1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
5 ;; Free Software Foundation, Inc.
7 ;; Author: Ilya Zakharevich and Bob Olson
8 ;; Maintainer: Ilya Zakharevich <cperl@ilyaz.org>
9 ;; Keywords: languages, Perl
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
28 ;;; Corrections made by Ilya Zakharevich cperl@ilyaz.org
32 ;; You can either fine-tune the bells and whistles of this mode or
33 ;; bulk enable them by putting
35 ;; (setq cperl-hairy t)
37 ;; in your .emacs file. (Emacs rulers do not consider it politically
38 ;; correct to make whistles enabled by default.)
40 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
41 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
42 ;; `cperl-praise', `cperl-speed'. <<<<<<
44 ;; The mode information (on C-h m) provides some customization help.
45 ;; If you use font-lock feature of this mode, it is advisable to use
46 ;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
48 ;; Faces used now: three faces for first-class and second-class keywords
49 ;; and control flow words, one for each: comments, string, labels,
50 ;; functions definitions and packages, arrays, hashes, and variable
51 ;; definitions. If you do not see all these faces, your font-lock does
52 ;; not define them, so you need to define them manually.
54 ;; This mode supports font-lock, imenu and mode-compile. In the
55 ;; hairy version font-lock is on, but you should activate imenu
56 ;; yourself (note that mode-compile is not standard yet). Well, you
57 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
58 ;; to bind it like that:
60 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
62 ;;; Font lock bugs as of v4.32:
64 ;; The following kinds of Perl code erroneously start strings:
66 ;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
67 ;; likewise with m, tr, y, q, qX instead of s
71 ;; Some macros are needed for `defcustom'
76 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
77 (defvar cperl-can-font-lock
79 (and (boundp 'emacs-major-version)
81 (> emacs-major-version 20)))))
82 (if cperl-can-font-lock
84 (defvar msb-menu-cond)
85 (defvar gud-perldb-history)
86 (defvar font-lock-background-mode) ; not in Emacs
87 (defvar font-lock-display-type) ; ditto
88 (defmacro cperl-is-face (arg) ; Takes quoted arg
89 (cond ((fboundp 'find-face)
91 (;;(and (fboundp 'face-list)
94 `(member ,arg (and (fboundp 'face-list)
98 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
99 (cond ((fboundp 'make-face)
100 `(make-face (quote ,arg)))
102 `(defvar ,arg (quote ,arg) ,descr))))
103 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
105 (or (cperl-is-face (quote ,arg))
106 (cperl-make-face ,arg ,descr))
107 (or (boundp (quote ,arg)) ; We use unquoted variants too
108 (defvar ,arg (quote ,arg) ,descr))))
110 (defmacro cperl-etags-snarf-tag (file line)
112 (beginning-of-line 2)
114 (defmacro cperl-etags-snarf-tag (file line)
117 (defmacro cperl-etags-goto-tag-location (elt)
119 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
120 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
121 ;; Probably will not work due to some save-excursion???
122 ;; Or save-file-position?
123 ;; (message "Did I get to line %s?" (elt (, elt) 1))
124 `(goto-line (string-to-number (elt ,elt 1))))
126 (defmacro cperl-etags-goto-tag-location (elt)
127 `(etags-goto-tag-location ,elt))))
129 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
131 (defvar cperl-can-font-lock
133 (and (boundp 'emacs-major-version)
135 (> emacs-major-version 20)))))
137 (defun cperl-choose-color (&rest list)
141 (if (or (x-color-defined-p (car list))
143 (setq answer (car list))))
144 (setq list (cdr list)))
148 "Major mode for editing Perl code."
153 (defgroup cperl-indentation-details nil
158 (defgroup cperl-affected-by-hairy nil
159 "Variables affected by `cperl-hairy'."
163 (defgroup cperl-autoinsert-details nil
164 "Auto-insert tuneup."
168 (defgroup cperl-faces nil
169 "Fontification colors."
173 (defgroup cperl-speed nil
174 "Speed vs. validity tuneup."
178 (defgroup cperl-help-system nil
179 "Help system tuneup."
184 (defcustom cperl-extra-newline-before-brace nil
185 "*Non-nil means that if, elsif, while, until, else, for, foreach
186 and do constructs look like:
197 :group 'cperl-autoinsert-details)
199 (defcustom cperl-extra-newline-before-brace-multiline
200 cperl-extra-newline-before-brace
201 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
202 for constructs with multiline if/unless/while/until/for/foreach condition."
204 :group 'cperl-autoinsert-details)
206 (defcustom cperl-indent-level 2
207 "*Indentation of CPerl statements with respect to containing block."
209 :group 'cperl-indentation-details)
211 (defcustom cperl-lineup-step nil
212 "*`cperl-lineup' will always lineup at multiple of this number.
213 If nil, the value of `cperl-indent-level' will be used."
214 :type '(choice (const nil) integer)
215 :group 'cperl-indentation-details)
217 (defcustom cperl-brace-imaginary-offset 0
218 "*Imagined indentation of a Perl open brace that actually follows a statement.
219 An open brace following other text is treated as if it were this far
220 to the right of the start of its line."
222 :group 'cperl-indentation-details)
224 (defcustom cperl-brace-offset 0
225 "*Extra indentation for braces, compared with other text in same context."
227 :group 'cperl-indentation-details)
228 (defcustom cperl-label-offset -2
229 "*Offset of CPerl label lines relative to usual indentation."
231 :group 'cperl-indentation-details)
232 (defcustom cperl-min-label-indent 1
233 "*Minimal offset of CPerl label lines."
235 :group 'cperl-indentation-details)
236 (defcustom cperl-continued-statement-offset 2
237 "*Extra indent for lines not starting new statements."
239 :group 'cperl-indentation-details)
240 (defcustom cperl-continued-brace-offset 0
241 "*Extra indent for substatements that start with open-braces.
242 This is in addition to cperl-continued-statement-offset."
244 :group 'cperl-indentation-details)
245 (defcustom cperl-close-paren-offset -1
246 "*Extra indent for substatements that start with close-parenthesis."
248 :group 'cperl-indentation-details)
250 (defcustom cperl-auto-newline nil
251 "*Non-nil means automatically newline before and after braces,
252 and after colons and semicolons, inserted in CPerl code. The following
253 \\[cperl-electric-backspace] will remove the inserted whitespace.
254 Insertion after colons requires both this variable and
255 `cperl-auto-newline-after-colon' set."
257 :group 'cperl-autoinsert-details)
259 (defcustom cperl-autoindent-on-semi nil
260 "*Non-nil means automatically indent after insertion of (semi)colon.
261 Active if `cperl-auto-newline' is false."
263 :group 'cperl-autoinsert-details)
265 (defcustom cperl-auto-newline-after-colon nil
266 "*Non-nil means automatically newline even after colons.
267 Subject to `cperl-auto-newline' setting."
269 :group 'cperl-autoinsert-details)
271 (defcustom cperl-tab-always-indent t
272 "*Non-nil means TAB in CPerl mode should always reindent the current line,
273 regardless of where in the line point is when the TAB command is used."
275 :group 'cperl-indentation-details)
277 (defcustom cperl-font-lock nil
278 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
279 Can be overwritten by `cperl-hairy' if nil."
280 :type '(choice (const null) boolean)
281 :group 'cperl-affected-by-hairy)
283 (defcustom cperl-electric-lbrace-space nil
284 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
285 Can be overwritten by `cperl-hairy' if nil."
286 :type '(choice (const null) boolean)
287 :group 'cperl-affected-by-hairy)
289 (defcustom cperl-electric-parens-string "({[]})<"
290 "*String of parentheses that should be electric in CPerl.
291 Closing ones are electric only if the region is highlighted."
293 :group 'cperl-affected-by-hairy)
295 (defcustom cperl-electric-parens nil
296 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
297 Can be overwritten by `cperl-hairy' if nil."
298 :type '(choice (const null) boolean)
299 :group 'cperl-affected-by-hairy)
301 (defvar zmacs-regions) ; Avoid warning
303 (defcustom cperl-electric-parens-mark
305 (or (and (boundp 'transient-mark-mode) ; For Emacs
307 (and (boundp 'zmacs-regions) ; For XEmacs
309 "*Not-nil means that electric parens look for active mark.
310 Default is yes if there is visual feedback on mark."
312 :group 'cperl-autoinsert-details)
314 (defcustom cperl-electric-linefeed nil
315 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
316 In any case these two mean plain and hairy linefeeds together.
317 Can be overwritten by `cperl-hairy' if nil."
318 :type '(choice (const null) boolean)
319 :group 'cperl-affected-by-hairy)
321 (defcustom cperl-electric-keywords nil
322 "*Not-nil (and non-null) means keywords are electric in CPerl.
323 Can be overwritten by `cperl-hairy' if nil."
324 :type '(choice (const null) boolean)
325 :group 'cperl-affected-by-hairy)
327 (defcustom cperl-electric-backspace-untabify t
328 "*Not-nil means electric-backspace will untabify in CPerl."
330 :group 'cperl-autoinsert-details)
332 (defcustom cperl-hairy nil
333 "*Not-nil means most of the bells and whistles are enabled in CPerl.
334 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
335 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
336 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
337 `cperl-lazy-help-time'."
339 :group 'cperl-affected-by-hairy)
341 (defcustom cperl-comment-column 32
342 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
344 :group 'cperl-indentation-details)
346 (defvar cperl-vc-header-alist nil)
347 (make-obsolete-variable
348 'cperl-vc-header-alist
349 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead.")
351 (defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
352 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
353 :type '(repeat string)
356 (defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/) ;")
357 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
358 :type '(repeat string)
361 (defcustom cperl-clobber-mode-lists
364 (boundp 'interpreter-mode-alist)
365 (assoc "miniperl" interpreter-mode-alist)
366 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
367 "*Whether to install us into `interpreter-' and `extension' mode lists."
371 (defcustom cperl-info-on-command-no-prompt nil
372 "*Not-nil (and non-null) means not to prompt on C-h f.
373 The opposite behavior is always available if prefixed with C-c.
374 Can be overwritten by `cperl-hairy' if nil."
375 :type '(choice (const null) boolean)
376 :group 'cperl-affected-by-hairy)
378 (defcustom cperl-clobber-lisp-bindings nil
379 "*Not-nil (and non-null) means not overwrite C-h f.
380 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
381 Can be overwritten by `cperl-hairy' if nil."
382 :type '(choice (const null) boolean)
383 :group 'cperl-affected-by-hairy)
385 (defcustom cperl-lazy-help-time nil
386 "*Not-nil (and non-null) means to show lazy help after given idle time.
387 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
388 :type '(choice (const null) (const nil) integer)
389 :group 'cperl-affected-by-hairy)
391 (defcustom cperl-pod-face 'font-lock-comment-face
392 "*Face for POD highlighting."
396 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
397 "*Face for POD highlighting.
398 Font for POD headers."
402 (defcustom cperl-here-face 'font-lock-string-face
403 "*Face for here-docs highlighting."
407 (defcustom cperl-invalid-face 'underline
408 "*Face for highlighting trailing whitespace."
413 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
414 "*Not-nil after evaluation means to highlight POD and here-docs sections."
418 (defcustom cperl-fontify-m-as-s t
419 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
423 (defcustom cperl-highlight-variables-indiscriminately nil
424 "*Non-nil means perform additional highlighting on variables.
425 Currently only changes how scalar variables are highlighted.
426 Note that that variable is only read at initialization time for
427 the variable `cperl-font-lock-keywords-2', so changing it after you've
428 entered CPerl mode the first time will have no effect."
432 (defcustom cperl-pod-here-scan t
433 "*Not-nil means look for POD and here-docs sections during startup.
434 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
438 (defcustom cperl-regexp-scan t
439 "*Not-nil means make marking of regular expression more thorough.
440 Effective only with `cperl-pod-here-scan'. Not implemented yet."
444 (defcustom cperl-imenu-addback nil
445 "*Not-nil means add backreferences to generated `imenu's.
446 May require patched `imenu' and `imenu-go'. Obsolete."
448 :group 'cperl-help-system)
450 (defcustom cperl-max-help-size 66
451 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
452 :type '(choice integer (const nil))
453 :group 'cperl-help-system)
455 (defcustom cperl-shrink-wrap-info-frame t
456 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
458 :group 'cperl-help-system)
460 (defcustom cperl-info-page "perl"
461 "*Name of the info page containing perl docs.
462 Older version of this page was called `perl5', newer `perl'."
464 :group 'cperl-help-system)
466 (defcustom cperl-use-syntax-table-text-property
467 (boundp 'parse-sexp-lookup-properties)
468 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
472 (defcustom cperl-use-syntax-table-text-property-for-tags
473 cperl-use-syntax-table-text-property
474 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
478 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
479 "*Regexp to match files to scan when generating TAGS."
483 (defcustom cperl-noscan-files-regexp
484 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
485 "*Regexp to match files/dirs to skip when generating TAGS."
489 (defcustom cperl-regexp-indent-step nil
490 "*Indentation used when beautifying regexps.
491 If nil, the value of `cperl-indent-level' will be used."
492 :type '(choice integer (const nil))
493 :group 'cperl-indentation-details)
495 (defcustom cperl-indent-left-aligned-comments t
496 "*Non-nil means that the comment starting in leftmost column should indent."
498 :group 'cperl-indentation-details)
500 (defcustom cperl-under-as-char nil
501 "*Non-nil means that the _ (underline) should be treated as word char."
505 (defcustom cperl-extra-perl-args ""
506 "*Extra arguments to use when starting Perl.
507 Currently used with `cperl-check-syntax' only."
511 (defcustom cperl-message-electric-keyword t
512 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
514 :group 'cperl-help-system)
516 (defcustom cperl-indent-region-fix-constructs 1
517 "*Amount of space to insert between `}' and `else' or `elsif'
518 in `cperl-indent-region'. Set to nil to leave as is. Values other
519 than 1 and nil will probably not work."
520 :type '(choice (const nil) (const 1))
521 :group 'cperl-indentation-details)
523 (defcustom cperl-break-one-line-blocks-when-indent t
524 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
525 need to be reformatted into multiline ones when indenting a region."
527 :group 'cperl-indentation-details)
529 (defcustom cperl-fix-hanging-brace-when-indent t
530 "*Non-nil means that BLOCK-end `}' may be put on a separate line
531 when indenting a region.
532 Braces followed by else/elsif/while/until are excepted."
534 :group 'cperl-indentation-details)
536 (defcustom cperl-merge-trailing-else t
537 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
538 may be merged to be on the same line when indenting a region."
540 :group 'cperl-indentation-details)
542 (defcustom cperl-indent-parens-as-block nil
543 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
544 but for trailing \",\" inside the group, which won't increase indentation.
545 One should tune up `cperl-close-paren-offset' as well."
547 :group 'cperl-indentation-details)
549 (defcustom cperl-syntaxify-by-font-lock
550 (and cperl-can-font-lock
551 (boundp 'parse-sexp-lookup-properties))
552 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
553 :type '(choice (const message) boolean)
556 (defcustom cperl-syntaxify-unwind
558 "*Non-nil means that CPerl unwinds to a start of a long construction
559 when syntaxifying a chunk of buffer."
563 (defcustom cperl-ps-print-face-properties
564 '((font-lock-keyword-face nil nil bold shadow)
565 (font-lock-variable-name-face nil nil bold)
566 (font-lock-function-name-face nil nil bold italic box)
567 (font-lock-constant-face nil "LightGray" bold)
568 (cperl-array nil "LightGray" bold underline)
569 (cperl-hash nil "LightGray" bold italic underline)
570 (font-lock-comment-face nil "LightGray" italic)
571 (font-lock-string-face nil nil italic underline)
572 (cperl-nonoverridable nil nil italic underline)
573 (font-lock-type-face nil nil underline)
574 (underline nil "LightGray" strikeout))
575 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
576 :type '(repeat (cons symbol
577 (cons (choice (const nil) string)
578 (cons (choice (const nil) string)
582 (defvar cperl-dark-background
583 (cperl-choose-color "navy" "os2blue" "darkgreen"))
584 (defvar cperl-dark-foreground
585 (cperl-choose-color "orchid1" "orange"))
587 (defface cperl-nonoverridable
588 `((((class grayscale) (background light))
589 (:background "Gray90" :slant italic :underline t))
590 (((class grayscale) (background dark))
591 (:foreground "Gray80" :slant italic :underline t :weight bold))
592 (((class color) (background light))
593 (:foreground "chartreuse3"))
594 (((class color) (background dark))
595 (:foreground ,cperl-dark-foreground))
596 (t (:weight bold :underline t)))
597 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
599 ;; backward-compatibility alias
600 (put 'cperl-nonoverridable-face 'face-alias 'cperl-nonoverridable)
603 `((((class grayscale) (background light))
604 (:background "Gray90" :weight bold))
605 (((class grayscale) (background dark))
606 (:foreground "Gray80" :weight bold))
607 (((class color) (background light))
608 (:foreground "Blue" :background "lightyellow2" :weight bold))
609 (((class color) (background dark))
610 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
612 "Font Lock mode face used to highlight array names."
614 ;; backward-compatibility alias
615 (put 'cperl-array-face 'face-alias 'cperl-array)
618 `((((class grayscale) (background light))
619 (:background "Gray90" :weight bold :slant italic))
620 (((class grayscale) (background dark))
621 (:foreground "Gray80" :weight bold :slant italic))
622 (((class color) (background light))
623 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
624 (((class color) (background dark))
625 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
626 (t (:weight bold :slant italic)))
627 "Font Lock mode face used to highlight hash names."
629 ;; backward-compatibility alias
630 (put 'cperl-hash-face 'face-alias 'cperl-hash)
634 ;;; Short extra-docs.
636 (defvar cperl-tips 'please-ignore-this-line
637 "Get maybe newer version of this package from
638 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
640 ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
641 Subdirectory `cperl-mode' may contain yet newer development releases and/or
642 patches to related files.
644 For best results apply to an older Emacs the patches from
645 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
646 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
647 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
648 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
650 Get support packages choose-color.el (or font-lock-extra.el before
651 19.30), imenu-go.el from the same place. \(Look for other files there
652 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
653 later you should use choose-color.el *instead* of font-lock-extra.el
654 \(and you will not get smart highlighting in C :-().
656 Note that to enable Compile choices in the menu you need to install
659 If your Emacs does not default to `cperl-mode' on Perl files, and you
660 want it to: put the following into your .emacs file:
662 (defalias 'perl-mode 'cperl-mode)
665 $CPAN/doc/manual/info/perl-info.tar.gz
667 http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
669 If you use imenu-go, run imenu on perl5-info buffer (you can do it
670 from Perl menu). If many files are related, generate TAGS files from
671 Tools/Tags submenu in Perl menu.
673 If some class structure is too complicated, use Tools/Hierarchy-view
674 from Perl menu, or hierarchic view of imenu. The second one uses the
675 current buffer only, the first one requires generation of TAGS from
676 Perl/Tools/Tags menu beforehand.
678 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
680 Switch auto-help on/off with Perl/Tools/Auto-help.
682 Though with contemporary Emaxen CPerl mode should maintain the correct
683 parsing of Perl even when editing, sometimes it may be lost. Fix this by
687 In cases of more severe confusion sometimes it is helpful to do
689 \\[load-library] cperl-mode RET
692 Before reporting (non-)problems look in the problem section of online
693 micro-docs on what I know about CPerl problems.")
695 (defvar cperl-problems 'please-ignore-this-line
696 "Description of problems in CPerl mode.
697 Some faces will not be shown on some versions of Emacs unless you
698 install choose-color.el, available from
699 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
701 `fill-paragraph' on a comment may leave the point behind the
702 paragraph. Parsing of lines with several <<EOF is not implemented
705 Emacs had a _very_ restricted syntax parsing engine until version
706 20.1. Most problems below are corrected starting from this version of
707 Emacs, and all of them should be fixed in version 20.3. (Or apply
708 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
709 this respect (until 2003).
711 Note that even with newer Emacsen in some very rare cases the details
712 of interaction of `font-lock' and syntaxification may be not cleaned
713 up yet. You may get slightly different colors basing on the order of
714 fontification and syntaxification. Say, the initial faces is correct,
715 but editing the buffer breaks this.
717 Even with older Emacsen CPerl mode tries to corrects some Emacs
718 misunderstandings, however, for efficiency reasons the degree of
719 correction is different for different operations. The partially
720 corrected problems are: POD sections, here-documents, regexps. The
721 operations are: highlighting, indentation, electric keywords, electric
724 This may be confusing, since the regexp s#//#/#\; may be highlighted
725 as a comment, but it will be recognized as a regexp by the indentation
726 code. Or the opposite case, when a POD section is highlighted, but
727 may break the indentation of the following code (though indentation
728 should work if the balance of delimiters is not broken by POD).
730 The main trick (to make $ a \"backslash\") makes constructions like
731 ${aaa} look like unbalanced braces. The only trick I can think of is
732 to insert it as $ {aaa} (valid in perl5, not in perl4).
734 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
735 as /($|\\s)/. Note that such a transposition is not always possible.
737 The solution is to upgrade your Emacs or patch an older one. Note
738 that Emacs 20.2 has some bugs related to `syntax-table' text
739 properties. Patches are available on the main CPerl download site,
742 If these bugs cannot be fixed on your machine (say, you have an inferior
743 environment and cannot recompile), you may still disable all the fancy stuff
744 via `cperl-use-syntax-table-text-property'.")
746 (defvar cperl-praise 'please-ignore-this-line
747 "Advantages of CPerl mode.
749 0) It uses the newest `syntax-table' property ;-);
751 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
752 mode - but the latter number may have improved too in last years) even
753 with old Emaxen which do not support `syntax-table' property.
755 When using `syntax-table' property for syntax assist hints, it should
756 handle 99.995% of lines correct - or somesuch. It automatically
757 updates syntax assist hints when you edit your script.
759 2) It is generally believed to be \"the most user-friendly Emacs
760 package\" whatever it may mean (I doubt that the people who say similar
761 things tried _all_ the rest of Emacs ;-), but this was not a lonely
764 3) Everything is customizable, one-by-one or in a big sweep;
766 4) It has many easily-accessable \"tools\":
767 a) Can run program, check syntax, start debugger;
768 b) Can lineup vertically \"middles\" of rows, like `=' in
771 c) Can insert spaces where this impoves readability (in one
772 interactive sweep over the buffer);
773 d) Has support for imenu, including:
774 1) Separate unordered list of \"interesting places\";
775 2) Separate TOC of POD sections;
776 3) Separate list of packages;
777 4) Hierarchical view of methods in (sub)packages;
778 5) and functions (by the full name - with package);
779 e) Has an interface to INFO docs for Perl; The interface is
780 very flexible, including shrink-wrapping of
781 documentation buffer/frame;
782 f) Has a builtin list of one-line explanations for perl constructs.
783 g) Can show these explanations if you stay long enough at the
784 corresponding place (or on demand);
785 h) Has an enhanced fontification (using 3 or 4 additional faces
786 comparing to font-lock - basically, different
787 namespaces in Perl have different colors);
788 i) Can construct TAGS basing on its knowledge of Perl syntax,
789 the standard menu has 6 different way to generate
790 TAGS (if \"by directory\", .xs files - with C-language
791 bindings - are included in the scan);
792 j) Can build a hierarchical view of classes (via imenu) basing
793 on generated TAGS file;
794 k) Has electric parentheses, electric newlines, uses Abbrev
795 for electric logical constructs
797 with different styles of expansion (context sensitive
798 to be not so bothering). Electric parentheses behave
799 \"as they should\" in a presence of a visible region.
800 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
806 n) Highlights (by user-choice) either 3-delimiters constructs
807 (such as tr/a/b/), or regular expressions and `y/tr';
808 o) Highlights trailing whitespace;
809 p) Is able to manipulate Perl Regular Expressions to ease
810 conversion to a more readable form.
812 5) The indentation engine was very smart, but most of tricks may be
813 not needed anymore with the support for `syntax-table' property. Has
814 progress indicator for indentation (with `imenu' loaded).
816 6) Indent-region improves inline-comments as well; also corrects
817 whitespace *inside* the conditional/loop constructs.
819 7) Fill-paragraph correctly handles multi-line comments;
821 8) Can switch to different indentation styles by one command, and restore
822 the settings present before the switch.
824 9) When doing indentation of control constructs, may correct
825 line-breaks/spacing between elements of the construct.
827 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
828 capable syntax engines).")
830 (defvar cperl-speed 'please-ignore-this-line
831 "This is an incomplete compendium of what is available in other parts
832 of CPerl documentation. (Please inform me if I skept anything.)
834 There is a perception that CPerl is slower than alternatives. This part
835 of documentation is designed to overcome this misconception.
837 *By default* CPerl tries to enable the most comfortable settings.
838 From most points of view, correctly working package is infinitely more
839 comfortable than a non-correctly working one, thus by default CPerl
840 prefers correctness over speed. Below is the guide how to change
841 settings if your preferences are different.
843 A) Speed of loading the file. When loading file, CPerl may perform a
844 scan which indicates places which cannot be parsed by primitive Emacs
845 syntax-parsing routines, and marks them up so that either
847 A1) CPerl may work around these deficiencies (for big chunks, mostly
848 PODs and HERE-documents), or
849 A2) On capable Emaxen CPerl will use improved syntax-handlings
850 which reads mark-up hints directly.
852 The scan in case A2 is much more comprehensive, thus may be slower.
854 User can disable syntax-engine-helping scan of A2 by setting
855 `cperl-use-syntax-table-text-property'
856 variable to nil (if it is set to t).
858 One can disable the scan altogether (both A1 and A2) by setting
859 `cperl-pod-here-scan'
862 B) Speed of editing operations.
864 One can add a (minor) speedup to editing operations by setting
865 `cperl-use-syntax-table-text-property'
866 variable to nil (if it is set to t). This will disable
867 syntax-engine-helping scan, thus will make many more Perl
868 constructs be wrongly recognized by CPerl, thus may lead to
869 wrongly matched parentheses, wrong indentation, etc.
871 One can unset `cperl-syntaxify-unwind'. This might speed up editing
872 of, say, long POD sections.")
874 (defvar cperl-tips-faces 'please-ignore-this-line
875 "CPerl mode uses following faces for highlighting:
877 `cperl-array' Array names
878 `cperl-hash' Hash names
879 `font-lock-comment-face' Comments, PODs and whatever is considered
880 syntaxically to be not code
881 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
882 2-arg operators s/y/tr/ or of RExen,
883 `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
884 a target of a file tests, file tests,
885 subroutine names at the moment of definition
886 (except those conflicting with Perl operators),
887 package names (when recognized), format names
888 `font-lock-keyword-face' Control flow switch constructs, declarators
889 `cperl-nonoverridable' Non-overridable keywords, modifiers of RExen
890 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
891 literal parts and the terminator of formats
892 and whatever is syntaxically considered
894 `font-lock-type-face' Overridable keywords
895 `font-lock-variable-name-face' Variable declarations, indirect array and
896 hash names, POD headers/item names
897 `cperl-invalid' Trailing whitespace
899 Note that in several situations the highlighting tries to inform about
900 possible confusion, such as different colors for function names in
901 declarations depending on what they (do not) override, or special cases
902 m// and s/// which do not do what one would expect them to do.
904 Help with best setup of these faces for printout requested (for each of
905 the faces: please specify bold, italic, underline, shadow and box.)
911 ;;; Portability stuff:
913 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
914 `(define-key cperl-mode-map
916 `(if cperl-xemacs-p ,xemacs-key ,emacs-key)
920 (defvar cperl-del-back-ch
921 (car (append (where-is-internal 'delete-backward-char)
922 (where-is-internal 'backward-delete-char-untabify)))
923 "Character generated by key bound to `delete-backward-char'.")
925 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
926 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
928 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
931 ;; "Active regions" are on: use region only if active
932 ;; "Active regions" are off: use region unconditionally
933 (defun cperl-use-region-p ()
934 (if zmacs-regions (mark) t)))
935 (defun cperl-use-region-p ()
936 (if transient-mark-mode mark-active t))
937 (defun cperl-mark-active () mark-active))
939 (defsubst cperl-enable-font-lock ()
942 (defun cperl-putback-char (c) ; Emacs 19
943 (set 'unread-command-events (list c))) ; Avoid undefined warning
946 (defun cperl-putback-char (c) ; XEmacs >= 19.12
947 (setq unread-command-events (list (eval '(character-to-event c))))))
949 (or (fboundp 'uncomment-region)
950 (defun uncomment-region (beg end)
952 (comment-region beg end -1)))
954 (defvar cperl-do-not-fontify
955 (if (string< emacs-version "19.30")
958 "Text property which inhibits refontification.")
960 (defsubst cperl-put-do-not-fontify (from to &optional post)
961 ;; If POST, do not do it with postponed fontification
962 (if (and post cperl-syntaxify-by-font-lock)
964 (put-text-property (max (point-min) (1- from))
965 to cperl-do-not-fontify t)))
967 (defcustom cperl-mode-hook nil
968 "Hook run by CPerl mode."
972 (defvar cperl-syntax-state nil)
973 (defvar cperl-syntax-done-to nil)
974 (defvar cperl-emacs-can-parse (> (length (save-excursion
975 (parse-partial-sexp (point) (point)))) 9))
977 ;; Make customization possible "in reverse"
978 (defsubst cperl-val (symbol &optional default hairy)
980 ((eq (symbol-value symbol) 'null) default)
981 (cperl-hairy (or hairy t))
982 (t (symbol-value symbol))))
984 ;;; Probably it is too late to set these guys already, but it can help later:
986 ;;;(and cperl-clobber-mode-lists
987 ;;;(setq auto-mode-alist
988 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
989 ;;;(and (boundp 'interpreter-mode-alist)
990 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
991 ;;; '(("miniperl" . perl-mode))))))
997 '(imenu easymenu etags timer man info))
998 (if (fboundp 'ps-extend-face-list)
999 (defmacro cperl-ps-extend-face-list (arg)
1000 `(ps-extend-face-list ,arg))
1001 (defmacro cperl-ps-extend-face-list (arg)
1002 `(error "This version of Emacs has no `ps-extend-face-list'")))
1003 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1004 ;; macros instead of defsubsts don't work on Emacs, so we do the
1005 ;; expansion manually. Any other suggestions?
1008 (defvar cperl-mode-abbrev-table nil
1009 "Abbrev table in use in CPerl mode buffers.")
1011 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1013 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
1015 (if cperl-mode-map nil
1016 (setq cperl-mode-map (make-sparse-keymap))
1017 (cperl-define-key "{" 'cperl-electric-lbrace)
1018 (cperl-define-key "[" 'cperl-electric-paren)
1019 (cperl-define-key "(" 'cperl-electric-paren)
1020 (cperl-define-key "<" 'cperl-electric-paren)
1021 (cperl-define-key "}" 'cperl-electric-brace)
1022 (cperl-define-key "]" 'cperl-electric-rparen)
1023 (cperl-define-key ")" 'cperl-electric-rparen)
1024 (cperl-define-key ";" 'cperl-electric-semi)
1025 (cperl-define-key ":" 'cperl-electric-terminator)
1026 (cperl-define-key "\C-j" 'newline-and-indent)
1027 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
1028 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
1029 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1030 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
1031 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1032 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
1033 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
1034 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
1035 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1036 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1038 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1039 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1040 (cperl-define-key "\177" 'cperl-electric-backspace)
1041 (cperl-define-key "\t" 'cperl-indent-command)
1042 ;; don't clobber the backspace binding:
1043 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1044 [(control c) (control h) F])
1045 (if (cperl-val 'cperl-clobber-lisp-bindings)
1047 (cperl-define-key "\C-hf"
1048 ;;(concat (char-to-string help-char) "f") ; does not work
1049 'cperl-info-on-command
1051 (cperl-define-key "\C-hv"
1052 ;;(concat (char-to-string help-char) "v") ; does not work
1055 (cperl-define-key "\C-c\C-hf"
1056 ;;(concat (char-to-string help-char) "f") ; does not work
1057 (key-binding "\C-hf")
1058 [(control c) (control h) f])
1059 (cperl-define-key "\C-c\C-hv"
1060 ;;(concat (char-to-string help-char) "v") ; does not work
1061 (key-binding "\C-hv")
1062 [(control c) (control h) v]))
1063 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1064 [(control c) (control h) f])
1065 (cperl-define-key "\C-c\C-hv"
1066 ;;(concat (char-to-string help-char) "v") ; does not work
1068 [(control c) (control h) v]))
1069 (if (and cperl-xemacs-p
1070 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1072 ;; substitute-key-definition is usefulness-deenhanced...
1073 (cperl-define-key "\M-q" 'cperl-fill-paragraph)
1074 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1075 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
1076 (substitute-key-definition
1077 'indent-sexp 'cperl-indent-exp
1078 cperl-mode-map global-map)
1079 (substitute-key-definition
1080 'indent-region 'cperl-indent-region
1081 cperl-mode-map global-map)
1082 (substitute-key-definition
1083 'indent-for-comment 'cperl-indent-for-comment
1084 cperl-mode-map global-map)))
1087 (defvar cperl-lazy-installed)
1088 (defvar cperl-old-style nil)
1093 cperl-menu cperl-mode-map "Menu for CPerl mode"
1095 ["Beginning of function" beginning-of-defun t]
1096 ["End of function" end-of-defun t]
1097 ["Mark function" mark-defun t]
1098 ["Indent expression" cperl-indent-exp t]
1099 ["Fill paragraph/comment" fill-paragraph t]
1101 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1102 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1104 ["Beautify" cperl-beautify-regexp
1105 cperl-use-syntax-table-text-property]
1106 ["Beautify one level deep" (cperl-beautify-regexp 1)
1107 cperl-use-syntax-table-text-property]
1108 ["Beautify a group" cperl-beautify-level
1109 cperl-use-syntax-table-text-property]
1110 ["Beautify a group one level deep" (cperl-beautify-level 1)
1111 cperl-use-syntax-table-text-property]
1112 ["Contract a group" cperl-contract-level
1113 cperl-use-syntax-table-text-property]
1114 ["Contract groups" cperl-contract-levels
1115 cperl-use-syntax-table-text-property])
1116 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1118 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1119 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1120 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1122 ["Run" mode-compile (fboundp 'mode-compile)]
1123 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1124 (get-buffer "*compilation*"))]
1125 ["Next error" next-error (get-buffer "*compilation*")]
1126 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1128 ["Debugger" cperl-db t]
1131 ["Imenu" imenu (fboundp 'imenu)]
1132 ["Insert spaces if needed" cperl-find-bad-style t]
1133 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1134 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1135 ["CPerl pretty print (exprmntl)" cperl-ps-print
1136 (fboundp 'ps-extend-face-list)]
1137 ["Imenu on info" cperl-imenu-on-info (featurep 'imenu)]
1139 ;;; ["Create tags for current file" cperl-etags t]
1140 ;;; ["Add tags for current file" (cperl-etags t) t]
1141 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1142 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1143 ;;; ["Create tags for Perl files in (sub)directories"
1144 ;;; (cperl-etags nil 'recursive) t]
1145 ;;; ["Add tags for Perl files in (sub)directories"
1146 ;;; (cperl-etags t 'recursive) t])
1147 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1148 ["Create tags for current file" (cperl-write-tags nil t) t]
1149 ["Add tags for current file" (cperl-write-tags) t]
1150 ["Create tags for Perl files in directory"
1151 (cperl-write-tags nil t nil t) t]
1152 ["Add tags for Perl files in directory"
1153 (cperl-write-tags nil nil nil t) t]
1154 ["Create tags for Perl files in (sub)directories"
1155 (cperl-write-tags nil t t t) t]
1156 ["Add tags for Perl files in (sub)directories"
1157 (cperl-write-tags nil nil t t) t]))
1159 ["Define word at point" imenu-go-find-at-position
1160 (fboundp 'imenu-go-find-at-position)]
1161 ["Help on function" cperl-info-on-command t]
1162 ["Help on function at point" cperl-info-on-current-command t]
1163 ["Help on symbol at point" cperl-get-help t]
1164 ["Perldoc" cperl-perldoc t]
1165 ["Perldoc on word at point" cperl-perldoc-at-point t]
1166 ["View manpage of POD in this file" cperl-build-manpage t]
1167 ["Auto-help on" cperl-lazy-install
1168 (and (fboundp 'run-with-idle-timer)
1169 (not cperl-lazy-installed))]
1170 ["Auto-help off" cperl-lazy-unstall
1171 (and (fboundp 'run-with-idle-timer)
1172 cperl-lazy-installed)])
1174 ["Auto newline" cperl-toggle-auto-newline t]
1175 ["Electric parens" cperl-toggle-electric t]
1176 ["Electric keywords" cperl-toggle-abbrev t]
1177 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1178 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
1179 ["Auto fill" auto-fill-mode t])
1181 ["CPerl" (cperl-set-style "CPerl") t]
1182 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1183 ["GNU" (cperl-set-style "GNU") t]
1184 ["C++" (cperl-set-style "C++") t]
1185 ["FSF" (cperl-set-style "FSF") t]
1186 ["BSD" (cperl-set-style "BSD") t]
1187 ["Whitesmith" (cperl-set-style "Whitesmith") t]
1188 ["Current" (cperl-set-style "Current") t]
1189 ["Memorized" (cperl-set-style-back) cperl-old-style])
1191 ["Tips" (describe-variable 'cperl-tips) t]
1192 ["Problems" (describe-variable 'cperl-problems) t]
1193 ["Speed" (describe-variable 'cperl-speed) t]
1194 ["Praise" (describe-variable 'cperl-praise) t]
1195 ["Faces" (describe-variable 'cperl-tips-faces) t]
1196 ["CPerl mode" (describe-function 'cperl-mode) t]
1198 (message "The version of master-file for this CPerl is %s-Emacs"
1199 cperl-version) t]))))
1202 (autoload 'c-macro-expand "cmacexp"
1203 "Display the result of expanding all C macros occurring in the region.
1204 The expansion is entirely correct because it uses the C preprocessor."
1207 (defvar cperl-imenu--function-name-regexp-perl
1210 "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
1212 "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
1215 (defvar cperl-outline-regexp
1216 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1218 (defvar cperl-mode-syntax-table nil
1219 "Syntax table in use in CPerl mode buffers.")
1221 (defvar cperl-string-syntax-table nil
1222 "Syntax table in use in CPerl mode string-like chunks.")
1224 (if cperl-mode-syntax-table
1226 (setq cperl-mode-syntax-table (make-syntax-table))
1227 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1228 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1229 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1230 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1231 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1232 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1233 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1234 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1235 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1236 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1237 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1238 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
1239 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1240 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1241 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1242 (if cperl-under-as-char
1243 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1244 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1245 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1246 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1247 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
1248 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
1252 (defvar cperl-faces-init nil)
1254 (defvar cperl-msb-fixed nil)
1255 (defvar cperl-use-major-mode 'cperl-mode)
1258 (defun cperl-mode ()
1259 "Major mode for editing Perl code.
1260 Expression and list commands understand all C brackets.
1261 Tab indents for Perl code.
1262 Paragraphs are separated by blank lines only.
1263 Delete converts tabs to spaces as it moves back.
1265 Various characters in Perl almost always come in pairs: {}, (), [],
1266 sometimes <>. When the user types the first, she gets the second as
1267 well, with optional special formatting done on {}. (Disabled by
1268 default.) You can always quote (with \\[quoted-insert]) the left
1269 \"paren\" to avoid the expansion. The processing of < is special,
1270 since most the time you mean \"less\". CPerl mode tries to guess
1271 whether you want to type pair <>, and inserts is if it
1272 appropriate. You can set `cperl-electric-parens-string' to the string that
1273 contains the parenths from the above list you want to be electrical.
1274 Electricity of parenths is controlled by `cperl-electric-parens'.
1275 You may also set `cperl-electric-parens-mark' to have electric parens
1276 look for active mark and \"embrace\" a region if possible.'
1278 CPerl mode provides expansion of the Perl control constructs:
1280 if, else, elsif, unless, while, until, continue, do,
1281 for, foreach, formy and foreachmy.
1283 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1285 The user types the keyword immediately followed by a space, which
1286 causes the construct to be expanded, and the point is positioned where
1287 she is most likely to want to be. eg. when the user types a space
1288 following \"if\" the following appears in the buffer: if () { or if ()
1289 } { } and the cursor is between the parentheses. The user can then
1290 type some boolean expression within the parens. Having done that,
1291 typing \\[cperl-linefeed] places you - appropriately indented - on a
1292 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1293 directive line, then appropriate number of new lines is inserted).
1295 If CPerl decides that you want to insert \"English\" style construct like
1299 it will not do any expansion. See also help on variable
1300 `cperl-extra-newline-before-brace'. (Note that one can switch the
1301 help message on expansion by setting `cperl-message-electric-keyword'
1304 \\[cperl-linefeed] is a convenience replacement for typing carriage
1305 return. It places you in the next line with proper indentation, or if
1306 you type it inside the inline block of control construct, like
1308 foreach (@lines) {print; print}
1310 and you are on a boundary of a statement inside braces, it will
1311 transform the construct into a multiline and will place you into an
1312 appropriately indented blank line. If you need a usual
1313 `newline-and-indent' behavior, it is on \\[newline-and-indent],
1314 see documentation on `cperl-electric-linefeed'.
1316 Use \\[cperl-invert-if-unless] to change a construction of the form
1326 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1327 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1328 on electric space between $ and {, `cperl-electric-parens-string' is
1329 the string that contains parentheses that should be electric in CPerl
1330 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1331 setting `cperl-electric-keywords' enables electric expansion of
1332 control structures in CPerl. `cperl-electric-linefeed' governs which
1333 one of two linefeed behavior is preferable. You can enable all these
1334 options simultaneously (recommended mode of use) by setting
1335 `cperl-hairy' to t. In this case you can switch separate options off
1336 by setting them to `null'. Note that one may undo the extra
1337 whitespace inserted by semis and braces in `auto-newline'-mode by
1338 consequent \\[cperl-electric-backspace].
1340 If your site has perl5 documentation in info format, you can use commands
1341 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1342 These keys run commands `cperl-info-on-current-command' and
1343 `cperl-info-on-command', which one is which is controlled by variable
1344 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1345 \(in turn affected by `cperl-hairy').
1347 Even if you have no info-format documentation, short one-liner-style
1348 help is available on \\[cperl-get-help], and one can run perldoc or
1351 It is possible to show this help automatically after some idle time.
1352 This is regulated by variable `cperl-lazy-help-time'. Default with
1353 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1354 secs idle time . It is also possible to switch this on/off from the
1355 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1357 Use \\[cperl-lineup] to vertically lineup some construction - put the
1358 beginning of the region at the start of construction, and make region
1359 span the needed amount of lines.
1361 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1362 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1363 here-docs sections. With capable Emaxen results of scan are used
1364 for indentation too, otherwise they are used for highlighting only.
1366 Variables controlling indentation style:
1367 `cperl-tab-always-indent'
1368 Non-nil means TAB in CPerl mode should always reindent the current line,
1369 regardless of where in the line point is when the TAB command is used.
1370 `cperl-indent-left-aligned-comments'
1371 Non-nil means that the comment starting in leftmost column should indent.
1372 `cperl-auto-newline'
1373 Non-nil means automatically newline before and after braces,
1374 and after colons and semicolons, inserted in Perl code. The following
1375 \\[cperl-electric-backspace] will remove the inserted whitespace.
1376 Insertion after colons requires both this variable and
1377 `cperl-auto-newline-after-colon' set.
1378 `cperl-auto-newline-after-colon'
1379 Non-nil means automatically newline even after colons.
1380 Subject to `cperl-auto-newline' setting.
1381 `cperl-indent-level'
1382 Indentation of Perl statements within surrounding block.
1383 The surrounding block's indentation is the indentation
1384 of the line on which the open-brace appears.
1385 `cperl-continued-statement-offset'
1386 Extra indentation given to a substatement, such as the
1387 then-clause of an if, or body of a while, or just a statement continuation.
1388 `cperl-continued-brace-offset'
1389 Extra indentation given to a brace that starts a substatement.
1390 This is in addition to `cperl-continued-statement-offset'.
1391 `cperl-brace-offset'
1392 Extra indentation for line if it starts with an open brace.
1393 `cperl-brace-imaginary-offset'
1394 An open brace following other text is treated as if it the line started
1395 this far to the right of the actual line indentation.
1396 `cperl-label-offset'
1397 Extra indentation for line that is a label.
1398 `cperl-min-label-indent'
1399 Minimal indentation for line that is a label.
1401 Settings for K&R and BSD indentation styles are
1402 `cperl-indent-level' 5 8
1403 `cperl-continued-statement-offset' 5 8
1404 `cperl-brace-offset' -5 -8
1405 `cperl-label-offset' -5 -8
1407 CPerl knows several indentation styles, and may bulk set the
1408 corresponding variables. Use \\[cperl-set-style] to do this. Use
1409 \\[cperl-set-style-back] to restore the memorized preexisting values
1410 \(both available from menu).
1412 If `cperl-indent-level' is 0, the statement after opening brace in
1413 column 0 is indented on
1414 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1416 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1419 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1420 or as help on variables `cperl-tips', `cperl-problems',
1421 `cperl-praise', `cperl-speed'."
1423 (kill-all-local-variables)
1424 (use-local-map cperl-mode-map)
1425 (if (cperl-val 'cperl-electric-linefeed)
1427 (local-set-key "\C-J" 'cperl-linefeed)
1428 (local-set-key "\C-C\C-J" 'newline-and-indent)))
1430 (cperl-val 'cperl-clobber-lisp-bindings)
1431 (cperl-val 'cperl-info-on-command-no-prompt))
1433 ;; don't clobber the backspace binding:
1434 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1435 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1436 [(control c) (control h) f])))
1437 (setq major-mode cperl-use-major-mode)
1438 (setq mode-name "CPerl")
1439 (if (not cperl-mode-abbrev-table)
1440 (let ((prev-a-c abbrevs-changed))
1441 (define-abbrev-table 'cperl-mode-abbrev-table '(
1442 ("if" "if" cperl-electric-keyword 0)
1443 ("elsif" "elsif" cperl-electric-keyword 0)
1444 ("while" "while" cperl-electric-keyword 0)
1445 ("until" "until" cperl-electric-keyword 0)
1446 ("unless" "unless" cperl-electric-keyword 0)
1447 ("else" "else" cperl-electric-else 0)
1448 ("continue" "continue" cperl-electric-else 0)
1449 ("for" "for" cperl-electric-keyword 0)
1450 ("foreach" "foreach" cperl-electric-keyword 0)
1451 ("formy" "formy" cperl-electric-keyword 0)
1452 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1453 ("do" "do" cperl-electric-keyword 0)
1454 ("=pod" "=pod" cperl-electric-pod 0)
1455 ("=over" "=over" cperl-electric-pod 0)
1456 ("=head1" "=head1" cperl-electric-pod 0)
1457 ("=head2" "=head2" cperl-electric-pod 0)
1458 ("pod" "pod" cperl-electric-pod 0)
1459 ("over" "over" cperl-electric-pod 0)
1460 ("head1" "head1" cperl-electric-pod 0)
1461 ("head2" "head2" cperl-electric-pod 0)))
1462 (setq abbrevs-changed prev-a-c)))
1463 (setq local-abbrev-table cperl-mode-abbrev-table)
1464 (abbrev-mode (if (cperl-val 'cperl-electric-keywords) 1 0))
1465 (set-syntax-table cperl-mode-syntax-table)
1466 (make-local-variable 'outline-regexp)
1467 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1468 (setq outline-regexp cperl-outline-regexp)
1469 (make-local-variable 'outline-level)
1470 (setq outline-level 'cperl-outline-level)
1471 (make-local-variable 'paragraph-start)
1472 (setq paragraph-start (concat "^$\\|" page-delimiter))
1473 (make-local-variable 'paragraph-separate)
1474 (setq paragraph-separate paragraph-start)
1475 (make-local-variable 'paragraph-ignore-fill-prefix)
1476 (setq paragraph-ignore-fill-prefix t)
1477 (set (make-local-variable 'fill-paragraph-function) 'cperl-fill-paragraph)
1478 (make-local-variable 'indent-line-function)
1479 (setq indent-line-function 'cperl-indent-line)
1480 (make-local-variable 'require-final-newline)
1481 (setq require-final-newline mode-require-final-newline)
1482 (make-local-variable 'comment-start)
1483 (setq comment-start "# ")
1484 (make-local-variable 'comment-end)
1485 (setq comment-end "")
1486 (make-local-variable 'comment-column)
1487 (setq comment-column cperl-comment-column)
1488 (make-local-variable 'comment-start-skip)
1489 (setq comment-start-skip "#+ *")
1490 (make-local-variable 'defun-prompt-regexp)
1491 (setq defun-prompt-regexp "^[ \t]*sub[ \t\n]+\\([^ \t\n{(;]+\\)\\([ \t\n]*([^()]*)[ \t\n]*\\)?[ \t\n]*")
1492 (make-local-variable 'comment-indent-function)
1493 (setq comment-indent-function 'cperl-comment-indent)
1494 (make-local-variable 'parse-sexp-ignore-comments)
1495 (setq parse-sexp-ignore-comments t)
1496 (make-local-variable 'indent-region-function)
1497 (setq indent-region-function 'cperl-indent-region)
1498 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1499 (make-local-variable 'imenu-create-index-function)
1500 (setq imenu-create-index-function
1501 (function cperl-imenu--create-perl-index))
1502 (make-local-variable 'imenu-sort-function)
1503 (setq imenu-sort-function nil)
1504 (make-local-variable 'vc-rcs-header)
1505 (set 'vc-rcs-header cperl-vc-rcs-header)
1506 (make-local-variable 'vc-sccs-header)
1507 (set 'vc-sccs-header cperl-vc-sccs-header)
1508 (make-local-variable 'font-lock-defaults)
1509 (setq font-lock-defaults
1511 ((string< emacs-version "19.30")
1512 '(cperl-font-lock-keywords-2))
1513 ((string< emacs-version "19.33") ; Which one to use?
1514 '((cperl-font-lock-keywords
1515 cperl-font-lock-keywords-1
1516 cperl-font-lock-keywords-2)))
1518 '((cperl-load-font-lock-keywords
1519 cperl-load-font-lock-keywords-1
1520 cperl-load-font-lock-keywords-2)
1521 nil nil ((?_ . "w"))))))
1522 (make-local-variable 'cperl-syntax-state)
1523 (if cperl-use-syntax-table-text-property
1525 (make-local-variable 'parse-sexp-lookup-properties)
1526 ;; Do not introduce variable if not needed, we check it!
1527 (set 'parse-sexp-lookup-properties t)
1528 ;; Fix broken font-lock:
1529 (or (boundp 'font-lock-unfontify-region-function)
1530 (set 'font-lock-unfontify-region-function
1531 'font-lock-default-unfontify-region))
1532 (make-local-variable 'font-lock-unfontify-region-function)
1533 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1534 'cperl-font-lock-unfontify-region-function)
1535 (make-local-variable 'cperl-syntax-done-to)
1536 (make-local-variable 'font-lock-syntactic-keywords)
1537 (setq font-lock-syntactic-keywords
1538 (if cperl-syntaxify-by-font-lock
1539 '((cperl-fontify-syntaxically))
1540 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1541 ;; used to ignore syntax-table text-properties. (t) is a hack
1542 ;; to make font-lock think that font-lock-syntactic-keywords
1545 (make-local-variable 'cperl-old-style)
1546 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1547 (set (make-local-variable 'normal-auto-fill-function)
1548 'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
1549 (or (fboundp 'cperl-old-auto-fill-mode)
1551 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1552 (defun auto-fill-mode (&optional arg)
1554 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1555 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1556 (setq auto-fill-function 'cperl-do-auto-fill))))))
1557 (if (cperl-enable-font-lock)
1558 (if (cperl-val 'cperl-font-lock)
1559 (progn (or cperl-faces-init (cperl-init-faces))
1560 (font-lock-mode 1))))
1561 (and (boundp 'msb-menu-cond)
1562 (not cperl-msb-fixed)
1564 (if (featurep 'easymenu)
1565 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
1566 (run-mode-hooks 'cperl-mode-hook)
1567 ;; After hooks since fontification will break this
1568 (if cperl-pod-here-scan
1569 (or cperl-syntaxify-by-font-lock
1570 (progn (or cperl-faces-init (cperl-init-faces-weak))
1571 (cperl-find-pods-heres)))))
1573 ;; Fix for perldb - make default reasonable
1577 (perldb (read-from-minibuffer "Run perldb (like this): "
1578 (if (consp gud-perldb-history)
1579 (car gud-perldb-history)
1580 (concat "perl " ;;(file-name-nondirectory
1584 (buffer-file-name)))
1586 '(gud-perldb-history . 1))))
1588 (defun cperl-msb-fix ()
1589 ;; Adds perl files to msb menu, supposes that msb is already loaded
1590 (setq cperl-msb-fixed t)
1591 (let* ((l (length msb-menu-cond))
1592 (last (nth (1- l) msb-menu-cond))
1593 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1594 (handle (1- (nth 1 last))))
1595 (setcdr precdr (list
1597 '(memq major-mode '(cperl-mode perl-mode))
1602 ;; This is used by indent-for-comment
1603 ;; to decide how much to indent a comment in CPerl code
1604 ;; based on its context. Do fallback if comment is found wrong.
1606 (defvar cperl-wrong-comment)
1607 (defvar cperl-st-cfence '(14)) ; Comment-fence
1608 (defvar cperl-st-sfence '(15)) ; String-fence
1609 (defvar cperl-st-punct '(1))
1610 (defvar cperl-st-word '(2))
1611 (defvar cperl-st-bra '(4 . ?\>))
1612 (defvar cperl-st-ket '(5 . ?\<))
1615 (defun cperl-comment-indent ()
1616 (let ((p (point)) (c (current-column)) was phony)
1617 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
1618 ;; Wrong comment found
1620 (setq was (cperl-to-comment-or-eol)
1621 phony (eq (get-text-property (point) 'syntax-table)
1625 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1626 (if (eq (preceding-char) ?\#)
1631 (skip-chars-backward " \t")
1632 (max (1+ (current-column)) ; Else indent at comment column
1635 (insert comment-start)
1636 (backward-char (length comment-start)))
1637 (setq cperl-wrong-comment t)
1638 (indent-to comment-column 1) ; Indent minimum 1
1639 c))))) ; except leave at least one space.
1641 ;;;(defun cperl-comment-indent-fallback ()
1642 ;;; "Is called if the standard comment-search procedure fails.
1643 ;;;Point is at start of real comment."
1644 ;;; (let ((c (current-column)) target cnt prevc)
1645 ;;; (if (= c comment-column) nil
1646 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1647 ;;; (setq target (max (1+ (setq prevc
1648 ;;; (current-column))) ; Else indent at comment column
1649 ;;; comment-column))
1650 ;;; (if (= c comment-column) nil
1651 ;;; (delete-backward-char cnt)
1652 ;;; (while (< prevc target)
1654 ;;; (setq prevc (current-column)))
1655 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1656 ;;; (while (< prevc target)
1658 ;;; (setq prevc (current-column)))))))
1660 (defun cperl-indent-for-comment ()
1661 "Substitute for `indent-for-comment' in CPerl."
1663 (let (cperl-wrong-comment)
1664 (indent-for-comment)
1665 (if cperl-wrong-comment
1666 (progn (cperl-to-comment-or-eol)
1667 (forward-char (length comment-start))))))
1669 (defun cperl-comment-region (b e arg)
1670 "Comment or uncomment each line in the region in CPerl mode.
1671 See `comment-region'."
1672 (interactive "r\np")
1673 (let ((comment-start "#"))
1674 (comment-region b e arg)))
1676 (defun cperl-uncomment-region (b e arg)
1677 "Uncomment or comment each line in the region in CPerl mode.
1678 See `comment-region'."
1679 (interactive "r\np")
1680 (let ((comment-start "#"))
1681 (comment-region b e (- arg))))
1683 (defvar cperl-brace-recursing nil)
1685 (defun cperl-electric-brace (arg &optional only-before)
1686 "Insert character and correct line's indentation.
1687 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1688 place (even in empty line), but not after. If after \")\" and the inserted
1689 char is \"{\", insert extra newline before only if
1690 `cperl-extra-newline-before-brace'."
1693 (other-end (if (and cperl-electric-parens-mark
1699 (not cperl-brace-recursing)
1700 (cperl-val 'cperl-electric-parens)
1701 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
1702 ;; Need to insert a matching pair
1705 (setq insertpos (point-marker))
1706 (goto-char other-end)
1707 (setq last-command-char ?\{)
1708 (cperl-electric-lbrace arg insertpos))
1710 ;; Check whether we close something "usual" with `}'
1711 (if (and (eq last-command-char ?\})
1715 (up-list (- (prefix-numeric-value arg)))
1716 ;;(cperl-after-block-p (point-min))
1717 (or (cperl-after-expr-p nil "{;)")
1718 ;; after sub, else, continue
1719 (cperl-after-block-p nil 'pre)))
1721 ;; Just insert the guy
1722 (self-insert-command (prefix-numeric-value arg))
1723 (if (and (not arg) ; No args, end (of empty line or auto)
1725 (or (and (null only-before)
1727 (skip-chars-backward " \t")
1729 (and (eq last-command-char ?\{) ; Do not insert newline
1730 ;; if after ")" and `cperl-extra-newline-before-brace'
1731 ;; is nil, do not insert extra newline.
1732 (not cperl-extra-newline-before-brace)
1734 (skip-chars-backward " \t")
1735 (eq (preceding-char) ?\))))
1736 (if cperl-auto-newline
1737 (progn (cperl-indent-line) (newline) t) nil)))
1739 (self-insert-command (prefix-numeric-value arg))
1741 (if cperl-auto-newline
1742 (setq insertpos (1- (point))))
1743 (if (and cperl-auto-newline (null only-before))
1746 (cperl-indent-line)))
1748 (if insertpos (progn (goto-char insertpos)
1749 (search-forward (make-string
1750 1 last-command-char))
1751 (setq insertpos (1- (point)))))
1755 (goto-char insertpos)
1756 (self-insert-command (prefix-numeric-value arg)))
1757 (self-insert-command (prefix-numeric-value arg)))))))
1759 (defun cperl-electric-lbrace (arg &optional end)
1760 "Insert character, correct line's indentation, correct quoting by space."
1762 (let ((cperl-brace-recursing t)
1763 (cperl-auto-newline cperl-auto-newline)
1765 (if (and cperl-electric-parens-mark
1773 (and (cperl-val 'cperl-electric-lbrace-space)
1774 (eq (preceding-char) ?$)
1776 (skip-chars-backward "$")
1777 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
1779 ;; Check whether we are in comment
1783 (not (looking-at "[ \t]*#")))
1784 (cperl-after-expr-p nil "{;)"))
1786 (setq cperl-auto-newline nil))
1787 (cperl-electric-brace arg)
1788 (and (cperl-val 'cperl-electric-parens)
1789 (eq last-command-char ?{)
1790 (memq last-command-char
1791 (append cperl-electric-parens-string nil))
1792 (or (if other-end (goto-char (marker-position other-end)))
1794 (setq last-command-char ?} pos (point))
1795 (progn (cperl-electric-brace arg t)
1798 (defun cperl-electric-paren (arg)
1799 "Insert an opening parenthesis or a matching pair of parentheses.
1800 See `cperl-electric-parens'."
1802 (let ((beg (save-excursion (beginning-of-line) (point)))
1803 (other-end (if (and cperl-electric-parens-mark
1810 (if (and (cperl-val 'cperl-electric-parens)
1811 (memq last-command-char
1812 (append cperl-electric-parens-string nil))
1813 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1814 ;;(not (save-excursion (search-backward "#" beg t)))
1815 (if (eq last-command-char ?<)
1817 (and abbrev-mode ; later it is too late, may be after `for'
1819 (cperl-after-expr-p nil "{;(,:="))
1822 (self-insert-command (prefix-numeric-value arg))
1823 (if other-end (goto-char (marker-position other-end)))
1824 (insert (make-string
1825 (prefix-numeric-value arg)
1826 (cdr (assoc last-command-char '((?{ .?})
1830 (forward-char (- (prefix-numeric-value arg))))
1831 (self-insert-command (prefix-numeric-value arg)))))
1833 (defun cperl-electric-rparen (arg)
1834 "Insert a matching pair of parentheses if marking is active.
1835 If not, or if we are not at the end of marking range, would self-insert.
1836 Affected by `cperl-electric-parens'."
1838 (let ((beg (save-excursion (beginning-of-line) (point)))
1839 (other-end (if (and cperl-electric-parens-mark
1840 (cperl-val 'cperl-electric-parens)
1841 (memq last-command-char
1842 (append cperl-electric-parens-string nil))
1849 (cperl-val 'cperl-electric-parens)
1850 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
1851 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1852 ;;(not (save-excursion (search-backward "#" beg t)))
1855 (self-insert-command (prefix-numeric-value arg))
1857 (if other-end (goto-char other-end))
1858 (insert (make-string
1859 (prefix-numeric-value arg)
1860 (cdr (assoc last-command-char '((?\} . ?\{)
1865 (self-insert-command (prefix-numeric-value arg)))))
1867 (defun cperl-electric-keyword ()
1868 "Insert a construction appropriate after a keyword.
1869 Help message may be switched off by setting `cperl-message-electric-keyword'
1871 (let ((beg (save-excursion (beginning-of-line) (point)))
1872 (dollar (and (eq last-command-char ?$)
1873 (eq this-command 'self-insert-command)))
1874 (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1875 (memq this-command '(self-insert-command newline))))
1877 (and (save-excursion
1881 (setq do (looking-at "do\\>")))
1883 (cperl-after-expr-p nil "{;:"))
1887 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
1889 (save-excursion (or (not (re-search-backward "^=" nil t))
1892 (and cperl-use-syntax-table-text-property
1893 (not (eq (get-text-property (point)
1896 (save-excursion (forward-sexp -1)
1897 (not (memq (following-char) (append "$@%&*" nil))))
1899 (and (eq (preceding-char) ?y)
1900 (progn ; "foreachmy"
1906 (memq this-command '(self-insert-command newline)))))
1907 (and dollar (insert " $"))
1909 ;;(insert " () {\n}")
1911 (cperl-extra-newline-before-brace
1912 (insert (if do "\n" " ()\n"))
1918 (and do (insert " while ();")))
1920 (insert (if do " {\n} while ();" " () {\n}"))))
1921 (or (looking-at "[ \t]\\|$") (insert " "))
1923 (if dollar (progn (search-backward "$")
1927 (search-backward ")")
1928 (if (eq last-command-char ?\()
1929 (progn ; Avoid "if (())"
1930 (delete-backward-char 1)
1931 (delete-backward-char -1))))
1933 (cperl-putback-char cperl-del-back-ch))
1934 (if cperl-message-electric-keyword
1935 (message "Precede char by C-q to avoid expansion"))))))
1937 (defun cperl-ensure-newlines (n &optional pos)
1938 "Make sure there are N newlines after the point."
1939 (or pos (setq pos (point)))
1940 (if (looking-at "\n")
1944 (cperl-ensure-newlines (1- n) pos)
1947 (defun cperl-electric-pod ()
1948 "Insert a POD chunk appropriate after a =POD directive."
1949 (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1950 (memq this-command '(self-insert-command newline))))
1951 head1 notlast name p really-delete over)
1952 (and (save-excursion
1955 (eq (preceding-char) ?=)
1957 (setq head1 (looking-at "head1\\>[ \t]*$"))
1958 (setq over (and (looking-at "over\\>[ \t]*$")
1959 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
1963 (get-text-property (point) 'in-pod)
1964 (cperl-after-expr-p nil "{;:")
1965 (and (re-search-backward
1966 ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
1967 "\\(\\`\n?\\|^\n\\)=\\sw+"
1971 (and cperl-use-syntax-table-text-property
1972 (not (eq (get-text-property (point) 'syntax-type)
1976 (setq notlast (re-search-forward "^\n=" nil t)))
1980 (cperl-ensure-newlines 2)
1986 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
1987 nil t)))) ; Only one
1990 (setq name (file-name-sans-extension
1991 (file-name-nondirectory (buffer-file-name)))
1993 (insert " NAME\n\n" name
1994 " - \n\n=head1 SYNOPSIS\n\n\n\n"
1995 "=head1 DESCRIPTION")
1996 (cperl-ensure-newlines 4)
2000 (setq really-delete t))
2005 (insert "\n\n=item \n\n\n\n"
2007 (cperl-ensure-newlines 2)
2011 (setq really-delete t)))
2012 (if (and delete really-delete)
2013 (cperl-putback-char cperl-del-back-ch))))))
2015 (defun cperl-electric-else ()
2016 "Insert a construction appropriate after a keyword.
2017 Help message may be switched off by setting `cperl-message-electric-keyword'
2019 (let ((beg (save-excursion (beginning-of-line) (point))))
2020 (and (save-excursion
2022 (cperl-after-expr-p nil "{;:"))
2026 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2028 (save-excursion (or (not (re-search-backward "^=" nil t))
2030 (and cperl-use-syntax-table-text-property
2031 (not (eq (get-text-property (point)
2036 ;;(insert " {\n\n}")
2038 (cperl-extra-newline-before-brace
2044 (insert " {\n\n}")))
2045 (or (looking-at "[ \t]\\|$") (insert " "))
2049 (cperl-putback-char cperl-del-back-ch)
2050 (setq this-command 'cperl-electric-else)
2051 (if cperl-message-electric-keyword
2052 (message "Precede char by C-q to avoid expansion"))))))
2054 (defun cperl-linefeed ()
2055 "Go to end of line, open a new line and indent appropriately.
2056 If in POD, insert appropriate lines."
2058 (let ((beg (save-excursion (beginning-of-line) (point)))
2059 (end (save-excursion (end-of-line) (point)))
2060 (pos (point)) start over cut res)
2061 (if (and ; Check if we need to split:
2062 ; i.e., on a boundary and inside "{...}"
2063 (save-excursion (cperl-to-comment-or-eol)
2064 (>= (point) pos)) ; Not in a comment
2066 (skip-chars-backward " \t" beg)
2068 (looking-at "[;{]")) ; After { or ; + spaces
2069 (looking-at "[ \t]*}") ; Before }
2070 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2073 (eq (car (parse-partial-sexp pos end -1)) -1)
2074 ; Leave the level of parens
2075 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2077 (cperl-after-block-p (point-min))
2080 (setq start (point-marker))
2081 (<= start pos))))) ; Redundant? Are after the
2082 ; start of parens group.
2084 (skip-chars-backward " \t")
2085 (or (memq (preceding-char) (append ";{" nil))
2091 (or (looking-at "{[ \t]*$") ; If there is a statement
2092 ; before, move it to separate line
2096 (cperl-indent-line)))
2097 (forward-line 1) ; We are on the target line
2100 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2101 ; after, move it to separate line
2104 (search-backward "}" beg)
2105 (skip-chars-backward " \t")
2106 (or (memq (preceding-char) (append ";{" nil))
2111 (forward-line -1) ; We are on the line before target
2113 (newline-and-indent))
2114 (end-of-line) ; else - no splitting
2116 ((and (looking-at "\n[ \t]*{$")
2118 (skip-chars-backward " \t")
2119 (eq (preceding-char) ?\)))) ; Probably if () {} group
2120 ; with an extra newline.
2122 (cperl-indent-line))
2123 ((save-excursion ; In POD header
2124 (forward-paragraph -1)
2125 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2126 ;; We are after \n now, so look for the rest
2127 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2129 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2130 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2134 (forward-paragraph -1)
2137 (setq cut (buffer-substring (point)
2141 (delete-char (- (save-excursion (end-of-line) (point))
2143 (setq res (expand-abbrev))
2149 (cperl-ensure-newlines (if cut 2 4))
2151 ((get-text-property (point) 'in-pod) ; In POD section
2152 (cperl-ensure-newlines 4)
2154 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2156 (cperl-indent-line))
2158 (newline-and-indent))))))
2160 (defun cperl-electric-semi (arg)
2161 "Insert character and correct line's indentation."
2163 (if cperl-auto-newline
2164 (cperl-electric-terminator arg)
2165 (self-insert-command (prefix-numeric-value arg))
2166 (if cperl-autoindent-on-semi
2167 (cperl-indent-line))))
2169 (defun cperl-electric-terminator (arg)
2170 "Insert character and correct line's indentation."
2173 (auto (and cperl-auto-newline
2174 (or (not (eq last-command-char ?:))
2175 cperl-auto-newline-after-colon)))
2177 (if (and ;;(not arg)
2179 (not (save-excursion
2181 (skip-chars-forward " \t")
2183 ;; Ignore in comment lines
2184 (= (following-char) ?#)
2185 ;; Colon is special only after a label
2186 ;; So quickly rule out most other uses of colon
2187 ;; and do no indentation for them.
2188 (and (eq last-command-char ?:)
2191 (skip-chars-forward " \t")
2192 (and (< (point) end)
2193 (progn (goto-char (- end 1))
2194 (not (looking-at ":"))))))
2196 (beginning-of-defun)
2197 (let ((pps (parse-partial-sexp (point) end)))
2198 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2200 (self-insert-command (prefix-numeric-value arg))
2202 (if auto (setq insertpos (point-marker)))
2208 (cperl-indent-line)))
2210 (if insertpos (goto-char (1- (marker-position insertpos)))
2215 (goto-char insertpos)
2216 (self-insert-command (prefix-numeric-value arg)))
2217 (self-insert-command (prefix-numeric-value arg)))))
2219 (defun cperl-electric-backspace (arg)
2220 "Backspace, or remove the whitespace around the point inserted by an electric
2221 key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2223 (if (and cperl-auto-newline
2224 (memq last-command '(cperl-electric-semi
2225 cperl-electric-terminator
2226 cperl-electric-lbrace))
2227 (memq (preceding-char) '(?\ ?\t ?\n)))
2229 (if (eq last-command 'cperl-electric-lbrace)
2230 (skip-chars-forward " \t\n"))
2232 (skip-chars-backward " \t\n")
2233 (delete-region (point) p))
2234 (and (eq last-command 'cperl-electric-else)
2235 ;; We are removing the whitespace *inside* cperl-electric-else
2236 (setq this-command 'cperl-electric-else-really))
2237 (if (and cperl-auto-newline
2238 (eq last-command 'cperl-electric-else-really)
2239 (memq (preceding-char) '(?\ ?\t ?\n)))
2241 (skip-chars-forward " \t\n")
2243 (skip-chars-backward " \t\n")
2244 (delete-region (point) p))
2245 (if cperl-electric-backspace-untabify
2246 (backward-delete-char-untabify arg)
2247 (delete-backward-char arg)))))
2249 (put 'cperl-electric-backspace 'delete-selection 'supersede)
2251 (defun cperl-inside-parens-p ()
2255 (narrow-to-region (point)
2256 (progn (beginning-of-defun) (point)))
2257 (goto-char (point-max))
2258 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2261 (defun cperl-indent-command (&optional whole-exp)
2262 "Indent current line as Perl code, or in some cases insert a tab character.
2263 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2264 line. Otherwise, indent the current line only if point is at the left margin
2265 or in the line's indentation; otherwise insert a tab.
2267 A numeric argument, regardless of its value,
2268 means indent rigidly all the lines of the expression starting after point
2269 so that this line becomes properly indented.
2270 The relative indentation among the lines of the expression are preserved."
2272 (cperl-update-syntaxification (point) (point))
2274 ;; If arg, always indent this line as Perl
2275 ;; and shift remaining lines of expression the same amount.
2276 (let ((shift-amt (cperl-indent-line))
2279 (if cperl-tab-always-indent
2280 (beginning-of-line))
2287 (if (and shift-amt (> end beg))
2288 (indent-code-rigidly beg end shift-amt "#")))
2289 (if (and (not cperl-tab-always-indent)
2291 (skip-chars-backward " \t")
2294 (cperl-indent-line))))
2296 (defun cperl-indent-line (&optional parse-data)
2297 "Indent current line as Perl code.
2298 Return the amount the indentation changed by."
2299 (let ((case-fold-search nil)
2300 (pos (- (point-max) (point)))
2301 indent i beg shift-amt)
2302 (setq indent (cperl-calculate-indent parse-data)
2306 (cond ((or (eq indent nil) (eq indent t))
2307 (setq indent (current-indentation) i nil))
2308 ;;((eq indent t) ; Never?
2309 ;; (setq indent (cperl-calculate-indent-within-comment)))
2310 ;;((looking-at "[ \t]*#")
2313 (skip-chars-forward " \t")
2314 (if (listp indent) (setq indent (car indent)))
2315 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2317 (setq indent (max cperl-min-label-indent
2318 (+ indent cperl-label-offset)))))
2319 ((= (following-char) ?})
2320 (setq indent (- indent cperl-indent-level)))
2321 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2322 (setq indent (+ indent cperl-close-paren-offset)))
2323 ((= (following-char) ?{)
2324 (setq indent (+ indent cperl-brace-offset))))))
2325 (skip-chars-forward " \t")
2326 (setq shift-amt (and i (- indent (current-column))))
2327 (if (or (not shift-amt)
2329 (if (> (- (point-max) pos) (point))
2330 (goto-char (- (point-max) pos)))
2331 (delete-region beg (point))
2333 ;; If initial point was within line's indentation,
2334 ;; position after the indentation. Else stay at same point in text.
2335 (if (> (- (point-max) pos) (point))
2336 (goto-char (- (point-max) pos))))
2339 (defun cperl-after-label ()
2340 ;; Returns true if the point is after label. Does not do save-excursion.
2341 (and (eq (preceding-char) ?:)
2342 (memq (char-syntax (char-after (- (point) 2)))
2346 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2348 (defun cperl-get-state (&optional parse-start start-state)
2349 ;; returns list (START STATE DEPTH PRESTART),
2350 ;; START is a good place to start parsing, or equal to
2351 ;; PARSE-START if preset,
2352 ;; STATE is what is returned by `parse-partial-sexp'.
2353 ;; DEPTH is true is we are immediately after end of block
2354 ;; which contains START.
2355 ;; PRESTART is the position basing on which START was found.
2357 (let ((start-point (point)) depth state start prestart)
2358 (if (and parse-start
2359 (<= parse-start start-point))
2360 (goto-char parse-start)
2361 (beginning-of-defun)
2362 (setq start-state nil))
2363 (setq prestart (point))
2365 ;; Try to go out, if sub is not on the outermost level
2366 (while (< (point) start-point)
2367 (setq start (point) parse-start start depth nil
2368 state (parse-partial-sexp start start-point -1))
2369 (if (> (car state) -1) nil
2370 ;; The current line could start like }}}, so the indentation
2371 ;; corresponds to a different level than what we reached
2373 (beginning-of-line 2))) ; Go to the next line.
2374 (if start (goto-char start))) ; Not at the start of file
2375 (setq start (point))
2376 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2377 (list start state depth prestart))))
2379 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
2380 ;; Positions is before ?\{. Checks whether it starts a block.
2381 ;; No save-excursion!
2382 (cperl-backward-to-noncomment (point-min))
2383 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
2384 ; Label may be mixed up with `$blah :'
2385 (save-excursion (cperl-after-label))
2386 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2389 ;; Need take into account `bless', `return', `tr',...
2390 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
2391 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
2393 (skip-chars-backward " \t\n\f")
2394 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2398 "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
2400 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2402 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
2403 "Return appropriate indentation for current line as Perl code.
2404 In usual case returns an integer: the column to indent to.
2405 Returns nil if line starts inside a string, t if in a comment.
2407 Will not correct the indentation for labels, but will correct it for braces
2408 and closing parentheses and brackets."
2409 (cperl-update-syntaxification (point) (point))
2412 (and (memq (get-text-property (point) 'syntax-type)
2413 '(pod here-doc here-doc-delim format))
2414 (not (get-text-property (point) 'indentable)))
2415 ;; before start of POD - whitespace found since do not have 'pod!
2416 (and (looking-at "[ \t]*\n=")
2417 (error "Spaces before POD section!"))
2418 (and (not cperl-indent-left-aligned-comments)
2422 (let ((indent-point (point))
2423 (char-after (save-excursion
2424 (skip-chars-forward " \t")
2426 (in-pod (get-text-property (point) 'in-pod))
2427 (pre-indent-point (point))
2428 p prop look-prop is-block delim)
2431 ;; In the verbatim part, probably code example. What to do???
2436 (cperl-backward-to-noncomment nil)
2437 (setq p (max (point-min) (1- (point)))
2438 prop (get-text-property p 'syntax-type)
2439 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2441 (if (memq prop '(pod here-doc format here-doc-delim))
2443 (goto-char (or (previous-single-property-change p look-prop)
2446 (setq pre-indent-point (point)))))))
2447 (goto-char pre-indent-point)
2448 (let* ((case-fold-search nil)
2449 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2450 (start (or (nth 2 parse-data)
2453 (containing-sexp (car (cdr state)))
2456 ;;containing-sexp ;; We are buggy at toplevel :-(
2459 (setcar parse-data pre-indent-point)
2460 (setcar (cdr parse-data) state)
2461 (or (nth 2 parse-data)
2462 (setcar (cddr parse-data) start))
2463 ;; Before this point: end of statement
2464 (setq old-indent (nth 3 parse-data))))
2465 (cond ((get-text-property (point) 'indentable)
2466 ;; indent to just after the surrounding open,
2467 ;; skip blanks if we do not close the expression.
2468 (goto-char (1+ (previous-single-property-change (point) 'indentable)))
2469 (or (memq char-after (append ")]}" nil))
2470 (looking-at "[ \t]*\\(#\\|$\\)")
2471 (skip-chars-forward " \t"))
2473 ((or (nth 3 state) (nth 4 state))
2474 ;; return nil or t if should not change this line
2476 ;; XXXX Do we need to special-case this?
2477 ((null containing-sexp)
2478 ;; Line is at top level. May be data or function definition,
2479 ;; or may be function argument declaration.
2480 ;; Indent like the previous top level line
2481 ;; unless that ends in a closeparen without semicolon,
2482 ;; in which case this line is the first argument decl.
2483 (skip-chars-forward " \t")
2486 (- (current-indentation)
2487 (if (nth 2 s-s) cperl-indent-level 0)))
2488 (if (= char-after ?{) cperl-continued-brace-offset 0)
2490 (cperl-backward-to-noncomment (or old-indent (point-min)))
2491 ;; Look at previous line that's at column 0
2492 ;; to determine whether we are in top-level decls
2493 ;; or function's arg decls. Set basic-indent accordingly.
2494 ;; Now add a little if this is a continuation line.
2496 (eq (point) old-indent) ; old-indent was at comment
2497 (eq (preceding-char) ?\;)
2499 (and (eq (preceding-char) ?\})
2500 (cperl-after-block-and-statement-beg
2501 (point-min))) ; Was start - too close
2502 (memq char-after (append ")]}" nil))
2503 (and (eq (preceding-char) ?\:) ; label
2506 (skip-chars-backward " \t")
2507 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2508 (get-text-property (point) 'first-format-line))
2511 (not (eq char-after ?\C-j)))
2512 (setcdr (cddr parse-data)
2513 (list pre-indent-point)))
2515 cperl-continued-statement-offset))))
2518 (and (setq delim (= (char-after containing-sexp) ?{))
2519 (save-excursion ; Is it a hash?
2520 (goto-char containing-sexp)
2522 cperl-indent-parens-as-block))
2523 ;; group is an expression, not a block:
2524 ;; indent to just after the surrounding open parens,
2525 ;; skip blanks if we do not close the expression.
2526 (goto-char (1+ containing-sexp))
2527 (or (memq char-after
2528 (append (if delim "}" ")]}") nil))
2529 (looking-at "[ \t]*\\(#\\|$\\)")
2530 (skip-chars-forward " \t"))
2533 (eq char-after ?\}))
2534 ;; Correct indentation of trailing ?\}
2535 (+ cperl-indent-level cperl-close-paren-offset)
2537 ;;; ((and (/= (char-after containing-sexp) ?{)
2538 ;;; (not cperl-indent-parens-as-block))
2539 ;;; ;; line is expression, not statement:
2540 ;;; ;; indent to just after the surrounding open,
2541 ;;; ;; skip blanks if we do not close the expression.
2542 ;;; (goto-char (1+ containing-sexp))
2543 ;;; (or (memq char-after (append ")]}" nil))
2544 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2545 ;;; (skip-chars-forward " \t"))
2546 ;;; (current-column))
2548 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
2549 ;;; (goto-char containing-sexp)
2550 ;;; (and (not (cperl-block-p))
2551 ;;; (not cperl-indent-parens-as-block)))
2552 ;;; (goto-char (1+ containing-sexp))
2553 ;;; (or (eq char-after ?\})
2554 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2555 ;;; (skip-chars-forward " \t"))
2556 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
2557 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
2558 ;;; cperl-close-paren-offset)
2561 ;; Statement level. Is it a continuation or a new statement?
2562 ;; Find previous non-comment character.
2563 (goto-char pre-indent-point)
2564 (cperl-backward-to-noncomment containing-sexp)
2565 ;; Back up over label lines, since they don't
2566 ;; affect whether our line is a continuation.
2568 (while ;;(or (eq (preceding-char) ?\,)
2569 (and (eq (preceding-char) ?:)
2570 (or ;;(eq (char-after (- (point) 2)) ?\') ; ????
2571 (memq (char-syntax (char-after (- (point) 2)))
2574 (if (eq (preceding-char) ?\,)
2575 ;; Will go to beginning of line, essentially.
2576 ;; Will ignore embedded sexpr XXXX.
2577 (cperl-backward-to-start-of-continued-exp containing-sexp))
2579 (cperl-backward-to-noncomment containing-sexp))
2580 ;; Now we get the answer.
2581 (if (not (or (eq (1- (point)) containing-sexp)
2582 (memq (preceding-char)
2583 (append (if is-block " ;{" " ,;{") '(nil)))
2584 (and (eq (preceding-char) ?\})
2585 (cperl-after-block-and-statement-beg
2587 (get-text-property (point) 'first-format-line)))
2588 ;; This line is continuation of preceding line's statement;
2589 ;; indent `cperl-continued-statement-offset' more than the
2590 ;; previous line of the statement.
2592 ;; There might be a label on this line, just
2593 ;; consider it bad style and ignore it.
2595 (cperl-backward-to-start-of-continued-exp containing-sexp)
2596 (+ (if (memq char-after (append "}])" nil))
2598 cperl-continued-statement-offset)
2601 (not (eq char-after ?\})))
2603 ;; Now it is a hash reference
2604 (+ cperl-indent-level cperl-close-paren-offset))
2605 (if (looking-at "\\w+[ \t]*:")
2606 (if (> (current-indentation) cperl-min-label-indent)
2607 (- (current-indentation) cperl-label-offset)
2608 ;; Do not move `parse-data', this should
2609 ;; be quick anyway (this comment comes
2610 ;; from different location):
2611 (cperl-calculate-indent))
2613 (if (eq char-after ?\{)
2614 cperl-continued-brace-offset 0)))
2615 ;; This line starts a new statement.
2616 ;; Position following last unclosed open.
2617 (goto-char containing-sexp)
2618 ;; Is line first statement after an open-brace?
2620 ;; If no, find that first statement and indent like
2621 ;; it. If the first statement begins with label, do
2622 ;; not believe when the indentation of the label is too
2626 (setq old-indent (current-indentation))
2627 (let ((colon-line-end 0))
2629 (progn (skip-chars-forward " \t\n")
2630 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
2631 ;; Skip over comments and labels following openbrace.
2632 (cond ((= (following-char) ?\#)
2634 ((= (following-char) ?\=)
2636 (or (next-single-property-change (point) 'in-pod)
2637 (point-max)))) ; do not loop if no syntaxification
2640 (save-excursion (end-of-line)
2641 (setq colon-line-end (point)))
2642 (search-forward ":"))))
2643 ;; The first following code counts
2644 ;; if it is before the line we want to indent.
2645 (and (< (point) indent-point)
2646 (if (> colon-line-end (point)) ; After label
2647 (if (> (current-indentation)
2648 cperl-min-label-indent)
2649 (- (current-indentation) cperl-label-offset)
2650 ;; Do not believe: `max' is involved
2651 (+ old-indent cperl-indent-level))
2652 (current-column)))))
2653 ;; If no previous statement,
2654 ;; indent it relative to line brace is on.
2655 ;; For open brace in column zero, don't let statement
2656 ;; start there too. If cperl-indent-level is zero,
2657 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2658 ;; For open-braces not the first thing in a line,
2659 ;; add in cperl-brace-imaginary-offset.
2661 ;; If first thing on a line: ?????
2662 (+ (if (and (bolp) (zerop cperl-indent-level))
2663 (+ cperl-brace-offset cperl-continued-statement-offset)
2667 (not (eq char-after ?\})))
2669 ;; Now it is a hash reference
2670 (+ cperl-indent-level cperl-close-paren-offset))
2671 ;; Move back over whitespace before the openbrace.
2672 ;; If openbrace is not first nonwhite thing on the line,
2673 ;; add the cperl-brace-imaginary-offset.
2674 (progn (skip-chars-backward " \t")
2675 (if (bolp) 0 cperl-brace-imaginary-offset))
2676 ;; If the openbrace is preceded by a parenthesized exp,
2677 ;; move to the beginning of that;
2678 ;; possibly a different line
2680 (if (eq (preceding-char) ?\))
2682 ;; In the case it starts a subroutine, indent with
2683 ;; respect to `sub', not with respect to the
2684 ;; first thing on the line, say in the case of
2685 ;; anonymous sub in a hash.
2687 (skip-chars-backward " \t")
2688 (if (and (eq (preceding-char) ?b)
2691 (looking-at "sub\\>"))
2695 (save-excursion (beginning-of-line) (point))
2697 (progn (goto-char (1+ old-indent))
2698 (skip-chars-forward " \t")
2700 ;; Get initial indentation of the line we are on.
2701 ;; If line starts with label, calculate label indentation
2704 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2705 (if (> (current-indentation) cperl-min-label-indent)
2706 (- (current-indentation) cperl-label-offset)
2707 ;; Do not move `parse-data', this should
2709 (cperl-calculate-indent))
2710 (current-indentation))))))))))))))
2712 ;; (defvar cperl-indent-alist
2716 ;; (toplevel-after-parenth 2)
2717 ;; (toplevel-continued 2)
2719 ;; "Alist of indentation rules for CPerl mode.
2721 ;; nil: do not indent;
2722 ;; number: add this amount of indentation.
2724 ;; Not finished, not used.")
2726 ;; (defun cperl-where-am-i (&optional parse-start start-state)
2728 ;; "Return a list of lists ((TYPE POS)...) of good points before the point.
2729 ;; ;; POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2731 ;; ;; Not finished, not used."
2733 ;; (let* ((start-point (point))
2734 ;; (s-s (cperl-get-state))
2735 ;; (start (nth 0 s-s))
2736 ;; (state (nth 1 s-s))
2737 ;; (prestart (nth 3 s-s))
2738 ;; (containing-sexp (car (cdr state)))
2739 ;; (case-fold-search nil)
2740 ;; (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
2741 ;; (cond ((nth 3 state) ; In string
2742 ;; (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
2743 ;; ((nth 4 state) ; In comment
2744 ;; (setq res (cons '(comment) res)))
2745 ;; ((null containing-sexp)
2746 ;; ;; Line is at top level.
2747 ;; ;; Indent like the previous top level line
2748 ;; ;; unless that ends in a closeparen without semicolon,
2749 ;; ;; in which case this line is the first argument decl.
2750 ;; (cperl-backward-to-noncomment (or parse-start (point-min)))
2751 ;; ;;(skip-chars-backward " \t\f\n")
2754 ;; (memq (preceding-char) (append ";}" nil)))
2755 ;; (setq res (cons (list 'toplevel start) res)))
2756 ;; ((eq (preceding-char) ?\) )
2757 ;; (setq res (cons (list 'toplevel-after-parenth start) res)))
2759 ;; (setq res (cons (list 'toplevel-continued start) res)))))
2760 ;; ((/= (char-after containing-sexp) ?{)
2761 ;; ;; line is expression, not statement:
2762 ;; ;; indent to just after the surrounding open.
2763 ;; ;; skip blanks if we do not close the expression.
2764 ;; (setq res (cons (list 'expression-blanks
2766 ;; (goto-char (1+ containing-sexp))
2767 ;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2768 ;; (skip-chars-forward " \t"))
2770 ;; (cons (list 'expression containing-sexp) res))))
2772 ;; ;; Containing-expr starts with \{. Check whether it is a hash.
2773 ;; (goto-char containing-sexp)
2774 ;; (not (cperl-block-p)))
2775 ;; (setq res (cons (list 'expression-blanks
2777 ;; (goto-char (1+ containing-sexp))
2778 ;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2779 ;; (skip-chars-forward " \t"))
2781 ;; (cons (list 'expression containing-sexp) res))))
2783 ;; ;; Statement level.
2784 ;; (setq res (cons (list 'in-block containing-sexp) res))
2785 ;; ;; Is it a continuation or a new statement?
2786 ;; ;; Find previous non-comment character.
2787 ;; (cperl-backward-to-noncomment containing-sexp)
2788 ;; ;; Back up over label lines, since they don't
2789 ;; ;; affect whether our line is a continuation.
2790 ;; ;; Back up comma-delimited lines too ?????
2791 ;; (while (or (eq (preceding-char) ?\,)
2792 ;; (save-excursion (cperl-after-label)))
2793 ;; (if (eq (preceding-char) ?\,)
2794 ;; ;; Will go to beginning of line, essentially
2795 ;; ;; Will ignore embedded sexpr XXXX.
2796 ;; (cperl-backward-to-start-of-continued-exp containing-sexp))
2797 ;; (beginning-of-line)
2798 ;; (cperl-backward-to-noncomment containing-sexp))
2799 ;; ;; Now we get the answer.
2800 ;; (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
2801 ;; ;; This line is continuation of preceding line's statement.
2802 ;; (list (list 'statement-continued containing-sexp))
2803 ;; ;; This line starts a new statement.
2804 ;; ;; Position following last unclosed open.
2805 ;; (goto-char containing-sexp)
2806 ;; ;; Is line first statement after an open-brace?
2808 ;; ;; If no, find that first statement and indent like
2809 ;; ;; it. If the first statement begins with label, do
2810 ;; ;; not believe when the indentation of the label is too
2814 ;; (let ((colon-line-end 0))
2815 ;; (while (progn (skip-chars-forward " \t\n" start-point)
2816 ;; (and (< (point) start-point)
2818 ;; "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
2819 ;; ;; Skip over comments and labels following openbrace.
2820 ;; (cond ((= (following-char) ?\#)
2821 ;; ;;(forward-line 1)
2825 ;; (save-excursion (end-of-line)
2826 ;; (setq colon-line-end (point)))
2827 ;; (search-forward ":"))))
2828 ;; ;; Now at the point, after label, or at start
2829 ;; ;; of first statement in the block.
2830 ;; (and (< (point) start-point)
2831 ;; (if (> colon-line-end (point))
2832 ;; ;; Before statement after label
2833 ;; (if (> (current-indentation)
2834 ;; cperl-min-label-indent)
2835 ;; (list (list 'label-in-block (point)))
2836 ;; ;; Do not believe: `max' is involved
2838 ;; (list 'label-in-block-min-indent (point))))
2839 ;; ;; Before statement
2840 ;; (list 'statement-in-block (point))))))
2841 ;; ;; If no previous statement,
2842 ;; ;; indent it relative to line brace is on.
2843 ;; ;; For open brace in column zero, don't let statement
2844 ;; ;; start there too. If cperl-indent-level is zero,
2845 ;; ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2846 ;; ;; For open-braces not the first thing in a line,
2847 ;; ;; add in cperl-brace-imaginary-offset.
2849 ;; ;; If first thing on a line: ?????
2850 ;; (+ (if (and (bolp) (zerop cperl-indent-level))
2851 ;; (+ cperl-brace-offset cperl-continued-statement-offset)
2852 ;; cperl-indent-level)
2853 ;; ;; Move back over whitespace before the openbrace.
2854 ;; ;; If openbrace is not first nonwhite thing on the line,
2855 ;; ;; add the cperl-brace-imaginary-offset.
2856 ;; (progn (skip-chars-backward " \t")
2857 ;; (if (bolp) 0 cperl-brace-imaginary-offset))
2858 ;; ;; If the openbrace is preceded by a parenthesized exp,
2859 ;; ;; move to the beginning of that;
2860 ;; ;; possibly a different line
2862 ;; (if (eq (preceding-char) ?\))
2863 ;; (forward-sexp -1))
2864 ;; ;; Get initial indentation of the line we are on.
2865 ;; ;; If line starts with label, calculate label indentation
2866 ;; (if (save-excursion
2867 ;; (beginning-of-line)
2868 ;; (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2869 ;; (if (> (current-indentation) cperl-min-label-indent)
2870 ;; (- (current-indentation) cperl-label-offset)
2871 ;; (cperl-calculate-indent))
2872 ;; (current-indentation))))))))
2875 (defun cperl-calculate-indent-within-comment ()
2876 "Return the indentation amount for line, assuming that
2877 the current line is to be regarded as part of a block comment."
2878 (let (end star-start)
2881 (skip-chars-forward " \t")
2883 (and (= (following-char) ?#)
2885 (cperl-to-comment-or-eol)
2891 (defun cperl-to-comment-or-eol ()
2892 "Go to position before comment on the current line, or to end of line.
2893 Returns true if comment is found."
2894 (let (state stop-in cpoint (lim (progn (end-of-line) (point))))
2897 (eq (get-text-property (point) 'syntax-type) 'pod)
2898 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t))
2899 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
2901 (while (not stop-in)
2902 (setq state (parse-partial-sexp (point) lim nil nil nil t))
2904 ;; If fails (beginning-of-line inside sexp), then contains not-comment
2905 (if (nth 4 state) ; After `#';
2906 ; (nth 2 state) can be
2907 ; beginning of m,s,qq and so
2911 (setq cpoint (point))
2912 (goto-char (nth 2 state))
2914 ((looking-at "\\(s\\|tr\\)\\>")
2915 (or (re-search-forward
2916 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
2919 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
2920 (or (re-search-forward
2921 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
2924 (t ; It was fair comment
2925 (setq stop-in t) ; Finish
2926 (goto-char (1- cpoint)))))
2927 (setq stop-in t) ; Finish
2929 (setq stop-in t))) ; Finish
2932 (defsubst cperl-1- (p)
2933 (max (point-min) (1- p)))
2935 (defsubst cperl-1+ (p)
2936 (min (point-max) (1+ p)))
2938 (defsubst cperl-modify-syntax-type (at how)
2939 (if (< at (point-max))
2941 (put-text-property at (1+ at) 'syntax-table how)
2942 (put-text-property at (1+ at) 'rear-nonsticky t))))
2944 (defun cperl-protect-defun-start (s e)
2945 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2948 (while (re-search-forward "^\\s(" e 'to-end)
2949 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
2951 (defun cperl-commentify (bb e string &optional noface)
2952 (if cperl-use-syntax-table-text-property
2953 (if (eq noface 'n) ; Only immediate
2955 ;; We suppose that e is _after_ the end of construction, as after eol.
2956 (setq string (if string cperl-st-sfence cperl-st-cfence))
2958 ;; one-char string/comment?!
2959 (cperl-modify-syntax-type bb cperl-st-punct)
2960 (cperl-modify-syntax-type bb string)
2961 (cperl-modify-syntax-type (1- e) string))
2962 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
2963 (put-text-property (1+ bb) (1- e)
2964 'syntax-table cperl-string-syntax-table))
2965 (cperl-protect-defun-start bb e))
2968 (not cperl-pod-here-fontify)
2969 (put-text-property bb e 'face (if string 'font-lock-string-face
2970 'font-lock-comment-face)))))
2972 (defvar cperl-starters '(( ?\( . ?\) )
2977 (defun cperl-forward-re (lim end is-2arg set-st st-l err-l argument
2978 &optional ostart oend)
2979 ;; Works *before* syntax recognition is done
2980 ;; May modify syntax-type text property if the situation is too hard
2981 (let (b starter ender st i i2 go-forward reset-st)
2982 (skip-chars-forward " \t")
2983 ;; ender means matching-char matcher.
2985 starter (if (eobp) 0 (char-after b))
2986 ender (cdr (assoc starter cperl-starters)))
2987 ;; What if starter == ?\\ ????
2990 (setq st (car st-l))
2991 (setcar st-l (make-syntax-table))
2992 (setq i 0 st (car st-l))
2994 (modify-syntax-entry i "." st)
2996 (modify-syntax-entry ?\\ "\\" st)))
2998 ;; Whether we have an intermediate point
3000 ;; Prepare the syntax table:
3002 (if (not ender) ; m/blah/, s/x//, s/x/y/
3003 (modify-syntax-entry starter "$" st)
3004 (modify-syntax-entry starter (concat "(" (list ender)) st)
3005 (modify-syntax-entry ender (concat ")" (list starter)) st)))
3008 ;; We use `$' syntax class to find matching stuff, but $$
3009 ;; is recognized the same as $, so we need to check this manually.
3010 (if (and (eq starter (char-after (cperl-1+ b)))
3012 ;; $ has TeXish matching rules, so $$ equiv $...
3014 (setq reset-st (syntax-table))
3015 (set-syntax-table st)
3017 (if (<= (point) (1+ b))
3018 (error "Unfinished regular expression"))
3019 (set-syntax-table reset-st)
3021 ;; Now the problem is with m;blah;;
3023 (eq (preceding-char)
3024 (char-after (- (point) 2)))
3027 (= 0 (% (skip-chars-backward "\\\\") 2)))
3029 ;; Now we are after the first part.
3030 (and is-2arg ; Have trailing part
3032 (eq (following-char) starter) ; Empty trailing part
3034 (or (eq (char-syntax (following-char)) ?.)
3035 ;; Make trailing letter into punctuation
3036 (cperl-modify-syntax-type (point) cperl-st-punct))
3037 (setq is-2arg nil go-forward t))) ; Ignore the tail
3038 (if is-2arg ; Not number => have second part
3040 (setq i (point) i2 i)
3042 (if (memq (following-char) '(?\ ?\t ?\n ?\f))
3044 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3045 (goto-char (match-end 0))
3046 (skip-chars-forward " \t\n\f"))
3049 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3050 (if ender (modify-syntax-entry ender "." st))
3052 (setq ender (cperl-forward-re lim end nil t st-l err-l
3053 argument starter ender)
3054 ender (nth 2 ender)))))
3055 (error (goto-char lim)
3058 (set-syntax-table reset-st))
3061 "End of `%s%s%c ... %c' string/RE not found: %s"
3063 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3064 starter (or ender starter) bb)
3065 (or (car err-l) (setcar err-l b)))))
3068 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3069 (if ender (modify-syntax-entry ender "." st))))
3070 ;; i: have 2 args, after end of the first arg
3071 ;; i2: start of the second arg, if any (before delim iff `ender').
3072 ;; ender: the last arg bounded by parens-like chars, the second one of them
3073 ;; starter: the starting delimiter of the first arg
3074 ;; go-forward: has 2 args, and the second part is empty
3075 (list i i2 ender starter go-forward)))
3077 (defvar font-lock-string-face)
3078 ;;(defvar font-lock-reference-face)
3079 (defvar font-lock-constant-face)
3080 (defsubst cperl-postpone-fontification (b e type val &optional now)
3081 ;; Do after syntactic fontification?
3082 (if cperl-syntaxify-by-font-lock
3083 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3084 (put-text-property b e type val)))
3086 ;;; Here is how the global structures (those which cannot be
3087 ;;; recognized locally) are marked:
3089 ;; Start-to-end is marked `in-pod' ==> t
3090 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3091 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3093 ;; Start-to-end is marked `here-doc-group' ==> t
3094 ;; The body is marked `syntax-type' ==> `here-doc'
3095 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3097 ;; First line (to =) marked `first-format-line' ==> t
3098 ;; After-this--to-end is marked `syntax-type' ==> `format'
3099 ;; d) 'Q'uoted string:
3100 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3101 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3103 (defun cperl-unwind-to-safe (before &optional end)
3104 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3105 (let ((pos (point)) opos)
3107 (while (and pos (get-text-property pos 'syntax-type))
3108 (setq pos (previous-single-property-change pos 'syntax-type))
3112 (goto-char (cperl-1- pos))
3115 (goto-char (setq pos (cperl-1- pos))))
3117 (goto-char (point-min))))
3119 (and (looking-at "\n*=")
3120 (/= 0 (skip-chars-backward "\n"))
3124 ;; Do the same for end, going small steps
3126 (while (and end (get-text-property end 'syntax-type))
3128 end (next-single-property-change end 'syntax-type)))
3131 (defvar cperl-nonoverridable-face)
3132 (defvar font-lock-function-name-face)
3133 (defvar font-lock-comment-face)
3135 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max)
3136 "Scans the buffer for hard-to-parse Perl constructions.
3137 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3138 the sections using `cperl-pod-head-face', `cperl-pod-face',
3141 (or min (setq min (point-min)
3142 cperl-syntax-state nil
3143 cperl-syntax-done-to min))
3144 (or max (setq max (point-max)))
3145 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3146 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3147 is-REx is-x-REx REx-comment-start REx-comment-end was-comment i2
3148 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3149 (modified (buffer-modified-p))
3150 (after-change-functions nil)
3151 (use-syntax-state (and cperl-syntax-state
3152 (>= min (car cperl-syntax-state))))
3153 (state-point (if use-syntax-state
3154 (car cperl-syntax-state)
3156 (state (if use-syntax-state
3157 (cdr cperl-syntax-state)))
3158 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3159 (st-l (list nil)) (err-l (list nil))
3160 ;; Somehow font-lock may be not loaded yet...
3161 (font-lock-string-face (if (boundp 'font-lock-string-face)
3162 font-lock-string-face
3163 'font-lock-string-face))
3164 (font-lock-constant-face (if (boundp 'font-lock-constant-face)
3165 font-lock-constant-face
3166 'font-lock-constant-face))
3167 (font-lock-function-name-face
3168 (if (boundp 'font-lock-function-name-face)
3169 font-lock-function-name-face
3170 'font-lock-function-name-face))
3171 (font-lock-comment-face
3172 (if (boundp 'font-lock-comment-face)
3173 font-lock-comment-face
3174 'font-lock-comment-face))
3175 (cperl-nonoverridable-face
3176 (if (boundp 'cperl-nonoverridable-face)
3177 cperl-nonoverridable-face
3178 'cperl-nonoverridable))
3179 (stop-point (if ignore-max
3184 "\\(\\`\n?\\|^\n\\)="
3186 ;; One extra () before this:
3189 ;; First variant "BLAH" or just ``.
3190 "[ \t]*" ; Yes, whitespace is allowed!
3191 "\\([\"'`]\\)" ; 2 + 1 = 3
3192 "\\([^\"'`\n]*\\)" ; 3 + 1
3195 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3196 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3197 ;; Do not have <<= or << 30 or <<30 or << $blah.
3198 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3199 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3202 ;; 1+6 extra () before this:
3203 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3204 (if cperl-use-syntax-table-text-property
3207 ;; 1+6+2=9 extra () before this:
3208 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3210 ;; 1+6+2+1=10 extra () before this:
3211 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3213 ;; 1+6+2+1+1=11 extra () before this:
3214 "\\<sub\\>[ \t]*\\([a-zA-Z_:'0-9]+[ \t]*\\)?\\(([^()]*)\\)"
3216 ;; 1+6+2+1+1+2=13 extra () before this:
3219 ;; 1+6+2+1+1+2+1=14 extra () before this:
3220 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3221 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3223 "__\\(END\\|DATA\\)__"
3224 ;; 1+6+2+1+1+2+1+1+1=16 extra () before this:
3226 "\\\\\\(['`\"($]\\)")
3232 (message "Scanning for \"hard\" Perl constructions..."))
3233 (and cperl-pod-here-fontify
3234 ;; We had evals here, do not know why...
3235 (setq face cperl-pod-face
3236 head-face cperl-pod-head-face
3237 here-face cperl-here-face))
3238 (remove-text-properties min max
3239 '(syntax-type t in-pod t syntax-table t
3246 ;; Need to remove face as well...
3248 (and (eq system-type 'emx)
3249 (looking-at "extproc[ \t]") ; Analogue of #!
3250 (cperl-commentify min
3251 (save-excursion (end-of-line) (point))
3255 (re-search-forward search max t))
3256 (setq tmpend nil) ; Valid for most cases
3258 ((match-beginning 1) ; POD section
3259 ;; "\\(\\`\n?\\|^\n\\)="
3260 (if (looking-at "cut\\>")
3262 nil ; Doing a chunk only
3263 (message "=cut is not preceded by a POD section")
3264 (or (car err-l) (setcar err-l (point))))
3269 tb (match-beginning 0)
3270 b1 nil) ; error condition
3271 ;; We do not search to max, since we may be called from
3272 ;; some hook of fontification, and max is random
3273 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
3276 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3278 (message "=cut is not preceded by an empty line")
3280 (or (car err-l) (setcar err-l b))))))
3281 (beginning-of-line 2) ; An empty line after =cut is not POD!
3285 (remove-text-properties
3286 max e '(syntax-type t in-pod t syntax-table t
3294 (put-text-property b e 'in-pod t)
3295 (put-text-property b e 'syntax-type 'in-pod)
3297 (while (re-search-forward "\n\n[ \t]" e t)
3298 ;; We start 'pod 1 char earlier to include the preceding line
3300 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3301 (cperl-put-do-not-fontify b (point) t)
3302 ;; mark the non-literal parts as PODs
3303 (if cperl-pod-here-fontify
3304 (cperl-postpone-fontification b (point) 'face face t))
3305 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3308 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3309 (cperl-put-do-not-fontify (point) e t)
3310 (if cperl-pod-here-fontify
3312 ;; mark the non-literal parts as PODs
3313 (cperl-postpone-fontification (point) e 'face face t)
3316 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3318 (cperl-postpone-fontification
3319 (match-beginning 1) (match-end 1)
3321 (while (re-search-forward
3323 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3326 (cperl-postpone-fontification
3327 (match-beginning 1) (match-end 1)
3329 (cperl-commentify bb e nil)
3331 (or (eq e (point-max))
3332 (forward-char -1)))) ; Prepare for immediate POD start.
3334 ;; We do only one here-per-line
3335 ;; ;; One extra () before this:
3338 ;; ;; First variant "BLAH" or just ``.
3339 ;; "[ \t]*" ; Yes, whitespace is allowed!
3340 ;; "\\([\"'`]\\)" ; 2 + 1
3341 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3344 ;; ;; Second variant: Identifier or \ID or empty
3345 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3346 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3347 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3348 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3350 ((match-beginning 2) ; 1 + 1
3351 ;; Abort in comment:
3353 (setq state (parse-partial-sexp state-point b nil nil state)
3355 tb (match-beginning 0)
3356 i (or (nth 3 state) (nth 4 state)))
3361 (not (match-beginning 6)) ; Empty
3363 "[ \t]*[=0-9$@%&(]"))))
3364 (if c ; Not here-doc
3366 (if (match-beginning 5) ;4 + 1
3367 (setq b1 (match-beginning 5) ; 4 + 1
3368 e1 (match-end 5)) ; 4 + 1
3369 (setq b1 (match-beginning 4) ; 3 + 1
3370 e1 (match-end 4))) ; 3 + 1
3371 (setq tag (buffer-substring b1 e1)
3372 qtag (regexp-quote tag))
3373 (cond (cperl-pod-here-fontify
3374 ;; Highlight the starting delimiter
3375 (cperl-postpone-fontification b1 e1 'face font-lock-constant-face)
3376 (cperl-put-do-not-fontify b1 e1 t)))
3379 ;; We do not search to max, since we may be called from
3380 ;; some hook of fontification, and max is random
3381 (or (and (re-search-forward (concat "^" qtag "$")
3383 (eq (following-char) ?\n))
3384 (progn ; Pretend we matched at the end
3385 (goto-char (point-max))
3386 (re-search-forward "\\'")
3387 (message "End of here-document `%s' not found." tag)
3388 (or (car err-l) (setcar err-l b))))
3389 (if cperl-pod-here-fontify
3391 ;; Highlight the ending delimiter
3392 (cperl-postpone-fontification (match-beginning 0) (match-end 0)
3393 'face font-lock-constant-face)
3394 (cperl-put-do-not-fontify b (match-end 0) t)
3395 ;; Highlight the HERE-DOC
3396 (cperl-postpone-fontification b (match-beginning 0)
3398 (setq e1 (cperl-1+ (match-end 0)))
3399 (put-text-property b (match-beginning 0)
3400 'syntax-type 'here-doc)
3401 (put-text-property (match-beginning 0) e1
3402 'syntax-type 'here-doc-delim)
3403 (put-text-property b e1
3405 (cperl-commentify b e1 nil)
3406 (cperl-put-do-not-fontify b (match-end 0) t)
3410 ((match-beginning 8)
3411 ;; 1+6=7 extra () before this:
3412 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3414 name (if (match-beginning 8) ; 7 + 1
3415 (buffer-substring (match-beginning 8) ; 7 + 1
3416 (match-end 8)) ; 7 + 1
3418 tb (match-beginning 0))
3420 (put-text-property (save-excursion
3423 b 'first-format-line 't)
3424 (if cperl-pod-here-fontify
3425 (while (and (eq (forward-line) 0)
3426 (not (looking-at "^[.;]$")))
3428 ((looking-at "^#")) ; Skip comments
3429 ((and argument ; Skip argument multi-lines
3430 (looking-at "^[ \t]*{"))
3432 (setq argument nil))
3433 (argument ; Skip argument lines
3434 (setq argument nil))
3437 (setq argument (looking-at "^[^\n]*[@^]"))
3439 ;; Highlight the format line
3440 (cperl-postpone-fontification b1 (point)
3441 'face font-lock-string-face)
3442 (cperl-commentify b1 (point) nil)
3443 (cperl-put-do-not-fontify b1 (point) t))))
3444 ;; We do not search to max, since we may be called from
3445 ;; some hook of fontification, and max is random
3446 (re-search-forward "^[.;]$" stop-point 'toend))
3448 (if (looking-at "^\\.$") ; ";" is not supported yet
3450 ;; Highlight the ending delimiter
3451 (cperl-postpone-fontification (point) (+ (point) 2)
3452 'face font-lock-string-face)
3453 (cperl-commentify (point) (+ (point) 2) nil)
3454 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
3455 (message "End of format `%s' not found." name)
3456 (or (car err-l) (setcar err-l b)))
3460 (put-text-property b (point) 'syntax-type 'format))
3462 ((or (match-beginning 10) (match-beginning 11))
3463 ;; 1+6+2=9 extra () before this:
3464 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3466 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3467 (setq b1 (if (match-beginning 10) 10 11)
3468 argument (buffer-substring
3469 (match-beginning b1) (match-end b1))
3472 c (char-after (match-beginning b1))
3473 bb (char-after (1- (match-beginning b1))) ; tmp holder
3474 ;; bb == "Not a stringy"
3475 bb (if (eq b1 10) ; user variables/whatever
3476 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
3477 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
3478 ((eq bb ?\:) ; $opt::s
3480 (- (match-beginning b1) 2))
3482 ((eq bb ?\>) ; $foo->s
3484 (- (match-beginning b1) 2))
3487 (not (eq (char-after ; &&m/blah/
3488 (- (match-beginning b1) 2))
3491 ;; <file> or <$file>
3493 ;; Do not stringify <FH>, <$fh> :
3496 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
3497 tb (match-beginning 0))
3498 (goto-char (match-beginning b1))
3499 (cperl-backward-to-noncomment (point-min))
3501 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
3507 ;; What is below: regexp-p?
3509 (or (memq (preceding-char)
3510 (append (if (memq c '(?\? ?\<))
3513 "~{(=|&+-*!,;:") nil))
3514 (and (eq (preceding-char) ?\})
3515 (cperl-after-block-p (point-min)))
3516 (and (eq (char-syntax (preceding-char)) ?w)
3519 ;; After these keywords `/' starts a RE. One should add all the
3520 ;; functions/builtins which expect an argument, but ...
3521 (if (eq (preceding-char) ?-)
3523 (looking-at "[a-zA-Z]\\>")
3525 (not (memq (preceding-char)
3528 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
3529 (and (eq (preceding-char) ?.)
3530 (eq (char-after (- (point) 2)) ?.))
3532 ;; m|blah| ? foo : bar;
3535 cperl-use-syntax-table-text-property
3539 (looking-at "\\s|")))))))
3542 ;; Check for $a -> y
3543 (setq b1 (preceding-char)
3546 (eq (char-after (- go 2)) ?-))
3549 (or bb (setq state (parse-partial-sexp
3550 state-point b nil nil state)
3552 (setq bb (or bb (nth 3 state) (nth 4 state)))
3556 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3557 (goto-char (match-end 0))
3558 (skip-chars-forward " \t\n\f"))
3559 (cond ((and (eq (following-char) ?\})
3561 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
3563 (skip-chars-backward " \t\n\f")
3564 (if (memq (preceding-char) (append "$@%&*" nil))
3570 (looking-at ; $foo -> {s}
3571 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
3572 (and ; $foo[12] -> {s}
3573 (memq (following-char) '(?\{ ?\[))
3576 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
3579 ((and (eq (following-char) ?=)
3580 (eq (char-after (1+ (point))) ?\>))
3581 ;; Check for { foo => 1, s => 2 }
3582 ;; Apparently s=> is never a substitution...
3584 ((and (eq (following-char) ?:)
3585 (eq b1 ?\{) ; Check for $ { s::bar }
3586 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
3589 (skip-chars-backward " \t\n\f")
3590 (memq (preceding-char)
3591 (append "$@%&*" nil))))
3595 ;; Skip whitespace and comments...
3596 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3597 (goto-char (match-end 0))
3598 (skip-chars-forward " \t\n\f"))
3600 (put-text-property b (point) 'syntax-type 'prestring))
3601 ;; qtag means two-arg matcher, may be reset to
3602 ;; 2 or 3 later if some special quoting is needed.
3603 ;; e1 means matching-char matcher.
3606 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
3607 ;; We do not search to max, since we may be called from
3608 ;; some hook of fontification, and max is random
3609 i (cperl-forward-re stop-point end
3611 t st-l err-l argument)
3612 ;; Note that if `go', then it is considered as 1-arg
3613 b1 (nth 1 i) ; start of the second part
3614 tag (nth 2 i) ; ender-char, true if second part
3615 ; is with matching chars []
3616 go (nth 4 i) ; There is a 1-char part after the end
3617 i (car i) ; intermediate point
3619 ;; Before end of the second part if non-matching: ///
3620 tail (if (and i (not tag))
3622 e (if i i e1) ; end of the first part
3623 qtag nil ; need to preserve backslashitis
3624 is-x-REx nil) ; REx has //x modifier
3625 ;; Commenting \\ is dangerous, what about ( ?
3627 (eq (char-after i) ?\\)
3629 (if (looking-at "\\sw*x") ; qr//x
3632 ;; Considered as 1arg form
3634 (cperl-commentify b (point) t)
3635 (put-text-property b (point) 'syntax-type 'string)
3637 ;; ignore other text properties:
3638 (string-match "^qw$" argument))
3639 (put-text-property b (point) 'indentable t))
3641 (setq e1 (cperl-1+ e1))
3644 (cperl-commentify b i t)
3645 (if (looking-at "\\sw*e") ; s///e
3649 (cperl-find-pods-heres b1 (1- (point)) t end)
3651 (goto-char (1+ max)))
3652 (if (and tag (eq (preceding-char) ?\>))
3654 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
3655 (cperl-modify-syntax-type i cperl-st-bra)))
3656 (put-text-property b i 'syntax-type 'string)
3658 (put-text-property b i 'indentable t)))
3659 (cperl-commentify b1 (point) t)
3660 (put-text-property b (point) 'syntax-type 'string)
3662 (put-text-property b i 'indentable t))
3664 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
3666 ;; Now: tail: if the second part is non-matching without ///e
3667 (if (eq (char-syntax (following-char)) ?w)
3669 (forward-word 1) ; skip modifiers s///s
3670 (if tail (cperl-commentify tail (point) t))
3671 (cperl-postpone-fontification
3672 e1 (point) 'face 'cperl-nonoverridable)))
3673 ;; Check whether it is m// which means "previous match"
3674 ;; and highlight differently
3676 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
3677 (or (not (= (length argument) 0))
3681 ;; split // *is* using zero-pattern
3687 (not (looking-at "split\\>")))
3689 (cperl-postpone-fontification
3690 b e 'face font-lock-function-name-face)
3691 (if (or i2 ; Has 2 args
3692 (and cperl-fontify-m-as-s
3694 (string-match "^\\(m\\|qr\\)$" argument)
3695 (and (eq 0 (length argument))
3696 (not (eq ?\< (char-after b)))))))
3698 (cperl-postpone-fontification
3699 b (cperl-1+ b) 'face font-lock-constant-face)
3700 (cperl-postpone-fontification
3701 (1- e) e 'face font-lock-constant-face)))
3702 (if (and is-REx cperl-regexp-scan)
3703 ;; Process RExen better
3710 (if (eq (char-after b) ?\#)
3711 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
3712 "\\((\\?#\\)\\|\\(#\\)")
3713 (if (eq (char-after b) ?\#)
3717 (goto-char (match-beginning 0))
3718 (setq REx-comment-start (point)
3722 ;; XXX not working if outside delimiter is #
3723 (eq (preceding-char) ?\\)
3724 (= (% (skip-chars-backward "$\\\\") 2) -1)))
3725 ;; Not a comment, avoid loop:
3726 (progn (setq was-comment nil)
3728 (if (match-beginning 2)
3730 (beginning-of-line 2)
3732 (goto-char (1- e))))
3733 ;; Works also if the outside delimiters are ().
3734 (or (search-forward ")" (1- e) 'toend)
3736 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
3737 REx-comment-start))))
3742 (setq REx-comment-end (point))
3744 REx-comment-start REx-comment-end nil)
3745 (cperl-postpone-fontification
3746 REx-comment-start REx-comment-end
3747 'face font-lock-comment-face))))))
3748 (if (and is-REx is-x-REx)
3749 (put-text-property (1+ b) (1- e)
3750 'syntax-subtype 'x-REx)))
3753 (cperl-postpone-fontification
3754 (1- e1) e1 'face font-lock-constant-face)
3755 (if (assoc (char-after b) cperl-starters)
3756 (cperl-postpone-fontification
3757 b1 (1+ b1) 'face font-lock-constant-face))))
3760 ((match-beginning 13) ; sub with prototypes
3761 (setq b (match-beginning 0))
3762 (if (memq (char-after (1- b))
3763 '(?\$ ?\@ ?\% ?\& ?\*))
3765 (setq state (parse-partial-sexp
3766 state-point b nil nil state)
3768 (if (or (nth 3 state) (nth 4 state))
3771 (cperl-commentify (match-beginning 13) (match-end 13) t))
3772 (goto-char (match-end 0))))
3773 ;; 1+6+2+1+1+2=13 extra () before this:
3775 ((and (match-beginning 14)
3776 (eq (preceding-char) ?\')) ; $'
3777 (setq b (1- (point))
3778 state (parse-partial-sexp
3779 state-point (1- b) nil nil state)
3781 (if (nth 3 state) ; in string
3782 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3784 ;; 1+6+2+1+1+2=13 extra () before this:
3786 ((match-beginning 14) ; ${
3787 (setq bb (match-beginning 0))
3788 (cperl-modify-syntax-type bb cperl-st-punct))
3789 ;; 1+6+2+1+1+2+1=14 extra () before this:
3790 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3791 ((match-beginning 15) ; old $abc'efg syntax
3792 (setq bb (match-end 0)
3793 b (match-beginning 0)
3794 state (parse-partial-sexp
3795 state-point b nil nil state)
3797 (if (nth 3 state) ; in string
3799 (put-text-property (1- bb) bb 'syntax-table cperl-st-word))
3801 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3802 ;; "__\\(END\\|DATA\\)__"
3803 ((match-beginning 16) ; __END__, __DATA__
3804 (setq bb (match-end 0)
3805 b (match-beginning 0)
3806 state (parse-partial-sexp
3807 state-point b nil nil state)
3809 (if (or (nth 3 state) (nth 4 state))
3811 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3812 (cperl-commentify b bb nil)
3815 ((match-beginning 17) ; "\\\\\\(['`\"($]\\)"
3816 ;; Trailing backslash ==> non-quoting outside string/comment
3817 (setq bb (match-end 0)
3818 b (match-beginning 0))
3820 (skip-chars-backward "\\\\")
3821 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
3822 (setq state (parse-partial-sexp
3823 state-point b nil nil state)
3825 (if (or (nth 3 state) (nth 4 state) )
3827 (cperl-modify-syntax-type b cperl-st-punct))
3829 (t (error "Error in regexp of the sniffer")))
3830 (if (> (point) stop-point)
3833 (message "Garbage after __END__/__DATA__ ignored")
3834 (message "Unbalanced syntax found while scanning")
3835 (or (car err-l) (setcar err-l b)))
3836 (goto-char stop-point))))
3837 (setq cperl-syntax-state (cons state-point state)
3838 cperl-syntax-done-to (or tmpend (max (point) max))))
3839 (if (car err-l) (goto-char (car err-l))
3841 (message "Scanning for \"hard\" Perl constructions... done"))))
3842 (and (buffer-modified-p)
3844 (set-buffer-modified-p nil))
3845 ;; I do not understand what this is doing here. It breaks font-locking
3846 ;; because it resets the syntax-table from font-lock-syntax-table to
3847 ;; cperl-mode-syntax-table.
3848 ;; (set-syntax-table cperl-mode-syntax-table)
3852 (defun cperl-backward-to-noncomment (lim)
3853 ;; Stops at lim or after non-whitespace that is not in comment
3855 (while (and (not stop) (> (point) (or lim 1)))
3856 (skip-chars-backward " \t\n\f" lim)
3859 (if (memq (setq pr (get-text-property (point) 'syntax-type))
3860 '(pod here-doc here-doc-delim))
3861 (cperl-unwind-to-safe nil)
3862 (or (looking-at "^[ \t]*\\(#\\|$\\)")
3863 (progn (cperl-to-comment-or-eol) (bolp))
3865 (skip-chars-backward " \t")
3866 (if (< p (point)) (goto-char p))
3869 (defun cperl-after-block-p (lim &optional pre-block)
3870 "Return true if the preceeding } ends a block or a following { starts one.
3871 Would not look before LIM. If PRE-BLOCK is nil checks preceeding }.
3872 otherwise following {."
3873 ;; We suppose that the preceding char is }.
3877 (or pre-block (forward-sexp -1))
3878 (cperl-backward-to-noncomment lim)
3879 (or (eq (point) lim)
3880 (eq (preceding-char) ?\) ) ; if () {} sub f () {}
3881 (if (eq (char-syntax (preceding-char)) ?w) ; else {}
3884 (or (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
3887 (cperl-backward-to-noncomment lim)
3888 (and (eq (char-syntax (preceding-char)) ?w)
3891 (looking-at "sub\\>"))))))
3892 (cperl-after-expr-p lim))))
3895 (defun cperl-after-expr-p (&optional lim chars test)
3896 "Return true if the position is good for start of expression.
3897 TEST is the expression to evaluate at the found position. If absent,
3898 CHARS is a string that contains good characters to have before us (however,
3899 `}' is treated \"smartly\" if it is not in the list)."
3900 (let ((lim (or lim (point-min)))
3902 (cperl-update-syntaxification (point) (point))
3904 (while (and (not stop) (> (point) lim))
3905 (skip-chars-backward " \t\n\f" lim)
3908 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
3909 ;; '(pod here-doc here-doc-delim))
3910 (if (get-text-property (point) 'here-doc-group)
3913 (previous-single-property-change (point) 'here-doc-group))
3914 (beginning-of-line 0)))
3915 (if (get-text-property (point) 'in-pod)
3918 (previous-single-property-change (point) 'in-pod))
3919 (beginning-of-line 0)))
3920 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
3921 ;; Else: last iteration, or a label
3922 (cperl-to-comment-or-eol) ; Will not move past "." after a format
3923 (skip-chars-backward " \t")
3924 (if (< p (point)) (goto-char p))
3926 (if (and (eq (preceding-char) ?:)
3929 (skip-chars-backward " \t\n\f" lim)
3930 (eq (char-syntax (preceding-char)) ?w)))
3931 (forward-sexp -1) ; Possibly label. Skip it
3934 (or (bobp) ; ???? Needed
3936 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
3938 (if test (eval test)
3939 (or (memq (preceding-char) (append (or chars "{;") nil))
3940 (and (eq (preceding-char) ?\})
3941 (cperl-after-block-p lim))
3942 (and (eq (following-char) ?.) ; in format: see comment above
3943 (eq (get-text-property (point) 'syntax-type)
3946 (defun cperl-backward-to-start-of-continued-exp (lim)
3947 (if (memq (preceding-char) (append ")]}\"'`" nil))
3950 (if (<= (point) lim)
3951 (goto-char (1+ lim)))
3952 (skip-chars-forward " \t"))
3954 (defun cperl-after-block-and-statement-beg (lim)
3955 ;; We assume that we are after ?\}
3957 (cperl-after-block-p lim)
3960 (cperl-backward-to-noncomment (point-min))
3963 (not (= (char-syntax (preceding-char)) ?w))
3968 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
3971 (defun cperl-indent-exp ()
3972 "Simple variant of indentation of continued-sexp.
3974 Will not indent comment if it starts at `comment-indent' or looks like
3975 continuation of the comment on the previous line.
3977 If `cperl-indent-region-fix-constructs', will improve spacing on
3978 conditional/loop constructs."
3981 (let ((tmp-end (progn (end-of-line) (point))) top done)
3986 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
3988 (setq top (point))) ; Get the outermost parenths in line
3990 (while (< (point) tmp-end)
3991 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
3992 (or (eolp) (forward-sexp 1)))
3993 (if (> (point) tmp-end)
3996 (setq tmp-end (point)))
3999 (setq tmp-end (point-marker)))
4000 (if cperl-indent-region-fix-constructs
4001 (cperl-fix-line-spacing tmp-end))
4002 (cperl-indent-region (point) tmp-end))))
4004 (defun cperl-fix-line-spacing (&optional end parse-data)
4005 "Improve whitespace in a conditional/loop construct.
4006 Returns some position at the last line."
4009 (setq end (point-max)))
4010 (let ((ee (save-excursion (end-of-line) (point)))
4011 (cperl-indent-region-fix-constructs
4012 (or cperl-indent-region-fix-constructs 1))
4013 p pp ml have-brace ret)
4020 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
4021 (setq have-brace (save-excursion (search-forward "}" ee t)))))
4022 nil ; Do not need to do anything
4026 (if (and cperl-merge-trailing-else
4028 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
4030 (search-forward "}")
4032 (skip-chars-forward " \t\n")
4033 (delete-region p (point))
4034 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4035 (beginning-of-line)))
4038 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
4040 (search-forward "}")
4041 (delete-horizontal-space)
4042 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4043 (beginning-of-line)))
4047 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4050 (delete-horizontal-space)
4051 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4052 (beginning-of-line)))
4056 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
4059 (delete-horizontal-space)
4060 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4061 (beginning-of-line)))
4063 ;; foreach my $var (
4065 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4068 (delete-horizontal-space)
4070 (make-string cperl-indent-region-fix-constructs ?\ ))
4071 (beginning-of-line)))
4073 ;; } foreach my $var () {
4075 "[ \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]*{")
4077 (setq ml (match-beginning 8))
4078 (re-search-forward "[({]")
4081 (if (eq (following-char) ?\( )
4085 ;; after `else' or nothing
4086 (if ml ; after `else'
4087 (skip-chars-backward " \t\n")
4088 (beginning-of-line))
4090 ;; Now after the sexp before the brace
4091 ;; Multiline expr should be special
4092 (setq ml (and pp (save-excursion (goto-char p)
4093 (search-forward "\n" pp t))))
4094 (if (and (or (not pp) (< pp end))
4095 (looking-at "[ \t\n]*{"))
4098 ((bolp) ; Were before `{', no if/else/etc
4100 ((looking-at "\\(\t*\\| [ \t]+\\){")
4101 (delete-horizontal-space)
4103 cperl-extra-newline-before-brace-multiline
4104 cperl-extra-newline-before-brace)
4106 (delete-horizontal-space)
4109 (if (cperl-indent-line parse-data)
4111 (cperl-fix-line-spacing end parse-data)
4112 (setq ret (point)))))
4114 (make-string cperl-indent-region-fix-constructs ?\ ))))
4115 ((and (looking-at "[ \t]*\n")
4117 cperl-extra-newline-before-brace-multiline
4118 cperl-extra-newline-before-brace)))
4120 (skip-chars-forward " \t\n")
4121 (delete-region pp (point))
4123 (make-string cperl-indent-region-fix-constructs ?\ ))))
4124 ;; Now we are before `{'
4125 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
4127 (skip-chars-forward " \t\n")
4132 (setq ml (search-forward "\n" p t))
4133 (if (or cperl-break-one-line-blocks-when-indent ml)
4134 ;; not good: multi-line BLOCK
4137 (delete-horizontal-space)
4140 (if (cperl-indent-line parse-data)
4141 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
4143 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
4144 ;; Now check whether there is a hanging `}'
4148 cperl-fix-hanging-brace-when-indent
4150 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
4154 (if (and (<= (point) pp)
4155 (eq (preceding-char) ?\} )
4156 (cperl-after-block-and-statement-beg (point-min)))
4163 (skip-chars-backward " \t")
4165 ;; `}' was the first thing on the line, insert NL *after* it.
4167 (cperl-indent-line parse-data)
4168 (search-forward "}")
4169 (delete-horizontal-space)
4171 (delete-horizontal-space)
4172 (or (eq (preceding-char) ?\;)
4174 (and (eq (preceding-char) ?\} )
4175 (cperl-after-block-p (point-min)))
4179 (if (cperl-indent-line parse-data)
4180 (setq ret (cperl-fix-line-spacing end parse-data)))
4181 (beginning-of-line)))))
4184 (defvar cperl-update-start) ; Do not need to make them local
4185 (defvar cperl-update-end)
4186 (defun cperl-delay-update-hook (beg end old-len)
4187 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
4188 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
4190 (defun cperl-indent-region (start end)
4191 "Simple variant of indentation of region in CPerl mode.
4192 Should be slow. Will not indent comment if it starts at `comment-indent'
4193 or looks like continuation of the comment on the previous line.
4194 Indents all the lines whose first character is between START and END
4197 If `cperl-indent-region-fix-constructs', will improve spacing on
4198 conditional/loop constructs."
4200 (cperl-update-syntaxification end end)
4202 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
4203 (let ((indent-info (if cperl-emacs-can-parse
4204 (list nil nil nil) ; Cannot use '(), since will modify
4207 after-change-functions ; Speed it up!
4208 st comm old-comm-indent new-comm-indent p pp i empty)
4209 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
4211 (setq old-comm-indent (and (cperl-to-comment-or-eol)
4213 new-comm-indent old-comm-indent)
4215 (setq end (set-marker (make-marker) end)) ; indentation changes pos
4216 (or (bolp) (beginning-of-line 2))
4217 (while (and (<= (point) end) (not (eobp))) ; bol to check start
4220 (setq empty (looking-at "[ \t]*\n"))
4221 (and (setq comm (looking-at "[ \t]*#"))
4222 (or (eq (current-indentation) (or old-comm-indent
4224 (setq old-comm-indent nil))))
4225 (if (and old-comm-indent
4227 (= (current-indentation) old-comm-indent)
4228 (not (eq (get-text-property (point) 'syntax-type) 'pod))
4229 (not (eq (get-text-property (point) 'syntax-table)
4231 (let ((comment-column new-comm-indent))
4232 (indent-for-comment)))
4234 (setq i (cperl-indent-line indent-info))
4238 (if cperl-indent-region-fix-constructs
4239 (goto-char (cperl-fix-line-spacing end indent-info)))
4240 (if (setq old-comm-indent
4241 (and (cperl-to-comment-or-eol)
4242 (not (memq (get-text-property (point)
4245 (not (eq (get-text-property (point)
4249 (progn (indent-for-comment)
4250 (skip-chars-backward " \t")
4251 (skip-chars-backward "#")
4252 (setq new-comm-indent (current-column))))))))
4253 (beginning-of-line 2)))
4254 ;; Now run the update hooks
4255 (and after-change-functions
4258 (goto-char cperl-update-end)
4261 (goto-char cperl-update-start)
4263 (delete-char -1))))))
4265 ;; Stolen from lisp-mode with a lot of improvements
4267 (defun cperl-fill-paragraph (&optional justify iteration)
4268 "Like `fill-paragraph', but handle CPerl comments.
4269 If any of the current line is a comment, fill the comment or the
4270 block of it that point is in, preserving the comment's initial
4271 indentation and initial hashes. Behaves usually outside of comment."
4272 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
4273 (let (;; Non-nil if the current line contains a comment.
4276 ;; If has-comment, the appropriate fill-prefix for the comment.
4278 ;; Line that contains code and comment (or nil)
4280 c spaces len dc (comment-column comment-column))
4281 ;; Figure out what kind of comment we are looking at.
4286 ;; A line with nothing but a comment on it?
4287 ((looking-at "[ \t]*#[# \t]*")
4289 comment-fill-prefix (buffer-substring (match-beginning 0)
4292 ;; A line with some code, followed by a comment? Remember that the
4293 ;; semi which starts the comment shouldn't be part of a string or
4295 ((cperl-to-comment-or-eol)
4296 (setq has-comment t)
4297 (looking-at "#+[ \t]*")
4298 (setq start (point) c (current-column)
4300 (concat (make-string (current-column) ?\ )
4301 (buffer-substring (match-beginning 0) (match-end 0)))
4302 spaces (progn (skip-chars-backward " \t")
4303 (buffer-substring (point) start))
4304 dc (- c (current-column)) len (- start (point))
4305 start (point-marker))
4307 (insert (make-string dc ?-)))))
4308 (if (not has-comment)
4309 (fill-paragraph justify) ; Do the usual thing outside of comment
4310 ;; Narrow to include only the comment, and then fill the region.
4313 ;; Find the first line we should include in the region to fill.
4314 (if start (progn (beginning-of-line) (point))
4316 (while (and (zerop (forward-line -1))
4317 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4318 ;; We may have gone to far. Go forward again.
4319 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
4322 ;; Find the beginning of the first line past the region to fill.
4324 (while (progn (forward-line 1)
4325 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4327 ;; Remove existing hashes
4329 (goto-char (point-min))
4330 (while (progn (forward-line 1) (< (point) (point-max)))
4331 (skip-chars-forward " \t")
4332 (and (looking-at "#+")
4333 (delete-char (- (match-end 0) (match-beginning 0))))))
4335 ;; Lines with only hashes on them can be paragraph boundaries.
4336 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
4337 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
4338 (fill-prefix comment-fill-prefix))
4339 (fill-paragraph justify)))
4344 (progn (delete-char dc) (insert spaces)))
4345 (if (or (= (current-column) c) iteration) nil
4346 (setq comment-column c)
4347 (indent-for-comment)
4348 ;; Repeat once more, flagging as iteration
4349 (cperl-fill-paragraph justify t)))))))
4351 (defun cperl-do-auto-fill ()
4352 ;; Break out if the line is short enough
4353 (if (> (save-excursion
4357 (let ((c (save-excursion (beginning-of-line)
4358 (cperl-to-comment-or-eol) (point)))
4359 (s (memq (following-char) '(?\s ?\t))) marker)
4361 ;; Don't break line inside code: only inside comment.
4363 (setq marker (point-marker))
4364 (fill-paragraph nil)
4366 ;; Is not enough, sometimes marker is a start of line
4367 (if (bolp) (progn (re-search-forward "#+[ \t]*")
4368 (goto-char (match-end 0))))
4369 ;; Following space could have gone:
4370 (if (or (not s) (memq (following-char) '(?\s ?\t))) nil
4373 ;; Previous space could have gone:
4374 (or (memq (preceding-char) '(?\s ?\t)) (insert " "))))))
4376 (defun cperl-imenu-addback (lst &optional isback name)
4377 ;; We suppose that the lst is a DAG, unless the first element only
4378 ;; loops back, and ISBACK is set. Thus this function cannot be
4379 ;; applied twice without ISBACK set.
4380 (cond ((not cperl-imenu-addback) lst)
4383 (setq name "+++BACK+++"))
4384 (mapcar (lambda (elt)
4385 (if (and (listp elt) (listp (cdr elt)))
4387 ;; In the other order it goes up
4388 ;; one level only ;-(
4389 (setcdr elt (cons (cons name lst)
4391 (cperl-imenu-addback (cdr elt) t name))))
4392 (if isback (cdr lst) lst))
4395 (defun cperl-imenu--create-perl-index (&optional regexp)
4396 (require 'imenu) ; May be called from TAGS creator
4397 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
4398 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
4399 (index-meth-alist '()) meth
4400 packages ends-ranges p marker
4401 (prev-pos 0) char fchar index index1 name (end-range 0) package)
4402 (goto-char (point-min))
4403 (cperl-update-syntaxification (point-max) (point-max))
4404 ;; Search for the function
4405 (progn ;;save-match-data
4406 (while (re-search-forward
4407 (or regexp cperl-imenu--function-name-regexp-perl)
4410 ((and ; Skip some noise if building tags
4411 (match-beginning 2) ; package or sub
4412 (eq (char-after (match-beginning 2)) ?p) ; package
4413 (not (save-match-data
4414 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
4417 (match-beginning 2) ; package or sub
4418 ;; Skip if quoted (will not skip multi-line ''-strings :-():
4419 (null (get-text-property (match-beginning 1) 'syntax-table))
4420 (null (get-text-property (match-beginning 1) 'syntax-type))
4421 (null (get-text-property (match-beginning 1) 'in-pod)))
4423 (goto-char (match-beginning 2))
4424 (setq fchar (following-char)))
4425 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4426 ;; (goto-char (match-end 0))) ; Messes what follows
4427 (setq char (following-char) ; ?\; for "sub foo () ;"
4430 (while (and ends-ranges (>= p (car ends-ranges)))
4431 ;; delete obsolete entries
4432 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
4433 (setq package (or (car packages) "")
4434 end-range (or (car ends-ranges) 0))
4436 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4438 (set-text-properties 0 (length name) nil name)
4440 package (concat name "::")
4441 name (concat "package " name)
4444 (parse-partial-sexp (point) (point-max) -1) (point))
4445 ends-ranges (cons end-range ends-ranges)
4446 packages (cons package packages)))
4448 ;; Skip this function name if it is a prototype declaration.
4449 (if (and (eq fchar ?s) (eq char ?\;)) nil
4450 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4451 marker (make-marker))
4452 (set-text-properties 0 (length name) nil name)
4453 (set-marker marker (match-end 3))
4455 (setq name (concat "package " name))
4456 (cond ((string-match "[:']" name)
4458 ((> p end-range) nil)
4460 (setq name (concat package name) meth t))))
4461 (setq index (cons name marker))
4463 (push index index-pack-alist)
4464 (push index index-alist))
4465 (if meth (push index index-meth-alist))
4466 (push index index-unsorted-alist)))
4467 ((match-beginning 5) ; POD section
4468 ;; (beginning-of-line)
4469 (setq index (imenu-example--name-and-position)
4470 name (buffer-substring (match-beginning 6) (match-end 6)))
4471 (set-text-properties 0 (length name) nil name)
4472 (if (eq (char-after (match-beginning 5)) ?2)
4473 (setq name (concat " " name)))
4475 (setq index1 (cons (concat "=" name) (cdr index)))
4476 (push index index-pod-alist)
4477 (push index1 index-unsorted-alist)))))
4479 (if (default-value 'imenu-sort-function)
4480 (sort index-alist (default-value 'imenu-sort-function))
4481 (nreverse index-alist)))
4482 (and index-pod-alist
4483 (push (cons "+POD headers+..."
4484 (nreverse index-pod-alist))
4486 (and (or index-pack-alist index-meth-alist)
4487 (let ((lst index-pack-alist) hier-list pack elt group name)
4488 ;; Remove "package ", reverse and uniquify.
4490 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
4491 (if (assoc name hier-list) nil
4492 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
4493 (setq lst index-meth-alist)
4495 (setq elt (car lst) lst (cdr lst))
4496 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
4497 (setq pack (substring (car elt) 0 (match-beginning 0)))
4498 (if (setq group (assoc pack hier-list))
4499 (if (listp (cdr group))
4500 ;; Have some functions already
4502 (cons (cons (substring
4504 (+ 2 (match-beginning 0)))
4507 (setcdr group (list (cons (substring
4509 (+ 2 (match-beginning 0)))
4513 (list (cons (substring
4515 (+ 2 (match-beginning 0)))
4518 (push (cons "+Hierarchy+..."
4521 (and index-pack-alist
4522 (push (cons "+Packages+..."
4523 (nreverse index-pack-alist))
4525 (and (or index-pack-alist index-pod-alist
4526 (default-value 'imenu-sort-function))
4527 index-unsorted-alist
4528 (push (cons "+Unsorted List+..."
4529 (nreverse index-unsorted-alist))
4531 (cperl-imenu-addback index-alist)))
4534 ;; Suggested by Mark A. Hershberger
4535 (defun cperl-outline-level ()
4536 (looking-at outline-regexp)
4537 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4538 ((match-beginning 2)
4539 (if (eq (char-after (match-beginning 2)) ?p)
4542 ((match-beginning 5)
4543 (if (eq (char-after (match-beginning 5)) ?1)
4546 (t 3))) ; should not happen
4549 (defvar cperl-compilation-error-regexp-alist
4550 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4551 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
4553 "Alist that specifies how to match errors in perl output.")
4555 (if (fboundp 'eval-after-load)
4558 '(setq perl-compilation-error-regexp-alist
4559 cperl-compilation-error-regexp-alist)))
4562 (defun cperl-windowed-init ()
4563 "Initialization under windowed version."
4564 (if (or (featurep 'ps-print) cperl-faces-init)
4565 ;; Need to init anyway:
4566 (or cperl-faces-init (cperl-init-faces))
4567 (add-hook 'font-lock-mode-hook
4570 (if (memq major-mode '(perl-mode cperl-mode))
4572 (or cperl-faces-init (cperl-init-faces)))))))
4573 (if (fboundp 'eval-after-load)
4576 '(or cperl-faces-init (cperl-init-faces))))))
4578 (defvar cperl-font-lock-keywords-1 nil
4579 "Additional expressions to highlight in Perl mode. Minimal set.")
4580 (defvar cperl-font-lock-keywords nil
4581 "Additional expressions to highlight in Perl mode. Default set.")
4582 (defvar cperl-font-lock-keywords-2 nil
4583 "Additional expressions to highlight in Perl mode. Maximal set")
4585 (defun cperl-load-font-lock-keywords ()
4586 (or cperl-faces-init (cperl-init-faces))
4587 cperl-font-lock-keywords)
4589 (defun cperl-load-font-lock-keywords-1 ()
4590 (or cperl-faces-init (cperl-init-faces))
4591 cperl-font-lock-keywords-1)
4593 (defun cperl-load-font-lock-keywords-2 ()
4594 (or cperl-faces-init (cperl-init-faces))
4595 cperl-font-lock-keywords-2)
4597 (defun cperl-init-faces-weak ()
4598 ;; Allow `cperl-find-pods-heres' to run.
4599 (or (boundp 'font-lock-constant-face)
4600 (cperl-force-face font-lock-constant-face
4601 "Face for constant and label names")
4602 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4605 (defun cperl-init-faces ()
4606 (condition-case errs
4608 (require 'font-lock)
4609 (and (fboundp 'font-lock-fontify-anchored-keywords)
4610 (featurep 'font-lock-extra)
4611 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
4612 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
4613 (if (fboundp 'font-lock-fontify-anchored-keywords)
4614 (setq font-lock-anchored t))
4616 t-font-lock-keywords
4618 `("[ \t]+$" 0 ',cperl-invalid-face t)
4621 "\\(^\\|[^$@%&\\]\\)\\<\\("
4624 '("if" "until" "while" "elsif" "else" "unless" "for"
4625 "foreach" "continue" "exit" "die" "last" "goto" "next"
4626 "redo" "return" "local" "exec" "sub" "do" "dump" "use"
4627 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
4628 "\\|") ; Flow control
4629 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
4630 ; In what follows we use `type' style
4631 ; for overwritable builtins
4634 "\\(^\\|[^$@%&\\]\\)\\<\\("
4635 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4636 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4637 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4638 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4639 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4640 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4641 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4642 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4643 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4644 ;; "gethostbyname" "gethostent" "getlogin"
4645 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4646 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4647 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4648 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4649 ;; "getservbyport" "getservent" "getsockname"
4650 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4651 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
4652 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
4653 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4654 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4655 ;; "quotemeta" "rand" "read" "readdir" "readline"
4656 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4657 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4658 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4659 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4660 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4661 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4662 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4663 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
4664 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
4665 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4666 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4667 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
4668 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
4669 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
4670 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
4671 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
4672 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
4673 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
4674 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
4675 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
4676 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
4677 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
4678 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
4679 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
4680 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
4681 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
4682 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
4683 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
4684 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
4685 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
4686 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
4687 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
4688 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
4689 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
4690 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
4691 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
4692 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
4693 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
4694 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
4695 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
4696 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
4697 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
4698 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
4699 "\\)\\>") 2 'font-lock-type-face)
4700 ;; In what follows we use `other' style
4701 ;; for nonoverwritable builtins
4702 ;; Somehow 's', 'm' are not auto-generated???
4705 "\\(^\\|[^$@%&\\]\\)\\<\\("
4706 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
4707 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4708 ;; "eval" "exists" "for" "foreach" "format" "goto"
4709 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4710 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4711 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4712 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4713 ;; "undef" "unless" "unshift" "untie" "until" "use"
4715 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
4716 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
4717 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
4718 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
4719 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
4720 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
4721 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
4722 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
4723 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
4724 "\\|[sm]" ; Added manually
4725 "\\)\\>") 2 'cperl-nonoverridable)
4726 ;; (mapconcat 'identity
4727 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4728 ;; "#include" "#define" "#undef")
4730 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
4731 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
4732 '("\\<sub[ \t]+\\([^ \t{;()]+\\)[ \t]*\\(([^()]*)[ \t]*\\)?[#{\n]" 1
4733 font-lock-function-name-face)
4734 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4735 2 font-lock-function-name-face)
4736 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
4737 1 font-lock-function-name-face)
4738 (cond ((featurep 'font-lock-extra)
4739 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4740 (2 font-lock-string-face t)
4741 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
4743 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4744 (2 font-lock-string-face t)
4745 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4747 (1 font-lock-string-face t))))
4748 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4749 2 font-lock-string-face t)))
4750 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
4751 font-lock-string-face t)
4752 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
4753 font-lock-constant-face) ; labels
4754 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
4755 2 font-lock-constant-face)
4756 ;; Uncomment to get perl-mode-like vars
4757 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
4758 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
4759 ;;; (2 (cons font-lock-variable-name-face '(underline))))
4760 (cond ((featurep 'font-lock-extra)
4761 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4762 (3 font-lock-variable-name-face)
4764 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4765 (1 font-lock-variable-name-face)
4766 (2 '(restart 2 nil) nil t)))
4767 nil t))) ; local variables, multiple
4769 '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4770 (3 font-lock-variable-name-face)
4771 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)"
4773 (1 font-lock-variable-name-face))))
4774 (t '("^[ \t{}]*\\(my\\|local\\our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4775 3 font-lock-variable-name-face)))
4776 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
4777 4 font-lock-variable-name-face)
4778 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
4779 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
4780 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
4782 t-font-lock-keywords-1
4783 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4784 (not cperl-xemacs-p) ; not yet as of XEmacs 19.12
4786 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
4787 (if (eq (char-after (match-beginning 2)) ?%)
4790 t) ; arrays and hashes
4791 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
4793 (if (= (- (match-end 2) (match-beginning 2)) 1)
4794 (if (eq (char-after (match-beginning 3)) ?{)
4796 'cperl-array) ; arrays and hashes
4797 font-lock-variable-name-face) ; Just to put something
4799 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4800 ;;; Too much noise from \s* @s[ and friends
4801 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
4802 ;;(3 font-lock-function-name-face t t)
4804 ;; (if (cperl-slash-is-regexp)
4805 ;; font-lock-function-name-face 'default) nil t))
4807 (if cperl-highlight-variables-indiscriminately
4808 (setq t-font-lock-keywords-1
4809 (append t-font-lock-keywords-1
4810 (list '("[$*]{?\\(\\sw+\\)" 1
4811 font-lock-variable-name-face)))))
4812 (setq cperl-font-lock-keywords-1
4813 (if cperl-syntaxify-by-font-lock
4814 (cons 'cperl-fontify-update
4815 t-font-lock-keywords)
4816 t-font-lock-keywords)
4817 cperl-font-lock-keywords cperl-font-lock-keywords-1
4818 cperl-font-lock-keywords-2 (append
4819 cperl-font-lock-keywords-1
4820 t-font-lock-keywords-1)))
4821 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
4822 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
4823 (eval ; Avoid a warning
4824 '(font-lock-require-faces
4826 ;; Color-light Color-dark Gray-light Gray-dark Mono
4827 (list 'font-lock-comment-face
4828 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
4833 (list 'font-lock-string-face
4834 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
4839 (list 'font-lock-function-name-face
4841 "Blue" "LightSkyBlue" "Gray50" "LightGray"
4842 (cdr (assq 'background-color ; if mono
4843 (frame-parameters))))
4846 (cdr (assq 'foreground-color ; if mono
4847 (frame-parameters))))
4851 (list 'font-lock-variable-name-face
4852 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
4857 (list 'font-lock-type-face
4858 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
4863 (list 'font-lock-constant-face
4864 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
4869 (list 'cperl-nonoverridable
4870 ["chartreuse3" ("orchid1" "orange")
4877 ["blue" "yellow" nil "Gray80"]
4878 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4884 ["red" "red" nil "Gray80"]
4885 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4890 ;; Do it the dull way, without choose-color
4891 (defvar cperl-guessed-background nil
4892 "Display characteristics as guessed by cperl.")
4893 ;; (or (fboundp 'x-color-defined-p)
4894 ;; (defalias 'x-color-defined-p
4895 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4896 ;; ;; XEmacs >= 19.12
4897 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4899 ;; (t 'x-valid-color-name-p))))
4900 (cperl-force-face font-lock-constant-face
4901 "Face for constant and label names")
4902 (cperl-force-face font-lock-variable-name-face
4903 "Face for variable names")
4904 (cperl-force-face font-lock-type-face
4905 "Face for data types")
4906 (cperl-force-face cperl-nonoverridable
4907 "Face for data types from another group")
4908 (cperl-force-face font-lock-comment-face
4909 "Face for comments")
4910 (cperl-force-face font-lock-function-name-face
4911 "Face for function names")
4912 (cperl-force-face cperl-hash
4914 (cperl-force-face cperl-array
4916 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4917 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4918 ;;(or (boundp 'font-lock-type-face)
4919 ;; (defconst font-lock-type-face
4920 ;; 'font-lock-type-face
4921 ;; "Face to use for data types."))
4922 ;;(or (boundp 'cperl-nonoverridable-face)
4923 ;; (defconst cperl-nonoverridable-face
4924 ;; 'cperl-nonoverridable
4925 ;; "Face to use for data types from another group."))
4926 ;;(if (not cperl-xemacs-p) nil
4927 ;; (or (boundp 'font-lock-comment-face)
4928 ;; (defconst font-lock-comment-face
4929 ;; 'font-lock-comment-face
4930 ;; "Face to use for comments."))
4931 ;; (or (boundp 'font-lock-keyword-face)
4932 ;; (defconst font-lock-keyword-face
4933 ;; 'font-lock-keyword-face
4934 ;; "Face to use for keywords."))
4935 ;; (or (boundp 'font-lock-function-name-face)
4936 ;; (defconst font-lock-function-name-face
4937 ;; 'font-lock-function-name-face
4938 ;; "Face to use for function names.")))
4940 (not (cperl-is-face 'cperl-array))
4941 (cperl-is-face 'font-lock-emphasized-face))
4942 (copy-face 'font-lock-emphasized-face 'cperl-array))
4944 (not (cperl-is-face 'cperl-hash))
4945 (cperl-is-face 'font-lock-other-emphasized-face))
4946 (copy-face 'font-lock-other-emphasized-face 'cperl-hash))
4948 (not (cperl-is-face 'cperl-nonoverridable))
4949 (cperl-is-face 'font-lock-other-type-face))
4950 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable))
4951 ;;(or (boundp 'cperl-hash-face)
4952 ;; (defconst cperl-hash-face
4954 ;; "Face to use for hashes."))
4955 ;;(or (boundp 'cperl-array-face)
4956 ;; (defconst cperl-array-face
4958 ;; "Face to use for arrays."))
4959 ;; Here we try to guess background
4961 (if (boundp 'font-lock-background-mode)
4962 font-lock-background-mode
4964 (face-list (and (fboundp 'face-list) (face-list))))
4965 ;;;; (fset 'cperl-is-face
4966 ;;;; (cond ((fboundp 'find-face)
4967 ;;;; (symbol-function 'find-face))
4969 ;;;; (function (lambda (face) (member face face-list))))
4971 ;;;; (function (lambda (face) (boundp face))))))
4972 (defvar cperl-guessed-background
4973 (if (and (boundp 'font-lock-display-type)
4974 (eq font-lock-display-type 'grayscale))
4977 "Background as guessed by CPerl mode")
4978 (and (not (cperl-is-face 'font-lock-constant-face))
4979 (cperl-is-face 'font-lock-reference-face)
4980 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
4981 (if (cperl-is-face 'font-lock-type-face) nil
4982 (copy-face 'default 'font-lock-type-face)
4984 ((eq background 'light)
4985 (set-face-foreground 'font-lock-type-face
4986 (if (x-color-defined-p "seagreen")
4989 ((eq background 'dark)
4990 (set-face-foreground 'font-lock-type-face
4991 (if (x-color-defined-p "os2pink")
4995 (set-face-background 'font-lock-type-face "gray90"))))
4996 (if (cperl-is-face 'cperl-nonoverridable)
4998 (copy-face 'font-lock-type-face 'cperl-nonoverridable)
5000 ((eq background 'light)
5001 (set-face-foreground 'cperl-nonoverridable
5002 (if (x-color-defined-p "chartreuse3")
5005 ((eq background 'dark)
5006 (set-face-foreground 'cperl-nonoverridable
5007 (if (x-color-defined-p "orchid1")
5010 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
5011 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
5013 ;;; ((eq background 'light)
5014 ;;; (set-face-background 'font-lock-other-emphasized-face
5015 ;;; (if (x-color-defined-p "lightyellow2")
5017 ;;; (if (x-color-defined-p "lightyellow")
5019 ;;; "light yellow"))))
5020 ;;; ((eq background 'dark)
5021 ;;; (set-face-background 'font-lock-other-emphasized-face
5022 ;;; (if (x-color-defined-p "navy")
5024 ;;; (if (x-color-defined-p "darkgreen")
5026 ;;; "dark green"))))
5027 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
5028 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
5029 ;;; (copy-face 'bold 'font-lock-emphasized-face)
5031 ;;; ((eq background 'light)
5032 ;;; (set-face-background 'font-lock-emphasized-face
5033 ;;; (if (x-color-defined-p "lightyellow2")
5035 ;;; "lightyellow")))
5036 ;;; ((eq background 'dark)
5037 ;;; (set-face-background 'font-lock-emphasized-face
5038 ;;; (if (x-color-defined-p "navy")
5040 ;;; (if (x-color-defined-p "darkgreen")
5042 ;;; "dark green"))))
5043 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
5044 (if (cperl-is-face 'font-lock-variable-name-face) nil
5045 (copy-face 'italic 'font-lock-variable-name-face))
5046 (if (cperl-is-face 'font-lock-constant-face) nil
5047 (copy-face 'italic 'font-lock-constant-face))))
5048 (setq cperl-faces-init t))
5049 (error (message "cperl-init-faces (ignored): %s" errs))))
5052 (defun cperl-ps-print-init ()
5053 "Initialization of `ps-print' components for faces used in CPerl."
5054 (eval-after-load "ps-print"
5055 '(setq ps-bold-faces
5056 ;; font-lock-variable-name-face
5057 ;; font-lock-constant-face
5058 (append '(cperl-array cperl-hash)
5061 ;; font-lock-constant-face
5062 (append '(cperl-nonoverridable cperl-hash)
5065 ;; font-lock-type-face
5066 (append '(cperl-array cperl-hash underline cperl-nonoverridable)
5067 ps-underlined-faces))))
5069 (defvar ps-print-face-extension-alist)
5071 (defun cperl-ps-print (&optional file)
5072 "Pretty-print in CPerl style.
5073 If optional argument FILE is an empty string, prints to printer, otherwise
5074 to the file FILE. If FILE is nil, prompts for a file name.
5076 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
5079 (setq file (read-from-minibuffer
5080 "Print to file (if empty - to printer): "
5081 (concat (buffer-file-name) ".ps")
5082 nil nil 'file-name-history)))
5083 (or (> (length file) 0)
5085 (require 'ps-print) ; To get ps-print-face-extension-alist
5086 (let ((ps-print-color-p t)
5087 (ps-print-face-extension-alist ps-print-face-extension-alist))
5088 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
5089 (ps-print-buffer-with-faces file)))
5091 ;;; (defun cperl-ps-print-init ()
5092 ;;; "Initialization of `ps-print' components for faces used in CPerl."
5093 ;;; ;; Guard against old versions
5094 ;;; (defvar ps-underlined-faces nil)
5095 ;;; (defvar ps-bold-faces nil)
5096 ;;; (defvar ps-italic-faces nil)
5097 ;;; (setq ps-bold-faces
5098 ;;; (append '(font-lock-emphasized-face
5100 ;;; font-lock-keyword-face
5101 ;;; font-lock-variable-name-face
5102 ;;; font-lock-constant-face
5103 ;;; font-lock-reference-face
5104 ;;; font-lock-other-emphasized-face
5107 ;;; (setq ps-italic-faces
5108 ;;; (append '(cperl-nonoverridable
5109 ;;; font-lock-constant-face
5110 ;;; font-lock-reference-face
5111 ;;; font-lock-other-emphasized-face
5113 ;;; ps-italic-faces))
5114 ;;; (setq ps-underlined-faces
5115 ;;; (append '(font-lock-emphasized-face
5117 ;;; font-lock-other-emphasized-face
5119 ;;; cperl-nonoverridable font-lock-type-face)
5120 ;;; ps-underlined-faces))
5121 ;;; (cons 'font-lock-type-face ps-underlined-faces))
5124 (if (cperl-enable-font-lock) (cperl-windowed-init))
5126 (defconst cperl-styles-entries
5127 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
5128 cperl-label-offset cperl-extra-newline-before-brace
5129 cperl-merge-trailing-else
5130 cperl-continued-statement-offset))
5132 (defconst cperl-style-alist
5133 '(("CPerl" ; =GNU without extra-newline-before-brace
5134 (cperl-indent-level . 2)
5135 (cperl-brace-offset . 0)
5136 (cperl-continued-brace-offset . 0)
5137 (cperl-label-offset . -2)
5138 (cperl-extra-newline-before-brace . nil)
5139 (cperl-merge-trailing-else . t)
5140 (cperl-continued-statement-offset . 2))
5141 ("PerlStyle" ; CPerl with 4 as indent
5142 (cperl-indent-level . 4)
5143 (cperl-brace-offset . 0)
5144 (cperl-continued-brace-offset . 0)
5145 (cperl-label-offset . -4)
5146 (cperl-extra-newline-before-brace . nil)
5147 (cperl-merge-trailing-else . t)
5148 (cperl-continued-statement-offset . 4))
5150 (cperl-indent-level . 2)
5151 (cperl-brace-offset . 0)
5152 (cperl-continued-brace-offset . 0)
5153 (cperl-label-offset . -2)
5154 (cperl-extra-newline-before-brace . t)
5155 (cperl-merge-trailing-else . nil)
5156 (cperl-continued-statement-offset . 2))
5158 (cperl-indent-level . 5)
5159 (cperl-brace-offset . 0)
5160 (cperl-continued-brace-offset . -5)
5161 (cperl-label-offset . -5)
5162 ;;(cperl-extra-newline-before-brace . nil) ; ???
5163 (cperl-merge-trailing-else . nil)
5164 (cperl-continued-statement-offset . 5))
5166 (cperl-indent-level . 4)
5167 (cperl-brace-offset . 0)
5168 (cperl-continued-brace-offset . -4)
5169 (cperl-label-offset . -4)
5170 ;;(cperl-extra-newline-before-brace . nil) ; ???
5171 (cperl-continued-statement-offset . 4))
5173 (cperl-indent-level . 4)
5174 (cperl-brace-offset . 0)
5175 (cperl-continued-brace-offset . -4)
5176 (cperl-label-offset . -4)
5177 (cperl-continued-statement-offset . 4)
5178 (cperl-merge-trailing-else . nil)
5179 (cperl-extra-newline-before-brace . t))
5182 (cperl-indent-level . 4)
5183 (cperl-brace-offset . 0)
5184 (cperl-continued-brace-offset . 0)
5185 (cperl-label-offset . -4)
5186 ;;(cperl-extra-newline-before-brace . nil) ; ???
5187 (cperl-continued-statement-offset . 4)))
5188 "(Experimental) list of variables to set to get a particular indentation style.
5189 Should be used via `cperl-set-style' or via Perl menu.")
5191 (defun cperl-set-style (style)
5192 "Set CPerl mode variables to use one of several different indentation styles.
5193 The arguments are a string representing the desired style.
5194 The list of styles is in `cperl-style-alist', available styles
5195 are GNU, K&R, BSD, C++ and Whitesmith.
5197 The current value of style is memorized (unless there is a memorized
5198 data already), may be restored by `cperl-set-style-back'.
5200 Chosing \"Current\" style will not change style, so this may be used for
5201 side-effect of memorizing only."
5203 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
5204 cperl-style-alist)))
5205 (list (completing-read "Enter style: " list nil 'insist))))
5207 (setq cperl-old-style
5210 (cons name (eval name))))
5211 cperl-styles-entries)))
5212 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
5214 (setq setting (car style) style (cdr style))
5215 (set (car setting) (cdr setting)))))
5217 (defun cperl-set-style-back ()
5218 "Restore a style memorized by `cperl-set-style'."
5220 (or cperl-old-style (error "The style was not changed"))
5222 (while cperl-old-style
5223 (setq setting (car cperl-old-style)
5224 cperl-old-style (cdr cperl-old-style))
5225 (set (car setting) (cdr setting)))))
5227 (defun cperl-check-syntax ()
5229 (require 'mode-compile)
5230 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
5231 (eval '(mode-compile)))) ; Avoid a warning
5233 (defun cperl-info-buffer (type)
5234 ;; Returns buffer with documentation. Creates if missing.
5235 ;; If TYPE, this vars buffer.
5236 ;; Special care is taken to not stomp over an existing info buffer
5237 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
5238 (info (get-buffer bname))
5239 (oldbuf (get-buffer "*info*")))
5241 (save-window-excursion
5246 (rename-buffer "*info-perl-tmp*")))
5247 (save-window-excursion
5249 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
5250 (set-buffer "*info*")
5251 (rename-buffer bname)
5253 (set-buffer "*info-perl-tmp*")
5254 (rename-buffer "*info*")
5255 (set-buffer bname)))
5256 (make-local-variable 'window-min-height)
5257 (setq window-min-height 2)
5258 (current-buffer)))))
5260 (defun cperl-word-at-point (&optional p)
5261 "Return the word at point or at P."
5263 (if p (goto-char p))
5264 (or (cperl-word-at-point-hard)
5267 (funcall (or (and (boundp 'find-tag-default-function)
5268 find-tag-default-function)
5269 (get major-mode 'find-tag-default-function)
5270 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
5271 ;; automatically used within `find-tag-default':
5272 'find-tag-default))))))
5274 (defun cperl-info-on-command (command)
5275 "Show documentation for Perl command COMMAND in other window.
5276 If perl-info buffer is shown in some frame, uses this frame.
5277 Customized by setting variables `cperl-shrink-wrap-info-frame',
5278 `cperl-max-help-size'."
5280 (let* ((default (cperl-word-at-point))
5282 (format "Find doc for Perl function (default %s): "
5284 (list (if (equal read "")
5288 (let ((buffer (current-buffer))
5289 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
5290 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
5291 max-height char-height buf-list)
5292 (if (string-match "^-[a-zA-Z]$" command)
5293 (setq cmd-desc "^-X[ \t\n]"))
5294 (setq isvar (string-match "^[$@%]" command)
5295 buf (cperl-info-buffer isvar)
5296 iniwin (selected-window)
5297 fr1 (window-frame iniwin))
5299 (goto-char (point-min))
5301 (progn (re-search-forward "^-X[ \t\n]")
5303 (if (re-search-forward cmd-desc nil t)
5305 ;; Go back to beginning of the group (ex, for qq)
5306 (if (re-search-backward "^[ \t\n\f]")
5311 buf-list (list buf "*info-perl-var*" "*info-perl*"))
5312 (while (and (not win) buf-list)
5313 (setq win (get-buffer-window (car buf-list) t))
5314 (setq buf-list (cdr buf-list)))
5316 (eq (window-buffer win) buf)
5317 (set-window-buffer win buf))
5318 (and win (setq fr2 (window-frame win)))
5319 (if (or (not fr2) (eq fr1 fr2))
5321 (special-display-popup-frame buf) ; Make it visible
5322 (select-window win))
5323 (goto-char pos) ; Needed (?!).
5325 (setq iniheight (window-height)
5326 frheight (frame-height)
5327 not-loner (< iniheight (1- frheight))) ; Are not alone
5328 (cond ((if not-loner cperl-max-help-size
5329 cperl-shrink-wrap-info-frame)
5335 (if (re-search-forward
5336 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
5337 (match-beginning 0) (point-max)))))
5340 (/ (* (- frheight 3) cperl-max-help-size) 100)
5341 (setq char-height (frame-char-height))
5342 ;; Non-functioning under OS/2:
5343 (if (eq char-height 1) (setq char-height 18))
5344 ;; Title, menubar, + 2 for slack
5345 (- (/ (x-display-pixel-height) char-height) 4)))
5346 (if (> height max-height) (setq height max-height))
5347 ;;(message "was %s doing %s" iniheight height)
5349 (enlarge-window (- height iniheight))
5350 (set-frame-height (window-frame win) (1+ height)))))
5351 (set-window-start (selected-window) pos))
5352 (message "No entry for %s found." command))
5353 ;;(pop-to-buffer buffer)
5354 (select-window iniwin)))
5356 (defun cperl-info-on-current-command ()
5357 "Show documentation for Perl command at point in other window."
5359 (cperl-info-on-command (cperl-word-at-point)))
5361 (defun cperl-imenu-info-imenu-search ()
5362 (if (looking-at "^-X[ \t\n]") nil
5364 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
5367 (defun cperl-imenu-info-imenu-name ()
5369 (match-beginning 1) (match-end 1)))
5371 (defun cperl-imenu-on-info ()
5373 (let* ((buffer (current-buffer))
5374 imenu-create-index-function
5375 imenu-prev-index-position-function
5376 imenu-extract-index-name-function
5377 (index-item (save-restriction
5378 (save-window-excursion
5379 (set-buffer (cperl-info-buffer nil))
5380 (setq imenu-create-index-function
5381 'imenu-default-create-index-function
5382 imenu-prev-index-position-function
5383 'cperl-imenu-info-imenu-search
5384 imenu-extract-index-name-function
5385 'cperl-imenu-info-imenu-name)
5386 (imenu-choose-buffer-index)))))
5390 (pop-to-buffer "*info-perl*")
5392 ((markerp (cdr index-item))
5393 (goto-char (marker-position (cdr index-item))))
5395 (goto-char (cdr index-item))))
5396 (set-window-start (selected-window) (point))
5397 (pop-to-buffer buffer)))))
5399 (defun cperl-lineup (beg end &optional step minshift)
5400 "Lineup construction in a region.
5401 Beginning of region should be at the start of a construction.
5402 All first occurrences of this construction in the lines that are
5403 partially contained in the region are lined up at the same column.
5405 MINSHIFT is the minimal amount of space to insert before the construction.
5406 STEP is the tabwidth to position constructions.
5407 If STEP is nil, `cperl-lineup-step' will be used
5408 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
5409 Will not move the position at the start to the left."
5411 (let (search col tcol seen b e)
5415 (setq end (point-marker))
5417 (skip-chars-forward " \t\f")
5418 (setq beg (point-marker))
5419 (indent-region beg end nil)
5421 (setq col (current-column))
5422 (if (looking-at "[a-zA-Z0-9_]")
5423 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
5427 (buffer-substring (match-beginning 0)
5428 (match-end 0))) "\\>"))
5429 (error "Cannot line up in a middle of the word"))
5430 (if (looking-at "$")
5431 (error "Cannot line up end of line"))
5432 (setq search (regexp-quote (char-to-string (following-char)))))
5433 (setq step (or step cperl-lineup-step cperl-indent-level))
5434 (or minshift (setq minshift 1))
5436 (beginning-of-line 2)
5437 (and (< (point) end)
5438 (re-search-forward search end t)
5439 (goto-char (match-beginning 0))))
5440 (setq tcol (current-column) seen t)
5441 (if (> tcol col) (setq col tcol)))
5443 (error "The construction to line up occurred only once"))
5445 (setq col (+ col minshift))
5446 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5450 (skip-chars-backward " \t")
5451 (delete-region (point) e)
5452 (indent-to-column col) ;(make-string (- col (current-column)) ?\ ))
5453 (beginning-of-line 2)
5454 (and (< (point) end)
5455 (re-search-forward search end t)
5456 (goto-char (match-beginning 0)))))))) ; No body
5458 (defun cperl-etags (&optional add all files)
5459 "Run etags with appropriate options for Perl files.
5460 If optional argument ALL is `recursive', will process Perl files
5461 in subdirectories too."
5464 (args '("-l" "none" "-r" "/\\<\\(package\\|sub\\)[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([{#]\\|$\\)\\)/\\4/"))
5466 (if add (setq args (cons "-a" args)))
5467 (or files (setq files (list buffer-file-name)))
5469 ((eq all 'recursive)
5470 ;;(error "Not implemented: recursive")
5471 (setq args (append (list "-e"
5472 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
5474 find(\\&wanted, '.');
5479 ;;(error "Not implemented: all")
5480 (setq args (append (list "-e"
5481 "push @ARGV, <*.PL *.pl *.pm>;
5486 (setq args (append args files))))
5487 (setq res (apply 'call-process cmd nil nil nil args))
5489 (message "etags returned \"%s\"" res))))
5491 (defun cperl-toggle-auto-newline ()
5492 "Toggle the state of `cperl-auto-newline'."
5494 (setq cperl-auto-newline (not cperl-auto-newline))
5495 (message "Newlines will %sbe auto-inserted now."
5496 (if cperl-auto-newline "" "not ")))
5498 (defun cperl-toggle-abbrev ()
5499 "Toggle the state of automatic keyword expansion in CPerl mode."
5501 (abbrev-mode (if abbrev-mode 0 1))
5502 (message "Perl control structure will %sbe auto-inserted now."
5503 (if abbrev-mode "" "not ")))
5506 (defun cperl-toggle-electric ()
5507 "Toggle the state of parentheses doubling in CPerl mode."
5509 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5510 (message "Parentheses will %sbe auto-doubled now."
5511 (if (cperl-val 'cperl-electric-parens) "" "not ")))
5513 (defun cperl-toggle-autohelp ()
5514 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
5515 Delay of auto-help controlled by `cperl-lazy-help-time'."
5517 (if (fboundp 'run-with-idle-timer)
5519 (if cperl-lazy-installed
5520 (cperl-lazy-unstall)
5521 (cperl-lazy-install))
5522 (message "Perl help messages will %sbe automatically shown now."
5523 (if cperl-lazy-installed "" "not ")))
5524 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
5526 (defun cperl-toggle-construct-fix ()
5527 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
5529 (setq cperl-indent-region-fix-constructs
5530 (if cperl-indent-region-fix-constructs
5533 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
5534 (if cperl-indent-region-fix-constructs "" "not ")))
5536 ;;;; Tags file creation.
5538 (defvar cperl-tmp-buffer " *cperl-tmp*")
5540 (defun cperl-setup-tmp-buf ()
5541 (set-buffer (get-buffer-create cperl-tmp-buffer))
5542 (set-syntax-table cperl-mode-syntax-table)
5543 (buffer-disable-undo)
5545 (if cperl-use-syntax-table-text-property-for-tags
5547 (make-local-variable 'parse-sexp-lookup-properties)
5548 ;; Do not introduce variable if not needed, we check it!
5549 (set 'parse-sexp-lookup-properties t))))
5551 (defun cperl-xsub-scan ()
5553 (let ((index-alist '())
5554 (prev-pos 0) index index1 name package prefix)
5555 (goto-char (point-min))
5556 ;; Search for the function
5557 (progn ;;save-match-data
5558 (while (re-search-forward
5559 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5562 ((match-beginning 2) ; SECTION
5563 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
5564 (goto-char (match-beginning 0))
5565 (skip-chars-forward " \t")
5567 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
5568 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
5570 ((not package) nil) ; C language section
5571 ((match-beginning 3) ; XSUB
5572 (goto-char (1+ (match-beginning 3)))
5573 (setq index (imenu-example--name-and-position))
5574 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
5575 (if (and prefix (string-match (concat "^" prefix) name))
5576 (setq name (substring name (length prefix))))
5577 (cond ((string-match "::" name) nil)
5579 (setq index1 (cons (concat package "::" name) (cdr index)))
5580 (push index1 index-alist)))
5582 (push index index-alist))
5584 ;; (beginning-of-line)
5585 (setq index (imenu-example--name-and-position))
5586 (setcar index (concat package "::BOOT:"))
5587 (push index index-alist)))))
5590 (defvar cperl-unreadable-ok nil)
5592 (defun cperl-find-tags (ifile xs topdir)
5593 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
5594 (cperl-pod-here-fontify nil) f file)
5596 (if b (set-buffer b)
5597 (cperl-setup-tmp-buf))
5600 (setq file (car (insert-file-contents ifile)))
5601 (error (if cperl-unreadable-ok nil
5603 (format "File %s unreadable. Continue? " ifile))
5604 (setq cperl-unreadable-ok t)
5605 (error "Aborting: unreadable file %s" ifile)))))
5607 (message "Unreadable file %s" ifile)
5608 (message "Scanning file %s ..." file)
5609 (if (and cperl-use-syntax-table-text-property-for-tags
5611 (condition-case err ; after __END__ may have garbage
5612 (cperl-find-pods-heres nil nil noninteractive)
5613 (error (message "While scanning for syntax: %s" err))))
5615 (setq lst (cperl-xsub-scan))
5616 (setq ind (cperl-imenu--create-perl-index))
5617 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
5622 (cond ((string-match "^[_a-zA-Z]" (car elt))
5623 (goto-char (cdr elt))
5624 (beginning-of-line) ; pos should be of the start of the line
5627 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
5628 (buffer-substring (progn
5629 (goto-char (cdr elt))
5630 ;; After name now...
5631 (or (eolp) (forward-char 1))
5639 (setq elt (car lst) lst (cdr lst))
5644 (if (string-match "^package " (car elt))
5645 (substring (car elt) 8)
5648 (number-to-string (elt elt 2)) ; Line
5650 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
5652 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
5653 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
5655 ;; Need to insert the name without package as well
5656 (setq lst (cons (cons (substring (elt elt 3)
5664 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5665 (set-text-properties 0 (length rel) nil rel)
5666 (and (equal topdir (substring rel 0 (length topdir)))
5667 (setq rel (substring file (length topdir))))
5668 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
5669 (setq ret (buffer-substring 1 (point-max)))
5672 (message "Scanning file %s finished" file))
5675 (defun cperl-add-tags-recurse-noxs ()
5676 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5678 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5679 -f cperl-add-tags-recurse
5681 (cperl-write-tags nil nil t t nil t))
5683 (defun cperl-add-tags-recurse ()
5684 "Add to TAGS file data for Perl files in the current directory and kids.
5686 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5687 -f cperl-add-tags-recurse
5689 (cperl-write-tags nil nil t t))
5691 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
5692 ;; If INBUFFER, do not select buffer, and do not save
5693 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5696 (setq file (if dir default-directory (buffer-file-name)))
5697 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
5699 (setq topdir default-directory))
5700 (let ((tags-file-name "TAGS")
5701 (case-fold-search (eq system-type 'emx))
5704 (cond (inbuffer nil) ; Already there
5705 ((file-exists-p tags-file-name)
5707 (visit-tags-table-buffer)
5708 (visit-tags-table-buffer tags-file-name)))
5709 (t (set-buffer (find-file-noselect tags-file-name))))
5712 (cond ((eq erase 'ignore))
5715 (setq erase 'ignore)))
5718 (directory-files file t
5719 (if recurse nil cperl-scan-files-regexp)
5722 (if cperl-unreadable-ok nil
5724 (format "Directory %s unreadable. Continue? " file))
5725 (setq cperl-unreadable-ok t
5726 tm nil) ; Return empty list
5727 (error "Aborting: unreadable directory %s" file)))))))
5731 ((string-match cperl-noscan-files-regexp file)
5733 ((not (file-directory-p file))
5734 (if (string-match cperl-scan-files-regexp file)
5735 (cperl-write-tags file erase recurse nil t noxs topdir)))
5737 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
5740 (setq xs (string-match "\\.xs$" file))
5741 (if (not (and xs noxs))
5743 (cond ((eq erase 'ignore) (goto-char (point-max)))
5744 (erase (erase-buffer))
5748 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5749 (set-text-properties 0 (length rel) nil rel)
5750 (and (equal topdir (substring rel 0 (length topdir)))
5751 (setq rel (substring file (length topdir))))
5752 (if (search-forward (concat "\f\n" rel ",") nil t)
5754 (search-backward "\f\n")
5755 (delete-region (point)
5758 (if (search-forward "\f\n"
5762 (goto-char (point-max)))))
5763 (insert (cperl-find-tags file xs topdir))))))
5764 (if inbuffer nil ; Delegate to the caller
5765 (save-buffer 0) ; No backup
5766 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
5767 (initialize-new-tags-table))))))
5769 (defvar cperl-tags-hier-regexp-list
5776 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
5778 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
5781 (defvar cperl-hierarchy '(() ())
5782 "Global hierarchy of classes.")
5784 (defun cperl-tags-hier-fill ()
5785 ;; Suppose we are in a tag table cooked by cperl.
5787 (let (type pack name pos line chunk ord cons1 file str info fileind)
5788 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5789 (setq pos (match-beginning 0)
5790 pack (match-beginning 2))
5792 (if (looking-at (concat
5801 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
5802 name (buffer-substring (match-beginning 2) (match-end 2))
5803 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5804 line (buffer-substring (match-beginning 3) (match-end 3))
5807 fileind (format "%s:%s" file line)
5808 ;; Moves to beginning of the next line:
5809 info (cperl-etags-snarf-tag file line))
5812 ;; Make new member of hierarchy name ==> file ==> pos if needed
5813 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
5815 (setcdr cons1 (cons (cons fileind (vector file info))
5817 ;; First occurrence of the name, start alist
5818 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5820 (setcar (cdr cperl-hierarchy)
5821 (cons cons1 (nth 1 cperl-hierarchy)))
5822 (setcar cperl-hierarchy
5823 (cons cons1 (car cperl-hierarchy)))))))
5826 (defun cperl-tags-hier-init (&optional update)
5827 "Show hierarchical menu of classes and methods.
5828 Finds info about classes by a scan of loaded TAGS files.
5829 Supposes that the TAGS files contain fully qualified function names.
5830 One may build such TAGS files from CPerl mode menu."
5834 (if (or update (null (nth 2 cperl-hierarchy)))
5835 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
5838 (setcdr elt (cdr (nth 1 elt)))))))
5839 pack name cons1 to l1 l2 l3 l4 b)
5840 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5841 (setq cperl-hierarchy (list l1 l2 l3))
5842 (if cperl-xemacs-p ; Not checked
5845 ;; Does this work in XEmacs?
5846 (call-interactively 'visit-tags-table))
5847 (message "Updating list of classes...")
5848 (set-buffer (get-file-buffer tags-file-name))
5849 (cperl-tags-hier-fill))
5851 (call-interactively 'visit-tags-table))
5855 (message "Updating list of classes... %s" tagsfile)
5856 (set-buffer (get-file-buffer tagsfile))
5857 (cperl-tags-hier-fill)))
5859 (message "Updating list of classes... postprocessing..."))
5860 (mapcar remover (car cperl-hierarchy))
5861 (mapcar remover (nth 1 cperl-hierarchy))
5862 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
5863 (cons "Methods: " (car cperl-hierarchy))))
5864 (cperl-tags-treeify to 1)
5865 (setcar (nthcdr 2 cperl-hierarchy)
5866 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
5867 (message "Updating list of classes: done, requesting display...")
5868 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5870 (or (nth 2 cperl-hierarchy)
5871 (error "No items found"))
5873 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
5874 (if (if (fboundp 'display-popup-menus-p)
5875 (let ((f 'display-popup-menus-p))
5878 (x-popup-menu t (nth 2 cperl-hierarchy))
5880 (tmm-prompt (nth 2 cperl-hierarchy))))
5881 (if (and update (listp update))
5882 (progn (while (cdr update) (setq update (cdr update)))
5883 (setq update (car update)))) ; Get the last from the list
5884 (if (vectorp update)
5886 (find-file (elt update 0))
5887 (cperl-etags-goto-tag-location (elt update 1))))
5888 (if (eq update -999) (cperl-tags-hier-init t)))
5890 (defun cperl-tags-treeify (to level)
5891 ;; cadr of `to' is read-write. On start it is a cons
5892 (let* ((regexp (concat "^\\(" (mapconcat
5894 (make-list level "[_a-zA-Z0-9]+")
5897 (packages (cdr (nth 1 to)))
5898 (methods (cdr (nth 2 to)))
5899 l1 head tail cons1 cons2 ord writeto packs recurse
5900 root-packages root-functions ms many_ms same_name ps
5904 (cond ((and (string-match regexp (car elt))
5905 (or (eq ord 1) (match-end 2)))
5906 (setq head (substring (car elt) 0 (match-end 1))
5907 tail (if (match-end 2) (substring (car elt)
5910 (if (setq cons1 (assoc head writeto)) nil
5911 ;; Need to init new head
5912 (setcdr writeto (cons (list head (list "Packages: ")
5915 (setq cons1 (nth 1 writeto)))
5916 (setq cons2 (nth ord cons1)) ; Either packs or meths
5917 (setcdr cons2 (cons elt (cdr cons2))))
5919 (setq root-functions (cons elt root-functions)))
5921 (setq root-packages (cons elt root-packages))))))))
5922 (setcdr to l1) ; Init to dynamic space
5925 (mapcar move-deeper packages)
5927 (mapcar move-deeper methods)
5929 (mapcar (function (lambda (elt)
5930 (cperl-tags-treeify elt (1+ level))))
5932 ;;Now clean up leaders with one child only
5933 (mapcar (function (lambda (elt)
5934 (if (not (and (listp (cdr elt))
5935 (eq (length elt) 2))) nil
5936 (setcar elt (car (nth 1 elt)))
5937 (setcdr elt (cdr (nth 1 elt))))))
5939 ;; Sort the roots of subtrees
5940 (if (default-value 'imenu-sort-function)
5942 (sort (cdr to) (default-value 'imenu-sort-function))))
5943 ;; Now add back functions removed from display
5944 (mapcar (function (lambda (elt)
5945 (setcdr to (cons elt (cdr to)))))
5946 (if (default-value 'imenu-sort-function)
5948 (sort root-functions (default-value 'imenu-sort-function)))
5950 ;; Now add back packages removed from display
5951 (mapcar (function (lambda (elt)
5952 (setcdr to (cons (cons (concat "package " (car elt))
5955 (if (default-value 'imenu-sort-function)
5957 (sort root-packages (default-value 'imenu-sort-function)))
5961 ;;; '(keymap "Name1"
5965 ;;; ("Tail1" "x") ("Tail2" "y"))))
5967 (defun cperl-list-fold (list name limit)
5968 (let (list1 list2 elt1 (num 0))
5969 (if (<= (length list) limit) list
5970 (setq list1 nil list2 nil)
5975 (if (<= num imenu-max-items)
5976 (setq list2 (cons elt1 list2))
5977 (setq list1 (cons (cons name
5982 (nreverse (cons (cons name
5986 (defun cperl-menu-to-keymap (menu &optional name)
5992 (cond ((listp (cdr elt))
5993 (setq list (cperl-list-fold
5994 (cdr elt) (car elt) imenu-max-items))
5997 (cperl-menu-to-keymap list))))
5999 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
6000 (cperl-list-fold menu "Root" imenu-max-items)))))
6003 (defvar cperl-bad-style-regexp
6004 (mapconcat 'identity
6005 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
6006 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
6008 "Finds places such that insertion of a whitespace may help a lot.")
6010 (defvar cperl-not-bad-style-regexp
6013 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
6014 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
6015 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
6016 "<\\$?\\sw+\\(\\.\\sw+\\)?>" ; <IN> <stdin.h>
6017 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
6024 "\\\\[&$@*\\\\]" ; \&func
6027 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
6030 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
6031 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
6032 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
6036 "If matches at the start of match found by `my-bad-c-style-regexp',
6037 insertion of a whitespace will not help.")
6041 (defun cperl-find-bad-style ()
6042 "Find places in the buffer where insertion of a whitespace may help.
6043 Prompts user for insertion of spaces.
6044 Currently it is tuned to C and Perl syntax."
6046 (let (found-bad (p (point)))
6047 (setq last-nonmenu-event 13) ; To disable popup
6048 (with-no-warnings ; It is useful to push the mark here.
6049 (beginning-of-buffer))
6050 (map-y-or-n-p "Insert space here? "
6051 (lambda (arg) (insert " "))
6052 'cperl-next-bad-style
6053 '("location" "locations" "insert a space into")
6054 '((?\C-r (lambda (arg)
6055 (let ((buffer-quit-function
6056 'exit-recursive-edit))
6057 (message "Exit with Esc Esc")
6059 t)) ; Consider acted upon
6060 "edit, exit with Esc Esc")
6062 (let ((buffer-quit-function
6063 'exit-recursive-edit))
6064 (message "Exit with Esc Esc")
6066 t)) ; Consider acted upon
6067 "edit, exit with Esc Esc"))
6069 (if found-bad (goto-char found-bad)
6071 (message "No appropriate place found"))))
6073 (defun cperl-next-bad-style ()
6074 (let (p (not-found t) (point (point)) found)
6075 (while (and not-found
6076 (re-search-forward cperl-bad-style-regexp nil 'to-end))
6078 (goto-char (match-beginning 0))
6080 (looking-at cperl-not-bad-style-regexp)
6081 ;; Check for a < -b and friends
6082 (and (eq (following-char) ?\-)
6084 (skip-chars-backward " \t\n")
6085 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
6086 ;; Now check for syntax type
6088 (setq found (point))
6089 (beginning-of-defun)
6090 (let ((pps (parse-partial-sexp (point) found)))
6091 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
6092 (goto-char (match-end 0))
6100 (defvar cperl-have-help-regexp
6104 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
6105 "[$@]\\^[a-zA-Z]" ; Special variable
6106 "[$@][^ \n\t]" ; Special variable
6107 "-[a-zA-Z]" ; File test
6108 "\\\\[a-zA-Z0]" ; Special chars
6109 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
6110 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
6111 "[a-zA-Z_0-9:]+" ; symbol or number
6118 "Matches places in the buffer we can find help for.")
6120 (defvar cperl-message-on-help-error t)
6121 (defvar cperl-help-from-timer nil)
6123 (defun cperl-word-at-point-hard ()
6124 ;; Does not save-excursion
6125 ;; Get to the something meaningful
6126 (or (eobp) (eolp) (forward-char 1))
6127 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
6128 (save-excursion (beginning-of-line) (point))
6131 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
6132 ;; (skip-chars-backward " \n\t\r({[]});,")
6133 ;; (or (bobp) (backward-char 1))))
6136 ((looking-at "[a-zA-Z0-9_:]") ; symbol
6137 (skip-chars-backward "a-zA-Z0-9_:")
6139 ((and (eq (preceding-char) ?^) ; $^I
6140 (eq (char-after (- (point) 2)) ?\$))
6142 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
6144 ((and (eq (preceding-char) ?\=)
6145 (eq (current-column) 1))
6146 (forward-char -1))) ; =head1
6147 (if (and (eq (preceding-char) ?\<)
6148 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
6150 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
6152 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
6154 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
6155 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
6157 ((and (eq (preceding-char) ?\$)
6158 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
6160 ((and (eq (following-char) ?\>)
6161 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
6164 (and (eq (preceding-char) ?\<)
6165 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
6166 (search-backward "<"))))
6167 ((and (eq (following-char) ?\$)
6168 (eq (preceding-char) ?\<)
6169 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
6171 (if (looking-at cperl-have-help-regexp)
6172 (buffer-substring (match-beginning 0) (match-end 0))))
6174 (defun cperl-get-help ()
6175 "Get one-line docs on the symbol at the point.
6176 The data for these docs is a little bit obsolete and may be in fact longer
6177 than a line. Your contribution to update/shorten it is appreciated."
6179 (save-match-data ; May be called "inside" query-replace
6181 (let ((word (cperl-word-at-point-hard)))
6183 (if (and cperl-help-from-timer ; Bail out if not in mainland
6184 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
6185 (or (memq (get-text-property (point) 'face)
6186 '(font-lock-comment-face font-lock-string-face))
6187 (memq (get-text-property (point) 'syntax-type)
6188 '(pod here-doc format))))
6190 (cperl-describe-perl-symbol word))
6191 (if cperl-message-on-help-error
6192 (message "Nothing found for %s..."
6193 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
6195 ;;; Stolen from perl-descr.el by Johan Vromans:
6197 (defvar cperl-doc-buffer " *perl-doc*"
6198 "Where the documentation can be found.")
6200 (defun cperl-describe-perl-symbol (val)
6201 "Display the documentation of symbol at point, a Perl operator."
6202 (let ((enable-recursive-minibuffers t)
6205 ((string-match "^[&*][a-zA-Z_]" val)
6206 (setq val (concat (substring val 0 1) "NAME")))
6207 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
6208 (setq val (concat "@" (substring val 1 (match-end 1)))))
6209 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
6210 (setq val (concat "%" (substring val 1 (match-end 1)))))
6211 ((and (string= val "x") (string-match "^x=" val))
6213 ((string-match "^\\$[\C-a-\C-z]" val)
6214 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
6215 ((string-match "^CORE::" val)
6216 (setq val "CORE::"))
6217 ((string-match "^SUPER::" val)
6218 (setq val "SUPER::"))
6219 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
6220 (setq val "<NAME>")))
6221 (setq regexp (concat "^"
6222 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
6224 "\\([ \t([/]\\|$\\)"))
6226 ;; get the buffer with the documentation text
6227 (cperl-switch-to-doc-buffer)
6229 ;; lookup in the doc
6230 (goto-char (point-min))
6231 (let ((case-fold-search nil))
6233 (if (re-search-forward regexp (point-max) t)
6235 (beginning-of-line 1)
6236 (let ((lnstart (point)))
6238 (message "%s" (buffer-substring lnstart (point)))))
6239 (if cperl-message-on-help-error
6240 (message "No definition for %s" val)))))))
6242 (defvar cperl-short-docs 'please-ignore-this-line
6243 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
6244 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
6245 ... Range (list context); flip/flop [no flop when flip] (scalar context).
6246 ! ... Logical negation.
6247 ... != ... Numeric inequality.
6248 ... !~ ... Search pattern, substitution, or translation (negated).
6249 $! In numeric context: errno. In a string context: error string.
6250 $\" The separator which joins elements of arrays interpolated in strings.
6251 $# The output format for printed numbers. Default is %.15g or close.
6252 $$ Process number of this script. Changes in the fork()ed child process.
6253 $% The current page number of the currently selected output channel.
6255 The following variables are always local to the current block:
6257 $1 Match of the 1st set of parentheses in the last match (auto-local).
6258 $2 Match of the 2nd set of parentheses in the last match (auto-local).
6259 $3 Match of the 3rd set of parentheses in the last match (auto-local).
6260 $4 Match of the 4th set of parentheses in the last match (auto-local).
6261 $5 Match of the 5th set of parentheses in the last match (auto-local).
6262 $6 Match of the 6th set of parentheses in the last match (auto-local).
6263 $7 Match of the 7th set of parentheses in the last match (auto-local).
6264 $8 Match of the 8th set of parentheses in the last match (auto-local).
6265 $9 Match of the 9th set of parentheses in the last match (auto-local).
6266 $& The string matched by the last pattern match (auto-local).
6267 $' The string after what was matched by the last match (auto-local).
6268 $` The string before what was matched by the last match (auto-local).
6270 $( The real gid of this process.
6271 $) The effective gid of this process.
6272 $* Deprecated: Set to 1 to do multiline matching within a string.
6273 $+ The last bracket matched by the last search pattern.
6274 $, The output field separator for the print operator.
6275 $- The number of lines left on the page.
6276 $. The current input line number of the last filehandle that was read.
6277 $/ The input record separator, newline by default.
6278 $0 Name of the file containing the current perl script (read/write).
6279 $: String may be broken after these characters to fill ^-lines in a format.
6280 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
6281 $< The real uid of this process.
6282 $= The page length of the current output channel. Default is 60 lines.
6283 $> The effective uid of this process.
6284 $? The status returned by the last ``, pipe close or `system'.
6285 $@ The perl error message from the last eval or do @var{EXPR} command.
6286 $ARGV The name of the current file used with <> .
6287 $[ Deprecated: The index of the first element/char in an array/string.
6288 $\\ The output record separator for the print operator.
6289 $] The perl version string as displayed with perl -v.
6290 $^ The name of the current top-of-page format.
6291 $^A The current value of the write() accumulator for format() lines.
6292 $^D The value of the perl debug (-D) flags.
6293 $^E Information about the last system error other than that provided by $!.
6294 $^F The highest system file descriptor, ordinarily 2.
6295 $^H The current set of syntax checks enabled by `use strict'.
6296 $^I The value of the in-place edit extension (perl -i option).
6297 $^L What formats output to perform a formfeed. Default is \f.
6298 $^M A buffer for emergency memory allocation when running out of memory.
6299 $^O The operating system name under which this copy of Perl was built.
6300 $^P Internal debugging flag.
6301 $^T The time the script was started. Used by -A/-M/-C file tests.
6302 $^W True if warnings are requested (perl -w flag).
6303 $^X The name under which perl was invoked (argv[0] in C-speech).
6304 $_ The default input and pattern-searching space.
6305 $| Auto-flush after write/print on current output channel? Default 0.
6306 $~ The name of the current report format.
6307 ... % ... Modulo division.
6308 ... %= ... Modulo division assignment.
6309 %ENV Contains the current environment.
6310 %INC List of files that have been require-d or do-ne.
6311 %SIG Used to set signal handlers for various signals.
6312 ... & ... Bitwise and.
6313 ... && ... Logical and.
6314 ... &&= ... Logical and assignment.
6315 ... &= ... Bitwise and assignment.
6316 ... * ... Multiplication.
6317 ... ** ... Exponentiation.
6318 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6319 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
6320 ... + ... Addition. +EXPR Makes EXPR into scalar context.
6321 ++ Auto-increment (magical on strings). ++EXPR EXPR++
6322 ... += ... Addition assignment.
6324 ... - ... Subtraction.
6325 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6326 ... -= ... Subtraction assignment.
6327 -A Access time in days since script started.
6328 -B File is a non-text (binary) file.
6329 -C Inode change time in days since script started.
6330 -M Age in days since script started.
6331 -O File is owned by real uid.
6332 -R File is readable by real uid.
6333 -S File is a socket .
6334 -T File is a text file.
6335 -W File is writable by real uid.
6336 -X File is executable by real uid.
6337 -b File is a block special file.
6338 -c File is a character special file.
6339 -d File is a directory.
6341 -f File is a plain file.
6342 -g File has setgid bit set.
6343 -k File has sticky bit set.
6344 -l File is a symbolic link.
6345 -o File is owned by effective uid.
6346 -p File is a named pipe (FIFO).
6347 -r File is readable by effective uid.
6348 -s File has non-zero size.
6349 -t Tests if filehandle (STDIN by default) is opened to a tty.
6350 -u File has setuid bit set.
6351 -w File is writable by effective uid.
6352 -x File is executable by effective uid.
6353 -z File has zero size.
6354 . Concatenate strings.
6355 .. Range (list context); flip/flop (scalar context) operator.
6356 .= Concatenate assignment strings
6357 ... / ... Division. /PATTERN/ioxsmg Pattern match
6358 ... /= ... Division assignment.
6359 /PATTERN/ioxsmg Pattern match.
6360 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6361 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6362 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6363 <> Reads line from union of files in @ARGV (= command line) and STDIN.
6364 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6365 ... <= ... Numeric less than or equal to.
6366 ... <=> ... Numeric compare.
6367 ... = ... Assignment.
6368 ... == ... Numeric equality.
6369 ... =~ ... Search pattern, substitution, or translation
6370 ... > ... Numeric greater than.
6371 ... >= ... Numeric greater than or equal to.
6372 ... >> ... Bitwise shift right.
6373 ... >>= ... Bitwise shift right assignment.
6374 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6375 ?PATTERN? One-time pattern match.
6376 @ARGV Command line arguments (not including the command name - see $0).
6377 @INC List of places to look for perl scripts during do/include/use.
6378 @_ Parameter array for subroutines; result of split() unless in list context.
6379 \\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
6380 \\0 Octal char, e.g. \\033.
6381 \\E Case modification terminator. See \\Q, \\L, and \\U.
6382 \\L Lowercase until \\E . See also \l, lc.
6383 \\U Upcase until \\E . See also \u, uc.
6384 \\Q Quote metacharacters until \\E . See also quotemeta.
6385 \\a Alarm character (octal 007).
6386 \\b Backspace character (octal 010).
6387 \\c Control character, e.g. \\c[ .
6388 \\e Escape character (octal 033).
6389 \\f Formfeed character (octal 014).
6390 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
6391 \\n Newline character (octal 012 on most systems).
6392 \\r Return character (octal 015 on most systems).
6393 \\t Tab character (octal 011).
6394 \\u Upcase the next character. See also \\U and \\l, ucfirst.
6395 \\x Hex character, e.g. \\x1b.
6396 ... ^ ... Bitwise exclusive or.
6397 __END__ Ends program source.
6398 __DATA__ Ends program source.
6399 __FILE__ Current (source) filename.
6400 __LINE__ Current line in current source.
6401 __PACKAGE__ Current package.
6402 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6403 ARGVOUT Output filehandle with -i flag.
6404 BEGIN { ... } Immediately executed (during compilation) piece of code.
6405 END { ... } Pseudo-subroutine executed after the script finishes.
6406 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
6407 INIT { ... } Pseudo-subroutine executed before the script starts running.
6408 DATA Input filehandle for what follows after __END__ or __DATA__.
6409 accept(NEWSOCKET,GENERICSOCKET)
6422 ... cmp ... String compare.
6423 connect(SOCKET,NAME)
6424 continue of { block } continue { block }. Is executed after `next' or at end.
6426 crypt(PLAINTEXT,SALT)
6428 dbmopen(%HASH,DBNAME,MODE)
6432 do { ... }|SUBR while|until EXPR executes at least once
6433 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6443 ... eq ... String equality.
6444 eval(EXPR) or eval { BLOCK }
6448 fcntl(FILEHANDLE,FUNCTION,SCALAR)
6450 flock(FILEHANDLE,OPERATION)
6451 for (EXPR;EXPR;EXPR) { ... }
6452 foreach [VAR] (@ARRAY) { ... }
6454 ... ge ... String greater than or equal.
6459 gethostbyaddr(ADDR,ADDRTYPE)
6463 getnetbyaddr(ADDR,ADDRTYPE)
6469 getpriority(WHICH,WHO)
6470 getprotobyname(NAME)
6471 getprotobynumber(NUMBER)
6476 getservbyname(NAME,PROTO)
6477 getservbyport(PORT,PROTO)
6480 getsockopt(SOCKET,LEVEL,OPTNAME)
6483 ... gt ... String greater than.
6485 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6486 index(STR,SUBSTR[,OFFSET])
6488 ioctl(FILEHANDLE,FUNCTION,SCALAR)
6493 ... le ... String less than or equal.
6495 link(OLDFILE,NEWFILE)
6496 listen(SOCKET,QUEUESIZE)
6500 lstat(EXPR|FILEHANDLE|VAR)
6501 ... lt ... String less than.
6503 mkdir(FILENAME,MODE)
6506 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6507 msgsnd(ID,MSG,FLAGS)
6508 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6509 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
6510 ... ne ... String inequality.
6513 open(FILEHANDLE[,EXPR])
6514 opendir(DIRHANDLE,EXPR)
6515 ord(EXPR) ASCII value of the first char of the string.
6517 package NAME Introduces package context.
6518 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6520 print [FILEHANDLE] [(LIST)]
6521 printf [FILEHANDLE] (FORMAT,LIST)
6523 q/STRING/ Synonym for 'STRING'
6524 qq/STRING/ Synonym for \"STRING\"
6525 qx/STRING/ Synonym for `STRING`
6527 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6530 recv(SOCKET,SCALAR,LEN,FLAGS)
6532 rename(OLDNAME,NEWNAME)
6533 require [FILENAME | PERL_VERSION]
6537 rewinddir(DIRHANDLE)
6538 rindex(STR,SUBSTR[,OFFSET])
6540 s/PATTERN/REPLACEMENT/gieoxsm
6542 seek(FILEHANDLE,POSITION,WHENCE)
6543 seekdir(DIRHANDLE,POS)
6544 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6545 semctl(ID,SEMNUM,CMD,ARG)
6546 semget(KEY,NSEMS,SIZE,FLAGS)
6548 send(SOCKET,MSG,FLAGS[,TO])
6550 sethostent(STAYOPEN)
6553 setpriority(WHICH,WHO,PRIORITY)
6554 setprotoent(STAYOPEN)
6556 setservent(STAYOPEN)
6557 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6560 shmget(KEY,SIZE,FLAGS)
6561 shmread(ID,VAR,POS,SIZE)
6562 shmwrite(ID,STRING,POS,SIZE)
6563 shutdown(SOCKET,HOW)
6566 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6567 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6568 sort [SUBROUTINE] (LIST)
6569 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6570 split[(/PATTERN/[,EXPR[,LIMIT]])]
6571 sprintf(FORMAT,LIST)
6574 stat(EXPR|FILEHANDLE|VAR)
6576 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6577 substr(EXPR,OFFSET[,LEN])
6578 symlink(OLDFILE,NEWFILE)
6580 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6582 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6587 tr/SEARCHLIST/REPLACEMENTLIST/cds
6588 truncate(FILE|EXPR,LENGTH)
6591 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6593 unpack(TEMPLATE,EXPR)
6595 until (EXPR) { ... } EXPR until EXPR
6598 vec(EXPR,OFFSET,BITS)
6601 wantarray Returns true if the sub/eval is called in list context.
6603 while (EXPR) { ... } EXPR while EXPR
6604 write[(EXPR|FILEHANDLE)]
6605 ... x ... Repeat string or array.
6606 x= ... Repetition assignment.
6607 y/SEARCHLIST/REPLACEMENTLIST/
6608 ... | ... Bitwise or.
6609 ... || ... Logical or.
6610 ~ ... Unary bitwise complement.
6611 #! OS interpreter indicator. If contains `perl', used for options, and -x.
6612 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6613 CORE:: Prefix to access builtin function if imported sub obscures it.
6614 SUPER:: Prefix to lookup for a method in @ISA classes.
6615 DESTROY Shorthand for `sub DESTROY {...}'.
6616 ... EQ ... Obsolete synonym of `eq'.
6617 ... GE ... Obsolete synonym of `ge'.
6618 ... GT ... Obsolete synonym of `gt'.
6619 ... LE ... Obsolete synonym of `le'.
6620 ... LT ... Obsolete synonym of `lt'.
6621 ... NE ... Obsolete synonym of `ne'.
6622 abs [ EXPR ] absolute value
6623 ... and ... Low-precedence synonym for &&.
6624 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6625 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6626 chr Converts a number to char with the same ordinal.
6627 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6628 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6629 exists $HASH{KEY} True if the key exists.
6630 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6631 formline PICTURE, LIST Backdoor into \"format\" processing.
6632 glob EXPR Synonym of <EXPR>.
6633 lc [ EXPR ] Returns lowercased EXPR.
6634 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
6635 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
6636 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6637 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6638 not ... Low-precedence synonym for ! - negation.
6639 ... or ... Low-precedence synonym for ||.
6640 pos STRING Set/Get end-position of the last match over this string, see \\G.
6641 quotemeta [ EXPR ] Quote regexp metacharacters.
6642 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6643 readline FH Synonym of <FH>.
6644 readpipe CMD Synonym of `CMD`.
6645 ref [ EXPR ] Type of EXPR when dereferenced.
6646 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6647 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6648 tied Returns internal object for a tied data.
6649 uc [ EXPR ] Returns upcased EXPR.
6650 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6651 untie VAR Unlink an object from a simple Perl variable.
6652 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6653 ... xor ... Low-precedence synonym for exclusive or.
6654 prototype \&SUB Returns prototype of the function given a reference.
6655 =head1 Top-level heading.
6656 =head2 Second-level heading.
6657 =head3 Third-level heading (is there such?).
6658 =over [ NUMBER ] Start list.
6659 =item [ TITLE ] Start new item in the list.
6661 =cut Switch from POD to Perl.
6662 =pod Switch from Perl to POD.
6665 (defun cperl-switch-to-doc-buffer (&optional interactive)
6666 "Go to the perl documentation buffer and insert the documentation."
6668 (let ((buf (get-buffer-create cperl-doc-buffer)))
6670 (switch-to-buffer-other-window buf)
6672 (if (= (buffer-size) 0)
6674 (insert (documentation-property 'cperl-short-docs
6675 'variable-documentation))
6676 (setq buffer-read-only t)))))
6678 (defun cperl-beautify-regexp-piece (b e embed level)
6679 ;; b is before the starting delimiter, e before the ending
6680 ;; e should be a marker, may be changed, but remains "correct".
6681 ;; EMBED is nil iff we process the whole REx.
6682 ;; The REx is guarantied to have //x
6683 ;; LEVEL shows how many levels deep to go
6684 ;; position at enter and at leave is not defined
6685 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
6689 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
6693 ((looking-at "(\\?[^a-zA-Z]")
6695 ((looking-at "(\\?") ; (?i)
6699 (setq c (if embed (current-indentation) (1- (current-column)))
6700 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
6701 (or (looking-at "[ \t]*[\n#]")
6706 (if (re-search-forward "[^ \t]" e t)
6707 (progn ; Something before the ending delimiter
6709 (delete-horizontal-space)
6711 (indent-to-column c)
6712 (set-marker e (point))))
6715 (while (< (point) (marker-position e))
6719 (skip-chars-forward " \t")
6720 (delete-region s (point))
6721 (indent-to-column c1)
6725 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
6726 "\\|" ; Embedded variable
6727 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
6730 "\\|" ; simple-code simple-code*?
6731 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
6735 "\\((\\(\\?\\)?\\)" ; 7 8
6738 (goto-char (match-end 0))
6740 (cond ((match-beginning 1) ; Alphanum word + junk
6742 ((or (match-beginning 3) ; $ab[12]
6743 (and (match-beginning 5) ; X* X+ X{2,3}
6744 (eq (preceding-char) ?\{)))
6747 ((match-beginning 6) ; []
6749 (if (looking-at "\\^?\\]")
6750 (goto-char (match-end 0)))
6751 ;; XXXX POSIX classes?!
6752 (while (and (not pos)
6753 (re-search-forward "\\[:\\|\\]" e t))
6754 (if (eq (preceding-char) ?:)
6755 (or (re-search-forward ":\\]" e t)
6756 (error "[:POSIX:]-group in []-group not terminated"))
6758 (or (eq (preceding-char) ?\])
6759 (error "[]-group not terminated"))
6760 (if (eq (following-char) ?\{)
6763 (and (eq (following-char) ??)
6765 (re-search-forward "\\=\\([*+?]\\??\\)" e t)))
6766 ((match-beginning 7) ; ()
6767 (goto-char (match-beginning 0))
6768 (setq pos (current-column))
6771 (delete-horizontal-space)
6773 (indent-to-column c1)))
6776 ;; (or (forward-sexp 1)
6779 ;; (error "()-group not terminated")))
6780 (set-marker m (1- (point)))
6781 (set-marker m1 (point))
6783 (if (progn ; indent rigidly if multiline
6784 ;; In fact does not make a lot of sense, since
6785 ;; the starting position can be already lost due
6786 ;; to insertion of "\n" and " "
6788 (search-forward "\n" m1 t))
6789 (indent-rigidly (point) m1 (- c1 pos)))
6790 (setq level (1- level))
6792 ((not (match-beginning 8))
6793 (cperl-beautify-regexp-piece tmp m t level))
6794 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
6796 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
6797 (goto-char (+ 2 tmp))
6799 (cperl-beautify-regexp-piece (point) m t level))
6800 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
6801 (goto-char (+ 3 tmp))
6802 (cperl-beautify-regexp-piece (point) m t level))
6804 (cperl-beautify-regexp-piece tmp m t level))))
6806 (cond ((looking-at "[*+?]\\??")
6807 (goto-char (match-end 0)))
6808 ((eq (following-char) ?\{)
6810 (if (eq (following-char) ?\?)
6812 (skip-chars-forward " \t")
6814 (if (looking-at "[#\n]")
6816 (or (eolp) (indent-for-comment))
6817 (beginning-of-line 2))
6818 (delete-horizontal-space)
6822 ((match-beginning 9) ; |
6826 (if (re-search-forward "[^ \t]" tmp t)
6829 (delete-horizontal-space)
6832 (delete-region (point) tmp))
6833 (indent-to-column c)
6835 (skip-chars-forward " \t")
6837 (if (looking-at "[#\n]")
6838 (beginning-of-line 2)
6839 (delete-horizontal-space)
6843 (or (looking-at "[ \t\n]")
6846 (skip-chars-forward " \t"))
6847 (or (looking-at "[#\n]")
6848 (error "Unknown code `%s' in a regexp"
6849 (buffer-substring (point) (1+ (point)))))
6850 (and inline (end-of-line 2)))
6851 ;; Special-case the last line of group
6852 (if (and (>= (point) (marker-position e))
6853 (/= (current-indentation) c))
6857 (skip-chars-forward " \t")
6858 (delete-region s (point))
6859 (indent-to-column c)))))
6861 (defun cperl-make-regexp-x ()
6862 ;; Returns position of the start
6863 ;; XXX this is called too often! Need to cache the result!
6865 (or cperl-use-syntax-table-text-property
6866 (error "I need to have a regexp marked!"))
6868 (if (looking-at "\\s|")
6870 (if (looking-at "\\([smy]\\|qr\\)\\s|")
6872 (re-search-backward "\\s|"))) ; Assume it is scanned already.
6874 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
6875 (sub-p (eq (preceding-char) ?s)) s)
6877 (set-marker e (1- (point)))
6878 (setq delim (preceding-char))
6879 (if (and sub-p (eq delim (char-after (- (point) 2))))
6880 (error "Possible s/blah// - do not know how to deal with"))
6881 (if sub-p (forward-sexp 1))
6882 (if (looking-at "\\sw*x")
6885 ;; Protect fragile " ", "#"
6888 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
6894 (defun cperl-beautify-regexp (&optional deep)
6895 "Do it. (Experimental, may change semantics, recheck the result.)
6896 We suppose that the regexp is scanned already."
6898 (setq deep (if deep (prefix-numeric-value deep) -1))
6900 (goto-char (cperl-make-regexp-x))
6901 (let ((b (point)) (e (make-marker)))
6903 (set-marker e (1- (point)))
6904 (cperl-beautify-regexp-piece b e nil deep))))
6906 (defun cperl-regext-to-level-start ()
6907 "Goto start of an enclosing group in regexp.
6908 We suppose that the regexp is scanned already."
6910 (let ((limit (cperl-make-regexp-x)) done)
6912 (or (eq (following-char) ?\()
6913 (search-backward "(" (1+ limit) t)
6914 (error "Cannot find `(' which starts a group"))
6917 (skip-chars-backward "\\")
6918 (looking-at "\\(\\\\\\\\\\)*(")))
6919 (or done (forward-char -1)))))
6921 (defun cperl-contract-level ()
6922 "Find an enclosing group in regexp and contract it.
6923 \(Experimental, may change semantics, recheck the result.)
6924 We suppose that the regexp is scanned already."
6926 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
6927 (cperl-regext-to-level-start)
6928 (let ((b (point)) (e (make-marker)) s c)
6930 (set-marker e (1- (point)))
6932 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
6934 ((match-beginning 1) ; #-comment
6935 (or c (setq c (current-indentation)))
6936 (beginning-of-line 2) ; Skip
6938 (skip-chars-forward " \t")
6939 (delete-region s (point))
6940 (indent-to-column c))
6943 (just-one-space))))))
6945 (defun cperl-contract-levels ()
6946 "Find an enclosing group in regexp and contract all the kids.
6947 \(Experimental, may change semantics, recheck the result.)
6948 We suppose that the regexp is scanned already."
6952 (cperl-regext-to-level-start)
6953 (error ; We are outside outermost group
6954 (goto-char (cperl-make-regexp-x))))
6955 (let ((b (point)) (e (make-marker)) s c)
6957 (set-marker e (1- (point)))
6959 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
6961 ((match-beginning 1) ; Skip
6964 (cperl-contract-level)))))))
6966 (defun cperl-beautify-level (&optional deep)
6967 "Find an enclosing group in regexp and beautify it.
6968 \(Experimental, may change semantics, recheck the result.)
6969 We suppose that the regexp is scanned already."
6971 (setq deep (if deep (prefix-numeric-value deep) -1))
6973 (cperl-regext-to-level-start)
6974 (let ((b (point)) (e (make-marker)))
6976 (set-marker e (1- (point)))
6977 (cperl-beautify-regexp-piece b e nil deep))))
6979 (defun cperl-invert-if-unless ()
6980 "Change `if (A) {B}' into `B if A;' etc if possible."
6982 (or (looking-at "\\<")
6984 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
6985 (let ((pos1 (point))
6986 pos2 pos3 pos4 pos5 s1 s2 state p pos45
6987 (s0 (buffer-substring (match-beginning 0) (match-end 0))))
6992 (if (eq (following-char) ?\( )
6999 ;; XXXX In fact may be `A if (B); {C}' ...
7000 (if (and (eq (following-char) ?\{ )
7002 (cperl-backward-to-noncomment pos3)
7003 (eq (preceding-char) ?\) )))
7004 (if (condition-case nil
7009 (looking-at "\\<els\\(e\\|if\\)\\>"))
7012 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" s0)
7013 (goto-char (1- pos5))
7014 (cperl-backward-to-noncomment pos4)
7015 (if (eq (preceding-char) ?\;)
7017 (setq pos45 (point))
7019 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
7020 (setq p (match-beginning 0)
7021 s1 (buffer-substring p (match-end 0))
7022 state (parse-partial-sexp pos4 p))
7026 (error "`%s' inside `%s' BLOCK" s1 s0))
7027 (goto-char (match-end 0)))
7029 (goto-char (1+ pos4))
7030 (skip-chars-forward " \t\n")
7031 (setq s2 (buffer-substring (point) pos45))
7033 (or (looking-at ";?[ \t\n]*}")
7035 (skip-chars-forward "; \t\n")
7036 (setq s2 (concat s2 "\n" (buffer-substring (point) (1- pos5))))))
7039 (goto-char (1- pos3))
7040 (cperl-backward-to-noncomment pos2)
7041 (or (looking-at "[ \t\n]*)")
7042 (goto-char (1- pos3)))
7044 (goto-char (1+ pos2))
7045 (skip-chars-forward " \t\n")
7046 (setq s1 (buffer-substring (point) p))
7047 (delete-region pos4 pos5)
7048 (delete-region pos2 pos3)
7055 (delete-horizontal-space)
7057 (delete-horizontal-space)
7060 (cperl-indent-line))
7061 (error "`%s' (EXPR) not with an {BLOCK}" s0)))
7062 (error "`%s' not with an (EXPR)" s0)))
7063 (error "Not at `if', `unless', `while', `until', `for' or `foreach'")))
7065 ;;; By Anthony Foiani <afoiani@uswest.com>
7066 ;;; Getting help on modules in C-h f ?
7067 ;;; This is a modified version of `man'.
7068 ;;; Need to teach it how to lookup functions
7069 (defun cperl-perldoc (word)
7070 "Run `perldoc' on WORD."
7072 (list (let* ((default-entry (cperl-word-at-point))
7074 (format "perldoc entry%s: "
7075 (if (string= default-entry "")
7077 (format " (default %s)" default-entry))))))
7078 (if (string= input "")
7079 (if (string= default-entry "")
7080 (error "No perldoc args given")
7084 (let* ((case-fold-search nil)
7086 (string-match "^[a-z]+$" word)
7087 (string-match (concat "^" word "\\>")
7088 (documentation-property
7090 'variable-documentation))))
7091 (manual-program (if is-func "perldoc -f" "perldoc")))
7094 (let ((Manual-program "perldoc")
7095 (Manual-switches (if is-func (list "-f"))))
7096 (manual-entry word)))
7098 (Man-getpage-in-background word)))))
7100 (defun cperl-perldoc-at-point ()
7101 "Run a `perldoc' on the word around point."
7103 (cperl-perldoc (cperl-word-at-point)))
7105 (defcustom pod2man-program "pod2man"
7106 "*File name for `pod2man'."
7110 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
7111 (defun cperl-pod-to-manpage ()
7112 "Create a virtual manpage in Emacs from the Perl Online Documentation."
7115 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
7116 (bufname (concat "Man " buffer-file-name))
7117 (buffer (generate-new-buffer bufname)))
7120 (let ((process-environment (copy-sequence process-environment)))
7121 ;; Prevent any attempt to use display terminal fanciness.
7122 (setenv "TERM" "dumb")
7123 (set-process-sentinel
7124 (start-process pod2man-program buffer "sh" "-c"
7125 (format (cperl-pod2man-build-command) pod2man-args))
7126 'Man-bgproc-sentinel)))))
7128 ;;; Updated version by him too
7129 (defun cperl-build-manpage ()
7130 "Create a virtual manpage in Emacs from the POD in the file."
7135 (let ((Manual-program "perldoc"))
7136 (manual-entry buffer-file-name)))
7138 (let* ((manual-program "perldoc"))
7139 (Man-getpage-in-background buffer-file-name)))))
7141 (defun cperl-pod2man-build-command ()
7142 "Builds the entire background manpage and cleaning command."
7143 (let ((command (concat pod2man-program " %s 2>/dev/null"))
7144 (flist Man-filter-list))
7145 (while (and flist (car flist))
7146 (let ((pcom (car (car flist)))
7147 (pargs (cdr (car flist))))
7149 (concat command " | " pcom " "
7150 (mapconcat '(lambda (phrase)
7151 (if (not (stringp phrase))
7152 (error "Malformed Man-filter-list"))
7155 (setq flist (cdr flist))))
7158 (defun cperl-lazy-install ()) ; Avoid a warning
7159 (defun cperl-lazy-unstall ()) ; Avoid a warning
7161 (if (fboundp 'run-with-idle-timer)
7163 (defvar cperl-help-shown nil
7164 "Non-nil means that the help was already shown now.")
7166 (defvar cperl-lazy-installed nil
7167 "Non-nil means that the lazy-help handlers are installed now.")
7169 (defun cperl-lazy-install ()
7170 "Switches on Auto-Help on Perl constructs (put in the message area).
7171 Delay of auto-help controlled by `cperl-lazy-help-time'."
7173 (make-variable-buffer-local 'cperl-help-shown)
7174 (if (and (cperl-val 'cperl-lazy-help-time)
7175 (not cperl-lazy-installed))
7177 (add-hook 'post-command-hook 'cperl-lazy-hook)
7178 (run-with-idle-timer
7179 (cperl-val 'cperl-lazy-help-time 1000000 5)
7181 'cperl-get-help-defer)
7182 (setq cperl-lazy-installed t))))
7184 (defun cperl-lazy-unstall ()
7185 "Switches off Auto-Help on Perl constructs (put in the message area).
7186 Delay of auto-help controlled by `cperl-lazy-help-time'."
7188 (remove-hook 'post-command-hook 'cperl-lazy-hook)
7189 (cancel-function-timers 'cperl-get-help-defer)
7190 (setq cperl-lazy-installed nil))
7192 (defun cperl-lazy-hook ()
7193 (setq cperl-help-shown nil))
7195 (defun cperl-get-help-defer ()
7196 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
7197 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
7199 (setq cperl-help-shown t))))
7200 (cperl-lazy-install)))
7203 ;;; Plug for wrong font-lock:
7205 (defun cperl-font-lock-unfontify-region-function (beg end)
7206 ;; Simplified now that font-lock-unfontify-region uses save-buffer-state.
7207 (let (before-change-functions after-change-functions)
7208 (remove-text-properties beg end '(face nil))))
7210 (defvar cperl-d-l nil)
7211 (defun cperl-fontify-syntaxically (end)
7212 ;; Some vars for debugging only
7213 ;; (message "Syntaxifying...")
7214 (let ((dbg (point)) (iend end)
7215 (istate (car cperl-syntax-state))
7217 (and cperl-syntaxify-unwind
7218 (setq end (cperl-unwind-to-safe t end)))
7219 (setq start (point))
7220 (or cperl-syntax-done-to
7221 (setq cperl-syntax-done-to (point-min)))
7222 (if (or (not (boundp 'font-lock-hot-pass))
7223 (eval 'font-lock-hot-pass)
7224 t) ; Not debugged otherwise
7225 ;; Need to forget what is after `start'
7226 (setq start (min cperl-syntax-done-to start))
7227 ;; Fontification without a change
7228 (setq start (max cperl-syntax-done-to start)))
7230 (setq cperl-syntax-done-to start) ; In case what follows fails
7231 (cperl-find-pods-heres start end t nil t))
7232 (if (eq cperl-syntaxify-by-font-lock 'message)
7233 (message "Syntaxified %s..%s from %s to %s(%s), state %s-->%s"
7235 start end cperl-syntax-done-to
7236 istate (car cperl-syntax-state))) ; For debugging
7237 nil)) ; Do not iterate
7239 (defun cperl-fontify-update (end)
7240 (let ((pos (point)) prop posend)
7242 (setq prop (get-text-property pos 'cperl-postpone))
7243 (setq posend (next-single-property-change pos 'cperl-postpone nil end))
7244 (and prop (put-text-property pos posend (car prop) (cdr prop)))
7246 nil) ; Do not iterate
7248 (defun cperl-update-syntaxification (from to)
7249 (if (and cperl-use-syntax-table-text-property
7250 cperl-syntaxify-by-font-lock
7251 (or (null cperl-syntax-done-to)
7252 (< cperl-syntax-done-to to)))
7256 (cperl-fontify-syntaxically to)))))
7258 (defvar cperl-version
7259 (let ((v "Revision: 5.0"))
7260 (string-match ":\\s *\\([0-9.]+\\)" v)
7261 (substring v (match-beginning 1) (match-end 1)))
7262 "Version of IZ-supported CPerl package this file is based on.")
7264 (provide 'cperl-mode)
7266 ;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
7267 ;;; cperl-mode.el ends here