1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1991, 1992, 1993, 1994, 1995, 1996,
4 ;; 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
5 ;; 2008, 2009, 2010 Free Software Foundation, Inc.
7 ;; Author: Ilya Zakharevich
9 ;; Maintainer: Ilya Zakharevich <ilyaz@cpan.org>
10 ;; Keywords: languages, Perl
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Corrections made by Ilya Zakharevich ilyaz@cpan.org
31 ;; You can either fine-tune the bells and whistles of this mode or
32 ;; bulk enable them by putting
34 ;; (setq cperl-hairy t)
36 ;; in your .emacs file. (Emacs rulers do not consider it politically
37 ;; correct to make whistles enabled by default.)
39 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
40 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
41 ;; `cperl-praise', `cperl-speed'. <<<<<<
43 ;; The mode information (on C-h m) provides some customization help.
44 ;; If you use font-lock feature of this mode, it is advisable to use
45 ;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
47 ;; Faces used now: three faces for first-class and second-class keywords
48 ;; and control flow words, one for each: comments, string, labels,
49 ;; functions definitions and packages, arrays, hashes, and variable
50 ;; definitions. If you do not see all these faces, your font-lock does
51 ;; not define them, so you need to define them manually.
53 ;; This mode supports font-lock, imenu and mode-compile. In the
54 ;; hairy version font-lock is on, but you should activate imenu
55 ;; yourself (note that mode-compile is not standard yet). Well, you
56 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
57 ;; to bind it like that:
59 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
61 ;;; Font lock bugs as of v4.32:
63 ;; The following kinds of Perl code erroneously start strings:
65 ;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
66 ;; likewise with m, tr, y, q, qX instead of s
70 (defvar vc-rcs-header
)
71 (defvar vc-sccs-header
)
80 (defvar cperl-can-font-lock
81 (or (featurep 'xemacs
)
82 (and (boundp 'emacs-major-version
)
84 (> emacs-major-version
20)))))
85 (if cperl-can-font-lock
87 (defvar msb-menu-cond
)
88 (defvar gud-perldb-history
)
89 (defvar font-lock-background-mode
) ; not in Emacs
90 (defvar font-lock-display-type
) ; ditto
91 (defvar paren-backwards-message
) ; Not in newer XEmacs?
92 (or (fboundp 'defgroup
)
93 (defmacro defgroup
(name val doc
&rest arr
)
95 (or (fboundp 'custom-declare-variable
)
96 (defmacro defcustom
(name val doc
&rest arr
)
97 `(defvar ,name
,val
,doc
)))
98 (or (and (fboundp 'custom-declare-variable
)
99 (string< "19.31" emacs-version
)) ; Checked with 19.30: defface does not work
100 (defmacro defface
(&rest arr
)
102 ;; Avoid warning (tmp definitions)
103 (or (fboundp 'x-color-defined-p
)
104 (defmacro x-color-defined-p
(col)
105 (cond ((fboundp 'color-defined-p
) `(color-defined-p ,col
))
107 ((fboundp 'valid-color-name-p
) `(valid-color-name-p ,col
))
109 ((fboundp 'x-valid-color-name-p
) `(x-valid-color-name-p ,col
))
110 (t '(error "Cannot implement color-defined-p")))))
111 (defmacro cperl-is-face
(arg) ; Takes quoted arg
112 (cond ((fboundp 'find-face
)
114 (;;(and (fboundp 'face-list)
117 `(member ,arg
(and (fboundp 'face-list
)
121 (defmacro cperl-make-face
(arg descr
) ; Takes unquoted arg
122 (cond ((fboundp 'make-face
)
123 `(make-face (quote ,arg
)))
125 `(defvar ,arg
(quote ,arg
) ,descr
))))
126 (defmacro cperl-force-face
(arg descr
) ; Takes unquoted arg
128 (or (cperl-is-face (quote ,arg
))
129 (cperl-make-face ,arg
,descr
))
130 (or (boundp (quote ,arg
)) ; We use unquoted variants too
131 (defvar ,arg
(quote ,arg
) ,descr
))))
132 (if (featurep 'xemacs
)
133 (defmacro cperl-etags-snarf-tag
(file line
)
135 (beginning-of-line 2)
137 (defmacro cperl-etags-snarf-tag
(file line
)
139 (if (featurep 'xemacs
)
140 (defmacro cperl-etags-goto-tag-location
(elt)
142 ;; (switch-to-buffer (get-file-buffer (elt ,elt 0)))
143 ;; (set-buffer (get-file-buffer (elt ,elt 0)))
144 ;; Probably will not work due to some save-excursion???
145 ;; Or save-file-position?
146 ;; (message "Did I get to line %s?" (elt ,elt 1))
147 `(goto-line (string-to-int (elt ,elt
1))))
149 (defmacro cperl-etags-goto-tag-location
(elt)
150 `(etags-goto-tag-location ,elt
))))
152 (defvar cperl-can-font-lock
153 (or (featurep 'xemacs
)
154 (and (boundp 'emacs-major-version
)
156 (> emacs-major-version
20)))))
158 (defun cperl-choose-color (&rest list
)
162 (if (or (x-color-defined-p (car list
))
164 (setq answer
(car list
))))
165 (setq list
(cdr list
)))
169 "Major mode for editing Perl code."
174 (defgroup cperl-indentation-details nil
179 (defgroup cperl-affected-by-hairy nil
180 "Variables affected by `cperl-hairy'."
184 (defgroup cperl-autoinsert-details nil
185 "Auto-insert tuneup."
189 (defgroup cperl-faces nil
190 "Fontification colors."
191 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
195 (defgroup cperl-speed nil
196 "Speed vs. validity tuneup."
200 (defgroup cperl-help-system nil
201 "Help system tuneup."
206 (defcustom cperl-extra-newline-before-brace nil
207 "*Non-nil means that if, elsif, while, until, else, for, foreach
208 and do constructs look like:
219 :group
'cperl-autoinsert-details
)
221 (defcustom cperl-extra-newline-before-brace-multiline
222 cperl-extra-newline-before-brace
223 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
224 for constructs with multiline if/unless/while/until/for/foreach condition."
226 :group
'cperl-autoinsert-details
)
228 (defcustom cperl-indent-level
2
229 "*Indentation of CPerl statements with respect to containing block."
231 :group
'cperl-indentation-details
)
233 ;; Is is not unusual to put both things like perl-indent-level and
234 ;; cperl-indent-level in the local variable section of a file. If only
235 ;; one of perl-mode and cperl-mode is in use, a warning will be issued
236 ;; about the variable. Autoload these here, so that no warning is
237 ;; issued when using either perl-mode or cperl-mode.
238 ;;;###autoload(put 'cperl-indent-level 'safe-local-variable 'integerp)
239 ;;;###autoload(put 'cperl-brace-offset 'safe-local-variable 'integerp)
240 ;;;###autoload(put 'cperl-continued-brace-offset 'safe-local-variable 'integerp)
241 ;;;###autoload(put 'cperl-label-offset 'safe-local-variable 'integerp)
242 ;;;###autoload(put 'cperl-continued-statement-offset 'safe-local-variable 'integerp)
243 ;;;###autoload(put 'cperl-extra-newline-before-brace 'safe-local-variable 'booleanp)
244 ;;;###autoload(put 'cperl-merge-trailing-else 'safe-local-variable 'booleanp)
246 (defcustom cperl-lineup-step nil
247 "*`cperl-lineup' will always lineup at multiple of this number.
248 If nil, the value of `cperl-indent-level' will be used."
249 :type
'(choice (const nil
) integer
)
250 :group
'cperl-indentation-details
)
252 (defcustom cperl-brace-imaginary-offset
0
253 "*Imagined indentation of a Perl open brace that actually follows a statement.
254 An open brace following other text is treated as if it were this far
255 to the right of the start of its line."
257 :group
'cperl-indentation-details
)
259 (defcustom cperl-brace-offset
0
260 "*Extra indentation for braces, compared with other text in same context."
262 :group
'cperl-indentation-details
)
263 (defcustom cperl-label-offset -
2
264 "*Offset of CPerl label lines relative to usual indentation."
266 :group
'cperl-indentation-details
)
267 (defcustom cperl-min-label-indent
1
268 "*Minimal offset of CPerl label lines."
270 :group
'cperl-indentation-details
)
271 (defcustom cperl-continued-statement-offset
2
272 "*Extra indent for lines not starting new statements."
274 :group
'cperl-indentation-details
)
275 (defcustom cperl-continued-brace-offset
0
276 "*Extra indent for substatements that start with open-braces.
277 This is in addition to cperl-continued-statement-offset."
279 :group
'cperl-indentation-details
)
280 (defcustom cperl-close-paren-offset -
1
281 "*Extra indent for substatements that start with close-parenthesis."
283 :group
'cperl-indentation-details
)
285 (defcustom cperl-indent-wrt-brace t
286 "*Non-nil means indent statements in if/etc block relative brace, not if/etc.
287 Versions 5.2 ... 5.20 behaved as if this were `nil'."
289 :group
'cperl-indentation-details
)
291 (defcustom cperl-auto-newline nil
292 "*Non-nil means automatically newline before and after braces,
293 and after colons and semicolons, inserted in CPerl code. The following
294 \\[cperl-electric-backspace] will remove the inserted whitespace.
295 Insertion after colons requires both this variable and
296 `cperl-auto-newline-after-colon' set."
298 :group
'cperl-autoinsert-details
)
300 (defcustom cperl-autoindent-on-semi nil
301 "*Non-nil means automatically indent after insertion of (semi)colon.
302 Active if `cperl-auto-newline' is false."
304 :group
'cperl-autoinsert-details
)
306 (defcustom cperl-auto-newline-after-colon nil
307 "*Non-nil means automatically newline even after colons.
308 Subject to `cperl-auto-newline' setting."
310 :group
'cperl-autoinsert-details
)
312 (defcustom cperl-tab-always-indent t
313 "*Non-nil means TAB in CPerl mode should always reindent the current line,
314 regardless of where in the line point is when the TAB command is used."
316 :group
'cperl-indentation-details
)
318 (defcustom cperl-font-lock nil
319 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
320 Can be overwritten by `cperl-hairy' if nil."
321 :type
'(choice (const null
) boolean
)
322 :group
'cperl-affected-by-hairy
)
324 (defcustom cperl-electric-lbrace-space nil
325 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
326 Can be overwritten by `cperl-hairy' if nil."
327 :type
'(choice (const null
) boolean
)
328 :group
'cperl-affected-by-hairy
)
330 (defcustom cperl-electric-parens-string
"({[]})<"
331 "*String of parentheses that should be electric in CPerl.
332 Closing ones are electric only if the region is highlighted."
334 :group
'cperl-affected-by-hairy
)
336 (defcustom cperl-electric-parens nil
337 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
338 Can be overwritten by `cperl-hairy' if nil."
339 :type
'(choice (const null
) boolean
)
340 :group
'cperl-affected-by-hairy
)
342 (defvar zmacs-regions
) ; Avoid warning
344 (defcustom cperl-electric-parens-mark
346 (or (and (boundp 'transient-mark-mode
) ; For Emacs
348 (and (boundp 'zmacs-regions
) ; For XEmacs
350 "*Not-nil means that electric parens look for active mark.
351 Default is yes if there is visual feedback on mark."
353 :group
'cperl-autoinsert-details
)
355 (defcustom cperl-electric-linefeed nil
356 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
357 In any case these two mean plain and hairy linefeeds together.
358 Can be overwritten by `cperl-hairy' if nil."
359 :type
'(choice (const null
) boolean
)
360 :group
'cperl-affected-by-hairy
)
362 (defcustom cperl-electric-keywords nil
363 "*Not-nil (and non-null) means keywords are electric in CPerl.
364 Can be overwritten by `cperl-hairy' if nil.
366 Uses `abbrev-mode' to do the expansion. If you want to use your
367 own abbrevs in cperl-mode, but do not want keywords to be
368 electric, you must redefine `cperl-mode-abbrev-table': do
369 \\[edit-abbrevs], search for `cperl-mode-abbrev-table', and, in
370 that paragraph, delete the words that appear at the ends of lines and
371 that begin with \"cperl-electric\".
373 :type
'(choice (const null
) boolean
)
374 :group
'cperl-affected-by-hairy
)
376 (defcustom cperl-electric-backspace-untabify t
377 "*Not-nil means electric-backspace will untabify in CPerl."
379 :group
'cperl-autoinsert-details
)
381 (defcustom cperl-hairy nil
382 "*Not-nil means most of the bells and whistles are enabled in CPerl.
383 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
384 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
385 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
386 `cperl-lazy-help-time'."
388 :group
'cperl-affected-by-hairy
)
390 (defcustom cperl-comment-column
32
391 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
393 :group
'cperl-indentation-details
)
395 (defcustom cperl-indent-comment-at-column-0 nil
396 "*Non-nil means that comment started at column 0 should be indentable."
398 :group
'cperl-indentation-details
)
400 (defcustom cperl-vc-sccs-header
'("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
401 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
402 :type
'(repeat string
)
405 (defcustom cperl-vc-rcs-header
'("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
406 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
407 :type
'(repeat string
)
410 ;; This became obsolete...
411 (defvar cperl-vc-header-alist nil
)
412 (make-obsolete-variable
413 'cperl-vc-header-alist
414 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead."
417 (defcustom cperl-clobber-mode-lists
420 (boundp 'interpreter-mode-alist
)
421 (assoc "miniperl" interpreter-mode-alist
)
422 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist
)))
423 "*Whether to install us into `interpreter-' and `extension' mode lists."
427 (defcustom cperl-info-on-command-no-prompt nil
428 "*Not-nil (and non-null) means not to prompt on C-h f.
429 The opposite behavior is always available if prefixed with C-c.
430 Can be overwritten by `cperl-hairy' if nil."
431 :type
'(choice (const null
) boolean
)
432 :group
'cperl-affected-by-hairy
)
434 (defcustom cperl-clobber-lisp-bindings nil
435 "*Not-nil (and non-null) means not overwrite C-h f.
436 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
437 Can be overwritten by `cperl-hairy' if nil."
438 :type
'(choice (const null
) boolean
)
439 :group
'cperl-affected-by-hairy
)
441 (defcustom cperl-lazy-help-time nil
442 "*Not-nil (and non-null) means to show lazy help after given idle time.
443 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
444 :type
'(choice (const null
) (const nil
) integer
)
445 :group
'cperl-affected-by-hairy
)
447 (defcustom cperl-pod-face
'font-lock-comment-face
448 "*Face for POD highlighting."
452 (defcustom cperl-pod-head-face
'font-lock-variable-name-face
453 "*Face for POD highlighting.
454 Font for POD headers."
458 (defcustom cperl-here-face
'font-lock-string-face
459 "*Face for here-docs highlighting."
463 ;;; Some double-evaluation happened with font-locks... Needed with 21.2...
464 (defvar cperl-singly-quote-face
(featurep 'xemacs
))
466 (defcustom cperl-invalid-face
'underline
467 "*Face for highlighting trailing whitespace."
472 (defcustom cperl-pod-here-fontify
'(featurep 'font-lock
)
473 "*Not-nil after evaluation means to highlight POD and here-docs sections."
477 (defcustom cperl-fontify-m-as-s t
478 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
482 (defcustom cperl-highlight-variables-indiscriminately nil
483 "*Non-nil means perform additional highlighting on variables.
484 Currently only changes how scalar variables are highlighted.
485 Note that that variable is only read at initialization time for
486 the variable `cperl-font-lock-keywords-2', so changing it after you've
487 entered CPerl mode the first time will have no effect."
491 (defcustom cperl-pod-here-scan t
492 "*Not-nil means look for POD and here-docs sections during startup.
493 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
497 (defcustom cperl-regexp-scan t
498 "*Not-nil means make marking of regular expression more thorough.
499 Effective only with `cperl-pod-here-scan'."
503 (defcustom cperl-hook-after-change t
504 "*Not-nil means install hook to know which regions of buffer are changed.
505 May significantly speed up delayed fontification. Changes take effect
510 (defcustom cperl-imenu-addback nil
511 "*Not-nil means add backreferences to generated `imenu's.
512 May require patched `imenu' and `imenu-go'. Obsolete."
514 :group
'cperl-help-system
)
516 (defcustom cperl-max-help-size
66
517 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
518 :type
'(choice integer
(const nil
))
519 :group
'cperl-help-system
)
521 (defcustom cperl-shrink-wrap-info-frame t
522 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
524 :group
'cperl-help-system
)
526 (defcustom cperl-info-page
"perl"
527 "*Name of the info page containing perl docs.
528 Older version of this page was called `perl5', newer `perl'."
530 :group
'cperl-help-system
)
532 (defcustom cperl-use-syntax-table-text-property
533 (boundp 'parse-sexp-lookup-properties
)
534 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
538 (defcustom cperl-use-syntax-table-text-property-for-tags
539 cperl-use-syntax-table-text-property
540 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
544 (defcustom cperl-scan-files-regexp
"\\.\\([pP][Llm]\\|xs\\)$"
545 "*Regexp to match files to scan when generating TAGS."
549 (defcustom cperl-noscan-files-regexp
550 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
551 "*Regexp to match files/dirs to skip when generating TAGS."
555 (defcustom cperl-regexp-indent-step nil
556 "*Indentation used when beautifying regexps.
557 If nil, the value of `cperl-indent-level' will be used."
558 :type
'(choice integer
(const nil
))
559 :group
'cperl-indentation-details
)
561 (defcustom cperl-indent-left-aligned-comments t
562 "*Non-nil means that the comment starting in leftmost column should indent."
564 :group
'cperl-indentation-details
)
566 (defcustom cperl-under-as-char nil
567 "*Non-nil means that the _ (underline) should be treated as word char."
571 (defcustom cperl-extra-perl-args
""
572 "*Extra arguments to use when starting Perl.
573 Currently used with `cperl-check-syntax' only."
577 (defcustom cperl-message-electric-keyword t
578 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
580 :group
'cperl-help-system
)
582 (defcustom cperl-indent-region-fix-constructs
1
583 "*Amount of space to insert between `}' and `else' or `elsif'
584 in `cperl-indent-region'. Set to nil to leave as is. Values other
585 than 1 and nil will probably not work."
586 :type
'(choice (const nil
) (const 1))
587 :group
'cperl-indentation-details
)
589 (defcustom cperl-break-one-line-blocks-when-indent t
590 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
591 need to be reformatted into multiline ones when indenting a region."
593 :group
'cperl-indentation-details
)
595 (defcustom cperl-fix-hanging-brace-when-indent t
596 "*Non-nil means that BLOCK-end `}' may be put on a separate line
597 when indenting a region.
598 Braces followed by else/elsif/while/until are excepted."
600 :group
'cperl-indentation-details
)
602 (defcustom cperl-merge-trailing-else t
603 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
604 may be merged to be on the same line when indenting a region."
606 :group
'cperl-indentation-details
)
608 (defcustom cperl-indent-parens-as-block nil
609 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
610 but for trailing \",\" inside the group, which won't increase indentation.
611 One should tune up `cperl-close-paren-offset' as well."
613 :group
'cperl-indentation-details
)
615 (defcustom cperl-syntaxify-by-font-lock
616 (and cperl-can-font-lock
617 (boundp 'parse-sexp-lookup-properties
))
618 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
619 :type
'(choice (const message
) boolean
)
622 (defcustom cperl-syntaxify-unwind
624 "*Non-nil means that CPerl unwinds to a start of a long construction
625 when syntaxifying a chunk of buffer."
629 (defcustom cperl-syntaxify-for-menu
631 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
632 This way enabling/disabling of menu items is more correct."
636 (defcustom cperl-ps-print-face-properties
637 '((font-lock-keyword-face nil nil bold shadow
)
638 (font-lock-variable-name-face nil nil bold
)
639 (font-lock-function-name-face nil nil bold italic box
)
640 (font-lock-constant-face nil
"LightGray" bold
)
641 (cperl-array-face nil
"LightGray" bold underline
)
642 (cperl-hash-face nil
"LightGray" bold italic underline
)
643 (font-lock-comment-face nil
"LightGray" italic
)
644 (font-lock-string-face nil nil italic underline
)
645 (cperl-nonoverridable-face nil nil italic underline
)
646 (font-lock-type-face nil nil underline
)
647 (font-lock-warning-face nil
"LightGray" bold italic box
)
648 (underline nil
"LightGray" strikeout
))
649 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
650 :type
'(repeat (cons symbol
651 (cons (choice (const nil
) string
)
652 (cons (choice (const nil
) string
)
656 (defvar cperl-dark-background
657 (cperl-choose-color "navy" "os2blue" "darkgreen"))
658 (defvar cperl-dark-foreground
659 (cperl-choose-color "orchid1" "orange"))
661 (defface cperl-nonoverridable-face
662 `((((class grayscale
) (background light
))
663 (:background
"Gray90" :slant italic
:underline t
))
664 (((class grayscale
) (background dark
))
665 (:foreground
"Gray80" :slant italic
:underline t
:weight bold
))
666 (((class color
) (background light
))
667 (:foreground
"chartreuse3"))
668 (((class color
) (background dark
))
669 (:foreground
,cperl-dark-foreground
))
670 (t (:weight bold
:underline t
)))
671 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
674 (defface cperl-array-face
675 `((((class grayscale
) (background light
))
676 (:background
"Gray90" :weight bold
))
677 (((class grayscale
) (background dark
))
678 (:foreground
"Gray80" :weight bold
))
679 (((class color
) (background light
))
680 (:foreground
"Blue" :background
"lightyellow2" :weight bold
))
681 (((class color
) (background dark
))
682 (:foreground
"yellow" :background
,cperl-dark-background
:weight bold
))
684 "Font Lock mode face used to highlight array names."
687 (defface cperl-hash-face
688 `((((class grayscale
) (background light
))
689 (:background
"Gray90" :weight bold
:slant italic
))
690 (((class grayscale
) (background dark
))
691 (:foreground
"Gray80" :weight bold
:slant italic
))
692 (((class color
) (background light
))
693 (:foreground
"Red" :background
"lightyellow2" :weight bold
:slant italic
))
694 (((class color
) (background dark
))
695 (:foreground
"Red" :background
,cperl-dark-background
:weight bold
:slant italic
))
696 (t (:weight bold
:slant italic
)))
697 "Font Lock mode face used to highlight hash names."
702 ;;; Short extra-docs.
704 (defvar cperl-tips
'please-ignore-this-line
705 "Get maybe newer version of this package from
706 http://ilyaz.org/software/emacs
707 Subdirectory `cperl-mode' may contain yet newer development releases and/or
708 patches to related files.
710 For best results apply to an older Emacs the patches from
711 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
712 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
713 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
714 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
716 Get support packages choose-color.el (or font-lock-extra.el before
717 19.30), imenu-go.el from the same place. \(Look for other files there
718 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
719 later you should use choose-color.el *instead* of font-lock-extra.el
720 \(and you will not get smart highlighting in C :-().
722 Note that to enable Compile choices in the menu you need to install
725 If your Emacs does not default to `cperl-mode' on Perl files, and you
726 want it to: put the following into your .emacs file:
728 (defalias 'perl-mode 'cperl-mode)
731 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
732 Also, one can generate a newer documentation running `pod2texi' converter
733 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
735 If you use imenu-go, run imenu on perl5-info buffer (you can do it
736 from Perl menu). If many files are related, generate TAGS files from
737 Tools/Tags submenu in Perl menu.
739 If some class structure is too complicated, use Tools/Hierarchy-view
740 from Perl menu, or hierarchic view of imenu. The second one uses the
741 current buffer only, the first one requires generation of TAGS from
742 Perl/Tools/Tags menu beforehand.
744 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
746 Switch auto-help on/off with Perl/Tools/Auto-help.
748 Though with contemporary Emaxen CPerl mode should maintain the correct
749 parsing of Perl even when editing, sometimes it may be lost. Fix this by
753 In cases of more severe confusion sometimes it is helpful to do
755 \\[load-library] cperl-mode RET
758 Before reporting (non-)problems look in the problem section of online
759 micro-docs on what I know about CPerl problems.")
761 (defvar cperl-problems
'please-ignore-this-line
762 "Description of problems in CPerl mode.
763 Some faces will not be shown on some versions of Emacs unless you
764 install choose-color.el, available from
765 http://ilyaz.org/software/emacs
767 `fill-paragraph' on a comment may leave the point behind the
768 paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
769 to detect it and bulk out).
771 See documentation of a variable `cperl-problems-old-emaxen' for the
772 problems which disappear if you upgrade Emacs to a reasonably new
773 version (20.3 for Emacs, and those of 2004 for XEmacs).")
775 (defvar cperl-problems-old-emaxen
'please-ignore-this-line
776 "Description of problems in CPerl mode specific for older Emacs versions.
778 Emacs had a _very_ restricted syntax parsing engine until version
779 20.1. Most problems below are corrected starting from this version of
780 Emacs, and all of them should be fixed in version 20.3. (Or apply
781 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
782 this respect (until 2003).
784 Note that even with newer Emacsen in some very rare cases the details
785 of interaction of `font-lock' and syntaxification may be not cleaned
786 up yet. You may get slightly different colors basing on the order of
787 fontification and syntaxification. Say, the initial faces is correct,
788 but editing the buffer breaks this.
790 Even with older Emacsen CPerl mode tries to corrects some Emacs
791 misunderstandings, however, for efficiency reasons the degree of
792 correction is different for different operations. The partially
793 corrected problems are: POD sections, here-documents, regexps. The
794 operations are: highlighting, indentation, electric keywords, electric
797 This may be confusing, since the regexp s#//#/#\; may be highlighted
798 as a comment, but it will be recognized as a regexp by the indentation
799 code. Or the opposite case, when a POD section is highlighted, but
800 may break the indentation of the following code (though indentation
801 should work if the balance of delimiters is not broken by POD).
803 The main trick (to make $ a \"backslash\") makes constructions like
804 ${aaa} look like unbalanced braces. The only trick I can think of is
805 to insert it as $ {aaa} (valid in perl5, not in perl4).
807 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
808 as /($|\\s)/. Note that such a transposition is not always possible.
810 The solution is to upgrade your Emacs or patch an older one. Note
811 that Emacs 20.2 has some bugs related to `syntax-table' text
812 properties. Patches are available on the main CPerl download site,
815 If these bugs cannot be fixed on your machine (say, you have an inferior
816 environment and cannot recompile), you may still disable all the fancy stuff
817 via `cperl-use-syntax-table-text-property'.")
819 (defvar cperl-praise
'please-ignore-this-line
820 "Advantages of CPerl mode.
822 0) It uses the newest `syntax-table' property ;-);
824 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
825 mode - but the latter number may have improved too in last years) even
826 with old Emaxen which do not support `syntax-table' property.
828 When using `syntax-table' property for syntax assist hints, it should
829 handle 99.995% of lines correct - or somesuch. It automatically
830 updates syntax assist hints when you edit your script.
832 2) It is generally believed to be \"the most user-friendly Emacs
833 package\" whatever it may mean (I doubt that the people who say similar
834 things tried _all_ the rest of Emacs ;-), but this was not a lonely
837 3) Everything is customizable, one-by-one or in a big sweep;
839 4) It has many easily-accessible \"tools\":
840 a) Can run program, check syntax, start debugger;
841 b) Can lineup vertically \"middles\" of rows, like `=' in
844 c) Can insert spaces where this impoves readability (in one
845 interactive sweep over the buffer);
846 d) Has support for imenu, including:
847 1) Separate unordered list of \"interesting places\";
848 2) Separate TOC of POD sections;
849 3) Separate list of packages;
850 4) Hierarchical view of methods in (sub)packages;
851 5) and functions (by the full name - with package);
852 e) Has an interface to INFO docs for Perl; The interface is
853 very flexible, including shrink-wrapping of
854 documentation buffer/frame;
855 f) Has a builtin list of one-line explanations for perl constructs.
856 g) Can show these explanations if you stay long enough at the
857 corresponding place (or on demand);
858 h) Has an enhanced fontification (using 3 or 4 additional faces
859 comparing to font-lock - basically, different
860 namespaces in Perl have different colors);
861 i) Can construct TAGS basing on its knowledge of Perl syntax,
862 the standard menu has 6 different way to generate
863 TAGS (if \"by directory\", .xs files - with C-language
864 bindings - are included in the scan);
865 j) Can build a hierarchical view of classes (via imenu) basing
866 on generated TAGS file;
867 k) Has electric parentheses, electric newlines, uses Abbrev
868 for electric logical constructs
870 with different styles of expansion (context sensitive
871 to be not so bothering). Electric parentheses behave
872 \"as they should\" in a presence of a visible region.
873 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
879 n) Highlights (by user-choice) either 3-delimiters constructs
880 (such as tr/a/b/), or regular expressions and `y/tr';
881 o) Highlights trailing whitespace;
882 p) Is able to manipulate Perl Regular Expressions to ease
883 conversion to a more readable form.
884 q) Can ispell POD sections and HERE-DOCs.
885 r) Understands comments and character classes inside regular
886 expressions; can find matching () and [] in a regular expression.
887 s) Allows indentation of //x-style regular expressions;
888 t) Highlights different symbols in regular expressions according
889 to their function; much less problems with backslashitis;
890 u) Allows to find regular expressions which contain interpolated parts.
892 5) The indentation engine was very smart, but most of tricks may be
893 not needed anymore with the support for `syntax-table' property. Has
894 progress indicator for indentation (with `imenu' loaded).
896 6) Indent-region improves inline-comments as well; also corrects
897 whitespace *inside* the conditional/loop constructs.
899 7) Fill-paragraph correctly handles multi-line comments;
901 8) Can switch to different indentation styles by one command, and restore
902 the settings present before the switch.
904 9) When doing indentation of control constructs, may correct
905 line-breaks/spacing between elements of the construct.
907 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
908 capable syntax engines).
910 11) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
913 (defvar cperl-speed
'please-ignore-this-line
914 "This is an incomplete compendium of what is available in other parts
915 of CPerl documentation. (Please inform me if I skept anything.)
917 There is a perception that CPerl is slower than alternatives. This part
918 of documentation is designed to overcome this misconception.
920 *By default* CPerl tries to enable the most comfortable settings.
921 From most points of view, correctly working package is infinitely more
922 comfortable than a non-correctly working one, thus by default CPerl
923 prefers correctness over speed. Below is the guide how to change
924 settings if your preferences are different.
926 A) Speed of loading the file. When loading file, CPerl may perform a
927 scan which indicates places which cannot be parsed by primitive Emacs
928 syntax-parsing routines, and marks them up so that either
930 A1) CPerl may work around these deficiencies (for big chunks, mostly
931 PODs and HERE-documents), or
932 A2) On capable Emaxen CPerl will use improved syntax-handlings
933 which reads mark-up hints directly.
935 The scan in case A2 is much more comprehensive, thus may be slower.
937 User can disable syntax-engine-helping scan of A2 by setting
938 `cperl-use-syntax-table-text-property'
939 variable to nil (if it is set to t).
941 One can disable the scan altogether (both A1 and A2) by setting
942 `cperl-pod-here-scan'
945 B) Speed of editing operations.
947 One can add a (minor) speedup to editing operations by setting
948 `cperl-use-syntax-table-text-property'
949 variable to nil (if it is set to t). This will disable
950 syntax-engine-helping scan, thus will make many more Perl
951 constructs be wrongly recognized by CPerl, thus may lead to
952 wrongly matched parentheses, wrong indentation, etc.
954 One can unset `cperl-syntaxify-unwind'. This might speed up editing
955 of, say, long POD sections.")
957 (defvar cperl-tips-faces
'please-ignore-this-line
958 "CPerl mode uses following faces for highlighting:
960 `cperl-array-face' Array names
961 `cperl-hash-face' Hash names
962 `font-lock-comment-face' Comments, PODs and whatever is considered
963 syntaxically to be not code
964 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
965 2-arg operators s/y/tr/ or of RExen,
966 `font-lock-warning-face' Special-cased m// and s//foo/,
967 `font-lock-function-name-face' _ as a target of a file tests, file tests,
968 subroutine names at the moment of definition
969 (except those conflicting with Perl operators),
970 package names (when recognized), format names
971 `font-lock-keyword-face' Control flow switch constructs, declarators
972 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
973 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
974 literal parts and the terminator of formats
975 and whatever is syntaxically considered
977 `font-lock-type-face' Overridable keywords
978 `font-lock-variable-name-face' Variable declarations, indirect array and
979 hash names, POD headers/item names
980 `cperl-invalid-face' Trailing whitespace
982 Note that in several situations the highlighting tries to inform about
983 possible confusion, such as different colors for function names in
984 declarations depending on what they (do not) override, or special cases
985 m// and s/// which do not do what one would expect them to do.
987 Help with best setup of these faces for printout requested (for each of
988 the faces: please specify bold, italic, underline, shadow and box.)
990 In regular expressions (including character classes):
991 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
992 `font-lock-constant-face': Delimiters
993 `font-lock-warning-face' Special-cased m// and s//foo/,
994 Mismatched closing delimiters, parens
995 we couldn't match, misplaced quantifiers,
996 unrecognized escape sequences
997 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
998 `font-lock-type-face' escape sequences with arguments (\\x \\23 \\p \\N)
999 and others match-a-char escape sequences
1000 `font-lock-keyword-face' Capturing parens, and |
1001 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
1002 \"Range -\" in character classes
1003 `font-lock-builtin-face' \"Remaining\" 0-length constructs, multipliers
1004 ?+*{}, not-capturing parens, leading
1005 backslashes of escape sequences
1006 `font-lock-variable-name-face' Interpolated constructs, embedded code,
1007 POSIX classes (inside charclasses)
1008 `font-lock-comment-face' Embedded comments
1014 ;;; Portability stuff:
1016 (defmacro cperl-define-key
(emacs-key definition
&optional xemacs-key
)
1017 `(define-key cperl-mode-map
1019 `(if (featurep 'xemacs
) ,xemacs-key
,emacs-key
)
1023 (defvar cperl-del-back-ch
1024 (car (append (where-is-internal 'delete-backward-char
)
1025 (where-is-internal 'backward-delete-char-untabify
)))
1026 "Character generated by key bound to `delete-backward-char'.")
1028 (and (vectorp cperl-del-back-ch
) (= (length cperl-del-back-ch
) 1)
1029 (setq cperl-del-back-ch
(aref cperl-del-back-ch
0)))
1031 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
1032 (if (featurep 'xemacs
)
1034 ;; "Active regions" are on: use region only if active
1035 ;; "Active regions" are off: use region unconditionally
1036 (defun cperl-use-region-p ()
1037 (if zmacs-regions
(mark) t
)))
1038 (defun cperl-use-region-p ()
1039 (if transient-mark-mode mark-active t
))
1040 (defun cperl-mark-active () mark-active
))
1042 (defsubst cperl-enable-font-lock
()
1043 cperl-can-font-lock
)
1045 (defun cperl-putback-char (c) ; Emacs 19
1046 (set 'unread-command-events
(list c
))) ; Avoid undefined warning
1048 (if (featurep 'xemacs
)
1049 (defun cperl-putback-char (c) ; XEmacs >= 19.12
1050 (setq unread-command-events
(list (eval '(character-to-event c
))))))
1052 (or (fboundp 'uncomment-region
)
1053 (defun uncomment-region (beg end
)
1055 (comment-region beg end -
1)))
1057 (defvar cperl-do-not-fontify
1058 (if (string< emacs-version
"19.30")
1061 "Text property which inhibits refontification.")
1063 (defsubst cperl-put-do-not-fontify
(from to
&optional post
)
1064 ;; If POST, do not do it with postponed fontification
1065 (if (and post cperl-syntaxify-by-font-lock
)
1067 (put-text-property (max (point-min) (1- from
))
1068 to cperl-do-not-fontify t
)))
1070 (defcustom cperl-mode-hook nil
1071 "Hook run by CPerl mode."
1075 (defvar cperl-syntax-state nil
)
1076 (defvar cperl-syntax-done-to nil
)
1077 (defvar cperl-emacs-can-parse
(> (length (save-excursion
1078 (parse-partial-sexp (point) (point)))) 9))
1080 ;; Make customization possible "in reverse"
1081 (defsubst cperl-val
(symbol &optional default hairy
)
1083 ((eq (symbol-value symbol
) 'null
) default
)
1084 (cperl-hairy (or hairy t
))
1085 (t (symbol-value symbol
))))
1088 (defun cperl-make-indent (column &optional minimum keep
)
1089 "Makes indent of the current line the requested amount.
1090 Unless KEEP, removes the old indentation. Works around a bug in ancient
1092 (let ((prop (get-text-property (point) 'syntax-type
)))
1094 (delete-horizontal-space))
1095 (indent-to column minimum
)
1096 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
1098 (> (current-column) 0)
1101 (or (get-text-property (point) 'syntax-type
)
1102 (and (looking-at "\\=[ \t]")
1103 (put-text-property (point) (match-end 0)
1104 'syntax-type prop
)))))))
1106 ;;; Probably it is too late to set these guys already, but it can help later:
1108 ;;;(and cperl-clobber-mode-lists
1109 ;;;(setq auto-mode-alist
1110 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
1111 ;;;(and (boundp 'interpreter-mode-alist)
1112 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
1113 ;;; '(("miniperl" . perl-mode))))))
1119 '(imenu easymenu etags timer man info
))
1120 (if (fboundp 'ps-extend-face-list
)
1121 (defmacro cperl-ps-extend-face-list
(arg)
1122 `(ps-extend-face-list ,arg
))
1123 (defmacro cperl-ps-extend-face-list
(arg)
1124 `(error "This version of Emacs has no `ps-extend-face-list'")))
1125 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1126 ;; macros instead of defsubsts don't work on Emacs, so we do the
1127 ;; expansion manually. Any other suggestions?
1130 (defvar cperl-mode-abbrev-table nil
1131 "Abbrev table in use in CPerl mode buffers.")
1133 (add-hook 'edit-var-mode-alist
'(perl-mode (regexp .
"^cperl-")))
1135 (defvar cperl-mode-map
() "Keymap used in CPerl mode.")
1137 (if cperl-mode-map nil
1138 (setq cperl-mode-map
(make-sparse-keymap))
1139 (cperl-define-key "{" 'cperl-electric-lbrace
)
1140 (cperl-define-key "[" 'cperl-electric-paren
)
1141 (cperl-define-key "(" 'cperl-electric-paren
)
1142 (cperl-define-key "<" 'cperl-electric-paren
)
1143 (cperl-define-key "}" 'cperl-electric-brace
)
1144 (cperl-define-key "]" 'cperl-electric-rparen
)
1145 (cperl-define-key ")" 'cperl-electric-rparen
)
1146 (cperl-define-key ";" 'cperl-electric-semi
)
1147 (cperl-define-key ":" 'cperl-electric-terminator
)
1148 (cperl-define-key "\C-j" 'newline-and-indent
)
1149 (cperl-define-key "\C-c\C-j" 'cperl-linefeed
)
1150 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless
)
1151 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline
)
1152 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev
)
1153 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix
)
1154 (cperl-define-key "\C-c\C-f" 'auto-fill-mode
)
1155 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric
)
1156 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style
)
1157 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell
)
1158 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell
)
1159 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc
)
1160 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx
)
1161 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0
)
1162 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1
)
1163 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp
)
1164 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc
)
1165 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point
)
1166 (cperl-define-key "\e\C-q" 'cperl-indent-exp
) ; Usually not bound
1167 (cperl-define-key [?\C-\M-\|
] 'cperl-lineup
1169 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1170 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1171 (cperl-define-key "\177" 'cperl-electric-backspace
)
1172 (cperl-define-key "\t" 'cperl-indent-command
)
1173 ;; don't clobber the backspace binding:
1174 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1175 [(control c
) (control h
) F
])
1176 (if (cperl-val 'cperl-clobber-lisp-bindings
)
1178 (cperl-define-key "\C-hf"
1179 ;;(concat (char-to-string help-char) "f") ; does not work
1180 'cperl-info-on-command
1182 (cperl-define-key "\C-hv"
1183 ;;(concat (char-to-string help-char) "v") ; does not work
1186 (cperl-define-key "\C-c\C-hf"
1187 ;;(concat (char-to-string help-char) "f") ; does not work
1188 (key-binding "\C-hf")
1189 [(control c
) (control h
) f
])
1190 (cperl-define-key "\C-c\C-hv"
1191 ;;(concat (char-to-string help-char) "v") ; does not work
1192 (key-binding "\C-hv")
1193 [(control c
) (control h
) v
]))
1194 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1195 [(control c
) (control h
) f
])
1196 (cperl-define-key "\C-c\C-hv"
1197 ;;(concat (char-to-string help-char) "v") ; does not work
1199 [(control c
) (control h
) v
]))
1200 (if (and (featurep 'xemacs
)
1201 (<= emacs-minor-version
11) (<= emacs-major-version
19))
1203 ;; substitute-key-definition is usefulness-deenhanced...
1204 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1205 (cperl-define-key "\e;" 'cperl-indent-for-comment
)
1206 (cperl-define-key "\e\C-\\" 'cperl-indent-region
))
1207 (or (boundp 'fill-paragraph-function
)
1208 (substitute-key-definition
1209 'fill-paragraph
'cperl-fill-paragraph
1210 cperl-mode-map global-map
))
1211 (substitute-key-definition
1212 'indent-sexp
'cperl-indent-exp
1213 cperl-mode-map global-map
)
1214 (substitute-key-definition
1215 'indent-region
'cperl-indent-region
1216 cperl-mode-map global-map
)
1217 (substitute-key-definition
1218 'indent-for-comment
'cperl-indent-for-comment
1219 cperl-mode-map global-map
)))
1222 (defvar cperl-lazy-installed
)
1223 (defvar cperl-old-style nil
)
1228 cperl-menu cperl-mode-map
"Menu for CPerl mode"
1230 ["Beginning of function" beginning-of-defun
t]
1231 ["End of function" end-of-defun
t]
1232 ["Mark function" mark-defun
t]
1233 ["Indent expression" cperl-indent-exp t
]
1234 ["Fill paragraph/comment" fill-paragraph t
]
1236 ["Line up a construction" cperl-lineup
(cperl-use-region-p)]
1237 ["Invert if/unless/while etc" cperl-invert-if-unless t
]
1239 ["Beautify" cperl-beautify-regexp
1240 cperl-use-syntax-table-text-property
]
1241 ["Beautify one level deep" (cperl-beautify-regexp 1)
1242 cperl-use-syntax-table-text-property
]
1243 ["Beautify a group" cperl-beautify-level
1244 cperl-use-syntax-table-text-property
]
1245 ["Beautify a group one level deep" (cperl-beautify-level 1)
1246 cperl-use-syntax-table-text-property
]
1247 ["Contract a group" cperl-contract-level
1248 cperl-use-syntax-table-text-property
]
1249 ["Contract groups" cperl-contract-levels
1250 cperl-use-syntax-table-text-property
]
1252 ["Find next interpolated" cperl-next-interpolated-REx
1253 (next-single-property-change (point-min) 'REx-interpolated
)]
1254 ["Find next interpolated (no //o)"
1255 cperl-next-interpolated-REx-0
1256 (or (text-property-any (point-min) (point-max) 'REx-interpolated t
)
1257 (text-property-any (point-min) (point-max) 'REx-interpolated
1))]
1258 ["Find next interpolated (neither //o nor whole-REx)"
1259 cperl-next-interpolated-REx-1
1260 (text-property-any (point-min) (point-max) 'REx-interpolated t
)])
1261 ["Insert spaces if needed to fix style" cperl-find-bad-style t
]
1262 ["Refresh \"hard\" constructions" cperl-find-pods-heres t
]
1264 ["Indent region" cperl-indent-region
(cperl-use-region-p)]
1265 ["Comment region" cperl-comment-region
(cperl-use-region-p)]
1266 ["Uncomment region" cperl-uncomment-region
(cperl-use-region-p)]
1268 ["Run" mode-compile
(fboundp 'mode-compile
)]
1269 ["Kill" mode-compile-kill
(and (fboundp 'mode-compile-kill
)
1270 (get-buffer "*compilation*"))]
1271 ["Next error" next-error
(get-buffer "*compilation*")]
1272 ["Check syntax" cperl-check-syntax
(fboundp 'mode-compile
)]
1274 ["Debugger" cperl-db t
]
1277 ["Imenu" imenu
(fboundp 'imenu
)]
1278 ["Imenu on Perl Info" cperl-imenu-on-info
(featurep 'imenu
)]
1280 ["Ispell PODs" cperl-pod-spell
1281 ;; Better not to update syntaxification here:
1282 ;; debugging syntaxificatio can be broken by this???
1284 (get-text-property (point-min) 'in-pod
)
1286 (and cperl-syntaxify-for-menu
1287 (cperl-update-syntaxification (point-max) (point-max)))
1288 (next-single-property-change (point-min) 'in-pod nil
(point-max)))
1290 ["Ispell HERE-DOCs" cperl-here-doc-spell
1292 (and cperl-syntaxify-for-menu
1293 (cperl-update-syntaxification (point-max) (point-max)))
1294 (next-single-property-change (point-min) 'here-doc-group nil
(point-max)))
1296 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
1297 (eq 'here-doc
(progn
1298 (and cperl-syntaxify-for-menu
1299 (cperl-update-syntaxification (point) (point)))
1300 (get-text-property (point) 'syntax-type
)))]
1301 ["Select this HERE-DOC or POD section"
1302 cperl-select-this-pod-or-here-doc
1304 (and cperl-syntaxify-for-menu
1305 (cperl-update-syntaxification (point) (point)))
1306 (get-text-property (point) 'syntax-type
))
1309 ["CPerl pretty print (exprmntl)" cperl-ps-print
1310 (fboundp 'ps-extend-face-list
)]
1312 ["Syntaxify region" cperl-find-pods-heres-region
1313 (cperl-use-region-p)]
1314 ["Profile syntaxification" cperl-time-fontification t
]
1315 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t
]
1316 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t
]
1317 ["Debug backtrace on syntactic scan (BEWARE!!!)"
1318 (cperl-toggle-set-debug-unwind nil t
) t
]
1320 ["Class Hierarchy from TAGS" cperl-tags-hier-init t
]
1321 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1323 ;;; ["Create tags for current file" cperl-etags t]
1324 ;;; ["Add tags for current file" (cperl-etags t) t]
1325 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1326 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1327 ;;; ["Create tags for Perl files in (sub)directories"
1328 ;;; (cperl-etags nil 'recursive) t]
1329 ;;; ["Add tags for Perl files in (sub)directories"
1330 ;;; (cperl-etags t 'recursive) t])
1331 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1332 ["Create tags for current file" (cperl-write-tags nil t
) t
]
1333 ["Add tags for current file" (cperl-write-tags) t
]
1334 ["Create tags for Perl files in directory"
1335 (cperl-write-tags nil t nil t
) t
]
1336 ["Add tags for Perl files in directory"
1337 (cperl-write-tags nil nil nil t
) t
]
1338 ["Create tags for Perl files in (sub)directories"
1339 (cperl-write-tags nil t t t
) t
]
1340 ["Add tags for Perl files in (sub)directories"
1341 (cperl-write-tags nil nil t t
) t
]))
1343 ["Define word at point" imenu-go-find-at-position
1344 (fboundp 'imenu-go-find-at-position
)]
1345 ["Help on function" cperl-info-on-command t
]
1346 ["Help on function at point" cperl-info-on-current-command t
]
1347 ["Help on symbol at point" cperl-get-help t
]
1348 ["Perldoc" cperl-perldoc t
]
1349 ["Perldoc on word at point" cperl-perldoc-at-point t
]
1350 ["View manpage of POD in this file" cperl-build-manpage t
]
1351 ["Auto-help on" cperl-lazy-install
1352 (and (fboundp 'run-with-idle-timer
)
1353 (not cperl-lazy-installed
))]
1354 ["Auto-help off" cperl-lazy-unstall
1355 (and (fboundp 'run-with-idle-timer
)
1356 cperl-lazy-installed
)])
1358 ["Auto newline" cperl-toggle-auto-newline t
]
1359 ["Electric parens" cperl-toggle-electric t
]
1360 ["Electric keywords" cperl-toggle-abbrev t
]
1361 ["Fix whitespace on indent" cperl-toggle-construct-fix t
]
1362 ["Auto-help on Perl constructs" cperl-toggle-autohelp t
]
1363 ["Auto fill" auto-fill-mode t
])
1365 ["CPerl" (cperl-set-style "CPerl") t
]
1366 ["PerlStyle" (cperl-set-style "PerlStyle") t
]
1367 ["GNU" (cperl-set-style "GNU") t
]
1368 ["C++" (cperl-set-style "C++") t
]
1369 ["K&R" (cperl-set-style "K&R") t
]
1370 ["BSD" (cperl-set-style "BSD") t
]
1371 ["Whitesmith" (cperl-set-style "Whitesmith") t
]
1372 ["Memorize Current" (cperl-set-style "Current") t
]
1373 ["Memorized" (cperl-set-style-back) cperl-old-style
])
1375 ["Tips" (describe-variable 'cperl-tips
) t
]
1376 ["Problems" (describe-variable 'cperl-problems
) t
]
1377 ["Speed" (describe-variable 'cperl-speed
) t
]
1378 ["Praise" (describe-variable 'cperl-praise
) t
]
1379 ["Faces" (describe-variable 'cperl-tips-faces
) t
]
1380 ["CPerl mode" (describe-function 'cperl-mode
) t
]
1382 (message "The version of master-file for this CPerl is %s-Emacs"
1383 cperl-version
) t
]))))
1386 (autoload 'c-macro-expand
"cmacexp"
1387 "Display the result of expanding all C macros occurring in the region.
1388 The expansion is entirely correct because it uses the C preprocessor."
1391 ;;; These two must be unwound, otherwise take exponential time
1392 (defconst cperl-maybe-white-and-comment-rex
"[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
1393 "Regular expression to match optional whitespace with interpspersed comments.
1394 Should contain exactly one group.")
1396 ;;; This one is tricky to unwind; still very inefficient...
1397 (defconst cperl-white-and-comment-rex
"\\([ \t\n]\\|#[^\n]*\n\\)+"
1398 "Regular expression to match whitespace with interpspersed comments.
1399 Should contain exactly one group.")
1402 ;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
1403 ;;; `cperl-outline-regexp', `defun-prompt-regexp'.
1404 ;;; Details of groups in this may be used in several functions; see comments
1405 ;;; near mentioned above variable(s)...
1406 ;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
1407 (defsubst cperl-after-sub-regexp
(named attr
) ; 9 groups without attr...
1408 "Match the text after `sub' in a subroutine declaration.
1409 If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
1410 of attributes (if present), or end of the name or prototype (whatever is
1412 (concat ; Assume n groups before this...
1413 "\\(" ; n+1=name-group
1414 cperl-white-and-comment-rex
; n+2=pre-name
1415 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
1416 "\\)" ; END n+1=name-group
1418 "\\(" ; n+4=proto-group
1419 cperl-maybe-white-and-comment-rex
; n+5=pre-proto
1420 "\\(([^()]*)\\)" ; n+6=prototype
1421 "\\)?" ; END n+4=proto-group
1422 "\\(" ; n+7=attr-group
1423 cperl-maybe-white-and-comment-rex
; n+8=pre-attr
1424 "\\(" ; n+9=start-attr
1428 cperl-maybe-white-and-comment-rex
; whitespace-comments
1429 "\\(\\sw\\|_\\)+" ; attr-name
1430 ;; attr-arg (1 level of internal parens allowed!)
1431 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
1432 "\\(" ; optional : (XXX allows trailing???)
1433 cperl-maybe-white-and-comment-rex
; whitespace-comments
1438 "\\)?" ; END n+6=proto-group
1441 ;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
1442 ;;; and `cperl-outline-level'.
1443 ;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
1444 (defvar cperl-imenu--function-name-regexp-perl
1447 "\\([ \t]*package" ; 2 = package-group
1448 "\\(" ; 3 = package-name-group
1449 cperl-white-and-comment-rex
; 4 = pre-package-name
1450 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
1453 (cperl-after-sub-regexp 'named nil
) ; 8=name 11=proto 14=attr-start
1454 cperl-maybe-white-and-comment-rex
; 15=pre-block
1456 "=head\\([1-4]\\)[ \t]+" ; 16=level
1457 "\\([^\n]+\\)$" ; 17=text
1460 (defvar cperl-outline-regexp
1461 (concat cperl-imenu--function-name-regexp-perl
"\\|" "\\`"))
1463 (defvar cperl-mode-syntax-table nil
1464 "Syntax table in use in CPerl mode buffers.")
1466 (defvar cperl-string-syntax-table nil
1467 "Syntax table in use in CPerl mode string-like chunks.")
1469 (defsubst cperl-1-
(p)
1470 (max (point-min) (1- p
)))
1472 (defsubst cperl-1
+ (p)
1473 (min (point-max) (1+ p
)))
1475 (if cperl-mode-syntax-table
1477 (setq cperl-mode-syntax-table
(make-syntax-table))
1478 (modify-syntax-entry ?
\\ "\\" cperl-mode-syntax-table
)
1479 (modify-syntax-entry ?
/ "." cperl-mode-syntax-table
)
1480 (modify-syntax-entry ?
* "." cperl-mode-syntax-table
)
1481 (modify-syntax-entry ?
+ "." cperl-mode-syntax-table
)
1482 (modify-syntax-entry ?-
"." cperl-mode-syntax-table
)
1483 (modify-syntax-entry ?
= "." cperl-mode-syntax-table
)
1484 (modify-syntax-entry ?%
"." cperl-mode-syntax-table
)
1485 (modify-syntax-entry ?
< "." cperl-mode-syntax-table
)
1486 (modify-syntax-entry ?
> "." cperl-mode-syntax-table
)
1487 (modify-syntax-entry ?
& "." cperl-mode-syntax-table
)
1488 (modify-syntax-entry ?$
"\\" cperl-mode-syntax-table
)
1489 (modify-syntax-entry ?
\n ">" cperl-mode-syntax-table
)
1490 (modify-syntax-entry ?
# "<" cperl-mode-syntax-table
)
1491 (modify-syntax-entry ?
' "\"" cperl-mode-syntax-table
)
1492 (modify-syntax-entry ?
` "\"" cperl-mode-syntax-table
)
1493 (if cperl-under-as-char
1494 (modify-syntax-entry ?_
"w" cperl-mode-syntax-table
))
1495 (modify-syntax-entry ?
: "_" cperl-mode-syntax-table
)
1496 (modify-syntax-entry ?|
"." cperl-mode-syntax-table
)
1497 (setq cperl-string-syntax-table
(copy-syntax-table cperl-mode-syntax-table
))
1498 (modify-syntax-entry ?$
"." cperl-string-syntax-table
)
1499 (modify-syntax-entry ?\
{ "." cperl-string-syntax-table
)
1500 (modify-syntax-entry ?\
} "." cperl-string-syntax-table
)
1501 (modify-syntax-entry ?
\" "." cperl-string-syntax-table
)
1502 (modify-syntax-entry ?
' "." cperl-string-syntax-table
)
1503 (modify-syntax-entry ?
` "." cperl-string-syntax-table
)
1504 (modify-syntax-entry ?
# "." cperl-string-syntax-table
)) ; (?# comment )
1508 (defvar cperl-faces-init nil
)
1510 (defvar cperl-msb-fixed nil
)
1511 (defvar cperl-use-major-mode
'cperl-mode
)
1512 (defvar cperl-font-lock-multiline-start nil
)
1513 (defvar cperl-font-lock-multiline nil
)
1514 (defvar cperl-font-locking nil
)
1516 ;; NB as it stands the code in cperl-mode assumes this only has one
1517 ;; element. If Xemacs 19 support were dropped, this could all be simplified.
1518 (defvar cperl-compilation-error-regexp-alist
1519 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
1520 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
1522 "Alist that specifies how to match errors in perl output.")
1524 (defvar compilation-error-regexp-alist
)
1527 (defun cperl-mode ()
1528 "Major mode for editing Perl code.
1529 Expression and list commands understand all C brackets.
1530 Tab indents for Perl code.
1531 Paragraphs are separated by blank lines only.
1532 Delete converts tabs to spaces as it moves back.
1534 Various characters in Perl almost always come in pairs: {}, (), [],
1535 sometimes <>. When the user types the first, she gets the second as
1536 well, with optional special formatting done on {}. (Disabled by
1537 default.) You can always quote (with \\[quoted-insert]) the left
1538 \"paren\" to avoid the expansion. The processing of < is special,
1539 since most the time you mean \"less\". CPerl mode tries to guess
1540 whether you want to type pair <>, and inserts is if it
1541 appropriate. You can set `cperl-electric-parens-string' to the string that
1542 contains the parenths from the above list you want to be electrical.
1543 Electricity of parenths is controlled by `cperl-electric-parens'.
1544 You may also set `cperl-electric-parens-mark' to have electric parens
1545 look for active mark and \"embrace\" a region if possible.'
1547 CPerl mode provides expansion of the Perl control constructs:
1549 if, else, elsif, unless, while, until, continue, do,
1550 for, foreach, formy and foreachmy.
1552 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1554 The user types the keyword immediately followed by a space, which
1555 causes the construct to be expanded, and the point is positioned where
1556 she is most likely to want to be. eg. when the user types a space
1557 following \"if\" the following appears in the buffer: if () { or if ()
1558 } { } and the cursor is between the parentheses. The user can then
1559 type some boolean expression within the parens. Having done that,
1560 typing \\[cperl-linefeed] places you - appropriately indented - on a
1561 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1562 directive line, then appropriate number of new lines is inserted).
1564 If CPerl decides that you want to insert \"English\" style construct like
1568 it will not do any expansion. See also help on variable
1569 `cperl-extra-newline-before-brace'. (Note that one can switch the
1570 help message on expansion by setting `cperl-message-electric-keyword'
1573 \\[cperl-linefeed] is a convenience replacement for typing carriage
1574 return. It places you in the next line with proper indentation, or if
1575 you type it inside the inline block of control construct, like
1577 foreach (@lines) {print; print}
1579 and you are on a boundary of a statement inside braces, it will
1580 transform the construct into a multiline and will place you into an
1581 appropriately indented blank line. If you need a usual
1582 `newline-and-indent' behavior, it is on \\[newline-and-indent],
1583 see documentation on `cperl-electric-linefeed'.
1585 Use \\[cperl-invert-if-unless] to change a construction of the form
1595 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1596 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1597 on electric space between $ and {, `cperl-electric-parens-string' is
1598 the string that contains parentheses that should be electric in CPerl
1599 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1600 setting `cperl-electric-keywords' enables electric expansion of
1601 control structures in CPerl. `cperl-electric-linefeed' governs which
1602 one of two linefeed behavior is preferable. You can enable all these
1603 options simultaneously (recommended mode of use) by setting
1604 `cperl-hairy' to t. In this case you can switch separate options off
1605 by setting them to `null'. Note that one may undo the extra
1606 whitespace inserted by semis and braces in `auto-newline'-mode by
1607 consequent \\[cperl-electric-backspace].
1609 If your site has perl5 documentation in info format, you can use commands
1610 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1611 These keys run commands `cperl-info-on-current-command' and
1612 `cperl-info-on-command', which one is which is controlled by variable
1613 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1614 \(in turn affected by `cperl-hairy').
1616 Even if you have no info-format documentation, short one-liner-style
1617 help is available on \\[cperl-get-help], and one can run perldoc or
1620 It is possible to show this help automatically after some idle time.
1621 This is regulated by variable `cperl-lazy-help-time'. Default with
1622 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1623 secs idle time . It is also possible to switch this on/off from the
1624 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1626 Use \\[cperl-lineup] to vertically lineup some construction - put the
1627 beginning of the region at the start of construction, and make region
1628 span the needed amount of lines.
1630 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1631 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1632 here-docs sections. With capable Emaxen results of scan are used
1633 for indentation too, otherwise they are used for highlighting only.
1635 Variables controlling indentation style:
1636 `cperl-tab-always-indent'
1637 Non-nil means TAB in CPerl mode should always reindent the current line,
1638 regardless of where in the line point is when the TAB command is used.
1639 `cperl-indent-left-aligned-comments'
1640 Non-nil means that the comment starting in leftmost column should indent.
1641 `cperl-auto-newline'
1642 Non-nil means automatically newline before and after braces,
1643 and after colons and semicolons, inserted in Perl code. The following
1644 \\[cperl-electric-backspace] will remove the inserted whitespace.
1645 Insertion after colons requires both this variable and
1646 `cperl-auto-newline-after-colon' set.
1647 `cperl-auto-newline-after-colon'
1648 Non-nil means automatically newline even after colons.
1649 Subject to `cperl-auto-newline' setting.
1650 `cperl-indent-level'
1651 Indentation of Perl statements within surrounding block.
1652 The surrounding block's indentation is the indentation
1653 of the line on which the open-brace appears.
1654 `cperl-continued-statement-offset'
1655 Extra indentation given to a substatement, such as the
1656 then-clause of an if, or body of a while, or just a statement continuation.
1657 `cperl-continued-brace-offset'
1658 Extra indentation given to a brace that starts a substatement.
1659 This is in addition to `cperl-continued-statement-offset'.
1660 `cperl-brace-offset'
1661 Extra indentation for line if it starts with an open brace.
1662 `cperl-brace-imaginary-offset'
1663 An open brace following other text is treated as if it the line started
1664 this far to the right of the actual line indentation.
1665 `cperl-label-offset'
1666 Extra indentation for line that is a label.
1667 `cperl-min-label-indent'
1668 Minimal indentation for line that is a label.
1670 Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
1671 `cperl-indent-level' 5 4 2 4
1672 `cperl-brace-offset' 0 0 0 0
1673 `cperl-continued-brace-offset' -5 -4 0 0
1674 `cperl-label-offset' -5 -4 -2 -4
1675 `cperl-continued-statement-offset' 5 4 2 4
1677 CPerl knows several indentation styles, and may bulk set the
1678 corresponding variables. Use \\[cperl-set-style] to do this. Use
1679 \\[cperl-set-style-back] to restore the memorized preexisting values
1680 \(both available from menu). See examples in `cperl-style-examples'.
1682 Part of the indentation style is how different parts of if/elsif/else
1683 statements are broken into lines; in CPerl, this is reflected on how
1684 templates for these constructs are created (controlled by
1685 `cperl-extra-newline-before-brace'), and how reflow-logic should treat
1686 \"continuation\" blocks of else/elsif/continue, controlled by the same
1687 variable, and by `cperl-extra-newline-before-brace-multiline',
1688 `cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
1690 If `cperl-indent-level' is 0, the statement after opening brace in
1691 column 0 is indented on
1692 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1694 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1697 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1698 or as help on variables `cperl-tips', `cperl-problems',
1699 `cperl-praise', `cperl-speed'."
1701 (kill-all-local-variables)
1702 (use-local-map cperl-mode-map
)
1703 (if (cperl-val 'cperl-electric-linefeed
)
1705 (local-set-key "\C-J" 'cperl-linefeed
)
1706 (local-set-key "\C-C\C-J" 'newline-and-indent
)))
1708 (cperl-val 'cperl-clobber-lisp-bindings
)
1709 (cperl-val 'cperl-info-on-command-no-prompt
))
1711 ;; don't clobber the backspace binding:
1712 (cperl-define-key "\C-hf" 'cperl-info-on-current-command
[(control h
) f
])
1713 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1714 [(control c
) (control h
) f
])))
1715 (setq major-mode cperl-use-major-mode
)
1716 (setq mode-name
"CPerl")
1717 (let ((prev-a-c abbrevs-changed
))
1718 (define-abbrev-table 'cperl-mode-abbrev-table
'(
1719 ("if" "if" cperl-electric-keyword
0)
1720 ("elsif" "elsif" cperl-electric-keyword
0)
1721 ("while" "while" cperl-electric-keyword
0)
1722 ("until" "until" cperl-electric-keyword
0)
1723 ("unless" "unless" cperl-electric-keyword
0)
1724 ("else" "else" cperl-electric-else
0)
1725 ("continue" "continue" cperl-electric-else
0)
1726 ("for" "for" cperl-electric-keyword
0)
1727 ("foreach" "foreach" cperl-electric-keyword
0)
1728 ("formy" "formy" cperl-electric-keyword
0)
1729 ("foreachmy" "foreachmy" cperl-electric-keyword
0)
1730 ("do" "do" cperl-electric-keyword
0)
1731 ("=pod" "=pod" cperl-electric-pod
0)
1732 ("=over" "=over" cperl-electric-pod
0)
1733 ("=head1" "=head1" cperl-electric-pod
0)
1734 ("=head2" "=head2" cperl-electric-pod
0)
1735 ("pod" "pod" cperl-electric-pod
0)
1736 ("over" "over" cperl-electric-pod
0)
1737 ("head1" "head1" cperl-electric-pod
0)
1738 ("head2" "head2" cperl-electric-pod
0)))
1739 (setq abbrevs-changed prev-a-c
))
1740 (setq local-abbrev-table cperl-mode-abbrev-table
)
1741 (if (cperl-val 'cperl-electric-keywords
)
1743 (set-syntax-table cperl-mode-syntax-table
)
1744 ;; Until Emacs is multi-threaded, we do not actually need it local:
1745 (make-local-variable 'cperl-font-lock-multiline-start
)
1746 (make-local-variable 'cperl-font-locking
)
1747 (make-local-variable 'outline-regexp
)
1748 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1749 (setq outline-regexp cperl-outline-regexp
)
1750 (make-local-variable 'outline-level
)
1751 (setq outline-level
'cperl-outline-level
)
1752 (make-local-variable 'paragraph-start
)
1753 (setq paragraph-start
(concat "^$\\|" page-delimiter
))
1754 (make-local-variable 'paragraph-separate
)
1755 (setq paragraph-separate paragraph-start
)
1756 (make-local-variable 'paragraph-ignore-fill-prefix
)
1757 (setq paragraph-ignore-fill-prefix t
)
1758 (if (featurep 'xemacs
)
1760 (make-local-variable 'paren-backwards-message
)
1761 (set 'paren-backwards-message t
)))
1762 (make-local-variable 'indent-line-function
)
1763 (setq indent-line-function
'cperl-indent-line
)
1764 (make-local-variable 'require-final-newline
)
1765 (setq require-final-newline mode-require-final-newline
)
1766 (make-local-variable 'comment-start
)
1767 (setq comment-start
"# ")
1768 (make-local-variable 'comment-end
)
1769 (setq comment-end
"")
1770 (make-local-variable 'comment-column
)
1771 (setq comment-column cperl-comment-column
)
1772 (make-local-variable 'comment-start-skip
)
1773 (setq comment-start-skip
"#+ *")
1774 (make-local-variable 'defun-prompt-regexp
)
1776 ;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1777 ;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
1778 (setq defun-prompt-regexp
1779 (concat "^[ \t]*\\(sub"
1780 (cperl-after-sub-regexp 'named
'attr-groups
)
1782 "\\(BEGIN\\|CHECK\\|INIT\\|END\\|AUTOLOAD\\|DESTROY\\)"
1784 cperl-maybe-white-and-comment-rex
))
1785 (make-local-variable 'comment-indent-function
)
1786 (setq comment-indent-function
'cperl-comment-indent
)
1787 (and (boundp 'fill-paragraph-function
)
1789 (make-local-variable 'fill-paragraph-function
)
1790 (set 'fill-paragraph-function
'cperl-fill-paragraph
)))
1791 (make-local-variable 'parse-sexp-ignore-comments
)
1792 (setq parse-sexp-ignore-comments t
)
1793 (make-local-variable 'indent-region-function
)
1794 (setq indent-region-function
'cperl-indent-region
)
1795 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1796 (make-local-variable 'imenu-create-index-function
)
1797 (setq imenu-create-index-function
1798 (function cperl-imenu--create-perl-index
))
1799 (make-local-variable 'imenu-sort-function
)
1800 (setq imenu-sort-function nil
)
1801 (make-local-variable 'vc-rcs-header
)
1802 (set 'vc-rcs-header cperl-vc-rcs-header
)
1803 (make-local-variable 'vc-sccs-header
)
1804 (set 'vc-sccs-header cperl-vc-sccs-header
)
1805 (when (featurep 'xemacs
)
1806 ;; This one is obsolete...
1807 (make-local-variable 'vc-header-alist
)
1808 (set 'vc-header-alist
(or cperl-vc-header-alist
; Avoid warning
1809 `((SCCS ,(car cperl-vc-sccs-header
))
1810 (RCS ,(car cperl-vc-rcs-header
))))))
1811 (cond ((boundp 'compilation-error-regexp-alist-alist
);; xemacs 20.x
1812 (make-local-variable 'compilation-error-regexp-alist-alist
)
1813 (set 'compilation-error-regexp-alist-alist
1814 (cons (cons 'cperl
(car cperl-compilation-error-regexp-alist
))
1815 (symbol-value 'compilation-error-regexp-alist-alist
)))
1816 (if (fboundp 'compilation-build-compilation-error-regexp-alist
)
1817 (let ((f 'compilation-build-compilation-error-regexp-alist
))
1819 (make-local-variable 'compilation-error-regexp-alist
)
1820 (push 'cperl compilation-error-regexp-alist
)))
1821 ((boundp 'compilation-error-regexp-alist
);; xmeacs 19.x
1822 (make-local-variable 'compilation-error-regexp-alist
)
1823 (set 'compilation-error-regexp-alist
1824 (append cperl-compilation-error-regexp-alist
1825 (symbol-value 'compilation-error-regexp-alist
)))))
1826 (make-local-variable 'font-lock-defaults
)
1827 (setq font-lock-defaults
1829 ((string< emacs-version
"19.30")
1830 '(cperl-font-lock-keywords-2 nil nil
((?_ .
"w"))))
1831 ((string< emacs-version
"19.33") ; Which one to use?
1832 '((cperl-font-lock-keywords
1833 cperl-font-lock-keywords-1
1834 cperl-font-lock-keywords-2
) nil nil
((?_ .
"w"))))
1836 '((cperl-load-font-lock-keywords
1837 cperl-load-font-lock-keywords-1
1838 cperl-load-font-lock-keywords-2
) nil nil
((?_ .
"w"))))))
1839 (make-local-variable 'cperl-syntax-state
)
1840 (setq cperl-syntax-state nil
) ; reset syntaxification cache
1841 (if cperl-use-syntax-table-text-property
1842 (if (boundp 'syntax-propertize-function
)
1844 ;; Reset syntaxification cache.
1845 (set (make-local-variable 'cperl-syntax-done-to
) nil
)
1846 (set (make-local-variable 'syntax-propertize-function
)
1848 (goto-char start
) (cperl-fontify-syntaxically end
))))
1849 (make-local-variable 'parse-sexp-lookup-properties
)
1850 ;; Do not introduce variable if not needed, we check it!
1851 (set 'parse-sexp-lookup-properties t
)
1852 ;; Fix broken font-lock:
1853 (or (boundp 'font-lock-unfontify-region-function
)
1854 (set 'font-lock-unfontify-region-function
1855 'font-lock-default-unfontify-region
))
1856 (unless (featurep 'xemacs
) ; Our: just a plug for wrong font-lock
1857 (make-local-variable 'font-lock-unfontify-region-function
)
1858 (set 'font-lock-unfontify-region-function
; not present with old Emacs
1859 'cperl-font-lock-unfontify-region-function
))
1860 (make-local-variable 'cperl-syntax-done-to
)
1861 (setq cperl-syntax-done-to nil
) ; reset syntaxification cache
1862 (make-local-variable 'font-lock-syntactic-keywords
)
1863 (setq font-lock-syntactic-keywords
1864 (if cperl-syntaxify-by-font-lock
1865 '((cperl-fontify-syntaxically))
1866 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1867 ;; used to ignore syntax-table text-properties. (t) is a hack
1868 ;; to make font-lock think that font-lock-syntactic-keywords
1871 (if (boundp 'font-lock-multiline
) ; Newer font-lock; use its facilities
1873 (setq cperl-font-lock-multiline t
) ; Not localized...
1874 (set (make-local-variable 'font-lock-multiline
) t
))
1875 (make-local-variable 'font-lock-fontify-region-function
)
1876 (set 'font-lock-fontify-region-function
; not present with old Emacs
1877 'cperl-font-lock-fontify-region-function
))
1878 (make-local-variable 'font-lock-fontify-region-function
)
1879 (set 'font-lock-fontify-region-function
; not present with old Emacs
1880 'cperl-font-lock-fontify-region-function
)
1881 (make-local-variable 'cperl-old-style
)
1882 (if (boundp 'normal-auto-fill-function
) ; 19.33 and later
1883 (set (make-local-variable 'normal-auto-fill-function
)
1884 'cperl-do-auto-fill
)
1885 (or (fboundp 'cperl-old-auto-fill-mode
)
1887 (fset 'cperl-old-auto-fill-mode
(symbol-function 'auto-fill-mode
))
1888 (defun auto-fill-mode (&optional arg
)
1890 (eval '(cperl-old-auto-fill-mode arg
)) ; Avoid a warning
1891 (and auto-fill-function
(memq major-mode
'(perl-mode cperl-mode
))
1892 (setq auto-fill-function
'cperl-do-auto-fill
))))))
1893 (if (cperl-enable-font-lock)
1894 (if (cperl-val 'cperl-font-lock
)
1895 (progn (or cperl-faces-init
(cperl-init-faces))
1896 (font-lock-mode 1))))
1897 (set (make-local-variable 'facemenu-add-face-function
)
1898 'cperl-facemenu-add-face-function
) ; XXXX What this guy is for???
1899 (and (boundp 'msb-menu-cond
)
1900 (not cperl-msb-fixed
)
1902 (if (featurep 'easymenu
)
1903 (easy-menu-add cperl-menu
)) ; A NOP in Emacs.
1904 (run-mode-hooks 'cperl-mode-hook
)
1905 (if cperl-hook-after-change
1906 (add-hook 'after-change-functions
'cperl-after-change-function nil t
))
1907 ;; After hooks since fontification will break this
1908 (if cperl-pod-here-scan
1909 (or cperl-syntaxify-by-font-lock
1910 (progn (or cperl-faces-init
(cperl-init-faces-weak))
1911 (cperl-find-pods-heres)))))
1913 ;; Fix for perldb - make default reasonable
1917 (perldb (read-from-minibuffer "Run perldb (like this): "
1918 (if (consp gud-perldb-history
)
1919 (car gud-perldb-history
)
1920 (concat "perl " ;;(file-name-nondirectory
1924 (buffer-file-name)))
1926 '(gud-perldb-history .
1))))
1928 (defun cperl-msb-fix ()
1929 ;; Adds perl files to msb menu, supposes that msb is already loaded
1930 (setq cperl-msb-fixed t
)
1931 (let* ((l (length msb-menu-cond
))
1932 (last (nth (1- l
) msb-menu-cond
))
1933 (precdr (nthcdr (- l
2) msb-menu-cond
)) ; cdr of this is last
1934 (handle (1- (nth 1 last
))))
1935 (setcdr precdr
(list
1937 '(memq major-mode
'(cperl-mode perl-mode
))
1942 ;; This is used by indent-for-comment
1943 ;; to decide how much to indent a comment in CPerl code
1944 ;; based on its context. Do fallback if comment is found wrong.
1946 (defvar cperl-wrong-comment
)
1947 (defvar cperl-st-cfence
'(14)) ; Comment-fence
1948 (defvar cperl-st-sfence
'(15)) ; String-fence
1949 (defvar cperl-st-punct
'(1))
1950 (defvar cperl-st-word
'(2))
1951 (defvar cperl-st-bra
'(4 . ?\
>))
1952 (defvar cperl-st-ket
'(5 . ?\
<))
1955 (defun cperl-comment-indent () ; called at point at supposed comment
1956 (let ((p (point)) (c (current-column)) was phony
)
1957 (if (and (not cperl-indent-comment-at-column-0
)
1959 0 ; Existing comment at bol stays there.
1960 ;; Wrong comment found
1962 (setq was
(cperl-to-comment-or-eol)
1963 phony
(eq (get-text-property (point) 'syntax-table
)
1966 (progn ; Too naive???
1967 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1968 (if (eq (preceding-char) ?\
#)
1971 (if (= (point) p
) ; Our caller found a correct place
1973 (skip-chars-backward " \t")
1974 (setq was
(current-column))
1977 (max (1+ was
) ; Else indent at comment column
1979 ;; No, the caller found a random place; we need to edit ourselves
1981 (insert comment-start
)
1982 (backward-char (length comment-start
)))
1983 (setq cperl-wrong-comment t
)
1984 (cperl-make-indent comment-column
1) ; Indent min 1
1987 ;;;(defun cperl-comment-indent-fallback ()
1988 ;;; "Is called if the standard comment-search procedure fails.
1989 ;;;Point is at start of real comment."
1990 ;;; (let ((c (current-column)) target cnt prevc)
1991 ;;; (if (= c comment-column) nil
1992 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1993 ;;; (setq target (max (1+ (setq prevc
1994 ;;; (current-column))) ; Else indent at comment column
1995 ;;; comment-column))
1996 ;;; (if (= c comment-column) nil
1997 ;;; (delete-backward-char cnt)
1998 ;;; (while (< prevc target)
2000 ;;; (setq prevc (current-column)))
2001 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
2002 ;;; (while (< prevc target)
2004 ;;; (setq prevc (current-column)))))))
2006 (defun cperl-indent-for-comment ()
2007 "Substitute for `indent-for-comment' in CPerl."
2009 (let (cperl-wrong-comment)
2010 (indent-for-comment)
2011 (if cperl-wrong-comment
; set by `cperl-comment-indent'
2012 (progn (cperl-to-comment-or-eol)
2013 (forward-char (length comment-start
))))))
2015 (defun cperl-comment-region (b e arg
)
2016 "Comment or uncomment each line in the region in CPerl mode.
2017 See `comment-region'."
2018 (interactive "r\np")
2019 (let ((comment-start "#"))
2020 (comment-region b e arg
)))
2022 (defun cperl-uncomment-region (b e arg
)
2023 "Uncomment or comment each line in the region in CPerl mode.
2024 See `comment-region'."
2025 (interactive "r\np")
2026 (let ((comment-start "#"))
2027 (comment-region b e
(- arg
))))
2029 (defvar cperl-brace-recursing nil
)
2031 (defun cperl-electric-brace (arg &optional only-before
)
2032 "Insert character and correct line's indentation.
2033 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2034 place (even in empty line), but not after. If after \")\" and the inserted
2035 char is \"{\", insert extra newline before only if
2036 `cperl-extra-newline-before-brace'."
2039 (other-end (if (and cperl-electric-parens-mark
2045 (not cperl-brace-recursing
)
2046 (cperl-val 'cperl-electric-parens
)
2047 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2048 ;; Need to insert a matching pair
2051 (setq insertpos
(point-marker))
2052 (goto-char other-end
)
2053 (setq last-command-event ?\
{)
2054 (cperl-electric-lbrace arg insertpos
))
2056 ;; Check whether we close something "usual" with `}'
2057 (if (and (eq last-command-event ?\
})
2061 (up-list (- (prefix-numeric-value arg
)))
2062 ;;(cperl-after-block-p (point-min))
2063 (or (cperl-after-expr-p nil
"{;)")
2064 ;; after sub, else, continue
2065 (cperl-after-block-p nil
'pre
)))
2067 ;; Just insert the guy
2068 (self-insert-command (prefix-numeric-value arg
))
2069 (if (and (not arg
) ; No args, end (of empty line or auto)
2071 (or (and (null only-before
)
2073 (skip-chars-backward " \t")
2075 (and (eq last-command-event ?\
{) ; Do not insert newline
2076 ;; if after ")" and `cperl-extra-newline-before-brace'
2077 ;; is nil, do not insert extra newline.
2078 (not cperl-extra-newline-before-brace
)
2080 (skip-chars-backward " \t")
2081 (eq (preceding-char) ?\
))))
2082 (if cperl-auto-newline
2083 (progn (cperl-indent-line) (newline) t
) nil
)))
2085 (self-insert-command (prefix-numeric-value arg
))
2087 (if cperl-auto-newline
2088 (setq insertpos
(1- (point))))
2089 (if (and cperl-auto-newline
(null only-before
))
2092 (cperl-indent-line)))
2094 (if insertpos
(progn (goto-char insertpos
)
2095 (search-forward (make-string
2096 1 last-command-event
))
2097 (setq insertpos
(1- (point)))))
2101 (goto-char insertpos
)
2102 (self-insert-command (prefix-numeric-value arg
)))
2103 (self-insert-command (prefix-numeric-value arg
)))))))
2105 (defun cperl-electric-lbrace (arg &optional end
)
2106 "Insert character, correct line's indentation, correct quoting by space."
2108 (let ((cperl-brace-recursing t
)
2109 (cperl-auto-newline cperl-auto-newline
)
2111 (if (and cperl-electric-parens-mark
2119 (and (cperl-val 'cperl-electric-lbrace-space
)
2120 (eq (preceding-char) ?$
)
2122 (skip-chars-backward "$")
2123 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
2125 ;; Check whether we are in comment
2129 (not (looking-at "[ \t]*#")))
2130 (cperl-after-expr-p nil
"{;)"))
2132 (setq cperl-auto-newline nil
))
2133 (cperl-electric-brace arg
)
2134 (and (cperl-val 'cperl-electric-parens
)
2135 (eq last-command-event ?
{)
2136 (memq last-command-event
2137 (append cperl-electric-parens-string nil
))
2138 (or (if other-end
(goto-char (marker-position other-end
)))
2140 (setq last-command-event ?
} pos
(point))
2141 (progn (cperl-electric-brace arg t
)
2144 (defun cperl-electric-paren (arg)
2145 "Insert an opening parenthesis or a matching pair of parentheses.
2146 See `cperl-electric-parens'."
2148 (let ((beg (point-at-bol))
2149 (other-end (if (and cperl-electric-parens-mark
2156 (if (and (cperl-val 'cperl-electric-parens
)
2157 (memq last-command-event
2158 (append cperl-electric-parens-string nil
))
2159 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2160 ;;(not (save-excursion (search-backward "#" beg t)))
2161 (if (eq last-command-event ?
<)
2163 ;; This code is too electric, see Bug#3943.
2164 ;; (and abbrev-mode ; later it is too late, may be after `for'
2166 (cperl-after-expr-p nil
"{;(,:="))
2169 (self-insert-command (prefix-numeric-value arg
))
2170 (if other-end
(goto-char (marker-position other-end
)))
2171 (insert (make-string
2172 (prefix-numeric-value arg
)
2173 (cdr (assoc last-command-event
'((?
{ .?
})
2177 (forward-char (- (prefix-numeric-value arg
))))
2178 (self-insert-command (prefix-numeric-value arg
)))))
2180 (defun cperl-electric-rparen (arg)
2181 "Insert a matching pair of parentheses if marking is active.
2182 If not, or if we are not at the end of marking range, would self-insert.
2183 Affected by `cperl-electric-parens'."
2185 (let ((beg (point-at-bol))
2186 (other-end (if (and cperl-electric-parens-mark
2187 (cperl-val 'cperl-electric-parens
)
2188 (memq last-command-event
2189 (append cperl-electric-parens-string nil
))
2196 (cperl-val 'cperl-electric-parens
)
2197 (memq last-command-event
'( ?\
) ?\
] ?\
} ?\
> ))
2198 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2199 ;;(not (save-excursion (search-backward "#" beg t)))
2202 (self-insert-command (prefix-numeric-value arg
))
2204 (if other-end
(goto-char other-end
))
2205 (insert (make-string
2206 (prefix-numeric-value arg
)
2207 (cdr (assoc last-command-event
'((?\
} . ?\
{)
2212 (self-insert-command (prefix-numeric-value arg
)))))
2214 (defun cperl-electric-keyword ()
2215 "Insert a construction appropriate after a keyword.
2216 Help message may be switched off by setting `cperl-message-electric-keyword'
2218 (let ((beg (point-at-bol))
2219 (dollar (and (eq last-command-event ?$
)
2220 (eq this-command
'self-insert-command
)))
2221 (delete (and (memq last-command-event
'(?\s ?
\n ?
\t ?
\f))
2222 (memq this-command
'(self-insert-command newline
))))
2224 (and (save-excursion
2228 (setq do
(looking-at "do\\>")))
2230 (cperl-after-expr-p nil
"{;:"))
2234 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2236 (save-excursion (or (not (re-search-backward "^=" nil t
))
2239 (and cperl-use-syntax-table-text-property
2240 (not (eq (get-text-property (point)
2243 (save-excursion (forward-sexp -
1)
2244 (not (memq (following-char) (append "$@%&*" nil
))))
2246 (and (eq (preceding-char) ?y
)
2247 (progn ; "foreachmy"
2253 (memq this-command
'(self-insert-command newline
)))))
2254 (and dollar
(insert " $"))
2256 ;;(insert " () {\n}")
2258 (cperl-extra-newline-before-brace
2259 (insert (if do
"\n" " ()\n"))
2265 (and do
(insert " while ();")))
2267 (insert (if do
" {\n} while ();" " () {\n}"))))
2268 (or (looking-at "[ \t]\\|$") (insert " "))
2270 (if dollar
(progn (search-backward "$")
2274 (search-backward ")")
2275 (if (eq last-command-event ?\
()
2276 (progn ; Avoid "if (())"
2277 (delete-backward-char 1)
2278 (delete-backward-char -
1))))
2280 (cperl-putback-char cperl-del-back-ch
))
2281 (if cperl-message-electric-keyword
2282 (message "Precede char by C-q to avoid expansion"))))))
2284 (defun cperl-ensure-newlines (n &optional pos
)
2285 "Make sure there are N newlines after the point."
2286 (or pos
(setq pos
(point)))
2287 (if (looking-at "\n")
2291 (cperl-ensure-newlines (1- n
) pos
)
2294 (defun cperl-electric-pod ()
2295 "Insert a POD chunk appropriate after a =POD directive."
2296 (let ((delete (and (memq last-command-event
'(?\s ?
\n ?
\t ?
\f))
2297 (memq this-command
'(self-insert-command newline
))))
2298 head1 notlast name p really-delete over
)
2299 (and (save-excursion
2302 (eq (preceding-char) ?
=)
2304 (setq head1
(looking-at "head1\\>[ \t]*$"))
2305 (setq over
(and (looking-at "over\\>[ \t]*$")
2306 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
2310 (get-text-property (point) 'in-pod
)
2311 (cperl-after-expr-p nil
"{;:")
2312 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t
)
2313 (not (looking-at "\n*=cut"))
2314 (or (not cperl-use-syntax-table-text-property
)
2315 (eq (get-text-property (point) 'syntax-type
) 'pod
))))))
2318 (setq notlast
(re-search-forward "^\n=" nil t
)))
2322 (cperl-ensure-newlines 2)
2328 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
2329 nil t
)))) ; Only one
2332 (setq name
(file-name-sans-extension
2333 (file-name-nondirectory (buffer-file-name)))
2335 (insert " NAME\n\n" name
2336 " - \n\n=head1 SYNOPSIS\n\n\n\n"
2337 "=head1 DESCRIPTION")
2338 (cperl-ensure-newlines 4)
2342 (setq really-delete t
))
2347 (insert "\n\n=item \n\n\n\n"
2349 (cperl-ensure-newlines 2)
2353 (setq really-delete t
)))
2354 (if (and delete really-delete
)
2355 (cperl-putback-char cperl-del-back-ch
))))))
2357 (defun cperl-electric-else ()
2358 "Insert a construction appropriate after a keyword.
2359 Help message may be switched off by setting `cperl-message-electric-keyword'
2361 (let ((beg (point-at-bol)))
2362 (and (save-excursion
2364 (cperl-after-expr-p nil
"{;:"))
2368 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2370 (save-excursion (or (not (re-search-backward "^=" nil t
))
2372 (and cperl-use-syntax-table-text-property
2373 (not (eq (get-text-property (point)
2378 ;;(insert " {\n\n}")
2380 (cperl-extra-newline-before-brace
2386 (insert " {\n\n}")))
2387 (or (looking-at "[ \t]\\|$") (insert " "))
2391 (cperl-putback-char cperl-del-back-ch
)
2392 (setq this-command
'cperl-electric-else
)
2393 (if cperl-message-electric-keyword
2394 (message "Precede char by C-q to avoid expansion"))))))
2396 (defun cperl-linefeed ()
2397 "Go to end of line, open a new line and indent appropriately.
2398 If in POD, insert appropriate lines."
2400 (let ((beg (point-at-bol))
2401 (end (point-at-eol))
2402 (pos (point)) start over cut res
)
2403 (if (and ; Check if we need to split:
2404 ; i.e., on a boundary and inside "{...}"
2405 (save-excursion (cperl-to-comment-or-eol)
2406 (>= (point) pos
)) ; Not in a comment
2408 (skip-chars-backward " \t" beg
)
2410 (looking-at "[;{]")) ; After { or ; + spaces
2411 (looking-at "[ \t]*}") ; Before }
2412 (re-search-forward "\\=[ \t]*;" end t
)) ; Before spaces + ;
2415 (eq (car (parse-partial-sexp pos end -
1)) -
1)
2416 ; Leave the level of parens
2417 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2419 (cperl-after-block-p (point-min))
2422 (setq start
(point-marker))
2423 (<= start pos
))))) ; Redundant? Are after the
2424 ; start of parens group.
2426 (skip-chars-backward " \t")
2427 (or (memq (preceding-char) (append ";{" nil
))
2433 (or (looking-at "{[ \t]*$") ; If there is a statement
2434 ; before, move it to separate line
2438 (cperl-indent-line)))
2439 (forward-line 1) ; We are on the target line
2442 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2443 ; after, move it to separate line
2446 (search-backward "}" beg
)
2447 (skip-chars-backward " \t")
2448 (or (memq (preceding-char) (append ";{" nil
))
2453 (forward-line -
1) ; We are on the line before target
2455 (newline-and-indent))
2456 (end-of-line) ; else - no splitting
2458 ((and (looking-at "\n[ \t]*{$")
2460 (skip-chars-backward " \t")
2461 (eq (preceding-char) ?\
)))) ; Probably if () {} group
2462 ; with an extra newline.
2464 (cperl-indent-line))
2465 ((save-excursion ; In POD header
2466 (forward-paragraph -
1)
2467 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2468 ;; We are after \n now, so look for the rest
2469 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2471 (setq cut
(looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2472 (setq over
(looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2476 (forward-paragraph -
1)
2479 (setq cut
(buffer-substring (point) (point-at-eol)))
2480 (delete-char (- (point-at-eol) (point)))
2481 (setq res
(expand-abbrev))
2487 (cperl-ensure-newlines (if cut
2 4))
2489 ((get-text-property (point) 'in-pod
) ; In POD section
2490 (cperl-ensure-newlines 4)
2492 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2494 (cperl-indent-line))
2496 (newline-and-indent))))))
2498 (defun cperl-electric-semi (arg)
2499 "Insert character and correct line's indentation."
2501 (if cperl-auto-newline
2502 (cperl-electric-terminator arg
)
2503 (self-insert-command (prefix-numeric-value arg
))
2504 (if cperl-autoindent-on-semi
2505 (cperl-indent-line))))
2507 (defun cperl-electric-terminator (arg)
2508 "Insert character and correct line's indentation."
2511 (auto (and cperl-auto-newline
2512 (or (not (eq last-command-event ?
:))
2513 cperl-auto-newline-after-colon
)))
2515 (if (and ;;(not arg)
2517 (not (save-excursion
2519 (skip-chars-forward " \t")
2521 ;; Ignore in comment lines
2522 (= (following-char) ?
#)
2523 ;; Colon is special only after a label
2524 ;; So quickly rule out most other uses of colon
2525 ;; and do no indentation for them.
2526 (and (eq last-command-event ?
:)
2529 (skip-chars-forward " \t")
2530 (and (< (point) end
)
2531 (progn (goto-char (- end
1))
2532 (not (looking-at ":"))))))
2534 (beginning-of-defun)
2535 (let ((pps (parse-partial-sexp (point) end
)))
2536 (or (nth 3 pps
) (nth 4 pps
) (nth 5 pps
))))))))
2538 (self-insert-command (prefix-numeric-value arg
))
2540 (if auto
(setq insertpos
(point-marker)))
2546 (cperl-indent-line)))
2548 (if insertpos
(goto-char (1- (marker-position insertpos
)))
2553 (goto-char insertpos
)
2554 (self-insert-command (prefix-numeric-value arg
)))
2555 (self-insert-command (prefix-numeric-value arg
)))))
2557 (defun cperl-electric-backspace (arg)
2558 "Backspace, or remove whitespace around the point inserted by an electric key.
2559 Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2561 (if (and cperl-auto-newline
2562 (memq last-command
'(cperl-electric-semi
2563 cperl-electric-terminator
2564 cperl-electric-lbrace
))
2565 (memq (preceding-char) '(?\s ?
\t ?
\n)))
2567 (if (eq last-command
'cperl-electric-lbrace
)
2568 (skip-chars-forward " \t\n"))
2570 (skip-chars-backward " \t\n")
2571 (delete-region (point) p
))
2572 (and (eq last-command
'cperl-electric-else
)
2573 ;; We are removing the whitespace *inside* cperl-electric-else
2574 (setq this-command
'cperl-electric-else-really
))
2575 (if (and cperl-auto-newline
2576 (eq last-command
'cperl-electric-else-really
)
2577 (memq (preceding-char) '(?\s ?
\t ?
\n)))
2579 (skip-chars-forward " \t\n")
2581 (skip-chars-backward " \t\n")
2582 (delete-region (point) p
))
2583 (if cperl-electric-backspace-untabify
2584 (backward-delete-char-untabify arg
)
2585 (delete-backward-char arg
)))))
2587 (put 'cperl-electric-backspace
'delete-selection
'supersede
)
2589 (defun cperl-inside-parens-p () ;; NOT USED????
2593 (narrow-to-region (point)
2594 (progn (beginning-of-defun) (point)))
2595 (goto-char (point-max))
2596 (= (char-after (or (scan-lists (point) -
1 1) (point-min))) ?\
()))
2599 (defun cperl-indent-command (&optional whole-exp
)
2600 "Indent current line as Perl code, or in some cases insert a tab character.
2601 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2602 line. Otherwise, indent the current line only if point is at the left margin
2603 or in the line's indentation; otherwise insert a tab.
2605 A numeric argument, regardless of its value,
2606 means indent rigidly all the lines of the expression starting after point
2607 so that this line becomes properly indented.
2608 The relative indentation among the lines of the expression are preserved."
2610 (cperl-update-syntaxification (point) (point))
2612 ;; If arg, always indent this line as Perl
2613 ;; and shift remaining lines of expression the same amount.
2614 (let ((shift-amt (cperl-indent-line))
2617 (if cperl-tab-always-indent
2618 (beginning-of-line))
2625 (if (and shift-amt
(> end beg
))
2626 (indent-code-rigidly beg end shift-amt
"#")))
2627 (if (and (not cperl-tab-always-indent
)
2629 (skip-chars-backward " \t")
2632 (cperl-indent-line))))
2634 (defun cperl-indent-line (&optional parse-data
)
2635 "Indent current line as Perl code.
2636 Return the amount the indentation changed by."
2637 (let ((case-fold-search nil
)
2638 (pos (- (point-max) (point)))
2639 indent i beg shift-amt
)
2640 (setq indent
(cperl-calculate-indent parse-data
)
2644 (cond ((or (eq indent nil
) (eq indent t
))
2645 (setq indent
(current-indentation) i nil
))
2646 ;;((eq indent t) ; Never?
2647 ;; (setq indent (cperl-calculate-indent-within-comment)))
2648 ;;((looking-at "[ \t]*#")
2651 (skip-chars-forward " \t")
2652 (if (listp indent
) (setq indent
(car indent
)))
2653 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2654 (not (looking-at "[smy]:\\|tr:")))
2656 (setq indent
(max cperl-min-label-indent
2657 (+ indent cperl-label-offset
)))))
2658 ((= (following-char) ?
})
2659 (setq indent
(- indent cperl-indent-level
)))
2660 ((memq (following-char) '(?\
) ?\
])) ; To line up with opening paren.
2661 (setq indent
(+ indent cperl-close-paren-offset
)))
2662 ((= (following-char) ?
{)
2663 (setq indent
(+ indent cperl-brace-offset
))))))
2664 (skip-chars-forward " \t")
2665 (setq shift-amt
(and i
(- indent
(current-column))))
2666 (if (or (not shift-amt
)
2668 (if (> (- (point-max) pos
) (point))
2669 (goto-char (- (point-max) pos
)))
2670 ;;;(delete-region beg (point))
2671 ;;;(indent-to indent)
2672 (cperl-make-indent indent
)
2673 ;; If initial point was within line's indentation,
2674 ;; position after the indentation. Else stay at same point in text.
2675 (if (> (- (point-max) pos
) (point))
2676 (goto-char (- (point-max) pos
))))
2679 (defun cperl-after-label ()
2680 ;; Returns true if the point is after label. Does not do save-excursion.
2681 (and (eq (preceding-char) ?
:)
2682 (memq (char-syntax (char-after (- (point) 2)))
2686 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2688 (defun cperl-get-state (&optional parse-start start-state
)
2689 ;; returns list (START STATE DEPTH PRESTART),
2690 ;; START is a good place to start parsing, or equal to
2691 ;; PARSE-START if preset,
2692 ;; STATE is what is returned by `parse-partial-sexp'.
2693 ;; DEPTH is true is we are immediately after end of block
2694 ;; which contains START.
2695 ;; PRESTART is the position basing on which START was found.
2697 (let ((start-point (point)) depth state start prestart
)
2698 (if (and parse-start
2699 (<= parse-start start-point
))
2700 (goto-char parse-start
)
2701 (beginning-of-defun)
2702 (setq start-state nil
))
2703 (setq prestart
(point))
2705 ;; Try to go out, if sub is not on the outermost level
2706 (while (< (point) start-point
)
2707 (setq start
(point) parse-start start depth nil
2708 state
(parse-partial-sexp start start-point -
1))
2709 (if (> (car state
) -
1) nil
2710 ;; The current line could start like }}}, so the indentation
2711 ;; corresponds to a different level than what we reached
2713 (beginning-of-line 2))) ; Go to the next line.
2714 (if start
(goto-char start
))) ; Not at the start of file
2715 (setq start
(point))
2716 (or state
(setq state
(parse-partial-sexp start start-point -
1 nil start-state
)))
2717 (list start state depth prestart
))))
2719 (defvar cperl-look-for-prop
'((pod in-pod
) (here-doc-delim here-doc-group
)))
2721 (defun cperl-beginning-of-property (p prop
&optional lim
)
2722 "Given that P has a property PROP, find where the property starts.
2723 Will not look before LIM."
2724 ;;; XXXX What to do at point-max???
2725 (or (previous-single-property-change (cperl-1+ p
) prop lim
)
2727 ;;; (cond ((eq p (point-min))
2729 ;;; ((and lim (<= p lim))
2731 ;;; ((not (get-text-property (1- p) prop))
2733 ;;; (t (or (previous-single-property-change p look-prop lim)
2737 (defun cperl-sniff-for-indent (&optional parse-data
) ; was parse-start
2738 ;; the sniffer logic to understand what the current line MEANS.
2739 (cperl-update-syntaxification (point) (point))
2740 (let ((res (get-text-property (point) 'syntax-type
)))
2743 ((and (memq res
'(pod here-doc here-doc-delim format
))
2744 (not (get-text-property (point) 'indentable
)))
2746 ;; before start of POD - whitespace found since do not have 'pod!
2747 ((looking-at "[ \t]*\n=")
2748 (error "Spaces before POD section!"))
2749 ((and (not cperl-indent-left-aligned-comments
)
2751 [comment-special
:at-beginning-of-line
])
2752 ((get-text-property (point) 'in-pod
)
2756 (let* ((indent-point (point))
2757 (char-after-pos (save-excursion
2758 (skip-chars-forward " \t")
2760 (char-after (char-after char-after-pos
))
2761 (pre-indent-point (point))
2762 p prop look-prop is-block delim
)
2763 (save-excursion ; Know we are not in POD, find appropriate pos before
2764 (cperl-backward-to-noncomment nil
)
2765 (setq p
(max (point-min) (1- (point)))
2766 prop
(get-text-property p
'syntax-type
)
2767 look-prop
(or (nth 1 (assoc prop cperl-look-for-prop
))
2769 (if (memq prop
'(pod here-doc format here-doc-delim
))
2771 (goto-char (cperl-beginning-of-property p look-prop
))
2773 (setq pre-indent-point
(point)))))
2774 (goto-char pre-indent-point
) ; Orig line skipping preceeding pod/etc
2775 (let* ((case-fold-search nil
)
2776 (s-s (cperl-get-state (car parse-data
) (nth 1 parse-data
)))
2777 (start (or (nth 2 parse-data
) ; last complete sexp terminated
2778 (nth 0 s-s
))) ; Good place to start parsing
2780 (containing-sexp (car (cdr state
)))
2783 ;;containing-sexp ;; We are buggy at toplevel :-(
2786 (setcar parse-data pre-indent-point
)
2787 (setcar (cdr parse-data
) state
)
2788 (or (nth 2 parse-data
)
2789 (setcar (cddr parse-data
) start
))
2790 ;; Before this point: end of statement
2791 (setq old-indent
(nth 3 parse-data
))))
2792 (cond ((get-text-property (point) 'indentable
)
2793 ;; indent to "after" the surrounding open
2794 ;; (same offset as `cperl-beautify-regexp-piece'),
2795 ;; skip blanks if we do not close the expression.
2796 (setq delim
; We do not close the expression
2798 (cperl-1+ char-after-pos
) 'indentable
)
2799 p
(1+ (cperl-beginning-of-property
2800 (point) 'indentable
))
2801 is-block
; misused for: preceeding line in REx
2802 (save-excursion ; Find preceeding line
2803 (cperl-backward-to-noncomment p
)
2806 (progn ; get indent from the first line
2808 (skip-chars-forward " \t")
2809 (if (memq (char-after (point))
2811 nil
; Can't use intentation of this line...
2813 (skip-chars-forward " \t")
2815 prop
(parse-partial-sexp p char-after-pos
))
2816 (cond ((not delim
) ; End the REx, ignore is-block
2817 (vector 'indentable
'terminator p is-block
))
2818 (is-block ; Indent w.r.t. preceeding line
2819 (vector 'indentable
'cont-line char-after-pos
2820 is-block char-after p
))
2821 (t ; No preceeding line...
2822 (vector 'indentable
'first-line p
))))
2823 ((get-text-property char-after-pos
'REx-part2
)
2824 (vector 'REx-part2
(point)))
2829 ;; XXXX Do we need to special-case this?
2830 ((null containing-sexp)
2831 ;; Line is at top level. May be data or function definition,
2832 ;; or may be function argument declaration.
2833 ;; Indent like the previous top level line
2834 ;; unless that ends in a closeparen without semicolon,
2835 ;; in which case this line is the first argument decl.
2836 (skip-chars-forward " \t")
2837 (cperl-backward-to-noncomment (or old-indent (point-min)))
2840 (eq (point) old-indent) ; old-indent was at comment
2841 (eq (preceding-char) ?\;)
2843 (and (eq (preceding-char) ?\})
2844 (cperl-after-block-and-statement-beg
2845 (point-min))) ; Was start - too close
2846 (memq char-after (append ")]}" nil))
2847 (and (eq (preceding-char) ?\:) ; label
2850 (skip-chars-backward " \t")
2851 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2852 (get-text-property (point) 'first-format-line)))
2854 ;; Look at previous line that's at column 0
2855 ;; to determine whether we are in top-level decls
2856 ;; or function's arg decls. Set basic-indent accordingly.
2857 ;; Now add a little if this is a continuation line.
2860 (not (eq char-after ?\C-j))
2861 (setcdr (cddr parse-data)
2862 (list pre-indent-point)))
2863 (vector 'toplevel start char-after state (nth 2 s-s)))
2866 (and (setq delim (= (char-after containing-sexp) ?{))
2867 (save-excursion ; Is it a hash?
2868 (goto-char containing-sexp)
2870 cperl-indent-parens-as-block))
2871 ;; group is an expression, not a block:
2872 ;; indent to just after the surrounding open parens,
2873 ;; skip blanks if we do not close the expression.
2874 (goto-char (1+ containing-sexp))
2875 (or (memq char-after
2876 (append (if delim "}" ")]}") nil))
2877 (looking-at "[ \t]*\\(#\\|$\\)")
2878 (skip-chars-forward " \t"))
2879 (setq old-indent (point)) ; delim=is-brace
2880 (vector 'in-parens char-after (point) delim containing-sexp))
2882 ;; Statement level. Is it a continuation or a new statement?
2883 ;; Find previous non-comment character.
2884 (goto-char pre-indent-point) ; Skip one level of POD/etc
2885 (cperl-backward-to-noncomment containing-sexp)
2886 ;; Back up over label lines, since they don't
2887 ;; affect whether our line is a continuation.
2889 (while;;(or (eq (preceding-char) ?\,)
2890 (and (eq (preceding-char) ?:)
2891 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2892 (memq (char-syntax (char-after (- (point) 2)))
2895 ;; This is always FALSE?
2896 (if (eq (preceding-char) ?\,)
2897 ;; Will go to beginning of line, essentially.
2898 ;; Will ignore embedded sexpr XXXX.
2899 (cperl-backward-to-start-of-continued-exp containing-sexp))
2901 (cperl-backward-to-noncomment containing-sexp))
2902 ;; Now we get non-label preceeding the indent point
2903 (if (not (or (eq (1- (point)) containing-sexp)
2904 (memq (preceding-char)
2905 (append (if is-block " ;{" " ,;{") '(nil)))
2906 (and (eq (preceding-char) ?\})
2907 (cperl-after-block-and-statement-beg
2909 (get-text-property (point) 'first-format-line)))
2910 ;; This line is continuation of preceding line's statement;
2911 ;; indent `cperl-continued-statement-offset' more than the
2912 ;; previous line of the statement.
2914 ;; There might be a label on this line, just
2915 ;; consider it bad style and ignore it.
2917 (cperl-backward-to-start-of-continued-exp containing-sexp)
2918 (vector 'continuation (point) char-after is-block delim))
2919 ;; This line starts a new statement.
2920 ;; Position following last unclosed open brace
2921 (goto-char containing-sexp)
2922 ;; Is line first statement after an open-brace?
2924 ;; If no, find that first statement and indent like
2925 ;; it. If the first statement begins with label, do
2926 ;; not believe when the indentation of the label is too
2930 (let ((colon-line-end 0))
2932 (progn (skip-chars-forward " \t\n")
2933 ;; s: foo : bar :x is NOT label
2934 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
2935 (not (looking-at "[sym]:\\|tr:"))))
2936 ;; Skip over comments and labels following openbrace.
2937 (cond ((= (following-char) ?\#)
2939 ((= (following-char) ?\=)
2941 (or (next-single-property-change (point) 'in-pod)
2942 (point-max)))) ; do not loop if no syntaxification
2945 (setq colon-line-end (point-at-eol))
2946 (search-forward ":"))))
2947 ;; We are at beginning of code (NOT label or comment)
2948 ;; First, the following code counts
2949 ;; if it is before the line we want to indent.
2950 (and (< (point) indent-point)
2951 (vector 'have-prev-sibling (point) colon-line-end
2954 ;; If no previous statement,
2955 ;; indent it relative to line brace is on.
2957 ;; For open-braces not the first thing in a line,
2958 ;; add in cperl-brace-imaginary-offset.
2960 ;; If first thing on a line: ?????
2961 ;; Move back over whitespace before the openbrace.
2962 (setq ; brace first thing on a line
2963 old-indent (progn (skip-chars-backward " \t") (bolp)))
2964 ;; Should we indent w.r.t. earlier than start?
2965 ;; Move to start of control group, possibly on a different line
2966 (or cperl-indent-wrt-brace
2967 (cperl-backward-to-noncomment (point-min)))
2968 ;; If the openbrace is preceded by a parenthesized exp,
2969 ;; move to the beginning of that;
2970 (if (eq (preceding-char) ?\))
2973 (cperl-backward-to-noncomment (point-min))))
2974 ;; In the case it starts a subroutine, indent with
2975 ;; respect to `sub', not with respect to the
2976 ;; first thing on the line, say in the case of
2977 ;; anonymous sub in a hash.
2978 (if (and;; Is it a sub in group starting on this line?
2979 (cond ((get-text-property (point) 'attrib-group)
2980 (goto-char (cperl-beginning-of-property
2981 (point) 'attrib-group)))
2982 ((eq (preceding-char) ?b)
2984 (looking-at "sub\\>")))
2985 (setq p (nth 1 ; start of innermost containing list
2990 (goto-char (1+ p)) ; enclosing block on the same line
2991 (skip-chars-forward " \t")
2992 (vector 'code-start-in-block containing-sexp char-after
2993 (and delim (not is-block)) ; is a HASH
2994 old-indent ; brace first thing on a line
2995 t (point) ; have something before...
2999 ;; Get initial indentation of the line we are on.
3000 ;; If line starts with label, calculate label indentation
3001 (vector 'code-start-in-block containing-sexp char-after
3002 (and delim (not is-block)) ; is a HASH
3003 old-indent ; brace first thing on a line
3004 nil (point))))))))))))))) ; nothing interesting before
3006 (defvar cperl-indent-rules-alist
3007 '((pod nil) ; via `syntax-type' property
3008 (here-doc nil) ; via `syntax-type' property
3009 (here-doc-delim nil) ; via `syntax-type' property
3010 (format nil) ; via `syntax-type' property
3011 (in-pod nil) ; via `in-pod' property
3012 (comment-special:at-beginning-of-line nil)
3015 "Alist of indentation rules for CPerl mode.
3018 number: add this amount of indentation.")
3020 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3021 "Return appropriate indentation for current line as Perl code.
3022 In usual case returns an integer: the column to indent to.
3023 Returns nil if line starts inside a string, t if in a comment.
3025 Will not correct the indentation for labels, but will correct it for braces
3026 and closing parentheses and brackets."
3027 ;; This code is still a broken architecture: in some cases we need to
3028 ;; compensate for some modifications which `cperl-indent-line' will add later
3030 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3032 ;;((or (null i) (eq i t) (numberp i))
3035 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3037 (what (cadr what)) ; Load from table
3039 ;; Indenters for regular expressions with //x and qw()
3041 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3042 (goto-char (elt i 1))
3043 (condition-case nil ; Use indentation of the 1st part
3046 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3047 (cond ;;; [indentable terminator start-pos is-block]
3048 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3049 (goto-char (elt i 2)) ; After opening parens
3050 (1- (current-column)))
3051 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3052 (goto-char (elt i 2))
3053 (+ (or cperl-regexp-indent-step cperl-indent-level)
3056 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3057 ;; Indent as the level after closing parens
3058 (goto-char (elt i 2)) ; indent line
3059 (skip-chars-forward " \t)") ; Skip closing parens
3061 (goto-char (elt i 3)) ; previous line
3062 (skip-chars-forward " \t)") ; Skip closing parens
3063 ;; Number of parens in between:
3064 (setq p (nth 0 (parse-partial-sexp (point) p))
3065 what (elt i 4)) ; First char on current line
3066 (goto-char (elt i 3)) ; previous line
3067 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3068 (cond ((eq what ?\) )
3069 (- cperl-close-paren-offset)) ; compensate
3071 (- (or cperl-regexp-indent-step cperl-indent-level)))
3073 (if (eq (following-char) ?\| )
3074 (or cperl-regexp-indent-step cperl-indent-level)
3078 (error "Unrecognized value of indent: %s" i))))
3080 ;; Indenter for stuff at toplevel
3082 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3083 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3084 (goto-char (elt i 1)) ; start = Good place to start parsing
3085 (- (current-indentation) ;
3086 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3087 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3088 ;; Look at previous line that's at column 0
3089 ;; to determine whether we are in top-level decls
3090 ;; or function's arg decls. Set basic-indent accordingly.
3091 ;; Now add a little if this is a continuation line.
3092 (if (elt i 3) ; state (XXX What is the semantic???)
3094 cperl-continued-statement-offset)))
3096 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3098 ((eq 'in-parens (elt i 0))
3099 ;; in-parens char-after old-indent-point is-brace containing-sexp
3101 ;; group is an expression, not a block:
3102 ;; indent to just after the surrounding open parens,
3103 ;; skip blanks if we do not close the expression.
3105 (goto-char (elt i 2)) ; old-indent-point
3107 (if (and (elt i 3) ; is-brace
3108 (eq (elt i 1) ?\})) ; char-after
3109 ;; Correct indentation of trailing ?\}
3110 (+ cperl-indent-level cperl-close-paren-offset)
3113 ;; Indenter for continuation lines
3115 ((eq 'continuation (elt i 0))
3116 ;; [continuation statement-start char-after is-block is-brace]
3117 (goto-char (elt i 1)) ; statement-start
3118 (+ (if (memq (elt i 2) (append "}])" nil)) ; char-after
3120 cperl-continued-statement-offset)
3121 (if (or (elt i 3) ; is-block
3122 (not (elt i 4)) ; is-brace
3123 (not (eq (elt i 2) ?\}))) ; char-after
3125 ;; Now it is a hash reference
3126 (+ cperl-indent-level cperl-close-paren-offset))
3127 ;; Labels do not take :: ...
3128 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
3129 (if (> (current-indentation) cperl-min-label-indent)
3130 (- (current-indentation) cperl-label-offset)
3131 ;; Do not move `parse-data', this should
3132 ;; be quick anyway (this comment comes
3133 ;; from different location):
3134 (cperl-calculate-indent))
3136 (if (eq (elt i 2) ?\{) ; char-after
3137 cperl-continued-brace-offset 0)))
3139 ;; Indenter for lines in a block which are not leading lines
3141 ((eq 'have-prev-sibling (elt i 0))
3142 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
3143 (goto-char (elt i 1)) ; sibling-beg
3144 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
3145 (if (> (current-indentation)
3146 cperl-min-label-indent)
3147 (- (current-indentation) cperl-label-offset)
3148 ;; Do not believe: `max' was involved in calculation of indent
3149 (+ cperl-indent-level
3151 (goto-char (elt i 3)) ; block-start
3152 (current-indentation))))
3155 ;; Indenter for the first line in a block
3157 ((eq 'code-start-in-block (elt i 0))
3158 ;;[code-start-in-block before-brace char-after
3159 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3160 ;; group-starts-before-start-of-sub start-of-control-group]
3161 (goto-char (elt i 1))
3162 ;; For open brace in column zero, don't let statement
3163 ;; start there too. If cperl-indent-level=0,
3164 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3165 (+ (if (and (bolp) (zerop cperl-indent-level))
3166 (+ cperl-brace-offset cperl-continued-statement-offset)
3168 (if (and (elt i 3) ; is-a-HASH-ref
3169 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3170 (+ cperl-indent-level cperl-close-paren-offset)
3172 ;; Unless openbrace is the first nonwhite thing on the line,
3173 ;; add the cperl-brace-imaginary-offset.
3174 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3175 cperl-brace-imaginary-offset)
3177 (goto-char (elt i 6)) ; start-of-control-group
3178 (if (elt i 5) ; group-starts-before-start-of-sub
3180 ;; Get initial indentation of the line we are on.
3181 ;; If line starts with label, calculate label indentation
3184 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3185 (if (> (current-indentation) cperl-min-label-indent)
3186 (- (current-indentation) cperl-label-offset)
3187 ;; Do not move `parse-data', this should
3189 (cperl-calculate-indent))
3190 (current-indentation))))))
3192 (error "Unrecognized value of indent: %s" i))))
3194 (error "Got strange value of indent: %s" i))))))
3196 (defun cperl-calculate-indent-within-comment ()
3197 "Return the indentation amount for line, assuming that
3198 the current line is to be regarded as part of a block comment."
3199 (let (end star-start)
3202 (skip-chars-forward " \t")
3204 (and (= (following-char) ?#)
3206 (cperl-to-comment-or-eol)
3212 (defun cperl-to-comment-or-eol ()
3213 "Go to position before comment on the current line, or to end of line.
3214 Returns true if comment is found. In POD will not move the point."
3215 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3216 ;; then looks for literal # or end-of-line.
3217 (let (state stop-in cpoint (lim (point-at-eol)) pr e)
3218 (or cperl-font-locking
3219 (cperl-update-syntaxification lim lim))
3221 (if (setq pr (get-text-property (point) 'syntax-type))
3222 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3223 (if (or (eq pr 'pod)
3224 (if (or (not e) (> e lim)) ; deep inside a group
3225 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
3226 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
3227 ;; Else - need to do it the hard way
3228 (and (and e (<= e lim))
3230 (while (not stop-in)
3231 (setq state (parse-partial-sexp (point) lim nil nil nil t))
3233 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3234 (if (nth 4 state) ; After `#';
3235 ; (nth 2 state) can be
3236 ; beginning of m,s,qq and so
3240 (setq cpoint (point))
3241 (goto-char (nth 2 state))
3243 ((looking-at "\\(s\\|tr\\)\\>")
3244 (or (re-search-forward
3245 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
3248 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
3249 (or (re-search-forward
3250 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
3253 (t ; It was fair comment
3254 (setq stop-in t) ; Finish
3255 (goto-char (1- cpoint)))))
3256 (setq stop-in t) ; Finish
3258 (setq stop-in t))) ; Finish
3261 (defsubst cperl-modify-syntax-type (at how)
3262 (if (< at (point-max))
3264 (put-text-property at (1+ at) 'syntax-table how)
3265 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
3267 (defun cperl-protect-defun-start (s e)
3268 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
3271 (while (re-search-forward "^\\s(" e 'to-end)
3272 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3274 (defun cperl-commentify (bb e string &optional noface)
3275 (if cperl-use-syntax-table-text-property
3276 (if (eq noface 'n) ; Only immediate
3278 ;; We suppose that e is _after_ the end of construction, as after eol.
3279 (setq string (if string cperl-st-sfence cperl-st-cfence))
3281 ;; one-char string/comment?!
3282 (cperl-modify-syntax-type bb cperl-st-punct)
3283 (cperl-modify-syntax-type bb string)
3284 (cperl-modify-syntax-type (1- e) string))
3285 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
3286 (put-text-property (1+ bb) (1- e)
3287 'syntax-table cperl-string-syntax-table))
3288 (cperl-protect-defun-start bb e))
3291 (not cperl-pod-here-fontify)
3292 (put-text-property bb e 'face (if string 'font-lock-string-face
3293 'font-lock-comment-face)))))
3295 (defvar cperl-starters '(( ?\( . ?\) )
3300 (defun cperl-cached-syntax-table (st)
3301 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3302 All the entries of the syntax table are \".\", except for a backslash, which
3306 (setcar st (make-syntax-table))
3310 (modify-syntax-entry i "." st)
3312 (modify-syntax-entry ?\\ "\\" st)
3315 (defun cperl-forward-re (lim end is-2arg st-l err-l argument
3316 &optional ostart oend)
3317 "Find the end of a regular expression or a stringish construct (q[] etc).
3318 The point should be before the starting delimiter.
3320 Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3321 is s/// or tr/// like expression. If END is nil, generates an error
3322 message if needed. If SET-ST is non-nil, will use (or generate) a
3323 cached syntax table in ST-L. If ERR-L is non-nil, will store the
3324 error message in its CAR (unless it already contains some error
3325 message). ARGUMENT should be the name of the construct (used in error
3326 messages). OSTART, OEND may be set in recursive calls when processing
3327 the second argument of 2ARG construct.
3329 Works *before* syntax recognition is done. In IS-2ARG situation may
3330 modify syntax-type text property if the situation is too hard."
3331 (let (b starter ender st i i2 go-forward reset-st set-st)
3332 (skip-chars-forward " \t")
3333 ;; ender means matching-char matcher.
3335 starter (if (eobp) 0 (char-after b))
3336 ender (cdr (assoc starter cperl-starters)))
3337 ;; What if starter == ?\\ ????
3338 (setq st (cperl-cached-syntax-table st-l))
3340 ;; Whether we have an intermediate point
3342 ;; Prepare the syntax table:
3343 (if (not ender) ; m/blah/, s/x//, s/x/y/
3344 (modify-syntax-entry starter "$" st)
3345 (modify-syntax-entry starter (concat "(" (list ender)) st)
3346 (modify-syntax-entry ender (concat ")" (list starter)) st))
3349 ;; We use `$' syntax class to find matching stuff, but $$
3350 ;; is recognized the same as $, so we need to check this manually.
3351 (if (and (eq starter (char-after (cperl-1+ b)))
3353 ;; $ has TeXish matching rules, so $$ equiv $...
3355 (setq reset-st (syntax-table))
3356 (set-syntax-table st)
3358 (if (<= (point) (1+ b))
3359 (error "Unfinished regular expression"))
3360 (set-syntax-table reset-st)
3362 ;; Now the problem is with m;blah;;
3364 (eq (preceding-char)
3365 (char-after (- (point) 2)))
3368 (= 0 (% (skip-chars-backward "\\\\") 2)))
3370 ;; Now we are after the first part.
3371 (and is-2arg ; Have trailing part
3373 (eq (following-char) starter) ; Empty trailing part
3375 (or (eq (char-syntax (following-char)) ?.)
3376 ;; Make trailing letter into punctuation
3377 (cperl-modify-syntax-type (point) cperl-st-punct))
3378 (setq is-2arg nil go-forward t))) ; Ignore the tail
3379 (if is-2arg ; Not number => have second part
3381 (setq i (point) i2 i)
3383 (if (memq (following-char) '(?\s ?\t ?\n ?\f))
3385 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3386 (goto-char (match-end 0))
3387 (skip-chars-forward " \t\n\f"))
3390 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3391 (if ender (modify-syntax-entry ender "." st))
3393 (setq ender (cperl-forward-re lim end nil st-l err-l
3394 argument starter ender)
3395 ender (nth 2 ender)))))
3396 (error (goto-char lim)
3399 (set-syntax-table reset-st))
3401 (and cperl-brace-recursing
3405 "End of `%s%s%c ... %c' string/RE not found: %s"
3407 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3408 starter (or ender starter) bb)
3409 (or (car err-l) (setcar err-l b)))))
3412 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3413 (if ender (modify-syntax-entry ender "." st))))
3414 ;; i: have 2 args, after end of the first arg
3415 ;; i2: start of the second arg, if any (before delim if `ender').
3416 ;; ender: the last arg bounded by parens-like chars, the second one of them
3417 ;; starter: the starting delimiter of the first arg
3418 ;; go-forward: has 2 args, and the second part is empty
3419 (list i i2 ender starter go-forward)))
3421 (defun cperl-forward-group-in-re (&optional st-l)
3422 "Find the end of a group in a REx.
3423 Return the error message (if any). Does not work if delimiter is `)'.
3424 Works before syntax recognition is done."
3425 ;; Works *before* syntax recognition is done
3426 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3427 (let (st b reset-st)
3430 (setq st (cperl-cached-syntax-table st-l))
3431 (modify-syntax-entry ?\( "()" st)
3432 (modify-syntax-entry ?\) ")(" st)
3433 (setq reset-st (syntax-table))
3434 (set-syntax-table st)
3437 "cperl-forward-group-in-re: error %s" b)))
3438 ;; now restore the initial state
3441 (modify-syntax-entry ?\( "." st)
3442 (modify-syntax-entry ?\) "." st)))
3444 (set-syntax-table reset-st))
3448 (defvar font-lock-string-face)
3449 ;;(defvar font-lock-reference-face)
3450 (defvar font-lock-constant-face)
3451 (defsubst cperl-postpone-fontification (b e type val &optional now)
3452 ;; Do after syntactic fontification?
3453 (if cperl-syntaxify-by-font-lock
3454 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3455 (put-text-property b e type val)))
3457 ;;; Here is how the global structures (those which cannot be
3458 ;;; recognized locally) are marked:
3460 ;; Start-to-end is marked `in-pod' ==> t
3461 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3462 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3464 ;; Start-to-end is marked `here-doc-group' ==> t
3465 ;; The body is marked `syntax-type' ==> `here-doc'
3466 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3468 ;; First line (to =) marked `first-format-line' ==> t
3469 ;; After-this--to-end is marked `syntax-type' ==> `format'
3470 ;; d) 'Q'uoted string:
3471 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3472 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3473 ;; second part of s///e is marked `syntax-type' ==> `multiline'
3474 ;; e) Attributes of subroutines: `attrib-group' ==> t
3475 ;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3476 ;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3478 ;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3479 ;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
3481 (defun cperl-unwind-to-safe (before &optional end)
3482 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3483 (let ((pos (point)) opos)
3484 (while (and pos (progn
3486 (get-text-property (setq pos (point)) 'syntax-type)))
3488 pos (cperl-beginning-of-property pos 'syntax-type))
3489 (if (eq pos (point-min))
3494 (goto-char (cperl-1- pos))
3497 (goto-char (setq pos (cperl-1- pos))))
3499 (goto-char (point-min))))
3501 (and (looking-at "\n*=")
3502 (/= 0 (skip-chars-backward "\n"))
3506 ;; Do the same for end, going small steps
3508 (while (and end (get-text-property end 'syntax-type))
3510 end (next-single-property-change end 'syntax-type nil (point-max)))
3511 (if end (progn (goto-char end)
3512 (or (bolp) (forward-line 1))
3513 (setq end (point)))))
3516 ;;; These are needed for byte-compile (at least with v19)
3517 (defvar cperl-nonoverridable-face)
3518 (defvar font-lock-variable-name-face)
3519 (defvar font-lock-function-name-face)
3520 (defvar font-lock-keyword-face)
3521 (defvar font-lock-builtin-face)
3522 (defvar font-lock-type-face)
3523 (defvar font-lock-comment-face)
3524 (defvar font-lock-warning-face)
3526 (defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
3527 "Syntaxically mark (and fontify) attributes of a subroutine.
3528 Should be called with the point before leading colon of an attribute."
3529 ;; Works *before* syntax recognition is done
3530 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3531 (let (st b p reset-st after-first (start (point)) start1 end1)
3535 "\\(" ; 1=optional? colon
3536 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3538 (if after-first "?" "")
3539 ;; No space between name and paren allowed...
3540 "\\(\\sw+\\)" ; 3=name
3541 "\\((\\)?")) ; 4=optional paren
3542 (and (match-beginning 1)
3543 (cperl-postpone-fontification
3544 (match-beginning 0) (cperl-1+ (match-beginning 0))
3545 'face font-lock-constant-face))
3546 (setq start1 (match-beginning 3) end1 (match-end 3))
3547 (cperl-postpone-fontification start1 end1
3548 'face font-lock-constant-face)
3549 (goto-char end1) ; end or before `('
3550 (if (match-end 4) ; Have attribute arguments...
3553 (setq st (cperl-cached-syntax-table st-l))
3554 (modify-syntax-entry ?\( "()" st)
3555 (modify-syntax-entry ?\) ")(" st))
3556 (setq reset-st (syntax-table) p (point))
3557 (set-syntax-table st)
3559 (set-syntax-table reset-st)
3561 (cperl-commentify p (point) t))) ; mark as string
3562 (forward-comment (buffer-size))
3563 (setq after-first t))
3565 "L%d: attribute `%s': %s"
3566 (count-lines (point-min) (point))
3567 (and start1 end1 (buffer-substring start1 end1)) b)
3571 (put-text-property start (point)
3572 'attrib-group (if (looking-at "{") t 0))
3574 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3575 ;; Apparently, we do not need `multiline': faces added now
3576 (put-text-property (+ 3 pos) (cperl-1+ (point))
3577 'syntax-type 'sub-decl))
3578 (and b-fname ; Fontify here: the following condition
3579 (cperl-postpone-fontification ; is too hard to determine by
3580 b-fname e-fname 'face ; a REx, so do it here
3581 (if (looking-at "{")
3582 font-lock-function-name-face
3583 font-lock-variable-name-face)))))
3584 ;; now restore the initial state
3587 (modify-syntax-entry ?\( "." st)
3588 (modify-syntax-entry ?\) "." st)))
3590 (set-syntax-table reset-st))))
3592 (defsubst cperl-look-at-leading-count (is-x-REx e)
3595 (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
3596 (1- e) t)) ; return nil on failure, no moving
3597 (if (eq ?\{ (preceding-char)) nil
3598 (cperl-postpone-fontification
3599 (1- (point)) (point)
3600 'face font-lock-warning-face))))
3602 ;; Do some smarter-highlighting
3603 ;; XXXX Currently ignores alphanum/dash delims,
3604 (defsubst cperl-highlight-charclass (endbracket dashface bsface onec-space)
3605 (let ((l '(1 5 7)) ll lle lll
3606 ;; 2 groups, the first takes the whole match (include \[trnfabe])
3607 (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{[^{}]*}" "\\)")))
3608 (while ; look for unescaped - between non-classes
3610 ;; On 19.33, certain simplifications lead
3611 ;; to bugs (as in [^a-z] \\| [trnfabe] )
3612 (concat ; 1: SingleChar (include \[trnfabe])
3614 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^cdg-mo-qsu-zA-Z0-9_]" "\\|" "\\\\c." "\\|" "\\\\x" "\\([0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}\\)" "\\|" "\\\\0?[0-7][0-7]?[0-7]?" "\\|" "\\\\N{[^{}]*}" "\\)"
3615 "\\(" ; 3: DASH SingleChar (match optionally)
3617 singleChar ; 5: SingleChar
3618 ;;"\\(" "[^\\\\]" "\\|" "\\\\[^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{[^{}]*}" "\\)"
3621 "\\(" ; 7: other escapes
3622 "\\\\[pP]" "\\([^{]\\|{[^{}]*}\\)"
3623 "\\|" "\\\\[^pP]" "\\)"
3626 (if (match-beginning 4)
3627 (cperl-postpone-fontification
3628 (match-beginning 4) (match-end 4)
3630 ;; save match data (for looking-at)
3631 (setq lll (mapcar (function (lambda (elt) (cons (match-beginning elt)
3632 (match-end elt)))) l))
3637 ;; (message "Got %s of %s" ll l)
3638 (if (and ll (eq (char-after ll) ?\\ ))
3641 (cperl-postpone-fontification ll (1+ ll)
3643 (if (looking-at "\\\\[a-zA-Z0-9]")
3644 (cperl-postpone-fontification (1+ ll) lle
3645 'face onec-space))))
3646 (setq lll (cdr lll))))
3647 (goto-char endbracket) ; just in case something misbehaves???
3650 ;;; Debugging this may require (setq max-specpdl-size 2000)...
3651 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
3652 "Scans the buffer for hard-to-parse Perl constructions.
3653 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3654 the sections using `cperl-pod-head-face', `cperl-pod-face',
3657 (or min (setq min (point-min)
3658 cperl-syntax-state nil
3659 cperl-syntax-done-to min))
3660 (or max (setq max (point-max)))
3661 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3662 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3663 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
3664 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3665 (modified (buffer-modified-p)) overshoot is-o-REx name
3666 (after-change-functions nil)
3667 (cperl-font-locking t)
3668 (use-syntax-state (and cperl-syntax-state
3669 (>= min (car cperl-syntax-state))))
3670 (state-point (if use-syntax-state
3671 (car cperl-syntax-state)
3673 (state (if use-syntax-state
3674 (cdr cperl-syntax-state)))
3675 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3676 (st-l (list nil)) (err-l (list nil))
3677 ;; Somehow font-lock may be not loaded yet...
3678 ;; (e.g., when building TAGS via command-line call)
3679 (font-lock-string-face (if (boundp 'font-lock-string-face)
3680 font-lock-string-face
3681 'font-lock-string-face))
3682 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
3683 font-lock-constant-face
3684 'font-lock-constant-face))
3685 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
3686 (if (boundp 'font-lock-function-name-face)
3687 font-lock-function-name-face
3688 'font-lock-function-name-face))
3689 (font-lock-variable-name-face ; interpolated vars and ({})-code
3690 (if (boundp 'font-lock-variable-name-face)
3691 font-lock-variable-name-face
3692 'font-lock-variable-name-face))
3693 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3694 (if (boundp 'font-lock-function-name-face)
3695 font-lock-function-name-face
3696 'font-lock-function-name-face))
3697 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3698 (if (boundp 'font-lock-constant-face)
3699 font-lock-constant-face
3700 'font-lock-constant-face))
3701 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3702 (if (boundp 'font-lock-builtin-face)
3703 font-lock-builtin-face
3704 'font-lock-builtin-face))
3705 (font-lock-comment-face
3706 (if (boundp 'font-lock-comment-face)
3707 font-lock-comment-face
3708 'font-lock-comment-face))
3709 (font-lock-warning-face
3710 (if (boundp 'font-lock-warning-face)
3711 font-lock-warning-face
3712 'font-lock-warning-face))
3713 (my-cperl-REx-ctl-face ; (|)
3714 (if (boundp 'font-lock-keyword-face)
3715 font-lock-keyword-face
3716 'font-lock-keyword-face))
3717 (my-cperl-REx-modifiers-face ; //gims
3718 (if (boundp 'cperl-nonoverridable-face)
3719 cperl-nonoverridable-face
3720 'cperl-nonoverridable-face))
3721 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3722 (if (boundp 'font-lock-type-face)
3724 'font-lock-type-face))
3725 (stop-point (if ignore-max
3730 "\\(\\`\n?\\|^\n\\)=" ; POD
3732 ;; One extra () before this:
3735 ;; First variant "BLAH" or just ``.
3736 "[ \t]*" ; Yes, whitespace is allowed!
3737 "\\([\"'`]\\)" ; 2 + 1 = 3
3738 "\\([^\"'`\n]*\\)" ; 3 + 1
3741 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3742 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3743 ;; Do not have <<= or << 30 or <<30 or << $blah.
3744 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3745 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3748 ;; 1+6 extra () before this:
3749 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
3750 (if cperl-use-syntax-table-text-property
3753 ;; 1+6+2=9 extra () before this:
3754 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
3756 ;; 1+6+2+1=10 extra () before this:
3757 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3759 ;; 1+6+2+1+1=11 extra () before this
3760 "\\<sub\\>" ; sub with proto/attr
3762 cperl-white-and-comment-rex
3763 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
3765 cperl-maybe-white-and-comment-rex
3766 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
3768 ;; 1+6+2+1+1+6=17 extra () before this:
3769 "\\$\\(['{]\\)" ; $' or ${foo}
3771 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3772 ;; we do not support intervening comments...):
3773 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3774 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
3776 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
3777 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
3779 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
3785 (message "Scanning for \"hard\" Perl constructions..."))
3786 ;;(message "find: %s --> %s" min max)
3787 (and cperl-pod-here-fontify
3788 ;; We had evals here, do not know why...
3789 (setq face cperl-pod-face
3790 head-face cperl-pod-head-face
3791 here-face cperl-here-face))
3792 (remove-text-properties min max
3793 '(syntax-type t in-pod t syntax-table t
3804 ;; Need to remove face as well...
3806 ;; 'emx not supported by Emacs since at least 21.1.
3807 (and (featurep 'xemacs) (eq system-type 'emx)
3809 (let ((case-fold-search t))
3810 (looking-at "extproc[ \t]")) ; Analogue of #!
3811 (cperl-commentify min
3816 (re-search-forward search max t))
3817 (setq tmpend nil) ; Valid for most cases
3818 (setq b (match-beginning 0)
3819 state (save-excursion (parse-partial-sexp
3820 state-point b nil nil state))
3823 ;; 1+6+2+1+1+6=17 extra () before this:
3825 ((match-beginning 18) ; $' or ${foo}
3826 (if (eq (preceding-char) ?\') ; $'
3828 (setq b (1- (point))
3829 state (parse-partial-sexp
3830 state-point (1- b) nil nil state)
3832 (if (nth 3 state) ; in string
3833 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3836 (setq bb (match-beginning 0))
3837 (cperl-modify-syntax-type bb cperl-st-punct)))
3838 ;; No processing in strings/comments beyond this point:
3839 ((or (nth 3 state) (nth 4 state))
3840 t) ; Do nothing in comment/string
3841 ((match-beginning 1) ; POD section
3842 ;; "\\(\\`\n?\\|^\n\\)="
3843 (setq b (match-beginning 0)
3844 state (parse-partial-sexp
3845 state-point b nil nil state)
3847 (if (or (nth 3 state) (nth 4 state)
3848 (looking-at "cut\\>"))
3849 (if (or (nth 3 state) (nth 4 state) ignore-max)
3850 nil ; Doing a chunk only
3851 (message "=cut is not preceded by a POD section")
3852 (or (car err-l) (setcar err-l (point))))
3857 tb (match-beginning 0)
3858 b1 nil) ; error condition
3859 ;; We do not search to max, since we may be called from
3860 ;; some hook of fontification, and max is random
3861 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
3864 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3866 (message "=cut is not preceded by an empty line")
3868 (or (car err-l) (setcar err-l b))))))
3869 (beginning-of-line 2) ; An empty line after =cut is not POD!
3873 (remove-text-properties
3874 max e '(syntax-type t in-pod t syntax-table t
3886 (put-text-property b e 'in-pod t)
3887 (put-text-property b e 'syntax-type 'in-pod)
3889 (while (re-search-forward "\n\n[ \t]" e t)
3890 ;; We start 'pod 1 char earlier to include the preceding line
3892 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3893 (cperl-put-do-not-fontify b (point) t)
3894 ;; mark the non-literal parts as PODs
3895 (if cperl-pod-here-fontify
3896 (cperl-postpone-fontification b (point) 'face face t))
3897 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3900 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3901 (cperl-put-do-not-fontify (point) e t)
3902 (if cperl-pod-here-fontify
3904 ;; mark the non-literal parts as PODs
3905 (cperl-postpone-fontification (point) e 'face face t)
3908 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3910 (cperl-postpone-fontification
3911 (match-beginning 1) (match-end 1)
3913 (while (re-search-forward
3915 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3918 (cperl-postpone-fontification
3919 (match-beginning 1) (match-end 1)
3921 (cperl-commentify bb e nil)
3923 (or (eq e (point-max))
3924 (forward-char -1)))) ; Prepare for immediate POD start.
3926 ;; We can do many here-per-line;
3927 ;; but multiline quote on the same line as <<HERE confuses us...
3928 ;; ;; One extra () before this:
3931 ;; ;; First variant "BLAH" or just ``.
3932 ;; "[ \t]*" ; Yes, whitespace is allowed!
3933 ;; "\\([\"'`]\\)" ; 2 + 1
3934 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3937 ;; ;; Second variant: Identifier or \ID or empty
3938 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3939 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3940 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3941 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3943 ((match-beginning 2) ; 1 + 1
3945 tb (match-beginning 0)
3946 c (and ; not HERE-DOC
3949 (or (looking-at "[ \t]*(") ; << function_call()
3950 (save-excursion ; 1 << func_name, or $foo << 10
3954 ;;; XXX What to do: foo <<bar ???
3955 ;;; XXX Need to support print {a} <<B ???
3958 ; $foo << b; $f .= <<B;
3959 ; ($f+1) << b; a($f) . <<B;
3960 ; foo 1, <<B; $x{a} <<b;
3962 ((looking-at "[0-9$({]")
3965 (looking-at "[ \t]*<<")
3971 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
3973 (error nil))) ; func(<<EOF)
3974 (and (not (match-beginning 6)) ; Empty
3976 "[ \t]*[=0-9$@%&(]"))))))
3977 (if c ; Not here-doc
3979 (setq c (match-end 2)) ; 1 + 1
3980 (if (match-beginning 5) ;4 + 1
3981 (setq b1 (match-beginning 5) ; 4 + 1
3982 e1 (match-end 5)) ; 4 + 1
3983 (setq b1 (match-beginning 4) ; 3 + 1
3984 e1 (match-end 4))) ; 3 + 1
3985 (setq tag (buffer-substring b1 e1)
3986 qtag (regexp-quote tag))
3987 (cond (cperl-pod-here-fontify
3988 ;; Highlight the starting delimiter
3989 (cperl-postpone-fontification
3990 b1 e1 'face my-cperl-delimiters-face)
3991 (cperl-put-do-not-fontify b1 e1 t)))
3995 (goto-char end-of-here-doc))
3997 ;; We do not search to max, since we may be called from
3998 ;; some hook of fontification, and max is random
3999 (or (and (re-search-forward (concat "^" qtag "$")
4001 ;;;(eq (following-char) ?\n) ; XXXX WHY???
4003 (progn ; Pretend we matched at the end
4004 (goto-char (point-max))
4005 (re-search-forward "\\'")
4006 (message "End of here-document `%s' not found." tag)
4007 (or (car err-l) (setcar err-l b))))
4008 (if cperl-pod-here-fontify
4010 ;; Highlight the ending delimiter
4011 (cperl-postpone-fontification
4012 (match-beginning 0) (match-end 0)
4013 'face my-cperl-delimiters-face)
4014 (cperl-put-do-not-fontify b (match-end 0) t)
4015 ;; Highlight the HERE-DOC
4016 (cperl-postpone-fontification b (match-beginning 0)
4018 (setq e1 (cperl-1+ (match-end 0)))
4019 (put-text-property b (match-beginning 0)
4020 'syntax-type 'here-doc)
4021 (put-text-property (match-beginning 0) e1
4022 'syntax-type 'here-doc-delim)
4023 (put-text-property b e1 'here-doc-group t)
4024 ;; This makes insertion at the start of HERE-DOC update
4025 ;; the whole construct:
4026 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
4027 (cperl-commentify b e1 nil)
4028 (cperl-put-do-not-fontify b (match-end 0) t)
4029 ;; Cache the syntax info...
4030 (setq cperl-syntax-state (cons state-point state))
4031 ;; ... and process the rest of the line...
4033 (elt ; non-inter ignore-max
4034 (cperl-find-pods-heres c i t end t e1) 1))
4035 (if (and overshoot (> overshoot (point)))
4036 (goto-char overshoot)
4037 (setq overshoot e1))
4041 ((match-beginning 8)
4042 ;; 1+6=7 extra () before this:
4043 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
4045 name (if (match-beginning 8) ; 7 + 1
4046 (buffer-substring (match-beginning 8) ; 7 + 1
4047 (match-end 8)) ; 7 + 1
4049 tb (match-beginning 0))
4051 (put-text-property (point-at-bol) b 'first-format-line 't)
4052 (if cperl-pod-here-fontify
4053 (while (and (eq (forward-line) 0)
4054 (not (looking-at "^[.;]$")))
4056 ((looking-at "^#")) ; Skip comments
4057 ((and argument ; Skip argument multi-lines
4058 (looking-at "^[ \t]*{"))
4060 (setq argument nil))
4061 (argument ; Skip argument lines
4062 (setq argument nil))
4065 (setq argument (looking-at "^[^\n]*[@^]"))
4067 ;; Highlight the format line
4068 (cperl-postpone-fontification b1 (point)
4069 'face font-lock-string-face)
4070 (cperl-commentify b1 (point) nil)
4071 (cperl-put-do-not-fontify b1 (point) t))))
4072 ;; We do not search to max, since we may be called from
4073 ;; some hook of fontification, and max is random
4074 (re-search-forward "^[.;]$" stop-point 'toend))
4076 (if (looking-at "^\\.$") ; ";" is not supported yet
4078 ;; Highlight the ending delimiter
4079 (cperl-postpone-fontification (point) (+ (point) 2)
4080 'face font-lock-string-face)
4081 (cperl-commentify (point) (+ (point) 2) nil)
4082 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
4083 (message "End of format `%s' not found." name)
4084 (or (car err-l) (setcar err-l b)))
4088 (put-text-property b (point) 'syntax-type 'format))
4089 ;; qq-like String or Regexp:
4090 ((or (match-beginning 10) (match-beginning 11))
4091 ;; 1+6+2=9 extra () before this:
4092 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
4094 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
4095 (setq b1 (if (match-beginning 10) 10 11)
4096 argument (buffer-substring
4097 (match-beginning b1) (match-end b1))
4098 b (point) ; end of qq etc
4100 c (char-after (match-beginning b1))
4101 bb (char-after (1- (match-beginning b1))) ; tmp holder
4102 ;; bb == "Not a stringy"
4103 bb (if (eq b1 10) ; user variables/whatever
4104 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4105 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4106 ((eq bb ?\:) ; $opt::s
4108 (- (match-beginning b1) 2))
4110 ((eq bb ?\>) ; $foo->s
4112 (- (match-beginning b1) 2))
4115 (not (eq (char-after ; &&m/blah/
4116 (- (match-beginning b1) 2))
4119 ;; <file> or <$file>
4121 ;; Do not stringify <FH>, <$fh> :
4124 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
4125 tb (match-beginning 0))
4126 (goto-char (match-beginning b1))
4127 (cperl-backward-to-noncomment (point-min))
4129 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
4134 ;; What is below: regexp-p?
4136 (or (memq (preceding-char)
4137 (append (if (memq c '(?\? ?\<))
4140 "~{(=|&+-*!,;:[") nil))
4141 (and (eq (preceding-char) ?\})
4142 (cperl-after-block-p (point-min)))
4143 (and (eq (char-syntax (preceding-char)) ?w)
4146 ;; After these keywords `/' starts a RE. One should add all the
4147 ;; functions/builtins which expect an argument, but ...
4148 (if (eq (preceding-char) ?-)
4150 (looking-at "[a-zA-Z]\\>")
4152 (not (memq (preceding-char)
4155 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4156 (and (eq (preceding-char) ?.)
4157 (eq (char-after (- (point) 2)) ?.))
4159 ;; m|blah| ? foo : bar;
4162 cperl-use-syntax-table-text-property
4166 (looking-at "\\s|"))))))
4169 ;; Check for $a -> y
4170 (setq b1 (preceding-char)
4173 (eq (char-after (- go 2)) ?-))
4179 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4180 (goto-char (match-end 0))
4181 (skip-chars-forward " \t\n\f"))
4182 (cond ((and (eq (following-char) ?\})
4184 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4186 (skip-chars-backward " \t\n\f")
4187 (if (memq (preceding-char) (append "$@%&*" nil))
4193 (looking-at ; $foo -> {s}
4194 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
4195 (and ; $foo[12] -> {s}
4196 (memq (following-char) '(?\{ ?\[))
4199 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
4202 ((and (eq (following-char) ?=)
4203 (eq (char-after (1+ (point))) ?\>))
4204 ;; Check for { foo => 1, s => 2 }
4205 ;; Apparently s=> is never a substitution...
4207 ((and (eq (following-char) ?:)
4208 (eq b1 ?\{) ; Check for $ { s::bar }
4209 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
4212 (skip-chars-backward " \t\n\f")
4213 (memq (preceding-char)
4214 (append "$@%&*" nil))))
4220 ;; Skip whitespace and comments...
4221 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4222 (goto-char (match-end 0))
4223 (skip-chars-forward " \t\n\f"))
4225 (put-text-property b (point) 'syntax-type 'prestring))
4226 ;; qtag means two-arg matcher, may be reset to
4227 ;; 2 or 3 later if some special quoting is needed.
4228 ;; e1 means matching-char matcher.
4229 (setq b (point) ; before the first delimiter
4231 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
4232 ;; We do not search to max, since we may be called from
4233 ;; some hook of fontification, and max is random
4234 i (cperl-forward-re stop-point end
4236 st-l err-l argument)
4237 ;; If `go', then it is considered as 1-arg, `b1' is nil
4238 ;; as in s/foo//x; the point is before final "slash"
4239 b1 (nth 1 i) ; start of the second part
4240 tag (nth 2 i) ; ender-char, true if second part
4241 ; is with matching chars []
4242 go (nth 4 i) ; There is a 1-char part after the end
4243 i (car i) ; intermediate point
4245 ;; Before end of the second part if non-matching: ///
4246 tail (if (and i (not tag))
4248 e (if i i e1) ; end of the first part
4249 qtag nil ; need to preserve backslashitis
4250 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4251 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
4252 ;; Commenting \\ is dangerous, what about ( ?
4254 (eq (char-after i) ?\\)
4256 (and (if go (looking-at ".\\sw*x")
4257 (looking-at "\\sw*x")) ; qr//x
4259 (and (if go (looking-at ".\\sw*o")
4260 (looking-at "\\sw*o")) ; //o
4263 ;; Considered as 1arg form
4265 (cperl-commentify b (point) t)
4266 (put-text-property b (point) 'syntax-type 'string)
4268 ;; ignore other text properties:
4269 (string-match "^qw$" argument))
4270 (put-text-property b (point) 'indentable t))
4272 (setq e1 (cperl-1+ e1))
4275 (cperl-commentify b i t)
4276 (if (looking-at "\\sw*e") ; s///e
4278 ;; Cache the syntax info...
4279 (setq cperl-syntax-state (cons state-point state))
4282 (car (cperl-find-pods-heres b1 (1- (point)) t end))
4284 (goto-char (1+ max)))
4285 (if (and tag (eq (preceding-char) ?\>))
4287 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
4288 (cperl-modify-syntax-type i cperl-st-bra)))
4289 (put-text-property b i 'syntax-type 'string)
4290 (put-text-property i (point) 'syntax-type 'multiline)
4292 (put-text-property b i 'indentable t)))
4293 (cperl-commentify b1 (point) t)
4294 (put-text-property b (point) 'syntax-type 'string)
4296 (put-text-property b i 'indentable t))
4298 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
4300 ;; Now: tail: if the second part is non-matching without ///e
4301 (if (eq (char-syntax (following-char)) ?w)
4303 (forward-word 1) ; skip modifiers s///s
4304 (if tail (cperl-commentify tail (point) t))
4305 (cperl-postpone-fontification
4306 e1 (point) 'face my-cperl-REx-modifiers-face)))
4307 ;; Check whether it is m// which means "previous match"
4308 ;; and highlight differently
4310 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
4311 (or (not (= (length argument) 0))
4315 ;; split // *is* using zero-pattern
4321 (not (looking-at "split\\>")))
4323 (cperl-postpone-fontification
4324 b e 'face font-lock-warning-face)
4325 (if (or i2 ; Has 2 args
4326 (and cperl-fontify-m-as-s
4328 (string-match "^\\(m\\|qr\\)$" argument)
4329 (and (eq 0 (length argument))
4330 (not (eq ?\< (char-after b)))))))
4332 (cperl-postpone-fontification
4333 b (cperl-1+ b) 'face my-cperl-delimiters-face)
4334 (cperl-postpone-fontification
4335 (1- e) e 'face my-cperl-delimiters-face)))
4336 (if (and is-REx cperl-regexp-scan)
4337 ;; Process RExen: embedded comments, charclasses and ]
4338 ;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
4339 ;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4340 ;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
4341 ;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
4342 ;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4343 ;;;m^a[\^b]c^ + m.a[^b]\.c.;
4347 (cperl-look-at-leading-count is-x-REx e)
4351 (if (eq (char-after b) ?\#)
4352 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
4353 "\\((\\?#\\)\\|\\(#\\)")
4354 ;; keep the same count: add a fake group
4355 (if (eq (char-after b) ?\#)
4356 "\\((\\?\\\\#\\)\\(\\)"
4357 "\\((\\?#\\)\\(\\)"))
4363 ;; XXXX Will not be able to use it in s)))
4364 (if (eq (char-after b) ?\) )
4365 "\\())))\\)" ; Will never match
4366 (if (eq (char-after b) ?? )
4367 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
4368 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
4369 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
4370 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
4371 "\\(" ;; XXXX 1-char variables, exc. |()\s
4374 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4376 "{[^{}]*}" ; only one-level allowed
4380 "\\(" ;;8,9:code part of array/hash elt
4386 ;; XXXX: what if u is delim?
4394 "\\\\[luLUEQbBAzZG]"
4397 "\\(" ; 10 group opener follower
4398 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
4400 "\\?[:=!>?{]" ; "?" something
4402 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
4404 "\\?([0-9]+)" ; (?(1)foo|bar)
4412 "\\\\\\(.\\)" ; 12=\SYMBOL
4415 (and (< (point) (1- e))
4416 (re-search-forward hairy-RE (1- e) 'to-end))
4417 (goto-char (match-beginning 0))
4418 (setq REx-subgr-start (point)
4419 was-subgr (following-char))
4421 ((match-beginning 6) ; 0-length builtins, groups
4422 (goto-char (match-end 0))
4423 (if (match-beginning 11)
4424 (goto-char (match-beginning 11)))
4427 (cperl-postpone-fontification
4428 (match-beginning 0) (point)
4431 ((eq was-subgr ?\) )
4436 (if (if (eq (char-after b) ?? )
4437 (looking-at "(\\\\\\?")
4438 (eq (char-after (1+ (point))) ?\?))
4439 my-cperl-REx-0length-face
4440 my-cperl-REx-ctl-face)
4441 font-lock-warning-face))
4442 (error font-lock-warning-face)))
4443 ((eq was-subgr ?\| )
4444 my-cperl-REx-ctl-face)
4445 ((eq was-subgr ?\$ )
4446 (if (> (point) (1+ REx-subgr-start))
4449 (match-beginning 0) (point)
4452 (if (and (eq (match-beginning 0)
4456 font-lock-variable-name-face)
4457 my-cperl-REx-spec-char-face))
4458 ((memq was-subgr (append "^." nil) )
4459 my-cperl-REx-spec-char-face)
4460 ((eq was-subgr ?\( )
4461 (if (not (match-beginning 10))
4462 my-cperl-REx-ctl-face
4463 my-cperl-REx-0length-face))
4464 (t my-cperl-REx-0length-face)))
4465 (if (and (memq was-subgr (append "(|" nil))
4466 (not (string-match "(\\?[-imsx]+)"
4468 (cperl-look-at-leading-count is-x-REx e))
4469 (setq was-subgr nil)) ; We do stuff here
4470 ((match-beginning 12) ; \SYMBOL
4474 ;; How many chars to not highlight:
4475 ;; 0-len special-alnums in other branch =>
4476 ;; Generic: \non-alnum (1), \alnum (1+face)
4477 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
4478 (setq REx-subgr-start (point)
4479 qtag (preceding-char))
4480 (cperl-postpone-fontification
4481 (- (point) 2) (- (point) 1) 'face
4483 (append "ghijkmoqvFHIJKMORTVY" nil))
4484 font-lock-warning-face
4485 my-cperl-REx-0length-face))
4486 (if (and (eq (char-after b) qtag)
4487 (memq qtag (append ".])^$|*?+" nil)))
4489 (if (and cperl-use-syntax-table-text-property
4492 REx-subgr-start (1- (point))
4493 'syntax-table cperl-st-punct))
4494 (cperl-postpone-fontification
4495 (1- (point)) (point) 'face
4496 ; \] can't appear below
4497 (if (memq qtag (append ".]^$" nil))
4498 'my-cperl-REx-spec-char-face
4499 (if (memq qtag (append "*?+" nil))
4500 'my-cperl-REx-0length-face
4501 'my-cperl-REx-ctl-face))))) ; )|
4502 ;; Test for arguments:
4504 ;; This is not pretty: the 5.8.7 logic:
4505 ;; \0numx -> octal (up to total 3 dig)
4506 ;; \DIGIT -> backref unless \0
4507 ;; \DIGITs -> backref if valid
4508 ;; otherwise up to 3 -> octal
4509 ;; Do not try to distinguish, we guess
4510 ((or (and (memq qtag (append "01234567" nil))
4512 "\\=[01234567]?[01234567]?"
4514 (and (memq qtag (append "89" nil))
4516 "\\=[0123456789]*" (1- e) 'to-end))
4519 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
4521 (and (memq qtag (append "pPN" nil))
4522 (re-search-forward "\\={[^{}]+}\\|."
4524 (eq (char-syntax qtag) ?w))
4525 (cperl-postpone-fontification
4526 (1- REx-subgr-start) (point)
4527 'face my-cperl-REx-length1-face))))
4528 (setq was-subgr nil)) ; We do stuff here
4529 ((match-beginning 3) ; [charclass]
4530 ;; Highlight leader, trailer, POSIX classes
4532 (if (eq (char-after b) ?^ )
4533 (and (eq (following-char) ?\\ )
4534 (eq (char-after (cperl-1+ (point)))
4537 (and (eq (following-char) ?^ )
4539 (setq argument b ; continue? & end of last POSIX
4540 tag nil ; list of POSIX classes
4541 qtag (point)) ; after leading ^ if present
4542 (if (eq (char-after b) ?\] )
4543 (and (eq (following-char) ?\\ )
4544 (eq (char-after (cperl-1+ (point)))
4546 (setq qtag (1+ qtag))
4548 (and (eq (following-char) ?\] )
4550 (setq REx-subgr-end qtag) ;EndOf smart-highlighed
4551 ;; Apparently, I can't put \] into a charclass
4552 ;; in m]]: m][\\\]\]] produces [\\]]
4553 ;;; POSIX? [:word:] [:^word:] only inside []
4554 ;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
4555 (while ; look for unescaped ]
4558 (if (eq (char-after b) ?\] )
4559 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
4560 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
4562 ;; Is this ] an end of POSIX class?
4565 (search-backward "[" argument t)
4566 (< REx-subgr-start (point))
4567 (setq argument (point)) ; POSIX-start
4568 (or ; Should work with delim = \
4569 (not (eq (preceding-char) ?\\ ))
4570 ;; XXXX Double \\ is needed with 19.33
4571 (= (% (skip-chars-backward "\\\\") 2) 0))
4574 ((eq (char-after b) ?\] )
4575 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
4576 ((eq (char-after b) ?\: )
4577 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
4578 ((eq (char-after b) ?^ )
4579 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
4580 ((eq (char-syntax (char-after b))
4583 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
4584 (char-to-string (char-after b))
4586 (t "\\\\*\\[:\\^?\\sw*:]")))
4587 (goto-char REx-subgr-end)
4588 (cperl-highlight-charclass
4589 argument my-cperl-REx-spec-char-face
4590 my-cperl-REx-0length-face my-cperl-REx-length1-face)))
4591 (setq tag (cons (cons argument (point))
4594 REx-subgr-end argument) ; continue
4595 (setq argument nil)))
4597 (message "Couldn't find end of charclass in a REx, pos=%s"
4599 (setq argument (1- (point)))
4600 (goto-char REx-subgr-end)
4601 (cperl-highlight-charclass
4602 argument my-cperl-REx-spec-char-face
4603 my-cperl-REx-0length-face my-cperl-REx-length1-face)
4605 ;; Highlight starter, trailer, POSIX
4606 (if (and cperl-use-syntax-table-text-property
4607 (> (- (point) 2) REx-subgr-start))
4609 (1+ REx-subgr-start) (1- (point))
4610 'syntax-table cperl-st-punct))
4611 (cperl-postpone-fontification
4612 REx-subgr-start qtag
4613 'face my-cperl-REx-spec-char-face)
4614 (cperl-postpone-fontification
4615 (1- (point)) (point) 'face
4616 my-cperl-REx-spec-char-face)
4617 (if (eq (char-after b) ?\] )
4618 (cperl-postpone-fontification
4619 (- (point) 2) (1- (point))
4620 'face my-cperl-REx-0length-face))
4622 (cperl-postpone-fontification
4623 (car (car tag)) (cdr (car tag))
4624 'face font-lock-variable-name-face) ;my-cperl-REx-length1-face
4625 (setq tag (cdr tag)))
4626 (setq was-subgr nil)) ; did facing already
4628 ((and (match-beginning 2) ; #-comment
4629 (/= (match-beginning 2) (match-end 2)))
4630 (beginning-of-line 2)
4632 (goto-char (1- e))))
4633 ((match-beginning 4) ; character "]"
4634 (setq was-subgr nil) ; We do stuff here
4635 (goto-char (match-end 0))
4636 (if cperl-use-syntax-table-text-property
4638 (1- (point)) (point)
4639 'syntax-table cperl-st-punct))
4640 (cperl-postpone-fontification
4641 (1- (point)) (point)
4642 'face font-lock-warning-face))
4643 ((match-beginning 5) ; before (?{}) (??{})
4644 (setq tag (match-end 0))
4646 (cperl-forward-group-in-re st-l))
4648 (setq qtag "no matching `)' found"))
4649 (and (not (eq (char-after (- (point) 2))
4651 (setq qtag "Can't find })")))
4654 (message "%s" qtag))
4655 (cperl-postpone-fontification
4656 (1- tag) (1- (point))
4657 'face font-lock-variable-name-face)
4658 (cperl-postpone-fontification
4659 REx-subgr-start (1- tag)
4660 'face my-cperl-REx-spec-char-face)
4661 (cperl-postpone-fontification
4662 (1- (point)) (point)
4663 'face my-cperl-REx-spec-char-face)
4664 (if cperl-use-syntax-table-text-property
4667 (- (point) 2) (1- (point))
4668 'syntax-table cperl-st-cfence)
4670 (+ REx-subgr-start 2)
4671 (+ REx-subgr-start 3)
4672 'syntax-table cperl-st-cfence))))
4673 (setq was-subgr nil))
4675 ;; Inside "(" and "\" arn't special in any way
4676 ;; Works also if the outside delimiters are ().
4677 (or;;(if (eq (char-after b) ?\) )
4678 ;;(re-search-forward
4679 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
4681 (search-forward ")" (1- e) 'toend)
4684 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4690 (setq REx-subgr-end (point))
4692 REx-subgr-start REx-subgr-end nil)
4693 (cperl-postpone-fontification
4694 REx-subgr-start REx-subgr-end
4695 'face font-lock-comment-face))))))
4696 (if (and is-REx is-x-REx)
4697 (put-text-property (1+ b) (1- e)
4698 'syntax-subtype 'x-REx)))
4699 (if (and i2 e1 (or (not b1) (> e1 b1)))
4700 (progn ; No errors finding the second part...
4701 (cperl-postpone-fontification
4702 (1- e1) e1 'face my-cperl-delimiters-face)
4703 (if (and (not (eobp))
4704 (assoc (char-after b) cperl-starters))
4706 (cperl-postpone-fontification
4707 b1 (1+ b1) 'face my-cperl-delimiters-face)
4708 (put-text-property b1 (1+ b1)
4712 ((match-beginning 17) ; sub with prototype or attribute
4713 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4714 ;;"\\<sub\\>\\(" ;12
4715 ;; cperl-white-and-comment-rex ;13
4716 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
4717 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
4718 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
4719 (setq b1 (match-beginning 14) e1 (match-end 14))
4720 (if (memq (char-after (1- b))
4721 '(?\$ ?\@ ?\% ?\& ?\*))
4724 (if (eq (char-after (match-beginning 17)) ?\( )
4726 (cperl-commentify ; Prototypes; mark as string
4727 (match-beginning 17) (match-end 17) t)
4728 (goto-char (match-end 0))
4729 ;; Now look for attributes after prototype:
4730 (forward-comment (buffer-size))
4731 (and (looking-at ":[^:]")
4732 (cperl-find-sub-attrs st-l b1 e1 b)))
4733 ;; treat attributes without prototype
4734 (goto-char (match-beginning 17))
4735 (cperl-find-sub-attrs st-l b1 e1 b))))
4736 ;; 1+6+2+1+1+6+1=18 extra () before this:
4737 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
4738 ((match-beginning 19) ; old $abc'efg syntax
4739 (setq bb (match-end 0))
4740 ;;;(if (nth 3 state) nil ; in string
4741 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
4743 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
4744 ;; "__\\(END\\|DATA\\)__"
4745 ((match-beginning 20) ; __END__, __DATA__
4746 (setq bb (match-end 0))
4747 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4748 (cperl-commentify b bb nil)
4750 ;; "\\\\\\(['`\"($]\\)"
4751 ((match-beginning 21)
4752 ;; Trailing backslash; make non-quoting outside string/comment
4753 (setq bb (match-end 0))
4755 (skip-chars-backward "\\\\")
4756 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
4757 (cperl-modify-syntax-type b cperl-st-punct)
4759 (t (error "Error in regexp of the sniffer")))
4760 (if (> (point) stop-point)
4763 (message "Garbage after __END__/__DATA__ ignored")
4764 (message "Unbalanced syntax found while scanning")
4765 (or (car err-l) (setcar err-l b)))
4766 (goto-char stop-point))))
4767 (setq cperl-syntax-state (cons state-point state)
4768 ;; Do not mark syntax as done past tmpend???
4769 cperl-syntax-done-to (or tmpend (max (point) max)))
4770 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4772 (if (car err-l) (goto-char (car err-l))
4774 (message "Scanning for \"hard\" Perl constructions... done"))))
4775 (and (buffer-modified-p)
4777 (set-buffer-modified-p nil))
4778 ;; I do not understand what this is doing here. It breaks font-locking
4779 ;; because it resets the syntax-table from font-lock-syntax-table to
4780 ;; cperl-mode-syntax-table.
4781 ;; (set-syntax-table cperl-mode-syntax-table)
4783 (list (car err-l) overshoot)))
4785 (defun cperl-find-pods-heres-region (min max)
4787 (cperl-find-pods-heres min max))
4789 (defun cperl-backward-to-noncomment (lim)
4790 ;; Stops at lim or after non-whitespace that is not in comment
4791 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
4793 (while (and (not stop) (> (point) (or lim (point-min))))
4794 (skip-chars-backward " \t\n\f" lim)
4797 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4798 '(pod here-doc here-doc-delim))
4800 (cperl-unwind-to-safe nil)
4801 (setq pr (get-text-property (point) 'syntax-type))))
4802 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
4803 (not (memq pr '(string prestring))))
4804 (progn (cperl-to-comment-or-eol) (bolp))
4806 (skip-chars-backward " \t")
4807 (if (< p (point)) (goto-char p))
4810 ;; Used only in `cperl-calculate-indent'...
4811 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4812 ;; Positions is before ?\{. Checks whether it starts a block.
4813 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4814 (cperl-backward-to-noncomment (point-min))
4815 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4816 ; Label may be mixed up with `$blah :'
4817 (save-excursion (cperl-after-label))
4818 (get-text-property (cperl-1- (point)) 'attrib-group)
4819 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4822 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
4823 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
4824 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
4825 ;; sub bless::foo {}
4827 (cperl-backward-to-noncomment (point-min))
4828 (and (eq (preceding-char) ?b)
4831 (looking-at "sub[ \t\n\f#]")))))))))
4833 ;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4834 ;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4835 ;;; may be a part of an in-statement construct, such as
4836 ;;; ${something()}, print {FH} $data.
4837 ;;; Moreover, one takes positive approach (looks for else,grep etc)
4838 ;;; another negative (looks for bless,tr etc)
4839 (defun cperl-after-block-p (lim &optional pre-block)
4840 "Return true if the preceeding } (if PRE-BLOCK, following {) delimits a block.
4841 Would not look before LIM. Assumes that LIM is a good place to begin a
4842 statement. The kind of block we treat here is one after which a new
4843 statement would start; thus the block in ${func()} does not count."
4847 (or pre-block (forward-sexp -1))
4848 (cperl-backward-to-noncomment lim)
4849 (or (eq (point) lim)
4850 ;; if () {} // sub f () {} // sub f :a(') {}
4851 (eq (preceding-char) ?\) )
4853 (save-excursion (cperl-after-label))
4855 (get-text-property (cperl-1- (point)) 'attrib-group)
4856 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
4859 ;; else {} but not else::func {}
4860 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
4861 (not (looking-at "\\(\\sw\\|_\\)+::")))
4864 (cperl-backward-to-noncomment lim)
4865 (and (eq (preceding-char) ?b)
4868 (looking-at "sub[ \t\n\f#]"))))))
4869 ;; What preceeds is not word... XXXX Last statement in sub???
4870 (cperl-after-expr-p lim))))
4873 (defun cperl-after-expr-p (&optional lim chars test)
4874 "Return true if the position is good for start of expression.
4875 TEST is the expression to evaluate at the found position. If absent,
4876 CHARS is a string that contains good characters to have before us (however,
4877 `}' is treated \"smartly\" if it is not in the list)."
4878 (let ((lim (or lim (point-min)))
4880 (cperl-update-syntaxification (point) (point))
4882 (while (and (not stop) (> (point) lim))
4883 (skip-chars-backward " \t\n\f" lim)
4886 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4887 ;; '(pod here-doc here-doc-delim))
4888 (if (get-text-property (point) 'here-doc-group)
4891 (cperl-beginning-of-property (point) 'here-doc-group))
4892 (beginning-of-line 0)))
4893 (if (get-text-property (point) 'in-pod)
4896 (cperl-beginning-of-property (point) 'in-pod))
4897 (beginning-of-line 0)))
4898 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
4899 ;; Else: last iteration, or a label
4900 (cperl-to-comment-or-eol) ; Will not move past "." after a format
4901 (skip-chars-backward " \t")
4902 (if (< p (point)) (goto-char p))
4904 (if (and (eq (preceding-char) ?:)
4907 (skip-chars-backward " \t\n\f" lim)
4908 (memq (char-syntax (preceding-char)) '(?w ?_))))
4909 (forward-sexp -1) ; Possibly label. Skip it
4912 (or (bobp) ; ???? Needed
4914 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
4916 (if test (eval test)
4917 (or (memq (preceding-char) (append (or chars "{;") nil))
4918 (and (eq (preceding-char) ?\})
4919 (cperl-after-block-p lim))
4920 (and (eq (following-char) ?.) ; in format: see comment above
4921 (eq (get-text-property (point) 'syntax-type)
4924 (defun cperl-backward-to-start-of-expr (&optional lim)
4927 (while (and (or (not lim)
4929 (not (cperl-after-expr-p lim)))
4931 ;; May be after $, @, $# etc of a variable
4932 (skip-chars-backward "$@%#")))
4935 (defun cperl-at-end-of-expr (&optional lim)
4936 ;; Since the SEXP approach below is very fragile, do some overengineering
4937 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
4940 ;; If nothing interesting after, does as (forward-sexp -1);
4941 ;; otherwise fails, or ends at a start of following sexp.
4942 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
4943 ;; may be stuck after @ or $; just put some stupid workaround now:
4947 (while (memq (preceding-char) (append "%&@$*" nil))
4950 (cperl-after-expr-p lim))))
4953 (defun cperl-forward-to-end-of-expr (&optional lim)
4957 (while (and (< (point) (or lim (point-max)))
4958 (not (cperl-at-end-of-expr)))
4962 (defun cperl-backward-to-start-of-continued-exp (lim)
4963 (if (memq (preceding-char) (append ")]}\"'`" nil))
4966 (if (<= (point) lim)
4967 (goto-char (1+ lim)))
4968 (skip-chars-forward " \t"))
4970 (defun cperl-after-block-and-statement-beg (lim)
4971 ;; We assume that we are after ?\}
4973 (cperl-after-block-p lim)
4976 (cperl-backward-to-noncomment (point-min))
4979 (not (= (char-syntax (preceding-char)) ?w))
4984 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
4987 (defun cperl-indent-exp ()
4988 "Simple variant of indentation of continued-sexp.
4990 Will not indent comment if it starts at `comment-indent' or looks like
4991 continuation of the comment on the previous line.
4993 If `cperl-indent-region-fix-constructs', will improve spacing on
4994 conditional/loop constructs."
4997 (let ((tmp-end (point-at-eol)) top done)
5002 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
5003 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
5004 (setq top (point))) ; Get the outermost parenths in line
5006 (while (< (point) tmp-end)
5007 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
5008 (or (eolp) (forward-sexp 1)))
5009 (if (> (point) tmp-end) ; Yes, there an unfinished block
5011 (if (eq ?\) (preceding-char))
5012 (progn ;; Plan B: find by REGEXP block followup this line
5017 (if (eq (following-char) ?$ ) ; for my $var (list)
5020 (if (looking-at "\\(my\\|local\\|our\\)\\>")
5021 (forward-sexp -1))))
5023 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
5024 "\\|for\\(each\\)?\\>\\(\\("
5025 cperl-maybe-white-and-comment-rex
5026 "\\(my\\|local\\|our\\)\\)?"
5027 cperl-maybe-white-and-comment-rex
5028 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
5032 (setq top (point)))))
5033 (error (setq done t)))
5035 (if (looking-at ; Try Plan C: continuation block
5036 (concat cperl-maybe-white-and-comment-rex
5037 "\\<\\(else\\|elsif\|continue\\)\\>"))
5039 (goto-char (match-end 0))
5040 (setq tmp-end (point-at-eol)))
5042 (setq tmp-end (point-at-eol)))
5044 (setq tmp-end (point-marker)))
5045 (if cperl-indent-region-fix-constructs
5046 (cperl-fix-line-spacing tmp-end))
5047 (cperl-indent-region (point) tmp-end))))
5049 (defun cperl-fix-line-spacing (&optional end parse-data)
5050 "Improve whitespace in a conditional/loop construct.
5051 Returns some position at the last line."
5054 (setq end (point-max)))
5055 (let ((ee (point-at-eol))
5056 (cperl-indent-region-fix-constructs
5057 (or cperl-indent-region-fix-constructs 1))
5058 p pp ml have-brace ret)
5065 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5066 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5067 nil ; Do not need to do anything
5071 (if cperl-merge-trailing-else
5073 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5075 (search-forward "}")
5077 (skip-chars-forward " \t\n")
5078 (delete-region p (point))
5079 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5080 (beginning-of-line)))
5081 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
5083 (search-forward "}")
5084 (delete-horizontal-space)
5087 (if (cperl-indent-line parse-data)
5089 (cperl-fix-line-spacing end parse-data)
5090 (setq ret (point)))))))
5093 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
5095 (search-forward "}")
5096 (delete-horizontal-space)
5097 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5098 (beginning-of-line)))
5102 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5105 (delete-horizontal-space)
5106 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5107 (beginning-of-line)))
5111 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
5114 (delete-horizontal-space)
5115 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5116 (beginning-of-line)))
5118 ;; foreach my $var (
5120 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5123 (delete-horizontal-space)
5125 (make-string cperl-indent-region-fix-constructs ?\s))
5126 (beginning-of-line)))
5127 ;; Looking at (with or without "}" at start, ending after "({"):
5128 ;; } foreach my $var () OR {
5130 "[ \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]*{")
5132 (setq ml (match-beginning 8)) ; "(" or "{" after control word
5133 (re-search-forward "[({]")
5136 (if (eq (following-char) ?\( )
5139 (setq pp (point))) ; past parenth-group
5140 ;; after `else' or nothing
5141 (if ml ; after `else'
5142 (skip-chars-backward " \t\n")
5143 (beginning-of-line))
5145 ;; Now after the sexp before the brace
5146 ;; Multiline expr should be special
5147 (setq ml (and pp (save-excursion (goto-char p)
5148 (search-forward "\n" pp t))))
5149 (if (and (or (not pp) (< pp end)) ; Do not go too far...
5150 (looking-at "[ \t\n]*{"))
5153 ((bolp) ; Were before `{', no if/else/etc
5155 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
5156 (delete-horizontal-space)
5158 cperl-extra-newline-before-brace-multiline
5159 cperl-extra-newline-before-brace)
5161 (delete-horizontal-space)
5164 (if (cperl-indent-line parse-data)
5166 (cperl-fix-line-spacing end parse-data)
5167 (setq ret (point)))))
5169 (make-string cperl-indent-region-fix-constructs ?\s))))
5170 ((and (looking-at "[ \t]*\n")
5172 cperl-extra-newline-before-brace-multiline
5173 cperl-extra-newline-before-brace)))
5175 (skip-chars-forward " \t\n")
5176 (delete-region pp (point))
5178 (make-string cperl-indent-region-fix-constructs ?\ )))
5179 ((and (looking-at "[\t ]*{")
5180 (if ml cperl-extra-newline-before-brace-multiline
5181 cperl-extra-newline-before-brace))
5182 (delete-horizontal-space)
5185 (if (cperl-indent-line parse-data)
5187 (cperl-fix-line-spacing end parse-data)
5188 (setq ret (point))))))
5189 ;; Now we are before `{'
5190 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
5192 (skip-chars-forward " \t\n")
5197 (setq ml (search-forward "\n" p t))
5198 (if (or cperl-break-one-line-blocks-when-indent ml)
5199 ;; not good: multi-line BLOCK
5202 (delete-horizontal-space)
5205 (if (cperl-indent-line parse-data)
5206 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5208 (setq p (point) pp (point-at-eol)) ; May be different from ee.
5209 ;; Now check whether there is a hanging `}'
5213 cperl-fix-hanging-brace-when-indent
5215 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5219 (if (and (<= (point) pp)
5220 (eq (preceding-char) ?\} )
5221 (cperl-after-block-and-statement-beg (point-min)))
5228 (skip-chars-backward " \t")
5230 ;; `}' was the first thing on the line, insert NL *after* it.
5232 (cperl-indent-line parse-data)
5233 (search-forward "}")
5234 (delete-horizontal-space)
5236 (delete-horizontal-space)
5237 (or (eq (preceding-char) ?\;)
5239 (and (eq (preceding-char) ?\} )
5240 (cperl-after-block-p (point-min)))
5244 (if (cperl-indent-line parse-data)
5245 (setq ret (cperl-fix-line-spacing end parse-data)))
5246 (beginning-of-line)))))
5249 (defvar cperl-update-start) ; Do not need to make them local
5250 (defvar cperl-update-end)
5251 (defun cperl-delay-update-hook (beg end old-len)
5252 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5253 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
5255 (defun cperl-indent-region (start end)
5256 "Simple variant of indentation of region in CPerl mode.
5257 Should be slow. Will not indent comment if it starts at `comment-indent'
5258 or looks like continuation of the comment on the previous line.
5259 Indents all the lines whose first character is between START and END
5262 If `cperl-indent-region-fix-constructs', will improve spacing on
5263 conditional/loop constructs."
5265 (cperl-update-syntaxification end end)
5267 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
5268 (let ((indent-info (if cperl-emacs-can-parse
5269 (list nil nil nil) ; Cannot use '(), since will modify
5272 after-change-functions ; Speed it up!
5273 st comm old-comm-indent new-comm-indent p pp i empty)
5274 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
5276 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5278 new-comm-indent old-comm-indent)
5280 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5281 (or (bolp) (beginning-of-line 2))
5282 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5285 (setq empty (looking-at "[ \t]*\n"))
5286 (and (setq comm (looking-at "[ \t]*#"))
5287 (or (eq (current-indentation) (or old-comm-indent
5289 (setq old-comm-indent nil))))
5290 (if (and old-comm-indent
5292 (= (current-indentation) old-comm-indent)
5293 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5294 (not (eq (get-text-property (point) 'syntax-table)
5296 (let ((comment-column new-comm-indent))
5297 (indent-for-comment)))
5299 (setq i (cperl-indent-line indent-info))
5303 (if cperl-indent-region-fix-constructs
5304 (goto-char (cperl-fix-line-spacing end indent-info)))
5305 (if (setq old-comm-indent
5306 (and (cperl-to-comment-or-eol)
5307 (not (memq (get-text-property (point)
5310 (not (eq (get-text-property (point)
5314 (progn (indent-for-comment)
5315 (skip-chars-backward " \t")
5316 (skip-chars-backward "#")
5317 (setq new-comm-indent (current-column))))))))
5318 (beginning-of-line 2)))
5319 ;; Now run the update hooks
5320 (and after-change-functions
5323 (goto-char cperl-update-end)
5326 (goto-char cperl-update-start)
5328 (delete-char -1))))))
5330 ;; Stolen from lisp-mode with a lot of improvements
5332 (defun cperl-fill-paragraph (&optional justify iteration)
5333 "Like `fill-paragraph', but handle CPerl comments.
5334 If any of the current line is a comment, fill the comment or the
5335 block of it that point is in, preserving the comment's initial
5336 indentation and initial hashes. Behaves usually outside of comment."
5337 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
5338 (let (;; Non-nil if the current line contains a comment.
5340 fill-paragraph-function ; do not recurse
5341 ;; If has-comment, the appropriate fill-prefix for the comment.
5343 ;; Line that contains code and comment (or nil)
5345 c spaces len dc (comment-column comment-column))
5346 ;; Figure out what kind of comment we are looking at.
5351 ;; A line with nothing but a comment on it?
5352 ((looking-at "[ \t]*#[# \t]*")
5354 comment-fill-prefix (buffer-substring (match-beginning 0)
5357 ;; A line with some code, followed by a comment? Remember that the
5358 ;; semi which starts the comment shouldn't be part of a string or
5360 ((cperl-to-comment-or-eol)
5361 (setq has-comment t)
5362 (looking-at "#+[ \t]*")
5363 (setq start (point) c (current-column)
5365 (concat (make-string (current-column) ?\s)
5366 (buffer-substring (match-beginning 0) (match-end 0)))
5367 spaces (progn (skip-chars-backward " \t")
5368 (buffer-substring (point) start))
5369 dc (- c (current-column)) len (- start (point))
5370 start (point-marker))
5372 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
5373 (if (not has-comment)
5374 (fill-paragraph justify) ; Do the usual thing outside of comment
5375 ;; Narrow to include only the comment, and then fill the region.
5378 ;; Find the first line we should include in the region to fill.
5379 (if start (progn (beginning-of-line) (point))
5381 (while (and (zerop (forward-line -1))
5382 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5383 ;; We may have gone to far. Go forward again.
5384 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
5387 ;; Find the beginning of the first line past the region to fill.
5389 (while (progn (forward-line 1)
5390 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
5392 ;; Remove existing hashes
5393 (goto-char (point-min))
5395 (while (progn (forward-line 1) (< (point) (point-max)))
5396 (skip-chars-forward " \t")
5397 (if (looking-at "#+")
5399 (if (and (eq (point) (match-beginning 0))
5400 (not (eq (point) (match-end 0)))) nil
5402 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5403 (delete-char (- (match-end 0) (match-beginning 0)))))))
5405 ;; Lines with only hashes on them can be paragraph boundaries.
5406 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
5407 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
5408 (fill-prefix comment-fill-prefix))
5409 (fill-paragraph justify)))
5414 (progn (delete-char dc) (insert spaces)))
5415 (if (or (= (current-column) c) iteration) nil
5416 (setq comment-column c)
5417 (indent-for-comment)
5418 ;; Repeat once more, flagging as iteration
5419 (cperl-fill-paragraph justify t))))))
5422 (defun cperl-do-auto-fill ()
5423 ;; Break out if the line is short enough
5424 (if (> (save-excursion
5428 (let ((c (save-excursion (beginning-of-line)
5429 (cperl-to-comment-or-eol) (point)))
5430 (s (memq (following-char) '(?\s ?\t))) marker)
5432 ;; Don't break line inside code: only inside comment.
5434 (setq marker (point-marker))
5435 (fill-paragraph nil)
5437 ;; Is not enough, sometimes marker is a start of line
5438 (if (bolp) (progn (re-search-forward "#+[ \t]*")
5439 (goto-char (match-end 0))))
5440 ;; Following space could have gone:
5441 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
5444 ;; Previous space could have gone:
5445 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
5447 (defun cperl-imenu-addback (lst &optional isback name)
5448 ;; We suppose that the lst is a DAG, unless the first element only
5449 ;; loops back, and ISBACK is set. Thus this function cannot be
5450 ;; applied twice without ISBACK set.
5451 (cond ((not cperl-imenu-addback) lst)
5454 (setq name "+++BACK+++"))
5456 (if (and (listp elt) (listp (cdr elt)))
5458 ;; In the other order it goes up
5459 ;; one level only ;-(
5460 (setcdr elt (cons (cons name lst)
5462 (cperl-imenu-addback (cdr elt) t name))))
5463 (if isback (cdr lst) lst))
5466 (defun cperl-imenu--create-perl-index (&optional regexp)
5467 (require 'imenu) ; May be called from TAGS creator
5468 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
5469 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5470 (index-meth-alist '()) meth
5471 packages ends-ranges p marker is-proto
5472 (prev-pos 0) is-pack index index1 name (end-range 0) package)
5473 (goto-char (point-min))
5474 (cperl-update-syntaxification (point-max) (point-max))
5475 ;; Search for the function
5476 (progn ;;save-match-data
5477 (while (re-search-forward
5478 (or regexp cperl-imenu--function-name-regexp-perl)
5480 ;; 2=package-group, 5=package-name 8=sub-name
5482 ((and ; Skip some noise if building tags
5483 (match-beginning 5) ; package name
5484 ;;(eq (char-after (match-beginning 2)) ?p) ; package
5485 (not (save-match-data
5486 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
5489 (or (match-beginning 2)
5490 (match-beginning 8)) ; package or sub
5491 ;; Skip if quoted (will not skip multi-line ''-strings :-():
5492 (null (get-text-property (match-beginning 1) 'syntax-table))
5493 (null (get-text-property (match-beginning 1) 'syntax-type))
5494 (null (get-text-property (match-beginning 1) 'in-pod)))
5495 (setq is-pack (match-beginning 2))
5496 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
5497 ;; (goto-char (match-end 0))) ; Messes what follows
5500 (while (and ends-ranges (>= p (car ends-ranges)))
5501 ;; delete obsolete entries
5502 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5503 (setq package (or (car packages) "")
5504 end-range (or (car ends-ranges) 0))
5505 (if is-pack ; doing "package"
5507 (if (match-beginning 5) ; named package
5508 (setq name (buffer-substring (match-beginning 5)
5511 (set-text-properties 0 (length name) nil name)
5513 package (concat name "::")
5514 name (concat "package " name))
5515 ;; Support nameless packages
5516 (setq name "package;" package ""))
5519 (parse-partial-sexp (point) (point-max) -1) (point))
5520 ends-ranges (cons end-range ends-ranges)
5521 packages (cons package packages)))
5523 (or (eq (following-char) ?\;)
5524 (eq 0 (get-text-property (point) 'attrib-group)))))
5525 ;; Skip this function name if it is a prototype declaration.
5526 (if (and is-proto (not is-pack)) nil
5529 (buffer-substring (match-beginning 8) (match-end 8)))
5530 (set-text-properties 0 (length name) nil name))
5531 (setq marker (make-marker))
5532 (set-marker marker (match-end (if is-pack 2 8)))
5534 ((string-match "[:']" name)
5536 ((> p end-range) nil)
5538 (setq name (concat package name) meth t)))
5539 (setq index (cons name marker))
5541 (push index index-pack-alist)
5542 (push index index-alist))
5543 (if meth (push index index-meth-alist))
5544 (push index index-unsorted-alist)))
5545 ((match-beginning 16) ; POD section
5546 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5547 marker (make-marker))
5548 (set-marker marker (match-beginning 17))
5549 (set-text-properties 0 (length name) nil name)
5550 (setq name (concat (make-string
5551 (* 3 (- (char-after (match-beginning 16)) ?1))
5554 index (cons name marker))
5555 (setq index1 (cons (concat "=" name) (cdr index)))
5556 (push index index-pod-alist)
5557 (push index1 index-unsorted-alist)))))
5559 (if (default-value 'imenu-sort-function)
5560 (sort index-alist (default-value 'imenu-sort-function))
5561 (nreverse index-alist)))
5562 (and index-pod-alist
5563 (push (cons "+POD headers+..."
5564 (nreverse index-pod-alist))
5566 (and (or index-pack-alist index-meth-alist)
5567 (let ((lst index-pack-alist) hier-list pack elt group name)
5568 ;; Remove "package ", reverse and uniquify.
5570 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5571 (if (assoc name hier-list) nil
5572 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5573 (setq lst index-meth-alist)
5575 (setq elt (car lst) lst (cdr lst))
5576 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
5577 (setq pack (substring (car elt) 0 (match-beginning 0)))
5578 (if (setq group (assoc pack hier-list))
5579 (if (listp (cdr group))
5580 ;; Have some functions already
5582 (cons (cons (substring
5584 (+ 2 (match-beginning 0)))
5587 (setcdr group (list (cons (substring
5589 (+ 2 (match-beginning 0)))
5593 (list (cons (substring
5595 (+ 2 (match-beginning 0)))
5598 (push (cons "+Hierarchy+..."
5601 (and index-pack-alist
5602 (push (cons "+Packages+..."
5603 (nreverse index-pack-alist))
5605 (and (or index-pack-alist index-pod-alist
5606 (default-value 'imenu-sort-function))
5607 index-unsorted-alist
5608 (push (cons "+Unsorted List+..."
5609 (nreverse index-unsorted-alist))
5611 (cperl-imenu-addback index-alist)))
5614 ;; Suggested by Mark A. Hershberger
5615 (defun cperl-outline-level ()
5616 (looking-at outline-regexp)
5617 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
5618 ;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5619 ((match-beginning 2) 0) ; package
5620 ((match-beginning 8) 1) ; sub
5621 ((match-beginning 16)
5622 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5623 (t 5))) ; should not happen
5626 (defun cperl-windowed-init ()
5627 "Initialization under windowed version."
5628 (cond ((featurep 'ps-print)
5629 (or cperl-faces-init
5631 (and (boundp 'font-lock-multiline)
5632 (setq cperl-font-lock-multiline t))
5633 (cperl-init-faces))))
5634 ((not cperl-faces-init)
5635 (add-hook 'font-lock-mode-hook
5638 (if (memq major-mode '(perl-mode cperl-mode))
5640 (or cperl-faces-init (cperl-init-faces)))))))
5641 (if (fboundp 'eval-after-load)
5644 '(or cperl-faces-init (cperl-init-faces)))))))
5646 (defvar cperl-font-lock-keywords-1 nil
5647 "Additional expressions to highlight in Perl mode. Minimal set.")
5648 (defvar cperl-font-lock-keywords nil
5649 "Additional expressions to highlight in Perl mode. Default set.")
5650 (defvar cperl-font-lock-keywords-2 nil
5651 "Additional expressions to highlight in Perl mode. Maximal set")
5653 (defun cperl-load-font-lock-keywords ()
5654 (or cperl-faces-init (cperl-init-faces))
5655 cperl-font-lock-keywords)
5657 (defun cperl-load-font-lock-keywords-1 ()
5658 (or cperl-faces-init (cperl-init-faces))
5659 cperl-font-lock-keywords-1)
5661 (defun cperl-load-font-lock-keywords-2 ()
5662 (or cperl-faces-init (cperl-init-faces))
5663 cperl-font-lock-keywords-2)
5665 (defun cperl-init-faces-weak ()
5666 ;; Allow `cperl-find-pods-heres' to run.
5667 (or (boundp 'font-lock-constant-face)
5668 (cperl-force-face font-lock-constant-face
5669 "Face for constant and label names"))
5670 (or (boundp 'font-lock-warning-face)
5671 (cperl-force-face font-lock-warning-face
5672 "Face for things which should stand out"))
5673 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5676 (defun cperl-init-faces ()
5677 (condition-case errs
5679 (require 'font-lock)
5680 (and (fboundp 'font-lock-fontify-anchored-keywords)
5681 (featurep 'font-lock-extra)
5682 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5683 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
5684 (if (fboundp 'font-lock-fontify-anchored-keywords)
5685 (setq font-lock-anchored t))
5687 t-font-lock-keywords
5689 `("[ \t]+$" 0 ',cperl-invalid-face t)
5692 "\\(^\\|[^$@%&\\]\\)\\<\\("
5695 '("if" "until" "while" "elsif" "else" "unless" "for"
5696 "foreach" "continue" "exit" "die" "last" "goto" "next"
5697 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
5698 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
5699 "\\|") ; Flow control
5700 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
5701 ; In what follows we use `type' style
5702 ; for overwritable builtins
5705 "\\(^\\|[^$@%&\\]\\)\\<\\("
5706 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5707 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5708 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5709 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5710 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5711 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5712 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5713 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5714 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5715 ;; "gethostbyname" "gethostent" "getlogin"
5716 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5717 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5718 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5719 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5720 ;; "getservbyport" "getservent" "getsockname"
5721 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5722 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5723 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
5724 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5725 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5726 ;; "quotemeta" "rand" "read" "readdir" "readline"
5727 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5728 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5729 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5730 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5731 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5732 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5733 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5734 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
5735 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
5736 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5737 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5738 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5739 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
5740 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
5741 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
5742 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
5743 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
5744 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
5745 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
5746 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
5747 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
5748 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
5749 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
5750 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
5751 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
5752 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
5753 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
5754 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5755 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
5756 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
5757 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
5758 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
5759 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
5760 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
5761 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
5762 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
5763 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
5764 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
5765 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
5766 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
5767 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
5768 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
5769 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
5770 "\\)\\>") 2 'font-lock-type-face)
5771 ;; In what follows we use `other' style
5772 ;; for nonoverwritable builtins
5773 ;; Somehow 's', 'm' are not auto-generated???
5776 "\\(^\\|[^$@%&\\]\\)\\<\\("
5777 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
5778 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5779 ;; "eval" "exists" "for" "foreach" "format" "goto"
5780 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
5781 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
5782 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5783 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5784 ;; "undef" "unless" "unshift" "untie" "until" "use"
5786 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
5787 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
5788 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
5789 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
5790 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5791 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
5792 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
5793 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
5794 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
5795 "\\|[sm]" ; Added manually
5796 "\\)\\>") 2 'cperl-nonoverridable-face)
5797 ;; (mapconcat 'identity
5798 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5799 ;; "#include" "#define" "#undef")
5801 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
5802 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
5803 ;; This highlights declarations and definitions differenty.
5804 ;; We do not try to highlight in the case of attributes:
5805 ;; it is already done by `cperl-find-pods-heres'
5806 (list (concat "\\<sub"
5807 cperl-white-and-comment-rex ; whitespace/comments
5808 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
5810 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5811 "([^()]*)\\)?" ; prototype
5812 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5814 2 (if cperl-font-lock-multiline
5815 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5816 'font-lock-function-name-face
5817 'font-lock-variable-name-face)
5818 ;; need to manually set 'multiline' for older font-locks
5820 (if (< 1 (count-lines (match-beginning 0)
5823 (+ 3 (match-beginning 0)) (match-end 0)
5824 'syntax-type 'multiline))
5825 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5826 'font-lock-function-name-face
5827 'font-lock-variable-name-face))))
5828 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5829 2 font-lock-function-name-face)
5830 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
5831 1 font-lock-function-name-face)
5832 (cond ((featurep 'font-lock-extra)
5833 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5834 (2 font-lock-string-face t)
5835 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5837 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5838 (2 font-lock-string-face t)
5839 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5841 (1 font-lock-string-face t))))
5842 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
5843 2 font-lock-string-face t)))
5844 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
5845 font-lock-string-face t)
5846 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
5847 font-lock-constant-face) ; labels
5848 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
5849 2 font-lock-constant-face)
5850 ;; Uncomment to get perl-mode-like vars
5851 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
5852 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
5853 ;;; (2 (cons font-lock-variable-name-face '(underline))))
5854 (cond ((featurep 'font-lock-extra)
5855 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5856 (3 font-lock-variable-name-face)
5858 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
5859 (1 font-lock-variable-name-face)
5860 (2 '(restart 2 nil) nil t)))
5861 nil t))) ; local variables, multiple
5863 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
5864 `(,(concat "\\<\\(my\\|local\\|our\\)"
5865 cperl-maybe-white-and-comment-rex
5867 cperl-maybe-white-and-comment-rex
5868 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5869 (5 ,(if cperl-font-lock-multiline
5870 'font-lock-variable-name-face
5871 '(progn (setq cperl-font-lock-multiline-start
5872 (match-beginning 0))
5873 'font-lock-variable-name-face)))
5875 cperl-maybe-white-and-comment-rex
5877 cperl-maybe-white-and-comment-rex
5878 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)")
5879 ;; Bug in font-lock: limit is used not only to limit
5880 ;; searches, but to set the "extend window for
5881 ;; facification" property. Thus we need to minimize.
5882 ,(if cperl-font-lock-multiline
5883 '(if (match-beginning 3)
5885 (goto-char (match-beginning 3))
5891 (error nil)))) ; typeahead
5892 (1- (point))) ; report limit
5893 (forward-char -2)) ; disable continued expr
5894 '(if (match-beginning 3)
5895 (point-max) ; No limit for continuation
5896 (forward-char -2))) ; disable continued expr
5897 ,(if cperl-font-lock-multiline
5900 ;; "my" may be already fontified (POD),
5901 ;; so cperl-font-lock-multiline-start is nil
5902 (if (or (not cperl-font-lock-multiline-start)
5904 cperl-font-lock-multiline-start
5908 (1+ cperl-font-lock-multiline-start) (point)
5909 'syntax-type 'multiline))
5910 (setq cperl-font-lock-multiline-start nil)))
5911 (3 font-lock-variable-name-face))))
5912 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
5913 3 font-lock-variable-name-face)))
5914 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
5915 4 font-lock-variable-name-face)
5916 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
5917 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
5918 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
5920 t-font-lock-keywords-1
5921 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
5922 ;; not yet as of XEmacs 19.12, works with 21.1.11
5924 (not (featurep 'xemacs))
5925 (string< "21.1.9" emacs-version)
5926 (and (string< "21.1.10" emacs-version)
5927 (string< emacs-version "21.1.2")))
5929 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
5930 (if (eq (char-after (match-beginning 2)) ?%)
5933 t) ; arrays and hashes
5934 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
5936 (if (= (- (match-end 2) (match-beginning 2)) 1)
5937 (if (eq (char-after (match-beginning 3)) ?{)
5939 'cperl-array-face) ; arrays and hashes
5940 font-lock-variable-name-face) ; Just to put something
5942 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5943 (1 cperl-array-face)
5944 (2 font-lock-variable-name-face))
5945 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
5947 (2 font-lock-variable-name-face))
5948 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
5949 ;;; Too much noise from \s* @s[ and friends
5950 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
5951 ;;(3 font-lock-function-name-face t t)
5953 ;; (if (cperl-slash-is-regexp)
5954 ;; font-lock-function-name-face 'default) nil t))
5956 (if cperl-highlight-variables-indiscriminately
5957 (setq t-font-lock-keywords-1
5958 (append t-font-lock-keywords-1
5959 (list '("\\([$*]{?\\sw+\\)" 1
5960 font-lock-variable-name-face)))))
5961 (setq cperl-font-lock-keywords-1
5962 (if cperl-syntaxify-by-font-lock
5963 (cons 'cperl-fontify-update
5964 t-font-lock-keywords)
5965 t-font-lock-keywords)
5966 cperl-font-lock-keywords cperl-font-lock-keywords-1
5967 cperl-font-lock-keywords-2 (append
5968 cperl-font-lock-keywords-1
5969 t-font-lock-keywords-1)))
5970 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5971 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
5972 (eval ; Avoid a warning
5973 '(font-lock-require-faces
5975 ;; Color-light Color-dark Gray-light Gray-dark Mono
5976 (list 'font-lock-comment-face
5977 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5982 (list 'font-lock-string-face
5983 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5988 (list 'font-lock-function-name-face
5990 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5991 (cdr (assq 'background-color ; if mono
5992 (frame-parameters))))
5995 (cdr (assq 'foreground-color ; if mono
5996 (frame-parameters))))
6000 (list 'font-lock-variable-name-face
6001 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
6006 (list 'font-lock-type-face
6007 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
6012 (list 'font-lock-warning-face
6013 ["Pink" "Red" "Gray50" "LightGray"]
6020 (list 'font-lock-constant-face
6021 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
6026 (list 'cperl-nonoverridable-face
6027 ["chartreuse3" ("orchid1" "orange")
6033 (list 'cperl-array-face
6034 ["blue" "yellow" nil "Gray80"]
6035 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6040 (list 'cperl-hash-face
6041 ["red" "red" nil "Gray80"]
6042 ["lightyellow2" ("navy" "os2blue" "darkgreen")
6047 ;; Do it the dull way, without choose-color
6048 (defvar cperl-guessed-background nil
6049 "Display characteristics as guessed by cperl.")
6050 ;; (or (fboundp 'x-color-defined-p)
6051 ;; (defalias 'x-color-defined-p
6052 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
6053 ;; ;; XEmacs >= 19.12
6054 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
6056 ;; (t 'x-valid-color-name-p))))
6057 (cperl-force-face font-lock-constant-face
6058 "Face for constant and label names")
6059 (cperl-force-face font-lock-variable-name-face
6060 "Face for variable names")
6061 (cperl-force-face font-lock-type-face
6062 "Face for data types")
6063 (cperl-force-face cperl-nonoverridable-face
6064 "Face for data types from another group")
6065 (cperl-force-face font-lock-warning-face
6066 "Face for things which should stand out")
6067 (cperl-force-face font-lock-comment-face
6068 "Face for comments")
6069 (cperl-force-face font-lock-function-name-face
6070 "Face for function names")
6071 (cperl-force-face cperl-hash-face
6073 (cperl-force-face cperl-array-face
6075 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6076 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6077 ;;(or (boundp 'font-lock-type-face)
6078 ;; (defconst font-lock-type-face
6079 ;; 'font-lock-type-face
6080 ;; "Face to use for data types."))
6081 ;;(or (boundp 'cperl-nonoverridable-face)
6082 ;; (defconst cperl-nonoverridable-face
6083 ;; 'cperl-nonoverridable-face
6084 ;; "Face to use for data types from another group."))
6085 ;;(if (not (featurep 'xemacs)) nil
6086 ;; (or (boundp 'font-lock-comment-face)
6087 ;; (defconst font-lock-comment-face
6088 ;; 'font-lock-comment-face
6089 ;; "Face to use for comments."))
6090 ;; (or (boundp 'font-lock-keyword-face)
6091 ;; (defconst font-lock-keyword-face
6092 ;; 'font-lock-keyword-face
6093 ;; "Face to use for keywords."))
6094 ;; (or (boundp 'font-lock-function-name-face)
6095 ;; (defconst font-lock-function-name-face
6096 ;; 'font-lock-function-name-face
6097 ;; "Face to use for function names.")))
6099 (not (cperl-is-face 'cperl-array-face))
6100 (cperl-is-face 'font-lock-emphasized-face))
6101 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
6103 (not (cperl-is-face 'cperl-hash-face))
6104 (cperl-is-face 'font-lock-other-emphasized-face))
6105 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
6107 (not (cperl-is-face 'cperl-nonoverridable-face))
6108 (cperl-is-face 'font-lock-other-type-face))
6109 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
6110 ;;(or (boundp 'cperl-hash-face)
6111 ;; (defconst cperl-hash-face
6113 ;; "Face to use for hashes."))
6114 ;;(or (boundp 'cperl-array-face)
6115 ;; (defconst cperl-array-face
6116 ;; 'cperl-array-face
6117 ;; "Face to use for arrays."))
6118 ;; Here we try to guess background
6120 (if (boundp 'font-lock-background-mode)
6121 font-lock-background-mode
6123 (face-list (and (fboundp 'face-list) (face-list))))
6124 ;;;; (fset 'cperl-is-face
6125 ;;;; (cond ((fboundp 'find-face)
6126 ;;;; (symbol-function 'find-face))
6128 ;;;; (function (lambda (face) (member face face-list))))
6130 ;;;; (function (lambda (face) (boundp face))))))
6131 (defvar cperl-guessed-background
6132 (if (and (boundp 'font-lock-display-type)
6133 (eq font-lock-display-type 'grayscale))
6136 "Background as guessed by CPerl mode")
6137 (and (not (cperl-is-face 'font-lock-constant-face))
6138 (cperl-is-face 'font-lock-reference-face)
6139 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
6140 (if (cperl-is-face 'font-lock-type-face) nil
6141 (copy-face 'default 'font-lock-type-face)
6143 ((eq background 'light)
6144 (set-face-foreground 'font-lock-type-face
6145 (if (x-color-defined-p "seagreen")
6148 ((eq background 'dark)
6149 (set-face-foreground 'font-lock-type-face
6150 (if (x-color-defined-p "os2pink")
6154 (set-face-background 'font-lock-type-face "gray90"))))
6155 (if (cperl-is-face 'cperl-nonoverridable-face)
6157 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
6159 ((eq background 'light)
6160 (set-face-foreground 'cperl-nonoverridable-face
6161 (if (x-color-defined-p "chartreuse3")
6164 ((eq background 'dark)
6165 (set-face-foreground 'cperl-nonoverridable-face
6166 (if (x-color-defined-p "orchid1")
6169 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6170 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6172 ;;; ((eq background 'light)
6173 ;;; (set-face-background 'font-lock-other-emphasized-face
6174 ;;; (if (x-color-defined-p "lightyellow2")
6176 ;;; (if (x-color-defined-p "lightyellow")
6178 ;;; "light yellow"))))
6179 ;;; ((eq background 'dark)
6180 ;;; (set-face-background 'font-lock-other-emphasized-face
6181 ;;; (if (x-color-defined-p "navy")
6183 ;;; (if (x-color-defined-p "darkgreen")
6185 ;;; "dark green"))))
6186 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6187 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6188 ;;; (copy-face 'bold 'font-lock-emphasized-face)
6190 ;;; ((eq background 'light)
6191 ;;; (set-face-background 'font-lock-emphasized-face
6192 ;;; (if (x-color-defined-p "lightyellow2")
6194 ;;; "lightyellow")))
6195 ;;; ((eq background 'dark)
6196 ;;; (set-face-background 'font-lock-emphasized-face
6197 ;;; (if (x-color-defined-p "navy")
6199 ;;; (if (x-color-defined-p "darkgreen")
6201 ;;; "dark green"))))
6202 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
6203 (if (cperl-is-face 'font-lock-variable-name-face) nil
6204 (copy-face 'italic 'font-lock-variable-name-face))
6205 (if (cperl-is-face 'font-lock-constant-face) nil
6206 (copy-face 'italic 'font-lock-constant-face))))
6207 (setq cperl-faces-init t))
6208 (error (message "cperl-init-faces (ignored): %s" errs))))
6211 (defun cperl-ps-print-init ()
6212 "Initialization of `ps-print' components for faces used in CPerl."
6213 (eval-after-load "ps-print"
6214 '(setq ps-bold-faces
6215 ;; font-lock-variable-name-face
6216 ;; font-lock-constant-face
6217 (append '(cperl-array-face cperl-hash-face)
6220 ;; font-lock-constant-face
6221 (append '(cperl-nonoverridable-face cperl-hash-face)
6224 ;; font-lock-type-face
6225 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
6226 ps-underlined-faces))))
6228 (defvar ps-print-face-extension-alist)
6230 (defun cperl-ps-print (&optional file)
6231 "Pretty-print in CPerl style.
6232 If optional argument FILE is an empty string, prints to printer, otherwise
6233 to the file FILE. If FILE is nil, prompts for a file name.
6235 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6238 (setq file (read-from-minibuffer
6239 "Print to file (if empty - to printer): "
6240 (concat (buffer-file-name) ".ps")
6241 nil nil 'file-name-history)))
6242 (or (> (length file) 0)
6244 (require 'ps-print) ; To get ps-print-face-extension-alist
6245 (let ((ps-print-color-p t)
6246 (ps-print-face-extension-alist ps-print-face-extension-alist))
6247 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6248 (ps-print-buffer-with-faces file)))
6250 ;;; (defun cperl-ps-print-init ()
6251 ;;; "Initialization of `ps-print' components for faces used in CPerl."
6252 ;;; ;; Guard against old versions
6253 ;;; (defvar ps-underlined-faces nil)
6254 ;;; (defvar ps-bold-faces nil)
6255 ;;; (defvar ps-italic-faces nil)
6256 ;;; (setq ps-bold-faces
6257 ;;; (append '(font-lock-emphasized-face
6258 ;;; cperl-array-face
6259 ;;; font-lock-keyword-face
6260 ;;; font-lock-variable-name-face
6261 ;;; font-lock-constant-face
6262 ;;; font-lock-reference-face
6263 ;;; font-lock-other-emphasized-face
6264 ;;; cperl-hash-face)
6266 ;;; (setq ps-italic-faces
6267 ;;; (append '(cperl-nonoverridable-face
6268 ;;; font-lock-constant-face
6269 ;;; font-lock-reference-face
6270 ;;; font-lock-other-emphasized-face
6271 ;;; cperl-hash-face)
6272 ;;; ps-italic-faces))
6273 ;;; (setq ps-underlined-faces
6274 ;;; (append '(font-lock-emphasized-face
6275 ;;; cperl-array-face
6276 ;;; font-lock-other-emphasized-face
6278 ;;; cperl-nonoverridable-face font-lock-type-face)
6279 ;;; ps-underlined-faces))
6280 ;;; (cons 'font-lock-type-face ps-underlined-faces))
6283 (if (cperl-enable-font-lock) (cperl-windowed-init))
6285 (defconst cperl-styles-entries
6286 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6287 cperl-label-offset cperl-extra-newline-before-brace
6288 cperl-extra-newline-before-brace-multiline
6289 cperl-merge-trailing-else
6290 cperl-continued-statement-offset))
6292 (defconst cperl-style-examples
6293 "##### Numbers etc are: cperl-indent-level cperl-brace-offset
6294 ##### cperl-continued-brace-offset cperl-label-offset
6295 ##### cperl-continued-statement-offset
6296 ##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6298 ########### (Do not forget cperl-extra-newline-before-brace-multiline)
6300 ### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6312 ### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6324 ### GNU 2/0/0/-2/2/nil/t
6339 ### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6354 ### BSD (=C++, but will not change preexisting merge-trailing-else
6355 ### and extra-newline-before-brace ) 4/0/-4/-4/4
6370 ### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6371 ### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6386 ### Whitesmith (=PerlStyle, but will not change preexisting
6387 ### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6402 "Examples of if/else with different indent styles (with v4.23).")
6404 (defconst cperl-style-alist
6405 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
6406 (cperl-indent-level . 2)
6407 (cperl-brace-offset . 0)
6408 (cperl-continued-brace-offset . 0)
6409 (cperl-label-offset . -2)
6410 (cperl-continued-statement-offset . 2)
6411 (cperl-extra-newline-before-brace . nil)
6412 (cperl-extra-newline-before-brace-multiline . nil)
6413 (cperl-merge-trailing-else . t))
6415 ("PerlStyle" ; CPerl with 4 as indent
6416 (cperl-indent-level . 4)
6417 (cperl-brace-offset . 0)
6418 (cperl-continued-brace-offset . 0)
6419 (cperl-label-offset . -4)
6420 (cperl-continued-statement-offset . 4)
6421 (cperl-extra-newline-before-brace . nil)
6422 (cperl-extra-newline-before-brace-multiline . nil)
6423 (cperl-merge-trailing-else . t))
6426 (cperl-indent-level . 2)
6427 (cperl-brace-offset . 0)
6428 (cperl-continued-brace-offset . 0)
6429 (cperl-label-offset . -2)
6430 (cperl-continued-statement-offset . 2)
6431 (cperl-extra-newline-before-brace . t)
6432 (cperl-extra-newline-before-brace-multiline . t)
6433 (cperl-merge-trailing-else . nil))
6436 (cperl-indent-level . 5)
6437 (cperl-brace-offset . 0)
6438 (cperl-continued-brace-offset . -5)
6439 (cperl-label-offset . -5)
6440 (cperl-continued-statement-offset . 5)
6441 ;;(cperl-extra-newline-before-brace . nil) ; ???
6442 ;;(cperl-extra-newline-before-brace-multiline . nil)
6443 (cperl-merge-trailing-else . nil))
6446 (cperl-indent-level . 4)
6447 (cperl-brace-offset . 0)
6448 (cperl-continued-brace-offset . -4)
6449 (cperl-label-offset . -4)
6450 (cperl-continued-statement-offset . 4)
6451 ;;(cperl-extra-newline-before-brace . nil) ; ???
6452 ;;(cperl-extra-newline-before-brace-multiline . nil)
6453 ;;(cperl-merge-trailing-else . nil) ; ???
6457 (cperl-indent-level . 4)
6458 (cperl-brace-offset . 0)
6459 (cperl-continued-brace-offset . -4)
6460 (cperl-label-offset . -4)
6461 (cperl-continued-statement-offset . 4)
6462 (cperl-extra-newline-before-brace . t)
6463 (cperl-extra-newline-before-brace-multiline . t)
6464 (cperl-merge-trailing-else . nil))
6467 (cperl-indent-level . 4)
6468 (cperl-brace-offset . 0)
6469 (cperl-continued-brace-offset . 0)
6470 (cperl-label-offset . -4)
6471 (cperl-continued-statement-offset . 4)
6472 ;;(cperl-extra-newline-before-brace . nil) ; ???
6473 ;;(cperl-extra-newline-before-brace-multiline . nil)
6474 ;;(cperl-merge-trailing-else . nil) ; ???
6477 "List of variables to set to get a particular indentation style.
6478 Should be used via `cperl-set-style' or via Perl menu.
6480 See examples in `cperl-style-examples'.")
6482 (defun cperl-set-style (style)
6483 "Set CPerl mode variables to use one of several different indentation styles.
6484 The arguments are a string representing the desired style.
6485 The list of styles is in `cperl-style-alist', available styles
6486 are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
6488 The current value of style is memorized (unless there is a memorized
6489 data already), may be restored by `cperl-set-style-back'.
6491 Chosing \"Current\" style will not change style, so this may be used for
6492 side-effect of memorizing only. Examples in `cperl-style-examples'."
6494 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
6495 cperl-style-alist)))
6496 (list (completing-read "Enter style: " list nil 'insist))))
6498 (setq cperl-old-style
6501 (cons name (eval name))))
6502 cperl-styles-entries)))
6503 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
6505 (setq setting (car style) style (cdr style))
6506 (set (car setting) (cdr setting)))))
6508 (defun cperl-set-style-back ()
6509 "Restore a style memorized by `cperl-set-style'."
6511 (or cperl-old-style (error "The style was not changed"))
6513 (while cperl-old-style
6514 (setq setting (car cperl-old-style)
6515 cperl-old-style (cdr cperl-old-style))
6516 (set (car setting) (cdr setting)))))
6518 (defun cperl-check-syntax ()
6520 (require 'mode-compile)
6521 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6522 (eval '(mode-compile)))) ; Avoid a warning
6524 (defun cperl-info-buffer (type)
6525 ;; Returns buffer with documentation. Creates if missing.
6526 ;; If TYPE, this vars buffer.
6527 ;; Special care is taken to not stomp over an existing info buffer
6528 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6529 (info (get-buffer bname))
6530 (oldbuf (get-buffer "*info*")))
6532 (save-window-excursion
6537 (rename-buffer "*info-perl-tmp*")))
6538 (save-window-excursion
6540 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6541 (set-buffer "*info*")
6542 (rename-buffer bname)
6544 (set-buffer "*info-perl-tmp*")
6545 (rename-buffer "*info*")
6546 (set-buffer bname)))
6547 (make-local-variable 'window-min-height)
6548 (setq window-min-height 2)
6549 (current-buffer)))))
6551 (defun cperl-word-at-point (&optional p)
6552 "Return the word at point or at P."
6554 (if p (goto-char p))
6555 (or (cperl-word-at-point-hard)
6558 (funcall (or (and (boundp 'find-tag-default-function)
6559 find-tag-default-function)
6560 (get major-mode 'find-tag-default-function)
6561 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6562 ;; automatically used within `find-tag-default':
6563 'find-tag-default))))))
6565 (defun cperl-info-on-command (command)
6566 "Show documentation for Perl command COMMAND in other window.
6567 If perl-info buffer is shown in some frame, uses this frame.
6568 Customized by setting variables `cperl-shrink-wrap-info-frame',
6569 `cperl-max-help-size'."
6571 (let* ((default (cperl-word-at-point))
6573 (format "Find doc for Perl function (default %s): "
6575 (list (if (equal read "")
6579 (let ((buffer (current-buffer))
6580 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6581 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6582 max-height char-height buf-list)
6583 (if (string-match "^-[a-zA-Z]$" command)
6584 (setq cmd-desc "^-X[ \t\n]"))
6585 (setq isvar (string-match "^[$@%]" command)
6586 buf (cperl-info-buffer isvar)
6587 iniwin (selected-window)
6588 fr1 (window-frame iniwin))
6590 (goto-char (point-min))
6592 (progn (re-search-forward "^-X[ \t\n]")
6594 (if (re-search-forward cmd-desc nil t)
6596 ;; Go back to beginning of the group (ex, for qq)
6597 (if (re-search-backward "^[ \t\n\f]")
6602 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6603 (while (and (not win) buf-list)
6604 (setq win (get-buffer-window (car buf-list) t))
6605 (setq buf-list (cdr buf-list)))
6607 (eq (window-buffer win) buf)
6608 (set-window-buffer win buf))
6609 (and win (setq fr2 (window-frame win)))
6610 (if (or (not fr2) (eq fr1 fr2))
6612 (special-display-popup-frame buf) ; Make it visible
6613 (select-window win))
6614 (goto-char pos) ; Needed (?!).
6616 (setq iniheight (window-height)
6617 frheight (frame-height)
6618 not-loner (< iniheight (1- frheight))) ; Are not alone
6619 (cond ((if not-loner cperl-max-help-size
6620 cperl-shrink-wrap-info-frame)
6626 (if (re-search-forward
6627 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
6628 (match-beginning 0) (point-max)))))
6631 (/ (* (- frheight 3) cperl-max-help-size) 100)
6632 (setq char-height (frame-char-height))
6633 ;; Non-functioning under OS/2:
6634 (if (eq char-height 1) (setq char-height 18))
6635 ;; Title, menubar, + 2 for slack
6636 (- (/ (display-pixel-height) char-height) 4)))
6637 (if (> height max-height) (setq height max-height))
6638 ;;(message "was %s doing %s" iniheight height)
6640 (enlarge-window (- height iniheight))
6641 (set-frame-height (window-frame win) (1+ height)))))
6642 (set-window-start (selected-window) pos))
6643 (message "No entry for %s found." command))
6644 ;;(pop-to-buffer buffer)
6645 (select-window iniwin)))
6647 (defun cperl-info-on-current-command ()
6648 "Show documentation for Perl command at point in other window."
6650 (cperl-info-on-command (cperl-word-at-point)))
6652 (defun cperl-imenu-info-imenu-search ()
6653 (if (looking-at "^-X[ \t\n]") nil
6655 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
6658 (defun cperl-imenu-info-imenu-name ()
6660 (match-beginning 1) (match-end 1)))
6662 (defun cperl-imenu-on-info ()
6663 "Shows imenu for Perl Info Buffer.
6664 Opens Perl Info buffer if needed."
6666 (let* ((buffer (current-buffer))
6667 imenu-create-index-function
6668 imenu-prev-index-position-function
6669 imenu-extract-index-name-function
6670 (index-item (save-restriction
6671 (save-window-excursion
6672 (set-buffer (cperl-info-buffer nil))
6673 (setq imenu-create-index-function
6674 'imenu-default-create-index-function
6675 imenu-prev-index-position-function
6676 'cperl-imenu-info-imenu-search
6677 imenu-extract-index-name-function
6678 'cperl-imenu-info-imenu-name)
6679 (imenu-choose-buffer-index)))))
6683 (pop-to-buffer "*info-perl*")
6685 ((markerp (cdr index-item))
6686 (goto-char (marker-position (cdr index-item))))
6688 (goto-char (cdr index-item))))
6689 (set-window-start (selected-window) (point))
6690 (pop-to-buffer buffer)))))
6692 (defun cperl-lineup (beg end &optional step minshift)
6693 "Lineup construction in a region.
6694 Beginning of region should be at the start of a construction.
6695 All first occurrences of this construction in the lines that are
6696 partially contained in the region are lined up at the same column.
6698 MINSHIFT is the minimal amount of space to insert before the construction.
6699 STEP is the tabwidth to position constructions.
6700 If STEP is nil, `cperl-lineup-step' will be used
6701 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
6702 Will not move the position at the start to the left."
6704 (let (search col tcol seen b)
6708 (setq end (point-marker))
6710 (skip-chars-forward " \t\f")
6711 (setq beg (point-marker))
6712 (indent-region beg end nil)
6714 (setq col (current-column))
6715 (if (looking-at "[a-zA-Z0-9_]")
6716 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
6720 (buffer-substring (match-beginning 0)
6721 (match-end 0))) "\\>"))
6722 (error "Cannot line up in a middle of the word"))
6723 (if (looking-at "$")
6724 (error "Cannot line up end of line"))
6725 (setq search (regexp-quote (char-to-string (following-char)))))
6726 (setq step (or step cperl-lineup-step cperl-indent-level))
6727 (or minshift (setq minshift 1))
6729 (beginning-of-line 2)
6730 (and (< (point) end)
6731 (re-search-forward search end t)
6732 (goto-char (match-beginning 0))))
6733 (setq tcol (current-column) seen t)
6734 (if (> tcol col) (setq col tcol)))
6736 (error "The construction to line up occurred only once"))
6738 (setq col (+ col minshift))
6739 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
6742 (cperl-make-indent col)
6743 (beginning-of-line 2)
6744 (and (< (point) end)
6745 (re-search-forward search end t)
6746 (goto-char (match-beginning 0)))))))) ; No body
6748 (defun cperl-etags (&optional add all files) ;; NOT USED???
6749 "Run etags with appropriate options for Perl files.
6750 If optional argument ALL is `recursive', will process Perl files
6751 in subdirectories too."
6754 (args '("-l" "none" "-r"
6755 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6756 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6758 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
6760 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
6762 (if add (setq args (cons "-a" args)))
6763 (or files (setq files (list buffer-file-name)))
6765 ((eq all 'recursive)
6766 ;;(error "Not implemented: recursive")
6767 (setq args (append (list "-e"
6768 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
6770 find(\\&wanted, '.');
6775 ;;(error "Not implemented: all")
6776 (setq args (append (list "-e"
6777 "push @ARGV, <*.PL *.pl *.pm>;
6782 (setq args (append args files))))
6783 (setq res (apply 'call-process cmd nil nil nil args))
6785 (message "etags returned \"%s\"" res))))
6787 (defun cperl-toggle-auto-newline ()
6788 "Toggle the state of `cperl-auto-newline'."
6790 (setq cperl-auto-newline (not cperl-auto-newline))
6791 (message "Newlines will %sbe auto-inserted now."
6792 (if cperl-auto-newline "" "not ")))
6794 (defun cperl-toggle-abbrev ()
6795 "Toggle the state of automatic keyword expansion in CPerl mode."
6797 (abbrev-mode (if abbrev-mode 0 1))
6798 (message "Perl control structure will %sbe auto-inserted now."
6799 (if abbrev-mode "" "not ")))
6802 (defun cperl-toggle-electric ()
6803 "Toggle the state of parentheses doubling in CPerl mode."
6805 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
6806 (message "Parentheses will %sbe auto-doubled now."
6807 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6809 (defun cperl-toggle-autohelp ()
6810 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6811 Delay of auto-help controlled by `cperl-lazy-help-time'."
6813 (if (fboundp 'run-with-idle-timer)
6815 (if cperl-lazy-installed
6816 (cperl-lazy-unstall)
6817 (cperl-lazy-install))
6818 (message "Perl help messages will %sbe automatically shown now."
6819 (if cperl-lazy-installed "" "not ")))
6820 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6822 (defun cperl-toggle-construct-fix ()
6823 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6825 (setq cperl-indent-region-fix-constructs
6826 (if cperl-indent-region-fix-constructs
6829 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
6830 (if cperl-indent-region-fix-constructs "" "not ")))
6832 (defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6833 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6834 Nonpositive numeric argument disables debugging messages. The message
6835 summarizes which regions it was decided to rescan for syntactic constructs.
6837 The message looks like this:
6839 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6841 Numbers are character positions in the buffer. REQ provides the range to
6842 rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6843 for correct operation it should start and end outside any special syntactic
6844 construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6848 (setq arg (if (eq cperl-syntaxify-by-font-lock
6849 (if backtrace 'backtrace 'message)) 0 1)))
6850 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6851 (setq cperl-syntaxify-by-font-lock arg)
6852 (message "Debugging messages of syntax unwind %sabled."
6853 (if (eq arg t) "dis" "en")))
6855 ;;;; Tags file creation.
6857 (defvar cperl-tmp-buffer " *cperl-tmp*")
6859 (defun cperl-setup-tmp-buf ()
6860 (set-buffer (get-buffer-create cperl-tmp-buffer))
6861 (set-syntax-table cperl-mode-syntax-table)
6862 (buffer-disable-undo)
6864 (if cperl-use-syntax-table-text-property-for-tags
6866 (make-local-variable 'parse-sexp-lookup-properties)
6867 ;; Do not introduce variable if not needed, we check it!
6868 (set 'parse-sexp-lookup-properties t))))
6870 ;; Copied from imenu-example--name-and-position.
6871 (defvar imenu-use-markers)
6873 (defun cperl-imenu-name-and-position ()
6874 "Return the current/previous sexp and its (beginning) location.
6875 Does not move point."
6878 (let ((beg (if imenu-use-markers (point-marker) (point)))
6879 (end (progn (forward-sexp) (point))))
6880 (cons (buffer-substring beg end)
6883 (defun cperl-xsub-scan ()
6885 (let ((index-alist '())
6886 (prev-pos 0) index index1 name package prefix)
6887 (goto-char (point-min))
6888 ;; Search for the function
6889 (progn ;;save-match-data
6890 (while (re-search-forward
6891 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6894 ((match-beginning 2) ; SECTION
6895 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6896 (goto-char (match-beginning 0))
6897 (skip-chars-forward " \t")
6899 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
6900 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6902 ((not package) nil) ; C language section
6903 ((match-beginning 3) ; XSUB
6904 (goto-char (1+ (match-beginning 3)))
6905 (setq index (cperl-imenu-name-and-position))
6906 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6907 (if (and prefix (string-match (concat "^" prefix) name))
6908 (setq name (substring name (length prefix))))
6909 (cond ((string-match "::" name) nil)
6911 (setq index1 (cons (concat package "::" name) (cdr index)))
6912 (push index1 index-alist)))
6914 (push index index-alist))
6916 ;; (beginning-of-line)
6917 (setq index (cperl-imenu-name-and-position))
6918 (setcar index (concat package "::BOOT:"))
6919 (push index index-alist)))))
6922 (defvar cperl-unreadable-ok nil)
6924 (defun cperl-find-tags (ifile xs topdir)
6925 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6926 (cperl-pod-here-fontify nil) f file)
6928 (if b (set-buffer b)
6929 (cperl-setup-tmp-buf))
6932 (setq file (car (insert-file-contents ifile)))
6933 (error (if cperl-unreadable-ok nil
6935 (format "File %s unreadable. Continue? " ifile))
6936 (setq cperl-unreadable-ok t)
6937 (error "Aborting: unreadable file %s" ifile)))))
6939 (message "Unreadable file %s" ifile)
6940 (message "Scanning file %s ..." file)
6941 (if (and cperl-use-syntax-table-text-property-for-tags
6943 (condition-case err ; after __END__ may have garbage
6944 (cperl-find-pods-heres nil nil noninteractive)
6945 (error (message "While scanning for syntax: %s" err))))
6947 (setq lst (cperl-xsub-scan))
6948 (setq ind (cperl-imenu--create-perl-index))
6949 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6954 (cond ((string-match "^[_a-zA-Z]" (car elt))
6955 (goto-char (cdr elt))
6956 (beginning-of-line) ; pos should be of the start of the line
6959 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6960 (buffer-substring (progn
6961 (goto-char (cdr elt))
6962 ;; After name now...
6963 (or (eolp) (forward-char 1))
6971 (setq elt (car lst) lst (cdr lst))
6976 (if (string-match "^package " (car elt))
6977 (substring (car elt) 8)
6980 (number-to-string (elt elt 2)) ; Line
6982 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
6984 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
6985 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
6987 ;; Need to insert the name without package as well
6988 (setq lst (cons (cons (substring (elt elt 3)
6996 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
6997 (set-text-properties 0 (length rel) nil rel)
6998 (and (equal topdir (substring rel 0 (length topdir)))
6999 (setq rel (substring file (length topdir))))
7000 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
7001 (setq ret (buffer-substring 1 (point-max)))
7004 (message "Scanning file %s finished" file))
7007 (defun cperl-add-tags-recurse-noxs ()
7008 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
7010 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7011 -f cperl-add-tags-recurse-noxs
7013 (cperl-write-tags nil nil t t nil t))
7015 (defun cperl-add-tags-recurse-noxs-fullpath ()
7016 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7017 Writes down fullpath, so TAGS is relocatable (but if the build directory
7018 is relocated, the file TAGS inside it breaks). Use as
7019 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7020 -f cperl-add-tags-recurse-noxs-fullpath
7022 (cperl-write-tags nil nil t t nil t ""))
7024 (defun cperl-add-tags-recurse ()
7025 "Add to TAGS file data for Perl files in the current directory and kids.
7027 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7028 -f cperl-add-tags-recurse
7030 (cperl-write-tags nil nil t t))
7032 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
7033 ;; If INBUFFER, do not select buffer, and do not save
7034 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
7037 (setq file (if dir default-directory (buffer-file-name)))
7038 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
7040 (setq topdir default-directory))
7041 (let ((tags-file-name "TAGS")
7042 (case-fold-search (and (featurep 'xemacs) (eq system-type 'emx)))
7045 (cond (inbuffer nil) ; Already there
7046 ((file-exists-p tags-file-name)
7047 (if (featurep 'xemacs)
7048 (visit-tags-table-buffer)
7049 (visit-tags-table-buffer tags-file-name)))
7050 (t (set-buffer (find-file-noselect tags-file-name))))
7053 (cond ((eq erase 'ignore))
7056 (setq erase 'ignore)))
7059 (directory-files file t
7060 (if recurse nil cperl-scan-files-regexp)
7063 (if cperl-unreadable-ok nil
7065 (format "Directory %s unreadable. Continue? " file))
7066 (setq cperl-unreadable-ok t
7067 tm nil) ; Return empty list
7068 (error "Aborting: unreadable directory %s" file)))))))
7072 ((string-match cperl-noscan-files-regexp file)
7074 ((not (file-directory-p file))
7075 (if (string-match cperl-scan-files-regexp file)
7076 (cperl-write-tags file erase recurse nil t noxs topdir)))
7078 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7081 (setq xs (string-match "\\.xs$" file))
7082 (if (not (and xs noxs))
7084 (cond ((eq erase 'ignore) (goto-char (point-max)))
7085 (erase (erase-buffer))
7089 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7090 (set-text-properties 0 (length rel) nil rel)
7091 (and (equal topdir (substring rel 0 (length topdir)))
7092 (setq rel (substring file (length topdir))))
7093 (if (search-forward (concat "\f\n" rel ",") nil t)
7095 (search-backward "\f\n")
7096 (delete-region (point)
7099 (if (search-forward "\f\n"
7103 (goto-char (point-max)))))
7104 (insert (cperl-find-tags file xs topdir))))))
7105 (if inbuffer nil ; Delegate to the caller
7106 (save-buffer 0) ; No backup
7107 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7108 (initialize-new-tags-table))))))
7110 (defvar cperl-tags-hier-regexp-list
7117 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
7119 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
7122 (defvar cperl-hierarchy '(() ())
7123 "Global hierarchy of classes.")
7125 (defun cperl-tags-hier-fill ()
7126 ;; Suppose we are in a tag table cooked by cperl.
7128 (let (type pack name pos line chunk ord cons1 file str info fileind)
7129 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
7130 (setq pos (match-beginning 0)
7131 pack (match-beginning 2))
7133 (if (looking-at (concat
7142 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7143 name (buffer-substring (match-beginning 2) (match-end 2))
7144 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
7145 line (buffer-substring (match-beginning 3) (match-end 3))
7148 fileind (format "%s:%s" file line)
7149 ;; Moves to beginning of the next line:
7150 info (cperl-etags-snarf-tag file line))
7153 ;; Make new member of hierarchy name ==> file ==> pos if needed
7154 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7156 (setcdr cons1 (cons (cons fileind (vector file info))
7158 ;; First occurrence of the name, start alist
7159 (setq cons1 (cons name (list (cons fileind (vector file info)))))
7161 (setcar (cdr cperl-hierarchy)
7162 (cons cons1 (nth 1 cperl-hierarchy)))
7163 (setcar cperl-hierarchy
7164 (cons cons1 (car cperl-hierarchy)))))))
7167 (declare-function x-popup-menu "menu.c" (position menu))
7169 (defun cperl-tags-hier-init (&optional update)
7170 "Show hierarchical menu of classes and methods.
7171 Finds info about classes by a scan of loaded TAGS files.
7172 Supposes that the TAGS files contain fully qualified function names.
7173 One may build such TAGS files from CPerl mode menu."
7177 (if (or update (null (nth 2 cperl-hierarchy)))
7178 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7181 (setcdr elt (cdr (nth 1 elt)))))))
7182 pack name cons1 to l1 l2 l3 l4 b)
7183 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7184 (setq cperl-hierarchy (list l1 l2 l3))
7185 (if (featurep 'xemacs) ; Not checked
7188 ;; Does this work in XEmacs?
7189 (call-interactively 'visit-tags-table))
7190 (message "Updating list of classes...")
7191 (set-buffer (get-file-buffer tags-file-name))
7192 (cperl-tags-hier-fill))
7194 (call-interactively 'visit-tags-table))
7198 (message "Updating list of classes... %s" tagsfile)
7199 (set-buffer (get-file-buffer tagsfile))
7200 (cperl-tags-hier-fill)))
7202 (message "Updating list of classes... postprocessing..."))
7203 (mapc remover (car cperl-hierarchy))
7204 (mapc remover (nth 1 cperl-hierarchy))
7205 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7206 (cons "Methods: " (car cperl-hierarchy))))
7207 (cperl-tags-treeify to 1)
7208 (setcar (nthcdr 2 cperl-hierarchy)
7209 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7210 (message "Updating list of classes: done, requesting display...")
7211 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7213 (or (nth 2 cperl-hierarchy)
7214 (error "No items found"))
7216 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
7217 (if (if (fboundp 'display-popup-menus-p)
7218 (let ((f 'display-popup-menus-p))
7221 (x-popup-menu t (nth 2 cperl-hierarchy))
7223 (tmm-prompt (nth 2 cperl-hierarchy))))
7224 (if (and update (listp update))
7225 (progn (while (cdr update) (setq update (cdr update)))
7226 (setq update (car update)))) ; Get the last from the list
7227 (if (vectorp update)
7229 (find-file (elt update 0))
7230 (cperl-etags-goto-tag-location (elt update 1))))
7231 (if (eq update -999) (cperl-tags-hier-init t)))
7233 (defun cperl-tags-treeify (to level)
7234 ;; cadr of `to' is read-write. On start it is a cons
7235 (let* ((regexp (concat "^\\(" (mapconcat
7237 (make-list level "[_a-zA-Z0-9]+")
7240 (packages (cdr (nth 1 to)))
7241 (methods (cdr (nth 2 to)))
7242 l1 head tail cons1 cons2 ord writeto packs recurse
7243 root-packages root-functions ms many_ms same_name ps
7247 (cond ((and (string-match regexp (car elt))
7248 (or (eq ord 1) (match-end 2)))
7249 (setq head (substring (car elt) 0 (match-end 1))
7250 tail (if (match-end 2) (substring (car elt)
7253 (if (setq cons1 (assoc head writeto)) nil
7254 ;; Need to init new head
7255 (setcdr writeto (cons (list head (list "Packages: ")
7258 (setq cons1 (nth 1 writeto)))
7259 (setq cons2 (nth ord cons1)) ; Either packs or meths
7260 (setcdr cons2 (cons elt (cdr cons2))))
7262 (setq root-functions (cons elt root-functions)))
7264 (setq root-packages (cons elt root-packages))))))))
7265 (setcdr to l1) ; Init to dynamic space
7268 (mapc move-deeper packages)
7270 (mapc move-deeper methods)
7272 (mapc (function (lambda (elt)
7273 (cperl-tags-treeify elt (1+ level))))
7275 ;;Now clean up leaders with one child only
7276 (mapc (function (lambda (elt)
7277 (if (not (and (listp (cdr elt))
7278 (eq (length elt) 2))) nil
7279 (setcar elt (car (nth 1 elt)))
7280 (setcdr elt (cdr (nth 1 elt))))))
7282 ;; Sort the roots of subtrees
7283 (if (default-value 'imenu-sort-function)
7285 (sort (cdr to) (default-value 'imenu-sort-function))))
7286 ;; Now add back functions removed from display
7287 (mapc (function (lambda (elt)
7288 (setcdr to (cons elt (cdr to)))))
7289 (if (default-value 'imenu-sort-function)
7291 (sort root-functions (default-value 'imenu-sort-function)))
7293 ;; Now add back packages removed from display
7294 (mapc (function (lambda (elt)
7295 (setcdr to (cons (cons (concat "package " (car elt))
7298 (if (default-value 'imenu-sort-function)
7300 (sort root-packages (default-value 'imenu-sort-function)))
7304 ;;; '(keymap "Name1"
7308 ;;; ("Tail1" "x") ("Tail2" "y"))))
7310 (defun cperl-list-fold (list name limit)
7311 (let (list1 list2 elt1 (num 0))
7312 (if (<= (length list) limit) list
7313 (setq list1 nil list2 nil)
7318 (if (<= num imenu-max-items)
7319 (setq list2 (cons elt1 list2))
7320 (setq list1 (cons (cons name
7325 (nreverse (cons (cons name
7329 (defun cperl-menu-to-keymap (menu &optional name)
7335 (cond ((listp (cdr elt))
7336 (setq list (cperl-list-fold
7337 (cdr elt) (car elt) imenu-max-items))
7340 (cperl-menu-to-keymap list))))
7342 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7343 (cperl-list-fold menu "Root" imenu-max-items)))))
7346 (defvar cperl-bad-style-regexp
7347 (mapconcat 'identity
7348 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
7349 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
7351 "Finds places such that insertion of a whitespace may help a lot.")
7353 (defvar cperl-not-bad-style-regexp
7356 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
7357 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7358 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
7359 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
7360 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
7367 "\\\\[&$@*\\\\]" ; \&func
7370 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
7373 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
7374 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
7375 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7379 "If matches at the start of match found by `my-bad-c-style-regexp',
7380 insertion of a whitespace will not help.")
7384 (defun cperl-find-bad-style ()
7385 "Find places in the buffer where insertion of a whitespace may help.
7386 Prompts user for insertion of spaces.
7387 Currently it is tuned to C and Perl syntax."
7389 (let (found-bad (p (point)))
7390 (setq last-nonmenu-event 13) ; To disable popup
7391 (goto-char (point-min))
7392 (map-y-or-n-p "Insert space here? "
7393 (lambda (arg) (insert " "))
7394 'cperl-next-bad-style
7395 '("location" "locations" "insert a space into")
7396 '((?\C-r (lambda (arg)
7397 (let ((buffer-quit-function
7398 'exit-recursive-edit))
7399 (message "Exit with Esc Esc")
7401 t)) ; Consider acted upon
7402 "edit, exit with Esc Esc")
7404 (let ((buffer-quit-function
7405 'exit-recursive-edit))
7406 (message "Exit with Esc Esc")
7408 t)) ; Consider acted upon
7409 "edit, exit with Esc Esc"))
7411 (if found-bad (goto-char found-bad)
7413 (message "No appropriate place found"))))
7415 (defun cperl-next-bad-style ()
7416 (let (p (not-found t) (point (point)) found)
7417 (while (and not-found
7418 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7420 (goto-char (match-beginning 0))
7422 (looking-at cperl-not-bad-style-regexp)
7423 ;; Check for a < -b and friends
7424 (and (eq (following-char) ?\-)
7426 (skip-chars-backward " \t\n")
7427 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
7428 ;; Now check for syntax type
7430 (setq found (point))
7431 (beginning-of-defun)
7432 (let ((pps (parse-partial-sexp (point) found)))
7433 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7434 (goto-char (match-end 0))
7442 (defvar cperl-have-help-regexp
7446 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
7447 "[$@]\\^[a-zA-Z]" ; Special variable
7448 "[$@][^ \n\t]" ; Special variable
7449 "-[a-zA-Z]" ; File test
7450 "\\\\[a-zA-Z0]" ; Special chars
7451 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
7452 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
7453 "[a-zA-Z_0-9:]+" ; symbol or number
7460 "Matches places in the buffer we can find help for.")
7462 (defvar cperl-message-on-help-error t)
7463 (defvar cperl-help-from-timer nil)
7465 (defun cperl-word-at-point-hard ()
7466 ;; Does not save-excursion
7467 ;; Get to the something meaningful
7468 (or (eobp) (eolp) (forward-char 1))
7469 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
7473 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
7474 ;; (skip-chars-backward " \n\t\r({[]});,")
7475 ;; (or (bobp) (backward-char 1))))
7478 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7479 (skip-chars-backward "a-zA-Z0-9_:")
7481 ((and (eq (preceding-char) ?^) ; $^I
7482 (eq (char-after (- (point) 2)) ?\$))
7484 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
7486 ((and (eq (preceding-char) ?\=)
7487 (eq (current-column) 1))
7488 (forward-char -1))) ; =head1
7489 (if (and (eq (preceding-char) ?\<)
7490 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
7492 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7494 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
7496 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
7497 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
7499 ((and (eq (preceding-char) ?\$)
7500 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7502 ((and (eq (following-char) ?\>)
7503 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7506 (and (eq (preceding-char) ?\<)
7507 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
7508 (search-backward "<"))))
7509 ((and (eq (following-char) ?\$)
7510 (eq (preceding-char) ?\<)
7511 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
7513 (if (looking-at cperl-have-help-regexp)
7514 (buffer-substring (match-beginning 0) (match-end 0))))
7516 (defun cperl-get-help ()
7517 "Get one-line docs on the symbol at the point.
7518 The data for these docs is a little bit obsolete and may be in fact longer
7519 than a line. Your contribution to update/shorten it is appreciated."
7521 (save-match-data ; May be called "inside" query-replace
7523 (let ((word (cperl-word-at-point-hard)))
7525 (if (and cperl-help-from-timer ; Bail out if not in mainland
7526 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
7527 (or (memq (get-text-property (point) 'face)
7528 '(font-lock-comment-face font-lock-string-face))
7529 (memq (get-text-property (point) 'syntax-type)
7530 '(pod here-doc format))))
7532 (cperl-describe-perl-symbol word))
7533 (if cperl-message-on-help-error
7534 (message "Nothing found for %s..."
7535 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7537 ;;; Stolen from perl-descr.el by Johan Vromans:
7539 (defvar cperl-doc-buffer " *perl-doc*"
7540 "Where the documentation can be found.")
7542 (defun cperl-describe-perl-symbol (val)
7543 "Display the documentation of symbol at point, a Perl operator."
7544 (let ((enable-recursive-minibuffers t)
7547 ((string-match "^[&*][a-zA-Z_]" val)
7548 (setq val (concat (substring val 0 1) "NAME")))
7549 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
7550 (setq val (concat "@" (substring val 1 (match-end 1)))))
7551 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
7552 (setq val (concat "%" (substring val 1 (match-end 1)))))
7553 ((and (string= val "x") (string-match "^x=" val))
7555 ((string-match "^\\$[\C-a-\C-z]" val)
7556 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7557 ((string-match "^CORE::" val)
7558 (setq val "CORE::"))
7559 ((string-match "^SUPER::" val)
7560 (setq val "SUPER::"))
7561 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
7562 (setq val "<NAME>")))
7563 (setq regexp (concat "^"
7564 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
7566 "\\([ \t([/]\\|$\\)"))
7568 ;; get the buffer with the documentation text
7569 (cperl-switch-to-doc-buffer)
7571 ;; lookup in the doc
7572 (goto-char (point-min))
7573 (let ((case-fold-search nil))
7575 (if (re-search-forward regexp (point-max) t)
7577 (beginning-of-line 1)
7578 (let ((lnstart (point)))
7580 (message "%s" (buffer-substring lnstart (point)))))
7581 (if cperl-message-on-help-error
7582 (message "No definition for %s" val)))))))
7584 (defvar cperl-short-docs 'please-ignore-this-line
7585 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7586 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
7587 ... Range (list context); flip/flop [no flop when flip] (scalar context).
7588 ! ... Logical negation.
7589 ... != ... Numeric inequality.
7590 ... !~ ... Search pattern, substitution, or translation (negated).
7591 $! In numeric context: errno. In a string context: error string.
7592 $\" The separator which joins elements of arrays interpolated in strings.
7593 $# The output format for printed numbers. Default is %.15g or close.
7594 $$ Process number of this script. Changes in the fork()ed child process.
7595 $% The current page number of the currently selected output channel.
7597 The following variables are always local to the current block:
7599 $1 Match of the 1st set of parentheses in the last match (auto-local).
7600 $2 Match of the 2nd set of parentheses in the last match (auto-local).
7601 $3 Match of the 3rd set of parentheses in the last match (auto-local).
7602 $4 Match of the 4th set of parentheses in the last match (auto-local).
7603 $5 Match of the 5th set of parentheses in the last match (auto-local).
7604 $6 Match of the 6th set of parentheses in the last match (auto-local).
7605 $7 Match of the 7th set of parentheses in the last match (auto-local).
7606 $8 Match of the 8th set of parentheses in the last match (auto-local).
7607 $9 Match of the 9th set of parentheses in the last match (auto-local).
7608 $& The string matched by the last pattern match (auto-local).
7609 $' The string after what was matched by the last match (auto-local).
7610 $` The string before what was matched by the last match (auto-local).
7612 $( The real gid of this process.
7613 $) The effective gid of this process.
7614 $* Deprecated: Set to 1 to do multiline matching within a string.
7615 $+ The last bracket matched by the last search pattern.
7616 $, The output field separator for the print operator.
7617 $- The number of lines left on the page.
7618 $. The current input line number of the last filehandle that was read.
7619 $/ The input record separator, newline by default.
7620 $0 Name of the file containing the current perl script (read/write).
7621 $: String may be broken after these characters to fill ^-lines in a format.
7622 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
7623 $< The real uid of this process.
7624 $= The page length of the current output channel. Default is 60 lines.
7625 $> The effective uid of this process.
7626 $? The status returned by the last ``, pipe close or `system'.
7627 $@ The perl error message from the last eval or do @var{EXPR} command.
7628 $ARGV The name of the current file used with <> .
7629 $[ Deprecated: The index of the first element/char in an array/string.
7630 $\\ The output record separator for the print operator.
7631 $] The perl version string as displayed with perl -v.
7632 $^ The name of the current top-of-page format.
7633 $^A The current value of the write() accumulator for format() lines.
7634 $^D The value of the perl debug (-D) flags.
7635 $^E Information about the last system error other than that provided by $!.
7636 $^F The highest system file descriptor, ordinarily 2.
7637 $^H The current set of syntax checks enabled by `use strict'.
7638 $^I The value of the in-place edit extension (perl -i option).
7639 $^L What formats output to perform a formfeed. Default is \\f.
7640 $^M A buffer for emergency memory allocation when running out of memory.
7641 $^O The operating system name under which this copy of Perl was built.
7642 $^P Internal debugging flag.
7643 $^T The time the script was started. Used by -A/-M/-C file tests.
7644 $^W True if warnings are requested (perl -w flag).
7645 $^X The name under which perl was invoked (argv[0] in C-speech).
7646 $_ The default input and pattern-searching space.
7647 $| Auto-flush after write/print on current output channel? Default 0.
7648 $~ The name of the current report format.
7649 ... % ... Modulo division.
7650 ... %= ... Modulo division assignment.
7651 %ENV Contains the current environment.
7652 %INC List of files that have been require-d or do-ne.
7653 %SIG Used to set signal handlers for various signals.
7654 ... & ... Bitwise and.
7655 ... && ... Logical and.
7656 ... &&= ... Logical and assignment.
7657 ... &= ... Bitwise and assignment.
7658 ... * ... Multiplication.
7659 ... ** ... Exponentiation.
7660 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7661 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
7662 ... + ... Addition. +EXPR Makes EXPR into scalar context.
7663 ++ Auto-increment (magical on strings). ++EXPR EXPR++
7664 ... += ... Addition assignment.
7666 ... - ... Subtraction.
7667 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7668 ... -= ... Subtraction assignment.
7669 -A Access time in days since script started.
7670 -B File is a non-text (binary) file.
7671 -C Inode change time in days since script started.
7672 -M Age in days since script started.
7673 -O File is owned by real uid.
7674 -R File is readable by real uid.
7675 -S File is a socket .
7676 -T File is a text file.
7677 -W File is writable by real uid.
7678 -X File is executable by real uid.
7679 -b File is a block special file.
7680 -c File is a character special file.
7681 -d File is a directory.
7683 -f File is a plain file.
7684 -g File has setgid bit set.
7685 -k File has sticky bit set.
7686 -l File is a symbolic link.
7687 -o File is owned by effective uid.
7688 -p File is a named pipe (FIFO).
7689 -r File is readable by effective uid.
7690 -s File has non-zero size.
7691 -t Tests if filehandle (STDIN by default) is opened to a tty.
7692 -u File has setuid bit set.
7693 -w File is writable by effective uid.
7694 -x File is executable by effective uid.
7695 -z File has zero size.
7696 . Concatenate strings.
7697 .. Range (list context); flip/flop (scalar context) operator.
7698 .= Concatenate assignment strings
7699 ... / ... Division. /PATTERN/ioxsmg Pattern match
7700 ... /= ... Division assignment.
7701 /PATTERN/ioxsmg Pattern match.
7702 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
7703 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7704 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7705 <> Reads line from union of files in @ARGV (= command line) and STDIN.
7706 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7707 ... <= ... Numeric less than or equal to.
7708 ... <=> ... Numeric compare.
7709 ... = ... Assignment.
7710 ... == ... Numeric equality.
7711 ... =~ ... Search pattern, substitution, or translation
7712 ... > ... Numeric greater than.
7713 ... >= ... Numeric greater than or equal to.
7714 ... >> ... Bitwise shift right.
7715 ... >>= ... Bitwise shift right assignment.
7716 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7717 ?PATTERN? One-time pattern match.
7718 @ARGV Command line arguments (not including the command name - see $0).
7719 @INC List of places to look for perl scripts during do/include/use.
7720 @_ Parameter array for subroutines; result of split() unless in list context.
7721 \\ Creates reference to what follows, like \\$var, or quotes non-\\w in strings.
7722 \\0 Octal char, e.g. \\033.
7723 \\E Case modification terminator. See \\Q, \\L, and \\U.
7724 \\L Lowercase until \\E . See also \\l, lc.
7725 \\U Upcase until \\E . See also \\u, uc.
7726 \\Q Quote metacharacters until \\E . See also quotemeta.
7727 \\a Alarm character (octal 007).
7728 \\b Backspace character (octal 010).
7729 \\c Control character, e.g. \\c[ .
7730 \\e Escape character (octal 033).
7731 \\f Formfeed character (octal 014).
7732 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
7733 \\n Newline character (octal 012 on most systems).
7734 \\r Return character (octal 015 on most systems).
7735 \\t Tab character (octal 011).
7736 \\u Upcase the next character. See also \\U and \\l, ucfirst.
7737 \\x Hex character, e.g. \\x1b.
7738 ... ^ ... Bitwise exclusive or.
7739 __END__ Ends program source.
7740 __DATA__ Ends program source.
7741 __FILE__ Current (source) filename.
7742 __LINE__ Current line in current source.
7743 __PACKAGE__ Current package.
7744 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7745 ARGVOUT Output filehandle with -i flag.
7746 BEGIN { ... } Immediately executed (during compilation) piece of code.
7747 END { ... } Pseudo-subroutine executed after the script finishes.
7748 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7749 INIT { ... } Pseudo-subroutine executed before the script starts running.
7750 DATA Input filehandle for what follows after __END__ or __DATA__.
7751 accept(NEWSOCKET,GENERICSOCKET)
7764 ... cmp ... String compare.
7765 connect(SOCKET,NAME)
7766 continue of { block } continue { block }. Is executed after `next' or at end.
7768 crypt(PLAINTEXT,SALT)
7770 dbmopen(%HASH,DBNAME,MODE)
7774 do { ... }|SUBR while|until EXPR executes at least once
7775 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7785 ... eq ... String equality.
7786 eval(EXPR) or eval { BLOCK }
7787 exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
7790 fcntl(FILEHANDLE,FUNCTION,SCALAR)
7792 flock(FILEHANDLE,OPERATION)
7793 for (EXPR;EXPR;EXPR) { ... }
7794 foreach [VAR] (@ARRAY) { ... }
7796 ... ge ... String greater than or equal.
7801 gethostbyaddr(ADDR,ADDRTYPE)
7805 getnetbyaddr(ADDR,ADDRTYPE)
7811 getpriority(WHICH,WHO)
7812 getprotobyname(NAME)
7813 getprotobynumber(NUMBER)
7818 getservbyname(NAME,PROTO)
7819 getservbyport(PORT,PROTO)
7822 getsockopt(SOCKET,LEVEL,OPTNAME)
7825 ... gt ... String greater than.
7827 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7828 index(STR,SUBSTR[,OFFSET])
7830 ioctl(FILEHANDLE,FUNCTION,SCALAR)
7835 ... le ... String less than or equal.
7837 link(OLDFILE,NEWFILE)
7838 listen(SOCKET,QUEUESIZE)
7842 lstat(EXPR|FILEHANDLE|VAR)
7843 ... lt ... String less than.
7845 mkdir(FILENAME,MODE)
7848 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7849 msgsnd(ID,MSG,FLAGS)
7850 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
7851 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
7852 ... ne ... String inequality.
7855 open(FILEHANDLE[,EXPR])
7856 opendir(DIRHANDLE,EXPR)
7857 ord(EXPR) ASCII value of the first char of the string.
7859 package NAME Introduces package context.
7860 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7862 print [FILEHANDLE] [(LIST)]
7863 printf [FILEHANDLE] (FORMAT,LIST)
7865 q/STRING/ Synonym for 'STRING'
7866 qq/STRING/ Synonym for \"STRING\"
7867 qx/STRING/ Synonym for `STRING`
7869 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7872 recv(SOCKET,SCALAR,LEN,FLAGS)
7874 rename(OLDNAME,NEWNAME)
7875 require [FILENAME | PERL_VERSION]
7879 rewinddir(DIRHANDLE)
7880 rindex(STR,SUBSTR[,OFFSET])
7882 s/PATTERN/REPLACEMENT/gieoxsm
7884 seek(FILEHANDLE,POSITION,WHENCE)
7885 seekdir(DIRHANDLE,POS)
7886 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7887 semctl(ID,SEMNUM,CMD,ARG)
7888 semget(KEY,NSEMS,SIZE,FLAGS)
7890 send(SOCKET,MSG,FLAGS[,TO])
7892 sethostent(STAYOPEN)
7895 setpriority(WHICH,WHO,PRIORITY)
7896 setprotoent(STAYOPEN)
7898 setservent(STAYOPEN)
7899 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7902 shmget(KEY,SIZE,FLAGS)
7903 shmread(ID,VAR,POS,SIZE)
7904 shmwrite(ID,STRING,POS,SIZE)
7905 shutdown(SOCKET,HOW)
7908 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7909 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7910 sort [SUBROUTINE] (LIST)
7911 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7912 split[(/PATTERN/[,EXPR[,LIMIT]])]
7913 sprintf(FORMAT,LIST)
7916 stat(EXPR|FILEHANDLE|VAR)
7918 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7919 substr(EXPR,OFFSET[,LEN])
7920 symlink(OLDFILE,NEWFILE)
7922 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7923 system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
7924 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7929 tr/SEARCHLIST/REPLACEMENTLIST/cds
7930 truncate(FILE|EXPR,LENGTH)
7933 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7935 unpack(TEMPLATE,EXPR)
7937 until (EXPR) { ... } EXPR until EXPR
7940 vec(EXPR,OFFSET,BITS)
7943 wantarray Returns true if the sub/eval is called in list context.
7945 while (EXPR) { ... } EXPR while EXPR
7946 write[(EXPR|FILEHANDLE)]
7947 ... x ... Repeat string or array.
7948 x= ... Repetition assignment.
7949 y/SEARCHLIST/REPLACEMENTLIST/
7950 ... | ... Bitwise or.
7951 ... || ... Logical or.
7952 ~ ... Unary bitwise complement.
7953 #! OS interpreter indicator. If contains `perl', used for options, and -x.
7954 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7955 CORE:: Prefix to access builtin function if imported sub obscures it.
7956 SUPER:: Prefix to lookup for a method in @ISA classes.
7957 DESTROY Shorthand for `sub DESTROY {...}'.
7958 ... EQ ... Obsolete synonym of `eq'.
7959 ... GE ... Obsolete synonym of `ge'.
7960 ... GT ... Obsolete synonym of `gt'.
7961 ... LE ... Obsolete synonym of `le'.
7962 ... LT ... Obsolete synonym of `lt'.
7963 ... NE ... Obsolete synonym of `ne'.
7964 abs [ EXPR ] absolute value
7965 ... and ... Low-precedence synonym for &&.
7966 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7967 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
7968 chr Converts a number to char with the same ordinal.
7969 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7970 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7971 exists $HASH{KEY} True if the key exists.
7972 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7973 formline PICTURE, LIST Backdoor into \"format\" processing.
7974 glob EXPR Synonym of <EXPR>.
7975 lc [ EXPR ] Returns lowercased EXPR.
7976 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
7977 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
7978 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
7979 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
7980 not ... Low-precedence synonym for ! - negation.
7981 ... or ... Low-precedence synonym for ||.
7982 pos STRING Set/Get end-position of the last match over this string, see \\G.
7983 quotemeta [ EXPR ] Quote regexp metacharacters.
7984 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
7985 readline FH Synonym of <FH>.
7986 readpipe CMD Synonym of `CMD`.
7987 ref [ EXPR ] Type of EXPR when dereferenced.
7988 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
7989 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
7990 tied Returns internal object for a tied data.
7991 uc [ EXPR ] Returns upcased EXPR.
7992 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
7993 untie VAR Unlink an object from a simple Perl variable.
7994 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
7995 ... xor ... Low-precedence synonym for exclusive or.
7996 prototype \\&SUB Returns prototype of the function given a reference.
7997 =head1 Top-level heading.
7998 =head2 Second-level heading.
7999 =head3 Third-level heading (is there such?).
8000 =over [ NUMBER ] Start list.
8001 =item [ TITLE ] Start new item in the list.
8003 =cut Switch from POD to Perl.
8004 =pod Switch from Perl to POD.
8007 (defun cperl-switch-to-doc-buffer (&optional interactive)
8008 "Go to the perl documentation buffer and insert the documentation."
8010 (let ((buf (get-buffer-create cperl-doc-buffer)))
8012 (switch-to-buffer-other-window buf)
8014 (if (= (buffer-size) 0)
8016 (insert (documentation-property 'cperl-short-docs
8017 'variable-documentation))
8018 (setq buffer-read-only t)))))
8020 (defun cperl-beautify-regexp-piece (b e embed level)
8021 ;; b is before the starting delimiter, e before the ending
8022 ;; e should be a marker, may be changed, but remains "correct".
8023 ;; EMBED is nil if we process the whole REx.
8024 ;; The REx is guaranteed to have //x
8025 ;; LEVEL shows how many levels deep to go
8026 ;; position at enter and at leave is not defined
8027 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8031 (setq c (if (eq embed t) (current-indentation) (current-column)))
8032 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8036 ((looking-at "(\\?[^a-zA-Z]")
8038 ((looking-at "(\\?") ; (?i)
8043 (setq c (1- (current-column))))
8044 (setq c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
8045 (or (looking-at "[ \t]*[\n#]")
8050 (if (re-search-forward "[^ \t]" e t)
8051 (progn ; Something before the ending delimiter
8053 (delete-horizontal-space)
8055 (cperl-make-indent c)
8056 (set-marker e (point))))
8059 (while (< (point) (marker-position e))
8063 (skip-chars-forward " \t")
8064 (delete-region s (point))
8065 (cperl-make-indent c1)
8069 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8070 "\\|" ; Embedded variable
8071 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8074 "\\|" ; simple-code simple-code*?
8075 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8079 "\\((\\(\\?\\)?\\)" ; 7 8
8082 (goto-char (match-end 0))
8084 (cond ((match-beginning 1) ; Alphanum word + junk
8086 ((or (match-beginning 3) ; $ab[12]
8087 (and (match-beginning 5) ; X* X+ X{2,3}
8088 (eq (preceding-char) ?\{)))
8091 ((and ; [], already syntaxified
8094 cperl-use-syntax-table-text-property)
8097 (or (eq (preceding-char) ?\])
8098 (error "[]-group not terminated"))
8100 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8101 ((match-beginning 6) ; []
8103 (if (looking-at "\\^?\\]")
8104 (goto-char (match-end 0)))
8105 ;; XXXX POSIX classes?!
8106 (while (and (not pos)
8107 (re-search-forward "\\[:\\|\\]" e t))
8108 (if (eq (preceding-char) ?:)
8109 (or (re-search-forward ":\\]" e t)
8110 (error "[:POSIX:]-group in []-group not terminated"))
8112 (or (eq (preceding-char) ?\])
8113 (error "[]-group not terminated"))
8115 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8116 ((match-beginning 7) ; ()
8117 (goto-char (match-beginning 0))
8118 (setq pos (current-column))
8121 (delete-horizontal-space)
8123 (cperl-make-indent c1)))
8126 ;; (or (forward-sexp 1)
8129 ;; (error "()-group not terminated")))
8130 (set-marker m (1- (point)))
8131 (set-marker m1 (point))
8133 (if (progn ; indent rigidly if multiline
8134 ;; In fact does not make a lot of sense, since
8135 ;; the starting position can be already lost due
8136 ;; to insertion of "\n" and " "
8138 (search-forward "\n" m1 t))
8139 (indent-rigidly (point) m1 (- c1 pos)))
8140 (setq level (1- level))
8142 ((not (match-beginning 8))
8143 (cperl-beautify-regexp-piece tmp m t level))
8144 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8146 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8147 (goto-char (+ 2 tmp))
8149 (cperl-beautify-regexp-piece (point) m t level))
8150 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8151 (goto-char (+ 3 tmp))
8152 (cperl-beautify-regexp-piece (point) m t level))
8154 (cperl-beautify-regexp-piece tmp m t level))))
8156 (cond ((looking-at "[*+?]\\??")
8157 (goto-char (match-end 0)))
8158 ((eq (following-char) ?\{)
8160 (if (eq (following-char) ?\?)
8162 (skip-chars-forward " \t")
8164 (if (looking-at "[#\n]")
8166 (or (eolp) (indent-for-comment))
8167 (beginning-of-line 2))
8168 (delete-horizontal-space)
8172 ((match-beginning 9) ; |
8176 (if (re-search-forward "[^ \t]" tmp t)
8179 (delete-horizontal-space)
8182 (delete-region (point) tmp))
8183 (cperl-make-indent c)
8185 (skip-chars-forward " \t")
8187 (if (looking-at "[#\n]")
8188 (beginning-of-line 2)
8189 (delete-horizontal-space)
8193 (or (looking-at "[ \t\n]")
8196 (skip-chars-forward " \t"))
8197 (or (looking-at "[#\n]")
8198 (error "Unknown code `%s' in a regexp"
8199 (buffer-substring (point) (1+ (point)))))
8200 (and inline (end-of-line 2)))
8201 ;; Special-case the last line of group
8202 (if (and (>= (point) (marker-position e))
8203 (/= (current-indentation) c))
8206 (cperl-make-indent c)))))
8208 (defun cperl-make-regexp-x ()
8209 ;; Returns position of the start
8210 ;; XXX this is called too often! Need to cache the result!
8212 (or cperl-use-syntax-table-text-property
8213 (error "I need to have a regexp marked!"))
8215 (if (looking-at "\\s|")
8217 (if (or (looking-at "\\([smy]\\|qr\\)\\s|")
8218 (and (eq (preceding-char) ?q)
8219 (looking-at "\\(r\\)\\s|")))
8220 (goto-char (match-end 1))
8221 (re-search-backward "\\s|"))) ; Assume it is scanned already.
8223 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8224 (sub-p (eq (preceding-char) ?s)) s)
8226 (set-marker e (1- (point)))
8227 (setq delim (preceding-char))
8228 (if (and sub-p (eq delim (char-after (- (point) 2))))
8229 (error "Possible s/blah// - do not know how to deal with"))
8230 (if sub-p (forward-sexp 1))
8231 (if (looking-at "\\sw*x")
8234 ;; Protect fragile " ", "#"
8237 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8243 (defun cperl-beautify-regexp (&optional deep)
8244 "Do it. (Experimental, may change semantics, recheck the result.)
8245 We suppose that the regexp is scanned already."
8247 (setq deep (if deep (prefix-numeric-value deep) -1))
8249 (goto-char (cperl-make-regexp-x))
8250 (let ((b (point)) (e (make-marker)))
8252 (set-marker e (1- (point)))
8253 (cperl-beautify-regexp-piece b e nil deep))))
8255 (defun cperl-regext-to-level-start ()
8256 "Goto start of an enclosing group in regexp.
8257 We suppose that the regexp is scanned already."
8259 (let ((limit (cperl-make-regexp-x)) done)
8261 (or (eq (following-char) ?\()
8262 (search-backward "(" (1+ limit) t)
8263 (error "Cannot find `(' which starts a group"))
8266 (skip-chars-backward "\\")
8267 (looking-at "\\(\\\\\\\\\\)*(")))
8268 (or done (forward-char -1)))))
8270 (defun cperl-contract-level ()
8271 "Find an enclosing group in regexp and contract it.
8272 \(Experimental, may change semantics, recheck the result.)
8273 We suppose that the regexp is scanned already."
8275 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
8276 (cperl-regext-to-level-start)
8277 (let ((b (point)) (e (make-marker)) c)
8279 (set-marker e (1- (point)))
8281 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
8283 ((match-beginning 1) ; #-comment
8284 (or c (setq c (current-indentation)))
8285 (beginning-of-line 2) ; Skip
8286 (cperl-make-indent c))
8289 (just-one-space))))))
8291 (defun cperl-contract-levels ()
8292 "Find an enclosing group in regexp and contract all the kids.
8293 \(Experimental, may change semantics, recheck the result.)
8294 We suppose that the regexp is scanned already."
8298 (cperl-regext-to-level-start)
8299 (error ; We are outside outermost group
8300 (goto-char (cperl-make-regexp-x))))
8301 (let ((b (point)) (e (make-marker)) s c)
8303 (set-marker e (1- (point)))
8305 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
8307 ((match-beginning 1) ; Skip
8310 (cperl-contract-level)))))))
8312 (defun cperl-beautify-level (&optional deep)
8313 "Find an enclosing group in regexp and beautify it.
8314 \(Experimental, may change semantics, recheck the result.)
8315 We suppose that the regexp is scanned already."
8317 (setq deep (if deep (prefix-numeric-value deep) -1))
8319 (cperl-regext-to-level-start)
8320 (let ((b (point)) (e (make-marker)))
8322 (set-marker e (1- (point)))
8323 (cperl-beautify-regexp-piece b e 'level deep))))
8325 (defun cperl-invert-if-unless-modifiers ()
8326 "Change `B if A;' into `if (A) {B}' etc if possible.
8329 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8330 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
8331 (and (= (char-syntax (preceding-char)) ?w)
8333 (setq pre-if (point))
8334 (cperl-backward-to-start-of-expr)
8335 (setq pre-B (point))
8336 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8337 (cperl-forward-to-end-of-expr)
8338 (setq post-A (point))
8340 (or (looking-at w-rex)
8341 ;; Find the position
8342 (progn (goto-char post-A)
8344 (not (looking-at w-rex))
8347 (setq pre-if (point))))
8348 (or (looking-at w-rex)
8349 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8350 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8351 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8352 ;; First, simple part: find code boundaries
8354 (setq post-if (point))
8357 (setq post-B (point))
8358 (cperl-backward-to-start-of-expr)
8359 (setq pre-B (point))
8360 (setq B (buffer-substring pre-B post-B))
8364 ;; May be after $, @, $# etc of a variable
8365 (skip-chars-backward "$@%#")
8366 (setq pre-A (point))
8367 (cperl-forward-to-end-of-expr)
8368 (setq post-A (point))
8369 (setq A (buffer-substring pre-A post-A))
8370 ;; Now modify (from end, to not break the stuff)
8371 (skip-chars-forward " \t;")
8372 (delete-region pre-A (point)) ; we move to pre-A
8373 (insert "\n" B ";\n}")
8374 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
8375 (delete-region pre-if post-if)
8376 (delete-region pre-B post-B)
8378 (insert if-string " (" A ") {")
8379 (setq post-B (point))
8380 (if (looking-at "[ \t]+$")
8381 (delete-horizontal-space)
8382 (if (looking-at "[ \t]*#")
8383 (cperl-indent-for-comment)
8386 (if (looking-at "[ \t]*$")
8387 (progn ; delete line
8388 (delete-horizontal-space)
8389 (delete-region (point) (1+ (point)))))
8391 (goto-char (1- post-B))
8396 (defun cperl-invert-if-unless ()
8397 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8398 If the cursor is not on the leading keyword of the BLOCK flavor of
8399 construct, will assume it is the STATEMENT flavor, so will try to find
8400 the appropriate statement modifier."
8402 (and (= (char-syntax (preceding-char)) ?w)
8404 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
8405 (let ((pre-if (point))
8406 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8407 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
8409 (setq post-A (point))
8411 (setq pre-A (point))
8412 (setq is-block (and (eq (following-char) ?\( )
8418 (eq (following-char) ?\{ ))
8424 (setq post-B (point))
8426 (setq pre-B (point))
8427 (if (and (eq (following-char) ?\{ )
8429 (cperl-backward-to-noncomment post-A)
8430 (eq (preceding-char) ?\) )))
8431 (if (condition-case nil
8436 (looking-at "\\<els\\(e\\|if\\)\\>"))
8439 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8440 (goto-char (1- post-B))
8441 (cperl-backward-to-noncomment pre-B)
8442 (if (eq (preceding-char) ?\;)
8444 (setq end-B-code (point))
8446 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
8447 (setq p (match-beginning 0)
8448 A (buffer-substring p (match-end 0))
8449 state (parse-partial-sexp pre-B p))
8453 (error "`%s' inside `%s' BLOCK" A if-string))
8454 (goto-char (match-end 0)))
8456 (goto-char (1+ pre-B))
8457 (skip-chars-forward " \t\n")
8458 (setq B (buffer-substring (point) end-B-code))
8459 (goto-char end-B-code)
8460 (or (looking-at ";?[ \t\n]*}")
8462 (skip-chars-forward "; \t\n")
8464 (buffer-substring (point) (1- post-B)))))
8467 (goto-char (1- post-A))
8468 (cperl-backward-to-noncomment pre-A)
8469 (or (looking-at "[ \t\n]*)")
8470 (goto-char (1- post-A)))
8472 (goto-char (1+ pre-A))
8473 (skip-chars-forward " \t\n")
8474 (setq A (buffer-substring (point) p))
8475 (delete-region pre-B post-B)
8476 (delete-region pre-A post-A)
8479 (and B-comment (insert B-comment " "))
8482 (setq pre-A (point))
8484 (delete-horizontal-space)
8485 (setq post-B (point))
8486 (if (looking-at "#")
8487 (indent-for-comment))
8490 (delete-horizontal-space)
8494 (setq pre-A (set-marker (make-marker) pre-A))
8495 (while (<= (point) (marker-position pre-A))
8498 (goto-char (marker-position pre-A))
8502 (indent-for-comment)
8503 (goto-char (marker-position pre-A)))))
8504 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8505 ;; (error "`%s' not with an (EXPR)" if-string)
8507 (cperl-invert-if-unless-modifiers)))
8508 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8509 (cperl-invert-if-unless-modifiers)))
8511 ;;; By Anthony Foiani <afoiani@uswest.com>
8512 ;;; Getting help on modules in C-h f ?
8513 ;;; This is a modified version of `man'.
8514 ;;; Need to teach it how to lookup functions
8516 (defun cperl-perldoc (word)
8517 "Run `perldoc' on WORD."
8519 (list (let* ((default-entry (cperl-word-at-point))
8521 (format "perldoc entry%s: "
8522 (if (string= default-entry "")
8524 (format " (default %s)" default-entry))))))
8525 (if (string= input "")
8526 (if (string= default-entry "")
8527 (error "No perldoc args given")
8531 (let* ((case-fold-search nil)
8533 (string-match "^[a-z]+$" word)
8534 (string-match (concat "^" word "\\>")
8535 (documentation-property
8537 'variable-documentation))))
8539 (manual-program (if is-func "perldoc -f" "perldoc")))
8542 (let ((Manual-program "perldoc")
8543 (Manual-switches (if is-func (list "-f"))))
8544 (manual-entry word)))
8546 (Man-getpage-in-background word)))))
8549 (defun cperl-perldoc-at-point ()
8550 "Run a `perldoc' on the word around point."
8552 (cperl-perldoc (cperl-word-at-point)))
8554 (defcustom pod2man-program "pod2man"
8555 "*File name for `pod2man'."
8559 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
8560 (defun cperl-pod-to-manpage ()
8561 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8564 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8565 (bufname (concat "Man " buffer-file-name))
8566 (buffer (generate-new-buffer bufname)))
8567 (with-current-buffer buffer
8568 (let ((process-environment (copy-sequence process-environment)))
8569 ;; Prevent any attempt to use display terminal fanciness.
8570 (setenv "TERM" "dumb")
8571 (set-process-sentinel
8572 (start-process pod2man-program buffer "sh" "-c"
8573 (format (cperl-pod2man-build-command) pod2man-args))
8574 'Man-bgproc-sentinel)))))
8576 ;;; Updated version by him too
8577 (defun cperl-build-manpage ()
8578 "Create a virtual manpage in Emacs from the POD in the file."
8583 (let ((Manual-program "perldoc"))
8584 (manual-entry buffer-file-name)))
8586 (let* ((manual-program "perldoc")
8588 (Man-getpage-in-background buffer-file-name)))))
8590 (defun cperl-pod2man-build-command ()
8591 "Builds the entire background manpage and cleaning command."
8592 (let ((command (concat pod2man-program " %s 2>/dev/null"))
8593 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
8594 (while (and flist (car flist))
8595 (let ((pcom (car (car flist)))
8596 (pargs (cdr (car flist))))
8598 (concat command " | " pcom " "
8599 (mapconcat '(lambda (phrase)
8600 (if (not (stringp phrase))
8601 (error "Malformed Man-filter-list"))
8604 (setq flist (cdr flist))))
8608 (defun cperl-next-interpolated-REx-1 ()
8609 "Move point to next REx which has interpolated parts without //o.
8610 Skips RExes consisting of one interpolated variable.
8612 Note that skipped RExen are not performance hits."
8614 (cperl-next-interpolated-REx 1))
8616 (defun cperl-next-interpolated-REx-0 ()
8617 "Move point to next REx which has interpolated parts without //o."
8619 (cperl-next-interpolated-REx 0))
8621 (defun cperl-next-interpolated-REx (&optional skip beg limit)
8622 "Move point to next REx which has interpolated parts.
8623 SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8624 point and the limit of search (default to point and end of buffer).
8626 SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8627 semantic may be used as a numeric argument.
8629 Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8630 a result of qr//, this is not a performance hit), t for the rest."
8632 (if (numberp skip) (setq skip (list 0 skip)))
8633 (or beg (setq beg (point)))
8634 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8636 (and (eq (get-text-property beg 'syntax-type) 'string)
8637 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8638 (cperl-map-pods-heres
8639 (function (lambda (s e p)
8640 (if (memq (get-text-property s 'REx-interpolated) skip)
8644 'REx-interpolated beg limit)
8645 (if pp (goto-char pp)
8646 (message "No more interpolated REx"))))
8648 ;;; Initial version contributed by Trey Belew
8649 (defun cperl-here-doc-spell (&optional beg end)
8650 "Spell-check HERE-documents in the Perl buffer.
8651 If a region is highlighted, restricts to the region."
8653 (cperl-pod-spell t beg end))
8655 (defun cperl-pod-spell (&optional do-heres beg end)
8656 "Spell-check POD documentation.
8657 If invoked with prefix argument, will do HERE-DOCs instead.
8658 If a region is highlighted, restricts to the region."
8662 (if (cperl-mark-active)
8663 (setq beg (min (mark) (point))
8664 end (max (mark) (point)))
8665 (setq beg (point-min)
8667 (cperl-map-pods-heres (function
8670 (setq e (save-excursion
8676 (if do-heres 'here-doc-group 'in-pod)
8679 (defun cperl-map-pods-heres (func &optional prop s end)
8680 "Executes a function over regions of pods or here-documents.
8681 PROP is the text-property to search for; default to `in-pod'. Stop when
8682 function returns nil."
8683 (let (pos posend has-prop (cont t))
8684 (or prop (setq prop 'in-pod))
8685 (or s (setq s (point-min)))
8686 (or end (setq end (point-max)))
8687 (cperl-update-syntaxification end end)
8689 (goto-char (setq pos s))
8690 (while (and cont (< pos end))
8691 (setq has-prop (get-text-property pos prop))
8692 (setq posend (next-single-property-change pos prop nil end))
8694 (setq cont (funcall func pos posend prop)))
8695 (setq pos posend)))))
8697 ;;; Based on code by Masatake YAMATO:
8698 (defun cperl-get-here-doc-region (&optional pos pod)
8699 "Return HERE document region around the point.
8700 Return nil if the point is not in a HERE document region. If POD is non-nil,
8701 will return a POD section if point is in a POD section."
8702 (or pos (setq pos (point)))
8703 (cperl-update-syntaxification pos pos)
8704 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8706 (eq 'pod (get-text-property pos 'syntax-type))))
8707 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8708 (e (next-single-property-change pos 'syntax-type)))
8709 (cons b (or e (point-max))))))
8711 (defun cperl-narrow-to-here-doc (&optional pos)
8712 "Narrows editing region to the HERE-DOC at POS.
8713 POS defaults to the point."
8715 (or pos (setq pos (point)))
8716 (let ((p (cperl-get-here-doc-region pos)))
8717 (or p (error "Not inside a HERE document"))
8718 (narrow-to-region (car p) (cdr p))
8720 "When you are finished with narrow editing, type C-x n w")))
8722 (defun cperl-select-this-pod-or-here-doc (&optional pos)
8723 "Select the HERE-DOC (or POD section) at POS.
8724 POS defaults to the point."
8726 (let ((p (cperl-get-here-doc-region pos t)))
8730 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8731 (message "I do not think POS is in POD or a HERE-doc..."))))
8733 (defun cperl-facemenu-add-face-function (face end)
8734 "A callback to process user-initiated font-change requests.
8735 Translates `bold', `italic', and `bold-italic' requests to insertion of
8736 corresponding POD directives, and `underline' to C<> POD directive.
8738 Such requests are usually bound to M-o LETTER."
8739 (or (get-text-property (point) 'in-pod)
8740 (error "Faces can only be set within POD"))
8741 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8742 (cdr (or (assq face '((bold . "B<")
8744 (bold-italic . "B<I<")
8745 (underline . "C<")))
8746 (error "Face %s not configured for cperl-mode"
8749 (defun cperl-time-fontification (&optional l step lim)
8750 "Times how long it takes to do incremental fontification in a region.
8751 L is the line to start at, STEP is the number of lines to skip when
8752 doing next incremental fontification, LIM is the maximal number of
8753 incremental fontification to perform. Messages are accumulated in
8756 May be used for pinpointing which construct slows down buffer fontification:
8757 start with default arguments, then refine the slowdown regions."
8758 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
8760 (or step (setq step 500))
8761 (or lim (setq lim 40))
8762 (let* ((timems (function (lambda ()
8763 (let ((tt (current-time)))
8764 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8765 (tt (funcall timems)) (c 0) delta tot)
8766 (goto-char (point-min))
8767 (forward-line (1- l))
8769 (setq tot (- (- tt (setq tt (funcall timems)))))
8770 (message "cperl-mode at %s: %s" l tot)
8771 (while (and (< c lim) (not (eobp)))
8775 (cperl-update-syntaxification (point) (point))
8776 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8777 (message "to %s:%6s,%7s" l delta tot))
8780 (defvar font-lock-cache-position)
8782 (defun cperl-emulate-lazy-lock (&optional window-size)
8783 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8784 Start fontifying the buffer from the start (or end) using the given
8785 WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8786 goes backwards; default is -50. This function is not CPerl-specific; it
8787 may be used to debug problems with delayed incremental fontification."
8789 "nSize of window for incremental fontification, negative goes backwards: ")
8790 (or window-size (setq window-size -50))
8791 (let ((pos (if (> window-size 0)
8797 ;; Why needed??? With older font-locks???
8798 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8799 (while (if (> window-size 0)
8801 (> pos (point-min)))
8803 (forward-line window-size)
8805 (font-lock-fontify-region (min p pos) (max p pos))
8809 (defun cperl-lazy-install ()) ; Avoid a warning
8810 (defun cperl-lazy-unstall ()) ; Avoid a warning
8812 (if (fboundp 'run-with-idle-timer)
8814 (defvar cperl-help-shown nil
8815 "Non-nil means that the help was already shown now.")
8817 (defvar cperl-lazy-installed nil
8818 "Non-nil means that the lazy-help handlers are installed now.")
8820 (defun cperl-lazy-install ()
8821 "Switches on Auto-Help on Perl constructs (put in the message area).
8822 Delay of auto-help controlled by `cperl-lazy-help-time'."
8824 (make-local-variable 'cperl-help-shown)
8825 (if (and (cperl-val 'cperl-lazy-help-time)
8826 (not cperl-lazy-installed))
8828 (add-hook 'post-command-hook 'cperl-lazy-hook)
8829 (run-with-idle-timer
8830 (cperl-val 'cperl-lazy-help-time 1000000 5)
8832 'cperl-get-help-defer)
8833 (setq cperl-lazy-installed t))))
8835 (defun cperl-lazy-unstall ()
8836 "Switches off Auto-Help on Perl constructs (put in the message area).
8837 Delay of auto-help controlled by `cperl-lazy-help-time'."
8839 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8840 (cancel-function-timers 'cperl-get-help-defer)
8841 (setq cperl-lazy-installed nil))
8843 (defun cperl-lazy-hook ()
8844 (setq cperl-help-shown nil))
8846 (defun cperl-get-help-defer ()
8847 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
8848 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8850 (setq cperl-help-shown t))))
8851 (cperl-lazy-install)))
8854 ;;; Plug for wrong font-lock:
8856 (defun cperl-font-lock-unfontify-region-function (beg end)
8857 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8858 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8859 before-change-functions after-change-functions
8860 deactivate-mark buffer-file-name buffer-file-truename)
8861 (remove-text-properties beg end '(face nil))
8862 (if (and (not modified) (buffer-modified-p))
8863 (set-buffer-modified-p nil))))
8865 (defun cperl-font-lock-fontify-region-function (beg end loudly)
8866 "Extends the region to safe positions, then calls the default function.
8867 Newer `font-lock's can do it themselves.
8868 We unwind only as far as needed for fontification. Syntaxification may
8869 do extra unwind via `cperl-unwind-to-safe'."
8875 (eq (get-text-property (setq beg (point)) 'syntax-type)
8877 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8883 (or (bolp) (condition-case nil
8886 (eq (get-text-property (setq end (point)) 'syntax-type)
8888 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8891 (font-lock-default-fontify-region beg end loudly))
8893 (defvar cperl-d-l nil)
8894 (defun cperl-fontify-syntaxically (end)
8895 ;; Some vars for debugging only
8896 ;; (message "Syntaxifying...")
8897 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
8898 (istate (car cperl-syntax-state))
8899 start from-start edebug-backtrace-buffer)
8900 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8903 (let ((f 'edebug-backtrace))
8904 (funcall f)))) ; Avoid compile-time warning
8905 (or cperl-syntax-done-to
8906 (setq cperl-syntax-done-to (point-min)
8908 (setq start (if (and cperl-hook-after-change
8910 cperl-syntax-done-to ; Fontify without change; ignore start
8911 ;; Need to forget what is after `start'
8912 (min cperl-syntax-done-to (point))))
8915 (setq start (point))
8916 (and cperl-syntaxify-unwind
8917 (setq end (cperl-unwind-to-safe t end)
8920 (setq cperl-syntax-done-to start) ; In case what follows fails
8921 (cperl-find-pods-heres start end t nil t))
8922 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8923 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8924 dbg iend start end idone cperl-syntax-done-to
8925 istate (car cperl-syntax-state))) ; For debugging
8926 nil)) ; Do not iterate
8928 (defun cperl-fontify-update (end)
8929 (let ((pos (point-min)) prop posend)
8930 (setq end (point-max))
8932 (setq prop (get-text-property pos 'cperl-postpone)
8933 posend (next-single-property-change pos 'cperl-postpone nil end))
8934 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8936 nil) ; Do not iterate
8938 (defun cperl-fontify-update-bad (end)
8939 ;; Since fontification happens with different region than syntaxification,
8940 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8941 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8943 (setq pos (or (cperl-beginning-of-property
8944 (cperl-1+ pos) 'cperl-postpone)
8947 (setq posend (next-single-property-change pos 'cperl-postpone))
8948 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8950 (setq prop (get-text-property pos 'cperl-postpone))))
8951 nil) ; Do not iterate
8953 ;; Called when any modification is made to buffer text.
8954 (defun cperl-after-change-function (beg end old-len)
8955 ;; We should have been informed about changes by `font-lock'. Since it
8956 ;; does not inform as which calls are defered, do it ourselves
8957 (if cperl-syntax-done-to
8958 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8960 (defun cperl-update-syntaxification (from to)
8961 (if (and cperl-use-syntax-table-text-property
8962 cperl-syntaxify-by-font-lock
8963 (or (null cperl-syntax-done-to)
8964 (< cperl-syntax-done-to to)))
8968 (cperl-fontify-syntaxically to)))))
8970 (defvar cperl-version
8971 (let ((v "Revision: 6.2"))
8972 (string-match ":\\s *\\([0-9.]+\\)" v)
8973 (substring v (match-beginning 1) (match-end 1)))
8974 "Version of IZ-supported CPerl package this file is based on.")
8976 (defun cperl-mode-unload-function ()
8977 "Unload the Cperl mode library."
8978 (let ((new-mode (if (eq (symbol-function 'perl-mode) 'cperl-mode)
8981 (dolist (buf (buffer-list))
8982 (with-current-buffer buf
8983 (when (eq major-mode 'cperl-mode)
8984 (funcall new-mode)))))
8985 ;; continue standard unloading
8988 (provide 'cperl-mode)
8990 ;;; cperl-mode.el ends here