1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
3 ;; Copyright (C) 1985-1987, 1991-2012 Free Software Foundation, Inc.
5 ;; Author: Ilya Zakharevich
7 ;; Maintainer: Ilya Zakharevich <ilyaz@cpan.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."
569 (defcustom cperl-extra-perl-args ""
570 "*Extra arguments to use when starting Perl.
571 Currently used with `cperl-check-syntax' only."
575 (defcustom cperl-message-electric-keyword t
576 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
578 :group 'cperl-help-system)
580 (defcustom cperl-indent-region-fix-constructs 1
581 "*Amount of space to insert between `}' and `else' or `elsif'
582 in `cperl-indent-region'. Set to nil to leave as is. Values other
583 than 1 and nil will probably not work."
584 :type '(choice (const nil) (const 1))
585 :group 'cperl-indentation-details)
587 (defcustom cperl-break-one-line-blocks-when-indent t
588 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
589 need to be reformatted into multiline ones when indenting a region."
591 :group 'cperl-indentation-details)
593 (defcustom cperl-fix-hanging-brace-when-indent t
594 "*Non-nil means that BLOCK-end `}' may be put on a separate line
595 when indenting a region.
596 Braces followed by else/elsif/while/until are excepted."
598 :group 'cperl-indentation-details)
600 (defcustom cperl-merge-trailing-else t
601 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
602 may be merged to be on the same line when indenting a region."
604 :group 'cperl-indentation-details)
606 (defcustom cperl-indent-parens-as-block nil
607 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
608 but for trailing \",\" inside the group, which won't increase indentation.
609 One should tune up `cperl-close-paren-offset' as well."
611 :group 'cperl-indentation-details)
613 (defcustom cperl-syntaxify-by-font-lock
614 (and cperl-can-font-lock
615 (boundp 'parse-sexp-lookup-properties))
616 "*Non-nil means that CPerl uses the `font-lock' routines for syntaxification."
617 :type '(choice (const message) boolean)
620 (defcustom cperl-syntaxify-unwind
622 "*Non-nil means that CPerl unwinds to a start of a long construction
623 when syntaxifying a chunk of buffer."
627 (defcustom cperl-syntaxify-for-menu
629 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
630 This way enabling/disabling of menu items is more correct."
634 (defcustom cperl-ps-print-face-properties
635 '((font-lock-keyword-face nil nil bold shadow)
636 (font-lock-variable-name-face nil nil bold)
637 (font-lock-function-name-face nil nil bold italic box)
638 (font-lock-constant-face nil "LightGray" bold)
639 (cperl-array-face nil "LightGray" bold underline)
640 (cperl-hash-face nil "LightGray" bold italic underline)
641 (font-lock-comment-face nil "LightGray" italic)
642 (font-lock-string-face nil nil italic underline)
643 (cperl-nonoverridable-face nil nil italic underline)
644 (font-lock-type-face nil nil underline)
645 (font-lock-warning-face nil "LightGray" bold italic box)
646 (underline nil "LightGray" strikeout))
647 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
648 :type '(repeat (cons symbol
649 (cons (choice (const nil) string)
650 (cons (choice (const nil) string)
654 (defvar cperl-dark-background
655 (cperl-choose-color "navy" "os2blue" "darkgreen"))
656 (defvar cperl-dark-foreground
657 (cperl-choose-color "orchid1" "orange"))
659 (defface cperl-nonoverridable-face
660 `((((class grayscale) (background light))
661 (:background "Gray90" :slant italic :underline t))
662 (((class grayscale) (background dark))
663 (:foreground "Gray80" :slant italic :underline t :weight bold))
664 (((class color) (background light))
665 (:foreground "chartreuse3"))
666 (((class color) (background dark))
667 (:foreground ,cperl-dark-foreground))
668 (t (:weight bold :underline t)))
669 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
672 (defface cperl-array-face
673 `((((class grayscale) (background light))
674 (:background "Gray90" :weight bold))
675 (((class grayscale) (background dark))
676 (:foreground "Gray80" :weight bold))
677 (((class color) (background light))
678 (:foreground "Blue" :background "lightyellow2" :weight bold))
679 (((class color) (background dark))
680 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
682 "Font Lock mode face used to highlight array names."
685 (defface cperl-hash-face
686 `((((class grayscale) (background light))
687 (:background "Gray90" :weight bold :slant italic))
688 (((class grayscale) (background dark))
689 (:foreground "Gray80" :weight bold :slant italic))
690 (((class color) (background light))
691 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
692 (((class color) (background dark))
693 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
694 (t (:weight bold :slant italic)))
695 "Font Lock mode face used to highlight hash names."
700 ;;; Short extra-docs.
702 (defvar cperl-tips 'please-ignore-this-line
703 "Get maybe newer version of this package from
704 http://ilyaz.org/software/emacs
705 Subdirectory `cperl-mode' may contain yet newer development releases and/or
706 patches to related files.
708 For best results apply to an older Emacs the patches from
709 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
710 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
711 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
712 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
714 Get support packages choose-color.el (or font-lock-extra.el before
715 19.30), imenu-go.el from the same place. \(Look for other files there
716 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
717 later you should use choose-color.el *instead* of font-lock-extra.el
718 \(and you will not get smart highlighting in C :-().
720 Note that to enable Compile choices in the menu you need to install
723 If your Emacs does not default to `cperl-mode' on Perl files, and you
724 want it to: put the following into your .emacs file:
726 (defalias 'perl-mode 'cperl-mode)
729 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
730 Also, one can generate a newer documentation running `pod2texi' converter
731 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
733 If you use imenu-go, run imenu on perl5-info buffer (you can do it
734 from Perl menu). If many files are related, generate TAGS files from
735 Tools/Tags submenu in Perl menu.
737 If some class structure is too complicated, use Tools/Hierarchy-view
738 from Perl menu, or hierarchic view of imenu. The second one uses the
739 current buffer only, the first one requires generation of TAGS from
740 Perl/Tools/Tags menu beforehand.
742 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
744 Switch auto-help on/off with Perl/Tools/Auto-help.
746 Though with contemporary Emaxen CPerl mode should maintain the correct
747 parsing of Perl even when editing, sometimes it may be lost. Fix this by
751 In cases of more severe confusion sometimes it is helpful to do
753 \\[load-library] cperl-mode RET
756 Before reporting (non-)problems look in the problem section of online
757 micro-docs on what I know about CPerl problems.")
759 (defvar cperl-problems 'please-ignore-this-line
760 "Description of problems in CPerl mode.
761 Some faces will not be shown on some versions of Emacs unless you
762 install choose-color.el, available from
763 http://ilyaz.org/software/emacs
765 `fill-paragraph' on a comment may leave the point behind the
766 paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
767 to detect it and bulk out).
769 See documentation of a variable `cperl-problems-old-emaxen' for the
770 problems which disappear if you upgrade Emacs to a reasonably new
771 version (20.3 for Emacs, and those of 2004 for XEmacs).")
773 (defvar cperl-problems-old-emaxen 'please-ignore-this-line
774 "Description of problems in CPerl mode specific for older Emacs versions.
776 Emacs had a _very_ restricted syntax parsing engine until version
777 20.1. Most problems below are corrected starting from this version of
778 Emacs, and all of them should be fixed in version 20.3. (Or apply
779 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
780 this respect (until 2003).
782 Note that even with newer Emacsen in some very rare cases the details
783 of interaction of `font-lock' and syntaxification may be not cleaned
784 up yet. You may get slightly different colors basing on the order of
785 fontification and syntaxification. Say, the initial faces is correct,
786 but editing the buffer breaks this.
788 Even with older Emacsen CPerl mode tries to corrects some Emacs
789 misunderstandings, however, for efficiency reasons the degree of
790 correction is different for different operations. The partially
791 corrected problems are: POD sections, here-documents, regexps. The
792 operations are: highlighting, indentation, electric keywords, electric
795 This may be confusing, since the regexp s#//#/#\; may be highlighted
796 as a comment, but it will be recognized as a regexp by the indentation
797 code. Or the opposite case, when a POD section is highlighted, but
798 may break the indentation of the following code (though indentation
799 should work if the balance of delimiters is not broken by POD).
801 The main trick (to make $ a \"backslash\") makes constructions like
802 ${aaa} look like unbalanced braces. The only trick I can think of is
803 to insert it as $ {aaa} (valid in perl5, not in perl4).
805 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
806 as /($|\\s)/. Note that such a transposition is not always possible.
808 The solution is to upgrade your Emacs or patch an older one. Note
809 that Emacs 20.2 has some bugs related to `syntax-table' text
810 properties. Patches are available on the main CPerl download site,
813 If these bugs cannot be fixed on your machine (say, you have an inferior
814 environment and cannot recompile), you may still disable all the fancy stuff
815 via `cperl-use-syntax-table-text-property'.")
817 (defvar cperl-praise 'please-ignore-this-line
818 "Advantages of CPerl mode.
820 0) It uses the newest `syntax-table' property ;-);
822 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
823 mode - but the latter number may have improved too in last years) even
824 with old Emaxen which do not support `syntax-table' property.
826 When using `syntax-table' property for syntax assist hints, it should
827 handle 99.995% of lines correct - or somesuch. It automatically
828 updates syntax assist hints when you edit your script.
830 2) It is generally believed to be \"the most user-friendly Emacs
831 package\" whatever it may mean (I doubt that the people who say similar
832 things tried _all_ the rest of Emacs ;-), but this was not a lonely
835 3) Everything is customizable, one-by-one or in a big sweep;
837 4) It has many easily-accessible \"tools\":
838 a) Can run program, check syntax, start debugger;
839 b) Can lineup vertically \"middles\" of rows, like `=' in
842 c) Can insert spaces where this improves readability (in one
843 interactive sweep over the buffer);
844 d) Has support for imenu, including:
845 1) Separate unordered list of \"interesting places\";
846 2) Separate TOC of POD sections;
847 3) Separate list of packages;
848 4) Hierarchical view of methods in (sub)packages;
849 5) and functions (by the full name - with package);
850 e) Has an interface to INFO docs for Perl; The interface is
851 very flexible, including shrink-wrapping of
852 documentation buffer/frame;
853 f) Has a builtin list of one-line explanations for perl constructs.
854 g) Can show these explanations if you stay long enough at the
855 corresponding place (or on demand);
856 h) Has an enhanced fontification (using 3 or 4 additional faces
857 comparing to font-lock - basically, different
858 namespaces in Perl have different colors);
859 i) Can construct TAGS basing on its knowledge of Perl syntax,
860 the standard menu has 6 different way to generate
861 TAGS (if \"by directory\", .xs files - with C-language
862 bindings - are included in the scan);
863 j) Can build a hierarchical view of classes (via imenu) basing
864 on generated TAGS file;
865 k) Has electric parentheses, electric newlines, uses Abbrev
866 for electric logical constructs
868 with different styles of expansion (context sensitive
869 to be not so bothering). Electric parentheses behave
870 \"as they should\" in a presence of a visible region.
871 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
877 n) Highlights (by user-choice) either 3-delimiters constructs
878 (such as tr/a/b/), or regular expressions and `y/tr';
879 o) Highlights trailing whitespace;
880 p) Is able to manipulate Perl Regular Expressions to ease
881 conversion to a more readable form.
882 q) Can ispell POD sections and HERE-DOCs.
883 r) Understands comments and character classes inside regular
884 expressions; can find matching () and [] in a regular expression.
885 s) Allows indentation of //x-style regular expressions;
886 t) Highlights different symbols in regular expressions according
887 to their function; much less problems with backslashitis;
888 u) Allows to find regular expressions which contain interpolated parts.
890 5) The indentation engine was very smart, but most of tricks may be
891 not needed anymore with the support for `syntax-table' property. Has
892 progress indicator for indentation (with `imenu' loaded).
894 6) Indent-region improves inline-comments as well; also corrects
895 whitespace *inside* the conditional/loop constructs.
897 7) Fill-paragraph correctly handles multi-line comments;
899 8) Can switch to different indentation styles by one command, and restore
900 the settings present before the switch.
902 9) When doing indentation of control constructs, may correct
903 line-breaks/spacing between elements of the construct.
905 10) Uses a linear-time algorithm for indentation of regions (on Emaxen with
906 capable syntax engines).
908 11) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
911 (defvar cperl-speed 'please-ignore-this-line
912 "This is an incomplete compendium of what is available in other parts
913 of CPerl documentation. (Please inform me if I skept anything.)
915 There is a perception that CPerl is slower than alternatives. This part
916 of documentation is designed to overcome this misconception.
918 *By default* CPerl tries to enable the most comfortable settings.
919 From most points of view, correctly working package is infinitely more
920 comfortable than a non-correctly working one, thus by default CPerl
921 prefers correctness over speed. Below is the guide how to change
922 settings if your preferences are different.
924 A) Speed of loading the file. When loading file, CPerl may perform a
925 scan which indicates places which cannot be parsed by primitive Emacs
926 syntax-parsing routines, and marks them up so that either
928 A1) CPerl may work around these deficiencies (for big chunks, mostly
929 PODs and HERE-documents), or
930 A2) On capable Emaxen CPerl will use improved syntax-handling
931 which reads mark-up hints directly.
933 The scan in case A2 is much more comprehensive, thus may be slower.
935 User can disable syntax-engine-helping scan of A2 by setting
936 `cperl-use-syntax-table-text-property'
937 variable to nil (if it is set to t).
939 One can disable the scan altogether (both A1 and A2) by setting
940 `cperl-pod-here-scan'
943 B) Speed of editing operations.
945 One can add a (minor) speedup to editing operations by setting
946 `cperl-use-syntax-table-text-property'
947 variable to nil (if it is set to t). This will disable
948 syntax-engine-helping scan, thus will make many more Perl
949 constructs be wrongly recognized by CPerl, thus may lead to
950 wrongly matched parentheses, wrong indentation, etc.
952 One can unset `cperl-syntaxify-unwind'. This might speed up editing
953 of, say, long POD sections.")
955 (defvar cperl-tips-faces 'please-ignore-this-line
956 "CPerl mode uses following faces for highlighting:
958 `cperl-array-face' Array names
959 `cperl-hash-face' Hash names
960 `font-lock-comment-face' Comments, PODs and whatever is considered
961 syntactically to be not code
962 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
963 2-arg operators s/y/tr/ or of RExen,
964 `font-lock-warning-face' Special-cased m// and s//foo/,
965 `font-lock-function-name-face' _ as a target of a file tests, file tests,
966 subroutine names at the moment of definition
967 (except those conflicting with Perl operators),
968 package names (when recognized), format names
969 `font-lock-keyword-face' Control flow switch constructs, declarators
970 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
971 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
972 literal parts and the terminator of formats
973 and whatever is syntactically considered
975 `font-lock-type-face' Overridable keywords
976 `font-lock-variable-name-face' Variable declarations, indirect array and
977 hash names, POD headers/item names
978 `cperl-invalid-face' Trailing whitespace
980 Note that in several situations the highlighting tries to inform about
981 possible confusion, such as different colors for function names in
982 declarations depending on what they (do not) override, or special cases
983 m// and s/// which do not do what one would expect them to do.
985 Help with best setup of these faces for printout requested (for each of
986 the faces: please specify bold, italic, underline, shadow and box.)
988 In regular expressions (including character classes):
989 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
990 `font-lock-constant-face': Delimiters
991 `font-lock-warning-face' Special-cased m// and s//foo/,
992 Mismatched closing delimiters, parens
993 we couldn't match, misplaced quantifiers,
994 unrecognized escape sequences
995 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
996 `font-lock-type-face' escape sequences with arguments (\\x \\23 \\p \\N)
997 and others match-a-char escape sequences
998 `font-lock-keyword-face' Capturing parens, and |
999 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
1000 \"Range -\" in character classes
1001 `font-lock-builtin-face' \"Remaining\" 0-length constructs, multipliers
1002 ?+*{}, not-capturing parens, leading
1003 backslashes of escape sequences
1004 `font-lock-variable-name-face' Interpolated constructs, embedded code,
1005 POSIX classes (inside charclasses)
1006 `font-lock-comment-face' Embedded comments
1012 ;;; Portability stuff:
1014 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
1015 `(define-key cperl-mode-map
1017 `(if (featurep 'xemacs) ,xemacs-key ,emacs-key)
1021 (defvar cperl-del-back-ch
1022 (car (append (where-is-internal 'delete-backward-char)
1023 (where-is-internal 'backward-delete-char-untabify)))
1024 "Character generated by key bound to `delete-backward-char'.")
1026 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
1027 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
1029 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
1030 (if (featurep 'xemacs)
1032 ;; "Active regions" are on: use region only if active
1033 ;; "Active regions" are off: use region unconditionally
1034 (defun cperl-use-region-p ()
1035 (if zmacs-regions (mark) t)))
1036 (defun cperl-use-region-p ()
1037 (if transient-mark-mode mark-active t))
1038 (defun cperl-mark-active () mark-active))
1040 (defsubst cperl-enable-font-lock ()
1041 cperl-can-font-lock)
1043 (defun cperl-putback-char (c) ; Emacs 19
1044 (set 'unread-command-events (list c))) ; Avoid undefined warning
1046 (if (featurep 'xemacs)
1047 (defun cperl-putback-char (c) ; XEmacs >= 19.12
1048 (setq unread-command-events (list (eval '(character-to-event c))))))
1050 (or (fboundp 'uncomment-region)
1051 (defun uncomment-region (beg end)
1053 (comment-region beg end -1)))
1055 (defvar cperl-do-not-fontify
1056 (if (string< emacs-version "19.30")
1059 "Text property which inhibits refontification.")
1061 (defsubst cperl-put-do-not-fontify (from to &optional post)
1062 ;; If POST, do not do it with postponed fontification
1063 (if (and post cperl-syntaxify-by-font-lock)
1065 (put-text-property (max (point-min) (1- from))
1066 to cperl-do-not-fontify t)))
1068 (defcustom cperl-mode-hook nil
1069 "Hook run by CPerl mode."
1073 (defvar cperl-syntax-state nil)
1074 (defvar cperl-syntax-done-to nil)
1075 (defvar cperl-emacs-can-parse (> (length (save-excursion
1076 (parse-partial-sexp (point) (point)))) 9))
1078 ;; Make customization possible "in reverse"
1079 (defsubst cperl-val (symbol &optional default hairy)
1081 ((eq (symbol-value symbol) 'null) default)
1082 (cperl-hairy (or hairy t))
1083 (t (symbol-value symbol))))
1086 (defun cperl-make-indent (column &optional minimum keep)
1087 "Makes indent of the current line the requested amount.
1088 Unless KEEP, removes the old indentation. Works around a bug in ancient
1090 (let ((prop (get-text-property (point) 'syntax-type)))
1092 (delete-horizontal-space))
1093 (indent-to column minimum)
1094 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
1096 (> (current-column) 0)
1099 (or (get-text-property (point) 'syntax-type)
1100 (and (looking-at "\\=[ \t]")
1101 (put-text-property (point) (match-end 0)
1102 'syntax-type prop)))))))
1104 ;;; Probably it is too late to set these guys already, but it can help later:
1106 ;;;(and cperl-clobber-mode-lists
1107 ;;;(setq auto-mode-alist
1108 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
1109 ;;;(and (boundp 'interpreter-mode-alist)
1110 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
1111 ;;; '(("miniperl" . perl-mode))))))
1117 '(imenu easymenu etags timer man info))
1118 (if (fboundp 'ps-extend-face-list)
1119 (defmacro cperl-ps-extend-face-list (arg)
1120 `(ps-extend-face-list ,arg))
1121 (defmacro cperl-ps-extend-face-list (arg)
1122 `(error "This version of Emacs has no `ps-extend-face-list'")))
1123 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1124 ;; macros instead of defsubsts don't work on Emacs, so we do the
1125 ;; expansion manually. Any other suggestions?
1128 (defvar cperl-mode-abbrev-table nil
1129 "Abbrev table in use in CPerl mode buffers.")
1131 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1133 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
1135 (if cperl-mode-map nil
1136 (setq cperl-mode-map (make-sparse-keymap))
1137 (cperl-define-key "{" 'cperl-electric-lbrace)
1138 (cperl-define-key "[" 'cperl-electric-paren)
1139 (cperl-define-key "(" 'cperl-electric-paren)
1140 (cperl-define-key "<" 'cperl-electric-paren)
1141 (cperl-define-key "}" 'cperl-electric-brace)
1142 (cperl-define-key "]" 'cperl-electric-rparen)
1143 (cperl-define-key ")" 'cperl-electric-rparen)
1144 (cperl-define-key ";" 'cperl-electric-semi)
1145 (cperl-define-key ":" 'cperl-electric-terminator)
1146 (cperl-define-key "\C-j" 'newline-and-indent)
1147 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
1148 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
1149 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1150 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
1151 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1152 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
1153 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
1154 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
1155 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
1156 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
1157 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
1158 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx)
1159 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0)
1160 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1)
1161 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
1162 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
1163 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
1164 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1165 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1167 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1168 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1169 (cperl-define-key "\177" 'cperl-electric-backspace)
1170 (cperl-define-key "\t" 'cperl-indent-command)
1171 ;; don't clobber the backspace binding:
1172 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1173 [(control c) (control h) F])
1174 (if (cperl-val 'cperl-clobber-lisp-bindings)
1176 (cperl-define-key "\C-hf"
1177 ;;(concat (char-to-string help-char) "f") ; does not work
1178 'cperl-info-on-command
1180 (cperl-define-key "\C-hv"
1181 ;;(concat (char-to-string help-char) "v") ; does not work
1184 (cperl-define-key "\C-c\C-hf"
1185 ;;(concat (char-to-string help-char) "f") ; does not work
1186 (key-binding "\C-hf")
1187 [(control c) (control h) f])
1188 (cperl-define-key "\C-c\C-hv"
1189 ;;(concat (char-to-string help-char) "v") ; does not work
1190 (key-binding "\C-hv")
1191 [(control c) (control h) v]))
1192 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1193 [(control c) (control h) f])
1194 (cperl-define-key "\C-c\C-hv"
1195 ;;(concat (char-to-string help-char) "v") ; does not work
1197 [(control c) (control h) v]))
1198 (if (and (featurep 'xemacs)
1199 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1201 ;; substitute-key-definition is usefulness-deenhanced...
1202 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1203 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1204 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
1205 (or (boundp 'fill-paragraph-function)
1206 (substitute-key-definition
1207 'fill-paragraph 'cperl-fill-paragraph
1208 cperl-mode-map global-map))
1209 (substitute-key-definition
1210 'indent-sexp 'cperl-indent-exp
1211 cperl-mode-map global-map)
1212 (substitute-key-definition
1213 'indent-region 'cperl-indent-region
1214 cperl-mode-map global-map)
1215 (substitute-key-definition
1216 'indent-for-comment 'cperl-indent-for-comment
1217 cperl-mode-map global-map)))
1220 (defvar cperl-lazy-installed)
1221 (defvar cperl-old-style nil)
1226 cperl-menu cperl-mode-map "Menu for CPerl mode"
1228 ["Beginning of function" beginning-of-defun t]
1229 ["End of function" end-of-defun t]
1230 ["Mark function" mark-defun t]
1231 ["Indent expression" cperl-indent-exp t]
1232 ["Fill paragraph/comment" fill-paragraph t]
1234 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1235 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1237 ["Beautify" cperl-beautify-regexp
1238 cperl-use-syntax-table-text-property]
1239 ["Beautify one level deep" (cperl-beautify-regexp 1)
1240 cperl-use-syntax-table-text-property]
1241 ["Beautify a group" cperl-beautify-level
1242 cperl-use-syntax-table-text-property]
1243 ["Beautify a group one level deep" (cperl-beautify-level 1)
1244 cperl-use-syntax-table-text-property]
1245 ["Contract a group" cperl-contract-level
1246 cperl-use-syntax-table-text-property]
1247 ["Contract groups" cperl-contract-levels
1248 cperl-use-syntax-table-text-property]
1250 ["Find next interpolated" cperl-next-interpolated-REx
1251 (next-single-property-change (point-min) 'REx-interpolated)]
1252 ["Find next interpolated (no //o)"
1253 cperl-next-interpolated-REx-0
1254 (or (text-property-any (point-min) (point-max) 'REx-interpolated t)
1255 (text-property-any (point-min) (point-max) 'REx-interpolated 1))]
1256 ["Find next interpolated (neither //o nor whole-REx)"
1257 cperl-next-interpolated-REx-1
1258 (text-property-any (point-min) (point-max) 'REx-interpolated t)])
1259 ["Insert spaces if needed to fix style" cperl-find-bad-style t]
1260 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1262 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1263 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1264 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1266 ["Run" mode-compile (fboundp 'mode-compile)]
1267 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1268 (get-buffer "*compilation*"))]
1269 ["Next error" next-error (get-buffer "*compilation*")]
1270 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1272 ["Debugger" cperl-db t]
1275 ["Imenu" imenu (fboundp 'imenu)]
1276 ["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
1278 ["Ispell PODs" cperl-pod-spell
1279 ;; Better not to update syntaxification here:
1280 ;; debugging syntaxification can be broken by this???
1282 (get-text-property (point-min) 'in-pod)
1284 (and cperl-syntaxify-for-menu
1285 (cperl-update-syntaxification (point-max) (point-max)))
1286 (next-single-property-change (point-min) 'in-pod nil (point-max)))
1288 ["Ispell HERE-DOCs" cperl-here-doc-spell
1290 (and cperl-syntaxify-for-menu
1291 (cperl-update-syntaxification (point-max) (point-max)))
1292 (next-single-property-change (point-min) 'here-doc-group nil (point-max)))
1294 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
1295 (eq 'here-doc (progn
1296 (and cperl-syntaxify-for-menu
1297 (cperl-update-syntaxification (point) (point)))
1298 (get-text-property (point) 'syntax-type)))]
1299 ["Select this HERE-DOC or POD section"
1300 cperl-select-this-pod-or-here-doc
1302 (and cperl-syntaxify-for-menu
1303 (cperl-update-syntaxification (point) (point)))
1304 (get-text-property (point) 'syntax-type))
1307 ["CPerl pretty print (experimental)" cperl-ps-print
1308 (fboundp 'ps-extend-face-list)]
1310 ["Syntaxify region" cperl-find-pods-heres-region
1311 (cperl-use-region-p)]
1312 ["Profile syntaxification" cperl-time-fontification t]
1313 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
1314 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t]
1315 ["Debug backtrace on syntactic scan (BEWARE!!!)"
1316 (cperl-toggle-set-debug-unwind nil t) t]
1318 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1319 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1321 ;;; ["Create tags for current file" cperl-etags t]
1322 ;;; ["Add tags for current file" (cperl-etags t) t]
1323 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1324 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1325 ;;; ["Create tags for Perl files in (sub)directories"
1326 ;;; (cperl-etags nil 'recursive) t]
1327 ;;; ["Add tags for Perl files in (sub)directories"
1328 ;;; (cperl-etags t 'recursive) t])
1329 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1330 ["Create tags for current file" (cperl-write-tags nil t) t]
1331 ["Add tags for current file" (cperl-write-tags) t]
1332 ["Create tags for Perl files in directory"
1333 (cperl-write-tags nil t nil t) t]
1334 ["Add tags for Perl files in directory"
1335 (cperl-write-tags nil nil nil t) t]
1336 ["Create tags for Perl files in (sub)directories"
1337 (cperl-write-tags nil t t t) t]
1338 ["Add tags for Perl files in (sub)directories"
1339 (cperl-write-tags nil nil t t) t]))
1341 ["Define word at point" imenu-go-find-at-position
1342 (fboundp 'imenu-go-find-at-position)]
1343 ["Help on function" cperl-info-on-command t]
1344 ["Help on function at point" cperl-info-on-current-command t]
1345 ["Help on symbol at point" cperl-get-help t]
1346 ["Perldoc" cperl-perldoc t]
1347 ["Perldoc on word at point" cperl-perldoc-at-point t]
1348 ["View manpage of POD in this file" cperl-build-manpage t]
1349 ["Auto-help on" cperl-lazy-install
1350 (and (fboundp 'run-with-idle-timer)
1351 (not cperl-lazy-installed))]
1352 ["Auto-help off" cperl-lazy-unstall
1353 (and (fboundp 'run-with-idle-timer)
1354 cperl-lazy-installed)])
1356 ["Auto newline" cperl-toggle-auto-newline t]
1357 ["Electric parens" cperl-toggle-electric t]
1358 ["Electric keywords" cperl-toggle-abbrev t]
1359 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1360 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
1361 ["Auto fill" auto-fill-mode t])
1363 ["CPerl" (cperl-set-style "CPerl") t]
1364 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1365 ["GNU" (cperl-set-style "GNU") t]
1366 ["C++" (cperl-set-style "C++") t]
1367 ["K&R" (cperl-set-style "K&R") t]
1368 ["BSD" (cperl-set-style "BSD") t]
1369 ["Whitesmith" (cperl-set-style "Whitesmith") t]
1370 ["Memorize Current" (cperl-set-style "Current") t]
1371 ["Memorized" (cperl-set-style-back) cperl-old-style])
1373 ["Tips" (describe-variable 'cperl-tips) t]
1374 ["Problems" (describe-variable 'cperl-problems) t]
1375 ["Speed" (describe-variable 'cperl-speed) t]
1376 ["Praise" (describe-variable 'cperl-praise) t]
1377 ["Faces" (describe-variable 'cperl-tips-faces) t]
1378 ["CPerl mode" (describe-function 'cperl-mode) t]
1380 (message "The version of master-file for this CPerl is %s-Emacs"
1381 cperl-version) t]))))
1384 (autoload 'c-macro-expand "cmacexp"
1385 "Display the result of expanding all C macros occurring in the region.
1386 The expansion is entirely correct because it uses the C preprocessor."
1389 ;;; These two must be unwound, otherwise take exponential time
1390 (defconst cperl-maybe-white-and-comment-rex "[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
1391 "Regular expression to match optional whitespace with interspersed comments.
1392 Should contain exactly one group.")
1394 ;;; This one is tricky to unwind; still very inefficient...
1395 (defconst cperl-white-and-comment-rex "\\([ \t\n]\\|#[^\n]*\n\\)+"
1396 "Regular expression to match whitespace with interspersed comments.
1397 Should contain exactly one group.")
1400 ;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
1401 ;;; `cperl-outline-regexp', `defun-prompt-regexp'.
1402 ;;; Details of groups in this may be used in several functions; see comments
1403 ;;; near mentioned above variable(s)...
1404 ;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
1405 (defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
1406 "Match the text after `sub' in a subroutine declaration.
1407 If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
1408 of attributes (if present), or end of the name or prototype (whatever is
1410 (concat ; Assume n groups before this...
1411 "\\(" ; n+1=name-group
1412 cperl-white-and-comment-rex ; n+2=pre-name
1413 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
1414 "\\)" ; END n+1=name-group
1416 "\\(" ; n+4=proto-group
1417 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
1418 "\\(([^()]*)\\)" ; n+6=prototype
1419 "\\)?" ; END n+4=proto-group
1420 "\\(" ; n+7=attr-group
1421 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
1422 "\\(" ; n+9=start-attr
1426 cperl-maybe-white-and-comment-rex ; whitespace-comments
1427 "\\(\\sw\\|_\\)+" ; attr-name
1428 ;; attr-arg (1 level of internal parens allowed!)
1429 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
1430 "\\(" ; optional : (XXX allows trailing???)
1431 cperl-maybe-white-and-comment-rex ; whitespace-comments
1436 "\\)?" ; END n+6=proto-group
1439 ;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
1440 ;;; and `cperl-outline-level'.
1441 ;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
1442 (defvar cperl-imenu--function-name-regexp-perl
1445 "\\([ \t]*package" ; 2 = package-group
1446 "\\(" ; 3 = package-name-group
1447 cperl-white-and-comment-rex ; 4 = pre-package-name
1448 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
1451 (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1452 cperl-maybe-white-and-comment-rex ; 15=pre-block
1454 "=head\\([1-4]\\)[ \t]+" ; 16=level
1455 "\\([^\n]+\\)$" ; 17=text
1458 (defvar cperl-outline-regexp
1459 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1461 (defvar cperl-mode-syntax-table nil
1462 "Syntax table in use in CPerl mode buffers.")
1464 (defvar cperl-string-syntax-table nil
1465 "Syntax table in use in CPerl mode string-like chunks.")
1467 (defsubst cperl-1- (p)
1468 (max (point-min) (1- p)))
1470 (defsubst cperl-1+ (p)
1471 (min (point-max) (1+ p)))
1473 (if cperl-mode-syntax-table
1475 (setq cperl-mode-syntax-table (make-syntax-table))
1476 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1477 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1478 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1479 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1480 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1481 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1482 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1483 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1484 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1485 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1486 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1487 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
1488 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1489 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1490 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1491 (if cperl-under-as-char
1492 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1493 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1494 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1495 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1496 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
1497 (modify-syntax-entry ?\{ "." cperl-string-syntax-table)
1498 (modify-syntax-entry ?\} "." cperl-string-syntax-table)
1499 (modify-syntax-entry ?\" "." cperl-string-syntax-table)
1500 (modify-syntax-entry ?' "." cperl-string-syntax-table)
1501 (modify-syntax-entry ?` "." cperl-string-syntax-table)
1502 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
1506 (defvar cperl-faces-init nil)
1508 (defvar cperl-msb-fixed nil)
1509 (defvar cperl-use-major-mode 'cperl-mode)
1510 (defvar cperl-font-lock-multiline-start nil)
1511 (defvar cperl-font-lock-multiline nil)
1512 (defvar cperl-font-locking nil)
1514 ;; NB as it stands the code in cperl-mode assumes this only has one
1515 ;; element. If XEmacs 19 support were dropped, this could all be simplified.
1516 (defvar cperl-compilation-error-regexp-alist
1517 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
1518 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
1520 "Alist that specifies how to match errors in perl output.")
1522 (defvar compilation-error-regexp-alist)
1525 (define-derived-mode cperl-mode prog-mode "CPerl"
1526 "Major mode for editing Perl code.
1527 Expression and list commands understand all C brackets.
1528 Tab indents for Perl code.
1529 Paragraphs are separated by blank lines only.
1530 Delete converts tabs to spaces as it moves back.
1532 Various characters in Perl almost always come in pairs: {}, (), [],
1533 sometimes <>. When the user types the first, she gets the second as
1534 well, with optional special formatting done on {}. (Disabled by
1535 default.) You can always quote (with \\[quoted-insert]) the left
1536 \"paren\" to avoid the expansion. The processing of < is special,
1537 since most the time you mean \"less\". CPerl mode tries to guess
1538 whether you want to type pair <>, and inserts is if it
1539 appropriate. You can set `cperl-electric-parens-string' to the string that
1540 contains the parens from the above list you want to be electrical.
1541 Electricity of parens is controlled by `cperl-electric-parens'.
1542 You may also set `cperl-electric-parens-mark' to have electric parens
1543 look for active mark and \"embrace\" a region if possible.'
1545 CPerl mode provides expansion of the Perl control constructs:
1547 if, else, elsif, unless, while, until, continue, do,
1548 for, foreach, formy and foreachmy.
1550 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1552 The user types the keyword immediately followed by a space, which
1553 causes the construct to be expanded, and the point is positioned where
1554 she is most likely to want to be. eg. when the user types a space
1555 following \"if\" the following appears in the buffer: if () { or if ()
1556 } { } and the cursor is between the parentheses. The user can then
1557 type some boolean expression within the parens. Having done that,
1558 typing \\[cperl-linefeed] places you - appropriately indented - on a
1559 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1560 directive line, then appropriate number of new lines is inserted).
1562 If CPerl decides that you want to insert \"English\" style construct like
1566 it will not do any expansion. See also help on variable
1567 `cperl-extra-newline-before-brace'. (Note that one can switch the
1568 help message on expansion by setting `cperl-message-electric-keyword'
1571 \\[cperl-linefeed] is a convenience replacement for typing carriage
1572 return. It places you in the next line with proper indentation, or if
1573 you type it inside the inline block of control construct, like
1575 foreach (@lines) {print; print}
1577 and you are on a boundary of a statement inside braces, it will
1578 transform the construct into a multiline and will place you into an
1579 appropriately indented blank line. If you need a usual
1580 `newline-and-indent' behavior, it is on \\[newline-and-indent],
1581 see documentation on `cperl-electric-linefeed'.
1583 Use \\[cperl-invert-if-unless] to change a construction of the form
1593 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1594 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1595 on electric space between $ and {, `cperl-electric-parens-string' is
1596 the string that contains parentheses that should be electric in CPerl
1597 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1598 setting `cperl-electric-keywords' enables electric expansion of
1599 control structures in CPerl. `cperl-electric-linefeed' governs which
1600 one of two linefeed behavior is preferable. You can enable all these
1601 options simultaneously (recommended mode of use) by setting
1602 `cperl-hairy' to t. In this case you can switch separate options off
1603 by setting them to `null'. Note that one may undo the extra
1604 whitespace inserted by semis and braces in `auto-newline'-mode by
1605 consequent \\[cperl-electric-backspace].
1607 If your site has perl5 documentation in info format, you can use commands
1608 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1609 These keys run commands `cperl-info-on-current-command' and
1610 `cperl-info-on-command', which one is which is controlled by variable
1611 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1612 \(in turn affected by `cperl-hairy').
1614 Even if you have no info-format documentation, short one-liner-style
1615 help is available on \\[cperl-get-help], and one can run perldoc or
1618 It is possible to show this help automatically after some idle time.
1619 This is regulated by variable `cperl-lazy-help-time'. Default with
1620 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1621 secs idle time . It is also possible to switch this on/off from the
1622 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1624 Use \\[cperl-lineup] to vertically lineup some construction - put the
1625 beginning of the region at the start of construction, and make region
1626 span the needed amount of lines.
1628 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1629 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1630 here-docs sections. With capable Emaxen results of scan are used
1631 for indentation too, otherwise they are used for highlighting only.
1633 Variables controlling indentation style:
1634 `cperl-tab-always-indent'
1635 Non-nil means TAB in CPerl mode should always reindent the current line,
1636 regardless of where in the line point is when the TAB command is used.
1637 `cperl-indent-left-aligned-comments'
1638 Non-nil means that the comment starting in leftmost column should indent.
1639 `cperl-auto-newline'
1640 Non-nil means automatically newline before and after braces,
1641 and after colons and semicolons, inserted in Perl code. The following
1642 \\[cperl-electric-backspace] will remove the inserted whitespace.
1643 Insertion after colons requires both this variable and
1644 `cperl-auto-newline-after-colon' set.
1645 `cperl-auto-newline-after-colon'
1646 Non-nil means automatically newline even after colons.
1647 Subject to `cperl-auto-newline' setting.
1648 `cperl-indent-level'
1649 Indentation of Perl statements within surrounding block.
1650 The surrounding block's indentation is the indentation
1651 of the line on which the open-brace appears.
1652 `cperl-continued-statement-offset'
1653 Extra indentation given to a substatement, such as the
1654 then-clause of an if, or body of a while, or just a statement continuation.
1655 `cperl-continued-brace-offset'
1656 Extra indentation given to a brace that starts a substatement.
1657 This is in addition to `cperl-continued-statement-offset'.
1658 `cperl-brace-offset'
1659 Extra indentation for line if it starts with an open brace.
1660 `cperl-brace-imaginary-offset'
1661 An open brace following other text is treated as if it the line started
1662 this far to the right of the actual line indentation.
1663 `cperl-label-offset'
1664 Extra indentation for line that is a label.
1665 `cperl-min-label-indent'
1666 Minimal indentation for line that is a label.
1668 Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
1669 `cperl-indent-level' 5 4 2 4
1670 `cperl-brace-offset' 0 0 0 0
1671 `cperl-continued-brace-offset' -5 -4 0 0
1672 `cperl-label-offset' -5 -4 -2 -4
1673 `cperl-continued-statement-offset' 5 4 2 4
1675 CPerl knows several indentation styles, and may bulk set the
1676 corresponding variables. Use \\[cperl-set-style] to do this. Use
1677 \\[cperl-set-style-back] to restore the memorized preexisting values
1678 \(both available from menu). See examples in `cperl-style-examples'.
1680 Part of the indentation style is how different parts of if/elsif/else
1681 statements are broken into lines; in CPerl, this is reflected on how
1682 templates for these constructs are created (controlled by
1683 `cperl-extra-newline-before-brace'), and how reflow-logic should treat
1684 \"continuation\" blocks of else/elsif/continue, controlled by the same
1685 variable, and by `cperl-extra-newline-before-brace-multiline',
1686 `cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
1688 If `cperl-indent-level' is 0, the statement after opening brace in
1689 column 0 is indented on
1690 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1692 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1695 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1696 or as help on variables `cperl-tips', `cperl-problems',
1697 `cperl-praise', `cperl-speed'."
1698 (if (cperl-val 'cperl-electric-linefeed)
1700 (local-set-key "\C-J" 'cperl-linefeed)
1701 (local-set-key "\C-C\C-J" 'newline-and-indent)))
1703 (cperl-val 'cperl-clobber-lisp-bindings)
1704 (cperl-val 'cperl-info-on-command-no-prompt))
1706 ;; don't clobber the backspace binding:
1707 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1708 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1709 [(control c) (control h) f])))
1710 (let ((prev-a-c abbrevs-changed))
1711 (define-abbrev-table 'cperl-mode-abbrev-table '(
1712 ("if" "if" cperl-electric-keyword 0)
1713 ("elsif" "elsif" cperl-electric-keyword 0)
1714 ("while" "while" cperl-electric-keyword 0)
1715 ("until" "until" cperl-electric-keyword 0)
1716 ("unless" "unless" cperl-electric-keyword 0)
1717 ("else" "else" cperl-electric-else 0)
1718 ("continue" "continue" cperl-electric-else 0)
1719 ("for" "for" cperl-electric-keyword 0)
1720 ("foreach" "foreach" cperl-electric-keyword 0)
1721 ("formy" "formy" cperl-electric-keyword 0)
1722 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1723 ("do" "do" cperl-electric-keyword 0)
1724 ("=pod" "=pod" cperl-electric-pod 0)
1725 ("=over" "=over" cperl-electric-pod 0)
1726 ("=head1" "=head1" cperl-electric-pod 0)
1727 ("=head2" "=head2" cperl-electric-pod 0)
1728 ("pod" "pod" cperl-electric-pod 0)
1729 ("over" "over" cperl-electric-pod 0)
1730 ("head1" "head1" cperl-electric-pod 0)
1731 ("head2" "head2" cperl-electric-pod 0)))
1732 (setq abbrevs-changed prev-a-c))
1733 (setq local-abbrev-table cperl-mode-abbrev-table)
1734 (if (cperl-val 'cperl-electric-keywords)
1736 (set-syntax-table cperl-mode-syntax-table)
1737 ;; Until Emacs is multi-threaded, we do not actually need it local:
1738 (make-local-variable 'cperl-font-lock-multiline-start)
1739 (make-local-variable 'cperl-font-locking)
1740 (make-local-variable 'outline-regexp)
1741 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1742 (setq outline-regexp cperl-outline-regexp)
1743 (make-local-variable 'outline-level)
1744 (setq outline-level 'cperl-outline-level)
1745 (make-local-variable 'paragraph-start)
1746 (setq paragraph-start (concat "^$\\|" page-delimiter))
1747 (make-local-variable 'paragraph-separate)
1748 (setq paragraph-separate paragraph-start)
1749 (make-local-variable 'paragraph-ignore-fill-prefix)
1750 (setq paragraph-ignore-fill-prefix t)
1751 (if (featurep 'xemacs)
1753 (make-local-variable 'paren-backwards-message)
1754 (set 'paren-backwards-message t)))
1755 (make-local-variable 'indent-line-function)
1756 (setq indent-line-function 'cperl-indent-line)
1757 (make-local-variable 'require-final-newline)
1758 (setq require-final-newline mode-require-final-newline)
1759 (make-local-variable 'comment-start)
1760 (setq comment-start "# ")
1761 (make-local-variable 'comment-end)
1762 (setq comment-end "")
1763 (make-local-variable 'comment-column)
1764 (setq comment-column cperl-comment-column)
1765 (make-local-variable 'comment-start-skip)
1766 (setq comment-start-skip "#+ *")
1767 (make-local-variable 'defun-prompt-regexp)
1769 ;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1770 ;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
1771 (setq defun-prompt-regexp
1772 (concat "^[ \t]*\\(sub"
1773 (cperl-after-sub-regexp 'named 'attr-groups)
1775 "\\(BEGIN\\|CHECK\\|INIT\\|END\\|AUTOLOAD\\|DESTROY\\)"
1777 cperl-maybe-white-and-comment-rex))
1778 (make-local-variable 'comment-indent-function)
1779 (setq comment-indent-function 'cperl-comment-indent)
1780 (and (boundp 'fill-paragraph-function)
1782 (make-local-variable 'fill-paragraph-function)
1783 (set 'fill-paragraph-function 'cperl-fill-paragraph)))
1784 (make-local-variable 'parse-sexp-ignore-comments)
1785 (setq parse-sexp-ignore-comments t)
1786 (make-local-variable 'indent-region-function)
1787 (setq indent-region-function 'cperl-indent-region)
1788 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1789 (make-local-variable 'imenu-create-index-function)
1790 (setq imenu-create-index-function
1791 (function cperl-imenu--create-perl-index))
1792 (make-local-variable 'imenu-sort-function)
1793 (setq imenu-sort-function nil)
1794 (make-local-variable 'vc-rcs-header)
1795 (set 'vc-rcs-header cperl-vc-rcs-header)
1796 (make-local-variable 'vc-sccs-header)
1797 (set 'vc-sccs-header cperl-vc-sccs-header)
1798 (when (featurep 'xemacs)
1799 ;; This one is obsolete...
1800 (make-local-variable 'vc-header-alist)
1801 (set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
1802 `((SCCS ,(car cperl-vc-sccs-header))
1803 (RCS ,(car cperl-vc-rcs-header))))))
1804 (cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
1805 (make-local-variable 'compilation-error-regexp-alist-alist)
1806 (set 'compilation-error-regexp-alist-alist
1807 (cons (cons 'cperl (car cperl-compilation-error-regexp-alist))
1808 (symbol-value 'compilation-error-regexp-alist-alist)))
1809 (if (fboundp 'compilation-build-compilation-error-regexp-alist)
1810 (let ((f 'compilation-build-compilation-error-regexp-alist))
1812 (make-local-variable 'compilation-error-regexp-alist)
1813 (push 'cperl compilation-error-regexp-alist)))
1814 ((boundp 'compilation-error-regexp-alist);; xemacs 19.x
1815 (make-local-variable 'compilation-error-regexp-alist)
1816 (set 'compilation-error-regexp-alist
1817 (append cperl-compilation-error-regexp-alist
1818 (symbol-value 'compilation-error-regexp-alist)))))
1819 (make-local-variable 'font-lock-defaults)
1820 (setq font-lock-defaults
1822 ((string< emacs-version "19.30")
1823 '(cperl-font-lock-keywords-2 nil nil ((?_ . "w"))))
1824 ((string< emacs-version "19.33") ; Which one to use?
1825 '((cperl-font-lock-keywords
1826 cperl-font-lock-keywords-1
1827 cperl-font-lock-keywords-2) nil nil ((?_ . "w"))))
1829 '((cperl-load-font-lock-keywords
1830 cperl-load-font-lock-keywords-1
1831 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
1832 (make-local-variable 'cperl-syntax-state)
1833 (setq cperl-syntax-state nil) ; reset syntaxification cache
1834 (if cperl-use-syntax-table-text-property
1835 (if (boundp 'syntax-propertize-function)
1837 ;; Reset syntaxification cache.
1838 (set (make-local-variable 'cperl-syntax-done-to) nil)
1839 (set (make-local-variable 'syntax-propertize-function)
1841 (goto-char start) (cperl-fontify-syntaxically end))))
1842 (make-local-variable 'parse-sexp-lookup-properties)
1843 ;; Do not introduce variable if not needed, we check it!
1844 (set 'parse-sexp-lookup-properties t)
1845 ;; Fix broken font-lock:
1846 (or (boundp 'font-lock-unfontify-region-function)
1847 (set 'font-lock-unfontify-region-function
1848 'font-lock-default-unfontify-region))
1849 (unless (featurep 'xemacs) ; Our: just a plug for wrong font-lock
1850 (make-local-variable 'font-lock-unfontify-region-function)
1851 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1852 'cperl-font-lock-unfontify-region-function))
1853 (make-local-variable 'cperl-syntax-done-to)
1854 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
1855 (make-local-variable 'font-lock-syntactic-keywords)
1856 (setq font-lock-syntactic-keywords
1857 (if cperl-syntaxify-by-font-lock
1858 '((cperl-fontify-syntaxically))
1859 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1860 ;; used to ignore syntax-table text-properties. (t) is a hack
1861 ;; to make font-lock think that font-lock-syntactic-keywords
1864 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
1866 (setq cperl-font-lock-multiline t) ; Not localized...
1867 (set (make-local-variable 'font-lock-multiline) t))
1868 (make-local-variable 'font-lock-fontify-region-function)
1869 (set 'font-lock-fontify-region-function ; not present with old Emacs
1870 'cperl-font-lock-fontify-region-function))
1871 (make-local-variable 'font-lock-fontify-region-function)
1872 (set 'font-lock-fontify-region-function ; not present with old Emacs
1873 'cperl-font-lock-fontify-region-function)
1874 (make-local-variable 'cperl-old-style)
1875 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1876 (set (make-local-variable 'normal-auto-fill-function)
1877 'cperl-do-auto-fill)
1878 (or (fboundp 'cperl-old-auto-fill-mode)
1880 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1881 (defun auto-fill-mode (&optional arg)
1883 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1884 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1885 (setq auto-fill-function 'cperl-do-auto-fill))))))
1886 (if (cperl-enable-font-lock)
1887 (if (cperl-val 'cperl-font-lock)
1888 (progn (or cperl-faces-init (cperl-init-faces))
1889 (font-lock-mode 1))))
1890 (set (make-local-variable 'facemenu-add-face-function)
1891 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
1892 (and (boundp 'msb-menu-cond)
1893 (not cperl-msb-fixed)
1895 (if (featurep 'easymenu)
1896 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
1897 (run-mode-hooks 'cperl-mode-hook)
1898 (if cperl-hook-after-change
1899 (add-hook 'after-change-functions 'cperl-after-change-function nil t))
1900 ;; After hooks since fontification will break this
1901 (if cperl-pod-here-scan
1902 (or cperl-syntaxify-by-font-lock
1903 (progn (or cperl-faces-init (cperl-init-faces-weak))
1904 (cperl-find-pods-heres)))))
1906 ;; Fix for perldb - make default reasonable
1910 (perldb (read-from-minibuffer "Run perldb (like this): "
1911 (if (consp gud-perldb-history)
1912 (car gud-perldb-history)
1913 (concat "perl " ;;(file-name-nondirectory
1917 (buffer-file-name)))
1919 '(gud-perldb-history . 1))))
1921 (defun cperl-msb-fix ()
1922 ;; Adds perl files to msb menu, supposes that msb is already loaded
1923 (setq cperl-msb-fixed t)
1924 (let* ((l (length msb-menu-cond))
1925 (last (nth (1- l) msb-menu-cond))
1926 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1927 (handle (1- (nth 1 last))))
1928 (setcdr precdr (list
1930 '(memq major-mode '(cperl-mode perl-mode))
1935 ;; This is used by indent-for-comment
1936 ;; to decide how much to indent a comment in CPerl code
1937 ;; based on its context. Do fallback if comment is found wrong.
1939 (defvar cperl-wrong-comment)
1940 (defvar cperl-st-cfence '(14)) ; Comment-fence
1941 (defvar cperl-st-sfence '(15)) ; String-fence
1942 (defvar cperl-st-punct '(1))
1943 (defvar cperl-st-word '(2))
1944 (defvar cperl-st-bra '(4 . ?\>))
1945 (defvar cperl-st-ket '(5 . ?\<))
1948 (defun cperl-comment-indent () ; called at point at supposed comment
1949 (let ((p (point)) (c (current-column)) was phony)
1950 (if (and (not cperl-indent-comment-at-column-0)
1952 0 ; Existing comment at bol stays there.
1953 ;; Wrong comment found
1955 (setq was (cperl-to-comment-or-eol)
1956 phony (eq (get-text-property (point) 'syntax-table)
1959 (progn ; Too naive???
1960 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1961 (if (eq (preceding-char) ?\#)
1964 (if (= (point) p) ; Our caller found a correct place
1966 (skip-chars-backward " \t")
1967 (setq was (current-column))
1970 (max (1+ was) ; Else indent at comment column
1972 ;; No, the caller found a random place; we need to edit ourselves
1974 (insert comment-start)
1975 (backward-char (length comment-start)))
1976 (setq cperl-wrong-comment t)
1977 (cperl-make-indent comment-column 1) ; Indent min 1
1980 ;;;(defun cperl-comment-indent-fallback ()
1981 ;;; "Is called if the standard comment-search procedure fails.
1982 ;;;Point is at start of real comment."
1983 ;;; (let ((c (current-column)) target cnt prevc)
1984 ;;; (if (= c comment-column) nil
1985 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1986 ;;; (setq target (max (1+ (setq prevc
1987 ;;; (current-column))) ; Else indent at comment column
1988 ;;; comment-column))
1989 ;;; (if (= c comment-column) nil
1990 ;;; (delete-backward-char cnt)
1991 ;;; (while (< prevc target)
1993 ;;; (setq prevc (current-column)))
1994 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1995 ;;; (while (< prevc target)
1997 ;;; (setq prevc (current-column)))))))
1999 (defun cperl-indent-for-comment ()
2000 "Substitute for `indent-for-comment' in CPerl."
2002 (let (cperl-wrong-comment)
2003 (indent-for-comment)
2004 (if cperl-wrong-comment ; set by `cperl-comment-indent'
2005 (progn (cperl-to-comment-or-eol)
2006 (forward-char (length comment-start))))))
2008 (defun cperl-comment-region (b e arg)
2009 "Comment or uncomment each line in the region in CPerl mode.
2010 See `comment-region'."
2011 (interactive "r\np")
2012 (let ((comment-start "#"))
2013 (comment-region b e arg)))
2015 (defun cperl-uncomment-region (b e arg)
2016 "Uncomment or comment each line in the region in CPerl mode.
2017 See `comment-region'."
2018 (interactive "r\np")
2019 (let ((comment-start "#"))
2020 (comment-region b e (- arg))))
2022 (defvar cperl-brace-recursing nil)
2024 (defun cperl-electric-brace (arg &optional only-before)
2025 "Insert character and correct line's indentation.
2026 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2027 place (even in empty line), but not after. If after \")\" and the inserted
2028 char is \"{\", insert extra newline before only if
2029 `cperl-extra-newline-before-brace'."
2032 (other-end (if (and cperl-electric-parens-mark
2038 (not cperl-brace-recursing)
2039 (cperl-val 'cperl-electric-parens)
2040 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2041 ;; Need to insert a matching pair
2044 (setq insertpos (point-marker))
2045 (goto-char other-end)
2046 (setq last-command-event ?\{)
2047 (cperl-electric-lbrace arg insertpos))
2049 ;; Check whether we close something "usual" with `}'
2050 (if (and (eq last-command-event ?\})
2054 (up-list (- (prefix-numeric-value arg)))
2055 ;;(cperl-after-block-p (point-min))
2056 (or (cperl-after-expr-p nil "{;)")
2057 ;; after sub, else, continue
2058 (cperl-after-block-p nil 'pre)))
2060 ;; Just insert the guy
2061 (self-insert-command (prefix-numeric-value arg))
2062 (if (and (not arg) ; No args, end (of empty line or auto)
2064 (or (and (null only-before)
2066 (skip-chars-backward " \t")
2068 (and (eq last-command-event ?\{) ; Do not insert newline
2069 ;; if after ")" and `cperl-extra-newline-before-brace'
2070 ;; is nil, do not insert extra newline.
2071 (not cperl-extra-newline-before-brace)
2073 (skip-chars-backward " \t")
2074 (eq (preceding-char) ?\))))
2075 (if cperl-auto-newline
2076 (progn (cperl-indent-line) (newline) t) nil)))
2078 (self-insert-command (prefix-numeric-value arg))
2080 (if cperl-auto-newline
2081 (setq insertpos (1- (point))))
2082 (if (and cperl-auto-newline (null only-before))
2085 (cperl-indent-line)))
2087 (if insertpos (progn (goto-char insertpos)
2088 (search-forward (make-string
2089 1 last-command-event))
2090 (setq insertpos (1- (point)))))
2094 (goto-char insertpos)
2095 (self-insert-command (prefix-numeric-value arg)))
2096 (self-insert-command (prefix-numeric-value arg)))))))
2098 (defun cperl-electric-lbrace (arg &optional end)
2099 "Insert character, correct line's indentation, correct quoting by space."
2101 (let ((cperl-brace-recursing t)
2102 (cperl-auto-newline cperl-auto-newline)
2104 (if (and cperl-electric-parens-mark
2112 (and (cperl-val 'cperl-electric-lbrace-space)
2113 (eq (preceding-char) ?$)
2115 (skip-chars-backward "$")
2116 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
2118 ;; Check whether we are in comment
2122 (not (looking-at "[ \t]*#")))
2123 (cperl-after-expr-p nil "{;)"))
2125 (setq cperl-auto-newline nil))
2126 (cperl-electric-brace arg)
2127 (and (cperl-val 'cperl-electric-parens)
2128 (eq last-command-event ?{)
2129 (memq last-command-event
2130 (append cperl-electric-parens-string nil))
2131 (or (if other-end (goto-char (marker-position other-end)))
2133 (setq last-command-event ?} pos (point))
2134 (progn (cperl-electric-brace arg t)
2137 (defun cperl-electric-paren (arg)
2138 "Insert an opening parenthesis or a matching pair of parentheses.
2139 See `cperl-electric-parens'."
2141 (let ((beg (point-at-bol))
2142 (other-end (if (and cperl-electric-parens-mark
2149 (if (and (cperl-val 'cperl-electric-parens)
2150 (memq last-command-event
2151 (append cperl-electric-parens-string nil))
2152 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2153 ;;(not (save-excursion (search-backward "#" beg t)))
2154 (if (eq last-command-event ?<)
2156 ;; This code is too electric, see Bug#3943.
2157 ;; (and abbrev-mode ; later it is too late, may be after `for'
2159 (cperl-after-expr-p nil "{;(,:="))
2162 (self-insert-command (prefix-numeric-value arg))
2163 (if other-end (goto-char (marker-position other-end)))
2164 (insert (make-string
2165 (prefix-numeric-value arg)
2166 (cdr (assoc last-command-event '((?{ .?})
2170 (forward-char (- (prefix-numeric-value arg))))
2171 (self-insert-command (prefix-numeric-value arg)))))
2173 (defun cperl-electric-rparen (arg)
2174 "Insert a matching pair of parentheses if marking is active.
2175 If not, or if we are not at the end of marking range, would self-insert.
2176 Affected by `cperl-electric-parens'."
2178 (let ((beg (point-at-bol))
2179 (other-end (if (and cperl-electric-parens-mark
2180 (cperl-val 'cperl-electric-parens)
2181 (memq last-command-event
2182 (append cperl-electric-parens-string nil))
2189 (cperl-val 'cperl-electric-parens)
2190 (memq last-command-event '( ?\) ?\] ?\} ?\> ))
2191 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2192 ;;(not (save-excursion (search-backward "#" beg t)))
2195 (self-insert-command (prefix-numeric-value arg))
2197 (if other-end (goto-char other-end))
2198 (insert (make-string
2199 (prefix-numeric-value arg)
2200 (cdr (assoc last-command-event '((?\} . ?\{)
2205 (self-insert-command (prefix-numeric-value arg)))))
2207 (defun cperl-electric-keyword ()
2208 "Insert a construction appropriate after a keyword.
2209 Help message may be switched off by setting `cperl-message-electric-keyword'
2211 (let ((beg (point-at-bol))
2212 (dollar (and (eq last-command-event ?$)
2213 (eq this-command 'self-insert-command)))
2214 (delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
2215 (memq this-command '(self-insert-command newline))))
2217 (and (save-excursion
2221 (setq do (looking-at "do\\>")))
2223 (cperl-after-expr-p nil "{;:"))
2227 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2229 (save-excursion (or (not (re-search-backward "^=" nil t))
2232 (and cperl-use-syntax-table-text-property
2233 (not (eq (get-text-property (point)
2236 (save-excursion (forward-sexp -1)
2237 (not (memq (following-char) (append "$@%&*" nil))))
2239 (and (eq (preceding-char) ?y)
2240 (progn ; "foreachmy"
2246 (memq this-command '(self-insert-command newline)))))
2247 (and dollar (insert " $"))
2249 ;;(insert " () {\n}")
2251 (cperl-extra-newline-before-brace
2252 (insert (if do "\n" " ()\n"))
2258 (and do (insert " while ();")))
2260 (insert (if do " {\n} while ();" " () {\n}"))))
2261 (or (looking-at "[ \t]\\|$") (insert " "))
2263 (if dollar (progn (search-backward "$")
2267 (search-backward ")")
2268 (if (eq last-command-event ?\()
2269 (progn ; Avoid "if (())"
2270 (delete-backward-char 1)
2271 (delete-backward-char -1))))
2273 (cperl-putback-char cperl-del-back-ch))
2274 (if cperl-message-electric-keyword
2275 (message "Precede char by C-q to avoid expansion"))))))
2277 (defun cperl-ensure-newlines (n &optional pos)
2278 "Make sure there are N newlines after the point."
2279 (or pos (setq pos (point)))
2280 (if (looking-at "\n")
2284 (cperl-ensure-newlines (1- n) pos)
2287 (defun cperl-electric-pod ()
2288 "Insert a POD chunk appropriate after a =POD directive."
2289 (let ((delete (and (memq last-command-event '(?\s ?\n ?\t ?\f))
2290 (memq this-command '(self-insert-command newline))))
2291 head1 notlast name p really-delete over)
2292 (and (save-excursion
2295 (eq (preceding-char) ?=)
2297 (setq head1 (looking-at "head1\\>[ \t]*$"))
2298 (setq over (and (looking-at "over\\>[ \t]*$")
2299 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
2303 (get-text-property (point) 'in-pod)
2304 (cperl-after-expr-p nil "{;:")
2305 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
2306 (not (looking-at "\n*=cut"))
2307 (or (not cperl-use-syntax-table-text-property)
2308 (eq (get-text-property (point) 'syntax-type) 'pod))))))
2311 (setq notlast (re-search-forward "^\n=" nil t)))
2315 (cperl-ensure-newlines 2)
2321 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
2322 nil t)))) ; Only one
2325 (setq name (file-name-base)
2327 (insert " NAME\n\n" name
2328 " - \n\n=head1 SYNOPSIS\n\n\n\n"
2329 "=head1 DESCRIPTION")
2330 (cperl-ensure-newlines 4)
2334 (setq really-delete t))
2339 (insert "\n\n=item \n\n\n\n"
2341 (cperl-ensure-newlines 2)
2345 (setq really-delete t)))
2346 (if (and delete really-delete)
2347 (cperl-putback-char cperl-del-back-ch))))))
2349 (defun cperl-electric-else ()
2350 "Insert a construction appropriate after a keyword.
2351 Help message may be switched off by setting `cperl-message-electric-keyword'
2353 (let ((beg (point-at-bol)))
2354 (and (save-excursion
2356 (cperl-after-expr-p nil "{;:"))
2360 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2362 (save-excursion (or (not (re-search-backward "^=" nil t))
2364 (and cperl-use-syntax-table-text-property
2365 (not (eq (get-text-property (point)
2370 ;;(insert " {\n\n}")
2372 (cperl-extra-newline-before-brace
2378 (insert " {\n\n}")))
2379 (or (looking-at "[ \t]\\|$") (insert " "))
2383 (cperl-putback-char cperl-del-back-ch)
2384 (setq this-command 'cperl-electric-else)
2385 (if cperl-message-electric-keyword
2386 (message "Precede char by C-q to avoid expansion"))))))
2388 (defun cperl-linefeed ()
2389 "Go to end of line, open a new line and indent appropriately.
2390 If in POD, insert appropriate lines."
2392 (let ((beg (point-at-bol))
2393 (end (point-at-eol))
2394 (pos (point)) start over cut res)
2395 (if (and ; Check if we need to split:
2396 ; i.e., on a boundary and inside "{...}"
2397 (save-excursion (cperl-to-comment-or-eol)
2398 (>= (point) pos)) ; Not in a comment
2400 (skip-chars-backward " \t" beg)
2402 (looking-at "[;{]")) ; After { or ; + spaces
2403 (looking-at "[ \t]*}") ; Before }
2404 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2407 (eq (car (parse-partial-sexp pos end -1)) -1)
2408 ; Leave the level of parens
2409 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2411 (cperl-after-block-p (point-min))
2414 (setq start (point-marker))
2415 (<= start pos))))) ; Redundant? Are after the
2416 ; start of parens group.
2418 (skip-chars-backward " \t")
2419 (or (memq (preceding-char) (append ";{" nil))
2425 (or (looking-at "{[ \t]*$") ; If there is a statement
2426 ; before, move it to separate line
2430 (cperl-indent-line)))
2431 (forward-line 1) ; We are on the target line
2434 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2435 ; after, move it to separate line
2438 (search-backward "}" beg)
2439 (skip-chars-backward " \t")
2440 (or (memq (preceding-char) (append ";{" nil))
2445 (forward-line -1) ; We are on the line before target
2447 (newline-and-indent))
2448 (end-of-line) ; else - no splitting
2450 ((and (looking-at "\n[ \t]*{$")
2452 (skip-chars-backward " \t")
2453 (eq (preceding-char) ?\)))) ; Probably if () {} group
2454 ; with an extra newline.
2456 (cperl-indent-line))
2457 ((save-excursion ; In POD header
2458 (forward-paragraph -1)
2459 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2460 ;; We are after \n now, so look for the rest
2461 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2463 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2464 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2468 (forward-paragraph -1)
2471 (setq cut (buffer-substring (point) (point-at-eol)))
2472 (delete-char (- (point-at-eol) (point)))
2473 (setq res (expand-abbrev))
2479 (cperl-ensure-newlines (if cut 2 4))
2481 ((get-text-property (point) 'in-pod) ; In POD section
2482 (cperl-ensure-newlines 4)
2484 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2486 (cperl-indent-line))
2488 (newline-and-indent))))))
2490 (defun cperl-electric-semi (arg)
2491 "Insert character and correct line's indentation."
2493 (if cperl-auto-newline
2494 (cperl-electric-terminator arg)
2495 (self-insert-command (prefix-numeric-value arg))
2496 (if cperl-autoindent-on-semi
2497 (cperl-indent-line))))
2499 (defun cperl-electric-terminator (arg)
2500 "Insert character and correct line's indentation."
2503 (auto (and cperl-auto-newline
2504 (or (not (eq last-command-event ?:))
2505 cperl-auto-newline-after-colon)))
2507 (if (and ;;(not arg)
2509 (not (save-excursion
2511 (skip-chars-forward " \t")
2513 ;; Ignore in comment lines
2514 (= (following-char) ?#)
2515 ;; Colon is special only after a label
2516 ;; So quickly rule out most other uses of colon
2517 ;; and do no indentation for them.
2518 (and (eq last-command-event ?:)
2521 (skip-chars-forward " \t")
2522 (and (< (point) end)
2523 (progn (goto-char (- end 1))
2524 (not (looking-at ":"))))))
2526 (beginning-of-defun)
2527 (let ((pps (parse-partial-sexp (point) end)))
2528 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2530 (self-insert-command (prefix-numeric-value arg))
2532 (if auto (setq insertpos (point-marker)))
2538 (cperl-indent-line)))
2540 (if insertpos (goto-char (1- (marker-position insertpos)))
2545 (goto-char insertpos)
2546 (self-insert-command (prefix-numeric-value arg)))
2547 (self-insert-command (prefix-numeric-value arg)))))
2549 (defun cperl-electric-backspace (arg)
2550 "Backspace, or remove whitespace around the point inserted by an electric key.
2551 Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2553 (if (and cperl-auto-newline
2554 (memq last-command '(cperl-electric-semi
2555 cperl-electric-terminator
2556 cperl-electric-lbrace))
2557 (memq (preceding-char) '(?\s ?\t ?\n)))
2559 (if (eq last-command 'cperl-electric-lbrace)
2560 (skip-chars-forward " \t\n"))
2562 (skip-chars-backward " \t\n")
2563 (delete-region (point) p))
2564 (and (eq last-command 'cperl-electric-else)
2565 ;; We are removing the whitespace *inside* cperl-electric-else
2566 (setq this-command 'cperl-electric-else-really))
2567 (if (and cperl-auto-newline
2568 (eq last-command 'cperl-electric-else-really)
2569 (memq (preceding-char) '(?\s ?\t ?\n)))
2571 (skip-chars-forward " \t\n")
2573 (skip-chars-backward " \t\n")
2574 (delete-region (point) p))
2575 (if cperl-electric-backspace-untabify
2576 (backward-delete-char-untabify arg)
2577 (delete-backward-char arg)))))
2579 (put 'cperl-electric-backspace 'delete-selection 'supersede)
2581 (defun cperl-inside-parens-p () ;; NOT USED????
2585 (narrow-to-region (point)
2586 (progn (beginning-of-defun) (point)))
2587 (goto-char (point-max))
2588 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2591 (defun cperl-indent-command (&optional whole-exp)
2592 "Indent current line as Perl code, or in some cases insert a tab character.
2593 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2594 line. Otherwise, indent the current line only if point is at the left margin
2595 or in the line's indentation; otherwise insert a tab.
2597 A numeric argument, regardless of its value,
2598 means indent rigidly all the lines of the expression starting after point
2599 so that this line becomes properly indented.
2600 The relative indentation among the lines of the expression are preserved."
2602 (cperl-update-syntaxification (point) (point))
2604 ;; If arg, always indent this line as Perl
2605 ;; and shift remaining lines of expression the same amount.
2606 (let ((shift-amt (cperl-indent-line))
2609 (if cperl-tab-always-indent
2610 (beginning-of-line))
2617 (if (and shift-amt (> end beg))
2618 (indent-code-rigidly beg end shift-amt "#")))
2619 (if (and (not cperl-tab-always-indent)
2621 (skip-chars-backward " \t")
2624 (cperl-indent-line))))
2626 (defun cperl-indent-line (&optional parse-data)
2627 "Indent current line as Perl code.
2628 Return the amount the indentation changed by."
2629 (let ((case-fold-search nil)
2630 (pos (- (point-max) (point)))
2631 indent i beg shift-amt)
2632 (setq indent (cperl-calculate-indent parse-data)
2636 (cond ((or (eq indent nil) (eq indent t))
2637 (setq indent (current-indentation) i nil))
2638 ;;((eq indent t) ; Never?
2639 ;; (setq indent (cperl-calculate-indent-within-comment)))
2640 ;;((looking-at "[ \t]*#")
2643 (skip-chars-forward " \t")
2644 (if (listp indent) (setq indent (car indent)))
2645 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2646 (not (looking-at "[smy]:\\|tr:")))
2648 (setq indent (max cperl-min-label-indent
2649 (+ indent cperl-label-offset)))))
2650 ((= (following-char) ?})
2651 (setq indent (- indent cperl-indent-level)))
2652 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2653 (setq indent (+ indent cperl-close-paren-offset)))
2654 ((= (following-char) ?{)
2655 (setq indent (+ indent cperl-brace-offset))))))
2656 (skip-chars-forward " \t")
2657 (setq shift-amt (and i (- indent (current-column))))
2658 (if (or (not shift-amt)
2660 (if (> (- (point-max) pos) (point))
2661 (goto-char (- (point-max) pos)))
2662 ;;;(delete-region beg (point))
2663 ;;;(indent-to indent)
2664 (cperl-make-indent indent)
2665 ;; If initial point was within line's indentation,
2666 ;; position after the indentation. Else stay at same point in text.
2667 (if (> (- (point-max) pos) (point))
2668 (goto-char (- (point-max) pos))))
2671 (defun cperl-after-label ()
2672 ;; Returns true if the point is after label. Does not do save-excursion.
2673 (and (eq (preceding-char) ?:)
2674 (memq (char-syntax (char-after (- (point) 2)))
2678 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2680 (defun cperl-get-state (&optional parse-start start-state)
2681 ;; returns list (START STATE DEPTH PRESTART),
2682 ;; START is a good place to start parsing, or equal to
2683 ;; PARSE-START if preset,
2684 ;; STATE is what is returned by `parse-partial-sexp'.
2685 ;; DEPTH is true is we are immediately after end of block
2686 ;; which contains START.
2687 ;; PRESTART is the position basing on which START was found.
2689 (let ((start-point (point)) depth state start prestart)
2690 (if (and parse-start
2691 (<= parse-start start-point))
2692 (goto-char parse-start)
2693 (beginning-of-defun)
2694 (setq start-state nil))
2695 (setq prestart (point))
2697 ;; Try to go out, if sub is not on the outermost level
2698 (while (< (point) start-point)
2699 (setq start (point) parse-start start depth nil
2700 state (parse-partial-sexp start start-point -1))
2701 (if (> (car state) -1) nil
2702 ;; The current line could start like }}}, so the indentation
2703 ;; corresponds to a different level than what we reached
2705 (beginning-of-line 2))) ; Go to the next line.
2706 (if start (goto-char start))) ; Not at the start of file
2707 (setq start (point))
2708 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2709 (list start state depth prestart))))
2711 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2713 (defun cperl-beginning-of-property (p prop &optional lim)
2714 "Given that P has a property PROP, find where the property starts.
2715 Will not look before LIM."
2716 ;;; XXXX What to do at point-max???
2717 (or (previous-single-property-change (cperl-1+ p) prop lim)
2719 ;;; (cond ((eq p (point-min))
2721 ;;; ((and lim (<= p lim))
2723 ;;; ((not (get-text-property (1- p) prop))
2725 ;;; (t (or (previous-single-property-change p look-prop lim)
2729 (defun cperl-sniff-for-indent (&optional parse-data) ; was parse-start
2730 ;; the sniffer logic to understand what the current line MEANS.
2731 (cperl-update-syntaxification (point) (point))
2732 (let ((res (get-text-property (point) 'syntax-type)))
2735 ((and (memq res '(pod here-doc here-doc-delim format))
2736 (not (get-text-property (point) 'indentable)))
2738 ;; before start of POD - whitespace found since do not have 'pod!
2739 ((looking-at "[ \t]*\n=")
2740 (error "Spaces before POD section!"))
2741 ((and (not cperl-indent-left-aligned-comments)
2743 [comment-special:at-beginning-of-line])
2744 ((get-text-property (point) 'in-pod)
2748 (let* ((indent-point (point))
2749 (char-after-pos (save-excursion
2750 (skip-chars-forward " \t")
2752 (char-after (char-after char-after-pos))
2753 (pre-indent-point (point))
2754 p prop look-prop is-block delim)
2755 (save-excursion ; Know we are not in POD, find appropriate pos before
2756 (cperl-backward-to-noncomment nil)
2757 (setq p (max (point-min) (1- (point)))
2758 prop (get-text-property p 'syntax-type)
2759 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2761 (if (memq prop '(pod here-doc format here-doc-delim))
2763 (goto-char (cperl-beginning-of-property p look-prop))
2765 (setq pre-indent-point (point)))))
2766 (goto-char pre-indent-point) ; Orig line skipping preceding pod/etc
2767 (let* ((case-fold-search nil)
2768 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2769 (start (or (nth 2 parse-data) ; last complete sexp terminated
2770 (nth 0 s-s))) ; Good place to start parsing
2772 (containing-sexp (car (cdr state)))
2775 ;;containing-sexp ;; We are buggy at toplevel :-(
2778 (setcar parse-data pre-indent-point)
2779 (setcar (cdr parse-data) state)
2780 (or (nth 2 parse-data)
2781 (setcar (cddr parse-data) start))
2782 ;; Before this point: end of statement
2783 (setq old-indent (nth 3 parse-data))))
2784 (cond ((get-text-property (point) 'indentable)
2785 ;; indent to "after" the surrounding open
2786 ;; (same offset as `cperl-beautify-regexp-piece'),
2787 ;; skip blanks if we do not close the expression.
2788 (setq delim ; We do not close the expression
2790 (cperl-1+ char-after-pos) 'indentable)
2791 p (1+ (cperl-beginning-of-property
2792 (point) 'indentable))
2793 is-block ; misused for: preceding line in REx
2794 (save-excursion ; Find preceding line
2795 (cperl-backward-to-noncomment p)
2798 (progn ; get indent from the first line
2800 (skip-chars-forward " \t")
2801 (if (memq (char-after (point))
2803 nil ; Can't use indentation of this line...
2805 (skip-chars-forward " \t")
2807 prop (parse-partial-sexp p char-after-pos))
2808 (cond ((not delim) ; End the REx, ignore is-block
2809 (vector 'indentable 'terminator p is-block))
2810 (is-block ; Indent w.r.t. preceding line
2811 (vector 'indentable 'cont-line char-after-pos
2812 is-block char-after p))
2813 (t ; No preceding line...
2814 (vector 'indentable 'first-line p))))
2815 ((get-text-property char-after-pos 'REx-part2)
2816 (vector 'REx-part2 (point)))
2821 ;; XXXX Do we need to special-case this?
2822 ((null containing-sexp)
2823 ;; Line is at top level. May be data or function definition,
2824 ;; or may be function argument declaration.
2825 ;; Indent like the previous top level line
2826 ;; unless that ends in a closeparen without semicolon,
2827 ;; in which case this line is the first argument decl.
2828 (skip-chars-forward " \t")
2829 (cperl-backward-to-noncomment (or old-indent (point-min)))
2832 (eq (point) old-indent) ; old-indent was at comment
2833 (eq (preceding-char) ?\;)
2835 (and (eq (preceding-char) ?\})
2836 (cperl-after-block-and-statement-beg
2837 (point-min))) ; Was start - too close
2838 (memq char-after (append ")]}" nil))
2839 (and (eq (preceding-char) ?\:) ; label
2842 (skip-chars-backward " \t")
2843 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2844 (get-text-property (point) 'first-format-line)))
2846 ;; Look at previous line that's at column 0
2847 ;; to determine whether we are in top-level decls
2848 ;; or function's arg decls. Set basic-indent accordingly.
2849 ;; Now add a little if this is a continuation line.
2852 (not (eq char-after ?\C-j))
2853 (setcdr (cddr parse-data)
2854 (list pre-indent-point)))
2855 (vector 'toplevel start char-after state (nth 2 s-s)))
2858 (and (setq delim (= (char-after containing-sexp) ?{))
2859 (save-excursion ; Is it a hash?
2860 (goto-char containing-sexp)
2862 cperl-indent-parens-as-block))
2863 ;; group is an expression, not a block:
2864 ;; indent to just after the surrounding open parens,
2865 ;; skip blanks if we do not close the expression.
2866 (goto-char (1+ containing-sexp))
2867 (or (memq char-after
2868 (append (if delim "}" ")]}") nil))
2869 (looking-at "[ \t]*\\(#\\|$\\)")
2870 (skip-chars-forward " \t"))
2871 (setq old-indent (point)) ; delim=is-brace
2872 (vector 'in-parens char-after (point) delim containing-sexp))
2874 ;; Statement level. Is it a continuation or a new statement?
2875 ;; Find previous non-comment character.
2876 (goto-char pre-indent-point) ; Skip one level of POD/etc
2877 (cperl-backward-to-noncomment containing-sexp)
2878 ;; Back up over label lines, since they don't
2879 ;; affect whether our line is a continuation.
2881 (while;;(or (eq (preceding-char) ?\,)
2882 (and (eq (preceding-char) ?:)
2883 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2884 (memq (char-syntax (char-after (- (point) 2)))
2887 ;; This is always FALSE?
2888 (if (eq (preceding-char) ?\,)
2889 ;; Will go to beginning of line, essentially.
2890 ;; Will ignore embedded sexpr XXXX.
2891 (cperl-backward-to-start-of-continued-exp containing-sexp))
2893 (cperl-backward-to-noncomment containing-sexp))
2894 ;; Now we get non-label preceding the indent point
2895 (if (not (or (eq (1- (point)) containing-sexp)
2896 (memq (preceding-char)
2897 (append (if is-block " ;{" " ,;{") '(nil)))
2898 (and (eq (preceding-char) ?\})
2899 (cperl-after-block-and-statement-beg
2901 (get-text-property (point) 'first-format-line)))
2902 ;; This line is continuation of preceding line's statement;
2903 ;; indent `cperl-continued-statement-offset' more than the
2904 ;; previous line of the statement.
2906 ;; There might be a label on this line, just
2907 ;; consider it bad style and ignore it.
2909 (cperl-backward-to-start-of-continued-exp containing-sexp)
2910 (vector 'continuation (point) char-after is-block delim))
2911 ;; This line starts a new statement.
2912 ;; Position following last unclosed open brace
2913 (goto-char containing-sexp)
2914 ;; Is line first statement after an open-brace?
2916 ;; If no, find that first statement and indent like
2917 ;; it. If the first statement begins with label, do
2918 ;; not believe when the indentation of the label is too
2922 (let ((colon-line-end 0))
2924 (progn (skip-chars-forward " \t\n")
2925 ;; s: foo : bar :x is NOT label
2926 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
2927 (not (looking-at "[sym]:\\|tr:"))))
2928 ;; Skip over comments and labels following openbrace.
2929 (cond ((= (following-char) ?\#)
2931 ((= (following-char) ?\=)
2933 (or (next-single-property-change (point) 'in-pod)
2934 (point-max)))) ; do not loop if no syntaxification
2937 (setq colon-line-end (point-at-eol))
2938 (search-forward ":"))))
2939 ;; We are at beginning of code (NOT label or comment)
2940 ;; First, the following code counts
2941 ;; if it is before the line we want to indent.
2942 (and (< (point) indent-point)
2943 (vector 'have-prev-sibling (point) colon-line-end
2946 ;; If no previous statement,
2947 ;; indent it relative to line brace is on.
2949 ;; For open-braces not the first thing in a line,
2950 ;; add in cperl-brace-imaginary-offset.
2952 ;; If first thing on a line: ?????
2953 ;; Move back over whitespace before the openbrace.
2954 (setq ; brace first thing on a line
2955 old-indent (progn (skip-chars-backward " \t") (bolp)))
2956 ;; Should we indent w.r.t. earlier than start?
2957 ;; Move to start of control group, possibly on a different line
2958 (or cperl-indent-wrt-brace
2959 (cperl-backward-to-noncomment (point-min)))
2960 ;; If the openbrace is preceded by a parenthesized exp,
2961 ;; move to the beginning of that;
2962 (if (eq (preceding-char) ?\))
2965 (cperl-backward-to-noncomment (point-min))))
2966 ;; In the case it starts a subroutine, indent with
2967 ;; respect to `sub', not with respect to the
2968 ;; first thing on the line, say in the case of
2969 ;; anonymous sub in a hash.
2970 (if (and;; Is it a sub in group starting on this line?
2971 (cond ((get-text-property (point) 'attrib-group)
2972 (goto-char (cperl-beginning-of-property
2973 (point) 'attrib-group)))
2974 ((eq (preceding-char) ?b)
2976 (looking-at "sub\\>")))
2977 (setq p (nth 1 ; start of innermost containing list
2982 (goto-char (1+ p)) ; enclosing block on the same line
2983 (skip-chars-forward " \t")
2984 (vector 'code-start-in-block containing-sexp char-after
2985 (and delim (not is-block)) ; is a HASH
2986 old-indent ; brace first thing on a line
2987 t (point) ; have something before...
2991 ;; Get initial indentation of the line we are on.
2992 ;; If line starts with label, calculate label indentation
2993 (vector 'code-start-in-block containing-sexp char-after
2994 (and delim (not is-block)) ; is a HASH
2995 old-indent ; brace first thing on a line
2996 nil (point))))))))))))))) ; nothing interesting before
2998 (defvar cperl-indent-rules-alist
2999 '((pod nil) ; via `syntax-type' property
3000 (here-doc nil) ; via `syntax-type' property
3001 (here-doc-delim nil) ; via `syntax-type' property
3002 (format nil) ; via `syntax-type' property
3003 (in-pod nil) ; via `in-pod' property
3004 (comment-special:at-beginning-of-line nil)
3007 "Alist of indentation rules for CPerl mode.
3010 number: add this amount of indentation.")
3012 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3013 "Return appropriate indentation for current line as Perl code.
3014 In usual case returns an integer: the column to indent to.
3015 Returns nil if line starts inside a string, t if in a comment.
3017 Will not correct the indentation for labels, but will correct it for braces
3018 and closing parentheses and brackets."
3019 ;; This code is still a broken architecture: in some cases we need to
3020 ;; compensate for some modifications which `cperl-indent-line' will add later
3022 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3024 ;;((or (null i) (eq i t) (numberp i))
3027 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3029 (what (cadr what)) ; Load from table
3031 ;; Indenters for regular expressions with //x and qw()
3033 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3034 (goto-char (elt i 1))
3035 (condition-case nil ; Use indentation of the 1st part
3038 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3039 (cond ;;; [indentable terminator start-pos is-block]
3040 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3041 (goto-char (elt i 2)) ; After opening parens
3042 (1- (current-column)))
3043 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3044 (goto-char (elt i 2))
3045 (+ (or cperl-regexp-indent-step cperl-indent-level)
3048 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3049 ;; Indent as the level after closing parens
3050 (goto-char (elt i 2)) ; indent line
3051 (skip-chars-forward " \t)") ; Skip closing parens
3053 (goto-char (elt i 3)) ; previous line
3054 (skip-chars-forward " \t)") ; Skip closing parens
3055 ;; Number of parens in between:
3056 (setq p (nth 0 (parse-partial-sexp (point) p))
3057 what (elt i 4)) ; First char on current line
3058 (goto-char (elt i 3)) ; previous line
3059 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3060 (cond ((eq what ?\) )
3061 (- cperl-close-paren-offset)) ; compensate
3063 (- (or cperl-regexp-indent-step cperl-indent-level)))
3065 (if (eq (following-char) ?\| )
3066 (or cperl-regexp-indent-step cperl-indent-level)
3070 (error "Unrecognized value of indent: %s" i))))
3072 ;; Indenter for stuff at toplevel
3074 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3075 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3076 (goto-char (elt i 1)) ; start = Good place to start parsing
3077 (- (current-indentation) ;
3078 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3079 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3080 ;; Look at previous line that's at column 0
3081 ;; to determine whether we are in top-level decls
3082 ;; or function's arg decls. Set basic-indent accordingly.
3083 ;; Now add a little if this is a continuation line.
3084 (if (elt i 3) ; state (XXX What is the semantic???)
3086 cperl-continued-statement-offset)))
3088 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3090 ((eq 'in-parens (elt i 0))
3091 ;; in-parens char-after old-indent-point is-brace containing-sexp
3093 ;; group is an expression, not a block:
3094 ;; indent to just after the surrounding open parens,
3095 ;; skip blanks if we do not close the expression.
3097 (goto-char (elt i 2)) ; old-indent-point
3099 (if (and (elt i 3) ; is-brace
3100 (eq (elt i 1) ?\})) ; char-after
3101 ;; Correct indentation of trailing ?\}
3102 (+ cperl-indent-level cperl-close-paren-offset)
3105 ;; Indenter for continuation lines
3107 ((eq 'continuation (elt i 0))
3108 ;; [continuation statement-start char-after is-block is-brace]
3109 (goto-char (elt i 1)) ; statement-start
3110 (+ (if (memq (elt i 2) (append "}])" nil)) ; char-after
3112 cperl-continued-statement-offset)
3113 (if (or (elt i 3) ; is-block
3114 (not (elt i 4)) ; is-brace
3115 (not (eq (elt i 2) ?\}))) ; char-after
3117 ;; Now it is a hash reference
3118 (+ cperl-indent-level cperl-close-paren-offset))
3119 ;; Labels do not take :: ...
3120 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
3121 (if (> (current-indentation) cperl-min-label-indent)
3122 (- (current-indentation) cperl-label-offset)
3123 ;; Do not move `parse-data', this should
3124 ;; be quick anyway (this comment comes
3125 ;; from different location):
3126 (cperl-calculate-indent))
3128 (if (eq (elt i 2) ?\{) ; char-after
3129 cperl-continued-brace-offset 0)))
3131 ;; Indenter for lines in a block which are not leading lines
3133 ((eq 'have-prev-sibling (elt i 0))
3134 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
3135 (goto-char (elt i 1)) ; sibling-beg
3136 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
3137 (if (> (current-indentation)
3138 cperl-min-label-indent)
3139 (- (current-indentation) cperl-label-offset)
3140 ;; Do not believe: `max' was involved in calculation of indent
3141 (+ cperl-indent-level
3143 (goto-char (elt i 3)) ; block-start
3144 (current-indentation))))
3147 ;; Indenter for the first line in a block
3149 ((eq 'code-start-in-block (elt i 0))
3150 ;;[code-start-in-block before-brace char-after
3151 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3152 ;; group-starts-before-start-of-sub start-of-control-group]
3153 (goto-char (elt i 1))
3154 ;; For open brace in column zero, don't let statement
3155 ;; start there too. If cperl-indent-level=0,
3156 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3157 (+ (if (and (bolp) (zerop cperl-indent-level))
3158 (+ cperl-brace-offset cperl-continued-statement-offset)
3160 (if (and (elt i 3) ; is-a-HASH-ref
3161 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3162 (+ cperl-indent-level cperl-close-paren-offset)
3164 ;; Unless openbrace is the first nonwhite thing on the line,
3165 ;; add the cperl-brace-imaginary-offset.
3166 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3167 cperl-brace-imaginary-offset)
3169 (goto-char (elt i 6)) ; start-of-control-group
3170 (if (elt i 5) ; group-starts-before-start-of-sub
3172 ;; Get initial indentation of the line we are on.
3173 ;; If line starts with label, calculate label indentation
3176 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3177 (if (> (current-indentation) cperl-min-label-indent)
3178 (- (current-indentation) cperl-label-offset)
3179 ;; Do not move `parse-data', this should
3181 (cperl-calculate-indent))
3182 (current-indentation))))))
3184 (error "Unrecognized value of indent: %s" i))))
3186 (error "Got strange value of indent: %s" i))))))
3188 (defun cperl-calculate-indent-within-comment ()
3189 "Return the indentation amount for line, assuming that
3190 the current line is to be regarded as part of a block comment."
3191 (let (end star-start)
3194 (skip-chars-forward " \t")
3196 (and (= (following-char) ?#)
3198 (cperl-to-comment-or-eol)
3204 (defun cperl-to-comment-or-eol ()
3205 "Go to position before comment on the current line, or to end of line.
3206 Returns true if comment is found. In POD will not move the point."
3207 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3208 ;; then looks for literal # or end-of-line.
3209 (let (state stop-in cpoint (lim (point-at-eol)) pr e)
3210 (or cperl-font-locking
3211 (cperl-update-syntaxification lim lim))
3213 (if (setq pr (get-text-property (point) 'syntax-type))
3214 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3215 (if (or (eq pr 'pod)
3216 (if (or (not e) (> e lim)) ; deep inside a group
3217 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
3218 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
3219 ;; Else - need to do it the hard way
3220 (and (and e (<= e lim))
3222 (while (not stop-in)
3223 (setq state (parse-partial-sexp (point) lim nil nil nil t))
3225 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3226 (if (nth 4 state) ; After `#';
3227 ; (nth 2 state) can be
3228 ; beginning of m,s,qq and so
3232 (setq cpoint (point))
3233 (goto-char (nth 2 state))
3235 ((looking-at "\\(s\\|tr\\)\\>")
3236 (or (re-search-forward
3237 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
3240 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
3241 (or (re-search-forward
3242 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
3245 (t ; It was fair comment
3246 (setq stop-in t) ; Finish
3247 (goto-char (1- cpoint)))))
3248 (setq stop-in t) ; Finish
3250 (setq stop-in t))) ; Finish
3253 (defsubst cperl-modify-syntax-type (at how)
3254 (if (< at (point-max))
3256 (put-text-property at (1+ at) 'syntax-table how)
3257 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
3259 (defun cperl-protect-defun-start (s e)
3260 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
3263 (while (re-search-forward "^\\s(" e 'to-end)
3264 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3266 (defun cperl-commentify (bb e string &optional noface)
3267 (if cperl-use-syntax-table-text-property
3268 (if (eq noface 'n) ; Only immediate
3270 ;; We suppose that e is _after_ the end of construction, as after eol.
3271 (setq string (if string cperl-st-sfence cperl-st-cfence))
3273 ;; one-char string/comment?!
3274 (cperl-modify-syntax-type bb cperl-st-punct)
3275 (cperl-modify-syntax-type bb string)
3276 (cperl-modify-syntax-type (1- e) string))
3277 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
3278 (put-text-property (1+ bb) (1- e)
3279 'syntax-table cperl-string-syntax-table))
3280 (cperl-protect-defun-start bb e))
3283 (not cperl-pod-here-fontify)
3284 (put-text-property bb e 'face (if string 'font-lock-string-face
3285 'font-lock-comment-face)))))
3287 (defvar cperl-starters '(( ?\( . ?\) )
3292 (defun cperl-cached-syntax-table (st)
3293 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3294 All the entries of the syntax table are \".\", except for a backslash, which
3298 (setcar st (make-syntax-table))
3302 (modify-syntax-entry i "." st)
3304 (modify-syntax-entry ?\\ "\\" st)
3307 (defun cperl-forward-re (lim end is-2arg st-l err-l argument
3308 &optional ostart oend)
3309 "Find the end of a regular expression or a stringish construct (q[] etc).
3310 The point should be before the starting delimiter.
3312 Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3313 is s/// or tr/// like expression. If END is nil, generates an error
3314 message if needed. If SET-ST is non-nil, will use (or generate) a
3315 cached syntax table in ST-L. If ERR-L is non-nil, will store the
3316 error message in its CAR (unless it already contains some error
3317 message). ARGUMENT should be the name of the construct (used in error
3318 messages). OSTART, OEND may be set in recursive calls when processing
3319 the second argument of 2ARG construct.
3321 Works *before* syntax recognition is done. In IS-2ARG situation may
3322 modify syntax-type text property if the situation is too hard."
3323 (let (b starter ender st i i2 go-forward reset-st set-st)
3324 (skip-chars-forward " \t")
3325 ;; ender means matching-char matcher.
3327 starter (if (eobp) 0 (char-after b))
3328 ender (cdr (assoc starter cperl-starters)))
3329 ;; What if starter == ?\\ ????
3330 (setq st (cperl-cached-syntax-table st-l))
3332 ;; Whether we have an intermediate point
3334 ;; Prepare the syntax table:
3335 (if (not ender) ; m/blah/, s/x//, s/x/y/
3336 (modify-syntax-entry starter "$" st)
3337 (modify-syntax-entry starter (concat "(" (list ender)) st)
3338 (modify-syntax-entry ender (concat ")" (list starter)) st))
3341 ;; We use `$' syntax class to find matching stuff, but $$
3342 ;; is recognized the same as $, so we need to check this manually.
3343 (if (and (eq starter (char-after (cperl-1+ b)))
3345 ;; $ has TeXish matching rules, so $$ equiv $...
3347 (setq reset-st (syntax-table))
3348 (set-syntax-table st)
3350 (if (<= (point) (1+ b))
3351 (error "Unfinished regular expression"))
3352 (set-syntax-table reset-st)
3354 ;; Now the problem is with m;blah;;
3356 (eq (preceding-char)
3357 (char-after (- (point) 2)))
3360 (= 0 (% (skip-chars-backward "\\\\") 2)))
3362 ;; Now we are after the first part.
3363 (and is-2arg ; Have trailing part
3365 (eq (following-char) starter) ; Empty trailing part
3367 (or (eq (char-syntax (following-char)) ?.)
3368 ;; Make trailing letter into punctuation
3369 (cperl-modify-syntax-type (point) cperl-st-punct))
3370 (setq is-2arg nil go-forward t))) ; Ignore the tail
3371 (if is-2arg ; Not number => have second part
3373 (setq i (point) i2 i)
3375 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
3377 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3378 (goto-char (match-end 0))
3379 (skip-chars-forward " \t\n\f"))
3382 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3383 (if ender (modify-syntax-entry ender "." st))
3385 (setq ender (cperl-forward-re lim end nil st-l err-l
3386 argument starter ender)
3387 ender (nth 2 ender)))))
3388 (error (goto-char lim)
3391 (set-syntax-table reset-st))
3393 (and cperl-brace-recursing
3397 "End of `%s%s%c ... %c' string/RE not found: %s"
3399 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3400 starter (or ender starter) bb)
3401 (or (car err-l) (setcar err-l b)))))
3404 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3405 (if ender (modify-syntax-entry ender "." st))))
3406 ;; i: have 2 args, after end of the first arg
3407 ;; i2: start of the second arg, if any (before delim if `ender').
3408 ;; ender: the last arg bounded by parens-like chars, the second one of them
3409 ;; starter: the starting delimiter of the first arg
3410 ;; go-forward: has 2 args, and the second part is empty
3411 (list i i2 ender starter go-forward)))
3413 (defun cperl-forward-group-in-re (&optional st-l)
3414 "Find the end of a group in a REx.
3415 Return the error message (if any). Does not work if delimiter is `)'.
3416 Works before syntax recognition is done."
3417 ;; Works *before* syntax recognition is done
3418 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3419 (let (st b reset-st)
3422 (setq st (cperl-cached-syntax-table st-l))
3423 (modify-syntax-entry ?\( "()" st)
3424 (modify-syntax-entry ?\) ")(" st)
3425 (setq reset-st (syntax-table))
3426 (set-syntax-table st)
3429 "cperl-forward-group-in-re: error %s" b)))
3430 ;; now restore the initial state
3433 (modify-syntax-entry ?\( "." st)
3434 (modify-syntax-entry ?\) "." st)))
3436 (set-syntax-table reset-st))
3440 (defvar font-lock-string-face)
3441 ;;(defvar font-lock-reference-face)
3442 (defvar font-lock-constant-face)
3443 (defsubst cperl-postpone-fontification (b e type val &optional now)
3444 ;; Do after syntactic fontification?
3445 (if cperl-syntaxify-by-font-lock
3446 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3447 (put-text-property b e type val)))
3449 ;;; Here is how the global structures (those which cannot be
3450 ;;; recognized locally) are marked:
3452 ;; Start-to-end is marked `in-pod' ==> t
3453 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3454 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3456 ;; Start-to-end is marked `here-doc-group' ==> t
3457 ;; The body is marked `syntax-type' ==> `here-doc'
3458 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3460 ;; First line (to =) marked `first-format-line' ==> t
3461 ;; After-this--to-end is marked `syntax-type' ==> `format'
3462 ;; d) 'Q'uoted string:
3463 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3464 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3465 ;; second part of s///e is marked `syntax-type' ==> `multiline'
3466 ;; e) Attributes of subroutines: `attrib-group' ==> t
3467 ;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3468 ;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3470 ;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3471 ;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
3473 (defun cperl-unwind-to-safe (before &optional end)
3474 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3475 (let ((pos (point)) opos)
3476 (while (and pos (progn
3478 (get-text-property (setq pos (point)) 'syntax-type)))
3480 pos (cperl-beginning-of-property pos 'syntax-type))
3481 (if (eq pos (point-min))
3486 (goto-char (cperl-1- pos))
3489 (goto-char (setq pos (cperl-1- pos))))
3491 (goto-char (point-min))))
3493 (and (looking-at "\n*=")
3494 (/= 0 (skip-chars-backward "\n"))
3498 ;; Do the same for end, going small steps
3500 (while (and end (get-text-property end 'syntax-type))
3502 end (next-single-property-change end 'syntax-type nil (point-max)))
3503 (if end (progn (goto-char end)
3504 (or (bolp) (forward-line 1))
3505 (setq end (point)))))
3508 ;;; These are needed for byte-compile (at least with v19)
3509 (defvar cperl-nonoverridable-face)
3510 (defvar font-lock-variable-name-face)
3511 (defvar font-lock-function-name-face)
3512 (defvar font-lock-keyword-face)
3513 (defvar font-lock-builtin-face)
3514 (defvar font-lock-type-face)
3515 (defvar font-lock-comment-face)
3516 (defvar font-lock-warning-face)
3518 (defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
3519 "Syntactically mark (and fontify) attributes of a subroutine.
3520 Should be called with the point before leading colon of an attribute."
3521 ;; Works *before* syntax recognition is done
3522 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3523 (let (st b p reset-st after-first (start (point)) start1 end1)
3527 "\\(" ; 1=optional? colon
3528 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3530 (if after-first "?" "")
3531 ;; No space between name and paren allowed...
3532 "\\(\\sw+\\)" ; 3=name
3533 "\\((\\)?")) ; 4=optional paren
3534 (and (match-beginning 1)
3535 (cperl-postpone-fontification
3536 (match-beginning 0) (cperl-1+ (match-beginning 0))
3537 'face font-lock-constant-face))
3538 (setq start1 (match-beginning 3) end1 (match-end 3))
3539 (cperl-postpone-fontification start1 end1
3540 'face font-lock-constant-face)
3541 (goto-char end1) ; end or before `('
3542 (if (match-end 4) ; Have attribute arguments...
3545 (setq st (cperl-cached-syntax-table st-l))
3546 (modify-syntax-entry ?\( "()" st)
3547 (modify-syntax-entry ?\) ")(" st))
3548 (setq reset-st (syntax-table) p (point))
3549 (set-syntax-table st)
3551 (set-syntax-table reset-st)
3553 (cperl-commentify p (point) t))) ; mark as string
3554 (forward-comment (buffer-size))
3555 (setq after-first t))
3557 "L%d: attribute `%s': %s"
3558 (count-lines (point-min) (point))
3559 (and start1 end1 (buffer-substring start1 end1)) b)
3563 (put-text-property start (point)
3564 'attrib-group (if (looking-at "{") t 0))
3566 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3567 ;; Apparently, we do not need `multiline': faces added now
3568 (put-text-property (+ 3 pos) (cperl-1+ (point))
3569 'syntax-type 'sub-decl))
3570 (and b-fname ; Fontify here: the following condition
3571 (cperl-postpone-fontification ; is too hard to determine by
3572 b-fname e-fname 'face ; a REx, so do it here
3573 (if (looking-at "{")
3574 font-lock-function-name-face
3575 font-lock-variable-name-face)))))
3576 ;; now restore the initial state
3579 (modify-syntax-entry ?\( "." st)
3580 (modify-syntax-entry ?\) "." st)))
3582 (set-syntax-table reset-st))))
3584 (defsubst cperl-look-at-leading-count (is-x-REx e)
3587 (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
3588 (1- e) t)) ; return nil on failure, no moving
3589 (if (eq ?\{ (preceding-char)) nil
3590 (cperl-postpone-fontification
3591 (1- (point)) (point)
3592 'face font-lock-warning-face))))
3594 ;; Do some smarter-highlighting
3595 ;; XXXX Currently ignores alphanum/dash delims,
3596 (defsubst cperl-highlight-charclass (endbracket dashface bsface onec-space)
3597 (let ((l '(1 5 7)) ll lle lll
3598 ;; 2 groups, the first takes the whole match (include \[trnfabe])
3599 (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{[^{}]*}" "\\)")))
3600 (while ; look for unescaped - between non-classes
3602 ;; On 19.33, certain simplifications lead
3603 ;; to bugs (as in [^a-z] \\| [trnfabe] )
3604 (concat ; 1: SingleChar (include \[trnfabe])
3606 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3607 "\\(" ; 3: DASH SingleChar (match optionally)
3609 singleChar ; 5: SingleChar
3610 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3613 "\\(" ; 7: other escapes
3614 "\\\\[pP]" "\\([^{]\\|{[^{}]*}\\)"
3615 "\\|" "\\\\[^pP]" "\\)"
3618 (if (match-beginning 4)
3619 (cperl-postpone-fontification
3620 (match-beginning 4) (match-end 4)
3622 ;; save match data (for looking-at)
3623 (setq lll (mapcar (function (lambda (elt) (cons (match-beginning elt)
3624 (match-end elt)))) l))
3629 ;; (message "Got %s of %s" ll l)
3630 (if (and ll (eq (char-after ll) ?\\ ))
3633 (cperl-postpone-fontification ll (1+ ll)
3635 (if (looking-at "\\\\[a-zA-Z0-9]")
3636 (cperl-postpone-fontification (1+ ll) lle
3637 'face onec-space))))
3638 (setq lll (cdr lll))))
3639 (goto-char endbracket) ; just in case something misbehaves???
3642 ;;; Debugging this may require (setq max-specpdl-size 2000)...
3643 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
3644 "Scans the buffer for hard-to-parse Perl constructions.
3645 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3646 the sections using `cperl-pod-head-face', `cperl-pod-face',
3649 (or min (setq min (point-min)
3650 cperl-syntax-state nil
3651 cperl-syntax-done-to min))
3652 (or max (setq max (point-max)))
3653 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3654 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3655 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
3656 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3657 (modified (buffer-modified-p)) overshoot is-o-REx name
3658 (after-change-functions nil)
3659 (cperl-font-locking t)
3660 (use-syntax-state (and cperl-syntax-state
3661 (>= min (car cperl-syntax-state))))
3662 (state-point (if use-syntax-state
3663 (car cperl-syntax-state)
3665 (state (if use-syntax-state
3666 (cdr cperl-syntax-state)))
3667 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3668 (st-l (list nil)) (err-l (list nil))
3669 ;; Somehow font-lock may be not loaded yet...
3670 ;; (e.g., when building TAGS via command-line call)
3671 (font-lock-string-face (if (boundp 'font-lock-string-face)
3672 font-lock-string-face
3673 'font-lock-string-face))
3674 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
3675 font-lock-constant-face
3676 'font-lock-constant-face))
3677 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
3678 (if (boundp 'font-lock-function-name-face)
3679 font-lock-function-name-face
3680 'font-lock-function-name-face))
3681 (font-lock-variable-name-face ; interpolated vars and ({})-code
3682 (if (boundp 'font-lock-variable-name-face)
3683 font-lock-variable-name-face
3684 'font-lock-variable-name-face))
3685 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3686 (if (boundp 'font-lock-function-name-face)
3687 font-lock-function-name-face
3688 'font-lock-function-name-face))
3689 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3690 (if (boundp 'font-lock-constant-face)
3691 font-lock-constant-face
3692 'font-lock-constant-face))
3693 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3694 (if (boundp 'font-lock-builtin-face)
3695 font-lock-builtin-face
3696 'font-lock-builtin-face))
3697 (font-lock-comment-face
3698 (if (boundp 'font-lock-comment-face)
3699 font-lock-comment-face
3700 'font-lock-comment-face))
3701 (font-lock-warning-face
3702 (if (boundp 'font-lock-warning-face)
3703 font-lock-warning-face
3704 'font-lock-warning-face))
3705 (my-cperl-REx-ctl-face ; (|)
3706 (if (boundp 'font-lock-keyword-face)
3707 font-lock-keyword-face
3708 'font-lock-keyword-face))
3709 (my-cperl-REx-modifiers-face ; //gims
3710 (if (boundp 'cperl-nonoverridable-face)
3711 cperl-nonoverridable-face
3712 'cperl-nonoverridable-face))
3713 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3714 (if (boundp 'font-lock-type-face)
3716 'font-lock-type-face))
3717 (stop-point (if ignore-max
3722 "\\(\\`\n?\\|^\n\\)=" ; POD
3724 ;; One extra () before this:
3727 ;; First variant "BLAH" or just ``.
3728 "[ \t]*" ; Yes, whitespace is allowed!
3729 "\\([\"'`]\\)" ; 2 + 1 = 3
3730 "\\([^\"'`\n]*\\)" ; 3 + 1
3733 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3734 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3735 ;; Do not have <<= or << 30 or <<30 or << $blah.
3736 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3737 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3740 ;; 1+6 extra () before this:
3741 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
3742 (if cperl-use-syntax-table-text-property
3745 ;; 1+6+2=9 extra () before this:
3746 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
3748 ;; 1+6+2+1=10 extra () before this:
3749 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3751 ;; 1+6+2+1+1=11 extra () before this
3752 "\\<sub\\>" ; sub with proto/attr
3754 cperl-white-and-comment-rex
3755 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
3757 cperl-maybe-white-and-comment-rex
3758 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
3760 ;; 1+6+2+1+1+6=17 extra () before this:
3761 "\\$\\(['{]\\)" ; $' or ${foo}
3763 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3764 ;; we do not support intervening comments...):
3765 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3766 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
3768 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
3769 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
3771 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
3777 (message "Scanning for \"hard\" Perl constructions..."))
3778 ;;(message "find: %s --> %s" min max)
3779 (and cperl-pod-here-fontify
3780 ;; We had evals here, do not know why...
3781 (setq face cperl-pod-face
3782 head-face cperl-pod-head-face
3783 here-face cperl-here-face))
3784 (remove-text-properties min max
3785 '(syntax-type t in-pod t syntax-table t
3796 ;; Need to remove face as well...
3798 ;; 'emx not supported by Emacs since at least 21.1.
3799 (and (featurep 'xemacs) (eq system-type 'emx)
3801 (let ((case-fold-search t))
3802 (looking-at "extproc[ \t]")) ; Analogue of #!
3803 (cperl-commentify min
3808 (re-search-forward search max t))
3809 (setq tmpend nil) ; Valid for most cases
3810 (setq b (match-beginning 0)
3811 state (save-excursion (parse-partial-sexp
3812 state-point b nil nil state))
3815 ;; 1+6+2+1+1+6=17 extra () before this:
3817 ((match-beginning 18) ; $' or ${foo}
3818 (if (eq (preceding-char) ?\') ; $'
3820 (setq b (1- (point))
3821 state (parse-partial-sexp
3822 state-point (1- b) nil nil state)
3824 (if (nth 3 state) ; in string
3825 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3828 (setq bb (match-beginning 0))
3829 (cperl-modify-syntax-type bb cperl-st-punct)))
3830 ;; No processing in strings/comments beyond this point:
3831 ((or (nth 3 state) (nth 4 state))
3832 t) ; Do nothing in comment/string
3833 ((match-beginning 1) ; POD section
3834 ;; "\\(\\`\n?\\|^\n\\)="
3835 (setq b (match-beginning 0)
3836 state (parse-partial-sexp
3837 state-point b nil nil state)
3839 (if (or (nth 3 state) (nth 4 state)
3840 (looking-at "cut\\>"))
3841 (if (or (nth 3 state) (nth 4 state) ignore-max)
3842 nil ; Doing a chunk only
3843 (message "=cut is not preceded by a POD section")
3844 (or (car err-l) (setcar err-l (point))))
3849 tb (match-beginning 0)
3850 b1 nil) ; error condition
3851 ;; We do not search to max, since we may be called from
3852 ;; some hook of fontification, and max is random
3853 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
3856 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3858 (message "=cut is not preceded by an empty line")
3860 (or (car err-l) (setcar err-l b))))))
3861 (beginning-of-line 2) ; An empty line after =cut is not POD!
3865 (remove-text-properties
3866 max e '(syntax-type t in-pod t syntax-table t
3878 (put-text-property b e 'in-pod t)
3879 (put-text-property b e 'syntax-type 'in-pod)
3881 (while (re-search-forward "\n\n[ \t]" e t)
3882 ;; We start 'pod 1 char earlier to include the preceding line
3884 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3885 (cperl-put-do-not-fontify b (point) t)
3886 ;; mark the non-literal parts as PODs
3887 (if cperl-pod-here-fontify
3888 (cperl-postpone-fontification b (point) 'face face t))
3889 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3892 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3893 (cperl-put-do-not-fontify (point) e t)
3894 (if cperl-pod-here-fontify
3896 ;; mark the non-literal parts as PODs
3897 (cperl-postpone-fontification (point) e 'face face t)
3900 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3902 (cperl-postpone-fontification
3903 (match-beginning 1) (match-end 1)
3905 (while (re-search-forward
3907 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3910 (cperl-postpone-fontification
3911 (match-beginning 1) (match-end 1)
3913 (cperl-commentify bb e nil)
3915 (or (eq e (point-max))
3916 (forward-char -1)))) ; Prepare for immediate POD start.
3918 ;; We can do many here-per-line;
3919 ;; but multiline quote on the same line as <<HERE confuses us...
3920 ;; ;; One extra () before this:
3923 ;; ;; First variant "BLAH" or just ``.
3924 ;; "[ \t]*" ; Yes, whitespace is allowed!
3925 ;; "\\([\"'`]\\)" ; 2 + 1
3926 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3929 ;; ;; Second variant: Identifier or \ID or empty
3930 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3931 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3932 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3933 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3935 ((match-beginning 2) ; 1 + 1
3937 tb (match-beginning 0)
3938 c (and ; not HERE-DOC
3941 (or (looking-at "[ \t]*(") ; << function_call()
3942 (save-excursion ; 1 << func_name, or $foo << 10
3946 ;;; XXX What to do: foo <<bar ???
3947 ;;; XXX Need to support print {a} <<B ???
3950 ; $foo << b; $f .= <<B;
3951 ; ($f+1) << b; a($f) . <<B;
3952 ; foo 1, <<B; $x{a} <<b;
3954 ((looking-at "[0-9$({]")
3957 (looking-at "[ \t]*<<")
3963 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
3965 (error nil))) ; func(<<EOF)
3966 (and (not (match-beginning 6)) ; Empty
3968 "[ \t]*[=0-9$@%&(]"))))))
3969 (if c ; Not here-doc
3971 (setq c (match-end 2)) ; 1 + 1
3972 (if (match-beginning 5) ;4 + 1
3973 (setq b1 (match-beginning 5) ; 4 + 1
3974 e1 (match-end 5)) ; 4 + 1
3975 (setq b1 (match-beginning 4) ; 3 + 1
3976 e1 (match-end 4))) ; 3 + 1
3977 (setq tag (buffer-substring b1 e1)
3978 qtag (regexp-quote tag))
3979 (cond (cperl-pod-here-fontify
3980 ;; Highlight the starting delimiter
3981 (cperl-postpone-fontification
3982 b1 e1 'face my-cperl-delimiters-face)
3983 (cperl-put-do-not-fontify b1 e1 t)))
3987 (goto-char end-of-here-doc))
3989 ;; We do not search to max, since we may be called from
3990 ;; some hook of fontification, and max is random
3991 (or (and (re-search-forward (concat "^" qtag "$")
3993 ;;;(eq (following-char) ?\n) ; XXXX WHY???
3995 (progn ; Pretend we matched at the end
3996 (goto-char (point-max))
3997 (re-search-forward "\\'")
3998 (message "End of here-document `%s' not found." tag)
3999 (or (car err-l) (setcar err-l b))))
4000 (if cperl-pod-here-fontify
4002 ;; Highlight the ending delimiter
4003 (cperl-postpone-fontification
4004 (match-beginning 0) (match-end 0)
4005 'face my-cperl-delimiters-face)
4006 (cperl-put-do-not-fontify b (match-end 0) t)
4007 ;; Highlight the HERE-DOC
4008 (cperl-postpone-fontification b (match-beginning 0)
4010 (setq e1 (cperl-1+ (match-end 0)))
4011 (put-text-property b (match-beginning 0)
4012 'syntax-type 'here-doc)
4013 (put-text-property (match-beginning 0) e1
4014 'syntax-type 'here-doc-delim)
4015 (put-text-property b e1 'here-doc-group t)
4016 ;; This makes insertion at the start of HERE-DOC update
4017 ;; the whole construct:
4018 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
4019 (cperl-commentify b e1 nil)
4020 (cperl-put-do-not-fontify b (match-end 0) t)
4021 ;; Cache the syntax info...
4022 (setq cperl-syntax-state (cons state-point state))
4023 ;; ... and process the rest of the line...
4025 (elt ; non-inter ignore-max
4026 (cperl-find-pods-heres c i t end t e1) 1))
4027 (if (and overshoot (> overshoot (point)))
4028 (goto-char overshoot)
4029 (setq overshoot e1))
4033 ((match-beginning 8)
4034 ;; 1+6=7 extra () before this:
4035 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
4037 name (if (match-beginning 8) ; 7 + 1
4038 (buffer-substring (match-beginning 8) ; 7 + 1
4039 (match-end 8)) ; 7 + 1
4041 tb (match-beginning 0))
4043 (put-text-property (point-at-bol) b 'first-format-line 't)
4044 (if cperl-pod-here-fontify
4045 (while (and (eq (forward-line) 0)
4046 (not (looking-at "^[.;]$")))
4048 ((looking-at "^#")) ; Skip comments
4049 ((and argument ; Skip argument multi-lines
4050 (looking-at "^[ \t]*{"))
4052 (setq argument nil))
4053 (argument ; Skip argument lines
4054 (setq argument nil))
4057 (setq argument (looking-at "^[^\n]*[@^]"))
4059 ;; Highlight the format line
4060 (cperl-postpone-fontification b1 (point)
4061 'face font-lock-string-face)
4062 (cperl-commentify b1 (point) nil)
4063 (cperl-put-do-not-fontify b1 (point) t))))
4064 ;; We do not search to max, since we may be called from
4065 ;; some hook of fontification, and max is random
4066 (re-search-forward "^[.;]$" stop-point 'toend))
4068 (if (looking-at "^\\.$") ; ";" is not supported yet
4070 ;; Highlight the ending delimiter
4071 (cperl-postpone-fontification (point) (+ (point) 2)
4072 'face font-lock-string-face)
4073 (cperl-commentify (point) (+ (point) 2) nil)
4074 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
4075 (message "End of format `%s' not found." name)
4076 (or (car err-l) (setcar err-l b)))
4080 (put-text-property b (point) 'syntax-type 'format))
4081 ;; qq-like String or Regexp:
4082 ((or (match-beginning 10) (match-beginning 11))
4083 ;; 1+6+2=9 extra () before this:
4084 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
4086 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
4087 (setq b1 (if (match-beginning 10) 10 11)
4088 argument (buffer-substring
4089 (match-beginning b1) (match-end b1))
4090 b (point) ; end of qq etc
4092 c (char-after (match-beginning b1))
4093 bb (char-after (1- (match-beginning b1))) ; tmp holder
4094 ;; bb == "Not a stringy"
4095 bb (if (eq b1 10) ; user variables/whatever
4096 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4097 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4098 ((eq bb ?\:) ; $opt::s
4100 (- (match-beginning b1) 2))
4102 ((eq bb ?\>) ; $foo->s
4104 (- (match-beginning b1) 2))
4107 (not (eq (char-after ; &&m/blah/
4108 (- (match-beginning b1) 2))
4111 ;; <file> or <$file>
4113 ;; Do not stringify <FH>, <$fh> :
4116 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
4117 tb (match-beginning 0))
4118 (goto-char (match-beginning b1))
4119 (cperl-backward-to-noncomment (point-min))
4121 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
4126 ;; What is below: regexp-p?
4128 (or (memq (preceding-char)
4129 (append (if (memq c '(?\? ?\<))
4132 "~{(=|&+-*!,;:[") nil))
4133 (and (eq (preceding-char) ?\})
4134 (cperl-after-block-p (point-min)))
4135 (and (eq (char-syntax (preceding-char)) ?w)
4138 ;; After these keywords `/' starts a RE. One should add all the
4139 ;; functions/builtins which expect an argument, but ...
4140 (if (eq (preceding-char) ?-)
4142 (looking-at "[a-zA-Z]\\>")
4144 (not (memq (preceding-char)
4147 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4148 (and (eq (preceding-char) ?.)
4149 (eq (char-after (- (point) 2)) ?.))
4151 ;; m|blah| ? foo : bar;
4154 cperl-use-syntax-table-text-property
4158 (looking-at "\\s|"))))))
4161 ;; Check for $a -> y
4162 (setq b1 (preceding-char)
4165 (eq (char-after (- go 2)) ?-))
4171 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4172 (goto-char (match-end 0))
4173 (skip-chars-forward " \t\n\f"))
4174 (cond ((and (eq (following-char) ?\})
4176 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4178 (skip-chars-backward " \t\n\f")
4179 (if (memq (preceding-char) (append "$@%&*" nil))
4185 (looking-at ; $foo -> {s}
4186 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
4187 (and ; $foo[12] -> {s}
4188 (memq (following-char) '(?\{ ?\[))
4191 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
4194 ((and (eq (following-char) ?=)
4195 (eq (char-after (1+ (point))) ?\>))
4196 ;; Check for { foo => 1, s => 2 }
4197 ;; Apparently s=> is never a substitution...
4199 ((and (eq (following-char) ?:)
4200 (eq b1 ?\{) ; Check for $ { s::bar }
4201 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
4204 (skip-chars-backward " \t\n\f")
4205 (memq (preceding-char)
4206 (append "$@%&*" nil))))
4212 ;; Skip whitespace and comments...
4213 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4214 (goto-char (match-end 0))
4215 (skip-chars-forward " \t\n\f"))
4217 (put-text-property b (point) 'syntax-type 'prestring))
4218 ;; qtag means two-arg matcher, may be reset to
4219 ;; 2 or 3 later if some special quoting is needed.
4220 ;; e1 means matching-char matcher.
4221 (setq b (point) ; before the first delimiter
4223 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
4224 ;; We do not search to max, since we may be called from
4225 ;; some hook of fontification, and max is random
4226 i (cperl-forward-re stop-point end
4228 st-l err-l argument)
4229 ;; If `go', then it is considered as 1-arg, `b1' is nil
4230 ;; as in s/foo//x; the point is before final "slash"
4231 b1 (nth 1 i) ; start of the second part
4232 tag (nth 2 i) ; ender-char, true if second part
4233 ; is with matching chars []
4234 go (nth 4 i) ; There is a 1-char part after the end
4235 i (car i) ; intermediate point
4237 ;; Before end of the second part if non-matching: ///
4238 tail (if (and i (not tag))
4240 e (if i i e1) ; end of the first part
4241 qtag nil ; need to preserve backslashitis
4242 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4243 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
4244 ;; Commenting \\ is dangerous, what about ( ?
4246 (eq (char-after i) ?\\)
4248 (and (if go (looking-at ".\\sw*x")
4249 (looking-at "\\sw*x")) ; qr//x
4251 (and (if go (looking-at ".\\sw*o")
4252 (looking-at "\\sw*o")) ; //o
4255 ;; Considered as 1arg form
4257 (cperl-commentify b (point) t)
4258 (put-text-property b (point) 'syntax-type 'string)
4260 ;; ignore other text properties:
4261 (string-match "^qw$" argument))
4262 (put-text-property b (point) 'indentable t))
4264 (setq e1 (cperl-1+ e1))
4267 (cperl-commentify b i t)
4268 (if (looking-at "\\sw*e") ; s///e
4270 ;; Cache the syntax info...
4271 (setq cperl-syntax-state (cons state-point state))
4274 (car (cperl-find-pods-heres b1 (1- (point)) t end))
4276 (goto-char (1+ max)))
4277 (if (and tag (eq (preceding-char) ?\>))
4279 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
4280 (cperl-modify-syntax-type i cperl-st-bra)))
4281 (put-text-property b i 'syntax-type 'string)
4282 (put-text-property i (point) 'syntax-type 'multiline)
4284 (put-text-property b i 'indentable t)))
4285 (cperl-commentify b1 (point) t)
4286 (put-text-property b (point) 'syntax-type 'string)
4288 (put-text-property b i 'indentable t))
4290 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
4292 ;; Now: tail: if the second part is non-matching without ///e
4293 (if (eq (char-syntax (following-char)) ?w)
4295 (forward-word 1) ; skip modifiers s///s
4296 (if tail (cperl-commentify tail (point) t))
4297 (cperl-postpone-fontification
4298 e1 (point) 'face my-cperl-REx-modifiers-face)))
4299 ;; Check whether it is m// which means "previous match"
4300 ;; and highlight differently
4302 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
4303 (or (not (= (length argument) 0))
4307 ;; split // *is* using zero-pattern
4313 (not (looking-at "split\\>")))
4315 (cperl-postpone-fontification
4316 b e 'face font-lock-warning-face)
4317 (if (or i2 ; Has 2 args
4318 (and cperl-fontify-m-as-s
4320 (string-match "^\\(m\\|qr\\)$" argument)
4321 (and (eq 0 (length argument))
4322 (not (eq ?\< (char-after b)))))))
4324 (cperl-postpone-fontification
4325 b (cperl-1+ b) 'face my-cperl-delimiters-face)
4326 (cperl-postpone-fontification
4327 (1- e) e 'face my-cperl-delimiters-face)))
4328 (if (and is-REx cperl-regexp-scan)
4329 ;; Process RExen: embedded comments, charclasses and ]
4330 ;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
4331 ;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4332 ;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
4333 ;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
4334 ;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4335 ;;;m^a[\^b]c^ + m.a[^b]\.c.;
4339 (cperl-look-at-leading-count is-x-REx e)
4343 (if (eq (char-after b) ?\#)
4344 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
4345 "\\((\\?#\\)\\|\\(#\\)")
4346 ;; keep the same count: add a fake group
4347 (if (eq (char-after b) ?\#)
4348 "\\((\\?\\\\#\\)\\(\\)"
4349 "\\((\\?#\\)\\(\\)"))
4355 ;; XXXX Will not be able to use it in s)))
4356 (if (eq (char-after b) ?\) )
4357 "\\())))\\)" ; Will never match
4358 (if (eq (char-after b) ?? )
4359 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
4360 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
4361 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
4362 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
4363 "\\(" ;; XXXX 1-char variables, exc. |()\s
4366 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4368 "{[^{}]*}" ; only one-level allowed
4372 "\\(" ;;8,9:code part of array/hash elt
4378 ;; XXXX: what if u is delim?
4386 "\\\\[luLUEQbBAzZG]"
4389 "\\(" ; 10 group opener follower
4390 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
4392 "\\?[:=!>?{]" ; "?" something
4394 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
4396 "\\?([0-9]+)" ; (?(1)foo|bar)
4404 "\\\\\\(.\\)" ; 12=\SYMBOL
4407 (and (< (point) (1- e))
4408 (re-search-forward hairy-RE (1- e) 'to-end))
4409 (goto-char (match-beginning 0))
4410 (setq REx-subgr-start (point)
4411 was-subgr (following-char))
4413 ((match-beginning 6) ; 0-length builtins, groups
4414 (goto-char (match-end 0))
4415 (if (match-beginning 11)
4416 (goto-char (match-beginning 11)))
4419 (cperl-postpone-fontification
4420 (match-beginning 0) (point)
4423 ((eq was-subgr ?\) )
4428 (if (if (eq (char-after b) ?? )
4429 (looking-at "(\\\\\\?")
4430 (eq (char-after (1+ (point))) ?\?))
4431 my-cperl-REx-0length-face
4432 my-cperl-REx-ctl-face)
4433 font-lock-warning-face))
4434 (error font-lock-warning-face)))
4435 ((eq was-subgr ?\| )
4436 my-cperl-REx-ctl-face)
4437 ((eq was-subgr ?\$ )
4438 (if (> (point) (1+ REx-subgr-start))
4441 (match-beginning 0) (point)
4444 (if (and (eq (match-beginning 0)
4448 font-lock-variable-name-face)
4449 my-cperl-REx-spec-char-face))
4450 ((memq was-subgr (append "^." nil) )
4451 my-cperl-REx-spec-char-face)
4452 ((eq was-subgr ?\( )
4453 (if (not (match-beginning 10))
4454 my-cperl-REx-ctl-face
4455 my-cperl-REx-0length-face))
4456 (t my-cperl-REx-0length-face)))
4457 (if (and (memq was-subgr (append "(|" nil))
4458 (not (string-match "(\\?[-imsx]+)"
4460 (cperl-look-at-leading-count is-x-REx e))
4461 (setq was-subgr nil)) ; We do stuff here
4462 ((match-beginning 12) ; \SYMBOL
4466 ;; How many chars to not highlight:
4467 ;; 0-len special-alnums in other branch =>
4468 ;; Generic: \non-alnum (1), \alnum (1+face)
4469 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
4470 (setq REx-subgr-start (point)
4471 qtag (preceding-char))
4472 (cperl-postpone-fontification
4473 (- (point) 2) (- (point) 1) 'face
4475 (append "ghijkmoqvFHIJKMORTVY" nil))
4476 font-lock-warning-face
4477 my-cperl-REx-0length-face))
4478 (if (and (eq (char-after b) qtag)
4479 (memq qtag (append ".])^$|*?+" nil)))
4481 (if (and cperl-use-syntax-table-text-property
4484 REx-subgr-start (1- (point))
4485 'syntax-table cperl-st-punct))
4486 (cperl-postpone-fontification
4487 (1- (point)) (point) 'face
4488 ; \] can't appear below
4489 (if (memq qtag (append ".]^$" nil))
4490 'my-cperl-REx-spec-char-face
4491 (if (memq qtag (append "*?+" nil))
4492 'my-cperl-REx-0length-face
4493 'my-cperl-REx-ctl-face))))) ; )|
4494 ;; Test for arguments:
4496 ;; This is not pretty: the 5.8.7 logic:
4497 ;; \0numx -> octal (up to total 3 dig)
4498 ;; \DIGIT -> backref unless \0
4499 ;; \DIGITs -> backref if valid
4500 ;; otherwise up to 3 -> octal
4501 ;; Do not try to distinguish, we guess
4502 ((or (and (memq qtag (append "01234567" nil))
4504 "\\=[01234567]?[01234567]?"
4506 (and (memq qtag (append "89" nil))
4508 "\\=[0123456789]*" (1- e) 'to-end))
4511 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
4513 (and (memq qtag (append "pPN" nil))
4514 (re-search-forward "\\={[^{}]+}\\|."
4516 (eq (char-syntax qtag) ?w))
4517 (cperl-postpone-fontification
4518 (1- REx-subgr-start) (point)
4519 'face my-cperl-REx-length1-face))))
4520 (setq was-subgr nil)) ; We do stuff here
4521 ((match-beginning 3) ; [charclass]
4522 ;; Highlight leader, trailer, POSIX classes
4524 (if (eq (char-after b) ?^ )
4525 (and (eq (following-char) ?\\ )
4526 (eq (char-after (cperl-1+ (point)))
4529 (and (eq (following-char) ?^ )
4531 (setq argument b ; continue? & end of last POSIX
4532 tag nil ; list of POSIX classes
4533 qtag (point)) ; after leading ^ if present
4534 (if (eq (char-after b) ?\] )
4535 (and (eq (following-char) ?\\ )
4536 (eq (char-after (cperl-1+ (point)))
4538 (setq qtag (1+ qtag))
4540 (and (eq (following-char) ?\] )
4542 (setq REx-subgr-end qtag) ;End smart-highlighted
4543 ;; Apparently, I can't put \] into a charclass
4544 ;; in m]]: m][\\\]\]] produces [\\]]
4545 ;;; POSIX? [:word:] [:^word:] only inside []
4546 ;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
4547 (while ; look for unescaped ]
4550 (if (eq (char-after b) ?\] )
4551 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
4552 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
4554 ;; Is this ] an end of POSIX class?
4557 (search-backward "[" argument t)
4558 (< REx-subgr-start (point))
4559 (setq argument (point)) ; POSIX-start
4560 (or ; Should work with delim = \
4561 (not (eq (preceding-char) ?\\ ))
4562 ;; XXXX Double \\ is needed with 19.33
4563 (= (% (skip-chars-backward "\\\\") 2) 0))
4566 ((eq (char-after b) ?\] )
4567 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
4568 ((eq (char-after b) ?\: )
4569 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
4570 ((eq (char-after b) ?^ )
4571 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
4572 ((eq (char-syntax (char-after b))
4575 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
4576 (char-to-string (char-after b))
4578 (t "\\\\*\\[:\\^?\\sw*:]")))
4579 (goto-char REx-subgr-end)
4580 (cperl-highlight-charclass
4581 argument my-cperl-REx-spec-char-face
4582 my-cperl-REx-0length-face my-cperl-REx-length1-face)))
4583 (setq tag (cons (cons argument (point))
4586 REx-subgr-end argument) ; continue
4587 (setq argument nil)))
4589 (message "Couldn't find end of charclass in a REx, pos=%s"
4591 (setq argument (1- (point)))
4592 (goto-char REx-subgr-end)
4593 (cperl-highlight-charclass
4594 argument my-cperl-REx-spec-char-face
4595 my-cperl-REx-0length-face my-cperl-REx-length1-face)
4597 ;; Highlight starter, trailer, POSIX
4598 (if (and cperl-use-syntax-table-text-property
4599 (> (- (point) 2) REx-subgr-start))
4601 (1+ REx-subgr-start) (1- (point))
4602 'syntax-table cperl-st-punct))
4603 (cperl-postpone-fontification
4604 REx-subgr-start qtag
4605 'face my-cperl-REx-spec-char-face)
4606 (cperl-postpone-fontification
4607 (1- (point)) (point) 'face
4608 my-cperl-REx-spec-char-face)
4609 (if (eq (char-after b) ?\] )
4610 (cperl-postpone-fontification
4611 (- (point) 2) (1- (point))
4612 'face my-cperl-REx-0length-face))
4614 (cperl-postpone-fontification
4615 (car (car tag)) (cdr (car tag))
4616 'face font-lock-variable-name-face) ;my-cperl-REx-length1-face
4617 (setq tag (cdr tag)))
4618 (setq was-subgr nil)) ; did facing already
4620 ((and (match-beginning 2) ; #-comment
4621 (/= (match-beginning 2) (match-end 2)))
4622 (beginning-of-line 2)
4624 (goto-char (1- e))))
4625 ((match-beginning 4) ; character "]"
4626 (setq was-subgr nil) ; We do stuff here
4627 (goto-char (match-end 0))
4628 (if cperl-use-syntax-table-text-property
4630 (1- (point)) (point)
4631 'syntax-table cperl-st-punct))
4632 (cperl-postpone-fontification
4633 (1- (point)) (point)
4634 'face font-lock-warning-face))
4635 ((match-beginning 5) ; before (?{}) (??{})
4636 (setq tag (match-end 0))
4638 (cperl-forward-group-in-re st-l))
4640 (setq qtag "no matching `)' found"))
4641 (and (not (eq (char-after (- (point) 2))
4643 (setq qtag "Can't find })")))
4646 (message "%s" qtag))
4647 (cperl-postpone-fontification
4648 (1- tag) (1- (point))
4649 'face font-lock-variable-name-face)
4650 (cperl-postpone-fontification
4651 REx-subgr-start (1- tag)
4652 'face my-cperl-REx-spec-char-face)
4653 (cperl-postpone-fontification
4654 (1- (point)) (point)
4655 'face my-cperl-REx-spec-char-face)
4656 (if cperl-use-syntax-table-text-property
4659 (- (point) 2) (1- (point))
4660 'syntax-table cperl-st-cfence)
4662 (+ REx-subgr-start 2)
4663 (+ REx-subgr-start 3)
4664 'syntax-table cperl-st-cfence))))
4665 (setq was-subgr nil))
4667 ;; Inside "(" and "\" arn't special in any way
4668 ;; Works also if the outside delimiters are ().
4669 (or;;(if (eq (char-after b) ?\) )
4670 ;;(re-search-forward
4671 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
4673 (search-forward ")" (1- e) 'toend)
4676 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4682 (setq REx-subgr-end (point))
4684 REx-subgr-start REx-subgr-end nil)
4685 (cperl-postpone-fontification
4686 REx-subgr-start REx-subgr-end
4687 'face font-lock-comment-face))))))
4688 (if (and is-REx is-x-REx)
4689 (put-text-property (1+ b) (1- e)
4690 'syntax-subtype 'x-REx)))
4691 (if (and i2 e1 (or (not b1) (> e1 b1)))
4692 (progn ; No errors finding the second part...
4693 (cperl-postpone-fontification
4694 (1- e1) e1 'face my-cperl-delimiters-face)
4695 (if (and (not (eobp))
4696 (assoc (char-after b) cperl-starters))
4698 (cperl-postpone-fontification
4699 b1 (1+ b1) 'face my-cperl-delimiters-face)
4700 (put-text-property b1 (1+ b1)
4704 ((match-beginning 17) ; sub with prototype or attribute
4705 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4706 ;;"\\<sub\\>\\(" ;12
4707 ;; cperl-white-and-comment-rex ;13
4708 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
4709 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
4710 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
4711 (setq b1 (match-beginning 14) e1 (match-end 14))
4712 (if (memq (char-after (1- b))
4713 '(?\$ ?\@ ?\% ?\& ?\*))
4716 (if (eq (char-after (match-beginning 17)) ?\( )
4718 (cperl-commentify ; Prototypes; mark as string
4719 (match-beginning 17) (match-end 17) t)
4720 (goto-char (match-end 0))
4721 ;; Now look for attributes after prototype:
4722 (forward-comment (buffer-size))
4723 (and (looking-at ":[^:]")
4724 (cperl-find-sub-attrs st-l b1 e1 b)))
4725 ;; treat attributes without prototype
4726 (goto-char (match-beginning 17))
4727 (cperl-find-sub-attrs st-l b1 e1 b))))
4728 ;; 1+6+2+1+1+6+1=18 extra () before this:
4729 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
4730 ((match-beginning 19) ; old $abc'efg syntax
4731 (setq bb (match-end 0))
4732 ;;;(if (nth 3 state) nil ; in string
4733 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
4735 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
4736 ;; "__\\(END\\|DATA\\)__"
4737 ((match-beginning 20) ; __END__, __DATA__
4738 (setq bb (match-end 0))
4739 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4740 (cperl-commentify b bb nil)
4742 ;; "\\\\\\(['`\"($]\\)"
4743 ((match-beginning 21)
4744 ;; Trailing backslash; make non-quoting outside string/comment
4745 (setq bb (match-end 0))
4747 (skip-chars-backward "\\\\")
4748 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
4749 (cperl-modify-syntax-type b cperl-st-punct)
4751 (t (error "Error in regexp of the sniffer")))
4752 (if (> (point) stop-point)
4755 (message "Garbage after __END__/__DATA__ ignored")
4756 (message "Unbalanced syntax found while scanning")
4757 (or (car err-l) (setcar err-l b)))
4758 (goto-char stop-point))))
4759 (setq cperl-syntax-state (cons state-point state)
4760 ;; Do not mark syntax as done past tmpend???
4761 cperl-syntax-done-to (or tmpend (max (point) max)))
4762 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4764 (if (car err-l) (goto-char (car err-l))
4766 (message "Scanning for \"hard\" Perl constructions... done"))))
4767 (and (buffer-modified-p)
4769 (set-buffer-modified-p nil))
4770 ;; I do not understand what this is doing here. It breaks font-locking
4771 ;; because it resets the syntax-table from font-lock-syntax-table to
4772 ;; cperl-mode-syntax-table.
4773 ;; (set-syntax-table cperl-mode-syntax-table)
4775 (list (car err-l) overshoot)))
4777 (defun cperl-find-pods-heres-region (min max)
4779 (cperl-find-pods-heres min max))
4781 (defun cperl-backward-to-noncomment (lim)
4782 ;; Stops at lim or after non-whitespace that is not in comment
4783 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
4785 (while (and (not stop) (> (point) (or lim (point-min))))
4786 (skip-chars-backward " \t\n\f" lim)
4789 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4790 '(pod here-doc here-doc-delim))
4792 (cperl-unwind-to-safe nil)
4793 (setq pr (get-text-property (point) 'syntax-type))))
4794 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
4795 (not (memq pr '(string prestring))))
4796 (progn (cperl-to-comment-or-eol) (bolp))
4798 (skip-chars-backward " \t")
4799 (if (< p (point)) (goto-char p))
4802 ;; Used only in `cperl-calculate-indent'...
4803 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4804 ;; Positions is before ?\{. Checks whether it starts a block.
4805 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4806 (cperl-backward-to-noncomment (point-min))
4807 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4808 ; Label may be mixed up with `$blah :'
4809 (save-excursion (cperl-after-label))
4810 (get-text-property (cperl-1- (point)) 'attrib-group)
4811 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4814 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
4815 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
4816 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
4817 ;; sub bless::foo {}
4819 (cperl-backward-to-noncomment (point-min))
4820 (and (eq (preceding-char) ?b)
4823 (looking-at "sub[ \t\n\f#]")))))))))
4825 ;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4826 ;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4827 ;;; may be a part of an in-statement construct, such as
4828 ;;; ${something()}, print {FH} $data.
4829 ;;; Moreover, one takes positive approach (looks for else,grep etc)
4830 ;;; another negative (looks for bless,tr etc)
4831 (defun cperl-after-block-p (lim &optional pre-block)
4832 "Return true if the preceding } (if PRE-BLOCK, following {) delimits a block.
4833 Would not look before LIM. Assumes that LIM is a good place to begin a
4834 statement. The kind of block we treat here is one after which a new
4835 statement would start; thus the block in ${func()} does not count."
4839 (or pre-block (forward-sexp -1))
4840 (cperl-backward-to-noncomment lim)
4841 (or (eq (point) lim)
4842 ;; if () {} // sub f () {} // sub f :a(') {}
4843 (eq (preceding-char) ?\) )
4845 (save-excursion (cperl-after-label))
4847 (get-text-property (cperl-1- (point)) 'attrib-group)
4848 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
4851 ;; else {} but not else::func {}
4852 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
4853 (not (looking-at "\\(\\sw\\|_\\)+::")))
4856 (cperl-backward-to-noncomment lim)
4857 (and (eq (preceding-char) ?b)
4860 (looking-at "sub[ \t\n\f#]"))))))
4861 ;; What precedes is not word... XXXX Last statement in sub???
4862 (cperl-after-expr-p lim))))
4865 (defun cperl-after-expr-p (&optional lim chars test)
4866 "Return true if the position is good for start of expression.
4867 TEST is the expression to evaluate at the found position. If absent,
4868 CHARS is a string that contains good characters to have before us (however,
4869 `}' is treated \"smartly\" if it is not in the list)."
4870 (let ((lim (or lim (point-min)))
4872 (cperl-update-syntaxification (point) (point))
4874 (while (and (not stop) (> (point) lim))
4875 (skip-chars-backward " \t\n\f" lim)
4878 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4879 ;; '(pod here-doc here-doc-delim))
4880 (if (get-text-property (point) 'here-doc-group)
4883 (cperl-beginning-of-property (point) 'here-doc-group))
4884 (beginning-of-line 0)))
4885 (if (get-text-property (point) 'in-pod)
4888 (cperl-beginning-of-property (point) 'in-pod))
4889 (beginning-of-line 0)))
4890 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
4891 ;; Else: last iteration, or a label
4892 (cperl-to-comment-or-eol) ; Will not move past "." after a format
4893 (skip-chars-backward " \t")
4894 (if (< p (point)) (goto-char p))
4896 (if (and (eq (preceding-char) ?:)
4899 (skip-chars-backward " \t\n\f" lim)
4900 (memq (char-syntax (preceding-char)) '(?w ?_))))
4901 (forward-sexp -1) ; Possibly label. Skip it
4904 (or (bobp) ; ???? Needed
4906 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
4908 (if test (eval test)
4909 (or (memq (preceding-char) (append (or chars "{;") nil))
4910 (and (eq (preceding-char) ?\})
4911 (cperl-after-block-p lim))
4912 (and (eq (following-char) ?.) ; in format: see comment above
4913 (eq (get-text-property (point) 'syntax-type)
4916 (defun cperl-backward-to-start-of-expr (&optional lim)
4919 (while (and (or (not lim)
4921 (not (cperl-after-expr-p lim)))
4923 ;; May be after $, @, $# etc of a variable
4924 (skip-chars-backward "$@%#")))
4927 (defun cperl-at-end-of-expr (&optional lim)
4928 ;; Since the SEXP approach below is very fragile, do some overengineering
4929 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
4932 ;; If nothing interesting after, does as (forward-sexp -1);
4933 ;; otherwise fails, or ends at a start of following sexp.
4934 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
4935 ;; may be stuck after @ or $; just put some stupid workaround now:
4939 (while (memq (preceding-char) (append "%&@$*" nil))
4942 (cperl-after-expr-p lim))))
4945 (defun cperl-forward-to-end-of-expr (&optional lim)
4949 (while (and (< (point) (or lim (point-max)))
4950 (not (cperl-at-end-of-expr)))
4954 (defun cperl-backward-to-start-of-continued-exp (lim)
4955 (if (memq (preceding-char) (append ")]}\"'`" nil))
4958 (if (<= (point) lim)
4959 (goto-char (1+ lim)))
4960 (skip-chars-forward " \t"))
4962 (defun cperl-after-block-and-statement-beg (lim)
4963 ;; We assume that we are after ?\}
4965 (cperl-after-block-p lim)
4968 (cperl-backward-to-noncomment (point-min))
4971 (not (= (char-syntax (preceding-char)) ?w))
4976 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
4979 (defun cperl-indent-exp ()
4980 "Simple variant of indentation of continued-sexp.
4982 Will not indent comment if it starts at `comment-indent' or looks like
4983 continuation of the comment on the previous line.
4985 If `cperl-indent-region-fix-constructs', will improve spacing on
4986 conditional/loop constructs."
4989 (let ((tmp-end (point-at-eol)) top done)
4994 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
4995 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
4996 (setq top (point))) ; Get the outermost parens in line
4998 (while (< (point) tmp-end)
4999 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
5000 (or (eolp) (forward-sexp 1)))
5001 (if (> (point) tmp-end) ; Yes, there an unfinished block
5003 (if (eq ?\) (preceding-char))
5004 (progn ;; Plan B: find by REGEXP block followup this line
5009 (if (eq (following-char) ?$ ) ; for my $var (list)
5012 (if (looking-at "\\(my\\|local\\|our\\)\\>")
5013 (forward-sexp -1))))
5015 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
5016 "\\|for\\(each\\)?\\>\\(\\("
5017 cperl-maybe-white-and-comment-rex
5018 "\\(my\\|local\\|our\\)\\)?"
5019 cperl-maybe-white-and-comment-rex
5020 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
5024 (setq top (point)))))
5025 (error (setq done t)))
5027 (if (looking-at ; Try Plan C: continuation block
5028 (concat cperl-maybe-white-and-comment-rex
5029 "\\<\\(else\\|elsif\|continue\\)\\>"))
5031 (goto-char (match-end 0))
5032 (setq tmp-end (point-at-eol)))
5034 (setq tmp-end (point-at-eol)))
5036 (setq tmp-end (point-marker)))
5037 (if cperl-indent-region-fix-constructs
5038 (cperl-fix-line-spacing tmp-end))
5039 (cperl-indent-region (point) tmp-end))))
5041 (defun cperl-fix-line-spacing (&optional end parse-data)
5042 "Improve whitespace in a conditional/loop construct.
5043 Returns some position at the last line."
5046 (setq end (point-max)))
5047 (let ((ee (point-at-eol))
5048 (cperl-indent-region-fix-constructs
5049 (or cperl-indent-region-fix-constructs 1))
5050 p pp ml have-brace ret)
5057 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5058 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5059 nil ; Do not need to do anything
5063 (if cperl-merge-trailing-else
5065 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5067 (search-forward "}")
5069 (skip-chars-forward " \t\n")
5070 (delete-region p (point))
5071 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5072 (beginning-of-line)))
5073 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5075 (search-forward "}")
5076 (delete-horizontal-space)
5079 (if (cperl-indent-line parse-data)
5081 (cperl-fix-line-spacing end parse-data)
5082 (setq ret (point)))))))
5085 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5087 (search-forward "}")
5088 (delete-horizontal-space)
5089 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5090 (beginning-of-line)))
5094 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5097 (delete-horizontal-space)
5098 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5099 (beginning-of-line)))
5103 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5106 (delete-horizontal-space)
5107 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5108 (beginning-of-line)))
5110 ;; foreach my $var (
5112 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5115 (delete-horizontal-space)
5117 (make-string cperl-indent-region-fix-constructs ?\s))
5118 (beginning-of-line)))
5119 ;; Looking at (with or without "}" at start, ending after "({"):
5120 ;; } foreach my $var () OR {
5122 "[ \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]*{")
5124 (setq ml (match-beginning 8)) ; "(" or "{" after control word
5125 (re-search-forward "[({]")
5128 (if (eq (following-char) ?\( )
5131 (setq pp (point))) ; past parenth-group
5132 ;; after `else' or nothing
5133 (if ml ; after `else'
5134 (skip-chars-backward " \t\n")
5135 (beginning-of-line))
5137 ;; Now after the sexp before the brace
5138 ;; Multiline expr should be special
5139 (setq ml (and pp (save-excursion (goto-char p)
5140 (search-forward "\n" pp t))))
5141 (if (and (or (not pp) (< pp end)) ; Do not go too far...
5142 (looking-at "[ \t\n]*{"))
5145 ((bolp) ; Were before `{', no if/else/etc
5147 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
5148 (delete-horizontal-space)
5150 cperl-extra-newline-before-brace-multiline
5151 cperl-extra-newline-before-brace)
5153 (delete-horizontal-space)
5156 (if (cperl-indent-line parse-data)
5158 (cperl-fix-line-spacing end parse-data)
5159 (setq ret (point)))))
5161 (make-string cperl-indent-region-fix-constructs ?\s))))
5162 ((and (looking-at "[ \t]*\n")
5164 cperl-extra-newline-before-brace-multiline
5165 cperl-extra-newline-before-brace)))
5167 (skip-chars-forward " \t\n")
5168 (delete-region pp (point))
5170 (make-string cperl-indent-region-fix-constructs ?\ )))
5171 ((and (looking-at "[\t ]*{")
5172 (if ml cperl-extra-newline-before-brace-multiline
5173 cperl-extra-newline-before-brace))
5174 (delete-horizontal-space)
5177 (if (cperl-indent-line parse-data)
5179 (cperl-fix-line-spacing end parse-data)
5180 (setq ret (point))))))
5181 ;; Now we are before `{'
5182 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5184 (skip-chars-forward " \t\n")
5189 (setq ml (search-forward "\n" p t))
5190 (if (or cperl-break-one-line-blocks-when-indent ml)
5191 ;; not good: multi-line BLOCK
5194 (delete-horizontal-space)
5197 (if (cperl-indent-line parse-data)
5198 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5200 (setq p (point) pp (point-at-eol)) ; May be different from ee.
5201 ;; Now check whether there is a hanging `}'
5205 cperl-fix-hanging-brace-when-indent
5207 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5211 (if (and (<= (point) pp)
5212 (eq (preceding-char) ?\} )
5213 (cperl-after-block-and-statement-beg (point-min)))
5220 (skip-chars-backward " \t")
5222 ;; `}' was the first thing on the line, insert NL *after* it.
5224 (cperl-indent-line parse-data)
5225 (search-forward "}")
5226 (delete-horizontal-space)
5228 (delete-horizontal-space)
5229 (or (eq (preceding-char) ?\;)
5231 (and (eq (preceding-char) ?\} )
5232 (cperl-after-block-p (point-min)))
5236 (if (cperl-indent-line parse-data)
5237 (setq ret (cperl-fix-line-spacing end parse-data)))
5238 (beginning-of-line)))))
5241 (defvar cperl-update-start) ; Do not need to make them local
5242 (defvar cperl-update-end)
5243 (defun cperl-delay-update-hook (beg end old-len)
5244 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5245 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
5247 (defun cperl-indent-region (start end)
5248 "Simple variant of indentation of region in CPerl mode.
5249 Should be slow. Will not indent comment if it starts at `comment-indent'
5250 or looks like continuation of the comment on the previous line.
5251 Indents all the lines whose first character is between START and END
5254 If `cperl-indent-region-fix-constructs', will improve spacing on
5255 conditional/loop constructs."
5257 (cperl-update-syntaxification end end)
5259 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
5260 (let ((indent-info (if cperl-emacs-can-parse
5261 (list nil nil nil) ; Cannot use '(), since will modify
5264 after-change-functions ; Speed it up!
5265 st comm old-comm-indent new-comm-indent p pp i empty)
5266 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
5268 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5270 new-comm-indent old-comm-indent)
5272 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5273 (or (bolp) (beginning-of-line 2))
5274 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5277 (setq empty (looking-at "[ \t]*\n"))
5278 (and (setq comm (looking-at "[ \t]*#"))
5279 (or (eq (current-indentation) (or old-comm-indent
5281 (setq old-comm-indent nil))))
5282 (if (and old-comm-indent
5284 (= (current-indentation) old-comm-indent)
5285 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5286 (not (eq (get-text-property (point) 'syntax-table)
5288 (let ((comment-column new-comm-indent))
5289 (indent-for-comment)))
5291 (setq i (cperl-indent-line indent-info))
5295 (if cperl-indent-region-fix-constructs
5296 (goto-char (cperl-fix-line-spacing end indent-info)))
5297 (if (setq old-comm-indent
5298 (and (cperl-to-comment-or-eol)
5299 (not (memq (get-text-property (point)
5302 (not (eq (get-text-property (point)
5306 (progn (indent-for-comment)
5307 (skip-chars-backward " \t")
5308 (skip-chars-backward "#")
5309 (setq new-comm-indent (current-column))))))))
5310 (beginning-of-line 2)))
5311 ;; Now run the update hooks
5312 (and after-change-functions
5315 (goto-char cperl-update-end)
5318 (goto-char cperl-update-start)
5320 (delete-char -1))))))
5322 ;; Stolen from lisp-mode with a lot of improvements
5324 (defun cperl-fill-paragraph (&optional justify iteration)
5325 "Like `fill-paragraph', but handle CPerl comments.
5326 If any of the current line is a comment, fill the comment or the
5327 block of it that point is in, preserving the comment's initial
5328 indentation and initial hashes. Behaves usually outside of comment."
5329 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
5330 (let (;; Non-nil if the current line contains a comment.
5332 fill-paragraph-function ; do not recurse
5333 ;; If has-comment, the appropriate fill-prefix for the comment.
5335 ;; Line that contains code and comment (or nil)
5337 c spaces len dc (comment-column comment-column))
5338 ;; Figure out what kind of comment we are looking at.
5343 ;; A line with nothing but a comment on it?
5344 ((looking-at "[ \t]*#[# \t]*")
5346 comment-fill-prefix (buffer-substring (match-beginning 0)
5349 ;; A line with some code, followed by a comment? Remember that the
5350 ;; semi which starts the comment shouldn't be part of a string or
5352 ((cperl-to-comment-or-eol)
5353 (setq has-comment t)
5354 (looking-at "#+[ \t]*")
5355 (setq start (point) c (current-column)
5357 (concat (make-string (current-column) ?\s)
5358 (buffer-substring (match-beginning 0) (match-end 0)))
5359 spaces (progn (skip-chars-backward " \t")
5360 (buffer-substring (point) start))
5361 dc (- c (current-column)) len (- start (point))
5362 start (point-marker))
5364 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
5365 (if (not has-comment)
5366 (fill-paragraph justify) ; Do the usual thing outside of comment
5367 ;; Narrow to include only the comment, and then fill the region.
5370 ;; Find the first line we should include in the region to fill.
5371 (if start (progn (beginning-of-line) (point))
5373 (while (and (zerop (forward-line -1))
5374 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5375 ;; We may have gone to far. Go forward again.
5376 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5379 ;; Find the beginning of the first line past the region to fill.
5381 (while (progn (forward-line 1)
5382 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5384 ;; Remove existing hashes
5385 (goto-char (point-min))
5387 (while (progn (forward-line 1) (< (point) (point-max)))
5388 (skip-chars-forward " \t")
5389 (if (looking-at "#+")
5391 (if (and (eq (point) (match-beginning 0))
5392 (not (eq (point) (match-end 0)))) nil
5394 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5395 (delete-char (- (match-end 0) (match-beginning 0)))))))
5397 ;; Lines with only hashes on them can be paragraph boundaries.
5398 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5399 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5400 (fill-prefix comment-fill-prefix))
5401 (fill-paragraph justify)))
5406 (progn (delete-char dc) (insert spaces)))
5407 (if (or (= (current-column) c) iteration) nil
5408 (setq comment-column c)
5409 (indent-for-comment)
5410 ;; Repeat once more, flagging as iteration
5411 (cperl-fill-paragraph justify t))))))
5414 (defun cperl-do-auto-fill ()
5415 ;; Break out if the line is short enough
5416 (if (> (save-excursion
5420 (let ((c (save-excursion (beginning-of-line)
5421 (cperl-to-comment-or-eol) (point)))
5422 (s (memq (following-char) '(?\s ?\t))) marker)
5424 ;; Don't break line inside code: only inside comment.
5426 (setq marker (point-marker))
5427 (fill-paragraph nil)
5429 ;; Is not enough, sometimes marker is a start of line
5430 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5431 (goto-char (match-end 0))))
5432 ;; Following space could have gone:
5433 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
5436 ;; Previous space could have gone:
5437 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
5439 (defun cperl-imenu-addback (lst &optional isback name)
5440 ;; We suppose that the lst is a DAG, unless the first element only
5441 ;; loops back, and ISBACK is set. Thus this function cannot be
5442 ;; applied twice without ISBACK set.
5443 (cond ((not cperl-imenu-addback) lst)
5446 (setq name "+++BACK+++"))
5448 (if (and (listp elt) (listp (cdr elt)))
5450 ;; In the other order it goes up
5451 ;; one level only ;-(
5452 (setcdr elt (cons (cons name lst)
5454 (cperl-imenu-addback (cdr elt) t name))))
5455 (if isback (cdr lst) lst))
5458 (defun cperl-imenu--create-perl-index (&optional regexp)
5459 (require 'imenu) ; May be called from TAGS creator
5460 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
5461 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5462 (index-meth-alist '()) meth
5463 packages ends-ranges p marker is-proto
5464 (prev-pos 0) is-pack index index1 name (end-range 0) package)
5465 (goto-char (point-min))
5466 (cperl-update-syntaxification (point-max) (point-max))
5467 ;; Search for the function
5468 (progn ;;save-match-data
5469 (while (re-search-forward
5470 (or regexp cperl-imenu--function-name-regexp-perl)
5472 ;; 2=package-group, 5=package-name 8=sub-name
5474 ((and ; Skip some noise if building tags
5475 (match-beginning 5) ; package name
5476 ;;(eq (char-after (match-beginning 2)) ?p) ; package
5477 (not (save-match-data
5478 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
5481 (or (match-beginning 2)
5482 (match-beginning 8)) ; package or sub
5483 ;; Skip if quoted (will not skip multi-line ''-strings :-():
5484 (null (get-text-property (match-beginning 1) 'syntax-table))
5485 (null (get-text-property (match-beginning 1) 'syntax-type))
5486 (null (get-text-property (match-beginning 1) 'in-pod)))
5487 (setq is-pack (match-beginning 2))
5488 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5489 ;; (goto-char (match-end 0))) ; Messes what follows
5492 (while (and ends-ranges (>= p (car ends-ranges)))
5493 ;; delete obsolete entries
5494 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5495 (setq package (or (car packages) "")
5496 end-range (or (car ends-ranges) 0))
5497 (if is-pack ; doing "package"
5499 (if (match-beginning 5) ; named package
5500 (setq name (buffer-substring (match-beginning 5)
5503 (set-text-properties 0 (length name) nil name)
5505 package (concat name "::")
5506 name (concat "package " name))
5507 ;; Support nameless packages
5508 (setq name "package;" package ""))
5511 (parse-partial-sexp (point) (point-max) -1) (point))
5512 ends-ranges (cons end-range ends-ranges)
5513 packages (cons package packages)))
5515 (or (eq (following-char) ?\;)
5516 (eq 0 (get-text-property (point) 'attrib-group)))))
5517 ;; Skip this function name if it is a prototype declaration.
5518 (if (and is-proto (not is-pack)) nil
5521 (buffer-substring (match-beginning 8) (match-end 8)))
5522 (set-text-properties 0 (length name) nil name))
5523 (setq marker (make-marker))
5524 (set-marker marker (match-end (if is-pack 2 8)))
5526 ((string-match "[:']" name)
5528 ((> p end-range) nil)
5530 (setq name (concat package name) meth t)))
5531 (setq index (cons name marker))
5533 (push index index-pack-alist)
5534 (push index index-alist))
5535 (if meth (push index index-meth-alist))
5536 (push index index-unsorted-alist)))
5537 ((match-beginning 16) ; POD section
5538 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5539 marker (make-marker))
5540 (set-marker marker (match-beginning 17))
5541 (set-text-properties 0 (length name) nil name)
5542 (setq name (concat (make-string
5543 (* 3 (- (char-after (match-beginning 16)) ?1))
5546 index (cons name marker))
5547 (setq index1 (cons (concat "=" name) (cdr index)))
5548 (push index index-pod-alist)
5549 (push index1 index-unsorted-alist)))))
5551 (if (default-value 'imenu-sort-function)
5552 (sort index-alist (default-value 'imenu-sort-function))
5553 (nreverse index-alist)))
5554 (and index-pod-alist
5555 (push (cons "+POD headers+..."
5556 (nreverse index-pod-alist))
5558 (and (or index-pack-alist index-meth-alist)
5559 (let ((lst index-pack-alist) hier-list pack elt group name)
5560 ;; Remove "package ", reverse and uniquify.
5562 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5563 (if (assoc name hier-list) nil
5564 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5565 (setq lst index-meth-alist)
5567 (setq elt (car lst) lst (cdr lst))
5568 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5569 (setq pack (substring (car elt) 0 (match-beginning 0)))
5570 (if (setq group (assoc pack hier-list))
5571 (if (listp (cdr group))
5572 ;; Have some functions already
5574 (cons (cons (substring
5576 (+ 2 (match-beginning 0)))
5579 (setcdr group (list (cons (substring
5581 (+ 2 (match-beginning 0)))
5585 (list (cons (substring
5587 (+ 2 (match-beginning 0)))
5590 (push (cons "+Hierarchy+..."
5593 (and index-pack-alist
5594 (push (cons "+Packages+..."
5595 (nreverse index-pack-alist))
5597 (and (or index-pack-alist index-pod-alist
5598 (default-value 'imenu-sort-function))
5599 index-unsorted-alist
5600 (push (cons "+Unsorted List+..."
5601 (nreverse index-unsorted-alist))
5603 (cperl-imenu-addback index-alist)))
5606 ;; Suggested by Mark A. Hershberger
5607 (defun cperl-outline-level ()
5608 (looking-at outline-regexp)
5609 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
5610 ;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5611 ((match-beginning 2) 0) ; package
5612 ((match-beginning 8) 1) ; sub
5613 ((match-beginning 16)
5614 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5615 (t 5))) ; should not happen
5618 (defun cperl-windowed-init ()
5619 "Initialization under windowed version."
5620 (cond ((featurep 'ps-print)
5621 (or cperl-faces-init
5623 (and (boundp 'font-lock-multiline)
5624 (setq cperl-font-lock-multiline t))
5625 (cperl-init-faces))))
5626 ((not cperl-faces-init)
5627 (add-hook 'font-lock-mode-hook
5630 (if (memq major-mode '(perl-mode cperl-mode))
5632 (or cperl-faces-init (cperl-init-faces)))))))
5633 (if (fboundp 'eval-after-load)
5636 '(or cperl-faces-init (cperl-init-faces)))))))
5638 (defvar cperl-font-lock-keywords-1 nil
5639 "Additional expressions to highlight in Perl mode. Minimal set.")
5640 (defvar cperl-font-lock-keywords nil
5641 "Additional expressions to highlight in Perl mode. Default set.")
5642 (defvar cperl-font-lock-keywords-2 nil
5643 "Additional expressions to highlight in Perl mode. Maximal set")
5645 (defun cperl-load-font-lock-keywords ()
5646 (or cperl-faces-init (cperl-init-faces))
5647 cperl-font-lock-keywords)
5649 (defun cperl-load-font-lock-keywords-1 ()
5650 (or cperl-faces-init (cperl-init-faces))
5651 cperl-font-lock-keywords-1)
5653 (defun cperl-load-font-lock-keywords-2 ()
5654 (or cperl-faces-init (cperl-init-faces))
5655 cperl-font-lock-keywords-2)
5657 (defun cperl-init-faces-weak ()
5658 ;; Allow `cperl-find-pods-heres' to run.
5659 (or (boundp 'font-lock-constant-face)
5660 (cperl-force-face font-lock-constant-face
5661 "Face for constant and label names"))
5662 (or (boundp 'font-lock-warning-face)
5663 (cperl-force-face font-lock-warning-face
5664 "Face for things which should stand out"))
5665 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5668 (defun cperl-init-faces ()
5669 (condition-case errs
5671 (require 'font-lock)
5672 (and (fboundp 'font-lock-fontify-anchored-keywords)
5673 (featurep 'font-lock-extra)
5674 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5675 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
5676 (if (fboundp 'font-lock-fontify-anchored-keywords)
5677 (setq font-lock-anchored t))
5679 t-font-lock-keywords
5681 `("[ \t]+$" 0 ',cperl-invalid-face t)
5684 "\\(^\\|[^$@%&\\]\\)\\<\\("
5687 '("if" "until" "while" "elsif" "else" "unless" "for"
5688 "foreach" "continue" "exit" "die" "last" "goto" "next"
5689 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
5690 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
5691 "\\|") ; Flow control
5692 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
5693 ; In what follows we use `type' style
5694 ; for overwritable builtins
5697 "\\(^\\|[^$@%&\\]\\)\\<\\("
5698 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5699 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5700 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5701 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5702 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5703 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5704 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5705 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5706 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5707 ;; "gethostbyname" "gethostent" "getlogin"
5708 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5709 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5710 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5711 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5712 ;; "getservbyport" "getservent" "getsockname"
5713 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5714 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5715 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
5716 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5717 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5718 ;; "quotemeta" "rand" "read" "readdir" "readline"
5719 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5720 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5721 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5722 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5723 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5724 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5725 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5726 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
5727 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
5728 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5729 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5730 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5731 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
5732 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5733 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5734 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5735 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5736 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5737 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5738 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5739 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5740 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5741 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5742 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5743 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5744 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5745 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5746 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5747 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
5748 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5749 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5750 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5751 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5752 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5753 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5754 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5755 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
5756 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
5757 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5758 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5759 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5760 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5761 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5762 "\\)\\>") 2 'font-lock-type-face)
5763 ;; In what follows we use `other' style
5764 ;; for nonoverwritable builtins
5765 ;; Somehow 's', 'm' are not auto-generated???
5768 "\\(^\\|[^$@%&\\]\\)\\<\\("
5769 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
5770 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5771 ;; "eval" "exists" "for" "foreach" "format" "goto"
5772 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
5773 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
5774 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5775 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5776 ;; "undef" "unless" "unshift" "untie" "until" "use"
5778 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
5779 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
5780 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5781 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
5782 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5783 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
5784 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5785 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5786 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5787 "\\|[sm]" ; Added manually
5788 "\\)\\>") 2 'cperl-nonoverridable-face)
5789 ;; (mapconcat 'identity
5790 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5791 ;; "#include" "#define" "#undef")
5793 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5794 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
5795 ;; This highlights declarations and definitions differently.
5796 ;; We do not try to highlight in the case of attributes:
5797 ;; it is already done by `cperl-find-pods-heres'
5798 (list (concat "\\<sub"
5799 cperl-white-and-comment-rex ; whitespace/comments
5800 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5802 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5803 "([^()]*)\\)?" ; prototype
5804 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5806 2 (if cperl-font-lock-multiline
5807 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5808 'font-lock-function-name-face
5809 'font-lock-variable-name-face)
5810 ;; need to manually set 'multiline' for older font-locks
5812 (if (< 1 (count-lines (match-beginning 0)
5815 (+ 3 (match-beginning 0)) (match-end 0)
5816 'syntax-type 'multiline))
5817 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5818 'font-lock-function-name-face
5819 'font-lock-variable-name-face))))
5820 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5821 2 font-lock-function-name-face)
5822 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5823 1 font-lock-function-name-face)
5824 (cond ((featurep 'font-lock-extra)
5825 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5826 (2 font-lock-string-face t)
5827 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5829 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5830 (2 font-lock-string-face t)
5831 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5833 (1 font-lock-string-face t))))
5834 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5835 2 font-lock-string-face t)))
5836 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
5837 font-lock-string-face t)
5838 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
5839 font-lock-constant-face) ; labels
5840 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
5841 2 font-lock-constant-face)
5842 ;; Uncomment to get perl-mode-like vars
5843 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5844 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5845 ;;; (2 (cons font-lock-variable-name-face '(underline))))
5846 (cond ((featurep 'font-lock-extra)
5847 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5848 (3 font-lock-variable-name-face)
5850 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5851 (1 font-lock-variable-name-face)
5852 (2 '(restart 2 nil) nil t)))
5853 nil t))) ; local variables, multiple
5855 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
5856 `(,(concat "\\<\\(my\\|local\\|our\\)"
5857 cperl-maybe-white-and-comment-rex
5859 cperl-maybe-white-and-comment-rex
5860 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5861 (5 ,(if cperl-font-lock-multiline
5862 'font-lock-variable-name-face
5863 '(progn (setq cperl-font-lock-multiline-start
5864 (match-beginning 0))
5865 'font-lock-variable-name-face)))
5867 cperl-maybe-white-and-comment-rex
5869 cperl-maybe-white-and-comment-rex
5870 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5871 ;; Bug in font-lock: limit is used not only to limit
5872 ;; searches, but to set the "extend window for
5873 ;; facification" property. Thus we need to minimize.
5874 ,(if cperl-font-lock-multiline
5875 '(if (match-beginning 3)
5877 (goto-char (match-beginning 3))
5883 (error nil)))) ; typeahead
5884 (1- (point))) ; report limit
5885 (forward-char -2)) ; disable continued expr
5886 '(if (match-beginning 3)
5887 (point-max) ; No limit for continuation
5888 (forward-char -2))) ; disable continued expr
5889 ,(if cperl-font-lock-multiline
5892 ;; "my" may be already fontified (POD),
5893 ;; so cperl-font-lock-multiline-start is nil
5894 (if (or (not cperl-font-lock-multiline-start)
5896 cperl-font-lock-multiline-start
5900 (1+ cperl-font-lock-multiline-start) (point)
5901 'syntax-type 'multiline))
5902 (setq cperl-font-lock-multiline-start nil)))
5903 (3 font-lock-variable-name-face))))
5904 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
5905 3 font-lock-variable-name-face)))
5906 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
5907 4 font-lock-variable-name-face)
5908 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntactically
5909 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
5910 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
5912 t-font-lock-keywords-1
5913 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
5914 ;; not yet as of XEmacs 19.12, works with 21.1.11
5916 (not (featurep 'xemacs))
5917 (string< "21.1.9" emacs-version)
5918 (and (string< "21.1.10" emacs-version)
5919 (string< emacs-version "21.1.2")))
5921 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
5922 (if (eq (char-after (match-beginning 2)) ?%)
5925 t) ; arrays and hashes
5926 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
5928 (if (= (- (match-end 2) (match-beginning 2)) 1)
5929 (if (eq (char-after (match-beginning 3)) ?{)
5931 'cperl-array-face) ; arrays and hashes
5932 font-lock-variable-name-face) ; Just to put something
5934 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5935 (1 cperl-array-face)
5936 (2 font-lock-variable-name-face))
5937 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5939 (2 font-lock-variable-name-face))
5940 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
5941 ;;; Too much noise from \s* @s[ and friends
5942 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
5943 ;;(3 font-lock-function-name-face t t)
5945 ;; (if (cperl-slash-is-regexp)
5946 ;; font-lock-function-name-face 'default) nil t))
5948 (if cperl-highlight-variables-indiscriminately
5949 (setq t-font-lock-keywords-1
5950 (append t-font-lock-keywords-1
5951 (list '("\\([$*]{?\\sw+\\)" 1
5952 font-lock-variable-name-face)))))
5953 (setq cperl-font-lock-keywords-1
5954 (if cperl-syntaxify-by-font-lock
5955 (cons 'cperl-fontify-update
5956 t-font-lock-keywords)
5957 t-font-lock-keywords)
5958 cperl-font-lock-keywords cperl-font-lock-keywords-1
5959 cperl-font-lock-keywords-2 (append
5960 cperl-font-lock-keywords-1
5961 t-font-lock-keywords-1)))
5962 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5963 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
5964 (eval ; Avoid a warning
5965 '(font-lock-require-faces
5967 ;; Color-light Color-dark Gray-light Gray-dark Mono
5968 (list 'font-lock-comment-face
5969 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5974 (list 'font-lock-string-face
5975 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5980 (list 'font-lock-function-name-face
5982 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5983 (cdr (assq 'background-color ; if mono
5984 (frame-parameters))))
5987 (cdr (assq 'foreground-color ; if mono
5988 (frame-parameters))))
5992 (list 'font-lock-variable-name-face
5993 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
5998 (list 'font-lock-type-face
5999 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6004 (list 'font-lock-warning-face
6005 ["Pink" "Red" "Gray50" "LightGray"]
6012 (list 'font-lock-constant-face
6013 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6018 (list 'cperl-nonoverridable-face
6019 ["chartreuse3" ("orchid1" "orange")
6025 (list 'cperl-array-face
6026 ["blue" "yellow" nil "Gray80"]
6027 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6032 (list 'cperl-hash-face
6033 ["red" "red" nil "Gray80"]
6034 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6039 ;; Do it the dull way, without choose-color
6040 (defvar cperl-guessed-background nil
6041 "Display characteristics as guessed by cperl.")
6042 ;; (or (fboundp 'x-color-defined-p)
6043 ;; (defalias 'x-color-defined-p
6044 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6045 ;; ;; XEmacs >= 19.12
6046 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6048 ;; (t 'x-valid-color-name-p))))
6049 (cperl-force-face font-lock-constant-face
6050 "Face for constant and label names")
6051 (cperl-force-face font-lock-variable-name-face
6052 "Face for variable names")
6053 (cperl-force-face font-lock-type-face
6054 "Face for data types")
6055 (cperl-force-face cperl-nonoverridable-face
6056 "Face for data types from another group")
6057 (cperl-force-face font-lock-warning-face
6058 "Face for things which should stand out")
6059 (cperl-force-face font-lock-comment-face
6060 "Face for comments")
6061 (cperl-force-face font-lock-function-name-face
6062 "Face for function names")
6063 (cperl-force-face cperl-hash-face
6065 (cperl-force-face cperl-array-face
6067 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6068 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6069 ;;(or (boundp 'font-lock-type-face)
6070 ;; (defconst font-lock-type-face
6071 ;; 'font-lock-type-face
6072 ;; "Face to use for data types."))
6073 ;;(or (boundp 'cperl-nonoverridable-face)
6074 ;; (defconst cperl-nonoverridable-face
6075 ;; 'cperl-nonoverridable-face
6076 ;; "Face to use for data types from another group."))
6077 ;;(if (not (featurep 'xemacs)) nil
6078 ;; (or (boundp 'font-lock-comment-face)
6079 ;; (defconst font-lock-comment-face
6080 ;; 'font-lock-comment-face
6081 ;; "Face to use for comments."))
6082 ;; (or (boundp 'font-lock-keyword-face)
6083 ;; (defconst font-lock-keyword-face
6084 ;; 'font-lock-keyword-face
6085 ;; "Face to use for keywords."))
6086 ;; (or (boundp 'font-lock-function-name-face)
6087 ;; (defconst font-lock-function-name-face
6088 ;; 'font-lock-function-name-face
6089 ;; "Face to use for function names.")))
6091 (not (cperl-is-face 'cperl-array-face))
6092 (cperl-is-face 'font-lock-emphasized-face))
6093 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
6095 (not (cperl-is-face 'cperl-hash-face))
6096 (cperl-is-face 'font-lock-other-emphasized-face))
6097 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
6099 (not (cperl-is-face 'cperl-nonoverridable-face))
6100 (cperl-is-face 'font-lock-other-type-face))
6101 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
6102 ;;(or (boundp 'cperl-hash-face)
6103 ;; (defconst cperl-hash-face
6105 ;; "Face to use for hashes."))
6106 ;;(or (boundp 'cperl-array-face)
6107 ;; (defconst cperl-array-face
6108 ;; 'cperl-array-face
6109 ;; "Face to use for arrays."))
6110 ;; Here we try to guess background
6112 (if (boundp 'font-lock-background-mode)
6113 font-lock-background-mode
6115 (face-list (and (fboundp 'face-list) (face-list))))
6116 ;;;; (fset 'cperl-is-face
6117 ;;;; (cond ((fboundp 'find-face)
6118 ;;;; (symbol-function 'find-face))
6120 ;;;; (function (lambda (face) (member face face-list))))
6122 ;;;; (function (lambda (face) (boundp face))))))
6123 (defvar cperl-guessed-background
6124 (if (and (boundp 'font-lock-display-type)
6125 (eq font-lock-display-type 'grayscale))
6128 "Background as guessed by CPerl mode")
6129 (and (not (cperl-is-face 'font-lock-constant-face))
6130 (cperl-is-face 'font-lock-reference-face)
6131 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
6132 (if (cperl-is-face 'font-lock-type-face) nil
6133 (copy-face 'default 'font-lock-type-face)
6135 ((eq background 'light)
6136 (set-face-foreground 'font-lock-type-face
6137 (if (x-color-defined-p "seagreen")
6140 ((eq background 'dark)
6141 (set-face-foreground 'font-lock-type-face
6142 (if (x-color-defined-p "os2pink")
6146 (set-face-background 'font-lock-type-face "gray90"))))
6147 (if (cperl-is-face 'cperl-nonoverridable-face)
6149 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
6151 ((eq background 'light)
6152 (set-face-foreground 'cperl-nonoverridable-face
6153 (if (x-color-defined-p "chartreuse3")
6156 ((eq background 'dark)
6157 (set-face-foreground 'cperl-nonoverridable-face
6158 (if (x-color-defined-p "orchid1")
6161 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6162 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6164 ;;; ((eq background 'light)
6165 ;;; (set-face-background 'font-lock-other-emphasized-face
6166 ;;; (if (x-color-defined-p "lightyellow2")
6168 ;;; (if (x-color-defined-p "lightyellow")
6170 ;;; "light yellow"))))
6171 ;;; ((eq background 'dark)
6172 ;;; (set-face-background 'font-lock-other-emphasized-face
6173 ;;; (if (x-color-defined-p "navy")
6175 ;;; (if (x-color-defined-p "darkgreen")
6177 ;;; "dark green"))))
6178 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6179 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6180 ;;; (copy-face 'bold 'font-lock-emphasized-face)
6182 ;;; ((eq background 'light)
6183 ;;; (set-face-background 'font-lock-emphasized-face
6184 ;;; (if (x-color-defined-p "lightyellow2")
6186 ;;; "lightyellow")))
6187 ;;; ((eq background 'dark)
6188 ;;; (set-face-background 'font-lock-emphasized-face
6189 ;;; (if (x-color-defined-p "navy")
6191 ;;; (if (x-color-defined-p "darkgreen")
6193 ;;; "dark green"))))
6194 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
6195 (if (cperl-is-face 'font-lock-variable-name-face) nil
6196 (copy-face 'italic 'font-lock-variable-name-face))
6197 (if (cperl-is-face 'font-lock-constant-face) nil
6198 (copy-face 'italic 'font-lock-constant-face))))
6199 (setq cperl-faces-init t))
6200 (error (message "cperl-init-faces (ignored): %s" errs))))
6203 (defun cperl-ps-print-init ()
6204 "Initialization of `ps-print' components for faces used in CPerl."
6205 (eval-after-load "ps-print"
6206 '(setq ps-bold-faces
6207 ;; font-lock-variable-name-face
6208 ;; font-lock-constant-face
6209 (append '(cperl-array-face cperl-hash-face)
6212 ;; font-lock-constant-face
6213 (append '(cperl-nonoverridable-face cperl-hash-face)
6216 ;; font-lock-type-face
6217 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
6218 ps-underlined-faces))))
6220 (defvar ps-print-face-extension-alist)
6222 (defun cperl-ps-print (&optional file)
6223 "Pretty-print in CPerl style.
6224 If optional argument FILE is an empty string, prints to printer, otherwise
6225 to the file FILE. If FILE is nil, prompts for a file name.
6227 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6230 (setq file (read-from-minibuffer
6231 "Print to file (if empty - to printer): "
6232 (concat (buffer-file-name) ".ps")
6233 nil nil 'file-name-history)))
6234 (or (> (length file) 0)
6236 (require 'ps-print) ; To get ps-print-face-extension-alist
6237 (let ((ps-print-color-p t)
6238 (ps-print-face-extension-alist ps-print-face-extension-alist))
6239 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6240 (ps-print-buffer-with-faces file)))
6242 ;;; (defun cperl-ps-print-init ()
6243 ;;; "Initialization of `ps-print' components for faces used in CPerl."
6244 ;;; ;; Guard against old versions
6245 ;;; (defvar ps-underlined-faces nil)
6246 ;;; (defvar ps-bold-faces nil)
6247 ;;; (defvar ps-italic-faces nil)
6248 ;;; (setq ps-bold-faces
6249 ;;; (append '(font-lock-emphasized-face
6250 ;;; cperl-array-face
6251 ;;; font-lock-keyword-face
6252 ;;; font-lock-variable-name-face
6253 ;;; font-lock-constant-face
6254 ;;; font-lock-reference-face
6255 ;;; font-lock-other-emphasized-face
6256 ;;; cperl-hash-face)
6258 ;;; (setq ps-italic-faces
6259 ;;; (append '(cperl-nonoverridable-face
6260 ;;; font-lock-constant-face
6261 ;;; font-lock-reference-face
6262 ;;; font-lock-other-emphasized-face
6263 ;;; cperl-hash-face)
6264 ;;; ps-italic-faces))
6265 ;;; (setq ps-underlined-faces
6266 ;;; (append '(font-lock-emphasized-face
6267 ;;; cperl-array-face
6268 ;;; font-lock-other-emphasized-face
6270 ;;; cperl-nonoverridable-face font-lock-type-face)
6271 ;;; ps-underlined-faces))
6272 ;;; (cons 'font-lock-type-face ps-underlined-faces))
6275 (if (cperl-enable-font-lock) (cperl-windowed-init))
6277 (defconst cperl-styles-entries
6278 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6279 cperl-label-offset cperl-extra-newline-before-brace
6280 cperl-extra-newline-before-brace-multiline
6281 cperl-merge-trailing-else
6282 cperl-continued-statement-offset))
6284 (defconst cperl-style-examples
6285 "##### Numbers etc are: cperl-indent-level cperl-brace-offset
6286 ##### cperl-continued-brace-offset cperl-label-offset
6287 ##### cperl-continued-statement-offset
6288 ##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6290 ########### (Do not forget cperl-extra-newline-before-brace-multiline)
6292 ### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6304 ### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6316 ### GNU 2/0/0/-2/2/nil/t
6331 ### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6346 ### BSD (=C++, but will not change preexisting merge-trailing-else
6347 ### and extra-newline-before-brace ) 4/0/-4/-4/4
6362 ### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6363 ### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6378 ### Whitesmith (=PerlStyle, but will not change preexisting
6379 ### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6394 "Examples of if/else with different indent styles (with v4.23).")
6396 (defconst cperl-style-alist
6397 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
6398 (cperl-indent-level . 2)
6399 (cperl-brace-offset . 0)
6400 (cperl-continued-brace-offset . 0)
6401 (cperl-label-offset . -2)
6402 (cperl-continued-statement-offset . 2)
6403 (cperl-extra-newline-before-brace . nil)
6404 (cperl-extra-newline-before-brace-multiline . nil)
6405 (cperl-merge-trailing-else . t))
6407 ("PerlStyle" ; CPerl with 4 as indent
6408 (cperl-indent-level . 4)
6409 (cperl-brace-offset . 0)
6410 (cperl-continued-brace-offset . 0)
6411 (cperl-label-offset . -4)
6412 (cperl-continued-statement-offset . 4)
6413 (cperl-extra-newline-before-brace . nil)
6414 (cperl-extra-newline-before-brace-multiline . nil)
6415 (cperl-merge-trailing-else . t))
6418 (cperl-indent-level . 2)
6419 (cperl-brace-offset . 0)
6420 (cperl-continued-brace-offset . 0)
6421 (cperl-label-offset . -2)
6422 (cperl-continued-statement-offset . 2)
6423 (cperl-extra-newline-before-brace . t)
6424 (cperl-extra-newline-before-brace-multiline . t)
6425 (cperl-merge-trailing-else . nil))
6428 (cperl-indent-level . 5)
6429 (cperl-brace-offset . 0)
6430 (cperl-continued-brace-offset . -5)
6431 (cperl-label-offset . -5)
6432 (cperl-continued-statement-offset . 5)
6433 ;;(cperl-extra-newline-before-brace . nil) ; ???
6434 ;;(cperl-extra-newline-before-brace-multiline . nil)
6435 (cperl-merge-trailing-else . nil))
6438 (cperl-indent-level . 4)
6439 (cperl-brace-offset . 0)
6440 (cperl-continued-brace-offset . -4)
6441 (cperl-label-offset . -4)
6442 (cperl-continued-statement-offset . 4)
6443 ;;(cperl-extra-newline-before-brace . nil) ; ???
6444 ;;(cperl-extra-newline-before-brace-multiline . nil)
6445 ;;(cperl-merge-trailing-else . nil) ; ???
6449 (cperl-indent-level . 4)
6450 (cperl-brace-offset . 0)
6451 (cperl-continued-brace-offset . -4)
6452 (cperl-label-offset . -4)
6453 (cperl-continued-statement-offset . 4)
6454 (cperl-extra-newline-before-brace . t)
6455 (cperl-extra-newline-before-brace-multiline . t)
6456 (cperl-merge-trailing-else . nil))
6459 (cperl-indent-level . 4)
6460 (cperl-brace-offset . 0)
6461 (cperl-continued-brace-offset . 0)
6462 (cperl-label-offset . -4)
6463 (cperl-continued-statement-offset . 4)
6464 ;;(cperl-extra-newline-before-brace . nil) ; ???
6465 ;;(cperl-extra-newline-before-brace-multiline . nil)
6466 ;;(cperl-merge-trailing-else . nil) ; ???
6469 "List of variables to set to get a particular indentation style.
6470 Should be used via `cperl-set-style' or via Perl menu.
6472 See examples in `cperl-style-examples'.")
6474 (defun cperl-set-style (style)
6475 "Set CPerl mode variables to use one of several different indentation styles.
6476 The arguments are a string representing the desired style.
6477 The list of styles is in `cperl-style-alist', available styles
6478 are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
6480 The current value of style is memorized (unless there is a memorized
6481 data already), may be restored by `cperl-set-style-back'.
6483 Choosing \"Current\" style will not change style, so this may be used for
6484 side-effect of memorizing only. Examples in `cperl-style-examples'."
6486 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
6487 cperl-style-alist)))
6488 (list (completing-read "Enter style: " list nil 'insist))))
6490 (setq cperl-old-style
6493 (cons name (eval name))))
6494 cperl-styles-entries)))
6495 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
6497 (setq setting (car style) style (cdr style))
6498 (set (car setting) (cdr setting)))))
6500 (defun cperl-set-style-back ()
6501 "Restore a style memorized by `cperl-set-style'."
6503 (or cperl-old-style (error "The style was not changed"))
6505 (while cperl-old-style
6506 (setq setting (car cperl-old-style)
6507 cperl-old-style (cdr cperl-old-style))
6508 (set (car setting) (cdr setting)))))
6510 (defun cperl-check-syntax ()
6512 (require 'mode-compile)
6513 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6514 (eval '(mode-compile)))) ; Avoid a warning
6516 (defun cperl-info-buffer (type)
6517 ;; Returns buffer with documentation. Creates if missing.
6518 ;; If TYPE, this vars buffer.
6519 ;; Special care is taken to not stomp over an existing info buffer
6520 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6521 (info (get-buffer bname))
6522 (oldbuf (get-buffer "*info*")))
6524 (save-window-excursion
6529 (rename-buffer "*info-perl-tmp*")))
6530 (save-window-excursion
6532 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6533 (set-buffer "*info*")
6534 (rename-buffer bname)
6536 (set-buffer "*info-perl-tmp*")
6537 (rename-buffer "*info*")
6538 (set-buffer bname)))
6539 (make-local-variable 'window-min-height)
6540 (setq window-min-height 2)
6541 (current-buffer)))))
6543 (defun cperl-word-at-point (&optional p)
6544 "Return the word at point or at P."
6546 (if p (goto-char p))
6547 (or (cperl-word-at-point-hard)
6550 (funcall (or (and (boundp 'find-tag-default-function)
6551 find-tag-default-function)
6552 (get major-mode 'find-tag-default-function)
6553 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6554 ;; automatically used within `find-tag-default':
6555 'find-tag-default))))))
6557 (defun cperl-info-on-command (command)
6558 "Show documentation for Perl command COMMAND in other window.
6559 If perl-info buffer is shown in some frame, uses this frame.
6560 Customized by setting variables `cperl-shrink-wrap-info-frame',
6561 `cperl-max-help-size'."
6563 (let* ((default (cperl-word-at-point))
6565 (format "Find doc for Perl function (default %s): "
6567 (list (if (equal read "")
6571 (let ((buffer (current-buffer))
6572 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6573 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6574 max-height char-height buf-list)
6575 (if (string-match "^-[a-zA-Z]$" command)
6576 (setq cmd-desc "^-X[ \t\n]"))
6577 (setq isvar (string-match "^[$@%]" command)
6578 buf (cperl-info-buffer isvar)
6579 iniwin (selected-window)
6580 fr1 (window-frame iniwin))
6582 (goto-char (point-min))
6584 (progn (re-search-forward "^-X[ \t\n]")
6586 (if (re-search-forward cmd-desc nil t)
6588 ;; Go back to beginning of the group (ex, for qq)
6589 (if (re-search-backward "^[ \t\n\f]")
6594 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6595 (while (and (not win) buf-list)
6596 (setq win (get-buffer-window (car buf-list) t))
6597 (setq buf-list (cdr buf-list)))
6599 (eq (window-buffer win) buf)
6600 (set-window-buffer win buf))
6601 (and win (setq fr2 (window-frame win)))
6602 (if (or (not fr2) (eq fr1 fr2))
6604 (special-display-popup-frame buf) ; Make it visible
6605 (select-window win))
6606 (goto-char pos) ; Needed (?!).
6608 (setq iniheight (window-height)
6609 frheight (frame-height)
6610 not-loner (< iniheight (1- frheight))) ; Are not alone
6611 (cond ((if not-loner cperl-max-help-size
6612 cperl-shrink-wrap-info-frame)
6618 (if (re-search-forward
6619 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6620 (match-beginning 0) (point-max)))))
6623 (/ (* (- frheight 3) cperl-max-help-size) 100)
6624 (setq char-height (frame-char-height))
6625 ;; Non-functioning under OS/2:
6626 (if (eq char-height 1) (setq char-height 18))
6627 ;; Title, menubar, + 2 for slack
6628 (- (/ (display-pixel-height) char-height) 4)))
6629 (if (> height max-height) (setq height max-height))
6630 ;;(message "was %s doing %s" iniheight height)
6632 (enlarge-window (- height iniheight))
6633 (set-frame-height (window-frame win) (1+ height)))))
6634 (set-window-start (selected-window) pos))
6635 (message "No entry for %s found." command))
6636 ;;(pop-to-buffer buffer)
6637 (select-window iniwin)))
6639 (defun cperl-info-on-current-command ()
6640 "Show documentation for Perl command at point in other window."
6642 (cperl-info-on-command (cperl-word-at-point)))
6644 (defun cperl-imenu-info-imenu-search ()
6645 (if (looking-at "^-X[ \t\n]") nil
6647 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6650 (defun cperl-imenu-info-imenu-name ()
6652 (match-beginning 1) (match-end 1)))
6654 (defun cperl-imenu-on-info ()
6655 "Shows imenu for Perl Info Buffer.
6656 Opens Perl Info buffer if needed."
6658 (let* ((buffer (current-buffer))
6659 imenu-create-index-function
6660 imenu-prev-index-position-function
6661 imenu-extract-index-name-function
6662 (index-item (save-restriction
6663 (save-window-excursion
6664 (set-buffer (cperl-info-buffer nil))
6665 (setq imenu-create-index-function
6666 'imenu-default-create-index-function
6667 imenu-prev-index-position-function
6668 'cperl-imenu-info-imenu-search
6669 imenu-extract-index-name-function
6670 'cperl-imenu-info-imenu-name)
6671 (imenu-choose-buffer-index)))))
6675 (pop-to-buffer "*info-perl*")
6677 ((markerp (cdr index-item))
6678 (goto-char (marker-position (cdr index-item))))
6680 (goto-char (cdr index-item))))
6681 (set-window-start (selected-window) (point))
6682 (pop-to-buffer buffer)))))
6684 (defun cperl-lineup (beg end &optional step minshift)
6685 "Lineup construction in a region.
6686 Beginning of region should be at the start of a construction.
6687 All first occurrences of this construction in the lines that are
6688 partially contained in the region are lined up at the same column.
6690 MINSHIFT is the minimal amount of space to insert before the construction.
6691 STEP is the tabwidth to position constructions.
6692 If STEP is nil, `cperl-lineup-step' will be used
6693 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
6694 Will not move the position at the start to the left."
6696 (let (search col tcol seen b)
6700 (setq end (point-marker))
6702 (skip-chars-forward " \t\f")
6703 (setq beg (point-marker))
6704 (indent-region beg end nil)
6706 (setq col (current-column))
6707 (if (looking-at "[a-zA-Z0-9_]")
6708 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6712 (buffer-substring (match-beginning 0)
6713 (match-end 0))) "\\>"))
6714 (error "Cannot line up in a middle of the word"))
6715 (if (looking-at "$")
6716 (error "Cannot line up end of line"))
6717 (setq search (regexp-quote (char-to-string (following-char)))))
6718 (setq step (or step cperl-lineup-step cperl-indent-level))
6719 (or minshift (setq minshift 1))
6721 (beginning-of-line 2)
6722 (and (< (point) end)
6723 (re-search-forward search end t)
6724 (goto-char (match-beginning 0))))
6725 (setq tcol (current-column) seen t)
6726 (if (> tcol col) (setq col tcol)))
6728 (error "The construction to line up occurred only once"))
6730 (setq col (+ col minshift))
6731 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
6734 (cperl-make-indent col)
6735 (beginning-of-line 2)
6736 (and (< (point) end)
6737 (re-search-forward search end t)
6738 (goto-char (match-beginning 0)))))))) ; No body
6740 (defun cperl-etags (&optional add all files) ;; NOT USED???
6741 "Run etags with appropriate options for Perl files.
6742 If optional argument ALL is `recursive', will process Perl files
6743 in subdirectories too."
6746 (args '("-l" "none" "-r"
6747 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6748 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6750 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6752 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
6754 (if add (setq args (cons "-a" args)))
6755 (or files (setq files (list buffer-file-name)))
6757 ((eq all 'recursive)
6758 ;;(error "Not implemented: recursive")
6759 (setq args (append (list "-e"
6760 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6762 find(\\&wanted, '.');
6767 ;;(error "Not implemented: all")
6768 (setq args (append (list "-e"
6769 "push @ARGV, <*.PL *.pl *.pm>;
6774 (setq args (append args files))))
6775 (setq res (apply 'call-process cmd nil nil nil args))
6777 (message "etags returned \"%s\"" res))))
6779 (defun cperl-toggle-auto-newline ()
6780 "Toggle the state of `cperl-auto-newline'."
6782 (setq cperl-auto-newline (not cperl-auto-newline))
6783 (message "Newlines will %sbe auto-inserted now."
6784 (if cperl-auto-newline "" "not ")))
6786 (defun cperl-toggle-abbrev ()
6787 "Toggle the state of automatic keyword expansion in CPerl mode."
6789 (abbrev-mode (if abbrev-mode 0 1))
6790 (message "Perl control structure will %sbe auto-inserted now."
6791 (if abbrev-mode "" "not ")))
6794 (defun cperl-toggle-electric ()
6795 "Toggle the state of parentheses doubling in CPerl mode."
6797 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
6798 (message "Parentheses will %sbe auto-doubled now."
6799 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6801 (defun cperl-toggle-autohelp ()
6802 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6803 Delay of auto-help controlled by `cperl-lazy-help-time'."
6805 (if (fboundp 'run-with-idle-timer)
6807 (if cperl-lazy-installed
6808 (cperl-lazy-unstall)
6809 (cperl-lazy-install))
6810 (message "Perl help messages will %sbe automatically shown now."
6811 (if cperl-lazy-installed "" "not ")))
6812 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6814 (defun cperl-toggle-construct-fix ()
6815 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6817 (setq cperl-indent-region-fix-constructs
6818 (if cperl-indent-region-fix-constructs
6821 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
6822 (if cperl-indent-region-fix-constructs "" "not ")))
6824 (defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6825 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6826 Nonpositive numeric argument disables debugging messages. The message
6827 summarizes which regions it was decided to rescan for syntactic constructs.
6829 The message looks like this:
6831 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6833 Numbers are character positions in the buffer. REQ provides the range to
6834 rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6835 for correct operation it should start and end outside any special syntactic
6836 construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6840 (setq arg (if (eq cperl-syntaxify-by-font-lock
6841 (if backtrace 'backtrace 'message)) 0 1)))
6842 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6843 (setq cperl-syntaxify-by-font-lock arg)
6844 (message "Debugging messages of syntax unwind %sabled."
6845 (if (eq arg t) "dis" "en")))
6847 ;;;; Tags file creation.
6849 (defvar cperl-tmp-buffer " *cperl-tmp*")
6851 (defun cperl-setup-tmp-buf ()
6852 (set-buffer (get-buffer-create cperl-tmp-buffer))
6853 (set-syntax-table cperl-mode-syntax-table)
6854 (buffer-disable-undo)
6856 (if cperl-use-syntax-table-text-property-for-tags
6858 (make-local-variable 'parse-sexp-lookup-properties)
6859 ;; Do not introduce variable if not needed, we check it!
6860 (set 'parse-sexp-lookup-properties t))))
6862 ;; Copied from imenu-example--name-and-position.
6863 (defvar imenu-use-markers)
6865 (defun cperl-imenu-name-and-position ()
6866 "Return the current/previous sexp and its (beginning) location.
6867 Does not move point."
6870 (let ((beg (if imenu-use-markers (point-marker) (point)))
6871 (end (progn (forward-sexp) (point))))
6872 (cons (buffer-substring beg end)
6875 (defun cperl-xsub-scan ()
6877 (let ((index-alist '())
6878 (prev-pos 0) index index1 name package prefix)
6879 (goto-char (point-min))
6880 ;; Search for the function
6881 (progn ;;save-match-data
6882 (while (re-search-forward
6883 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6886 ((match-beginning 2) ; SECTION
6887 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6888 (goto-char (match-beginning 0))
6889 (skip-chars-forward " \t")
6891 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6892 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6894 ((not package) nil) ; C language section
6895 ((match-beginning 3) ; XSUB
6896 (goto-char (1+ (match-beginning 3)))
6897 (setq index (cperl-imenu-name-and-position))
6898 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6899 (if (and prefix (string-match (concat "^" prefix) name))
6900 (setq name (substring name (length prefix))))
6901 (cond ((string-match "::" name) nil)
6903 (setq index1 (cons (concat package "::" name) (cdr index)))
6904 (push index1 index-alist)))
6906 (push index index-alist))
6908 ;; (beginning-of-line)
6909 (setq index (cperl-imenu-name-and-position))
6910 (setcar index (concat package "::BOOT:"))
6911 (push index index-alist)))))
6914 (defvar cperl-unreadable-ok nil)
6916 (defun cperl-find-tags (ifile xs topdir)
6917 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6918 (cperl-pod-here-fontify nil) f file)
6920 (if b (set-buffer b)
6921 (cperl-setup-tmp-buf))
6924 (setq file (car (insert-file-contents ifile)))
6925 (error (if cperl-unreadable-ok nil
6927 (format "File %s unreadable. Continue? " ifile))
6928 (setq cperl-unreadable-ok t)
6929 (error "Aborting: unreadable file %s" ifile)))))
6931 (message "Unreadable file %s" ifile)
6932 (message "Scanning file %s ..." file)
6933 (if (and cperl-use-syntax-table-text-property-for-tags
6935 (condition-case err ; after __END__ may have garbage
6936 (cperl-find-pods-heres nil nil noninteractive)
6937 (error (message "While scanning for syntax: %s" err))))
6939 (setq lst (cperl-xsub-scan))
6940 (setq ind (cperl-imenu--create-perl-index))
6941 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6946 (cond ((string-match "^[_a-zA-Z]" (car elt))
6947 (goto-char (cdr elt))
6948 (beginning-of-line) ; pos should be of the start of the line
6951 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6952 (buffer-substring (progn
6953 (goto-char (cdr elt))
6954 ;; After name now...
6955 (or (eolp) (forward-char 1))
6963 (setq elt (car lst) lst (cdr lst))
6968 (if (string-match "^package " (car elt))
6969 (substring (car elt) 8)
6972 (number-to-string (elt elt 2)) ; Line
6974 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
6976 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
6977 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
6979 ;; Need to insert the name without package as well
6980 (setq lst (cons (cons (substring (elt elt 3)
6988 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
6989 (set-text-properties 0 (length rel) nil rel)
6990 (and (equal topdir (substring rel 0 (length topdir)))
6991 (setq rel (substring file (length topdir))))
6992 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
6993 (setq ret (buffer-substring 1 (point-max)))
6996 (message "Scanning file %s finished" file))
6999 (defun cperl-add-tags-recurse-noxs ()
7000 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
7002 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7003 -f cperl-add-tags-recurse-noxs
7005 (cperl-write-tags nil nil t t nil t))
7007 (defun cperl-add-tags-recurse-noxs-fullpath ()
7008 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7009 Writes down fullpath, so TAGS is relocatable (but if the build directory
7010 is relocated, the file TAGS inside it breaks). Use as
7011 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7012 -f cperl-add-tags-recurse-noxs-fullpath
7014 (cperl-write-tags nil nil t t nil t ""))
7016 (defun cperl-add-tags-recurse ()
7017 "Add to TAGS file data for Perl files in the current directory and kids.
7019 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7020 -f cperl-add-tags-recurse
7022 (cperl-write-tags nil nil t t))
7024 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7025 ;; If INBUFFER, do not select buffer, and do not save
7026 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7029 (setq file (if dir default-directory (buffer-file-name)))
7030 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7032 (setq topdir default-directory))
7033 (let ((tags-file-name "TAGS")
7034 (case-fold-search (and (featurep 'xemacs) (eq system-type 'emx)))
7037 (cond (inbuffer nil) ; Already there
7038 ((file-exists-p tags-file-name)
7039 (if (featurep 'xemacs)
7040 (visit-tags-table-buffer)
7041 (visit-tags-table-buffer tags-file-name)))
7042 (t (set-buffer (find-file-noselect tags-file-name))))
7045 (cond ((eq erase 'ignore))
7048 (setq erase 'ignore)))
7051 (directory-files file t
7052 (if recurse nil cperl-scan-files-regexp)
7055 (if cperl-unreadable-ok nil
7057 (format "Directory %s unreadable. Continue? " file))
7058 (setq cperl-unreadable-ok t
7059 tm nil) ; Return empty list
7060 (error "Aborting: unreadable directory %s" file)))))))
7064 ((string-match cperl-noscan-files-regexp file)
7066 ((not (file-directory-p file))
7067 (if (string-match cperl-scan-files-regexp file)
7068 (cperl-write-tags file erase recurse nil t noxs topdir)))
7070 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7073 (setq xs (string-match "\\.xs$" file))
7074 (if (not (and xs noxs))
7076 (cond ((eq erase 'ignore) (goto-char (point-max)))
7077 (erase (erase-buffer))
7081 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7082 (set-text-properties 0 (length rel) nil rel)
7083 (and (equal topdir (substring rel 0 (length topdir)))
7084 (setq rel (substring file (length topdir))))
7085 (if (search-forward (concat "\f\n" rel ",") nil t)
7087 (search-backward "\f\n")
7088 (delete-region (point)
7091 (if (search-forward "\f\n"
7095 (goto-char (point-max)))))
7096 (insert (cperl-find-tags file xs topdir))))))
7097 (if inbuffer nil ; Delegate to the caller
7098 (save-buffer 0) ; No backup
7099 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7100 (initialize-new-tags-table))))))
7102 (defvar cperl-tags-hier-regexp-list
7109 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7111 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7114 (defvar cperl-hierarchy '(() ())
7115 "Global hierarchy of classes.")
7117 (defun cperl-tags-hier-fill ()
7118 ;; Suppose we are in a tag table cooked by cperl.
7120 (let (type pack name pos line chunk ord cons1 file str info fileind)
7121 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
7122 (setq pos (match-beginning 0)
7123 pack (match-beginning 2))
7125 (if (looking-at (concat
7134 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7135 name (buffer-substring (match-beginning 2) (match-end 2))
7136 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
7137 line (buffer-substring (match-beginning 3) (match-end 3))
7140 fileind (format "%s:%s" file line)
7141 ;; Moves to beginning of the next line:
7142 info (cperl-etags-snarf-tag file line))
7145 ;; Make new member of hierarchy name ==> file ==> pos if needed
7146 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7148 (setcdr cons1 (cons (cons fileind (vector file info))
7150 ;; First occurrence of the name, start alist
7151 (setq cons1 (cons name (list (cons fileind (vector file info)))))
7153 (setcar (cdr cperl-hierarchy)
7154 (cons cons1 (nth 1 cperl-hierarchy)))
7155 (setcar cperl-hierarchy
7156 (cons cons1 (car cperl-hierarchy)))))))
7159 (declare-function x-popup-menu "menu.c" (position menu))
7161 (defun cperl-tags-hier-init (&optional update)
7162 "Show hierarchical menu of classes and methods.
7163 Finds info about classes by a scan of loaded TAGS files.
7164 Supposes that the TAGS files contain fully qualified function names.
7165 One may build such TAGS files from CPerl mode menu."
7169 (if (or update (null (nth 2 cperl-hierarchy)))
7170 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7173 (setcdr elt (cdr (nth 1 elt)))))))
7174 pack name cons1 to l1 l2 l3 l4 b)
7175 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7176 (setq cperl-hierarchy (list l1 l2 l3))
7177 (if (featurep 'xemacs) ; Not checked
7180 ;; Does this work in XEmacs?
7181 (call-interactively 'visit-tags-table))
7182 (message "Updating list of classes...")
7183 (set-buffer (get-file-buffer tags-file-name))
7184 (cperl-tags-hier-fill))
7186 (call-interactively 'visit-tags-table))
7190 (message "Updating list of classes... %s" tagsfile)
7191 (set-buffer (get-file-buffer tagsfile))
7192 (cperl-tags-hier-fill)))
7194 (message "Updating list of classes... postprocessing..."))
7195 (mapc remover (car cperl-hierarchy))
7196 (mapc remover (nth 1 cperl-hierarchy))
7197 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7198 (cons "Methods: " (car cperl-hierarchy))))
7199 (cperl-tags-treeify to 1)
7200 (setcar (nthcdr 2 cperl-hierarchy)
7201 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7202 (message "Updating list of classes: done, requesting display...")
7203 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7205 (or (nth 2 cperl-hierarchy)
7206 (error "No items found"))
7208 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
7209 (if (if (fboundp 'display-popup-menus-p)
7210 (let ((f 'display-popup-menus-p))
7213 (x-popup-menu t (nth 2 cperl-hierarchy))
7215 (tmm-prompt (nth 2 cperl-hierarchy))))
7216 (if (and update (listp update))
7217 (progn (while (cdr update) (setq update (cdr update)))
7218 (setq update (car update)))) ; Get the last from the list
7219 (if (vectorp update)
7221 (find-file (elt update 0))
7222 (cperl-etags-goto-tag-location (elt update 1))))
7223 (if (eq update -999) (cperl-tags-hier-init t)))
7225 (defun cperl-tags-treeify (to level)
7226 ;; cadr of `to' is read-write. On start it is a cons
7227 (let* ((regexp (concat "^\\(" (mapconcat
7229 (make-list level "[_a-zA-Z0-9]+")
7232 (packages (cdr (nth 1 to)))
7233 (methods (cdr (nth 2 to)))
7234 l1 head tail cons1 cons2 ord writeto packs recurse
7235 root-packages root-functions ms many_ms same_name ps
7239 (cond ((and (string-match regexp (car elt))
7240 (or (eq ord 1) (match-end 2)))
7241 (setq head (substring (car elt) 0 (match-end 1))
7242 tail (if (match-end 2) (substring (car elt)
7245 (if (setq cons1 (assoc head writeto)) nil
7246 ;; Need to init new head
7247 (setcdr writeto (cons (list head (list "Packages: ")
7250 (setq cons1 (nth 1 writeto)))
7251 (setq cons2 (nth ord cons1)) ; Either packs or meths
7252 (setcdr cons2 (cons elt (cdr cons2))))
7254 (setq root-functions (cons elt root-functions)))
7256 (setq root-packages (cons elt root-packages))))))))
7257 (setcdr to l1) ; Init to dynamic space
7260 (mapc move-deeper packages)
7262 (mapc move-deeper methods)
7264 (mapc (function (lambda (elt)
7265 (cperl-tags-treeify elt (1+ level))))
7267 ;;Now clean up leaders with one child only
7268 (mapc (function (lambda (elt)
7269 (if (not (and (listp (cdr elt))
7270 (eq (length elt) 2))) nil
7271 (setcar elt (car (nth 1 elt)))
7272 (setcdr elt (cdr (nth 1 elt))))))
7274 ;; Sort the roots of subtrees
7275 (if (default-value 'imenu-sort-function)
7277 (sort (cdr to) (default-value 'imenu-sort-function))))
7278 ;; Now add back functions removed from display
7279 (mapc (function (lambda (elt)
7280 (setcdr to (cons elt (cdr to)))))
7281 (if (default-value 'imenu-sort-function)
7283 (sort root-functions (default-value 'imenu-sort-function)))
7285 ;; Now add back packages removed from display
7286 (mapc (function (lambda (elt)
7287 (setcdr to (cons (cons (concat "package " (car elt))
7290 (if (default-value 'imenu-sort-function)
7292 (sort root-packages (default-value 'imenu-sort-function)))
7296 ;;; '(keymap "Name1"
7300 ;;; ("Tail1" "x") ("Tail2" "y"))))
7302 (defun cperl-list-fold (list name limit)
7303 (let (list1 list2 elt1 (num 0))
7304 (if (<= (length list) limit) list
7305 (setq list1 nil list2 nil)
7310 (if (<= num imenu-max-items)
7311 (setq list2 (cons elt1 list2))
7312 (setq list1 (cons (cons name
7317 (nreverse (cons (cons name
7321 (defun cperl-menu-to-keymap (menu &optional name)
7327 (cond ((listp (cdr elt))
7328 (setq list (cperl-list-fold
7329 (cdr elt) (car elt) imenu-max-items))
7332 (cperl-menu-to-keymap list))))
7334 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7335 (cperl-list-fold menu "Root" imenu-max-items)))))
7338 (defvar cperl-bad-style-regexp
7339 (mapconcat 'identity
7340 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
7341 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
7343 "Finds places such that insertion of a whitespace may help a lot.")
7345 (defvar cperl-not-bad-style-regexp
7348 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7349 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7350 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
7351 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
7352 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
7359 "\\\\[&$@*\\\\]" ; \&func
7362 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
7365 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
7366 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
7367 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7371 "If matches at the start of match found by `my-bad-c-style-regexp',
7372 insertion of a whitespace will not help.")
7376 (defun cperl-find-bad-style ()
7377 "Find places in the buffer where insertion of a whitespace may help.
7378 Prompts user for insertion of spaces.
7379 Currently it is tuned to C and Perl syntax."
7381 (let (found-bad (p (point)))
7382 (setq last-nonmenu-event 13) ; To disable popup
7383 (goto-char (point-min))
7384 (map-y-or-n-p "Insert space here? "
7385 (lambda (arg) (insert " "))
7386 'cperl-next-bad-style
7387 '("location" "locations" "insert a space into")
7388 '((?\C-r (lambda (arg)
7389 (let ((buffer-quit-function
7390 'exit-recursive-edit))
7391 (message "Exit with Esc Esc")
7393 t)) ; Consider acted upon
7394 "edit, exit with Esc Esc")
7396 (let ((buffer-quit-function
7397 'exit-recursive-edit))
7398 (message "Exit with Esc Esc")
7400 t)) ; Consider acted upon
7401 "edit, exit with Esc Esc"))
7403 (if found-bad (goto-char found-bad)
7405 (message "No appropriate place found"))))
7407 (defun cperl-next-bad-style ()
7408 (let (p (not-found t) (point (point)) found)
7409 (while (and not-found
7410 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7412 (goto-char (match-beginning 0))
7414 (looking-at cperl-not-bad-style-regexp)
7415 ;; Check for a < -b and friends
7416 (and (eq (following-char) ?\-)
7418 (skip-chars-backward " \t\n")
7419 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
7420 ;; Now check for syntax type
7422 (setq found (point))
7423 (beginning-of-defun)
7424 (let ((pps (parse-partial-sexp (point) found)))
7425 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7426 (goto-char (match-end 0))
7434 (defvar cperl-have-help-regexp
7438 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
7439 "[$@]\\^[a-zA-Z]" ; Special variable
7440 "[$@][^ \n\t]" ; Special variable
7441 "-[a-zA-Z]" ; File test
7442 "\\\\[a-zA-Z0]" ; Special chars
7443 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
7444 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7445 "[a-zA-Z_0-9:]+" ; symbol or number
7452 "Matches places in the buffer we can find help for.")
7454 (defvar cperl-message-on-help-error t)
7455 (defvar cperl-help-from-timer nil)
7457 (defun cperl-word-at-point-hard ()
7458 ;; Does not save-excursion
7459 ;; Get to the something meaningful
7460 (or (eobp) (eolp) (forward-char 1))
7461 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
7465 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7466 ;; (skip-chars-backward " \n\t\r({[]});,")
7467 ;; (or (bobp) (backward-char 1))))
7470 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7471 (skip-chars-backward "a-zA-Z0-9_:")
7473 ((and (eq (preceding-char) ?^) ; $^I
7474 (eq (char-after (- (point) 2)) ?\$))
7476 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7478 ((and (eq (preceding-char) ?\=)
7479 (eq (current-column) 1))
7480 (forward-char -1))) ; =head1
7481 (if (and (eq (preceding-char) ?\<)
7482 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7484 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7486 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7488 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7489 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7491 ((and (eq (preceding-char) ?\$)
7492 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7494 ((and (eq (following-char) ?\>)
7495 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7498 (and (eq (preceding-char) ?\<)
7499 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7500 (search-backward "<"))))
7501 ((and (eq (following-char) ?\$)
7502 (eq (preceding-char) ?\<)
7503 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7505 (if (looking-at cperl-have-help-regexp)
7506 (buffer-substring (match-beginning 0) (match-end 0))))
7508 (defun cperl-get-help ()
7509 "Get one-line docs on the symbol at the point.
7510 The data for these docs is a little bit obsolete and may be in fact longer
7511 than a line. Your contribution to update/shorten it is appreciated."
7513 (save-match-data ; May be called "inside" query-replace
7515 (let ((word (cperl-word-at-point-hard)))
7517 (if (and cperl-help-from-timer ; Bail out if not in mainland
7518 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7519 (or (memq (get-text-property (point) 'face)
7520 '(font-lock-comment-face font-lock-string-face))
7521 (memq (get-text-property (point) 'syntax-type)
7522 '(pod here-doc format))))
7524 (cperl-describe-perl-symbol word))
7525 (if cperl-message-on-help-error
7526 (message "Nothing found for %s..."
7527 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7529 ;;; Stolen from perl-descr.el by Johan Vromans:
7531 (defvar cperl-doc-buffer " *perl-doc*"
7532 "Where the documentation can be found.")
7534 (defun cperl-describe-perl-symbol (val)
7535 "Display the documentation of symbol at point, a Perl operator."
7536 (let ((enable-recursive-minibuffers t)
7539 ((string-match "^[&*][a-zA-Z_]" val)
7540 (setq val (concat (substring val 0 1) "NAME")))
7541 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7542 (setq val (concat "@" (substring val 1 (match-end 1)))))
7543 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7544 (setq val (concat "%" (substring val 1 (match-end 1)))))
7545 ((and (string= val "x") (string-match "^x=" val))
7547 ((string-match "^\\$[\C-a-\C-z]" val)
7548 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7549 ((string-match "^CORE::" val)
7550 (setq val "CORE::"))
7551 ((string-match "^SUPER::" val)
7552 (setq val "SUPER::"))
7553 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7554 (setq val "<NAME>")))
7555 (setq regexp (concat "^"
7556 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
7558 "\\([ \t([/]\\|$\\)"))
7560 ;; get the buffer with the documentation text
7561 (cperl-switch-to-doc-buffer)
7563 ;; lookup in the doc
7564 (goto-char (point-min))
7565 (let ((case-fold-search nil))
7567 (if (re-search-forward regexp (point-max) t)
7569 (beginning-of-line 1)
7570 (let ((lnstart (point)))
7572 (message "%s" (buffer-substring lnstart (point)))))
7573 (if cperl-message-on-help-error
7574 (message "No definition for %s" val)))))))
7576 (defvar cperl-short-docs 'please-ignore-this-line
7577 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7578 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
7579 ... Range (list context); flip/flop [no flop when flip] (scalar context).
7580 ! ... Logical negation.
7581 ... != ... Numeric inequality.
7582 ... !~ ... Search pattern, substitution, or translation (negated).
7583 $! In numeric context: errno. In a string context: error string.
7584 $\" The separator which joins elements of arrays interpolated in strings.
7585 $# The output format for printed numbers. Default is %.15g or close.
7586 $$ Process number of this script. Changes in the fork()ed child process.
7587 $% The current page number of the currently selected output channel.
7589 The following variables are always local to the current block:
7591 $1 Match of the 1st set of parentheses in the last match (auto-local).
7592 $2 Match of the 2nd set of parentheses in the last match (auto-local).
7593 $3 Match of the 3rd set of parentheses in the last match (auto-local).
7594 $4 Match of the 4th set of parentheses in the last match (auto-local).
7595 $5 Match of the 5th set of parentheses in the last match (auto-local).
7596 $6 Match of the 6th set of parentheses in the last match (auto-local).
7597 $7 Match of the 7th set of parentheses in the last match (auto-local).
7598 $8 Match of the 8th set of parentheses in the last match (auto-local).
7599 $9 Match of the 9th set of parentheses in the last match (auto-local).
7600 $& The string matched by the last pattern match (auto-local).
7601 $' The string after what was matched by the last match (auto-local).
7602 $` The string before what was matched by the last match (auto-local).
7604 $( The real gid of this process.
7605 $) The effective gid of this process.
7606 $* Deprecated: Set to 1 to do multiline matching within a string.
7607 $+ The last bracket matched by the last search pattern.
7608 $, The output field separator for the print operator.
7609 $- The number of lines left on the page.
7610 $. The current input line number of the last filehandle that was read.
7611 $/ The input record separator, newline by default.
7612 $0 Name of the file containing the current perl script (read/write).
7613 $: String may be broken after these characters to fill ^-lines in a format.
7614 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
7615 $< The real uid of this process.
7616 $= The page length of the current output channel. Default is 60 lines.
7617 $> The effective uid of this process.
7618 $? The status returned by the last ``, pipe close or `system'.
7619 $@ The perl error message from the last eval or do @var{EXPR} command.
7620 $ARGV The name of the current file used with <> .
7621 $[ Deprecated: The index of the first element/char in an array/string.
7622 $\\ The output record separator for the print operator.
7623 $] The perl version string as displayed with perl -v.
7624 $^ The name of the current top-of-page format.
7625 $^A The current value of the write() accumulator for format() lines.
7626 $^D The value of the perl debug (-D) flags.
7627 $^E Information about the last system error other than that provided by $!.
7628 $^F The highest system file descriptor, ordinarily 2.
7629 $^H The current set of syntax checks enabled by `use strict'.
7630 $^I The value of the in-place edit extension (perl -i option).
7631 $^L What formats output to perform a formfeed. Default is \\f.
7632 $^M A buffer for emergency memory allocation when running out of memory.
7633 $^O The operating system name under which this copy of Perl was built.
7634 $^P Internal debugging flag.
7635 $^T The time the script was started. Used by -A/-M/-C file tests.
7636 $^W True if warnings are requested (perl -w flag).
7637 $^X The name under which perl was invoked (argv[0] in C-speech).
7638 $_ The default input and pattern-searching space.
7639 $| Auto-flush after write/print on current output channel? Default 0.
7640 $~ The name of the current report format.
7641 ... % ... Modulo division.
7642 ... %= ... Modulo division assignment.
7643 %ENV Contains the current environment.
7644 %INC List of files that have been require-d or do-ne.
7645 %SIG Used to set signal handlers for various signals.
7646 ... & ... Bitwise and.
7647 ... && ... Logical and.
7648 ... &&= ... Logical and assignment.
7649 ... &= ... Bitwise and assignment.
7650 ... * ... Multiplication.
7651 ... ** ... Exponentiation.
7652 *NAME Glob: all objects referred by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7653 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
7654 ... + ... Addition. +EXPR Makes EXPR into scalar context.
7655 ++ Auto-increment (magical on strings). ++EXPR EXPR++
7656 ... += ... Addition assignment.
7658 ... - ... Subtraction.
7659 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7660 ... -= ... Subtraction assignment.
7661 -A Access time in days since script started.
7662 -B File is a non-text (binary) file.
7663 -C Inode change time in days since script started.
7664 -M Age in days since script started.
7665 -O File is owned by real uid.
7666 -R File is readable by real uid.
7667 -S File is a socket .
7668 -T File is a text file.
7669 -W File is writable by real uid.
7670 -X File is executable by real uid.
7671 -b File is a block special file.
7672 -c File is a character special file.
7673 -d File is a directory.
7675 -f File is a plain file.
7676 -g File has setgid bit set.
7677 -k File has sticky bit set.
7678 -l File is a symbolic link.
7679 -o File is owned by effective uid.
7680 -p File is a named pipe (FIFO).
7681 -r File is readable by effective uid.
7682 -s File has non-zero size.
7683 -t Tests if filehandle (STDIN by default) is opened to a tty.
7684 -u File has setuid bit set.
7685 -w File is writable by effective uid.
7686 -x File is executable by effective uid.
7687 -z File has zero size.
7688 . Concatenate strings.
7689 .. Range (list context); flip/flop (scalar context) operator.
7690 .= Concatenate assignment strings
7691 ... / ... Division. /PATTERN/ioxsmg Pattern match
7692 ... /= ... Division assignment.
7693 /PATTERN/ioxsmg Pattern match.
7694 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
7695 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7696 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7697 <> Reads line from union of files in @ARGV (= command line) and STDIN.
7698 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7699 ... <= ... Numeric less than or equal to.
7700 ... <=> ... Numeric compare.
7701 ... = ... Assignment.
7702 ... == ... Numeric equality.
7703 ... =~ ... Search pattern, substitution, or translation
7704 ... > ... Numeric greater than.
7705 ... >= ... Numeric greater than or equal to.
7706 ... >> ... Bitwise shift right.
7707 ... >>= ... Bitwise shift right assignment.
7708 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7709 ?PATTERN? One-time pattern match.
7710 @ARGV Command line arguments (not including the command name - see $0).
7711 @INC List of places to look for perl scripts during do/include/use.
7712 @_ Parameter array for subroutines; result of split() unless in list context.
7713 \\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
7714 \\0 Octal char, e.g. \\033.
7715 \\E Case modification terminator. See \\Q, \\L, and \\U.
7716 \\L Lowercase until \\E . See also \\l, lc.
7717 \\U Upcase until \\E . See also \\u, uc.
7718 \\Q Quote metacharacters until \\E . See also quotemeta.
7719 \\a Alarm character (octal 007).
7720 \\b Backspace character (octal 010).
7721 \\c Control character, e.g. \\c[ .
7722 \\e Escape character (octal 033).
7723 \\f Formfeed character (octal 014).
7724 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
7725 \\n Newline character (octal 012 on most systems).
7726 \\r Return character (octal 015 on most systems).
7727 \\t Tab character (octal 011).
7728 \\u Upcase the next character. See also \\U and \\l, ucfirst.
7729 \\x Hex character, e.g. \\x1b.
7730 ... ^ ... Bitwise exclusive or.
7731 __END__ Ends program source.
7732 __DATA__ Ends program source.
7733 __FILE__ Current (source) filename.
7734 __LINE__ Current line in current source.
7735 __PACKAGE__ Current package.
7736 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7737 ARGVOUT Output filehandle with -i flag.
7738 BEGIN { ... } Immediately executed (during compilation) piece of code.
7739 END { ... } Pseudo-subroutine executed after the script finishes.
7740 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7741 INIT { ... } Pseudo-subroutine executed before the script starts running.
7742 DATA Input filehandle for what follows after __END__ or __DATA__.
7743 accept(NEWSOCKET,GENERICSOCKET)
7756 ... cmp ... String compare.
7757 connect(SOCKET,NAME)
7758 continue of { block } continue { block }. Is executed after `next' or at end.
7760 crypt(PLAINTEXT,SALT)
7762 dbmopen(%HASH,DBNAME,MODE)
7766 do { ... }|SUBR while|until EXPR executes at least once
7767 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7777 ... eq ... String equality.
7778 eval(EXPR) or eval { BLOCK }
7779 exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
7782 fcntl(FILEHANDLE,FUNCTION,SCALAR)
7784 flock(FILEHANDLE,OPERATION)
7785 for (EXPR;EXPR;EXPR) { ... }
7786 foreach [VAR] (@ARRAY) { ... }
7788 ... ge ... String greater than or equal.
7793 gethostbyaddr(ADDR,ADDRTYPE)
7797 getnetbyaddr(ADDR,ADDRTYPE)
7803 getpriority(WHICH,WHO)
7804 getprotobyname(NAME)
7805 getprotobynumber(NUMBER)
7810 getservbyname(NAME,PROTO)
7811 getservbyport(PORT,PROTO)
7814 getsockopt(SOCKET,LEVEL,OPTNAME)
7817 ... gt ... String greater than.
7819 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7820 index(STR,SUBSTR[,OFFSET])
7822 ioctl(FILEHANDLE,FUNCTION,SCALAR)
7827 ... le ... String less than or equal.
7829 link(OLDFILE,NEWFILE)
7830 listen(SOCKET,QUEUESIZE)
7834 lstat(EXPR|FILEHANDLE|VAR)
7835 ... lt ... String less than.
7837 mkdir(FILENAME,MODE)
7840 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7841 msgsnd(ID,MSG,FLAGS)
7842 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
7843 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
7844 ... ne ... String inequality.
7847 open(FILEHANDLE[,EXPR])
7848 opendir(DIRHANDLE,EXPR)
7849 ord(EXPR) ASCII value of the first char of the string.
7851 package NAME Introduces package context.
7852 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7854 print [FILEHANDLE] [(LIST)]
7855 printf [FILEHANDLE] (FORMAT,LIST)
7857 q/STRING/ Synonym for 'STRING'
7858 qq/STRING/ Synonym for \"STRING\"
7859 qx/STRING/ Synonym for `STRING`
7861 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7864 recv(SOCKET,SCALAR,LEN,FLAGS)
7866 rename(OLDNAME,NEWNAME)
7867 require [FILENAME | PERL_VERSION]
7871 rewinddir(DIRHANDLE)
7872 rindex(STR,SUBSTR[,OFFSET])
7874 s/PATTERN/REPLACEMENT/gieoxsm
7876 seek(FILEHANDLE,POSITION,WHENCE)
7877 seekdir(DIRHANDLE,POS)
7878 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7879 semctl(ID,SEMNUM,CMD,ARG)
7880 semget(KEY,NSEMS,SIZE,FLAGS)
7882 send(SOCKET,MSG,FLAGS[,TO])
7884 sethostent(STAYOPEN)
7887 setpriority(WHICH,WHO,PRIORITY)
7888 setprotoent(STAYOPEN)
7890 setservent(STAYOPEN)
7891 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7894 shmget(KEY,SIZE,FLAGS)
7895 shmread(ID,VAR,POS,SIZE)
7896 shmwrite(ID,STRING,POS,SIZE)
7897 shutdown(SOCKET,HOW)
7900 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7901 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7902 sort [SUBROUTINE] (LIST)
7903 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7904 split[(/PATTERN/[,EXPR[,LIMIT]])]
7905 sprintf(FORMAT,LIST)
7908 stat(EXPR|FILEHANDLE|VAR)
7910 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7911 substr(EXPR,OFFSET[,LEN])
7912 symlink(OLDFILE,NEWFILE)
7914 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7915 system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
7916 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7921 tr/SEARCHLIST/REPLACEMENTLIST/cds
7922 truncate(FILE|EXPR,LENGTH)
7925 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7927 unpack(TEMPLATE,EXPR)
7929 until (EXPR) { ... } EXPR until EXPR
7932 vec(EXPR,OFFSET,BITS)
7935 wantarray Returns true if the sub/eval is called in list context.
7937 while (EXPR) { ... } EXPR while EXPR
7938 write[(EXPR|FILEHANDLE)]
7939 ... x ... Repeat string or array.
7940 x= ... Repetition assignment.
7941 y/SEARCHLIST/REPLACEMENTLIST/
7942 ... | ... Bitwise or.
7943 ... || ... Logical or.
7944 ~ ... Unary bitwise complement.
7945 #! OS interpreter indicator. If contains `perl', used for options, and -x.
7946 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7947 CORE:: Prefix to access builtin function if imported sub obscures it.
7948 SUPER:: Prefix to lookup for a method in @ISA classes.
7949 DESTROY Shorthand for `sub DESTROY {...}'.
7950 ... EQ ... Obsolete synonym of `eq'.
7951 ... GE ... Obsolete synonym of `ge'.
7952 ... GT ... Obsolete synonym of `gt'.
7953 ... LE ... Obsolete synonym of `le'.
7954 ... LT ... Obsolete synonym of `lt'.
7955 ... NE ... Obsolete synonym of `ne'.
7956 abs [ EXPR ] absolute value
7957 ... and ... Low-precedence synonym for &&.
7958 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7959 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
7960 chr Converts a number to char with the same ordinal.
7961 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7962 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7963 exists $HASH{KEY} True if the key exists.
7964 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7965 formline PICTURE, LIST Backdoor into \"format\" processing.
7966 glob EXPR Synonym of <EXPR>.
7967 lc [ EXPR ] Returns lowercased EXPR.
7968 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
7969 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
7970 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
7971 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
7972 not ... Low-precedence synonym for ! - negation.
7973 ... or ... Low-precedence synonym for ||.
7974 pos STRING Set/Get end-position of the last match over this string, see \\G.
7975 quotemeta [ EXPR ] Quote regexp metacharacters.
7976 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
7977 readline FH Synonym of <FH>.
7978 readpipe CMD Synonym of `CMD`.
7979 ref [ EXPR ] Type of EXPR when dereferenced.
7980 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
7981 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
7982 tied Returns internal object for a tied data.
7983 uc [ EXPR ] Returns upcased EXPR.
7984 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
7985 untie VAR Unlink an object from a simple Perl variable.
7986 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
7987 ... xor ... Low-precedence synonym for exclusive or.
7988 prototype \\&SUB Returns prototype of the function given a reference.
7989 =head1 Top-level heading.
7990 =head2 Second-level heading.
7991 =head3 Third-level heading (is there such?).
7992 =over [ NUMBER ] Start list.
7993 =item [ TITLE ] Start new item in the list.
7995 =cut Switch from POD to Perl.
7996 =pod Switch from Perl to POD.
7999 (defun cperl-switch-to-doc-buffer (&optional interactive)
8000 "Go to the perl documentation buffer and insert the documentation."
8002 (let ((buf (get-buffer-create cperl-doc-buffer)))
8004 (switch-to-buffer-other-window buf)
8006 (if (= (buffer-size) 0)
8008 (insert (documentation-property 'cperl-short-docs
8009 'variable-documentation))
8010 (setq buffer-read-only t)))))
8012 (defun cperl-beautify-regexp-piece (b e embed level)
8013 ;; b is before the starting delimiter, e before the ending
8014 ;; e should be a marker, may be changed, but remains "correct".
8015 ;; EMBED is nil if we process the whole REx.
8016 ;; The REx is guaranteed to have //x
8017 ;; LEVEL shows how many levels deep to go
8018 ;; position at enter and at leave is not defined
8019 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8023 (setq c (if (eq embed t) (current-indentation) (current-column)))
8024 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8028 ((looking-at "(\\?[^a-zA-Z]")
8030 ((looking-at "(\\?") ; (?i)
8035 (setq c (1- (current-column))))
8036 (setq c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
8037 (or (looking-at "[ \t]*[\n#]")
8042 (if (re-search-forward "[^ \t]" e t)
8043 (progn ; Something before the ending delimiter
8045 (delete-horizontal-space)
8047 (cperl-make-indent c)
8048 (set-marker e (point))))
8051 (while (< (point) (marker-position e))
8055 (skip-chars-forward " \t")
8056 (delete-region s (point))
8057 (cperl-make-indent c1)
8061 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8062 "\\|" ; Embedded variable
8063 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8066 "\\|" ; simple-code simple-code*?
8067 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8071 "\\((\\(\\?\\)?\\)" ; 7 8
8074 (goto-char (match-end 0))
8076 (cond ((match-beginning 1) ; Alphanum word + junk
8078 ((or (match-beginning 3) ; $ab[12]
8079 (and (match-beginning 5) ; X* X+ X{2,3}
8080 (eq (preceding-char) ?\{)))
8083 ((and ; [], already syntaxified
8086 cperl-use-syntax-table-text-property)
8089 (or (eq (preceding-char) ?\])
8090 (error "[]-group not terminated"))
8092 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8093 ((match-beginning 6) ; []
8095 (if (looking-at "\\^?\\]")
8096 (goto-char (match-end 0)))
8097 ;; XXXX POSIX classes?!
8098 (while (and (not pos)
8099 (re-search-forward "\\[:\\|\\]" e t))
8100 (if (eq (preceding-char) ?:)
8101 (or (re-search-forward ":\\]" e t)
8102 (error "[:POSIX:]-group in []-group not terminated"))
8104 (or (eq (preceding-char) ?\])
8105 (error "[]-group not terminated"))
8107 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8108 ((match-beginning 7) ; ()
8109 (goto-char (match-beginning 0))
8110 (setq pos (current-column))
8113 (delete-horizontal-space)
8115 (cperl-make-indent c1)))
8118 ;; (or (forward-sexp 1)
8121 ;; (error "()-group not terminated")))
8122 (set-marker m (1- (point)))
8123 (set-marker m1 (point))
8125 (if (progn ; indent rigidly if multiline
8126 ;; In fact does not make a lot of sense, since
8127 ;; the starting position can be already lost due
8128 ;; to insertion of "\n" and " "
8130 (search-forward "\n" m1 t))
8131 (indent-rigidly (point) m1 (- c1 pos)))
8132 (setq level (1- level))
8134 ((not (match-beginning 8))
8135 (cperl-beautify-regexp-piece tmp m t level))
8136 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8138 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8139 (goto-char (+ 2 tmp))
8141 (cperl-beautify-regexp-piece (point) m t level))
8142 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8143 (goto-char (+ 3 tmp))
8144 (cperl-beautify-regexp-piece (point) m t level))
8146 (cperl-beautify-regexp-piece tmp m t level))))
8148 (cond ((looking-at "[*+?]\\??")
8149 (goto-char (match-end 0)))
8150 ((eq (following-char) ?\{)
8152 (if (eq (following-char) ?\?)
8154 (skip-chars-forward " \t")
8156 (if (looking-at "[#\n]")
8158 (or (eolp) (indent-for-comment))
8159 (beginning-of-line 2))
8160 (delete-horizontal-space)
8164 ((match-beginning 9) ; |
8168 (if (re-search-forward "[^ \t]" tmp t)
8171 (delete-horizontal-space)
8174 (delete-region (point) tmp))
8175 (cperl-make-indent c)
8177 (skip-chars-forward " \t")
8179 (if (looking-at "[#\n]")
8180 (beginning-of-line 2)
8181 (delete-horizontal-space)
8185 (or (looking-at "[ \t\n]")
8188 (skip-chars-forward " \t"))
8189 (or (looking-at "[#\n]")
8190 (error "Unknown code `%s' in a regexp"
8191 (buffer-substring (point) (1+ (point)))))
8192 (and inline (end-of-line 2)))
8193 ;; Special-case the last line of group
8194 (if (and (>= (point) (marker-position e))
8195 (/= (current-indentation) c))
8198 (cperl-make-indent c)))))
8200 (defun cperl-make-regexp-x ()
8201 ;; Returns position of the start
8202 ;; XXX this is called too often! Need to cache the result!
8204 (or cperl-use-syntax-table-text-property
8205 (error "I need to have a regexp marked!"))
8207 (if (looking-at "\\s|")
8209 (if (or (looking-at "\\([smy]\\|qr\\)\\s|")
8210 (and (eq (preceding-char) ?q)
8211 (looking-at "\\(r\\)\\s|")))
8212 (goto-char (match-end 1))
8213 (re-search-backward "\\s|"))) ; Assume it is scanned already.
8215 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8216 (sub-p (eq (preceding-char) ?s)) s)
8218 (set-marker e (1- (point)))
8219 (setq delim (preceding-char))
8220 (if (and sub-p (eq delim (char-after (- (point) 2))))
8221 (error "Possible s/blah// - do not know how to deal with"))
8222 (if sub-p (forward-sexp 1))
8223 (if (looking-at "\\sw*x")
8226 ;; Protect fragile " ", "#"
8229 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8235 (defun cperl-beautify-regexp (&optional deep)
8236 "Do it. (Experimental, may change semantics, recheck the result.)
8237 We suppose that the regexp is scanned already."
8239 (setq deep (if deep (prefix-numeric-value deep) -1))
8241 (goto-char (cperl-make-regexp-x))
8242 (let ((b (point)) (e (make-marker)))
8244 (set-marker e (1- (point)))
8245 (cperl-beautify-regexp-piece b e nil deep))))
8247 (defun cperl-regext-to-level-start ()
8248 "Goto start of an enclosing group in regexp.
8249 We suppose that the regexp is scanned already."
8251 (let ((limit (cperl-make-regexp-x)) done)
8253 (or (eq (following-char) ?\()
8254 (search-backward "(" (1+ limit) t)
8255 (error "Cannot find `(' which starts a group"))
8258 (skip-chars-backward "\\")
8259 (looking-at "\\(\\\\\\\\\\)*(")))
8260 (or done (forward-char -1)))))
8262 (defun cperl-contract-level ()
8263 "Find an enclosing group in regexp and contract it.
8264 \(Experimental, may change semantics, recheck the result.)
8265 We suppose that the regexp is scanned already."
8267 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
8268 (cperl-regext-to-level-start)
8269 (let ((b (point)) (e (make-marker)) c)
8271 (set-marker e (1- (point)))
8273 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8275 ((match-beginning 1) ; #-comment
8276 (or c (setq c (current-indentation)))
8277 (beginning-of-line 2) ; Skip
8278 (cperl-make-indent c))
8281 (just-one-space))))))
8283 (defun cperl-contract-levels ()
8284 "Find an enclosing group in regexp and contract all the kids.
8285 \(Experimental, may change semantics, recheck the result.)
8286 We suppose that the regexp is scanned already."
8290 (cperl-regext-to-level-start)
8291 (error ; We are outside outermost group
8292 (goto-char (cperl-make-regexp-x))))
8293 (let ((b (point)) (e (make-marker)) s c)
8295 (set-marker e (1- (point)))
8297 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
8299 ((match-beginning 1) ; Skip
8302 (cperl-contract-level)))))))
8304 (defun cperl-beautify-level (&optional deep)
8305 "Find an enclosing group in regexp and beautify it.
8306 \(Experimental, may change semantics, recheck the result.)
8307 We suppose that the regexp is scanned already."
8309 (setq deep (if deep (prefix-numeric-value deep) -1))
8311 (cperl-regext-to-level-start)
8312 (let ((b (point)) (e (make-marker)))
8314 (set-marker e (1- (point)))
8315 (cperl-beautify-regexp-piece b e 'level deep))))
8317 (defun cperl-invert-if-unless-modifiers ()
8318 "Change `B if A;' into `if (A) {B}' etc if possible.
8321 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8322 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8323 (and (= (char-syntax (preceding-char)) ?w)
8325 (setq pre-if (point))
8326 (cperl-backward-to-start-of-expr)
8327 (setq pre-B (point))
8328 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8329 (cperl-forward-to-end-of-expr)
8330 (setq post-A (point))
8332 (or (looking-at w-rex)
8333 ;; Find the position
8334 (progn (goto-char post-A)
8336 (not (looking-at w-rex))
8339 (setq pre-if (point))))
8340 (or (looking-at w-rex)
8341 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8342 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8343 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8344 ;; First, simple part: find code boundaries
8346 (setq post-if (point))
8349 (setq post-B (point))
8350 (cperl-backward-to-start-of-expr)
8351 (setq pre-B (point))
8352 (setq B (buffer-substring pre-B post-B))
8356 ;; May be after $, @, $# etc of a variable
8357 (skip-chars-backward "$@%#")
8358 (setq pre-A (point))
8359 (cperl-forward-to-end-of-expr)
8360 (setq post-A (point))
8361 (setq A (buffer-substring pre-A post-A))
8362 ;; Now modify (from end, to not break the stuff)
8363 (skip-chars-forward " \t;")
8364 (delete-region pre-A (point)) ; we move to pre-A
8365 (insert "\n" B ";\n}")
8366 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8367 (delete-region pre-if post-if)
8368 (delete-region pre-B post-B)
8370 (insert if-string " (" A ") {")
8371 (setq post-B (point))
8372 (if (looking-at "[ \t]+$")
8373 (delete-horizontal-space)
8374 (if (looking-at "[ \t]*#")
8375 (cperl-indent-for-comment)
8378 (if (looking-at "[ \t]*$")
8379 (progn ; delete line
8380 (delete-horizontal-space)
8381 (delete-region (point) (1+ (point)))))
8383 (goto-char (1- post-B))
8388 (defun cperl-invert-if-unless ()
8389 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8390 If the cursor is not on the leading keyword of the BLOCK flavor of
8391 construct, will assume it is the STATEMENT flavor, so will try to find
8392 the appropriate statement modifier."
8394 (and (= (char-syntax (preceding-char)) ?w)
8396 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
8397 (let ((pre-if (point))
8398 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8399 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
8401 (setq post-A (point))
8403 (setq pre-A (point))
8404 (setq is-block (and (eq (following-char) ?\( )
8410 (eq (following-char) ?\{ ))
8416 (setq post-B (point))
8418 (setq pre-B (point))
8419 (if (and (eq (following-char) ?\{ )
8421 (cperl-backward-to-noncomment post-A)
8422 (eq (preceding-char) ?\) )))
8423 (if (condition-case nil
8428 (looking-at "\\<els\\(e\\|if\\)\\>"))
8431 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8432 (goto-char (1- post-B))
8433 (cperl-backward-to-noncomment pre-B)
8434 (if (eq (preceding-char) ?\;)
8436 (setq end-B-code (point))
8438 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
8439 (setq p (match-beginning 0)
8440 A (buffer-substring p (match-end 0))
8441 state (parse-partial-sexp pre-B p))
8445 (error "`%s' inside `%s' BLOCK" A if-string))
8446 (goto-char (match-end 0)))
8448 (goto-char (1+ pre-B))
8449 (skip-chars-forward " \t\n")
8450 (setq B (buffer-substring (point) end-B-code))
8451 (goto-char end-B-code)
8452 (or (looking-at ";?[ \t\n]*}")
8454 (skip-chars-forward "; \t\n")
8456 (buffer-substring (point) (1- post-B)))))
8459 (goto-char (1- post-A))
8460 (cperl-backward-to-noncomment pre-A)
8461 (or (looking-at "[ \t\n]*)")
8462 (goto-char (1- post-A)))
8464 (goto-char (1+ pre-A))
8465 (skip-chars-forward " \t\n")
8466 (setq A (buffer-substring (point) p))
8467 (delete-region pre-B post-B)
8468 (delete-region pre-A post-A)
8471 (and B-comment (insert B-comment " "))
8474 (setq pre-A (point))
8476 (delete-horizontal-space)
8477 (setq post-B (point))
8478 (if (looking-at "#")
8479 (indent-for-comment))
8482 (delete-horizontal-space)
8486 (setq pre-A (set-marker (make-marker) pre-A))
8487 (while (<= (point) (marker-position pre-A))
8490 (goto-char (marker-position pre-A))
8494 (indent-for-comment)
8495 (goto-char (marker-position pre-A)))))
8496 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8497 ;; (error "`%s' not with an (EXPR)" if-string)
8499 (cperl-invert-if-unless-modifiers)))
8500 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8501 (cperl-invert-if-unless-modifiers)))
8503 ;;; By Anthony Foiani <afoiani@uswest.com>
8504 ;;; Getting help on modules in C-h f ?
8505 ;;; This is a modified version of `man'.
8506 ;;; Need to teach it how to lookup functions
8508 (defun cperl-perldoc (word)
8509 "Run `perldoc' on WORD."
8511 (list (let* ((default-entry (cperl-word-at-point))
8513 (format "perldoc entry%s: "
8514 (if (string= default-entry "")
8516 (format " (default %s)" default-entry))))))
8517 (if (string= input "")
8518 (if (string= default-entry "")
8519 (error "No perldoc args given")
8523 (let* ((case-fold-search nil)
8525 (string-match "^[a-z]+$" word)
8526 (string-match (concat "^" word "\\>")
8527 (documentation-property
8529 'variable-documentation))))
8531 (manual-program (if is-func "perldoc -f" "perldoc")))
8534 (let ((Manual-program "perldoc")
8535 (Manual-switches (if is-func (list "-f"))))
8536 (manual-entry word)))
8538 (Man-getpage-in-background word)))))
8541 (defun cperl-perldoc-at-point ()
8542 "Run a `perldoc' on the word around point."
8544 (cperl-perldoc (cperl-word-at-point)))
8546 (defcustom pod2man-program "pod2man"
8547 "*File name for `pod2man'."
8551 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
8552 (defun cperl-pod-to-manpage ()
8553 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8556 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8557 (bufname (concat "Man " buffer-file-name))
8558 (buffer (generate-new-buffer bufname)))
8559 (with-current-buffer buffer
8560 (let ((process-environment (copy-sequence process-environment)))
8561 ;; Prevent any attempt to use display terminal fanciness.
8562 (setenv "TERM" "dumb")
8563 (set-process-sentinel
8564 (start-process pod2man-program buffer "sh" "-c"
8565 (format (cperl-pod2man-build-command) pod2man-args))
8566 'Man-bgproc-sentinel)))))
8568 ;;; Updated version by him too
8569 (defun cperl-build-manpage ()
8570 "Create a virtual manpage in Emacs from the POD in the file."
8575 (let ((Manual-program "perldoc"))
8576 (manual-entry buffer-file-name)))
8578 (let* ((manual-program "perldoc")
8580 (Man-getpage-in-background buffer-file-name)))))
8582 (defun cperl-pod2man-build-command ()
8583 "Builds the entire background manpage and cleaning command."
8584 (let ((command (concat pod2man-program " %s 2>/dev/null"))
8585 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
8586 (while (and flist (car flist))
8587 (let ((pcom (car (car flist)))
8588 (pargs (cdr (car flist))))
8590 (concat command " | " pcom " "
8591 (mapconcat (lambda (phrase)
8592 (if (not (stringp phrase))
8593 (error "Malformed Man-filter-list"))
8596 (setq flist (cdr flist))))
8600 (defun cperl-next-interpolated-REx-1 ()
8601 "Move point to next REx which has interpolated parts without //o.
8602 Skips RExes consisting of one interpolated variable.
8604 Note that skipped RExen are not performance hits."
8606 (cperl-next-interpolated-REx 1))
8608 (defun cperl-next-interpolated-REx-0 ()
8609 "Move point to next REx which has interpolated parts without //o."
8611 (cperl-next-interpolated-REx 0))
8613 (defun cperl-next-interpolated-REx (&optional skip beg limit)
8614 "Move point to next REx which has interpolated parts.
8615 SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8616 point and the limit of search (default to point and end of buffer).
8618 SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8619 semantic may be used as a numeric argument.
8621 Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8622 a result of qr//, this is not a performance hit), t for the rest."
8624 (if (numberp skip) (setq skip (list 0 skip)))
8625 (or beg (setq beg (point)))
8626 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8628 (and (eq (get-text-property beg 'syntax-type) 'string)
8629 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8630 (cperl-map-pods-heres
8631 (function (lambda (s e p)
8632 (if (memq (get-text-property s 'REx-interpolated) skip)
8636 'REx-interpolated beg limit)
8637 (if pp (goto-char pp)
8638 (message "No more interpolated REx"))))
8640 ;;; Initial version contributed by Trey Belew
8641 (defun cperl-here-doc-spell (&optional beg end)
8642 "Spell-check HERE-documents in the Perl buffer.
8643 If a region is highlighted, restricts to the region."
8645 (cperl-pod-spell t beg end))
8647 (defun cperl-pod-spell (&optional do-heres beg end)
8648 "Spell-check POD documentation.
8649 If invoked with prefix argument, will do HERE-DOCs instead.
8650 If a region is highlighted, restricts to the region."
8654 (if (cperl-mark-active)
8655 (setq beg (min (mark) (point))
8656 end (max (mark) (point)))
8657 (setq beg (point-min)
8659 (cperl-map-pods-heres (function
8662 (setq e (save-excursion
8668 (if do-heres 'here-doc-group 'in-pod)
8671 (defun cperl-map-pods-heres (func &optional prop s end)
8672 "Executes a function over regions of pods or here-documents.
8673 PROP is the text-property to search for; default to `in-pod'. Stop when
8674 function returns nil."
8675 (let (pos posend has-prop (cont t))
8676 (or prop (setq prop 'in-pod))
8677 (or s (setq s (point-min)))
8678 (or end (setq end (point-max)))
8679 (cperl-update-syntaxification end end)
8681 (goto-char (setq pos s))
8682 (while (and cont (< pos end))
8683 (setq has-prop (get-text-property pos prop))
8684 (setq posend (next-single-property-change pos prop nil end))
8686 (setq cont (funcall func pos posend prop)))
8687 (setq pos posend)))))
8689 ;;; Based on code by Masatake YAMATO:
8690 (defun cperl-get-here-doc-region (&optional pos pod)
8691 "Return HERE document region around the point.
8692 Return nil if the point is not in a HERE document region. If POD is non-nil,
8693 will return a POD section if point is in a POD section."
8694 (or pos (setq pos (point)))
8695 (cperl-update-syntaxification pos pos)
8696 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8698 (eq 'pod (get-text-property pos 'syntax-type))))
8699 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8700 (e (next-single-property-change pos 'syntax-type)))
8701 (cons b (or e (point-max))))))
8703 (defun cperl-narrow-to-here-doc (&optional pos)
8704 "Narrows editing region to the HERE-DOC at POS.
8705 POS defaults to the point."
8707 (or pos (setq pos (point)))
8708 (let ((p (cperl-get-here-doc-region pos)))
8709 (or p (error "Not inside a HERE document"))
8710 (narrow-to-region (car p) (cdr p))
8712 "When you are finished with narrow editing, type C-x n w")))
8714 (defun cperl-select-this-pod-or-here-doc (&optional pos)
8715 "Select the HERE-DOC (or POD section) at POS.
8716 POS defaults to the point."
8718 (let ((p (cperl-get-here-doc-region pos t)))
8722 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8723 (message "I do not think POS is in POD or a HERE-doc..."))))
8725 (defun cperl-facemenu-add-face-function (face end)
8726 "A callback to process user-initiated font-change requests.
8727 Translates `bold', `italic', and `bold-italic' requests to insertion of
8728 corresponding POD directives, and `underline' to C<> POD directive.
8730 Such requests are usually bound to M-o LETTER."
8731 (or (get-text-property (point) 'in-pod)
8732 (error "Faces can only be set within POD"))
8733 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8734 (cdr (or (assq face '((bold . "B<")
8736 (bold-italic . "B<I<")
8737 (underline . "C<")))
8738 (error "Face %s not configured for cperl-mode"
8741 (defun cperl-time-fontification (&optional l step lim)
8742 "Times how long it takes to do incremental fontification in a region.
8743 L is the line to start at, STEP is the number of lines to skip when
8744 doing next incremental fontification, LIM is the maximal number of
8745 incremental fontification to perform. Messages are accumulated in
8748 May be used for pinpointing which construct slows down buffer fontification:
8749 start with default arguments, then refine the slowdown regions."
8750 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8752 (or step (setq step 500))
8753 (or lim (setq lim 40))
8754 (let* ((timems (function (lambda ()
8755 (let ((tt (current-time)))
8756 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8757 (tt (funcall timems)) (c 0) delta tot)
8758 (goto-char (point-min))
8759 (forward-line (1- l))
8761 (setq tot (- (- tt (setq tt (funcall timems)))))
8762 (message "cperl-mode at %s: %s" l tot)
8763 (while (and (< c lim) (not (eobp)))
8767 (cperl-update-syntaxification (point) (point))
8768 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8769 (message "to %s:%6s,%7s" l delta tot))
8772 (defvar font-lock-cache-position)
8774 (defun cperl-emulate-lazy-lock (&optional window-size)
8775 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8776 Start fontifying the buffer from the start (or end) using the given
8777 WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8778 goes backwards; default is -50. This function is not CPerl-specific; it
8779 may be used to debug problems with delayed incremental fontification."
8781 "nSize of window for incremental fontification, negative goes backwards: ")
8782 (or window-size (setq window-size -50))
8783 (let ((pos (if (> window-size 0)
8789 ;; Why needed??? With older font-locks???
8790 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8791 (while (if (> window-size 0)
8793 (> pos (point-min)))
8795 (forward-line window-size)
8797 (font-lock-fontify-region (min p pos) (max p pos))
8801 (defun cperl-lazy-install ()) ; Avoid a warning
8802 (defun cperl-lazy-unstall ()) ; Avoid a warning
8804 (if (fboundp 'run-with-idle-timer)
8806 (defvar cperl-help-shown nil
8807 "Non-nil means that the help was already shown now.")
8809 (defvar cperl-lazy-installed nil
8810 "Non-nil means that the lazy-help handlers are installed now.")
8812 (defun cperl-lazy-install ()
8813 "Switches on Auto-Help on Perl constructs (put in the message area).
8814 Delay of auto-help controlled by `cperl-lazy-help-time'."
8816 (make-local-variable 'cperl-help-shown)
8817 (if (and (cperl-val 'cperl-lazy-help-time)
8818 (not cperl-lazy-installed))
8820 (add-hook 'post-command-hook 'cperl-lazy-hook)
8821 (run-with-idle-timer
8822 (cperl-val 'cperl-lazy-help-time 1000000 5)
8824 'cperl-get-help-defer)
8825 (setq cperl-lazy-installed t))))
8827 (defun cperl-lazy-unstall ()
8828 "Switches off Auto-Help on Perl constructs (put in the message area).
8829 Delay of auto-help controlled by `cperl-lazy-help-time'."
8831 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8832 (cancel-function-timers 'cperl-get-help-defer)
8833 (setq cperl-lazy-installed nil))
8835 (defun cperl-lazy-hook ()
8836 (setq cperl-help-shown nil))
8838 (defun cperl-get-help-defer ()
8839 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
8840 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8842 (setq cperl-help-shown t))))
8843 (cperl-lazy-install)))
8846 ;;; Plug for wrong font-lock:
8848 (defun cperl-font-lock-unfontify-region-function (beg end)
8849 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8850 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8851 before-change-functions after-change-functions
8852 deactivate-mark buffer-file-name buffer-file-truename)
8853 (remove-text-properties beg end '(face nil))
8854 (if (and (not modified) (buffer-modified-p))
8855 (set-buffer-modified-p nil))))
8857 (defun cperl-font-lock-fontify-region-function (beg end loudly)
8858 "Extends the region to safe positions, then calls the default function.
8859 Newer `font-lock's can do it themselves.
8860 We unwind only as far as needed for fontification. Syntaxification may
8861 do extra unwind via `cperl-unwind-to-safe'."
8867 (eq (get-text-property (setq beg (point)) 'syntax-type)
8869 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8875 (or (bolp) (condition-case nil
8878 (eq (get-text-property (setq end (point)) 'syntax-type)
8880 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8883 (font-lock-default-fontify-region beg end loudly))
8885 (defvar cperl-d-l nil)
8886 (defun cperl-fontify-syntaxically (end)
8887 ;; Some vars for debugging only
8888 ;; (message "Syntaxifying...")
8889 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
8890 (istate (car cperl-syntax-state))
8891 start from-start edebug-backtrace-buffer)
8892 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8895 (let ((f 'edebug-backtrace))
8896 (funcall f)))) ; Avoid compile-time warning
8897 (or cperl-syntax-done-to
8898 (setq cperl-syntax-done-to (point-min)
8900 (setq start (if (and cperl-hook-after-change
8902 cperl-syntax-done-to ; Fontify without change; ignore start
8903 ;; Need to forget what is after `start'
8904 (min cperl-syntax-done-to (point))))
8907 (setq start (point))
8908 (and cperl-syntaxify-unwind
8909 (setq end (cperl-unwind-to-safe t end)
8912 (setq cperl-syntax-done-to start) ; In case what follows fails
8913 (cperl-find-pods-heres start end t nil t))
8914 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8915 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8916 dbg iend start end idone cperl-syntax-done-to
8917 istate (car cperl-syntax-state))) ; For debugging
8918 nil)) ; Do not iterate
8920 (defun cperl-fontify-update (end)
8921 (let ((pos (point-min)) prop posend)
8922 (setq end (point-max))
8924 (setq prop (get-text-property pos 'cperl-postpone)
8925 posend (next-single-property-change pos 'cperl-postpone nil end))
8926 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8928 nil) ; Do not iterate
8930 (defun cperl-fontify-update-bad (end)
8931 ;; Since fontification happens with different region than syntaxification,
8932 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8933 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8935 (setq pos (or (cperl-beginning-of-property
8936 (cperl-1+ pos) 'cperl-postpone)
8939 (setq posend (next-single-property-change pos 'cperl-postpone))
8940 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8942 (setq prop (get-text-property pos 'cperl-postpone))))
8943 nil) ; Do not iterate
8945 ;; Called when any modification is made to buffer text.
8946 (defun cperl-after-change-function (beg end old-len)
8947 ;; We should have been informed about changes by `font-lock'. Since it
8948 ;; does not inform as which calls are deferred, do it ourselves
8949 (if cperl-syntax-done-to
8950 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8952 (defun cperl-update-syntaxification (from to)
8954 ((not cperl-use-syntax-table-text-property) nil)
8955 ((fboundp 'syntax-propertize) (syntax-propertize to))
8956 ((and cperl-syntaxify-by-font-lock
8957 (or (null cperl-syntax-done-to)
8958 (< cperl-syntax-done-to to)))
8961 (cperl-fontify-syntaxically to)))))
8963 (defvar cperl-version
8964 (let ((v "Revision: 6.2"))
8965 (string-match ":\\s *\\([0-9.]+\\)" v)
8966 (substring v (match-beginning 1) (match-end 1)))
8967 "Version of IZ-supported CPerl package this file is based on.")
8969 (provide 'cperl-mode)
8971 ;;; cperl-mode.el ends here