1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
3 ;; Copyright (C) 1985,86,87,91,92,93,94,95,96,97,98,99,2000,03,2004,2005
4 ;; Free Software Foundation, Inc.
6 ;; Author: Ilya Zakharevich and Bob Olson
7 ;; Maintainer: Ilya Zakharevich <cperl@ilyaz.org>
8 ;; Keywords: languages, Perl
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Corrections made by Ilya Zakharevich cperl@ilyaz.org
31 ;; You can either fine-tune the bells and whistles of this mode or
32 ;; bulk enable them by putting
34 ;; (setq cperl-hairy t)
36 ;; in your .emacs file. (Emacs rulers do not consider it politically
37 ;; correct to make whistles enabled by default.)
39 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
40 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
41 ;; `cperl-praise', `cperl-speed'. <<<<<<
43 ;; The mode information (on C-h m) provides some customization help.
44 ;; If you use font-lock feature of this mode, it is advisable to use
45 ;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
47 ;; Faces used now: three faces for first-class and second-class keywords
48 ;; and control flow words, one for each: comments, string, labels,
49 ;; functions definitions and packages, arrays, hashes, and variable
50 ;; definitions. If you do not see all these faces, your font-lock does
51 ;; not define them, so you need to define them manually.
53 ;; This mode supports font-lock, imenu and mode-compile. In the
54 ;; hairy version font-lock is on, but you should activate imenu
55 ;; yourself (note that mode-compile is not standard yet). Well, you
56 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
57 ;; to bind it like that:
59 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
61 ;;; Font lock bugs as of v4.32:
63 ;; The following kinds of Perl code erroneously start strings:
65 ;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
66 ;; likewise with m, tr, y, q, qX instead of s
70 ;; Some macros are needed for `defcustom'
75 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
76 (defvar cperl-can-font-lock
78 (and (boundp 'emacs-major-version)
80 (> emacs-major-version 20)))))
81 (if cperl-can-font-lock
83 (defvar msb-menu-cond)
84 (defvar gud-perldb-history)
85 (defvar font-lock-background-mode) ; not in Emacs
86 (defvar font-lock-display-type) ; ditto
87 (defmacro cperl-is-face (arg) ; Takes quoted arg
88 (cond ((fboundp 'find-face)
90 (;;(and (fboundp 'face-list)
93 `(member ,arg (and (fboundp 'face-list)
97 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
98 (cond ((fboundp 'make-face)
99 `(make-face (quote ,arg)))
101 `(defvar ,arg (quote ,arg) ,descr))))
102 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
104 (or (cperl-is-face (quote ,arg))
105 (cperl-make-face ,arg ,descr))
106 (or (boundp (quote ,arg)) ; We use unquoted variants too
107 (defvar ,arg (quote ,arg) ,descr))))
109 (defmacro cperl-etags-snarf-tag (file line)
111 (beginning-of-line 2)
113 (defmacro cperl-etags-snarf-tag (file line)
116 (defmacro cperl-etags-goto-tag-location (elt)
118 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
119 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
120 ;; Probably will not work due to some save-excursion???
121 ;; Or save-file-position?
122 ;; (message "Did I get to line %s?" (elt (, elt) 1))
123 `(goto-line (string-to-number (elt ,elt 1))))
125 (defmacro cperl-etags-goto-tag-location (elt)
126 `(etags-goto-tag-location ,elt))))
128 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
130 (defvar cperl-can-font-lock
132 (and (boundp 'emacs-major-version)
134 (> emacs-major-version 20)))))
136 (defun cperl-choose-color (&rest list)
140 (if (or (x-color-defined-p (car list))
142 (setq answer (car list))))
143 (setq list (cdr list)))
147 "Major mode for editing Perl code."
152 (defgroup cperl-indentation-details nil
157 (defgroup cperl-affected-by-hairy nil
158 "Variables affected by `cperl-hairy'."
162 (defgroup cperl-autoinsert-details nil
163 "Auto-insert tuneup."
167 (defgroup cperl-faces nil
168 "Fontification colors."
172 (defgroup cperl-speed nil
173 "Speed vs. validity tuneup."
177 (defgroup cperl-help-system nil
178 "Help system tuneup."
183 (defcustom cperl-extra-newline-before-brace nil
184 "*Non-nil means that if, elsif, while, until, else, for, foreach
185 and do constructs look like:
196 :group 'cperl-autoinsert-details)
198 (defcustom cperl-extra-newline-before-brace-multiline
199 cperl-extra-newline-before-brace
200 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
201 for constructs with multiline if/unless/while/until/for/foreach condition."
203 :group 'cperl-autoinsert-details)
205 (defcustom cperl-indent-level 2
206 "*Indentation of CPerl statements with respect to containing block."
208 :group 'cperl-indentation-details)
210 (defcustom cperl-lineup-step nil
211 "*`cperl-lineup' will always lineup at multiple of this number.
212 If nil, the value of `cperl-indent-level' will be used."
213 :type '(choice (const nil) integer)
214 :group 'cperl-indentation-details)
216 (defcustom cperl-brace-imaginary-offset 0
217 "*Imagined indentation of a Perl open brace that actually follows a statement.
218 An open brace following other text is treated as if it were this far
219 to the right of the start of its line."
221 :group 'cperl-indentation-details)
223 (defcustom cperl-brace-offset 0
224 "*Extra indentation for braces, compared with other text in same context."
226 :group 'cperl-indentation-details)
227 (defcustom cperl-label-offset -2
228 "*Offset of CPerl label lines relative to usual indentation."
230 :group 'cperl-indentation-details)
231 (defcustom cperl-min-label-indent 1
232 "*Minimal offset of CPerl label lines."
234 :group 'cperl-indentation-details)
235 (defcustom cperl-continued-statement-offset 2
236 "*Extra indent for lines not starting new statements."
238 :group 'cperl-indentation-details)
239 (defcustom cperl-continued-brace-offset 0
240 "*Extra indent for substatements that start with open-braces.
241 This is in addition to cperl-continued-statement-offset."
243 :group 'cperl-indentation-details)
244 (defcustom cperl-close-paren-offset -1
245 "*Extra indent for substatements that start with close-parenthesis."
247 :group 'cperl-indentation-details)
249 (defcustom cperl-auto-newline nil
250 "*Non-nil means automatically newline before and after braces,
251 and after colons and semicolons, inserted in CPerl code. The following
252 \\[cperl-electric-backspace] will remove the inserted whitespace.
253 Insertion after colons requires both this variable and
254 `cperl-auto-newline-after-colon' set."
256 :group 'cperl-autoinsert-details)
258 (defcustom cperl-autoindent-on-semi nil
259 "*Non-nil means automatically indent after insertion of (semi)colon.
260 Active if `cperl-auto-newline' is false."
262 :group 'cperl-autoinsert-details)
264 (defcustom cperl-auto-newline-after-colon nil
265 "*Non-nil means automatically newline even after colons.
266 Subject to `cperl-auto-newline' setting."
268 :group 'cperl-autoinsert-details)
270 (defcustom cperl-tab-always-indent t
271 "*Non-nil means TAB in CPerl mode should always reindent the current line,
272 regardless of where in the line point is when the TAB command is used."
274 :group 'cperl-indentation-details)
276 (defcustom cperl-font-lock nil
277 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
278 Can be overwritten by `cperl-hairy' if nil."
279 :type '(choice (const null) boolean)
280 :group 'cperl-affected-by-hairy)
282 (defcustom cperl-electric-lbrace-space nil
283 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
284 Can be overwritten by `cperl-hairy' if nil."
285 :type '(choice (const null) boolean)
286 :group 'cperl-affected-by-hairy)
288 (defcustom cperl-electric-parens-string "({[]})<"
289 "*String of parentheses that should be electric in CPerl.
290 Closing ones are electric only if the region is highlighted."
292 :group 'cperl-affected-by-hairy)
294 (defcustom cperl-electric-parens nil
295 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
296 Can be overwritten by `cperl-hairy' if nil."
297 :type '(choice (const null) boolean)
298 :group 'cperl-affected-by-hairy)
300 (defvar zmacs-regions) ; Avoid warning
302 (defcustom cperl-electric-parens-mark
304 (or (and (boundp 'transient-mark-mode) ; For Emacs
306 (and (boundp 'zmacs-regions) ; For XEmacs
308 "*Not-nil means that electric parens look for active mark.
309 Default is yes if there is visual feedback on mark."
311 :group 'cperl-autoinsert-details)
313 (defcustom cperl-electric-linefeed nil
314 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
315 In any case these two mean plain and hairy linefeeds together.
316 Can be overwritten by `cperl-hairy' if nil."
317 :type '(choice (const null) boolean)
318 :group 'cperl-affected-by-hairy)
320 (defcustom cperl-electric-keywords nil
321 "*Not-nil (and non-null) means keywords are electric in CPerl.
322 Can be overwritten by `cperl-hairy' if nil."
323 :type '(choice (const null) boolean)
324 :group 'cperl-affected-by-hairy)
326 (defcustom cperl-electric-backspace-untabify t
327 "*Not-nil means electric-backspace will untabify in CPerl."
329 :group 'cperl-autoinsert-details)
331 (defcustom cperl-hairy nil
332 "*Not-nil means most of the bells and whistles are enabled in CPerl.
333 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
334 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
335 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
336 `cperl-lazy-help-time'."
338 :group 'cperl-affected-by-hairy)
340 (defcustom cperl-comment-column 32
341 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
343 :group 'cperl-indentation-details)
345 (defvar cperl-vc-header-alist nil)
346 (make-obsolete-variable
347 'cperl-vc-header-alist
348 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead.")
350 (defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
351 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
352 :type '(repeat string)
355 (defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/) ;")
356 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
357 :type '(repeat string)
360 (defcustom cperl-clobber-mode-lists
363 (boundp 'interpreter-mode-alist)
364 (assoc "miniperl" interpreter-mode-alist)
365 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
366 "*Whether to install us into `interpreter-' and `extension' mode lists."
370 (defcustom cperl-info-on-command-no-prompt nil
371 "*Not-nil (and non-null) means not to prompt on C-h f.
372 The opposite behavior is always available if prefixed with C-c.
373 Can be overwritten by `cperl-hairy' if nil."
374 :type '(choice (const null) boolean)
375 :group 'cperl-affected-by-hairy)
377 (defcustom cperl-clobber-lisp-bindings nil
378 "*Not-nil (and non-null) means not overwrite C-h f.
379 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
380 Can be overwritten by `cperl-hairy' if nil."
381 :type '(choice (const null) boolean)
382 :group 'cperl-affected-by-hairy)
384 (defcustom cperl-lazy-help-time nil
385 "*Not-nil (and non-null) means to show lazy help after given idle time.
386 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
387 :type '(choice (const null) (const nil) integer)
388 :group 'cperl-affected-by-hairy)
390 (defcustom cperl-pod-face 'font-lock-comment-face
391 "*Face for POD highlighting."
395 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
396 "*Face for POD highlighting.
397 Font for POD headers."
401 (defcustom cperl-here-face 'font-lock-string-face
402 "*Face for here-docs highlighting."
406 (defcustom cperl-invalid-face 'underline
407 "*Face for highlighting trailing whitespace."
412 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
413 "*Not-nil after evaluation means to highlight POD and here-docs sections."
417 (defcustom cperl-fontify-m-as-s t
418 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
422 (defcustom cperl-highlight-variables-indiscriminately nil
423 "*Non-nil means perform additional highlighting on variables.
424 Currently only changes how scalar variables are highlighted.
425 Note that that variable is only read at initialization time for
426 the variable `cperl-font-lock-keywords-2', so changing it after you've
427 entered CPerl mode the first time will have no effect."
431 (defcustom cperl-pod-here-scan t
432 "*Not-nil means look for POD and here-docs sections during startup.
433 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
437 (defcustom cperl-regexp-scan t
438 "*Not-nil means make marking of regular expression more thorough.
439 Effective only with `cperl-pod-here-scan'. Not implemented yet."
443 (defcustom cperl-imenu-addback nil
444 "*Not-nil means add backreferences to generated `imenu's.
445 May require patched `imenu' and `imenu-go'. Obsolete."
447 :group 'cperl-help-system)
449 (defcustom cperl-max-help-size 66
450 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
451 :type '(choice integer (const nil))
452 :group 'cperl-help-system)
454 (defcustom cperl-shrink-wrap-info-frame t
455 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
457 :group 'cperl-help-system)
459 (defcustom cperl-info-page "perl"
460 "*Name of the info page containing perl docs.
461 Older version of this page was called `perl5', newer `perl'."
463 :group 'cperl-help-system)
465 (defcustom cperl-use-syntax-table-text-property
466 (boundp 'parse-sexp-lookup-properties)
467 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
471 (defcustom cperl-use-syntax-table-text-property-for-tags
472 cperl-use-syntax-table-text-property
473 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
477 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
478 "*Regexp to match files to scan when generating TAGS."
482 (defcustom cperl-noscan-files-regexp
483 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
484 "*Regexp to match files/dirs to skip when generating TAGS."
488 (defcustom cperl-regexp-indent-step nil
489 "*Indentation used when beautifying regexps.
490 If nil, the value of `cperl-indent-level' will be used."
491 :type '(choice integer (const nil))
492 :group 'cperl-indentation-details)
494 (defcustom cperl-indent-left-aligned-comments t
495 "*Non-nil means that the comment starting in leftmost column should indent."
497 :group 'cperl-indentation-details)
499 (defcustom cperl-under-as-char nil
500 "*Non-nil means that the _ (underline) should be treated as word char."
504 (defcustom cperl-extra-perl-args ""
505 "*Extra arguments to use when starting Perl.
506 Currently used with `cperl-check-syntax' only."
510 (defcustom cperl-message-electric-keyword t
511 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
513 :group 'cperl-help-system)
515 (defcustom cperl-indent-region-fix-constructs 1
516 "*Amount of space to insert between `}' and `else' or `elsif'
517 in `cperl-indent-region'. Set to nil to leave as is. Values other
518 than 1 and nil will probably not work."
519 :type '(choice (const nil) (const 1))
520 :group 'cperl-indentation-details)
522 (defcustom cperl-break-one-line-blocks-when-indent t
523 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
524 need to be reformatted into multiline ones when indenting a region."
526 :group 'cperl-indentation-details)
528 (defcustom cperl-fix-hanging-brace-when-indent t
529 "*Non-nil means that BLOCK-end `}' may be put on a separate line
530 when indenting a region.
531 Braces followed by else/elsif/while/until are excepted."
533 :group 'cperl-indentation-details)
535 (defcustom cperl-merge-trailing-else t
536 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
537 may be merged to be on the same line when indenting a region."
539 :group 'cperl-indentation-details)
541 (defcustom cperl-indent-parens-as-block nil
542 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
543 but for trailing \",\" inside the group, which won't increase indentation.
544 One should tune up `cperl-close-paren-offset' as well."
546 :group 'cperl-indentation-details)
548 (defcustom cperl-syntaxify-by-font-lock
549 (and cperl-can-font-lock
550 (boundp 'parse-sexp-lookup-properties))
551 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
552 :type '(choice (const message) boolean)
555 (defcustom cperl-syntaxify-unwind
557 "*Non-nil means that CPerl unwinds to a start of a long construction
558 when syntaxifying a chunk of buffer."
562 (defcustom cperl-ps-print-face-properties
563 '((font-lock-keyword-face nil nil bold shadow)
564 (font-lock-variable-name-face nil nil bold)
565 (font-lock-function-name-face nil nil bold italic box)
566 (font-lock-constant-face nil "LightGray" bold)
567 (cperl-array nil "LightGray" bold underline)
568 (cperl-hash nil "LightGray" bold italic underline)
569 (font-lock-comment-face nil "LightGray" italic)
570 (font-lock-string-face nil nil italic underline)
571 (cperl-nonoverridable nil nil italic underline)
572 (font-lock-type-face nil nil underline)
573 (underline nil "LightGray" strikeout))
574 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
575 :type '(repeat (cons symbol
576 (cons (choice (const nil) string)
577 (cons (choice (const nil) string)
581 (defvar cperl-dark-background
582 (cperl-choose-color "navy" "os2blue" "darkgreen"))
583 (defvar cperl-dark-foreground
584 (cperl-choose-color "orchid1" "orange"))
586 (defface cperl-nonoverridable
587 `((((class grayscale) (background light))
588 (:background "Gray90" :slant italic :underline t))
589 (((class grayscale) (background dark))
590 (:foreground "Gray80" :slant italic :underline t :weight bold))
591 (((class color) (background light))
592 (:foreground "chartreuse3"))
593 (((class color) (background dark))
594 (:foreground ,cperl-dark-foreground))
595 (t (:weight bold :underline t)))
596 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
598 ;; backward-compatibility alias
599 (put 'cperl-nonoverridable-face 'face-alias 'cperl-nonoverridable)
602 `((((class grayscale) (background light))
603 (:background "Gray90" :weight bold))
604 (((class grayscale) (background dark))
605 (:foreground "Gray80" :weight bold))
606 (((class color) (background light))
607 (:foreground "Blue" :background "lightyellow2" :weight bold))
608 (((class color) (background dark))
609 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
611 "Font Lock mode face used to highlight array names."
613 ;; backward-compatibility alias
614 (put 'cperl-array-face 'face-alias 'cperl-array)
617 `((((class grayscale) (background light))
618 (:background "Gray90" :weight bold :slant italic))
619 (((class grayscale) (background dark))
620 (:foreground "Gray80" :weight bold :slant italic))
621 (((class color) (background light))
622 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
623 (((class color) (background dark))
624 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
625 (t (:weight bold :slant italic)))
626 "Font Lock mode face used to highlight hash names."
628 ;; backward-compatibility alias
629 (put 'cperl-hash-face 'face-alias 'cperl-hash)
633 ;;; Short extra-docs.
635 (defvar cperl-tips 'please-ignore-this-line
636 "Get maybe newer version of this package from
637 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
639 ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
640 Subdirectory `cperl-mode' may contain yet newer development releases and/or
641 patches to related files.
643 For best results apply to an older Emacs the patches from
644 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
645 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
646 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
647 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
649 Get support packages choose-color.el (or font-lock-extra.el before
650 19.30), imenu-go.el from the same place. \(Look for other files there
651 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
652 later you should use choose-color.el *instead* of font-lock-extra.el
653 \(and you will not get smart highlighting in C :-().
655 Note that to enable Compile choices in the menu you need to install
658 If your Emacs does not default to `cperl-mode' on Perl files, and you
659 want it to: put the following into your .emacs file:
661 (defalias 'perl-mode 'cperl-mode)
664 $CPAN/doc/manual/info/perl-info.tar.gz
666 http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
668 If you use imenu-go, run imenu on perl5-info buffer (you can do it
669 from Perl menu). If many files are related, generate TAGS files from
670 Tools/Tags submenu in Perl menu.
672 If some class structure is too complicated, use Tools/Hierarchy-view
673 from Perl menu, or hierarchic view of imenu. The second one uses the
674 current buffer only, the first one requires generation of TAGS from
675 Perl/Tools/Tags menu beforehand.
677 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
679 Switch auto-help on/off with Perl/Tools/Auto-help.
681 Though with contemporary Emaxen CPerl mode should maintain the correct
682 parsing of Perl even when editing, sometimes it may be lost. Fix this by
686 In cases of more severe confusion sometimes it is helpful to do
688 \\[load-library] cperl-mode RET
691 Before reporting (non-)problems look in the problem section of online
692 micro-docs on what I know about CPerl problems.")
694 (defvar cperl-problems 'please-ignore-this-line
695 "Description of problems in CPerl mode.
696 Some faces will not be shown on some versions of Emacs unless you
697 install choose-color.el, available from
698 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
700 `fill-paragraph' on a comment may leave the point behind the
701 paragraph. Parsing of lines with several <<EOF is not implemented
704 Emacs had a _very_ restricted syntax parsing engine until version
705 20.1. Most problems below are corrected starting from this version of
706 Emacs, and all of them should be fixed in version 20.3. (Or apply
707 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
708 this respect (until 2003).
710 Note that even with newer Emacsen in some very rare cases the details
711 of interaction of `font-lock' and syntaxification may be not cleaned
712 up yet. You may get slightly different colors basing on the order of
713 fontification and syntaxification. Say, the initial faces is correct,
714 but editing the buffer breaks this.
716 Even with older Emacsen CPerl mode tries to corrects some Emacs
717 misunderstandings, however, for efficiency reasons the degree of
718 correction is different for different operations. The partially
719 corrected problems are: POD sections, here-documents, regexps. The
720 operations are: highlighting, indentation, electric keywords, electric
723 This may be confusing, since the regexp s#//#/#\; may be highlighted
724 as a comment, but it will be recognized as a regexp by the indentation
725 code. Or the opposite case, when a POD section is highlighted, but
726 may break the indentation of the following code (though indentation
727 should work if the balance of delimiters is not broken by POD).
729 The main trick (to make $ a \"backslash\") makes constructions like
730 ${aaa} look like unbalanced braces. The only trick I can think of is
731 to insert it as $ {aaa} (valid in perl5, not in perl4).
733 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
734 as /($|\\s)/. Note that such a transposition is not always possible.
736 The solution is to upgrade your Emacs or patch an older one. Note
737 that Emacs 20.2 has some bugs related to `syntax-table' text
738 properties. Patches are available on the main CPerl download site,
741 If these bugs cannot be fixed on your machine (say, you have an inferior
742 environment and cannot recompile), you may still disable all the fancy stuff
743 via `cperl-use-syntax-table-text-property'.")
745 (defvar cperl-praise 'please-ignore-this-line
746 "Advantages of CPerl mode.
748 0) It uses the newest `syntax-table' property ;-);
750 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
751 mode - but the latter number may have improved too in last years) even
752 with old Emaxen which do not support `syntax-table' property.
754 When using `syntax-table' property for syntax assist hints, it should
755 handle 99.995% of lines correct - or somesuch. It automatically
756 updates syntax assist hints when you edit your script.
758 2) It is generally believed to be \"the most user-friendly Emacs
759 package\" whatever it may mean (I doubt that the people who say similar
760 things tried _all_ the rest of Emacs ;-), but this was not a lonely
763 3) Everything is customizable, one-by-one or in a big sweep;
765 4) It has many easily-accessable \"tools\":
766 a) Can run program, check syntax, start debugger;
767 b) Can lineup vertically \"middles\" of rows, like `=' in
770 c) Can insert spaces where this impoves readability (in one
771 interactive sweep over the buffer);
772 d) Has support for imenu, including:
773 1) Separate unordered list of \"interesting places\";
774 2) Separate TOC of POD sections;
775 3) Separate list of packages;
776 4) Hierarchical view of methods in (sub)packages;
777 5) and functions (by the full name - with package);
778 e) Has an interface to INFO docs for Perl; The interface is
779 very flexible, including shrink-wrapping of
780 documentation buffer/frame;
781 f) Has a builtin list of one-line explanations for perl constructs.
782 g) Can show these explanations if you stay long enough at the
783 corresponding place (or on demand);
784 h) Has an enhanced fontification (using 3 or 4 additional faces
785 comparing to font-lock - basically, different
786 namespaces in Perl have different colors);
787 i) Can construct TAGS basing on its knowledge of Perl syntax,
788 the standard menu has 6 different way to generate
789 TAGS (if \"by directory\", .xs files - with C-language
790 bindings - are included in the scan);
791 j) Can build a hierarchical view of classes (via imenu) basing
792 on generated TAGS file;
793 k) Has electric parentheses, electric newlines, uses Abbrev
794 for electric logical constructs
796 with different styles of expansion (context sensitive
797 to be not so bothering). Electric parentheses behave
798 \"as they should\" in a presence of a visible region.
799 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
805 n) Highlights (by user-choice) either 3-delimiters constructs
806 (such as tr/a/b/), or regular expressions and `y/tr';
807 o) Highlights trailing whitespace;
808 p) Is able to manipulate Perl Regular Expressions to ease
809 conversion to a more readable form.
811 5) The indentation engine was very smart, but most of tricks may be
812 not needed anymore with the support for `syntax-table' property. Has
813 progress indicator for indentation (with `imenu' loaded).
815 6) Indent-region improves inline-comments as well; also corrects
816 whitespace *inside* the conditional/loop constructs.
818 7) Fill-paragraph correctly handles multi-line comments;
820 8) Can switch to different indentation styles by one command, and restore
821 the settings present before the switch.
823 9) When doing indentation of control constructs, may correct
824 line-breaks/spacing between elements of the construct.
826 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
827 capable syntax engines).")
829 (defvar cperl-speed 'please-ignore-this-line
830 "This is an incomplete compendium of what is available in other parts
831 of CPerl documentation. (Please inform me if I skept anything.)
833 There is a perception that CPerl is slower than alternatives. This part
834 of documentation is designed to overcome this misconception.
836 *By default* CPerl tries to enable the most comfortable settings.
837 From most points of view, correctly working package is infinitely more
838 comfortable than a non-correctly working one, thus by default CPerl
839 prefers correctness over speed. Below is the guide how to change
840 settings if your preferences are different.
842 A) Speed of loading the file. When loading file, CPerl may perform a
843 scan which indicates places which cannot be parsed by primitive Emacs
844 syntax-parsing routines, and marks them up so that either
846 A1) CPerl may work around these deficiencies (for big chunks, mostly
847 PODs and HERE-documents), or
848 A2) On capable Emaxen CPerl will use improved syntax-handlings
849 which reads mark-up hints directly.
851 The scan in case A2 is much more comprehensive, thus may be slower.
853 User can disable syntax-engine-helping scan of A2 by setting
854 `cperl-use-syntax-table-text-property'
855 variable to nil (if it is set to t).
857 One can disable the scan altogether (both A1 and A2) by setting
858 `cperl-pod-here-scan'
861 B) Speed of editing operations.
863 One can add a (minor) speedup to editing operations by setting
864 `cperl-use-syntax-table-text-property'
865 variable to nil (if it is set to t). This will disable
866 syntax-engine-helping scan, thus will make many more Perl
867 constructs be wrongly recognized by CPerl, thus may lead to
868 wrongly matched parentheses, wrong indentation, etc.
870 One can unset `cperl-syntaxify-unwind'. This might speed up editing
871 of, say, long POD sections.")
873 (defvar cperl-tips-faces 'please-ignore-this-line
874 "CPerl mode uses following faces for highlighting:
876 `cperl-array' Array names
877 `cperl-hash' Hash names
878 `font-lock-comment-face' Comments, PODs and whatever is considered
879 syntaxically to be not code
880 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
881 2-arg operators s/y/tr/ or of RExen,
882 `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
883 a target of a file tests, file tests,
884 subroutine names at the moment of definition
885 (except those conflicting with Perl operators),
886 package names (when recognized), format names
887 `font-lock-keyword-face' Control flow switch constructs, declarators
888 `cperl-nonoverridable' Non-overridable keywords, modifiers of RExen
889 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
890 literal parts and the terminator of formats
891 and whatever is syntaxically considered
893 `font-lock-type-face' Overridable keywords
894 `font-lock-variable-name-face' Variable declarations, indirect array and
895 hash names, POD headers/item names
896 `cperl-invalid' Trailing whitespace
898 Note that in several situations the highlighting tries to inform about
899 possible confusion, such as different colors for function names in
900 declarations depending on what they (do not) override, or special cases
901 m// and s/// which do not do what one would expect them to do.
903 Help with best setup of these faces for printout requested (for each of
904 the faces: please specify bold, italic, underline, shadow and box.)
910 ;;; Portability stuff:
912 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
913 `(define-key cperl-mode-map
915 `(if cperl-xemacs-p ,xemacs-key ,emacs-key)
919 (defvar cperl-del-back-ch
920 (car (append (where-is-internal 'delete-backward-char)
921 (where-is-internal 'backward-delete-char-untabify)))
922 "Character generated by key bound to `delete-backward-char'.")
924 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
925 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
927 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
930 ;; "Active regions" are on: use region only if active
931 ;; "Active regions" are off: use region unconditionally
932 (defun cperl-use-region-p ()
933 (if zmacs-regions (mark) t)))
934 (defun cperl-use-region-p ()
935 (if transient-mark-mode mark-active t))
936 (defun cperl-mark-active () mark-active))
938 (defsubst cperl-enable-font-lock ()
941 (defun cperl-putback-char (c) ; Emacs 19
942 (set 'unread-command-events (list c))) ; Avoid undefined warning
945 (defun cperl-putback-char (c) ; XEmacs >= 19.12
946 (setq unread-command-events (list (eval '(character-to-event c))))))
948 (or (fboundp 'uncomment-region)
949 (defun uncomment-region (beg end)
951 (comment-region beg end -1)))
953 (defvar cperl-do-not-fontify
954 (if (string< emacs-version "19.30")
957 "Text property which inhibits refontification.")
959 (defsubst cperl-put-do-not-fontify (from to &optional post)
960 ;; If POST, do not do it with postponed fontification
961 (if (and post cperl-syntaxify-by-font-lock)
963 (put-text-property (max (point-min) (1- from))
964 to cperl-do-not-fontify t)))
966 (defcustom cperl-mode-hook nil
967 "Hook run by CPerl mode."
971 (defvar cperl-syntax-state nil)
972 (defvar cperl-syntax-done-to nil)
973 (defvar cperl-emacs-can-parse (> (length (save-excursion
974 (parse-partial-sexp (point) (point)))) 9))
976 ;; Make customization possible "in reverse"
977 (defsubst cperl-val (symbol &optional default hairy)
979 ((eq (symbol-value symbol) 'null) default)
980 (cperl-hairy (or hairy t))
981 (t (symbol-value symbol))))
983 ;;; Probably it is too late to set these guys already, but it can help later:
985 ;;;(and cperl-clobber-mode-lists
986 ;;;(setq auto-mode-alist
987 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
988 ;;;(and (boundp 'interpreter-mode-alist)
989 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
990 ;;; '(("miniperl" . perl-mode))))))
996 '(imenu easymenu etags timer man info))
997 (if (fboundp 'ps-extend-face-list)
998 (defmacro cperl-ps-extend-face-list (arg)
999 `(ps-extend-face-list ,arg))
1000 (defmacro cperl-ps-extend-face-list (arg)
1001 `(error "This version of Emacs has no `ps-extend-face-list'")))
1002 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1003 ;; macros instead of defsubsts don't work on Emacs, so we do the
1004 ;; expansion manually. Any other suggestions?
1007 (defvar cperl-mode-abbrev-table nil
1008 "Abbrev table in use in CPerl mode buffers.")
1010 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1012 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
1014 (if cperl-mode-map nil
1015 (setq cperl-mode-map (make-sparse-keymap))
1016 (cperl-define-key "{" 'cperl-electric-lbrace)
1017 (cperl-define-key "[" 'cperl-electric-paren)
1018 (cperl-define-key "(" 'cperl-electric-paren)
1019 (cperl-define-key "<" 'cperl-electric-paren)
1020 (cperl-define-key "}" 'cperl-electric-brace)
1021 (cperl-define-key "]" 'cperl-electric-rparen)
1022 (cperl-define-key ")" 'cperl-electric-rparen)
1023 (cperl-define-key ";" 'cperl-electric-semi)
1024 (cperl-define-key ":" 'cperl-electric-terminator)
1025 (cperl-define-key "\C-j" 'newline-and-indent)
1026 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
1027 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
1028 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1029 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
1030 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1031 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
1032 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
1033 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
1034 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1035 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1037 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1038 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1039 (cperl-define-key "\177" 'cperl-electric-backspace)
1040 (cperl-define-key "\t" 'cperl-indent-command)
1041 ;; don't clobber the backspace binding:
1042 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1043 [(control c) (control h) F])
1044 (if (cperl-val 'cperl-clobber-lisp-bindings)
1046 (cperl-define-key "\C-hf"
1047 ;;(concat (char-to-string help-char) "f") ; does not work
1048 'cperl-info-on-command
1050 (cperl-define-key "\C-hv"
1051 ;;(concat (char-to-string help-char) "v") ; does not work
1054 (cperl-define-key "\C-c\C-hf"
1055 ;;(concat (char-to-string help-char) "f") ; does not work
1056 (key-binding "\C-hf")
1057 [(control c) (control h) f])
1058 (cperl-define-key "\C-c\C-hv"
1059 ;;(concat (char-to-string help-char) "v") ; does not work
1060 (key-binding "\C-hv")
1061 [(control c) (control h) v]))
1062 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1063 [(control c) (control h) f])
1064 (cperl-define-key "\C-c\C-hv"
1065 ;;(concat (char-to-string help-char) "v") ; does not work
1067 [(control c) (control h) v]))
1068 (if (and cperl-xemacs-p
1069 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1071 ;; substitute-key-definition is usefulness-deenhanced...
1072 (cperl-define-key "\M-q" 'cperl-fill-paragraph)
1073 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1074 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
1075 (substitute-key-definition
1076 'indent-sexp 'cperl-indent-exp
1077 cperl-mode-map global-map)
1078 (substitute-key-definition
1079 'indent-region 'cperl-indent-region
1080 cperl-mode-map global-map)
1081 (substitute-key-definition
1082 'indent-for-comment 'cperl-indent-for-comment
1083 cperl-mode-map global-map)))
1086 (defvar cperl-lazy-installed)
1087 (defvar cperl-old-style nil)
1092 cperl-menu cperl-mode-map "Menu for CPerl mode"
1094 ["Beginning of function" beginning-of-defun t]
1095 ["End of function" end-of-defun t]
1096 ["Mark function" mark-defun t]
1097 ["Indent expression" cperl-indent-exp t]
1098 ["Fill paragraph/comment" fill-paragraph t]
1100 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1101 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1103 ["Beautify" cperl-beautify-regexp
1104 cperl-use-syntax-table-text-property]
1105 ["Beautify one level deep" (cperl-beautify-regexp 1)
1106 cperl-use-syntax-table-text-property]
1107 ["Beautify a group" cperl-beautify-level
1108 cperl-use-syntax-table-text-property]
1109 ["Beautify a group one level deep" (cperl-beautify-level 1)
1110 cperl-use-syntax-table-text-property]
1111 ["Contract a group" cperl-contract-level
1112 cperl-use-syntax-table-text-property]
1113 ["Contract groups" cperl-contract-levels
1114 cperl-use-syntax-table-text-property])
1115 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1117 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1118 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1119 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1121 ["Run" mode-compile (fboundp 'mode-compile)]
1122 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1123 (get-buffer "*compilation*"))]
1124 ["Next error" next-error (get-buffer "*compilation*")]
1125 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1127 ["Debugger" cperl-db t]
1130 ["Imenu" imenu (fboundp 'imenu)]
1131 ["Insert spaces if needed" cperl-find-bad-style t]
1132 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1133 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1134 ["CPerl pretty print (exprmntl)" cperl-ps-print
1135 (fboundp 'ps-extend-face-list)]
1136 ["Imenu on info" cperl-imenu-on-info (featurep 'imenu)]
1138 ;;; ["Create tags for current file" cperl-etags t]
1139 ;;; ["Add tags for current file" (cperl-etags t) t]
1140 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1141 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1142 ;;; ["Create tags for Perl files in (sub)directories"
1143 ;;; (cperl-etags nil 'recursive) t]
1144 ;;; ["Add tags for Perl files in (sub)directories"
1145 ;;; (cperl-etags t 'recursive) t])
1146 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1147 ["Create tags for current file" (cperl-write-tags nil t) t]
1148 ["Add tags for current file" (cperl-write-tags) t]
1149 ["Create tags for Perl files in directory"
1150 (cperl-write-tags nil t nil t) t]
1151 ["Add tags for Perl files in directory"
1152 (cperl-write-tags nil nil nil t) t]
1153 ["Create tags for Perl files in (sub)directories"
1154 (cperl-write-tags nil t t t) t]
1155 ["Add tags for Perl files in (sub)directories"
1156 (cperl-write-tags nil nil t t) t]))
1158 ["Define word at point" imenu-go-find-at-position
1159 (fboundp 'imenu-go-find-at-position)]
1160 ["Help on function" cperl-info-on-command t]
1161 ["Help on function at point" cperl-info-on-current-command t]
1162 ["Help on symbol at point" cperl-get-help t]
1163 ["Perldoc" cperl-perldoc t]
1164 ["Perldoc on word at point" cperl-perldoc-at-point t]
1165 ["View manpage of POD in this file" cperl-build-manpage t]
1166 ["Auto-help on" cperl-lazy-install
1167 (and (fboundp 'run-with-idle-timer)
1168 (not cperl-lazy-installed))]
1169 ["Auto-help off" cperl-lazy-unstall
1170 (and (fboundp 'run-with-idle-timer)
1171 cperl-lazy-installed)])
1173 ["Auto newline" cperl-toggle-auto-newline t]
1174 ["Electric parens" cperl-toggle-electric t]
1175 ["Electric keywords" cperl-toggle-abbrev t]
1176 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1177 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
1178 ["Auto fill" auto-fill-mode t])
1180 ["CPerl" (cperl-set-style "CPerl") t]
1181 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1182 ["GNU" (cperl-set-style "GNU") t]
1183 ["C++" (cperl-set-style "C++") t]
1184 ["FSF" (cperl-set-style "FSF") t]
1185 ["BSD" (cperl-set-style "BSD") t]
1186 ["Whitesmith" (cperl-set-style "Whitesmith") t]
1187 ["Current" (cperl-set-style "Current") t]
1188 ["Memorized" (cperl-set-style-back) cperl-old-style])
1190 ["Tips" (describe-variable 'cperl-tips) t]
1191 ["Problems" (describe-variable 'cperl-problems) t]
1192 ["Speed" (describe-variable 'cperl-speed) t]
1193 ["Praise" (describe-variable 'cperl-praise) t]
1194 ["Faces" (describe-variable 'cperl-tips-faces) t]
1195 ["CPerl mode" (describe-function 'cperl-mode) t]
1197 (message "The version of master-file for this CPerl is %s-Emacs"
1198 cperl-version) t]))))
1201 (autoload 'c-macro-expand "cmacexp"
1202 "Display the result of expanding all C macros occurring in the region.
1203 The expansion is entirely correct because it uses the C preprocessor."
1206 (defvar cperl-imenu--function-name-regexp-perl
1209 "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
1211 "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
1214 (defvar cperl-outline-regexp
1215 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1217 (defvar cperl-mode-syntax-table nil
1218 "Syntax table in use in CPerl mode buffers.")
1220 (defvar cperl-string-syntax-table nil
1221 "Syntax table in use in CPerl mode string-like chunks.")
1223 (if cperl-mode-syntax-table
1225 (setq cperl-mode-syntax-table (make-syntax-table))
1226 (modify-syntax-entry ?\\ "\\" cperl-mode-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 ?\n ">" cperl-mode-syntax-table)
1238 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1239 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1240 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1241 (if cperl-under-as-char
1242 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1243 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1244 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1245 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1246 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
1247 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
1251 (defvar cperl-faces-init nil)
1253 (defvar cperl-msb-fixed nil)
1254 (defvar cperl-use-major-mode 'cperl-mode)
1257 (defun cperl-mode ()
1258 "Major mode for editing Perl code.
1259 Expression and list commands understand all C brackets.
1260 Tab indents for Perl code.
1261 Paragraphs are separated by blank lines only.
1262 Delete converts tabs to spaces as it moves back.
1264 Various characters in Perl almost always come in pairs: {}, (), [],
1265 sometimes <>. When the user types the first, she gets the second as
1266 well, with optional special formatting done on {}. (Disabled by
1267 default.) You can always quote (with \\[quoted-insert]) the left
1268 \"paren\" to avoid the expansion. The processing of < is special,
1269 since most the time you mean \"less\". CPerl mode tries to guess
1270 whether you want to type pair <>, and inserts is if it
1271 appropriate. You can set `cperl-electric-parens-string' to the string that
1272 contains the parenths from the above list you want to be electrical.
1273 Electricity of parenths is controlled by `cperl-electric-parens'.
1274 You may also set `cperl-electric-parens-mark' to have electric parens
1275 look for active mark and \"embrace\" a region if possible.'
1277 CPerl mode provides expansion of the Perl control constructs:
1279 if, else, elsif, unless, while, until, continue, do,
1280 for, foreach, formy and foreachmy.
1282 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1284 The user types the keyword immediately followed by a space, which
1285 causes the construct to be expanded, and the point is positioned where
1286 she is most likely to want to be. eg. when the user types a space
1287 following \"if\" the following appears in the buffer: if () { or if ()
1288 } { } and the cursor is between the parentheses. The user can then
1289 type some boolean expression within the parens. Having done that,
1290 typing \\[cperl-linefeed] places you - appropriately indented - on a
1291 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1292 directive line, then appropriate number of new lines is inserted).
1294 If CPerl decides that you want to insert \"English\" style construct like
1298 it will not do any expansion. See also help on variable
1299 `cperl-extra-newline-before-brace'. (Note that one can switch the
1300 help message on expansion by setting `cperl-message-electric-keyword'
1303 \\[cperl-linefeed] is a convenience replacement for typing carriage
1304 return. It places you in the next line with proper indentation, or if
1305 you type it inside the inline block of control construct, like
1307 foreach (@lines) {print; print}
1309 and you are on a boundary of a statement inside braces, it will
1310 transform the construct into a multiline and will place you into an
1311 appropriately indented blank line. If you need a usual
1312 `newline-and-indent' behavior, it is on \\[newline-and-indent],
1313 see documentation on `cperl-electric-linefeed'.
1315 Use \\[cperl-invert-if-unless] to change a construction of the form
1325 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1326 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1327 on electric space between $ and {, `cperl-electric-parens-string' is
1328 the string that contains parentheses that should be electric in CPerl
1329 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1330 setting `cperl-electric-keywords' enables electric expansion of
1331 control structures in CPerl. `cperl-electric-linefeed' governs which
1332 one of two linefeed behavior is preferable. You can enable all these
1333 options simultaneously (recommended mode of use) by setting
1334 `cperl-hairy' to t. In this case you can switch separate options off
1335 by setting them to `null'. Note that one may undo the extra
1336 whitespace inserted by semis and braces in `auto-newline'-mode by
1337 consequent \\[cperl-electric-backspace].
1339 If your site has perl5 documentation in info format, you can use commands
1340 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1341 These keys run commands `cperl-info-on-current-command' and
1342 `cperl-info-on-command', which one is which is controlled by variable
1343 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1344 \(in turn affected by `cperl-hairy').
1346 Even if you have no info-format documentation, short one-liner-style
1347 help is available on \\[cperl-get-help], and one can run perldoc or
1350 It is possible to show this help automatically after some idle time.
1351 This is regulated by variable `cperl-lazy-help-time'. Default with
1352 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1353 secs idle time . It is also possible to switch this on/off from the
1354 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1356 Use \\[cperl-lineup] to vertically lineup some construction - put the
1357 beginning of the region at the start of construction, and make region
1358 span the needed amount of lines.
1360 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1361 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1362 here-docs sections. With capable Emaxen results of scan are used
1363 for indentation too, otherwise they are used for highlighting only.
1365 Variables controlling indentation style:
1366 `cperl-tab-always-indent'
1367 Non-nil means TAB in CPerl mode should always reindent the current line,
1368 regardless of where in the line point is when the TAB command is used.
1369 `cperl-indent-left-aligned-comments'
1370 Non-nil means that the comment starting in leftmost column should indent.
1371 `cperl-auto-newline'
1372 Non-nil means automatically newline before and after braces,
1373 and after colons and semicolons, inserted in Perl code. The following
1374 \\[cperl-electric-backspace] will remove the inserted whitespace.
1375 Insertion after colons requires both this variable and
1376 `cperl-auto-newline-after-colon' set.
1377 `cperl-auto-newline-after-colon'
1378 Non-nil means automatically newline even after colons.
1379 Subject to `cperl-auto-newline' setting.
1380 `cperl-indent-level'
1381 Indentation of Perl statements within surrounding block.
1382 The surrounding block's indentation is the indentation
1383 of the line on which the open-brace appears.
1384 `cperl-continued-statement-offset'
1385 Extra indentation given to a substatement, such as the
1386 then-clause of an if, or body of a while, or just a statement continuation.
1387 `cperl-continued-brace-offset'
1388 Extra indentation given to a brace that starts a substatement.
1389 This is in addition to `cperl-continued-statement-offset'.
1390 `cperl-brace-offset'
1391 Extra indentation for line if it starts with an open brace.
1392 `cperl-brace-imaginary-offset'
1393 An open brace following other text is treated as if it the line started
1394 this far to the right of the actual line indentation.
1395 `cperl-label-offset'
1396 Extra indentation for line that is a label.
1397 `cperl-min-label-indent'
1398 Minimal indentation for line that is a label.
1400 Settings for K&R and BSD indentation styles are
1401 `cperl-indent-level' 5 8
1402 `cperl-continued-statement-offset' 5 8
1403 `cperl-brace-offset' -5 -8
1404 `cperl-label-offset' -5 -8
1406 CPerl knows several indentation styles, and may bulk set the
1407 corresponding variables. Use \\[cperl-set-style] to do this. Use
1408 \\[cperl-set-style-back] to restore the memorized preexisting values
1409 \(both available from menu).
1411 If `cperl-indent-level' is 0, the statement after opening brace in
1412 column 0 is indented on
1413 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1415 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1418 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1419 or as help on variables `cperl-tips', `cperl-problems',
1420 `cperl-praise', `cperl-speed'."
1422 (kill-all-local-variables)
1423 (use-local-map cperl-mode-map)
1424 (if (cperl-val 'cperl-electric-linefeed)
1426 (local-set-key "\C-J" 'cperl-linefeed)
1427 (local-set-key "\C-C\C-J" 'newline-and-indent)))
1429 (cperl-val 'cperl-clobber-lisp-bindings)
1430 (cperl-val 'cperl-info-on-command-no-prompt))
1432 ;; don't clobber the backspace binding:
1433 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1434 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1435 [(control c) (control h) f])))
1436 (setq major-mode cperl-use-major-mode)
1437 (setq mode-name "CPerl")
1438 (if (not cperl-mode-abbrev-table)
1439 (let ((prev-a-c abbrevs-changed))
1440 (define-abbrev-table 'cperl-mode-abbrev-table '(
1441 ("if" "if" cperl-electric-keyword 0)
1442 ("elsif" "elsif" cperl-electric-keyword 0)
1443 ("while" "while" cperl-electric-keyword 0)
1444 ("until" "until" cperl-electric-keyword 0)
1445 ("unless" "unless" cperl-electric-keyword 0)
1446 ("else" "else" cperl-electric-else 0)
1447 ("continue" "continue" cperl-electric-else 0)
1448 ("for" "for" cperl-electric-keyword 0)
1449 ("foreach" "foreach" cperl-electric-keyword 0)
1450 ("formy" "formy" cperl-electric-keyword 0)
1451 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1452 ("do" "do" cperl-electric-keyword 0)
1453 ("=pod" "=pod" cperl-electric-pod 0)
1454 ("=over" "=over" cperl-electric-pod 0)
1455 ("=head1" "=head1" cperl-electric-pod 0)
1456 ("=head2" "=head2" cperl-electric-pod 0)
1457 ("pod" "pod" cperl-electric-pod 0)
1458 ("over" "over" cperl-electric-pod 0)
1459 ("head1" "head1" cperl-electric-pod 0)
1460 ("head2" "head2" cperl-electric-pod 0)))
1461 (setq abbrevs-changed prev-a-c)))
1462 (setq local-abbrev-table cperl-mode-abbrev-table)
1463 (abbrev-mode (if (cperl-val 'cperl-electric-keywords) 1 0))
1464 (set-syntax-table cperl-mode-syntax-table)
1465 (make-local-variable 'outline-regexp)
1466 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1467 (setq outline-regexp cperl-outline-regexp)
1468 (make-local-variable 'outline-level)
1469 (setq outline-level 'cperl-outline-level)
1470 (make-local-variable 'paragraph-start)
1471 (setq paragraph-start (concat "^$\\|" page-delimiter))
1472 (make-local-variable 'paragraph-separate)
1473 (setq paragraph-separate paragraph-start)
1474 (make-local-variable 'paragraph-ignore-fill-prefix)
1475 (setq paragraph-ignore-fill-prefix t)
1476 (set (make-local-variable 'fill-paragraph-function) 'cperl-fill-paragraph)
1477 (make-local-variable 'indent-line-function)
1478 (setq indent-line-function 'cperl-indent-line)
1479 (make-local-variable 'require-final-newline)
1480 (setq require-final-newline mode-require-final-newline)
1481 (make-local-variable 'comment-start)
1482 (setq comment-start "# ")
1483 (make-local-variable 'comment-end)
1484 (setq comment-end "")
1485 (make-local-variable 'comment-column)
1486 (setq comment-column cperl-comment-column)
1487 (make-local-variable 'comment-start-skip)
1488 (setq comment-start-skip "#+ *")
1489 (make-local-variable 'defun-prompt-regexp)
1490 (setq defun-prompt-regexp "^[ \t]*sub[ \t\n]+\\([^ \t\n{(;]+\\)\\([ \t\n]*([^()]*)[ \t\n]*\\)?[ \t\n]*")
1491 (make-local-variable 'comment-indent-function)
1492 (setq comment-indent-function 'cperl-comment-indent)
1493 (make-local-variable 'parse-sexp-ignore-comments)
1494 (setq parse-sexp-ignore-comments t)
1495 (make-local-variable 'indent-region-function)
1496 (setq indent-region-function 'cperl-indent-region)
1497 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1498 (make-local-variable 'imenu-create-index-function)
1499 (setq imenu-create-index-function
1500 (function cperl-imenu--create-perl-index))
1501 (make-local-variable 'imenu-sort-function)
1502 (setq imenu-sort-function nil)
1503 (make-local-variable 'vc-rcs-header)
1504 (set 'vc-rcs-header cperl-vc-rcs-header)
1505 (make-local-variable 'vc-sccs-header)
1506 (set 'vc-sccs-header cperl-vc-sccs-header)
1507 (make-local-variable 'font-lock-defaults)
1508 (setq font-lock-defaults
1510 ((string< emacs-version "19.30")
1511 '(cperl-font-lock-keywords-2))
1512 ((string< emacs-version "19.33") ; Which one to use?
1513 '((cperl-font-lock-keywords
1514 cperl-font-lock-keywords-1
1515 cperl-font-lock-keywords-2)))
1517 '((cperl-load-font-lock-keywords
1518 cperl-load-font-lock-keywords-1
1519 cperl-load-font-lock-keywords-2)))))
1520 (make-local-variable 'cperl-syntax-state)
1521 (if cperl-use-syntax-table-text-property
1523 (make-local-variable 'parse-sexp-lookup-properties)
1524 ;; Do not introduce variable if not needed, we check it!
1525 (set 'parse-sexp-lookup-properties t)
1526 ;; Fix broken font-lock:
1527 (or (boundp 'font-lock-unfontify-region-function)
1528 (set 'font-lock-unfontify-region-function
1529 'font-lock-default-unfontify-region))
1530 (make-local-variable 'font-lock-unfontify-region-function)
1531 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1532 'cperl-font-lock-unfontify-region-function)
1533 (make-local-variable 'cperl-syntax-done-to)
1534 (make-local-variable 'font-lock-syntactic-keywords)
1535 (setq font-lock-syntactic-keywords
1536 (if cperl-syntaxify-by-font-lock
1537 '((cperl-fontify-syntaxically))
1538 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1539 ;; used to ignore syntax-table text-properties. (t) is a hack
1540 ;; to make font-lock think that font-lock-syntactic-keywords
1543 (make-local-variable 'cperl-old-style)
1544 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1545 (set (make-local-variable 'normal-auto-fill-function)
1546 'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
1547 (or (fboundp 'cperl-old-auto-fill-mode)
1549 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1550 (defun auto-fill-mode (&optional arg)
1552 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1553 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1554 (setq auto-fill-function 'cperl-do-auto-fill))))))
1555 (if (cperl-enable-font-lock)
1556 (if (cperl-val 'cperl-font-lock)
1557 (progn (or cperl-faces-init (cperl-init-faces))
1558 (font-lock-mode 1))))
1559 (and (boundp 'msb-menu-cond)
1560 (not cperl-msb-fixed)
1562 (if (featurep 'easymenu)
1563 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
1564 (run-mode-hooks 'cperl-mode-hook)
1565 ;; After hooks since fontification will break this
1566 (if cperl-pod-here-scan
1567 (or cperl-syntaxify-by-font-lock
1568 (progn (or cperl-faces-init (cperl-init-faces-weak))
1569 (cperl-find-pods-heres)))))
1571 ;; Fix for perldb - make default reasonable
1575 (perldb (read-from-minibuffer "Run perldb (like this): "
1576 (if (consp gud-perldb-history)
1577 (car gud-perldb-history)
1578 (concat "perl " ;;(file-name-nondirectory
1582 (buffer-file-name)))
1584 '(gud-perldb-history . 1))))
1586 (defun cperl-msb-fix ()
1587 ;; Adds perl files to msb menu, supposes that msb is already loaded
1588 (setq cperl-msb-fixed t)
1589 (let* ((l (length msb-menu-cond))
1590 (last (nth (1- l) msb-menu-cond))
1591 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1592 (handle (1- (nth 1 last))))
1593 (setcdr precdr (list
1595 '(memq major-mode '(cperl-mode perl-mode))
1600 ;; This is used by indent-for-comment
1601 ;; to decide how much to indent a comment in CPerl code
1602 ;; based on its context. Do fallback if comment is found wrong.
1604 (defvar cperl-wrong-comment)
1605 (defvar cperl-st-cfence '(14)) ; Comment-fence
1606 (defvar cperl-st-sfence '(15)) ; String-fence
1607 (defvar cperl-st-punct '(1))
1608 (defvar cperl-st-word '(2))
1609 (defvar cperl-st-bra '(4 . ?\>))
1610 (defvar cperl-st-ket '(5 . ?\<))
1613 (defun cperl-comment-indent ()
1614 (let ((p (point)) (c (current-column)) was phony)
1615 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
1616 ;; Wrong comment found
1618 (setq was (cperl-to-comment-or-eol)
1619 phony (eq (get-text-property (point) 'syntax-table)
1623 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1624 (if (eq (preceding-char) ?\#)
1629 (skip-chars-backward " \t")
1630 (max (1+ (current-column)) ; Else indent at comment column
1633 (insert comment-start)
1634 (backward-char (length comment-start)))
1635 (setq cperl-wrong-comment t)
1636 (indent-to comment-column 1) ; Indent minimum 1
1637 c))))) ; except leave at least one space.
1639 ;;;(defun cperl-comment-indent-fallback ()
1640 ;;; "Is called if the standard comment-search procedure fails.
1641 ;;;Point is at start of real comment."
1642 ;;; (let ((c (current-column)) target cnt prevc)
1643 ;;; (if (= c comment-column) nil
1644 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1645 ;;; (setq target (max (1+ (setq prevc
1646 ;;; (current-column))) ; Else indent at comment column
1647 ;;; comment-column))
1648 ;;; (if (= c comment-column) nil
1649 ;;; (delete-backward-char cnt)
1650 ;;; (while (< prevc target)
1652 ;;; (setq prevc (current-column)))
1653 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1654 ;;; (while (< prevc target)
1656 ;;; (setq prevc (current-column)))))))
1658 (defun cperl-indent-for-comment ()
1659 "Substitute for `indent-for-comment' in CPerl."
1661 (let (cperl-wrong-comment)
1662 (indent-for-comment)
1663 (if cperl-wrong-comment
1664 (progn (cperl-to-comment-or-eol)
1665 (forward-char (length comment-start))))))
1667 (defun cperl-comment-region (b e arg)
1668 "Comment or uncomment each line in the region in CPerl mode.
1669 See `comment-region'."
1670 (interactive "r\np")
1671 (let ((comment-start "#"))
1672 (comment-region b e arg)))
1674 (defun cperl-uncomment-region (b e arg)
1675 "Uncomment or comment each line in the region in CPerl mode.
1676 See `comment-region'."
1677 (interactive "r\np")
1678 (let ((comment-start "#"))
1679 (comment-region b e (- arg))))
1681 (defvar cperl-brace-recursing nil)
1683 (defun cperl-electric-brace (arg &optional only-before)
1684 "Insert character and correct line's indentation.
1685 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1686 place (even in empty line), but not after. If after \")\" and the inserted
1687 char is \"{\", insert extra newline before only if
1688 `cperl-extra-newline-before-brace'."
1691 (other-end (if (and cperl-electric-parens-mark
1697 (not cperl-brace-recursing)
1698 (cperl-val 'cperl-electric-parens)
1699 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
1700 ;; Need to insert a matching pair
1703 (setq insertpos (point-marker))
1704 (goto-char other-end)
1705 (setq last-command-char ?\{)
1706 (cperl-electric-lbrace arg insertpos))
1708 ;; Check whether we close something "usual" with `}'
1709 (if (and (eq last-command-char ?\})
1713 (up-list (- (prefix-numeric-value arg)))
1714 ;;(cperl-after-block-p (point-min))
1715 (or (cperl-after-expr-p nil "{;)")
1716 ;; after sub, else, continue
1717 (cperl-after-block-p nil 'pre)))
1719 ;; Just insert the guy
1720 (self-insert-command (prefix-numeric-value arg))
1721 (if (and (not arg) ; No args, end (of empty line or auto)
1723 (or (and (null only-before)
1725 (skip-chars-backward " \t")
1727 (and (eq last-command-char ?\{) ; Do not insert newline
1728 ;; if after ")" and `cperl-extra-newline-before-brace'
1729 ;; is nil, do not insert extra newline.
1730 (not cperl-extra-newline-before-brace)
1732 (skip-chars-backward " \t")
1733 (eq (preceding-char) ?\))))
1734 (if cperl-auto-newline
1735 (progn (cperl-indent-line) (newline) t) nil)))
1737 (self-insert-command (prefix-numeric-value arg))
1739 (if cperl-auto-newline
1740 (setq insertpos (1- (point))))
1741 (if (and cperl-auto-newline (null only-before))
1744 (cperl-indent-line)))
1746 (if insertpos (progn (goto-char insertpos)
1747 (search-forward (make-string
1748 1 last-command-char))
1749 (setq insertpos (1- (point)))))
1753 (goto-char insertpos)
1754 (self-insert-command (prefix-numeric-value arg)))
1755 (self-insert-command (prefix-numeric-value arg)))))))
1757 (defun cperl-electric-lbrace (arg &optional end)
1758 "Insert character, correct line's indentation, correct quoting by space."
1760 (let ((cperl-brace-recursing t)
1761 (cperl-auto-newline cperl-auto-newline)
1763 (if (and cperl-electric-parens-mark
1771 (and (cperl-val 'cperl-electric-lbrace-space)
1772 (eq (preceding-char) ?$)
1774 (skip-chars-backward "$")
1775 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
1777 ;; Check whether we are in comment
1781 (not (looking-at "[ \t]*#")))
1782 (cperl-after-expr-p nil "{;)"))
1784 (setq cperl-auto-newline nil))
1785 (cperl-electric-brace arg)
1786 (and (cperl-val 'cperl-electric-parens)
1787 (eq last-command-char ?{)
1788 (memq last-command-char
1789 (append cperl-electric-parens-string nil))
1790 (or (if other-end (goto-char (marker-position other-end)))
1792 (setq last-command-char ?} pos (point))
1793 (progn (cperl-electric-brace arg t)
1796 (defun cperl-electric-paren (arg)
1797 "Insert an opening parenthesis or a matching pair of parentheses.
1798 See `cperl-electric-parens'."
1800 (let ((beg (save-excursion (beginning-of-line) (point)))
1801 (other-end (if (and cperl-electric-parens-mark
1808 (if (and (cperl-val 'cperl-electric-parens)
1809 (memq last-command-char
1810 (append cperl-electric-parens-string nil))
1811 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1812 ;;(not (save-excursion (search-backward "#" beg t)))
1813 (if (eq last-command-char ?<)
1815 (and abbrev-mode ; later it is too late, may be after `for'
1817 (cperl-after-expr-p nil "{;(,:="))
1820 (self-insert-command (prefix-numeric-value arg))
1821 (if other-end (goto-char (marker-position other-end)))
1822 (insert (make-string
1823 (prefix-numeric-value arg)
1824 (cdr (assoc last-command-char '((?{ .?})
1828 (forward-char (- (prefix-numeric-value arg))))
1829 (self-insert-command (prefix-numeric-value arg)))))
1831 (defun cperl-electric-rparen (arg)
1832 "Insert a matching pair of parentheses if marking is active.
1833 If not, or if we are not at the end of marking range, would self-insert.
1834 Affected by `cperl-electric-parens'."
1836 (let ((beg (save-excursion (beginning-of-line) (point)))
1837 (other-end (if (and cperl-electric-parens-mark
1838 (cperl-val 'cperl-electric-parens)
1839 (memq last-command-char
1840 (append cperl-electric-parens-string nil))
1847 (cperl-val 'cperl-electric-parens)
1848 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
1849 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1850 ;;(not (save-excursion (search-backward "#" beg t)))
1853 (self-insert-command (prefix-numeric-value arg))
1855 (if other-end (goto-char other-end))
1856 (insert (make-string
1857 (prefix-numeric-value arg)
1858 (cdr (assoc last-command-char '((?\} . ?\{)
1863 (self-insert-command (prefix-numeric-value arg)))))
1865 (defun cperl-electric-keyword ()
1866 "Insert a construction appropriate after a keyword.
1867 Help message may be switched off by setting `cperl-message-electric-keyword'
1869 (let ((beg (save-excursion (beginning-of-line) (point)))
1870 (dollar (and (eq last-command-char ?$)
1871 (eq this-command 'self-insert-command)))
1872 (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1873 (memq this-command '(self-insert-command newline))))
1875 (and (save-excursion
1879 (setq do (looking-at "do\\>")))
1881 (cperl-after-expr-p nil "{;:"))
1885 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
1887 (save-excursion (or (not (re-search-backward "^=" nil t))
1890 (and cperl-use-syntax-table-text-property
1891 (not (eq (get-text-property (point)
1894 (save-excursion (forward-sexp -1)
1895 (not (memq (following-char) (append "$@%&*" nil))))
1897 (and (eq (preceding-char) ?y)
1898 (progn ; "foreachmy"
1904 (memq this-command '(self-insert-command newline)))))
1905 (and dollar (insert " $"))
1907 ;;(insert " () {\n}")
1909 (cperl-extra-newline-before-brace
1910 (insert (if do "\n" " ()\n"))
1916 (and do (insert " while ();")))
1918 (insert (if do " {\n} while ();" " () {\n}"))))
1919 (or (looking-at "[ \t]\\|$") (insert " "))
1921 (if dollar (progn (search-backward "$")
1925 (search-backward ")")
1926 (if (eq last-command-char ?\()
1927 (progn ; Avoid "if (())"
1928 (delete-backward-char 1)
1929 (delete-backward-char -1))))
1931 (cperl-putback-char cperl-del-back-ch))
1932 (if cperl-message-electric-keyword
1933 (message "Precede char by C-q to avoid expansion"))))))
1935 (defun cperl-ensure-newlines (n &optional pos)
1936 "Make sure there are N newlines after the point."
1937 (or pos (setq pos (point)))
1938 (if (looking-at "\n")
1942 (cperl-ensure-newlines (1- n) pos)
1945 (defun cperl-electric-pod ()
1946 "Insert a POD chunk appropriate after a =POD directive."
1947 (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1948 (memq this-command '(self-insert-command newline))))
1949 head1 notlast name p really-delete over)
1950 (and (save-excursion
1953 (eq (preceding-char) ?=)
1955 (setq head1 (looking-at "head1\\>[ \t]*$"))
1956 (setq over (and (looking-at "over\\>[ \t]*$")
1957 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
1961 (get-text-property (point) 'in-pod)
1962 (cperl-after-expr-p nil "{;:")
1963 (and (re-search-backward
1964 ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
1965 "\\(\\`\n?\\|^\n\\)=\\sw+"
1969 (and cperl-use-syntax-table-text-property
1970 (not (eq (get-text-property (point) 'syntax-type)
1974 (setq notlast (re-search-forward "^\n=" nil t)))
1978 (cperl-ensure-newlines 2)
1984 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
1985 nil t)))) ; Only one
1988 (setq name (file-name-sans-extension
1989 (file-name-nondirectory (buffer-file-name)))
1991 (insert " NAME\n\n" name
1992 " - \n\n=head1 SYNOPSIS\n\n\n\n"
1993 "=head1 DESCRIPTION")
1994 (cperl-ensure-newlines 4)
1998 (setq really-delete t))
2003 (insert "\n\n=item \n\n\n\n"
2005 (cperl-ensure-newlines 2)
2009 (setq really-delete t)))
2010 (if (and delete really-delete)
2011 (cperl-putback-char cperl-del-back-ch))))))
2013 (defun cperl-electric-else ()
2014 "Insert a construction appropriate after a keyword.
2015 Help message may be switched off by setting `cperl-message-electric-keyword'
2017 (let ((beg (save-excursion (beginning-of-line) (point))))
2018 (and (save-excursion
2020 (cperl-after-expr-p nil "{;:"))
2024 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2026 (save-excursion (or (not (re-search-backward "^=" nil t))
2028 (and cperl-use-syntax-table-text-property
2029 (not (eq (get-text-property (point)
2034 ;;(insert " {\n\n}")
2036 (cperl-extra-newline-before-brace
2042 (insert " {\n\n}")))
2043 (or (looking-at "[ \t]\\|$") (insert " "))
2047 (cperl-putback-char cperl-del-back-ch)
2048 (setq this-command 'cperl-electric-else)
2049 (if cperl-message-electric-keyword
2050 (message "Precede char by C-q to avoid expansion"))))))
2052 (defun cperl-linefeed ()
2053 "Go to end of line, open a new line and indent appropriately.
2054 If in POD, insert appropriate lines."
2056 (let ((beg (save-excursion (beginning-of-line) (point)))
2057 (end (save-excursion (end-of-line) (point)))
2058 (pos (point)) start over cut res)
2059 (if (and ; Check if we need to split:
2060 ; i.e., on a boundary and inside "{...}"
2061 (save-excursion (cperl-to-comment-or-eol)
2062 (>= (point) pos)) ; Not in a comment
2064 (skip-chars-backward " \t" beg)
2066 (looking-at "[;{]")) ; After { or ; + spaces
2067 (looking-at "[ \t]*}") ; Before }
2068 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2071 (eq (car (parse-partial-sexp pos end -1)) -1)
2072 ; Leave the level of parens
2073 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2075 (cperl-after-block-p (point-min))
2078 (setq start (point-marker))
2079 (<= start pos))))) ; Redundant? Are after the
2080 ; start of parens group.
2082 (skip-chars-backward " \t")
2083 (or (memq (preceding-char) (append ";{" nil))
2089 (or (looking-at "{[ \t]*$") ; If there is a statement
2090 ; before, move it to separate line
2094 (cperl-indent-line)))
2095 (forward-line 1) ; We are on the target line
2098 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2099 ; after, move it to separate line
2102 (search-backward "}" beg)
2103 (skip-chars-backward " \t")
2104 (or (memq (preceding-char) (append ";{" nil))
2109 (forward-line -1) ; We are on the line before target
2111 (newline-and-indent))
2112 (end-of-line) ; else - no splitting
2114 ((and (looking-at "\n[ \t]*{$")
2116 (skip-chars-backward " \t")
2117 (eq (preceding-char) ?\)))) ; Probably if () {} group
2118 ; with an extra newline.
2120 (cperl-indent-line))
2121 ((save-excursion ; In POD header
2122 (forward-paragraph -1)
2123 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2124 ;; We are after \n now, so look for the rest
2125 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2127 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2128 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2132 (forward-paragraph -1)
2135 (setq cut (buffer-substring (point)
2139 (delete-char (- (save-excursion (end-of-line) (point))
2141 (setq res (expand-abbrev))
2147 (cperl-ensure-newlines (if cut 2 4))
2149 ((get-text-property (point) 'in-pod) ; In POD section
2150 (cperl-ensure-newlines 4)
2152 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2154 (cperl-indent-line))
2156 (newline-and-indent))))))
2158 (defun cperl-electric-semi (arg)
2159 "Insert character and correct line's indentation."
2161 (if cperl-auto-newline
2162 (cperl-electric-terminator arg)
2163 (self-insert-command (prefix-numeric-value arg))
2164 (if cperl-autoindent-on-semi
2165 (cperl-indent-line))))
2167 (defun cperl-electric-terminator (arg)
2168 "Insert character and correct line's indentation."
2171 (auto (and cperl-auto-newline
2172 (or (not (eq last-command-char ?:))
2173 cperl-auto-newline-after-colon)))
2175 (if (and ;;(not arg)
2177 (not (save-excursion
2179 (skip-chars-forward " \t")
2181 ;; Ignore in comment lines
2182 (= (following-char) ?#)
2183 ;; Colon is special only after a label
2184 ;; So quickly rule out most other uses of colon
2185 ;; and do no indentation for them.
2186 (and (eq last-command-char ?:)
2189 (skip-chars-forward " \t")
2190 (and (< (point) end)
2191 (progn (goto-char (- end 1))
2192 (not (looking-at ":"))))))
2194 (beginning-of-defun)
2195 (let ((pps (parse-partial-sexp (point) end)))
2196 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2198 (self-insert-command (prefix-numeric-value arg))
2200 (if auto (setq insertpos (point-marker)))
2206 (cperl-indent-line)))
2208 (if insertpos (goto-char (1- (marker-position insertpos)))
2213 (goto-char insertpos)
2214 (self-insert-command (prefix-numeric-value arg)))
2215 (self-insert-command (prefix-numeric-value arg)))))
2217 (defun cperl-electric-backspace (arg)
2218 "Backspace, or remove the whitespace around the point inserted by an electric
2219 key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2221 (if (and cperl-auto-newline
2222 (memq last-command '(cperl-electric-semi
2223 cperl-electric-terminator
2224 cperl-electric-lbrace))
2225 (memq (preceding-char) '(?\ ?\t ?\n)))
2227 (if (eq last-command 'cperl-electric-lbrace)
2228 (skip-chars-forward " \t\n"))
2230 (skip-chars-backward " \t\n")
2231 (delete-region (point) p))
2232 (and (eq last-command 'cperl-electric-else)
2233 ;; We are removing the whitespace *inside* cperl-electric-else
2234 (setq this-command 'cperl-electric-else-really))
2235 (if (and cperl-auto-newline
2236 (eq last-command 'cperl-electric-else-really)
2237 (memq (preceding-char) '(?\ ?\t ?\n)))
2239 (skip-chars-forward " \t\n")
2241 (skip-chars-backward " \t\n")
2242 (delete-region (point) p))
2243 (if cperl-electric-backspace-untabify
2244 (backward-delete-char-untabify arg)
2245 (delete-backward-char arg)))))
2247 (put 'cperl-electric-backspace 'delete-selection 'supersede)
2249 (defun cperl-inside-parens-p ()
2253 (narrow-to-region (point)
2254 (progn (beginning-of-defun) (point)))
2255 (goto-char (point-max))
2256 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2259 (defun cperl-indent-command (&optional whole-exp)
2260 "Indent current line as Perl code, or in some cases insert a tab character.
2261 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2262 line. Otherwise, indent the current line only if point is at the left margin
2263 or in the line's indentation; otherwise insert a tab.
2265 A numeric argument, regardless of its value,
2266 means indent rigidly all the lines of the expression starting after point
2267 so that this line becomes properly indented.
2268 The relative indentation among the lines of the expression are preserved."
2270 (cperl-update-syntaxification (point) (point))
2272 ;; If arg, always indent this line as Perl
2273 ;; and shift remaining lines of expression the same amount.
2274 (let ((shift-amt (cperl-indent-line))
2277 (if cperl-tab-always-indent
2278 (beginning-of-line))
2285 (if (and shift-amt (> end beg))
2286 (indent-code-rigidly beg end shift-amt "#")))
2287 (if (and (not cperl-tab-always-indent)
2289 (skip-chars-backward " \t")
2292 (cperl-indent-line))))
2294 (defun cperl-indent-line (&optional parse-data)
2295 "Indent current line as Perl code.
2296 Return the amount the indentation changed by."
2297 (let ((case-fold-search nil)
2298 (pos (- (point-max) (point)))
2299 indent i beg shift-amt)
2300 (setq indent (cperl-calculate-indent parse-data)
2304 (cond ((or (eq indent nil) (eq indent t))
2305 (setq indent (current-indentation) i nil))
2306 ;;((eq indent t) ; Never?
2307 ;; (setq indent (cperl-calculate-indent-within-comment)))
2308 ;;((looking-at "[ \t]*#")
2311 (skip-chars-forward " \t")
2312 (if (listp indent) (setq indent (car indent)))
2313 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2315 (setq indent (max cperl-min-label-indent
2316 (+ indent cperl-label-offset)))))
2317 ((= (following-char) ?})
2318 (setq indent (- indent cperl-indent-level)))
2319 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2320 (setq indent (+ indent cperl-close-paren-offset)))
2321 ((= (following-char) ?{)
2322 (setq indent (+ indent cperl-brace-offset))))))
2323 (skip-chars-forward " \t")
2324 (setq shift-amt (and i (- indent (current-column))))
2325 (if (or (not shift-amt)
2327 (if (> (- (point-max) pos) (point))
2328 (goto-char (- (point-max) pos)))
2329 (delete-region beg (point))
2331 ;; If initial point was within line's indentation,
2332 ;; position after the indentation. Else stay at same point in text.
2333 (if (> (- (point-max) pos) (point))
2334 (goto-char (- (point-max) pos))))
2337 (defun cperl-after-label ()
2338 ;; Returns true if the point is after label. Does not do save-excursion.
2339 (and (eq (preceding-char) ?:)
2340 (memq (char-syntax (char-after (- (point) 2)))
2344 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2346 (defun cperl-get-state (&optional parse-start start-state)
2347 ;; returns list (START STATE DEPTH PRESTART),
2348 ;; START is a good place to start parsing, or equal to
2349 ;; PARSE-START if preset,
2350 ;; STATE is what is returned by `parse-partial-sexp'.
2351 ;; DEPTH is true is we are immediately after end of block
2352 ;; which contains START.
2353 ;; PRESTART is the position basing on which START was found.
2355 (let ((start-point (point)) depth state start prestart)
2356 (if (and parse-start
2357 (<= parse-start start-point))
2358 (goto-char parse-start)
2359 (beginning-of-defun)
2360 (setq start-state nil))
2361 (setq prestart (point))
2363 ;; Try to go out, if sub is not on the outermost level
2364 (while (< (point) start-point)
2365 (setq start (point) parse-start start depth nil
2366 state (parse-partial-sexp start start-point -1))
2367 (if (> (car state) -1) nil
2368 ;; The current line could start like }}}, so the indentation
2369 ;; corresponds to a different level than what we reached
2371 (beginning-of-line 2))) ; Go to the next line.
2372 (if start (goto-char start))) ; Not at the start of file
2373 (setq start (point))
2374 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2375 (list start state depth prestart))))
2377 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
2378 ;; Positions is before ?\{. Checks whether it starts a block.
2379 ;; No save-excursion!
2380 (cperl-backward-to-noncomment (point-min))
2381 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
2382 ; Label may be mixed up with `$blah :'
2383 (save-excursion (cperl-after-label))
2384 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2387 ;; Need take into account `bless', `return', `tr',...
2388 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
2389 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
2391 (skip-chars-backward " \t\n\f")
2392 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2396 "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
2398 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2400 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
2401 "Return appropriate indentation for current line as Perl code.
2402 In usual case returns an integer: the column to indent to.
2403 Returns nil if line starts inside a string, t if in a comment.
2405 Will not correct the indentation for labels, but will correct it for braces
2406 and closing parentheses and brackets."
2407 (cperl-update-syntaxification (point) (point))
2410 (and (memq (get-text-property (point) 'syntax-type)
2411 '(pod here-doc here-doc-delim format))
2412 (not (get-text-property (point) 'indentable)))
2413 ;; before start of POD - whitespace found since do not have 'pod!
2414 (and (looking-at "[ \t]*\n=")
2415 (error "Spaces before POD section!"))
2416 (and (not cperl-indent-left-aligned-comments)
2420 (let ((indent-point (point))
2421 (char-after (save-excursion
2422 (skip-chars-forward " \t")
2424 (in-pod (get-text-property (point) 'in-pod))
2425 (pre-indent-point (point))
2426 p prop look-prop is-block delim)
2429 ;; In the verbatim part, probably code example. What to do???
2434 (cperl-backward-to-noncomment nil)
2435 (setq p (max (point-min) (1- (point)))
2436 prop (get-text-property p 'syntax-type)
2437 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2439 (if (memq prop '(pod here-doc format here-doc-delim))
2441 (goto-char (or (previous-single-property-change p look-prop)
2444 (setq pre-indent-point (point)))))))
2445 (goto-char pre-indent-point)
2446 (let* ((case-fold-search nil)
2447 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2448 (start (or (nth 2 parse-data)
2451 (containing-sexp (car (cdr state)))
2454 ;;containing-sexp ;; We are buggy at toplevel :-(
2457 (setcar parse-data pre-indent-point)
2458 (setcar (cdr parse-data) state)
2459 (or (nth 2 parse-data)
2460 (setcar (cddr parse-data) start))
2461 ;; Before this point: end of statement
2462 (setq old-indent (nth 3 parse-data))))
2463 (cond ((get-text-property (point) 'indentable)
2464 ;; indent to just after the surrounding open,
2465 ;; skip blanks if we do not close the expression.
2466 (goto-char (1+ (previous-single-property-change (point) 'indentable)))
2467 (or (memq char-after (append ")]}" nil))
2468 (looking-at "[ \t]*\\(#\\|$\\)")
2469 (skip-chars-forward " \t"))
2471 ((or (nth 3 state) (nth 4 state))
2472 ;; return nil or t if should not change this line
2474 ;; XXXX Do we need to special-case this?
2475 ((null containing-sexp)
2476 ;; Line is at top level. May be data or function definition,
2477 ;; or may be function argument declaration.
2478 ;; Indent like the previous top level line
2479 ;; unless that ends in a closeparen without semicolon,
2480 ;; in which case this line is the first argument decl.
2481 (skip-chars-forward " \t")
2484 (- (current-indentation)
2485 (if (nth 2 s-s) cperl-indent-level 0)))
2486 (if (= char-after ?{) cperl-continued-brace-offset 0)
2488 (cperl-backward-to-noncomment (or old-indent (point-min)))
2489 ;; Look at previous line that's at column 0
2490 ;; to determine whether we are in top-level decls
2491 ;; or function's arg decls. Set basic-indent accordingly.
2492 ;; Now add a little if this is a continuation line.
2494 (eq (point) old-indent) ; old-indent was at comment
2495 (eq (preceding-char) ?\;)
2497 (and (eq (preceding-char) ?\})
2498 (cperl-after-block-and-statement-beg
2499 (point-min))) ; Was start - too close
2500 (memq char-after (append ")]}" nil))
2501 (and (eq (preceding-char) ?\:) ; label
2504 (skip-chars-backward " \t")
2505 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2506 (get-text-property (point) 'first-format-line))
2509 (not (eq char-after ?\C-j)))
2510 (setcdr (cddr parse-data)
2511 (list pre-indent-point)))
2513 cperl-continued-statement-offset))))
2516 (and (setq delim (= (char-after containing-sexp) ?{))
2517 (save-excursion ; Is it a hash?
2518 (goto-char containing-sexp)
2520 cperl-indent-parens-as-block))
2521 ;; group is an expression, not a block:
2522 ;; indent to just after the surrounding open parens,
2523 ;; skip blanks if we do not close the expression.
2524 (goto-char (1+ containing-sexp))
2525 (or (memq char-after
2526 (append (if delim "}" ")]}") nil))
2527 (looking-at "[ \t]*\\(#\\|$\\)")
2528 (skip-chars-forward " \t"))
2531 (eq char-after ?\}))
2532 ;; Correct indentation of trailing ?\}
2533 (+ cperl-indent-level cperl-close-paren-offset)
2535 ;;; ((and (/= (char-after containing-sexp) ?{)
2536 ;;; (not cperl-indent-parens-as-block))
2537 ;;; ;; line is expression, not statement:
2538 ;;; ;; indent to just after the surrounding open,
2539 ;;; ;; skip blanks if we do not close the expression.
2540 ;;; (goto-char (1+ containing-sexp))
2541 ;;; (or (memq char-after (append ")]}" nil))
2542 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2543 ;;; (skip-chars-forward " \t"))
2544 ;;; (current-column))
2546 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
2547 ;;; (goto-char containing-sexp)
2548 ;;; (and (not (cperl-block-p))
2549 ;;; (not cperl-indent-parens-as-block)))
2550 ;;; (goto-char (1+ containing-sexp))
2551 ;;; (or (eq char-after ?\})
2552 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2553 ;;; (skip-chars-forward " \t"))
2554 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
2555 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
2556 ;;; cperl-close-paren-offset)
2559 ;; Statement level. Is it a continuation or a new statement?
2560 ;; Find previous non-comment character.
2561 (goto-char pre-indent-point)
2562 (cperl-backward-to-noncomment containing-sexp)
2563 ;; Back up over label lines, since they don't
2564 ;; affect whether our line is a continuation.
2566 (while ;;(or (eq (preceding-char) ?\,)
2567 (and (eq (preceding-char) ?:)
2568 (or ;;(eq (char-after (- (point) 2)) ?\') ; ????
2569 (memq (char-syntax (char-after (- (point) 2)))
2572 (if (eq (preceding-char) ?\,)
2573 ;; Will go to beginning of line, essentially.
2574 ;; Will ignore embedded sexpr XXXX.
2575 (cperl-backward-to-start-of-continued-exp containing-sexp))
2577 (cperl-backward-to-noncomment containing-sexp))
2578 ;; Now we get the answer.
2579 (if (not (or (eq (1- (point)) containing-sexp)
2580 (memq (preceding-char)
2581 (append (if is-block " ;{" " ,;{") '(nil)))
2582 (and (eq (preceding-char) ?\})
2583 (cperl-after-block-and-statement-beg
2585 (get-text-property (point) 'first-format-line)))
2586 ;; This line is continuation of preceding line's statement;
2587 ;; indent `cperl-continued-statement-offset' more than the
2588 ;; previous line of the statement.
2590 ;; There might be a label on this line, just
2591 ;; consider it bad style and ignore it.
2593 (cperl-backward-to-start-of-continued-exp containing-sexp)
2594 (+ (if (memq char-after (append "}])" nil))
2596 cperl-continued-statement-offset)
2599 (not (eq char-after ?\})))
2601 ;; Now it is a hash reference
2602 (+ cperl-indent-level cperl-close-paren-offset))
2603 (if (looking-at "\\w+[ \t]*:")
2604 (if (> (current-indentation) cperl-min-label-indent)
2605 (- (current-indentation) cperl-label-offset)
2606 ;; Do not move `parse-data', this should
2607 ;; be quick anyway (this comment comes
2608 ;; from different location):
2609 (cperl-calculate-indent))
2611 (if (eq char-after ?\{)
2612 cperl-continued-brace-offset 0)))
2613 ;; This line starts a new statement.
2614 ;; Position following last unclosed open.
2615 (goto-char containing-sexp)
2616 ;; Is line first statement after an open-brace?
2618 ;; If no, find that first statement and indent like
2619 ;; it. If the first statement begins with label, do
2620 ;; not believe when the indentation of the label is too
2624 (setq old-indent (current-indentation))
2625 (let ((colon-line-end 0))
2627 (progn (skip-chars-forward " \t\n")
2628 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
2629 ;; Skip over comments and labels following openbrace.
2630 (cond ((= (following-char) ?\#)
2632 ((= (following-char) ?\=)
2634 (or (next-single-property-change (point) 'in-pod)
2635 (point-max)))) ; do not loop if no syntaxification
2638 (save-excursion (end-of-line)
2639 (setq colon-line-end (point)))
2640 (search-forward ":"))))
2641 ;; The first following code counts
2642 ;; if it is before the line we want to indent.
2643 (and (< (point) indent-point)
2644 (if (> colon-line-end (point)) ; After label
2645 (if (> (current-indentation)
2646 cperl-min-label-indent)
2647 (- (current-indentation) cperl-label-offset)
2648 ;; Do not believe: `max' is involved
2649 (+ old-indent cperl-indent-level))
2650 (current-column)))))
2651 ;; If no previous statement,
2652 ;; indent it relative to line brace is on.
2653 ;; For open brace in column zero, don't let statement
2654 ;; start there too. If cperl-indent-level is zero,
2655 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2656 ;; For open-braces not the first thing in a line,
2657 ;; add in cperl-brace-imaginary-offset.
2659 ;; If first thing on a line: ?????
2660 (+ (if (and (bolp) (zerop cperl-indent-level))
2661 (+ cperl-brace-offset cperl-continued-statement-offset)
2665 (not (eq char-after ?\})))
2667 ;; Now it is a hash reference
2668 (+ cperl-indent-level cperl-close-paren-offset))
2669 ;; Move back over whitespace before the openbrace.
2670 ;; If openbrace is not first nonwhite thing on the line,
2671 ;; add the cperl-brace-imaginary-offset.
2672 (progn (skip-chars-backward " \t")
2673 (if (bolp) 0 cperl-brace-imaginary-offset))
2674 ;; If the openbrace is preceded by a parenthesized exp,
2675 ;; move to the beginning of that;
2676 ;; possibly a different line
2678 (if (eq (preceding-char) ?\))
2680 ;; In the case it starts a subroutine, indent with
2681 ;; respect to `sub', not with respect to the
2682 ;; first thing on the line, say in the case of
2683 ;; anonymous sub in a hash.
2685 (skip-chars-backward " \t")
2686 (if (and (eq (preceding-char) ?b)
2689 (looking-at "sub\\>"))
2693 (save-excursion (beginning-of-line) (point))
2695 (progn (goto-char (1+ old-indent))
2696 (skip-chars-forward " \t")
2698 ;; Get initial indentation of the line we are on.
2699 ;; If line starts with label, calculate label indentation
2702 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2703 (if (> (current-indentation) cperl-min-label-indent)
2704 (- (current-indentation) cperl-label-offset)
2705 ;; Do not move `parse-data', this should
2707 (cperl-calculate-indent))
2708 (current-indentation))))))))))))))
2710 ;; (defvar cperl-indent-alist
2714 ;; (toplevel-after-parenth 2)
2715 ;; (toplevel-continued 2)
2717 ;; "Alist of indentation rules for CPerl mode.
2719 ;; nil: do not indent;
2720 ;; number: add this amount of indentation.
2722 ;; Not finished, not used.")
2724 ;; (defun cperl-where-am-i (&optional parse-start start-state)
2726 ;; "Return a list of lists ((TYPE POS)...) of good points before the point.
2727 ;; ;; POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2729 ;; ;; Not finished, not used."
2731 ;; (let* ((start-point (point))
2732 ;; (s-s (cperl-get-state))
2733 ;; (start (nth 0 s-s))
2734 ;; (state (nth 1 s-s))
2735 ;; (prestart (nth 3 s-s))
2736 ;; (containing-sexp (car (cdr state)))
2737 ;; (case-fold-search nil)
2738 ;; (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
2739 ;; (cond ((nth 3 state) ; In string
2740 ;; (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
2741 ;; ((nth 4 state) ; In comment
2742 ;; (setq res (cons '(comment) res)))
2743 ;; ((null containing-sexp)
2744 ;; ;; Line is at top level.
2745 ;; ;; Indent like the previous top level line
2746 ;; ;; unless that ends in a closeparen without semicolon,
2747 ;; ;; in which case this line is the first argument decl.
2748 ;; (cperl-backward-to-noncomment (or parse-start (point-min)))
2749 ;; ;;(skip-chars-backward " \t\f\n")
2752 ;; (memq (preceding-char) (append ";}" nil)))
2753 ;; (setq res (cons (list 'toplevel start) res)))
2754 ;; ((eq (preceding-char) ?\) )
2755 ;; (setq res (cons (list 'toplevel-after-parenth start) res)))
2757 ;; (setq res (cons (list 'toplevel-continued start) res)))))
2758 ;; ((/= (char-after containing-sexp) ?{)
2759 ;; ;; line is expression, not statement:
2760 ;; ;; indent to just after the surrounding open.
2761 ;; ;; skip blanks if we do not close the expression.
2762 ;; (setq res (cons (list 'expression-blanks
2764 ;; (goto-char (1+ containing-sexp))
2765 ;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2766 ;; (skip-chars-forward " \t"))
2768 ;; (cons (list 'expression containing-sexp) res))))
2770 ;; ;; Containing-expr starts with \{. Check whether it is a hash.
2771 ;; (goto-char containing-sexp)
2772 ;; (not (cperl-block-p)))
2773 ;; (setq res (cons (list 'expression-blanks
2775 ;; (goto-char (1+ containing-sexp))
2776 ;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2777 ;; (skip-chars-forward " \t"))
2779 ;; (cons (list 'expression containing-sexp) res))))
2781 ;; ;; Statement level.
2782 ;; (setq res (cons (list 'in-block containing-sexp) res))
2783 ;; ;; Is it a continuation or a new statement?
2784 ;; ;; Find previous non-comment character.
2785 ;; (cperl-backward-to-noncomment containing-sexp)
2786 ;; ;; Back up over label lines, since they don't
2787 ;; ;; affect whether our line is a continuation.
2788 ;; ;; Back up comma-delimited lines too ?????
2789 ;; (while (or (eq (preceding-char) ?\,)
2790 ;; (save-excursion (cperl-after-label)))
2791 ;; (if (eq (preceding-char) ?\,)
2792 ;; ;; Will go to beginning of line, essentially
2793 ;; ;; Will ignore embedded sexpr XXXX.
2794 ;; (cperl-backward-to-start-of-continued-exp containing-sexp))
2795 ;; (beginning-of-line)
2796 ;; (cperl-backward-to-noncomment containing-sexp))
2797 ;; ;; Now we get the answer.
2798 ;; (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
2799 ;; ;; This line is continuation of preceding line's statement.
2800 ;; (list (list 'statement-continued containing-sexp))
2801 ;; ;; This line starts a new statement.
2802 ;; ;; Position following last unclosed open.
2803 ;; (goto-char containing-sexp)
2804 ;; ;; Is line first statement after an open-brace?
2806 ;; ;; If no, find that first statement and indent like
2807 ;; ;; it. If the first statement begins with label, do
2808 ;; ;; not believe when the indentation of the label is too
2812 ;; (let ((colon-line-end 0))
2813 ;; (while (progn (skip-chars-forward " \t\n" start-point)
2814 ;; (and (< (point) start-point)
2816 ;; "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
2817 ;; ;; Skip over comments and labels following openbrace.
2818 ;; (cond ((= (following-char) ?\#)
2819 ;; ;;(forward-line 1)
2823 ;; (save-excursion (end-of-line)
2824 ;; (setq colon-line-end (point)))
2825 ;; (search-forward ":"))))
2826 ;; ;; Now at the point, after label, or at start
2827 ;; ;; of first statement in the block.
2828 ;; (and (< (point) start-point)
2829 ;; (if (> colon-line-end (point))
2830 ;; ;; Before statement after label
2831 ;; (if (> (current-indentation)
2832 ;; cperl-min-label-indent)
2833 ;; (list (list 'label-in-block (point)))
2834 ;; ;; Do not believe: `max' is involved
2836 ;; (list 'label-in-block-min-indent (point))))
2837 ;; ;; Before statement
2838 ;; (list 'statement-in-block (point))))))
2839 ;; ;; If no previous statement,
2840 ;; ;; indent it relative to line brace is on.
2841 ;; ;; For open brace in column zero, don't let statement
2842 ;; ;; start there too. If cperl-indent-level is zero,
2843 ;; ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2844 ;; ;; For open-braces not the first thing in a line,
2845 ;; ;; add in cperl-brace-imaginary-offset.
2847 ;; ;; If first thing on a line: ?????
2848 ;; (+ (if (and (bolp) (zerop cperl-indent-level))
2849 ;; (+ cperl-brace-offset cperl-continued-statement-offset)
2850 ;; cperl-indent-level)
2851 ;; ;; Move back over whitespace before the openbrace.
2852 ;; ;; If openbrace is not first nonwhite thing on the line,
2853 ;; ;; add the cperl-brace-imaginary-offset.
2854 ;; (progn (skip-chars-backward " \t")
2855 ;; (if (bolp) 0 cperl-brace-imaginary-offset))
2856 ;; ;; If the openbrace is preceded by a parenthesized exp,
2857 ;; ;; move to the beginning of that;
2858 ;; ;; possibly a different line
2860 ;; (if (eq (preceding-char) ?\))
2861 ;; (forward-sexp -1))
2862 ;; ;; Get initial indentation of the line we are on.
2863 ;; ;; If line starts with label, calculate label indentation
2864 ;; (if (save-excursion
2865 ;; (beginning-of-line)
2866 ;; (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2867 ;; (if (> (current-indentation) cperl-min-label-indent)
2868 ;; (- (current-indentation) cperl-label-offset)
2869 ;; (cperl-calculate-indent))
2870 ;; (current-indentation))))))))
2873 (defun cperl-calculate-indent-within-comment ()
2874 "Return the indentation amount for line, assuming that
2875 the current line is to be regarded as part of a block comment."
2876 (let (end star-start)
2879 (skip-chars-forward " \t")
2881 (and (= (following-char) ?#)
2883 (cperl-to-comment-or-eol)
2889 (defun cperl-to-comment-or-eol ()
2890 "Go to position before comment on the current line, or to end of line.
2891 Returns true if comment is found."
2892 (let (state stop-in cpoint (lim (progn (end-of-line) (point))))
2895 (eq (get-text-property (point) 'syntax-type) 'pod)
2896 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t))
2897 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
2899 (while (not stop-in)
2900 (setq state (parse-partial-sexp (point) lim nil nil nil t))
2902 ;; If fails (beginning-of-line inside sexp), then contains not-comment
2903 (if (nth 4 state) ; After `#';
2904 ; (nth 2 state) can be
2905 ; beginning of m,s,qq and so
2909 (setq cpoint (point))
2910 (goto-char (nth 2 state))
2912 ((looking-at "\\(s\\|tr\\)\\>")
2913 (or (re-search-forward
2914 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
2917 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
2918 (or (re-search-forward
2919 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
2922 (t ; It was fair comment
2923 (setq stop-in t) ; Finish
2924 (goto-char (1- cpoint)))))
2925 (setq stop-in t) ; Finish
2927 (setq stop-in t))) ; Finish
2930 (defsubst cperl-1- (p)
2931 (max (point-min) (1- p)))
2933 (defsubst cperl-1+ (p)
2934 (min (point-max) (1+ p)))
2936 (defsubst cperl-modify-syntax-type (at how)
2937 (if (< at (point-max))
2939 (put-text-property at (1+ at) 'syntax-table how)
2940 (put-text-property at (1+ at) 'rear-nonsticky t))))
2942 (defun cperl-protect-defun-start (s e)
2943 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2946 (while (re-search-forward "^\\s(" e 'to-end)
2947 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
2949 (defun cperl-commentify (bb e string &optional noface)
2950 (if cperl-use-syntax-table-text-property
2951 (if (eq noface 'n) ; Only immediate
2953 ;; We suppose that e is _after_ the end of construction, as after eol.
2954 (setq string (if string cperl-st-sfence cperl-st-cfence))
2956 ;; one-char string/comment?!
2957 (cperl-modify-syntax-type bb cperl-st-punct)
2958 (cperl-modify-syntax-type bb string)
2959 (cperl-modify-syntax-type (1- e) string))
2960 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
2961 (put-text-property (1+ bb) (1- e)
2962 'syntax-table cperl-string-syntax-table))
2963 (cperl-protect-defun-start bb e))
2966 (not cperl-pod-here-fontify)
2967 (put-text-property bb e 'face (if string 'font-lock-string-face
2968 'font-lock-comment-face)))))
2970 (defvar cperl-starters '(( ?\( . ?\) )
2975 (defun cperl-forward-re (lim end is-2arg set-st st-l err-l argument
2976 &optional ostart oend)
2977 ;; Works *before* syntax recognition is done
2978 ;; May modify syntax-type text property if the situation is too hard
2979 (let (b starter ender st i i2 go-forward reset-st)
2980 (skip-chars-forward " \t")
2981 ;; ender means matching-char matcher.
2983 starter (if (eobp) 0 (char-after b))
2984 ender (cdr (assoc starter cperl-starters)))
2985 ;; What if starter == ?\\ ????
2988 (setq st (car st-l))
2989 (setcar st-l (make-syntax-table))
2990 (setq i 0 st (car st-l))
2992 (modify-syntax-entry i "." st)
2994 (modify-syntax-entry ?\\ "\\" st)))
2996 ;; Whether we have an intermediate point
2998 ;; Prepare the syntax table:
3000 (if (not ender) ; m/blah/, s/x//, s/x/y/
3001 (modify-syntax-entry starter "$" st)
3002 (modify-syntax-entry starter (concat "(" (list ender)) st)
3003 (modify-syntax-entry ender (concat ")" (list starter)) st)))
3006 ;; We use `$' syntax class to find matching stuff, but $$
3007 ;; is recognized the same as $, so we need to check this manually.
3008 (if (and (eq starter (char-after (cperl-1+ b)))
3010 ;; $ has TeXish matching rules, so $$ equiv $...
3012 (setq reset-st (syntax-table))
3013 (set-syntax-table st)
3015 (if (<= (point) (1+ b))
3016 (error "Unfinished regular expression"))
3017 (set-syntax-table reset-st)
3019 ;; Now the problem is with m;blah;;
3021 (eq (preceding-char)
3022 (char-after (- (point) 2)))
3025 (= 0 (% (skip-chars-backward "\\\\") 2)))
3027 ;; Now we are after the first part.
3028 (and is-2arg ; Have trailing part
3030 (eq (following-char) starter) ; Empty trailing part
3032 (or (eq (char-syntax (following-char)) ?.)
3033 ;; Make trailing letter into punctuation
3034 (cperl-modify-syntax-type (point) cperl-st-punct))
3035 (setq is-2arg nil go-forward t))) ; Ignore the tail
3036 (if is-2arg ; Not number => have second part
3038 (setq i (point) i2 i)
3040 (if (memq (following-char) '(?\ ?\t ?\n ?\f))
3042 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3043 (goto-char (match-end 0))
3044 (skip-chars-forward " \t\n\f"))
3047 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3048 (if ender (modify-syntax-entry ender "." st))
3050 (setq ender (cperl-forward-re lim end nil t st-l err-l
3051 argument starter ender)
3052 ender (nth 2 ender)))))
3053 (error (goto-char lim)
3056 (set-syntax-table reset-st))
3059 "End of `%s%s%c ... %c' string/RE not found: %s"
3061 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3062 starter (or ender starter) bb)
3063 (or (car err-l) (setcar err-l b)))))
3066 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3067 (if ender (modify-syntax-entry ender "." st))))
3068 ;; i: have 2 args, after end of the first arg
3069 ;; i2: start of the second arg, if any (before delim iff `ender').
3070 ;; ender: the last arg bounded by parens-like chars, the second one of them
3071 ;; starter: the starting delimiter of the first arg
3072 ;; go-forward: has 2 args, and the second part is empty
3073 (list i i2 ender starter go-forward)))
3075 (defvar font-lock-string-face)
3076 ;;(defvar font-lock-reference-face)
3077 (defvar font-lock-constant-face)
3078 (defsubst cperl-postpone-fontification (b e type val &optional now)
3079 ;; Do after syntactic fontification?
3080 (if cperl-syntaxify-by-font-lock
3081 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3082 (put-text-property b e type val)))
3084 ;;; Here is how the global structures (those which cannot be
3085 ;;; recognized locally) are marked:
3087 ;; Start-to-end is marked `in-pod' ==> t
3088 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3089 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3091 ;; Start-to-end is marked `here-doc-group' ==> t
3092 ;; The body is marked `syntax-type' ==> `here-doc'
3093 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3095 ;; First line (to =) marked `first-format-line' ==> t
3096 ;; After-this--to-end is marked `syntax-type' ==> `format'
3097 ;; d) 'Q'uoted string:
3098 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3099 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3101 (defun cperl-unwind-to-safe (before &optional end)
3102 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3103 (let ((pos (point)) opos)
3105 (while (and pos (get-text-property pos 'syntax-type))
3106 (setq pos (previous-single-property-change pos 'syntax-type))
3110 (goto-char (cperl-1- pos))
3113 (goto-char (setq pos (cperl-1- pos))))
3115 (goto-char (point-min))))
3117 (and (looking-at "\n*=")
3118 (/= 0 (skip-chars-backward "\n"))
3122 ;; Do the same for end, going small steps
3124 (while (and end (get-text-property end 'syntax-type))
3126 end (next-single-property-change end 'syntax-type)))
3129 (defvar cperl-nonoverridable-face)
3130 (defvar font-lock-function-name-face)
3131 (defvar font-lock-comment-face)
3133 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max)
3134 "Scans the buffer for hard-to-parse Perl constructions.
3135 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3136 the sections using `cperl-pod-head-face', `cperl-pod-face',
3139 (or min (setq min (point-min)
3140 cperl-syntax-state nil
3141 cperl-syntax-done-to min))
3142 (or max (setq max (point-max)))
3143 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3144 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3145 is-REx is-x-REx REx-comment-start REx-comment-end was-comment i2
3146 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3147 (modified (buffer-modified-p))
3148 (after-change-functions nil)
3149 (use-syntax-state (and cperl-syntax-state
3150 (>= min (car cperl-syntax-state))))
3151 (state-point (if use-syntax-state
3152 (car cperl-syntax-state)
3154 (state (if use-syntax-state
3155 (cdr cperl-syntax-state)))
3156 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3157 (st-l (list nil)) (err-l (list nil))
3158 ;; Somehow font-lock may be not loaded yet...
3159 (font-lock-string-face (if (boundp 'font-lock-string-face)
3160 font-lock-string-face
3161 'font-lock-string-face))
3162 (font-lock-constant-face (if (boundp 'font-lock-constant-face)
3163 font-lock-constant-face
3164 'font-lock-constant-face))
3165 (font-lock-function-name-face
3166 (if (boundp 'font-lock-function-name-face)
3167 font-lock-function-name-face
3168 'font-lock-function-name-face))
3169 (font-lock-comment-face
3170 (if (boundp 'font-lock-comment-face)
3171 font-lock-comment-face
3172 'font-lock-comment-face))
3173 (cperl-nonoverridable-face
3174 (if (boundp 'cperl-nonoverridable-face)
3175 cperl-nonoverridable-face
3176 'cperl-nonoverridable))
3177 (stop-point (if ignore-max
3182 "\\(\\`\n?\\|^\n\\)="
3184 ;; One extra () before this:
3187 ;; First variant "BLAH" or just ``.
3188 "[ \t]*" ; Yes, whitespace is allowed!
3189 "\\([\"'`]\\)" ; 2 + 1 = 3
3190 "\\([^\"'`\n]*\\)" ; 3 + 1
3193 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3194 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3195 ;; Do not have <<= or << 30 or <<30 or << $blah.
3196 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3197 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3200 ;; 1+6 extra () before this:
3201 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3202 (if cperl-use-syntax-table-text-property
3205 ;; 1+6+2=9 extra () before this:
3206 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3208 ;; 1+6+2+1=10 extra () before this:
3209 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3211 ;; 1+6+2+1+1=11 extra () before this:
3212 "\\<sub\\>[ \t]*\\([a-zA-Z_:'0-9]+[ \t]*\\)?\\(([^()]*)\\)"
3214 ;; 1+6+2+1+1+2=13 extra () before this:
3217 ;; 1+6+2+1+1+2+1=14 extra () before this:
3218 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3219 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3221 "__\\(END\\|DATA\\)__"
3222 ;; 1+6+2+1+1+2+1+1+1=16 extra () before this:
3224 "\\\\\\(['`\"($]\\)")
3230 (message "Scanning for \"hard\" Perl constructions..."))
3231 (and cperl-pod-here-fontify
3232 ;; We had evals here, do not know why...
3233 (setq face cperl-pod-face
3234 head-face cperl-pod-head-face
3235 here-face cperl-here-face))
3236 (remove-text-properties min max
3237 '(syntax-type t in-pod t syntax-table t
3244 ;; Need to remove face as well...
3246 (and (eq system-type 'emx)
3247 (looking-at "extproc[ \t]") ; Analogue of #!
3248 (cperl-commentify min
3249 (save-excursion (end-of-line) (point))
3253 (re-search-forward search max t))
3254 (setq tmpend nil) ; Valid for most cases
3256 ((match-beginning 1) ; POD section
3257 ;; "\\(\\`\n?\\|^\n\\)="
3258 (if (looking-at "cut\\>")
3260 nil ; Doing a chunk only
3261 (message "=cut is not preceded by a POD section")
3262 (or (car err-l) (setcar err-l (point))))
3267 tb (match-beginning 0)
3268 b1 nil) ; error condition
3269 ;; We do not search to max, since we may be called from
3270 ;; some hook of fontification, and max is random
3271 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
3274 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3276 (message "=cut is not preceded by an empty line")
3278 (or (car err-l) (setcar err-l b))))))
3279 (beginning-of-line 2) ; An empty line after =cut is not POD!
3283 (remove-text-properties
3284 max e '(syntax-type t in-pod t syntax-table t
3292 (put-text-property b e 'in-pod t)
3293 (put-text-property b e 'syntax-type 'in-pod)
3295 (while (re-search-forward "\n\n[ \t]" e t)
3296 ;; We start 'pod 1 char earlier to include the preceding line
3298 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3299 (cperl-put-do-not-fontify b (point) t)
3300 ;; mark the non-literal parts as PODs
3301 (if cperl-pod-here-fontify
3302 (cperl-postpone-fontification b (point) 'face face t))
3303 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3306 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3307 (cperl-put-do-not-fontify (point) e t)
3308 (if cperl-pod-here-fontify
3310 ;; mark the non-literal parts as PODs
3311 (cperl-postpone-fontification (point) e 'face face t)
3314 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3316 (cperl-postpone-fontification
3317 (match-beginning 1) (match-end 1)
3319 (while (re-search-forward
3321 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3324 (cperl-postpone-fontification
3325 (match-beginning 1) (match-end 1)
3327 (cperl-commentify bb e nil)
3329 (or (eq e (point-max))
3330 (forward-char -1)))) ; Prepare for immediate POD start.
3332 ;; We do only one here-per-line
3333 ;; ;; One extra () before this:
3336 ;; ;; First variant "BLAH" or just ``.
3337 ;; "[ \t]*" ; Yes, whitespace is allowed!
3338 ;; "\\([\"'`]\\)" ; 2 + 1
3339 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3342 ;; ;; Second variant: Identifier or \ID or empty
3343 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3344 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3345 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3346 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3348 ((match-beginning 2) ; 1 + 1
3349 ;; Abort in comment:
3351 (setq state (parse-partial-sexp state-point b nil nil state)
3353 tb (match-beginning 0)
3354 i (or (nth 3 state) (nth 4 state)))
3359 (not (match-beginning 6)) ; Empty
3361 "[ \t]*[=0-9$@%&(]"))))
3362 (if c ; Not here-doc
3364 (if (match-beginning 5) ;4 + 1
3365 (setq b1 (match-beginning 5) ; 4 + 1
3366 e1 (match-end 5)) ; 4 + 1
3367 (setq b1 (match-beginning 4) ; 3 + 1
3368 e1 (match-end 4))) ; 3 + 1
3369 (setq tag (buffer-substring b1 e1)
3370 qtag (regexp-quote tag))
3371 (cond (cperl-pod-here-fontify
3372 ;; Highlight the starting delimiter
3373 (cperl-postpone-fontification b1 e1 'face font-lock-constant-face)
3374 (cperl-put-do-not-fontify b1 e1 t)))
3377 ;; We do not search to max, since we may be called from
3378 ;; some hook of fontification, and max is random
3379 (or (and (re-search-forward (concat "^" qtag "$")
3381 (eq (following-char) ?\n))
3382 (progn ; Pretend we matched at the end
3383 (goto-char (point-max))
3384 (re-search-forward "\\'")
3385 (message "End of here-document `%s' not found." tag)
3386 (or (car err-l) (setcar err-l b))))
3387 (if cperl-pod-here-fontify
3389 ;; Highlight the ending delimiter
3390 (cperl-postpone-fontification (match-beginning 0) (match-end 0)
3391 'face font-lock-constant-face)
3392 (cperl-put-do-not-fontify b (match-end 0) t)
3393 ;; Highlight the HERE-DOC
3394 (cperl-postpone-fontification b (match-beginning 0)
3396 (setq e1 (cperl-1+ (match-end 0)))
3397 (put-text-property b (match-beginning 0)
3398 'syntax-type 'here-doc)
3399 (put-text-property (match-beginning 0) e1
3400 'syntax-type 'here-doc-delim)
3401 (put-text-property b e1
3403 (cperl-commentify b e1 nil)
3404 (cperl-put-do-not-fontify b (match-end 0) t)
3408 ((match-beginning 8)
3409 ;; 1+6=7 extra () before this:
3410 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3412 name (if (match-beginning 8) ; 7 + 1
3413 (buffer-substring (match-beginning 8) ; 7 + 1
3414 (match-end 8)) ; 7 + 1
3416 tb (match-beginning 0))
3418 (put-text-property (save-excursion
3421 b 'first-format-line 't)
3422 (if cperl-pod-here-fontify
3423 (while (and (eq (forward-line) 0)
3424 (not (looking-at "^[.;]$")))
3426 ((looking-at "^#")) ; Skip comments
3427 ((and argument ; Skip argument multi-lines
3428 (looking-at "^[ \t]*{"))
3430 (setq argument nil))
3431 (argument ; Skip argument lines
3432 (setq argument nil))
3435 (setq argument (looking-at "^[^\n]*[@^]"))
3437 ;; Highlight the format line
3438 (cperl-postpone-fontification b1 (point)
3439 'face font-lock-string-face)
3440 (cperl-commentify b1 (point) nil)
3441 (cperl-put-do-not-fontify b1 (point) t))))
3442 ;; We do not search to max, since we may be called from
3443 ;; some hook of fontification, and max is random
3444 (re-search-forward "^[.;]$" stop-point 'toend))
3446 (if (looking-at "^\\.$") ; ";" is not supported yet
3448 ;; Highlight the ending delimiter
3449 (cperl-postpone-fontification (point) (+ (point) 2)
3450 'face font-lock-string-face)
3451 (cperl-commentify (point) (+ (point) 2) nil)
3452 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
3453 (message "End of format `%s' not found." name)
3454 (or (car err-l) (setcar err-l b)))
3458 (put-text-property b (point) 'syntax-type 'format))
3460 ((or (match-beginning 10) (match-beginning 11))
3461 ;; 1+6+2=9 extra () before this:
3462 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3464 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3465 (setq b1 (if (match-beginning 10) 10 11)
3466 argument (buffer-substring
3467 (match-beginning b1) (match-end b1))
3470 c (char-after (match-beginning b1))
3471 bb (char-after (1- (match-beginning b1))) ; tmp holder
3472 ;; bb == "Not a stringy"
3473 bb (if (eq b1 10) ; user variables/whatever
3474 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
3475 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
3476 ((eq bb ?\:) ; $opt::s
3478 (- (match-beginning b1) 2))
3480 ((eq bb ?\>) ; $foo->s
3482 (- (match-beginning b1) 2))
3485 (not (eq (char-after ; &&m/blah/
3486 (- (match-beginning b1) 2))
3489 ;; <file> or <$file>
3491 ;; Do not stringify <FH>, <$fh> :
3494 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
3495 tb (match-beginning 0))
3496 (goto-char (match-beginning b1))
3497 (cperl-backward-to-noncomment (point-min))
3499 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
3505 ;; What is below: regexp-p?
3507 (or (memq (preceding-char)
3508 (append (if (memq c '(?\? ?\<))
3511 "~{(=|&+-*!,;:") nil))
3512 (and (eq (preceding-char) ?\})
3513 (cperl-after-block-p (point-min)))
3514 (and (eq (char-syntax (preceding-char)) ?w)
3517 ;; After these keywords `/' starts a RE. One should add all the
3518 ;; functions/builtins which expect an argument, but ...
3519 (if (eq (preceding-char) ?-)
3521 (looking-at "[a-zA-Z]\\>")
3523 (not (memq (preceding-char)
3526 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
3527 (and (eq (preceding-char) ?.)
3528 (eq (char-after (- (point) 2)) ?.))
3530 ;; m|blah| ? foo : bar;
3533 cperl-use-syntax-table-text-property
3537 (looking-at "\\s|")))))))
3540 ;; Check for $a -> y
3541 (setq b1 (preceding-char)
3544 (eq (char-after (- go 2)) ?-))
3547 (or bb (setq state (parse-partial-sexp
3548 state-point b nil nil state)
3550 (setq bb (or bb (nth 3 state) (nth 4 state)))
3554 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3555 (goto-char (match-end 0))
3556 (skip-chars-forward " \t\n\f"))
3557 (cond ((and (eq (following-char) ?\})
3559 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
3561 (skip-chars-backward " \t\n\f")
3562 (if (memq (preceding-char) (append "$@%&*" nil))
3568 (looking-at ; $foo -> {s}
3569 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
3570 (and ; $foo[12] -> {s}
3571 (memq (following-char) '(?\{ ?\[))
3574 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
3577 ((and (eq (following-char) ?=)
3578 (eq (char-after (1+ (point))) ?\>))
3579 ;; Check for { foo => 1, s => 2 }
3580 ;; Apparently s=> is never a substitution...
3582 ((and (eq (following-char) ?:)
3583 (eq b1 ?\{) ; Check for $ { s::bar }
3584 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
3587 (skip-chars-backward " \t\n\f")
3588 (memq (preceding-char)
3589 (append "$@%&*" nil))))
3593 ;; Skip whitespace and comments...
3594 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3595 (goto-char (match-end 0))
3596 (skip-chars-forward " \t\n\f"))
3598 (put-text-property b (point) 'syntax-type 'prestring))
3599 ;; qtag means two-arg matcher, may be reset to
3600 ;; 2 or 3 later if some special quoting is needed.
3601 ;; e1 means matching-char matcher.
3604 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
3605 ;; We do not search to max, since we may be called from
3606 ;; some hook of fontification, and max is random
3607 i (cperl-forward-re stop-point end
3609 t st-l err-l argument)
3610 ;; Note that if `go', then it is considered as 1-arg
3611 b1 (nth 1 i) ; start of the second part
3612 tag (nth 2 i) ; ender-char, true if second part
3613 ; is with matching chars []
3614 go (nth 4 i) ; There is a 1-char part after the end
3615 i (car i) ; intermediate point
3617 ;; Before end of the second part if non-matching: ///
3618 tail (if (and i (not tag))
3620 e (if i i e1) ; end of the first part
3621 qtag nil ; need to preserve backslashitis
3622 is-x-REx nil) ; REx has //x modifier
3623 ;; Commenting \\ is dangerous, what about ( ?
3625 (eq (char-after i) ?\\)
3627 (if (looking-at "\\sw*x") ; qr//x
3630 ;; Considered as 1arg form
3632 (cperl-commentify b (point) t)
3633 (put-text-property b (point) 'syntax-type 'string)
3635 ;; ignore other text properties:
3636 (string-match "^qw$" argument))
3637 (put-text-property b (point) 'indentable t))
3639 (setq e1 (cperl-1+ e1))
3642 (cperl-commentify b i t)
3643 (if (looking-at "\\sw*e") ; s///e
3647 (cperl-find-pods-heres b1 (1- (point)) t end)
3649 (goto-char (1+ max)))
3650 (if (and tag (eq (preceding-char) ?\>))
3652 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
3653 (cperl-modify-syntax-type i cperl-st-bra)))
3654 (put-text-property b i 'syntax-type 'string)
3656 (put-text-property b i 'indentable t)))
3657 (cperl-commentify b1 (point) t)
3658 (put-text-property b (point) 'syntax-type 'string)
3660 (put-text-property b i 'indentable t))
3662 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
3664 ;; Now: tail: if the second part is non-matching without ///e
3665 (if (eq (char-syntax (following-char)) ?w)
3667 (forward-word 1) ; skip modifiers s///s
3668 (if tail (cperl-commentify tail (point) t))
3669 (cperl-postpone-fontification
3670 e1 (point) 'face 'cperl-nonoverridable)))
3671 ;; Check whether it is m// which means "previous match"
3672 ;; and highlight differently
3674 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
3675 (or (not (= (length argument) 0))
3679 ;; split // *is* using zero-pattern
3685 (not (looking-at "split\\>")))
3687 (cperl-postpone-fontification
3688 b e 'face font-lock-function-name-face)
3689 (if (or i2 ; Has 2 args
3690 (and cperl-fontify-m-as-s
3692 (string-match "^\\(m\\|qr\\)$" argument)
3693 (and (eq 0 (length argument))
3694 (not (eq ?\< (char-after b)))))))
3696 (cperl-postpone-fontification
3697 b (cperl-1+ b) 'face font-lock-constant-face)
3698 (cperl-postpone-fontification
3699 (1- e) e 'face font-lock-constant-face)))
3700 (if (and is-REx cperl-regexp-scan)
3701 ;; Process RExen better
3708 (if (eq (char-after b) ?\#)
3709 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
3710 "\\((\\?#\\)\\|\\(#\\)")
3711 (if (eq (char-after b) ?\#)
3715 (goto-char (match-beginning 0))
3716 (setq REx-comment-start (point)
3720 ;; XXX not working if outside delimiter is #
3721 (eq (preceding-char) ?\\)
3722 (= (% (skip-chars-backward "$\\\\") 2) -1)))
3723 ;; Not a comment, avoid loop:
3724 (progn (setq was-comment nil)
3726 (if (match-beginning 2)
3728 (beginning-of-line 2)
3730 (goto-char (1- e))))
3731 ;; Works also if the outside delimiters are ().
3732 (or (search-forward ")" (1- e) 'toend)
3734 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
3735 REx-comment-start))))
3740 (setq REx-comment-end (point))
3742 REx-comment-start REx-comment-end nil)
3743 (cperl-postpone-fontification
3744 REx-comment-start REx-comment-end
3745 'face font-lock-comment-face))))))
3746 (if (and is-REx is-x-REx)
3747 (put-text-property (1+ b) (1- e)
3748 'syntax-subtype 'x-REx)))
3751 (cperl-postpone-fontification
3752 (1- e1) e1 'face font-lock-constant-face)
3753 (if (assoc (char-after b) cperl-starters)
3754 (cperl-postpone-fontification
3755 b1 (1+ b1) 'face font-lock-constant-face))))
3758 ((match-beginning 13) ; sub with prototypes
3759 (setq b (match-beginning 0))
3760 (if (memq (char-after (1- b))
3761 '(?\$ ?\@ ?\% ?\& ?\*))
3763 (setq state (parse-partial-sexp
3764 state-point b nil nil state)
3766 (if (or (nth 3 state) (nth 4 state))
3769 (cperl-commentify (match-beginning 13) (match-end 13) t))
3770 (goto-char (match-end 0))))
3771 ;; 1+6+2+1+1+2=13 extra () before this:
3773 ((and (match-beginning 14)
3774 (eq (preceding-char) ?\')) ; $'
3775 (setq b (1- (point))
3776 state (parse-partial-sexp
3777 state-point (1- b) nil nil state)
3779 (if (nth 3 state) ; in string
3780 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3782 ;; 1+6+2+1+1+2=13 extra () before this:
3784 ((match-beginning 14) ; ${
3785 (setq bb (match-beginning 0))
3786 (cperl-modify-syntax-type bb cperl-st-punct))
3787 ;; 1+6+2+1+1+2+1=14 extra () before this:
3788 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3789 ((match-beginning 15) ; old $abc'efg syntax
3790 (setq bb (match-end 0)
3791 b (match-beginning 0)
3792 state (parse-partial-sexp
3793 state-point b nil nil state)
3795 (if (nth 3 state) ; in string
3797 (put-text-property (1- bb) bb 'syntax-table cperl-st-word))
3799 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3800 ;; "__\\(END\\|DATA\\)__"
3801 ((match-beginning 16) ; __END__, __DATA__
3802 (setq bb (match-end 0)
3803 b (match-beginning 0)
3804 state (parse-partial-sexp
3805 state-point b nil nil state)
3807 (if (or (nth 3 state) (nth 4 state))
3809 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3810 (cperl-commentify b bb nil)
3813 ((match-beginning 17) ; "\\\\\\(['`\"($]\\)"
3814 ;; Trailing backslash ==> non-quoting outside string/comment
3815 (setq bb (match-end 0)
3816 b (match-beginning 0))
3818 (skip-chars-backward "\\\\")
3819 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
3820 (setq state (parse-partial-sexp
3821 state-point b nil nil state)
3823 (if (or (nth 3 state) (nth 4 state) )
3825 (cperl-modify-syntax-type b cperl-st-punct))
3827 (t (error "Error in regexp of the sniffer")))
3828 (if (> (point) stop-point)
3831 (message "Garbage after __END__/__DATA__ ignored")
3832 (message "Unbalanced syntax found while scanning")
3833 (or (car err-l) (setcar err-l b)))
3834 (goto-char stop-point))))
3835 (setq cperl-syntax-state (cons state-point state)
3836 cperl-syntax-done-to (or tmpend (max (point) max))))
3837 (if (car err-l) (goto-char (car err-l))
3839 (message "Scanning for \"hard\" Perl constructions... done"))))
3840 (and (buffer-modified-p)
3842 (set-buffer-modified-p nil))
3843 (set-syntax-table cperl-mode-syntax-table))
3846 (defun cperl-backward-to-noncomment (lim)
3847 ;; Stops at lim or after non-whitespace that is not in comment
3849 (while (and (not stop) (> (point) (or lim 1)))
3850 (skip-chars-backward " \t\n\f" lim)
3853 (if (memq (setq pr (get-text-property (point) 'syntax-type))
3854 '(pod here-doc here-doc-delim))
3855 (cperl-unwind-to-safe nil)
3856 (or (looking-at "^[ \t]*\\(#\\|$\\)")
3857 (progn (cperl-to-comment-or-eol) (bolp))
3859 (skip-chars-backward " \t")
3860 (if (< p (point)) (goto-char p))
3863 (defun cperl-after-block-p (lim &optional pre-block)
3864 "Return true if the preceeding } ends a block or a following { starts one.
3865 Would not look before LIM. If PRE-BLOCK is nil checks preceeding }.
3866 otherwise following {."
3867 ;; We suppose that the preceding char is }.
3871 (or pre-block (forward-sexp -1))
3872 (cperl-backward-to-noncomment lim)
3873 (or (eq (point) lim)
3874 (eq (preceding-char) ?\) ) ; if () {} sub f () {}
3875 (if (eq (char-syntax (preceding-char)) ?w) ; else {}
3878 (or (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
3881 (cperl-backward-to-noncomment lim)
3882 (and (eq (char-syntax (preceding-char)) ?w)
3885 (looking-at "sub\\>"))))))
3886 (cperl-after-expr-p lim))))
3889 (defun cperl-after-expr-p (&optional lim chars test)
3890 "Return true if the position is good for start of expression.
3891 TEST is the expression to evaluate at the found position. If absent,
3892 CHARS is a string that contains good characters to have before us (however,
3893 `}' is treated \"smartly\" if it is not in the list)."
3894 (let ((lim (or lim (point-min)))
3896 (cperl-update-syntaxification (point) (point))
3898 (while (and (not stop) (> (point) lim))
3899 (skip-chars-backward " \t\n\f" lim)
3902 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
3903 ;; '(pod here-doc here-doc-delim))
3904 (if (get-text-property (point) 'here-doc-group)
3907 (previous-single-property-change (point) 'here-doc-group))
3908 (beginning-of-line 0)))
3909 (if (get-text-property (point) 'in-pod)
3912 (previous-single-property-change (point) 'in-pod))
3913 (beginning-of-line 0)))
3914 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
3915 ;; Else: last iteration, or a label
3916 (cperl-to-comment-or-eol) ; Will not move past "." after a format
3917 (skip-chars-backward " \t")
3918 (if (< p (point)) (goto-char p))
3920 (if (and (eq (preceding-char) ?:)
3923 (skip-chars-backward " \t\n\f" lim)
3924 (eq (char-syntax (preceding-char)) ?w)))
3925 (forward-sexp -1) ; Possibly label. Skip it
3928 (or (bobp) ; ???? Needed
3930 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
3932 (if test (eval test)
3933 (or (memq (preceding-char) (append (or chars "{;") nil))
3934 (and (eq (preceding-char) ?\})
3935 (cperl-after-block-p lim))
3936 (and (eq (following-char) ?.) ; in format: see comment above
3937 (eq (get-text-property (point) 'syntax-type)
3940 (defun cperl-backward-to-start-of-continued-exp (lim)
3941 (if (memq (preceding-char) (append ")]}\"'`" nil))
3944 (if (<= (point) lim)
3945 (goto-char (1+ lim)))
3946 (skip-chars-forward " \t"))
3948 (defun cperl-after-block-and-statement-beg (lim)
3949 ;; We assume that we are after ?\}
3951 (cperl-after-block-p lim)
3954 (cperl-backward-to-noncomment (point-min))
3957 (not (= (char-syntax (preceding-char)) ?w))
3962 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
3965 (defun cperl-indent-exp ()
3966 "Simple variant of indentation of continued-sexp.
3968 Will not indent comment if it starts at `comment-indent' or looks like
3969 continuation of the comment on the previous line.
3971 If `cperl-indent-region-fix-constructs', will improve spacing on
3972 conditional/loop constructs."
3975 (let ((tmp-end (progn (end-of-line) (point))) top done)
3980 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
3982 (setq top (point))) ; Get the outermost parenths in line
3984 (while (< (point) tmp-end)
3985 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
3986 (or (eolp) (forward-sexp 1)))
3987 (if (> (point) tmp-end)
3990 (setq tmp-end (point)))
3993 (setq tmp-end (point-marker)))
3994 (if cperl-indent-region-fix-constructs
3995 (cperl-fix-line-spacing tmp-end))
3996 (cperl-indent-region (point) tmp-end))))
3998 (defun cperl-fix-line-spacing (&optional end parse-data)
3999 "Improve whitespace in a conditional/loop construct.
4000 Returns some position at the last line."
4003 (setq end (point-max)))
4004 (let ((ee (save-excursion (end-of-line) (point)))
4005 (cperl-indent-region-fix-constructs
4006 (or cperl-indent-region-fix-constructs 1))
4007 p pp ml have-brace ret)
4014 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
4015 (setq have-brace (save-excursion (search-forward "}" ee t)))))
4016 nil ; Do not need to do anything
4020 (if (and cperl-merge-trailing-else
4022 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
4024 (search-forward "}")
4026 (skip-chars-forward " \t\n")
4027 (delete-region p (point))
4028 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4029 (beginning-of-line)))
4032 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
4034 (search-forward "}")
4035 (delete-horizontal-space)
4036 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4037 (beginning-of-line)))
4041 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4044 (delete-horizontal-space)
4045 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4046 (beginning-of-line)))
4050 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
4053 (delete-horizontal-space)
4054 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4055 (beginning-of-line)))
4057 ;; foreach my $var (
4059 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4062 (delete-horizontal-space)
4064 (make-string cperl-indent-region-fix-constructs ?\ ))
4065 (beginning-of-line)))
4067 ;; } foreach my $var () {
4069 "[ \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]*{")
4071 (setq ml (match-beginning 8))
4072 (re-search-forward "[({]")
4075 (if (eq (following-char) ?\( )
4079 ;; after `else' or nothing
4080 (if ml ; after `else'
4081 (skip-chars-backward " \t\n")
4082 (beginning-of-line))
4084 ;; Now after the sexp before the brace
4085 ;; Multiline expr should be special
4086 (setq ml (and pp (save-excursion (goto-char p)
4087 (search-forward "\n" pp t))))
4088 (if (and (or (not pp) (< pp end))
4089 (looking-at "[ \t\n]*{"))
4092 ((bolp) ; Were before `{', no if/else/etc
4094 ((looking-at "\\(\t*\\| [ \t]+\\){")
4095 (delete-horizontal-space)
4097 cperl-extra-newline-before-brace-multiline
4098 cperl-extra-newline-before-brace)
4100 (delete-horizontal-space)
4103 (if (cperl-indent-line parse-data)
4105 (cperl-fix-line-spacing end parse-data)
4106 (setq ret (point)))))
4108 (make-string cperl-indent-region-fix-constructs ?\ ))))
4109 ((and (looking-at "[ \t]*\n")
4111 cperl-extra-newline-before-brace-multiline
4112 cperl-extra-newline-before-brace)))
4114 (skip-chars-forward " \t\n")
4115 (delete-region pp (point))
4117 (make-string cperl-indent-region-fix-constructs ?\ ))))
4118 ;; Now we are before `{'
4119 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
4121 (skip-chars-forward " \t\n")
4126 (setq ml (search-forward "\n" p t))
4127 (if (or cperl-break-one-line-blocks-when-indent ml)
4128 ;; not good: multi-line BLOCK
4131 (delete-horizontal-space)
4134 (if (cperl-indent-line parse-data)
4135 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
4137 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
4138 ;; Now check whether there is a hanging `}'
4142 cperl-fix-hanging-brace-when-indent
4144 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
4148 (if (and (<= (point) pp)
4149 (eq (preceding-char) ?\} )
4150 (cperl-after-block-and-statement-beg (point-min)))
4157 (skip-chars-backward " \t")
4159 ;; `}' was the first thing on the line, insert NL *after* it.
4161 (cperl-indent-line parse-data)
4162 (search-forward "}")
4163 (delete-horizontal-space)
4165 (delete-horizontal-space)
4166 (or (eq (preceding-char) ?\;)
4168 (and (eq (preceding-char) ?\} )
4169 (cperl-after-block-p (point-min)))
4173 (if (cperl-indent-line parse-data)
4174 (setq ret (cperl-fix-line-spacing end parse-data)))
4175 (beginning-of-line)))))
4178 (defvar cperl-update-start) ; Do not need to make them local
4179 (defvar cperl-update-end)
4180 (defun cperl-delay-update-hook (beg end old-len)
4181 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
4182 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
4184 (defun cperl-indent-region (start end)
4185 "Simple variant of indentation of region in CPerl mode.
4186 Should be slow. Will not indent comment if it starts at `comment-indent'
4187 or looks like continuation of the comment on the previous line.
4188 Indents all the lines whose first character is between START and END
4191 If `cperl-indent-region-fix-constructs', will improve spacing on
4192 conditional/loop constructs."
4194 (cperl-update-syntaxification end end)
4196 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
4197 (let ((indent-info (if cperl-emacs-can-parse
4198 (list nil nil nil) ; Cannot use '(), since will modify
4201 after-change-functions ; Speed it up!
4202 st comm old-comm-indent new-comm-indent p pp i empty)
4203 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
4205 (setq old-comm-indent (and (cperl-to-comment-or-eol)
4207 new-comm-indent old-comm-indent)
4209 (setq end (set-marker (make-marker) end)) ; indentation changes pos
4210 (or (bolp) (beginning-of-line 2))
4211 (while (and (<= (point) end) (not (eobp))) ; bol to check start
4214 (setq empty (looking-at "[ \t]*\n"))
4215 (and (setq comm (looking-at "[ \t]*#"))
4216 (or (eq (current-indentation) (or old-comm-indent
4218 (setq old-comm-indent nil))))
4219 (if (and old-comm-indent
4221 (= (current-indentation) old-comm-indent)
4222 (not (eq (get-text-property (point) 'syntax-type) 'pod))
4223 (not (eq (get-text-property (point) 'syntax-table)
4225 (let ((comment-column new-comm-indent))
4226 (indent-for-comment)))
4228 (setq i (cperl-indent-line indent-info))
4232 (if cperl-indent-region-fix-constructs
4233 (goto-char (cperl-fix-line-spacing end indent-info)))
4234 (if (setq old-comm-indent
4235 (and (cperl-to-comment-or-eol)
4236 (not (memq (get-text-property (point)
4239 (not (eq (get-text-property (point)
4243 (progn (indent-for-comment)
4244 (skip-chars-backward " \t")
4245 (skip-chars-backward "#")
4246 (setq new-comm-indent (current-column))))))))
4247 (beginning-of-line 2)))
4248 ;; Now run the update hooks
4249 (and after-change-functions
4252 (goto-char cperl-update-end)
4255 (goto-char cperl-update-start)
4257 (delete-char -1))))))
4259 ;; Stolen from lisp-mode with a lot of improvements
4261 (defun cperl-fill-paragraph (&optional justify iteration)
4262 "Like `fill-paragraph', but handle CPerl comments.
4263 If any of the current line is a comment, fill the comment or the
4264 block of it that point is in, preserving the comment's initial
4265 indentation and initial hashes. Behaves usually outside of comment."
4266 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
4267 (let (;; Non-nil if the current line contains a comment.
4270 ;; If has-comment, the appropriate fill-prefix for the comment.
4272 ;; Line that contains code and comment (or nil)
4274 c spaces len dc (comment-column comment-column))
4275 ;; Figure out what kind of comment we are looking at.
4280 ;; A line with nothing but a comment on it?
4281 ((looking-at "[ \t]*#[# \t]*")
4283 comment-fill-prefix (buffer-substring (match-beginning 0)
4286 ;; A line with some code, followed by a comment? Remember that the
4287 ;; semi which starts the comment shouldn't be part of a string or
4289 ((cperl-to-comment-or-eol)
4290 (setq has-comment t)
4291 (looking-at "#+[ \t]*")
4292 (setq start (point) c (current-column)
4294 (concat (make-string (current-column) ?\ )
4295 (buffer-substring (match-beginning 0) (match-end 0)))
4296 spaces (progn (skip-chars-backward " \t")
4297 (buffer-substring (point) start))
4298 dc (- c (current-column)) len (- start (point))
4299 start (point-marker))
4301 (insert (make-string dc ?-)))))
4302 (if (not has-comment)
4303 (fill-paragraph justify) ; Do the usual thing outside of comment
4304 ;; Narrow to include only the comment, and then fill the region.
4307 ;; Find the first line we should include in the region to fill.
4308 (if start (progn (beginning-of-line) (point))
4310 (while (and (zerop (forward-line -1))
4311 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4312 ;; We may have gone to far. Go forward again.
4313 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
4316 ;; Find the beginning of the first line past the region to fill.
4318 (while (progn (forward-line 1)
4319 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4321 ;; Remove existing hashes
4323 (goto-char (point-min))
4324 (while (progn (forward-line 1) (< (point) (point-max)))
4325 (skip-chars-forward " \t")
4326 (and (looking-at "#+")
4327 (delete-char (- (match-end 0) (match-beginning 0))))))
4329 ;; Lines with only hashes on them can be paragraph boundaries.
4330 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
4331 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
4332 (fill-prefix comment-fill-prefix))
4333 (fill-paragraph justify)))
4338 (progn (delete-char dc) (insert spaces)))
4339 (if (or (= (current-column) c) iteration) nil
4340 (setq comment-column c)
4341 (indent-for-comment)
4342 ;; Repeat once more, flagging as iteration
4343 (cperl-fill-paragraph justify t)))))))
4345 (defun cperl-do-auto-fill ()
4346 ;; Break out if the line is short enough
4347 (if (> (save-excursion
4351 (let ((c (save-excursion (beginning-of-line)
4352 (cperl-to-comment-or-eol) (point)))
4353 (s (memq (following-char) '(?\ ?\t))) marker)
4355 ;; Don't break line inside code: only inside comment.
4357 (setq marker (point-marker))
4358 (fill-paragraph nil)
4360 ;; Is not enough, sometimes marker is a start of line
4361 (if (bolp) (progn (re-search-forward "#+[ \t]*")
4362 (goto-char (match-end 0))))
4363 ;; Following space could have gone:
4364 (if (or (not s) (memq (following-char) '(?\ ?\t))) nil
4367 ;; Previous space could have gone:
4368 (or (memq (preceding-char) '(?\ ?\t)) (insert " "))))))
4370 (defun cperl-imenu-addback (lst &optional isback name)
4371 ;; We suppose that the lst is a DAG, unless the first element only
4372 ;; loops back, and ISBACK is set. Thus this function cannot be
4373 ;; applied twice without ISBACK set.
4374 (cond ((not cperl-imenu-addback) lst)
4377 (setq name "+++BACK+++"))
4378 (mapcar (lambda (elt)
4379 (if (and (listp elt) (listp (cdr elt)))
4381 ;; In the other order it goes up
4382 ;; one level only ;-(
4383 (setcdr elt (cons (cons name lst)
4385 (cperl-imenu-addback (cdr elt) t name))))
4386 (if isback (cdr lst) lst))
4389 (defun cperl-imenu--create-perl-index (&optional regexp)
4390 (require 'imenu) ; May be called from TAGS creator
4391 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
4392 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
4393 (index-meth-alist '()) meth
4394 packages ends-ranges p marker
4395 (prev-pos 0) char fchar index index1 name (end-range 0) package)
4396 (goto-char (point-min))
4397 (cperl-update-syntaxification (point-max) (point-max))
4398 ;; Search for the function
4399 (progn ;;save-match-data
4400 (while (re-search-forward
4401 (or regexp cperl-imenu--function-name-regexp-perl)
4404 ((and ; Skip some noise if building tags
4405 (match-beginning 2) ; package or sub
4406 (eq (char-after (match-beginning 2)) ?p) ; package
4407 (not (save-match-data
4408 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
4411 (match-beginning 2) ; package or sub
4412 ;; Skip if quoted (will not skip multi-line ''-strings :-():
4413 (null (get-text-property (match-beginning 1) 'syntax-table))
4414 (null (get-text-property (match-beginning 1) 'syntax-type))
4415 (null (get-text-property (match-beginning 1) 'in-pod)))
4417 (goto-char (match-beginning 2))
4418 (setq fchar (following-char)))
4419 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4420 ;; (goto-char (match-end 0))) ; Messes what follows
4421 (setq char (following-char) ; ?\; for "sub foo () ;"
4424 (while (and ends-ranges (>= p (car ends-ranges)))
4425 ;; delete obsolete entries
4426 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
4427 (setq package (or (car packages) "")
4428 end-range (or (car ends-ranges) 0))
4430 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4432 (set-text-properties 0 (length name) nil name)
4434 package (concat name "::")
4435 name (concat "package " name)
4438 (parse-partial-sexp (point) (point-max) -1) (point))
4439 ends-ranges (cons end-range ends-ranges)
4440 packages (cons package packages)))
4442 ;; Skip this function name if it is a prototype declaration.
4443 (if (and (eq fchar ?s) (eq char ?\;)) nil
4444 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4445 marker (make-marker))
4446 (set-text-properties 0 (length name) nil name)
4447 (set-marker marker (match-end 3))
4449 (setq name (concat "package " name))
4450 (cond ((string-match "[:']" name)
4452 ((> p end-range) nil)
4454 (setq name (concat package name) meth t))))
4455 (setq index (cons name marker))
4457 (push index index-pack-alist)
4458 (push index index-alist))
4459 (if meth (push index index-meth-alist))
4460 (push index index-unsorted-alist)))
4461 ((match-beginning 5) ; POD section
4462 ;; (beginning-of-line)
4463 (setq index (imenu-example--name-and-position)
4464 name (buffer-substring (match-beginning 6) (match-end 6)))
4465 (set-text-properties 0 (length name) nil name)
4466 (if (eq (char-after (match-beginning 5)) ?2)
4467 (setq name (concat " " name)))
4469 (setq index1 (cons (concat "=" name) (cdr index)))
4470 (push index index-pod-alist)
4471 (push index1 index-unsorted-alist)))))
4473 (if (default-value 'imenu-sort-function)
4474 (sort index-alist (default-value 'imenu-sort-function))
4475 (nreverse index-alist)))
4476 (and index-pod-alist
4477 (push (cons "+POD headers+..."
4478 (nreverse index-pod-alist))
4480 (and (or index-pack-alist index-meth-alist)
4481 (let ((lst index-pack-alist) hier-list pack elt group name)
4482 ;; Remove "package ", reverse and uniquify.
4484 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
4485 (if (assoc name hier-list) nil
4486 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
4487 (setq lst index-meth-alist)
4489 (setq elt (car lst) lst (cdr lst))
4490 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
4491 (setq pack (substring (car elt) 0 (match-beginning 0)))
4492 (if (setq group (assoc pack hier-list))
4493 (if (listp (cdr group))
4494 ;; Have some functions already
4496 (cons (cons (substring
4498 (+ 2 (match-beginning 0)))
4501 (setcdr group (list (cons (substring
4503 (+ 2 (match-beginning 0)))
4507 (list (cons (substring
4509 (+ 2 (match-beginning 0)))
4512 (push (cons "+Hierarchy+..."
4515 (and index-pack-alist
4516 (push (cons "+Packages+..."
4517 (nreverse index-pack-alist))
4519 (and (or index-pack-alist index-pod-alist
4520 (default-value 'imenu-sort-function))
4521 index-unsorted-alist
4522 (push (cons "+Unsorted List+..."
4523 (nreverse index-unsorted-alist))
4525 (cperl-imenu-addback index-alist)))
4528 ;; Suggested by Mark A. Hershberger
4529 (defun cperl-outline-level ()
4530 (looking-at outline-regexp)
4531 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4532 ((match-beginning 2)
4533 (if (eq (char-after (match-beginning 2)) ?p)
4536 ((match-beginning 5)
4537 (if (eq (char-after (match-beginning 5)) ?1)
4540 (t 3))) ; should not happen
4543 (defvar cperl-compilation-error-regexp-alist
4544 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4545 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
4547 "Alist that specifies how to match errors in perl output.")
4549 (if (fboundp 'eval-after-load)
4552 '(setq perl-compilation-error-regexp-alist
4553 cperl-compilation-error-regexp-alist)))
4556 (defun cperl-windowed-init ()
4557 "Initialization under windowed version."
4558 (if (or (featurep 'ps-print) cperl-faces-init)
4559 ;; Need to init anyway:
4560 (or cperl-faces-init (cperl-init-faces))
4561 (add-hook 'font-lock-mode-hook
4564 (if (memq major-mode '(perl-mode cperl-mode))
4566 (or cperl-faces-init (cperl-init-faces)))))))
4567 (if (fboundp 'eval-after-load)
4570 '(or cperl-faces-init (cperl-init-faces))))))
4572 (defvar cperl-font-lock-keywords-1 nil
4573 "Additional expressions to highlight in Perl mode. Minimal set.")
4574 (defvar cperl-font-lock-keywords nil
4575 "Additional expressions to highlight in Perl mode. Default set.")
4576 (defvar cperl-font-lock-keywords-2 nil
4577 "Additional expressions to highlight in Perl mode. Maximal set")
4579 (defun cperl-load-font-lock-keywords ()
4580 (or cperl-faces-init (cperl-init-faces))
4581 cperl-font-lock-keywords)
4583 (defun cperl-load-font-lock-keywords-1 ()
4584 (or cperl-faces-init (cperl-init-faces))
4585 cperl-font-lock-keywords-1)
4587 (defun cperl-load-font-lock-keywords-2 ()
4588 (or cperl-faces-init (cperl-init-faces))
4589 cperl-font-lock-keywords-2)
4591 (defun cperl-init-faces-weak ()
4592 ;; Allow `cperl-find-pods-heres' to run.
4593 (or (boundp 'font-lock-constant-face)
4594 (cperl-force-face font-lock-constant-face
4595 "Face for constant and label names")
4596 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4599 (defun cperl-init-faces ()
4600 (condition-case errs
4602 (require 'font-lock)
4603 (and (fboundp 'font-lock-fontify-anchored-keywords)
4604 (featurep 'font-lock-extra)
4605 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
4606 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
4607 (if (fboundp 'font-lock-fontify-anchored-keywords)
4608 (setq font-lock-anchored t))
4610 t-font-lock-keywords
4612 `("[ \t]+$" 0 ',cperl-invalid-face t)
4615 "\\(^\\|[^$@%&\\]\\)\\<\\("
4618 '("if" "until" "while" "elsif" "else" "unless" "for"
4619 "foreach" "continue" "exit" "die" "last" "goto" "next"
4620 "redo" "return" "local" "exec" "sub" "do" "dump" "use"
4621 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
4622 "\\|") ; Flow control
4623 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
4624 ; In what follows we use `type' style
4625 ; for overwritable builtins
4628 "\\(^\\|[^$@%&\\]\\)\\<\\("
4629 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4630 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4631 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4632 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4633 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4634 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4635 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4636 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4637 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4638 ;; "gethostbyname" "gethostent" "getlogin"
4639 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4640 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4641 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4642 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4643 ;; "getservbyport" "getservent" "getsockname"
4644 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4645 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
4646 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
4647 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4648 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4649 ;; "quotemeta" "rand" "read" "readdir" "readline"
4650 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4651 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4652 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4653 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4654 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4655 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4656 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4657 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
4658 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
4659 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4660 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4661 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
4662 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
4663 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
4664 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
4665 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
4666 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
4667 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
4668 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
4669 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
4670 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
4671 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
4672 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
4673 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
4674 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
4675 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
4676 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
4677 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
4678 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
4679 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
4680 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
4681 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
4682 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
4683 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
4684 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
4685 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
4686 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
4687 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
4688 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
4689 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
4690 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
4691 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
4692 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
4693 "\\)\\>") 2 'font-lock-type-face)
4694 ;; In what follows we use `other' style
4695 ;; for nonoverwritable builtins
4696 ;; Somehow 's', 'm' are not auto-generated???
4699 "\\(^\\|[^$@%&\\]\\)\\<\\("
4700 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
4701 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4702 ;; "eval" "exists" "for" "foreach" "format" "goto"
4703 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4704 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4705 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4706 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4707 ;; "undef" "unless" "unshift" "untie" "until" "use"
4709 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
4710 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
4711 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
4712 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
4713 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
4714 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
4715 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
4716 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
4717 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
4718 "\\|[sm]" ; Added manually
4719 "\\)\\>") 2 'cperl-nonoverridable)
4720 ;; (mapconcat 'identity
4721 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4722 ;; "#include" "#define" "#undef")
4724 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
4725 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
4726 '("\\<sub[ \t]+\\([^ \t{;()]+\\)[ \t]*\\(([^()]*)[ \t]*\\)?[#{\n]" 1
4727 font-lock-function-name-face)
4728 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4729 2 font-lock-function-name-face)
4730 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
4731 1 font-lock-function-name-face)
4732 (cond ((featurep 'font-lock-extra)
4733 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4734 (2 font-lock-string-face t)
4735 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
4737 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4738 (2 font-lock-string-face t)
4739 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4741 (1 font-lock-string-face t))))
4742 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4743 2 font-lock-string-face t)))
4744 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
4745 font-lock-string-face t)
4746 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
4747 font-lock-constant-face) ; labels
4748 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
4749 2 font-lock-constant-face)
4750 ;; Uncomment to get perl-mode-like vars
4751 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
4752 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
4753 ;;; (2 (cons font-lock-variable-name-face '(underline))))
4754 (cond ((featurep 'font-lock-extra)
4755 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4756 (3 font-lock-variable-name-face)
4758 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4759 (1 font-lock-variable-name-face)
4760 (2 '(restart 2 nil) nil t)))
4761 nil t))) ; local variables, multiple
4763 '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4764 (3 font-lock-variable-name-face)
4765 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)"
4767 (1 font-lock-variable-name-face))))
4768 (t '("^[ \t{}]*\\(my\\|local\\our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4769 3 font-lock-variable-name-face)))
4770 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
4771 4 font-lock-variable-name-face)
4772 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
4773 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
4774 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
4776 t-font-lock-keywords-1
4777 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4778 (not cperl-xemacs-p) ; not yet as of XEmacs 19.12
4780 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
4781 (if (eq (char-after (match-beginning 2)) ?%)
4784 t) ; arrays and hashes
4785 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
4787 (if (= (- (match-end 2) (match-beginning 2)) 1)
4788 (if (eq (char-after (match-beginning 3)) ?{)
4790 'cperl-array) ; arrays and hashes
4791 font-lock-variable-name-face) ; Just to put something
4793 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4794 ;;; Too much noise from \s* @s[ and friends
4795 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
4796 ;;(3 font-lock-function-name-face t t)
4798 ;; (if (cperl-slash-is-regexp)
4799 ;; font-lock-function-name-face 'default) nil t))
4801 (if cperl-highlight-variables-indiscriminately
4802 (setq t-font-lock-keywords-1
4803 (append t-font-lock-keywords-1
4804 (list '("[$*]{?\\(\\sw+\\)" 1
4805 font-lock-variable-name-face)))))
4806 (setq cperl-font-lock-keywords-1
4807 (if cperl-syntaxify-by-font-lock
4808 (cons 'cperl-fontify-update
4809 t-font-lock-keywords)
4810 t-font-lock-keywords)
4811 cperl-font-lock-keywords cperl-font-lock-keywords-1
4812 cperl-font-lock-keywords-2 (append
4813 cperl-font-lock-keywords-1
4814 t-font-lock-keywords-1)))
4815 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
4816 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
4817 (eval ; Avoid a warning
4818 '(font-lock-require-faces
4820 ;; Color-light Color-dark Gray-light Gray-dark Mono
4821 (list 'font-lock-comment-face
4822 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
4827 (list 'font-lock-string-face
4828 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
4833 (list 'font-lock-function-name-face
4835 "Blue" "LightSkyBlue" "Gray50" "LightGray"
4836 (cdr (assq 'background-color ; if mono
4837 (frame-parameters))))
4840 (cdr (assq 'foreground-color ; if mono
4841 (frame-parameters))))
4845 (list 'font-lock-variable-name-face
4846 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
4851 (list 'font-lock-type-face
4852 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
4857 (list 'font-lock-constant-face
4858 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
4863 (list 'cperl-nonoverridable
4864 ["chartreuse3" ("orchid1" "orange")
4871 ["blue" "yellow" nil "Gray80"]
4872 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4878 ["red" "red" nil "Gray80"]
4879 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4884 ;; Do it the dull way, without choose-color
4885 (defvar cperl-guessed-background nil
4886 "Display characteristics as guessed by cperl.")
4887 ;; (or (fboundp 'x-color-defined-p)
4888 ;; (defalias 'x-color-defined-p
4889 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4890 ;; ;; XEmacs >= 19.12
4891 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4893 ;; (t 'x-valid-color-name-p))))
4894 (cperl-force-face font-lock-constant-face
4895 "Face for constant and label names")
4896 (cperl-force-face font-lock-variable-name-face
4897 "Face for variable names")
4898 (cperl-force-face font-lock-type-face
4899 "Face for data types")
4900 (cperl-force-face cperl-nonoverridable
4901 "Face for data types from another group")
4902 (cperl-force-face font-lock-comment-face
4903 "Face for comments")
4904 (cperl-force-face font-lock-function-name-face
4905 "Face for function names")
4906 (cperl-force-face cperl-hash
4908 (cperl-force-face cperl-array
4910 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4911 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4912 ;;(or (boundp 'font-lock-type-face)
4913 ;; (defconst font-lock-type-face
4914 ;; 'font-lock-type-face
4915 ;; "Face to use for data types."))
4916 ;;(or (boundp 'cperl-nonoverridable-face)
4917 ;; (defconst cperl-nonoverridable-face
4918 ;; 'cperl-nonoverridable
4919 ;; "Face to use for data types from another group."))
4920 ;;(if (not cperl-xemacs-p) nil
4921 ;; (or (boundp 'font-lock-comment-face)
4922 ;; (defconst font-lock-comment-face
4923 ;; 'font-lock-comment-face
4924 ;; "Face to use for comments."))
4925 ;; (or (boundp 'font-lock-keyword-face)
4926 ;; (defconst font-lock-keyword-face
4927 ;; 'font-lock-keyword-face
4928 ;; "Face to use for keywords."))
4929 ;; (or (boundp 'font-lock-function-name-face)
4930 ;; (defconst font-lock-function-name-face
4931 ;; 'font-lock-function-name-face
4932 ;; "Face to use for function names.")))
4934 (not (cperl-is-face 'cperl-array))
4935 (cperl-is-face 'font-lock-emphasized-face))
4936 (copy-face 'font-lock-emphasized-face 'cperl-array))
4938 (not (cperl-is-face 'cperl-hash))
4939 (cperl-is-face 'font-lock-other-emphasized-face))
4940 (copy-face 'font-lock-other-emphasized-face 'cperl-hash))
4942 (not (cperl-is-face 'cperl-nonoverridable))
4943 (cperl-is-face 'font-lock-other-type-face))
4944 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable))
4945 ;;(or (boundp 'cperl-hash-face)
4946 ;; (defconst cperl-hash-face
4948 ;; "Face to use for hashes."))
4949 ;;(or (boundp 'cperl-array-face)
4950 ;; (defconst cperl-array-face
4952 ;; "Face to use for arrays."))
4953 ;; Here we try to guess background
4955 (if (boundp 'font-lock-background-mode)
4956 font-lock-background-mode
4958 (face-list (and (fboundp 'face-list) (face-list))))
4959 ;;;; (fset 'cperl-is-face
4960 ;;;; (cond ((fboundp 'find-face)
4961 ;;;; (symbol-function 'find-face))
4963 ;;;; (function (lambda (face) (member face face-list))))
4965 ;;;; (function (lambda (face) (boundp face))))))
4966 (defvar cperl-guessed-background
4967 (if (and (boundp 'font-lock-display-type)
4968 (eq font-lock-display-type 'grayscale))
4971 "Background as guessed by CPerl mode")
4972 (and (not (cperl-is-face 'font-lock-constant-face))
4973 (cperl-is-face 'font-lock-reference-face)
4974 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
4975 (if (cperl-is-face 'font-lock-type-face) nil
4976 (copy-face 'default 'font-lock-type-face)
4978 ((eq background 'light)
4979 (set-face-foreground 'font-lock-type-face
4980 (if (x-color-defined-p "seagreen")
4983 ((eq background 'dark)
4984 (set-face-foreground 'font-lock-type-face
4985 (if (x-color-defined-p "os2pink")
4989 (set-face-background 'font-lock-type-face "gray90"))))
4990 (if (cperl-is-face 'cperl-nonoverridable)
4992 (copy-face 'font-lock-type-face 'cperl-nonoverridable)
4994 ((eq background 'light)
4995 (set-face-foreground 'cperl-nonoverridable
4996 (if (x-color-defined-p "chartreuse3")
4999 ((eq background 'dark)
5000 (set-face-foreground 'cperl-nonoverridable
5001 (if (x-color-defined-p "orchid1")
5004 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
5005 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
5007 ;;; ((eq background 'light)
5008 ;;; (set-face-background 'font-lock-other-emphasized-face
5009 ;;; (if (x-color-defined-p "lightyellow2")
5011 ;;; (if (x-color-defined-p "lightyellow")
5013 ;;; "light yellow"))))
5014 ;;; ((eq background 'dark)
5015 ;;; (set-face-background 'font-lock-other-emphasized-face
5016 ;;; (if (x-color-defined-p "navy")
5018 ;;; (if (x-color-defined-p "darkgreen")
5020 ;;; "dark green"))))
5021 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
5022 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
5023 ;;; (copy-face 'bold 'font-lock-emphasized-face)
5025 ;;; ((eq background 'light)
5026 ;;; (set-face-background 'font-lock-emphasized-face
5027 ;;; (if (x-color-defined-p "lightyellow2")
5029 ;;; "lightyellow")))
5030 ;;; ((eq background 'dark)
5031 ;;; (set-face-background 'font-lock-emphasized-face
5032 ;;; (if (x-color-defined-p "navy")
5034 ;;; (if (x-color-defined-p "darkgreen")
5036 ;;; "dark green"))))
5037 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
5038 (if (cperl-is-face 'font-lock-variable-name-face) nil
5039 (copy-face 'italic 'font-lock-variable-name-face))
5040 (if (cperl-is-face 'font-lock-constant-face) nil
5041 (copy-face 'italic 'font-lock-constant-face))))
5042 (setq cperl-faces-init t))
5043 (error (message "cperl-init-faces (ignored): %s" errs))))
5046 (defun cperl-ps-print-init ()
5047 "Initialization of `ps-print' components for faces used in CPerl."
5048 (eval-after-load "ps-print"
5049 '(setq ps-bold-faces
5050 ;; font-lock-variable-name-face
5051 ;; font-lock-constant-face
5052 (append '(cperl-array cperl-hash)
5055 ;; font-lock-constant-face
5056 (append '(cperl-nonoverridable cperl-hash)
5059 ;; font-lock-type-face
5060 (append '(cperl-array cperl-hash underline cperl-nonoverridable)
5061 ps-underlined-faces))))
5063 (defvar ps-print-face-extension-alist)
5065 (defun cperl-ps-print (&optional file)
5066 "Pretty-print in CPerl style.
5067 If optional argument FILE is an empty string, prints to printer, otherwise
5068 to the file FILE. If FILE is nil, prompts for a file name.
5070 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
5073 (setq file (read-from-minibuffer
5074 "Print to file (if empty - to printer): "
5075 (concat (buffer-file-name) ".ps")
5076 nil nil 'file-name-history)))
5077 (or (> (length file) 0)
5079 (require 'ps-print) ; To get ps-print-face-extension-alist
5080 (let ((ps-print-color-p t)
5081 (ps-print-face-extension-alist ps-print-face-extension-alist))
5082 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
5083 (ps-print-buffer-with-faces file)))
5085 ;;; (defun cperl-ps-print-init ()
5086 ;;; "Initialization of `ps-print' components for faces used in CPerl."
5087 ;;; ;; Guard against old versions
5088 ;;; (defvar ps-underlined-faces nil)
5089 ;;; (defvar ps-bold-faces nil)
5090 ;;; (defvar ps-italic-faces nil)
5091 ;;; (setq ps-bold-faces
5092 ;;; (append '(font-lock-emphasized-face
5094 ;;; font-lock-keyword-face
5095 ;;; font-lock-variable-name-face
5096 ;;; font-lock-constant-face
5097 ;;; font-lock-reference-face
5098 ;;; font-lock-other-emphasized-face
5101 ;;; (setq ps-italic-faces
5102 ;;; (append '(cperl-nonoverridable
5103 ;;; font-lock-constant-face
5104 ;;; font-lock-reference-face
5105 ;;; font-lock-other-emphasized-face
5107 ;;; ps-italic-faces))
5108 ;;; (setq ps-underlined-faces
5109 ;;; (append '(font-lock-emphasized-face
5111 ;;; font-lock-other-emphasized-face
5113 ;;; cperl-nonoverridable font-lock-type-face)
5114 ;;; ps-underlined-faces))
5115 ;;; (cons 'font-lock-type-face ps-underlined-faces))
5118 (if (cperl-enable-font-lock) (cperl-windowed-init))
5120 (defconst cperl-styles-entries
5121 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
5122 cperl-label-offset cperl-extra-newline-before-brace
5123 cperl-merge-trailing-else
5124 cperl-continued-statement-offset))
5126 (defconst cperl-style-alist
5127 '(("CPerl" ; =GNU without extra-newline-before-brace
5128 (cperl-indent-level . 2)
5129 (cperl-brace-offset . 0)
5130 (cperl-continued-brace-offset . 0)
5131 (cperl-label-offset . -2)
5132 (cperl-extra-newline-before-brace . nil)
5133 (cperl-merge-trailing-else . t)
5134 (cperl-continued-statement-offset . 2))
5135 ("PerlStyle" ; CPerl with 4 as indent
5136 (cperl-indent-level . 4)
5137 (cperl-brace-offset . 0)
5138 (cperl-continued-brace-offset . 0)
5139 (cperl-label-offset . -4)
5140 (cperl-extra-newline-before-brace . nil)
5141 (cperl-merge-trailing-else . t)
5142 (cperl-continued-statement-offset . 4))
5144 (cperl-indent-level . 2)
5145 (cperl-brace-offset . 0)
5146 (cperl-continued-brace-offset . 0)
5147 (cperl-label-offset . -2)
5148 (cperl-extra-newline-before-brace . t)
5149 (cperl-merge-trailing-else . nil)
5150 (cperl-continued-statement-offset . 2))
5152 (cperl-indent-level . 5)
5153 (cperl-brace-offset . 0)
5154 (cperl-continued-brace-offset . -5)
5155 (cperl-label-offset . -5)
5156 ;;(cperl-extra-newline-before-brace . nil) ; ???
5157 (cperl-merge-trailing-else . nil)
5158 (cperl-continued-statement-offset . 5))
5160 (cperl-indent-level . 4)
5161 (cperl-brace-offset . 0)
5162 (cperl-continued-brace-offset . -4)
5163 (cperl-label-offset . -4)
5164 ;;(cperl-extra-newline-before-brace . nil) ; ???
5165 (cperl-continued-statement-offset . 4))
5167 (cperl-indent-level . 4)
5168 (cperl-brace-offset . 0)
5169 (cperl-continued-brace-offset . -4)
5170 (cperl-label-offset . -4)
5171 (cperl-continued-statement-offset . 4)
5172 (cperl-merge-trailing-else . nil)
5173 (cperl-extra-newline-before-brace . t))
5176 (cperl-indent-level . 4)
5177 (cperl-brace-offset . 0)
5178 (cperl-continued-brace-offset . 0)
5179 (cperl-label-offset . -4)
5180 ;;(cperl-extra-newline-before-brace . nil) ; ???
5181 (cperl-continued-statement-offset . 4)))
5182 "(Experimental) list of variables to set to get a particular indentation style.
5183 Should be used via `cperl-set-style' or via Perl menu.")
5185 (defun cperl-set-style (style)
5186 "Set CPerl mode variables to use one of several different indentation styles.
5187 The arguments are a string representing the desired style.
5188 The list of styles is in `cperl-style-alist', available styles
5189 are GNU, K&R, BSD, C++ and Whitesmith.
5191 The current value of style is memorized (unless there is a memorized
5192 data already), may be restored by `cperl-set-style-back'.
5194 Chosing \"Current\" style will not change style, so this may be used for
5195 side-effect of memorizing only."
5197 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
5198 cperl-style-alist)))
5199 (list (completing-read "Enter style: " list nil 'insist))))
5201 (setq cperl-old-style
5204 (cons name (eval name))))
5205 cperl-styles-entries)))
5206 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
5208 (setq setting (car style) style (cdr style))
5209 (set (car setting) (cdr setting)))))
5211 (defun cperl-set-style-back ()
5212 "Restore a style memorized by `cperl-set-style'."
5214 (or cperl-old-style (error "The style was not changed"))
5216 (while cperl-old-style
5217 (setq setting (car cperl-old-style)
5218 cperl-old-style (cdr cperl-old-style))
5219 (set (car setting) (cdr setting)))))
5221 (defun cperl-check-syntax ()
5223 (require 'mode-compile)
5224 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
5225 (eval '(mode-compile)))) ; Avoid a warning
5227 (defun cperl-info-buffer (type)
5228 ;; Returns buffer with documentation. Creates if missing.
5229 ;; If TYPE, this vars buffer.
5230 ;; Special care is taken to not stomp over an existing info buffer
5231 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
5232 (info (get-buffer bname))
5233 (oldbuf (get-buffer "*info*")))
5235 (save-window-excursion
5240 (rename-buffer "*info-perl-tmp*")))
5241 (save-window-excursion
5243 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
5244 (set-buffer "*info*")
5245 (rename-buffer bname)
5247 (set-buffer "*info-perl-tmp*")
5248 (rename-buffer "*info*")
5249 (set-buffer bname)))
5250 (make-local-variable 'window-min-height)
5251 (setq window-min-height 2)
5252 (current-buffer)))))
5254 (defun cperl-word-at-point (&optional p)
5255 "Return the word at point or at P."
5257 (if p (goto-char p))
5258 (or (cperl-word-at-point-hard)
5261 (funcall (or (and (boundp 'find-tag-default-function)
5262 find-tag-default-function)
5263 (get major-mode 'find-tag-default-function)
5264 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
5265 ;; automatically used within `find-tag-default':
5266 'find-tag-default))))))
5268 (defun cperl-info-on-command (command)
5269 "Show documentation for Perl command COMMAND in other window.
5270 If perl-info buffer is shown in some frame, uses this frame.
5271 Customized by setting variables `cperl-shrink-wrap-info-frame',
5272 `cperl-max-help-size'."
5274 (let* ((default (cperl-word-at-point))
5276 (format "Find doc for Perl function (default %s): "
5278 (list (if (equal read "")
5282 (let ((buffer (current-buffer))
5283 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
5284 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
5285 max-height char-height buf-list)
5286 (if (string-match "^-[a-zA-Z]$" command)
5287 (setq cmd-desc "^-X[ \t\n]"))
5288 (setq isvar (string-match "^[$@%]" command)
5289 buf (cperl-info-buffer isvar)
5290 iniwin (selected-window)
5291 fr1 (window-frame iniwin))
5293 (goto-char (point-min))
5295 (progn (re-search-forward "^-X[ \t\n]")
5297 (if (re-search-forward cmd-desc nil t)
5299 ;; Go back to beginning of the group (ex, for qq)
5300 (if (re-search-backward "^[ \t\n\f]")
5305 buf-list (list buf "*info-perl-var*" "*info-perl*"))
5306 (while (and (not win) buf-list)
5307 (setq win (get-buffer-window (car buf-list) t))
5308 (setq buf-list (cdr buf-list)))
5310 (eq (window-buffer win) buf)
5311 (set-window-buffer win buf))
5312 (and win (setq fr2 (window-frame win)))
5313 (if (or (not fr2) (eq fr1 fr2))
5315 (special-display-popup-frame buf) ; Make it visible
5316 (select-window win))
5317 (goto-char pos) ; Needed (?!).
5319 (setq iniheight (window-height)
5320 frheight (frame-height)
5321 not-loner (< iniheight (1- frheight))) ; Are not alone
5322 (cond ((if not-loner cperl-max-help-size
5323 cperl-shrink-wrap-info-frame)
5329 (if (re-search-forward
5330 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
5331 (match-beginning 0) (point-max)))))
5334 (/ (* (- frheight 3) cperl-max-help-size) 100)
5335 (setq char-height (frame-char-height))
5336 ;; Non-functioning under OS/2:
5337 (if (eq char-height 1) (setq char-height 18))
5338 ;; Title, menubar, + 2 for slack
5339 (- (/ (x-display-pixel-height) char-height) 4)))
5340 (if (> height max-height) (setq height max-height))
5341 ;;(message "was %s doing %s" iniheight height)
5343 (enlarge-window (- height iniheight))
5344 (set-frame-height (window-frame win) (1+ height)))))
5345 (set-window-start (selected-window) pos))
5346 (message "No entry for %s found." command))
5347 ;;(pop-to-buffer buffer)
5348 (select-window iniwin)))
5350 (defun cperl-info-on-current-command ()
5351 "Show documentation for Perl command at point in other window."
5353 (cperl-info-on-command (cperl-word-at-point)))
5355 (defun cperl-imenu-info-imenu-search ()
5356 (if (looking-at "^-X[ \t\n]") nil
5358 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
5361 (defun cperl-imenu-info-imenu-name ()
5363 (match-beginning 1) (match-end 1)))
5365 (defun cperl-imenu-on-info ()
5367 (let* ((buffer (current-buffer))
5368 imenu-create-index-function
5369 imenu-prev-index-position-function
5370 imenu-extract-index-name-function
5371 (index-item (save-restriction
5372 (save-window-excursion
5373 (set-buffer (cperl-info-buffer nil))
5374 (setq imenu-create-index-function
5375 'imenu-default-create-index-function
5376 imenu-prev-index-position-function
5377 'cperl-imenu-info-imenu-search
5378 imenu-extract-index-name-function
5379 'cperl-imenu-info-imenu-name)
5380 (imenu-choose-buffer-index)))))
5384 (pop-to-buffer "*info-perl*")
5386 ((markerp (cdr index-item))
5387 (goto-char (marker-position (cdr index-item))))
5389 (goto-char (cdr index-item))))
5390 (set-window-start (selected-window) (point))
5391 (pop-to-buffer buffer)))))
5393 (defun cperl-lineup (beg end &optional step minshift)
5394 "Lineup construction in a region.
5395 Beginning of region should be at the start of a construction.
5396 All first occurrences of this construction in the lines that are
5397 partially contained in the region are lined up at the same column.
5399 MINSHIFT is the minimal amount of space to insert before the construction.
5400 STEP is the tabwidth to position constructions.
5401 If STEP is nil, `cperl-lineup-step' will be used
5402 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
5403 Will not move the position at the start to the left."
5405 (let (search col tcol seen b e)
5409 (setq end (point-marker))
5411 (skip-chars-forward " \t\f")
5412 (setq beg (point-marker))
5413 (indent-region beg end nil)
5415 (setq col (current-column))
5416 (if (looking-at "[a-zA-Z0-9_]")
5417 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
5421 (buffer-substring (match-beginning 0)
5422 (match-end 0))) "\\>"))
5423 (error "Cannot line up in a middle of the word"))
5424 (if (looking-at "$")
5425 (error "Cannot line up end of line"))
5426 (setq search (regexp-quote (char-to-string (following-char)))))
5427 (setq step (or step cperl-lineup-step cperl-indent-level))
5428 (or minshift (setq minshift 1))
5430 (beginning-of-line 2)
5431 (and (< (point) end)
5432 (re-search-forward search end t)
5433 (goto-char (match-beginning 0))))
5434 (setq tcol (current-column) seen t)
5435 (if (> tcol col) (setq col tcol)))
5437 (error "The construction to line up occurred only once"))
5439 (setq col (+ col minshift))
5440 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5444 (skip-chars-backward " \t")
5445 (delete-region (point) e)
5446 (indent-to-column col) ;(make-string (- col (current-column)) ?\ ))
5447 (beginning-of-line 2)
5448 (and (< (point) end)
5449 (re-search-forward search end t)
5450 (goto-char (match-beginning 0)))))))) ; No body
5452 (defun cperl-etags (&optional add all files)
5453 "Run etags with appropriate options for Perl files.
5454 If optional argument ALL is `recursive', will process Perl files
5455 in subdirectories too."
5458 (args '("-l" "none" "-r" "/\\<\\(package\\|sub\\)[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([{#]\\|$\\)\\)/\\4/"))
5460 (if add (setq args (cons "-a" args)))
5461 (or files (setq files (list buffer-file-name)))
5463 ((eq all 'recursive)
5464 ;;(error "Not implemented: recursive")
5465 (setq args (append (list "-e"
5466 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
5468 find(\\&wanted, '.');
5473 ;;(error "Not implemented: all")
5474 (setq args (append (list "-e"
5475 "push @ARGV, <*.PL *.pl *.pm>;
5480 (setq args (append args files))))
5481 (setq res (apply 'call-process cmd nil nil nil args))
5483 (message "etags returned \"%s\"" res))))
5485 (defun cperl-toggle-auto-newline ()
5486 "Toggle the state of `cperl-auto-newline'."
5488 (setq cperl-auto-newline (not cperl-auto-newline))
5489 (message "Newlines will %sbe auto-inserted now."
5490 (if cperl-auto-newline "" "not ")))
5492 (defun cperl-toggle-abbrev ()
5493 "Toggle the state of automatic keyword expansion in CPerl mode."
5495 (abbrev-mode (if abbrev-mode 0 1))
5496 (message "Perl control structure will %sbe auto-inserted now."
5497 (if abbrev-mode "" "not ")))
5500 (defun cperl-toggle-electric ()
5501 "Toggle the state of parentheses doubling in CPerl mode."
5503 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5504 (message "Parentheses will %sbe auto-doubled now."
5505 (if (cperl-val 'cperl-electric-parens) "" "not ")))
5507 (defun cperl-toggle-autohelp ()
5508 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
5509 Delay of auto-help controlled by `cperl-lazy-help-time'."
5511 (if (fboundp 'run-with-idle-timer)
5513 (if cperl-lazy-installed
5514 (cperl-lazy-unstall)
5515 (cperl-lazy-install))
5516 (message "Perl help messages will %sbe automatically shown now."
5517 (if cperl-lazy-installed "" "not ")))
5518 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
5520 (defun cperl-toggle-construct-fix ()
5521 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
5523 (setq cperl-indent-region-fix-constructs
5524 (if cperl-indent-region-fix-constructs
5527 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
5528 (if cperl-indent-region-fix-constructs "" "not ")))
5530 ;;;; Tags file creation.
5532 (defvar cperl-tmp-buffer " *cperl-tmp*")
5534 (defun cperl-setup-tmp-buf ()
5535 (set-buffer (get-buffer-create cperl-tmp-buffer))
5536 (set-syntax-table cperl-mode-syntax-table)
5537 (buffer-disable-undo)
5539 (if cperl-use-syntax-table-text-property-for-tags
5541 (make-local-variable 'parse-sexp-lookup-properties)
5542 ;; Do not introduce variable if not needed, we check it!
5543 (set 'parse-sexp-lookup-properties t))))
5545 (defun cperl-xsub-scan ()
5547 (let ((index-alist '())
5548 (prev-pos 0) index index1 name package prefix)
5549 (goto-char (point-min))
5550 ;; Search for the function
5551 (progn ;;save-match-data
5552 (while (re-search-forward
5553 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5556 ((match-beginning 2) ; SECTION
5557 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
5558 (goto-char (match-beginning 0))
5559 (skip-chars-forward " \t")
5561 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
5562 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
5564 ((not package) nil) ; C language section
5565 ((match-beginning 3) ; XSUB
5566 (goto-char (1+ (match-beginning 3)))
5567 (setq index (imenu-example--name-and-position))
5568 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
5569 (if (and prefix (string-match (concat "^" prefix) name))
5570 (setq name (substring name (length prefix))))
5571 (cond ((string-match "::" name) nil)
5573 (setq index1 (cons (concat package "::" name) (cdr index)))
5574 (push index1 index-alist)))
5576 (push index index-alist))
5578 ;; (beginning-of-line)
5579 (setq index (imenu-example--name-and-position))
5580 (setcar index (concat package "::BOOT:"))
5581 (push index index-alist)))))
5584 (defvar cperl-unreadable-ok nil)
5586 (defun cperl-find-tags (ifile xs topdir)
5587 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
5588 (cperl-pod-here-fontify nil) f file)
5590 (if b (set-buffer b)
5591 (cperl-setup-tmp-buf))
5594 (setq file (car (insert-file-contents ifile)))
5595 (error (if cperl-unreadable-ok nil
5597 (format "File %s unreadable. Continue? " ifile))
5598 (setq cperl-unreadable-ok t)
5599 (error "Aborting: unreadable file %s" ifile)))))
5601 (message "Unreadable file %s" ifile)
5602 (message "Scanning file %s ..." file)
5603 (if (and cperl-use-syntax-table-text-property-for-tags
5605 (condition-case err ; after __END__ may have garbage
5606 (cperl-find-pods-heres nil nil noninteractive)
5607 (error (message "While scanning for syntax: %s" err))))
5609 (setq lst (cperl-xsub-scan))
5610 (setq ind (cperl-imenu--create-perl-index))
5611 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
5616 (cond ((string-match "^[_a-zA-Z]" (car elt))
5617 (goto-char (cdr elt))
5618 (beginning-of-line) ; pos should be of the start of the line
5621 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
5622 (buffer-substring (progn
5623 (goto-char (cdr elt))
5624 ;; After name now...
5625 (or (eolp) (forward-char 1))
5633 (setq elt (car lst) lst (cdr lst))
5638 (if (string-match "^package " (car elt))
5639 (substring (car elt) 8)
5642 (number-to-string (elt elt 2)) ; Line
5644 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
5646 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
5647 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
5649 ;; Need to insert the name without package as well
5650 (setq lst (cons (cons (substring (elt elt 3)
5658 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5659 (set-text-properties 0 (length rel) nil rel)
5660 (and (equal topdir (substring rel 0 (length topdir)))
5661 (setq rel (substring file (length topdir))))
5662 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
5663 (setq ret (buffer-substring 1 (point-max)))
5666 (message "Scanning file %s finished" file))
5669 (defun cperl-add-tags-recurse-noxs ()
5670 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5672 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5673 -f cperl-add-tags-recurse
5675 (cperl-write-tags nil nil t t nil t))
5677 (defun cperl-add-tags-recurse ()
5678 "Add to TAGS file data for Perl files in the current directory and kids.
5680 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5681 -f cperl-add-tags-recurse
5683 (cperl-write-tags nil nil t t))
5685 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
5686 ;; If INBUFFER, do not select buffer, and do not save
5687 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5690 (setq file (if dir default-directory (buffer-file-name)))
5691 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
5693 (setq topdir default-directory))
5694 (let ((tags-file-name "TAGS")
5695 (case-fold-search (eq system-type 'emx))
5698 (cond (inbuffer nil) ; Already there
5699 ((file-exists-p tags-file-name)
5701 (visit-tags-table-buffer)
5702 (visit-tags-table-buffer tags-file-name)))
5703 (t (set-buffer (find-file-noselect tags-file-name))))
5706 (cond ((eq erase 'ignore))
5709 (setq erase 'ignore)))
5712 (directory-files file t
5713 (if recurse nil cperl-scan-files-regexp)
5716 (if cperl-unreadable-ok nil
5718 (format "Directory %s unreadable. Continue? " file))
5719 (setq cperl-unreadable-ok t
5720 tm nil) ; Return empty list
5721 (error "Aborting: unreadable directory %s" file)))))))
5725 ((string-match cperl-noscan-files-regexp file)
5727 ((not (file-directory-p file))
5728 (if (string-match cperl-scan-files-regexp file)
5729 (cperl-write-tags file erase recurse nil t noxs topdir)))
5731 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
5734 (setq xs (string-match "\\.xs$" file))
5735 (if (not (and xs noxs))
5737 (cond ((eq erase 'ignore) (goto-char (point-max)))
5738 (erase (erase-buffer))
5742 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5743 (set-text-properties 0 (length rel) nil rel)
5744 (and (equal topdir (substring rel 0 (length topdir)))
5745 (setq rel (substring file (length topdir))))
5746 (if (search-forward (concat "\f\n" rel ",") nil t)
5748 (search-backward "\f\n")
5749 (delete-region (point)
5752 (if (search-forward "\f\n"
5756 (goto-char (point-max)))))
5757 (insert (cperl-find-tags file xs topdir))))))
5758 (if inbuffer nil ; Delegate to the caller
5759 (save-buffer 0) ; No backup
5760 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
5761 (initialize-new-tags-table))))))
5763 (defvar cperl-tags-hier-regexp-list
5770 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
5772 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
5775 (defvar cperl-hierarchy '(() ())
5776 "Global hierarchy of classes.")
5778 (defun cperl-tags-hier-fill ()
5779 ;; Suppose we are in a tag table cooked by cperl.
5781 (let (type pack name pos line chunk ord cons1 file str info fileind)
5782 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5783 (setq pos (match-beginning 0)
5784 pack (match-beginning 2))
5786 (if (looking-at (concat
5795 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
5796 name (buffer-substring (match-beginning 2) (match-end 2))
5797 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5798 line (buffer-substring (match-beginning 3) (match-end 3))
5801 fileind (format "%s:%s" file line)
5802 ;; Moves to beginning of the next line:
5803 info (cperl-etags-snarf-tag file line))
5806 ;; Make new member of hierarchy name ==> file ==> pos if needed
5807 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
5809 (setcdr cons1 (cons (cons fileind (vector file info))
5811 ;; First occurrence of the name, start alist
5812 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5814 (setcar (cdr cperl-hierarchy)
5815 (cons cons1 (nth 1 cperl-hierarchy)))
5816 (setcar cperl-hierarchy
5817 (cons cons1 (car cperl-hierarchy)))))))
5820 (defun cperl-tags-hier-init (&optional update)
5821 "Show hierarchical menu of classes and methods.
5822 Finds info about classes by a scan of loaded TAGS files.
5823 Supposes that the TAGS files contain fully qualified function names.
5824 One may build such TAGS files from CPerl mode menu."
5828 (if (or update (null (nth 2 cperl-hierarchy)))
5829 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
5832 (setcdr elt (cdr (nth 1 elt)))))))
5833 pack name cons1 to l1 l2 l3 l4 b)
5834 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5835 (setq cperl-hierarchy (list l1 l2 l3))
5836 (if cperl-xemacs-p ; Not checked
5839 ;; Does this work in XEmacs?
5840 (call-interactively 'visit-tags-table))
5841 (message "Updating list of classes...")
5842 (set-buffer (get-file-buffer tags-file-name))
5843 (cperl-tags-hier-fill))
5845 (call-interactively 'visit-tags-table))
5849 (message "Updating list of classes... %s" tagsfile)
5850 (set-buffer (get-file-buffer tagsfile))
5851 (cperl-tags-hier-fill)))
5853 (message "Updating list of classes... postprocessing..."))
5854 (mapcar remover (car cperl-hierarchy))
5855 (mapcar remover (nth 1 cperl-hierarchy))
5856 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
5857 (cons "Methods: " (car cperl-hierarchy))))
5858 (cperl-tags-treeify to 1)
5859 (setcar (nthcdr 2 cperl-hierarchy)
5860 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
5861 (message "Updating list of classes: done, requesting display...")
5862 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5864 (or (nth 2 cperl-hierarchy)
5865 (error "No items found"))
5867 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
5868 (if (if (fboundp 'display-popup-menus-p)
5869 (let ((f 'display-popup-menus-p))
5872 (x-popup-menu t (nth 2 cperl-hierarchy))
5874 (tmm-prompt (nth 2 cperl-hierarchy))))
5875 (if (and update (listp update))
5876 (progn (while (cdr update) (setq update (cdr update)))
5877 (setq update (car update)))) ; Get the last from the list
5878 (if (vectorp update)
5880 (find-file (elt update 0))
5881 (cperl-etags-goto-tag-location (elt update 1))))
5882 (if (eq update -999) (cperl-tags-hier-init t)))
5884 (defun cperl-tags-treeify (to level)
5885 ;; cadr of `to' is read-write. On start it is a cons
5886 (let* ((regexp (concat "^\\(" (mapconcat
5888 (make-list level "[_a-zA-Z0-9]+")
5891 (packages (cdr (nth 1 to)))
5892 (methods (cdr (nth 2 to)))
5893 l1 head tail cons1 cons2 ord writeto packs recurse
5894 root-packages root-functions ms many_ms same_name ps
5898 (cond ((and (string-match regexp (car elt))
5899 (or (eq ord 1) (match-end 2)))
5900 (setq head (substring (car elt) 0 (match-end 1))
5901 tail (if (match-end 2) (substring (car elt)
5904 (if (setq cons1 (assoc head writeto)) nil
5905 ;; Need to init new head
5906 (setcdr writeto (cons (list head (list "Packages: ")
5909 (setq cons1 (nth 1 writeto)))
5910 (setq cons2 (nth ord cons1)) ; Either packs or meths
5911 (setcdr cons2 (cons elt (cdr cons2))))
5913 (setq root-functions (cons elt root-functions)))
5915 (setq root-packages (cons elt root-packages))))))))
5916 (setcdr to l1) ; Init to dynamic space
5919 (mapcar move-deeper packages)
5921 (mapcar move-deeper methods)
5923 (mapcar (function (lambda (elt)
5924 (cperl-tags-treeify elt (1+ level))))
5926 ;;Now clean up leaders with one child only
5927 (mapcar (function (lambda (elt)
5928 (if (not (and (listp (cdr elt))
5929 (eq (length elt) 2))) nil
5930 (setcar elt (car (nth 1 elt)))
5931 (setcdr elt (cdr (nth 1 elt))))))
5933 ;; Sort the roots of subtrees
5934 (if (default-value 'imenu-sort-function)
5936 (sort (cdr to) (default-value 'imenu-sort-function))))
5937 ;; Now add back functions removed from display
5938 (mapcar (function (lambda (elt)
5939 (setcdr to (cons elt (cdr to)))))
5940 (if (default-value 'imenu-sort-function)
5942 (sort root-functions (default-value 'imenu-sort-function)))
5944 ;; Now add back packages removed from display
5945 (mapcar (function (lambda (elt)
5946 (setcdr to (cons (cons (concat "package " (car elt))
5949 (if (default-value 'imenu-sort-function)
5951 (sort root-packages (default-value 'imenu-sort-function)))
5955 ;;; '(keymap "Name1"
5959 ;;; ("Tail1" "x") ("Tail2" "y"))))
5961 (defun cperl-list-fold (list name limit)
5962 (let (list1 list2 elt1 (num 0))
5963 (if (<= (length list) limit) list
5964 (setq list1 nil list2 nil)
5969 (if (<= num imenu-max-items)
5970 (setq list2 (cons elt1 list2))
5971 (setq list1 (cons (cons name
5976 (nreverse (cons (cons name
5980 (defun cperl-menu-to-keymap (menu &optional name)
5986 (cond ((listp (cdr elt))
5987 (setq list (cperl-list-fold
5988 (cdr elt) (car elt) imenu-max-items))
5991 (cperl-menu-to-keymap list))))
5993 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
5994 (cperl-list-fold menu "Root" imenu-max-items)))))
5997 (defvar cperl-bad-style-regexp
5998 (mapconcat 'identity
5999 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
6000 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
6002 "Finds places such that insertion of a whitespace may help a lot.")
6004 (defvar cperl-not-bad-style-regexp
6007 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
6008 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
6009 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
6010 "<\\$?\\sw+\\(\\.\\sw+\\)?>" ; <IN> <stdin.h>
6011 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
6018 "\\\\[&$@*\\\\]" ; \&func
6021 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
6024 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
6025 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
6026 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
6030 "If matches at the start of match found by `my-bad-c-style-regexp',
6031 insertion of a whitespace will not help.")
6035 (defun cperl-find-bad-style ()
6036 "Find places in the buffer where insertion of a whitespace may help.
6037 Prompts user for insertion of spaces.
6038 Currently it is tuned to C and Perl syntax."
6040 (let (found-bad (p (point)))
6041 (setq last-nonmenu-event 13) ; To disable popup
6042 (with-no-warnings ; It is useful to push the mark here.
6043 (beginning-of-buffer))
6044 (map-y-or-n-p "Insert space here? "
6045 (lambda (arg) (insert " "))
6046 'cperl-next-bad-style
6047 '("location" "locations" "insert a space into")
6048 '((?\C-r (lambda (arg)
6049 (let ((buffer-quit-function
6050 'exit-recursive-edit))
6051 (message "Exit with Esc Esc")
6053 t)) ; Consider acted upon
6054 "edit, exit with Esc Esc")
6056 (let ((buffer-quit-function
6057 'exit-recursive-edit))
6058 (message "Exit with Esc Esc")
6060 t)) ; Consider acted upon
6061 "edit, exit with Esc Esc"))
6063 (if found-bad (goto-char found-bad)
6065 (message "No appropriate place found"))))
6067 (defun cperl-next-bad-style ()
6068 (let (p (not-found t) (point (point)) found)
6069 (while (and not-found
6070 (re-search-forward cperl-bad-style-regexp nil 'to-end))
6072 (goto-char (match-beginning 0))
6074 (looking-at cperl-not-bad-style-regexp)
6075 ;; Check for a < -b and friends
6076 (and (eq (following-char) ?\-)
6078 (skip-chars-backward " \t\n")
6079 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
6080 ;; Now check for syntax type
6082 (setq found (point))
6083 (beginning-of-defun)
6084 (let ((pps (parse-partial-sexp (point) found)))
6085 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
6086 (goto-char (match-end 0))
6094 (defvar cperl-have-help-regexp
6098 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
6099 "[$@]\\^[a-zA-Z]" ; Special variable
6100 "[$@][^ \n\t]" ; Special variable
6101 "-[a-zA-Z]" ; File test
6102 "\\\\[a-zA-Z0]" ; Special chars
6103 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
6104 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
6105 "[a-zA-Z_0-9:]+" ; symbol or number
6112 "Matches places in the buffer we can find help for.")
6114 (defvar cperl-message-on-help-error t)
6115 (defvar cperl-help-from-timer nil)
6117 (defun cperl-word-at-point-hard ()
6118 ;; Does not save-excursion
6119 ;; Get to the something meaningful
6120 (or (eobp) (eolp) (forward-char 1))
6121 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
6122 (save-excursion (beginning-of-line) (point))
6125 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
6126 ;; (skip-chars-backward " \n\t\r({[]});,")
6127 ;; (or (bobp) (backward-char 1))))
6130 ((looking-at "[a-zA-Z0-9_:]") ; symbol
6131 (skip-chars-backward "a-zA-Z0-9_:")
6133 ((and (eq (preceding-char) ?^) ; $^I
6134 (eq (char-after (- (point) 2)) ?\$))
6136 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
6138 ((and (eq (preceding-char) ?\=)
6139 (eq (current-column) 1))
6140 (forward-char -1))) ; =head1
6141 (if (and (eq (preceding-char) ?\<)
6142 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
6144 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
6146 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
6148 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
6149 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
6151 ((and (eq (preceding-char) ?\$)
6152 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
6154 ((and (eq (following-char) ?\>)
6155 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
6158 (and (eq (preceding-char) ?\<)
6159 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
6160 (search-backward "<"))))
6161 ((and (eq (following-char) ?\$)
6162 (eq (preceding-char) ?\<)
6163 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
6165 (if (looking-at cperl-have-help-regexp)
6166 (buffer-substring (match-beginning 0) (match-end 0))))
6168 (defun cperl-get-help ()
6169 "Get one-line docs on the symbol at the point.
6170 The data for these docs is a little bit obsolete and may be in fact longer
6171 than a line. Your contribution to update/shorten it is appreciated."
6173 (save-match-data ; May be called "inside" query-replace
6175 (let ((word (cperl-word-at-point-hard)))
6177 (if (and cperl-help-from-timer ; Bail out if not in mainland
6178 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
6179 (or (memq (get-text-property (point) 'face)
6180 '(font-lock-comment-face font-lock-string-face))
6181 (memq (get-text-property (point) 'syntax-type)
6182 '(pod here-doc format))))
6184 (cperl-describe-perl-symbol word))
6185 (if cperl-message-on-help-error
6186 (message "Nothing found for %s..."
6187 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
6189 ;;; Stolen from perl-descr.el by Johan Vromans:
6191 (defvar cperl-doc-buffer " *perl-doc*"
6192 "Where the documentation can be found.")
6194 (defun cperl-describe-perl-symbol (val)
6195 "Display the documentation of symbol at point, a Perl operator."
6196 (let ((enable-recursive-minibuffers t)
6199 ((string-match "^[&*][a-zA-Z_]" val)
6200 (setq val (concat (substring val 0 1) "NAME")))
6201 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
6202 (setq val (concat "@" (substring val 1 (match-end 1)))))
6203 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
6204 (setq val (concat "%" (substring val 1 (match-end 1)))))
6205 ((and (string= val "x") (string-match "^x=" val))
6207 ((string-match "^\\$[\C-a-\C-z]" val)
6208 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
6209 ((string-match "^CORE::" val)
6210 (setq val "CORE::"))
6211 ((string-match "^SUPER::" val)
6212 (setq val "SUPER::"))
6213 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
6214 (setq val "<NAME>")))
6215 (setq regexp (concat "^"
6216 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
6218 "\\([ \t([/]\\|$\\)"))
6220 ;; get the buffer with the documentation text
6221 (cperl-switch-to-doc-buffer)
6223 ;; lookup in the doc
6224 (goto-char (point-min))
6225 (let ((case-fold-search nil))
6227 (if (re-search-forward regexp (point-max) t)
6229 (beginning-of-line 1)
6230 (let ((lnstart (point)))
6232 (message "%s" (buffer-substring lnstart (point)))))
6233 (if cperl-message-on-help-error
6234 (message "No definition for %s" val)))))))
6236 (defvar cperl-short-docs 'please-ignore-this-line
6237 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
6238 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
6239 ... Range (list context); flip/flop [no flop when flip] (scalar context).
6240 ! ... Logical negation.
6241 ... != ... Numeric inequality.
6242 ... !~ ... Search pattern, substitution, or translation (negated).
6243 $! In numeric context: errno. In a string context: error string.
6244 $\" The separator which joins elements of arrays interpolated in strings.
6245 $# The output format for printed numbers. Default is %.15g or close.
6246 $$ Process number of this script. Changes in the fork()ed child process.
6247 $% The current page number of the currently selected output channel.
6249 The following variables are always local to the current block:
6251 $1 Match of the 1st set of parentheses in the last match (auto-local).
6252 $2 Match of the 2nd set of parentheses in the last match (auto-local).
6253 $3 Match of the 3rd set of parentheses in the last match (auto-local).
6254 $4 Match of the 4th set of parentheses in the last match (auto-local).
6255 $5 Match of the 5th set of parentheses in the last match (auto-local).
6256 $6 Match of the 6th set of parentheses in the last match (auto-local).
6257 $7 Match of the 7th set of parentheses in the last match (auto-local).
6258 $8 Match of the 8th set of parentheses in the last match (auto-local).
6259 $9 Match of the 9th set of parentheses in the last match (auto-local).
6260 $& The string matched by the last pattern match (auto-local).
6261 $' The string after what was matched by the last match (auto-local).
6262 $` The string before what was matched by the last match (auto-local).
6264 $( The real gid of this process.
6265 $) The effective gid of this process.
6266 $* Deprecated: Set to 1 to do multiline matching within a string.
6267 $+ The last bracket matched by the last search pattern.
6268 $, The output field separator for the print operator.
6269 $- The number of lines left on the page.
6270 $. The current input line number of the last filehandle that was read.
6271 $/ The input record separator, newline by default.
6272 $0 Name of the file containing the current perl script (read/write).
6273 $: String may be broken after these characters to fill ^-lines in a format.
6274 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
6275 $< The real uid of this process.
6276 $= The page length of the current output channel. Default is 60 lines.
6277 $> The effective uid of this process.
6278 $? The status returned by the last ``, pipe close or `system'.
6279 $@ The perl error message from the last eval or do @var{EXPR} command.
6280 $ARGV The name of the current file used with <> .
6281 $[ Deprecated: The index of the first element/char in an array/string.
6282 $\\ The output record separator for the print operator.
6283 $] The perl version string as displayed with perl -v.
6284 $^ The name of the current top-of-page format.
6285 $^A The current value of the write() accumulator for format() lines.
6286 $^D The value of the perl debug (-D) flags.
6287 $^E Information about the last system error other than that provided by $!.
6288 $^F The highest system file descriptor, ordinarily 2.
6289 $^H The current set of syntax checks enabled by `use strict'.
6290 $^I The value of the in-place edit extension (perl -i option).
6291 $^L What formats output to perform a formfeed. Default is \f.
6292 $^M A buffer for emergency memory allocation when running out of memory.
6293 $^O The operating system name under which this copy of Perl was built.
6294 $^P Internal debugging flag.
6295 $^T The time the script was started. Used by -A/-M/-C file tests.
6296 $^W True if warnings are requested (perl -w flag).
6297 $^X The name under which perl was invoked (argv[0] in C-speech).
6298 $_ The default input and pattern-searching space.
6299 $| Auto-flush after write/print on current output channel? Default 0.
6300 $~ The name of the current report format.
6301 ... % ... Modulo division.
6302 ... %= ... Modulo division assignment.
6303 %ENV Contains the current environment.
6304 %INC List of files that have been require-d or do-ne.
6305 %SIG Used to set signal handlers for various signals.
6306 ... & ... Bitwise and.
6307 ... && ... Logical and.
6308 ... &&= ... Logical and assignment.
6309 ... &= ... Bitwise and assignment.
6310 ... * ... Multiplication.
6311 ... ** ... Exponentiation.
6312 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6313 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
6314 ... + ... Addition. +EXPR Makes EXPR into scalar context.
6315 ++ Auto-increment (magical on strings). ++EXPR EXPR++
6316 ... += ... Addition assignment.
6318 ... - ... Subtraction.
6319 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6320 ... -= ... Subtraction assignment.
6321 -A Access time in days since script started.
6322 -B File is a non-text (binary) file.
6323 -C Inode change time in days since script started.
6324 -M Age in days since script started.
6325 -O File is owned by real uid.
6326 -R File is readable by real uid.
6327 -S File is a socket .
6328 -T File is a text file.
6329 -W File is writable by real uid.
6330 -X File is executable by real uid.
6331 -b File is a block special file.
6332 -c File is a character special file.
6333 -d File is a directory.
6335 -f File is a plain file.
6336 -g File has setgid bit set.
6337 -k File has sticky bit set.
6338 -l File is a symbolic link.
6339 -o File is owned by effective uid.
6340 -p File is a named pipe (FIFO).
6341 -r File is readable by effective uid.
6342 -s File has non-zero size.
6343 -t Tests if filehandle (STDIN by default) is opened to a tty.
6344 -u File has setuid bit set.
6345 -w File is writable by effective uid.
6346 -x File is executable by effective uid.
6347 -z File has zero size.
6348 . Concatenate strings.
6349 .. Range (list context); flip/flop (scalar context) operator.
6350 .= Concatenate assignment strings
6351 ... / ... Division. /PATTERN/ioxsmg Pattern match
6352 ... /= ... Division assignment.
6353 /PATTERN/ioxsmg Pattern match.
6354 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6355 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6356 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6357 <> Reads line from union of files in @ARGV (= command line) and STDIN.
6358 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6359 ... <= ... Numeric less than or equal to.
6360 ... <=> ... Numeric compare.
6361 ... = ... Assignment.
6362 ... == ... Numeric equality.
6363 ... =~ ... Search pattern, substitution, or translation
6364 ... > ... Numeric greater than.
6365 ... >= ... Numeric greater than or equal to.
6366 ... >> ... Bitwise shift right.
6367 ... >>= ... Bitwise shift right assignment.
6368 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6369 ?PATTERN? One-time pattern match.
6370 @ARGV Command line arguments (not including the command name - see $0).
6371 @INC List of places to look for perl scripts during do/include/use.
6372 @_ Parameter array for subroutines; result of split() unless in list context.
6373 \\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
6374 \\0 Octal char, e.g. \\033.
6375 \\E Case modification terminator. See \\Q, \\L, and \\U.
6376 \\L Lowercase until \\E . See also \l, lc.
6377 \\U Upcase until \\E . See also \u, uc.
6378 \\Q Quote metacharacters until \\E . See also quotemeta.
6379 \\a Alarm character (octal 007).
6380 \\b Backspace character (octal 010).
6381 \\c Control character, e.g. \\c[ .
6382 \\e Escape character (octal 033).
6383 \\f Formfeed character (octal 014).
6384 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
6385 \\n Newline character (octal 012 on most systems).
6386 \\r Return character (octal 015 on most systems).
6387 \\t Tab character (octal 011).
6388 \\u Upcase the next character. See also \\U and \\l, ucfirst.
6389 \\x Hex character, e.g. \\x1b.
6390 ... ^ ... Bitwise exclusive or.
6391 __END__ Ends program source.
6392 __DATA__ Ends program source.
6393 __FILE__ Current (source) filename.
6394 __LINE__ Current line in current source.
6395 __PACKAGE__ Current package.
6396 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6397 ARGVOUT Output filehandle with -i flag.
6398 BEGIN { ... } Immediately executed (during compilation) piece of code.
6399 END { ... } Pseudo-subroutine executed after the script finishes.
6400 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
6401 INIT { ... } Pseudo-subroutine executed before the script starts running.
6402 DATA Input filehandle for what follows after __END__ or __DATA__.
6403 accept(NEWSOCKET,GENERICSOCKET)
6416 ... cmp ... String compare.
6417 connect(SOCKET,NAME)
6418 continue of { block } continue { block }. Is executed after `next' or at end.
6420 crypt(PLAINTEXT,SALT)
6422 dbmopen(%HASH,DBNAME,MODE)
6426 do { ... }|SUBR while|until EXPR executes at least once
6427 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6437 ... eq ... String equality.
6438 eval(EXPR) or eval { BLOCK }
6442 fcntl(FILEHANDLE,FUNCTION,SCALAR)
6444 flock(FILEHANDLE,OPERATION)
6445 for (EXPR;EXPR;EXPR) { ... }
6446 foreach [VAR] (@ARRAY) { ... }
6448 ... ge ... String greater than or equal.
6453 gethostbyaddr(ADDR,ADDRTYPE)
6457 getnetbyaddr(ADDR,ADDRTYPE)
6463 getpriority(WHICH,WHO)
6464 getprotobyname(NAME)
6465 getprotobynumber(NUMBER)
6470 getservbyname(NAME,PROTO)
6471 getservbyport(PORT,PROTO)
6474 getsockopt(SOCKET,LEVEL,OPTNAME)
6477 ... gt ... String greater than.
6479 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6480 index(STR,SUBSTR[,OFFSET])
6482 ioctl(FILEHANDLE,FUNCTION,SCALAR)
6487 ... le ... String less than or equal.
6489 link(OLDFILE,NEWFILE)
6490 listen(SOCKET,QUEUESIZE)
6494 lstat(EXPR|FILEHANDLE|VAR)
6495 ... lt ... String less than.
6497 mkdir(FILENAME,MODE)
6500 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6501 msgsnd(ID,MSG,FLAGS)
6502 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6503 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
6504 ... ne ... String inequality.
6507 open(FILEHANDLE[,EXPR])
6508 opendir(DIRHANDLE,EXPR)
6509 ord(EXPR) ASCII value of the first char of the string.
6511 package NAME Introduces package context.
6512 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6514 print [FILEHANDLE] [(LIST)]
6515 printf [FILEHANDLE] (FORMAT,LIST)
6517 q/STRING/ Synonym for 'STRING'
6518 qq/STRING/ Synonym for \"STRING\"
6519 qx/STRING/ Synonym for `STRING`
6521 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6524 recv(SOCKET,SCALAR,LEN,FLAGS)
6526 rename(OLDNAME,NEWNAME)
6527 require [FILENAME | PERL_VERSION]
6531 rewinddir(DIRHANDLE)
6532 rindex(STR,SUBSTR[,OFFSET])
6534 s/PATTERN/REPLACEMENT/gieoxsm
6536 seek(FILEHANDLE,POSITION,WHENCE)
6537 seekdir(DIRHANDLE,POS)
6538 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6539 semctl(ID,SEMNUM,CMD,ARG)
6540 semget(KEY,NSEMS,SIZE,FLAGS)
6542 send(SOCKET,MSG,FLAGS[,TO])
6544 sethostent(STAYOPEN)
6547 setpriority(WHICH,WHO,PRIORITY)
6548 setprotoent(STAYOPEN)
6550 setservent(STAYOPEN)
6551 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6554 shmget(KEY,SIZE,FLAGS)
6555 shmread(ID,VAR,POS,SIZE)
6556 shmwrite(ID,STRING,POS,SIZE)
6557 shutdown(SOCKET,HOW)
6560 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6561 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6562 sort [SUBROUTINE] (LIST)
6563 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6564 split[(/PATTERN/[,EXPR[,LIMIT]])]
6565 sprintf(FORMAT,LIST)
6568 stat(EXPR|FILEHANDLE|VAR)
6570 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6571 substr(EXPR,OFFSET[,LEN])
6572 symlink(OLDFILE,NEWFILE)
6574 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6576 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6581 tr/SEARCHLIST/REPLACEMENTLIST/cds
6582 truncate(FILE|EXPR,LENGTH)
6585 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6587 unpack(TEMPLATE,EXPR)
6589 until (EXPR) { ... } EXPR until EXPR
6592 vec(EXPR,OFFSET,BITS)
6595 wantarray Returns true if the sub/eval is called in list context.
6597 while (EXPR) { ... } EXPR while EXPR
6598 write[(EXPR|FILEHANDLE)]
6599 ... x ... Repeat string or array.
6600 x= ... Repetition assignment.
6601 y/SEARCHLIST/REPLACEMENTLIST/
6602 ... | ... Bitwise or.
6603 ... || ... Logical or.
6604 ~ ... Unary bitwise complement.
6605 #! OS interpreter indicator. If contains `perl', used for options, and -x.
6606 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6607 CORE:: Prefix to access builtin function if imported sub obscures it.
6608 SUPER:: Prefix to lookup for a method in @ISA classes.
6609 DESTROY Shorthand for `sub DESTROY {...}'.
6610 ... EQ ... Obsolete synonym of `eq'.
6611 ... GE ... Obsolete synonym of `ge'.
6612 ... GT ... Obsolete synonym of `gt'.
6613 ... LE ... Obsolete synonym of `le'.
6614 ... LT ... Obsolete synonym of `lt'.
6615 ... NE ... Obsolete synonym of `ne'.
6616 abs [ EXPR ] absolute value
6617 ... and ... Low-precedence synonym for &&.
6618 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6619 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6620 chr Converts a number to char with the same ordinal.
6621 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6622 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6623 exists $HASH{KEY} True if the key exists.
6624 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6625 formline PICTURE, LIST Backdoor into \"format\" processing.
6626 glob EXPR Synonym of <EXPR>.
6627 lc [ EXPR ] Returns lowercased EXPR.
6628 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
6629 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
6630 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6631 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6632 not ... Low-precedence synonym for ! - negation.
6633 ... or ... Low-precedence synonym for ||.
6634 pos STRING Set/Get end-position of the last match over this string, see \\G.
6635 quotemeta [ EXPR ] Quote regexp metacharacters.
6636 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6637 readline FH Synonym of <FH>.
6638 readpipe CMD Synonym of `CMD`.
6639 ref [ EXPR ] Type of EXPR when dereferenced.
6640 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6641 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6642 tied Returns internal object for a tied data.
6643 uc [ EXPR ] Returns upcased EXPR.
6644 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6645 untie VAR Unlink an object from a simple Perl variable.
6646 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6647 ... xor ... Low-precedence synonym for exclusive or.
6648 prototype \&SUB Returns prototype of the function given a reference.
6649 =head1 Top-level heading.
6650 =head2 Second-level heading.
6651 =head3 Third-level heading (is there such?).
6652 =over [ NUMBER ] Start list.
6653 =item [ TITLE ] Start new item in the list.
6655 =cut Switch from POD to Perl.
6656 =pod Switch from Perl to POD.
6659 (defun cperl-switch-to-doc-buffer (&optional interactive)
6660 "Go to the perl documentation buffer and insert the documentation."
6662 (let ((buf (get-buffer-create cperl-doc-buffer)))
6664 (switch-to-buffer-other-window buf)
6666 (if (= (buffer-size) 0)
6668 (insert (documentation-property 'cperl-short-docs
6669 'variable-documentation))
6670 (setq buffer-read-only t)))))
6672 (defun cperl-beautify-regexp-piece (b e embed level)
6673 ;; b is before the starting delimiter, e before the ending
6674 ;; e should be a marker, may be changed, but remains "correct".
6675 ;; EMBED is nil iff we process the whole REx.
6676 ;; The REx is guarantied to have //x
6677 ;; LEVEL shows how many levels deep to go
6678 ;; position at enter and at leave is not defined
6679 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
6683 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
6687 ((looking-at "(\\?[^a-zA-Z]")
6689 ((looking-at "(\\?") ; (?i)
6693 (setq c (if embed (current-indentation) (1- (current-column)))
6694 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
6695 (or (looking-at "[ \t]*[\n#]")
6700 (if (re-search-forward "[^ \t]" e t)
6701 (progn ; Something before the ending delimiter
6703 (delete-horizontal-space)
6705 (indent-to-column c)
6706 (set-marker e (point))))
6709 (while (< (point) (marker-position e))
6713 (skip-chars-forward " \t")
6714 (delete-region s (point))
6715 (indent-to-column c1)
6719 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
6720 "\\|" ; Embedded variable
6721 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
6724 "\\|" ; simple-code simple-code*?
6725 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
6729 "\\((\\(\\?\\)?\\)" ; 7 8
6732 (goto-char (match-end 0))
6734 (cond ((match-beginning 1) ; Alphanum word + junk
6736 ((or (match-beginning 3) ; $ab[12]
6737 (and (match-beginning 5) ; X* X+ X{2,3}
6738 (eq (preceding-char) ?\{)))
6741 ((match-beginning 6) ; []
6743 (if (looking-at "\\^?\\]")
6744 (goto-char (match-end 0)))
6745 ;; XXXX POSIX classes?!
6746 (while (and (not pos)
6747 (re-search-forward "\\[:\\|\\]" e t))
6748 (if (eq (preceding-char) ?:)
6749 (or (re-search-forward ":\\]" e t)
6750 (error "[:POSIX:]-group in []-group not terminated"))
6752 (or (eq (preceding-char) ?\])
6753 (error "[]-group not terminated"))
6754 (if (eq (following-char) ?\{)
6757 (and (eq (following-char) ??)
6759 (re-search-forward "\\=\\([*+?]\\??\\)" e t)))
6760 ((match-beginning 7) ; ()
6761 (goto-char (match-beginning 0))
6762 (setq pos (current-column))
6765 (delete-horizontal-space)
6767 (indent-to-column c1)))
6770 ;; (or (forward-sexp 1)
6773 ;; (error "()-group not terminated")))
6774 (set-marker m (1- (point)))
6775 (set-marker m1 (point))
6777 (if (progn ; indent rigidly if multiline
6778 ;; In fact does not make a lot of sense, since
6779 ;; the starting position can be already lost due
6780 ;; to insertion of "\n" and " "
6782 (search-forward "\n" m1 t))
6783 (indent-rigidly (point) m1 (- c1 pos)))
6784 (setq level (1- level))
6786 ((not (match-beginning 8))
6787 (cperl-beautify-regexp-piece tmp m t level))
6788 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
6790 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
6791 (goto-char (+ 2 tmp))
6793 (cperl-beautify-regexp-piece (point) m t level))
6794 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
6795 (goto-char (+ 3 tmp))
6796 (cperl-beautify-regexp-piece (point) m t level))
6798 (cperl-beautify-regexp-piece tmp m t level))))
6800 (cond ((looking-at "[*+?]\\??")
6801 (goto-char (match-end 0)))
6802 ((eq (following-char) ?\{)
6804 (if (eq (following-char) ?\?)
6806 (skip-chars-forward " \t")
6808 (if (looking-at "[#\n]")
6810 (or (eolp) (indent-for-comment))
6811 (beginning-of-line 2))
6812 (delete-horizontal-space)
6816 ((match-beginning 9) ; |
6820 (if (re-search-forward "[^ \t]" tmp t)
6823 (delete-horizontal-space)
6826 (delete-region (point) tmp))
6827 (indent-to-column c)
6829 (skip-chars-forward " \t")
6831 (if (looking-at "[#\n]")
6832 (beginning-of-line 2)
6833 (delete-horizontal-space)
6837 (or (looking-at "[ \t\n]")
6840 (skip-chars-forward " \t"))
6841 (or (looking-at "[#\n]")
6842 (error "Unknown code `%s' in a regexp"
6843 (buffer-substring (point) (1+ (point)))))
6844 (and inline (end-of-line 2)))
6845 ;; Special-case the last line of group
6846 (if (and (>= (point) (marker-position e))
6847 (/= (current-indentation) c))
6851 (skip-chars-forward " \t")
6852 (delete-region s (point))
6853 (indent-to-column c)))))
6855 (defun cperl-make-regexp-x ()
6856 ;; Returns position of the start
6857 ;; XXX this is called too often! Need to cache the result!
6859 (or cperl-use-syntax-table-text-property
6860 (error "I need to have a regexp marked!"))
6862 (if (looking-at "\\s|")
6864 (if (looking-at "\\([smy]\\|qr\\)\\s|")
6866 (re-search-backward "\\s|"))) ; Assume it is scanned already.
6868 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
6869 (sub-p (eq (preceding-char) ?s)) s)
6871 (set-marker e (1- (point)))
6872 (setq delim (preceding-char))
6873 (if (and sub-p (eq delim (char-after (- (point) 2))))
6874 (error "Possible s/blah// - do not know how to deal with"))
6875 (if sub-p (forward-sexp 1))
6876 (if (looking-at "\\sw*x")
6879 ;; Protect fragile " ", "#"
6882 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
6888 (defun cperl-beautify-regexp (&optional deep)
6889 "Do it. (Experimental, may change semantics, recheck the result.)
6890 We suppose that the regexp is scanned already."
6892 (setq deep (if deep (prefix-numeric-value deep) -1))
6894 (goto-char (cperl-make-regexp-x))
6895 (let ((b (point)) (e (make-marker)))
6897 (set-marker e (1- (point)))
6898 (cperl-beautify-regexp-piece b e nil deep))))
6900 (defun cperl-regext-to-level-start ()
6901 "Goto start of an enclosing group in regexp.
6902 We suppose that the regexp is scanned already."
6904 (let ((limit (cperl-make-regexp-x)) done)
6906 (or (eq (following-char) ?\()
6907 (search-backward "(" (1+ limit) t)
6908 (error "Cannot find `(' which starts a group"))
6911 (skip-chars-backward "\\")
6912 (looking-at "\\(\\\\\\\\\\)*(")))
6913 (or done (forward-char -1)))))
6915 (defun cperl-contract-level ()
6916 "Find an enclosing group in regexp and contract it.
6917 \(Experimental, may change semantics, recheck the result.)
6918 We suppose that the regexp is scanned already."
6920 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
6921 (cperl-regext-to-level-start)
6922 (let ((b (point)) (e (make-marker)) s c)
6924 (set-marker e (1- (point)))
6926 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
6928 ((match-beginning 1) ; #-comment
6929 (or c (setq c (current-indentation)))
6930 (beginning-of-line 2) ; Skip
6932 (skip-chars-forward " \t")
6933 (delete-region s (point))
6934 (indent-to-column c))
6937 (just-one-space))))))
6939 (defun cperl-contract-levels ()
6940 "Find an enclosing group in regexp and contract all the kids.
6941 \(Experimental, may change semantics, recheck the result.)
6942 We suppose that the regexp is scanned already."
6946 (cperl-regext-to-level-start)
6947 (error ; We are outside outermost group
6948 (goto-char (cperl-make-regexp-x))))
6949 (let ((b (point)) (e (make-marker)) s c)
6951 (set-marker e (1- (point)))
6953 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
6955 ((match-beginning 1) ; Skip
6958 (cperl-contract-level)))))))
6960 (defun cperl-beautify-level (&optional deep)
6961 "Find an enclosing group in regexp and beautify it.
6962 \(Experimental, may change semantics, recheck the result.)
6963 We suppose that the regexp is scanned already."
6965 (setq deep (if deep (prefix-numeric-value deep) -1))
6967 (cperl-regext-to-level-start)
6968 (let ((b (point)) (e (make-marker)))
6970 (set-marker e (1- (point)))
6971 (cperl-beautify-regexp-piece b e nil deep))))
6973 (defun cperl-invert-if-unless ()
6974 "Change `if (A) {B}' into `B if A;' etc if possible."
6976 (or (looking-at "\\<")
6978 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
6979 (let ((pos1 (point))
6980 pos2 pos3 pos4 pos5 s1 s2 state p pos45
6981 (s0 (buffer-substring (match-beginning 0) (match-end 0))))
6986 (if (eq (following-char) ?\( )
6993 ;; XXXX In fact may be `A if (B); {C}' ...
6994 (if (and (eq (following-char) ?\{ )
6996 (cperl-backward-to-noncomment pos3)
6997 (eq (preceding-char) ?\) )))
6998 (if (condition-case nil
7003 (looking-at "\\<els\\(e\\|if\\)\\>"))
7006 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" s0)
7007 (goto-char (1- pos5))
7008 (cperl-backward-to-noncomment pos4)
7009 (if (eq (preceding-char) ?\;)
7011 (setq pos45 (point))
7013 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
7014 (setq p (match-beginning 0)
7015 s1 (buffer-substring p (match-end 0))
7016 state (parse-partial-sexp pos4 p))
7020 (error "`%s' inside `%s' BLOCK" s1 s0))
7021 (goto-char (match-end 0)))
7023 (goto-char (1+ pos4))
7024 (skip-chars-forward " \t\n")
7025 (setq s2 (buffer-substring (point) pos45))
7027 (or (looking-at ";?[ \t\n]*}")
7029 (skip-chars-forward "; \t\n")
7030 (setq s2 (concat s2 "\n" (buffer-substring (point) (1- pos5))))))
7033 (goto-char (1- pos3))
7034 (cperl-backward-to-noncomment pos2)
7035 (or (looking-at "[ \t\n]*)")
7036 (goto-char (1- pos3)))
7038 (goto-char (1+ pos2))
7039 (skip-chars-forward " \t\n")
7040 (setq s1 (buffer-substring (point) p))
7041 (delete-region pos4 pos5)
7042 (delete-region pos2 pos3)
7049 (delete-horizontal-space)
7051 (delete-horizontal-space)
7054 (cperl-indent-line))
7055 (error "`%s' (EXPR) not with an {BLOCK}" s0)))
7056 (error "`%s' not with an (EXPR)" s0)))
7057 (error "Not at `if', `unless', `while', `until', `for' or `foreach'")))
7059 ;;; By Anthony Foiani <afoiani@uswest.com>
7060 ;;; Getting help on modules in C-h f ?
7061 ;;; This is a modified version of `man'.
7062 ;;; Need to teach it how to lookup functions
7063 (defun cperl-perldoc (word)
7064 "Run `perldoc' on WORD."
7066 (list (let* ((default-entry (cperl-word-at-point))
7068 (format "perldoc entry%s: "
7069 (if (string= default-entry "")
7071 (format " (default %s)" default-entry))))))
7072 (if (string= input "")
7073 (if (string= default-entry "")
7074 (error "No perldoc args given")
7078 (let* ((case-fold-search nil)
7080 (string-match "^[a-z]+$" word)
7081 (string-match (concat "^" word "\\>")
7082 (documentation-property
7084 'variable-documentation))))
7085 (manual-program (if is-func "perldoc -f" "perldoc")))
7088 (let ((Manual-program "perldoc")
7089 (Manual-switches (if is-func (list "-f"))))
7090 (manual-entry word)))
7092 (Man-getpage-in-background word)))))
7094 (defun cperl-perldoc-at-point ()
7095 "Run a `perldoc' on the word around point."
7097 (cperl-perldoc (cperl-word-at-point)))
7099 (defcustom pod2man-program "pod2man"
7100 "*File name for `pod2man'."
7104 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
7105 (defun cperl-pod-to-manpage ()
7106 "Create a virtual manpage in Emacs from the Perl Online Documentation."
7109 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
7110 (bufname (concat "Man " buffer-file-name))
7111 (buffer (generate-new-buffer bufname)))
7114 (let ((process-environment (copy-sequence process-environment)))
7115 ;; Prevent any attempt to use display terminal fanciness.
7116 (setenv "TERM" "dumb")
7117 (set-process-sentinel
7118 (start-process pod2man-program buffer "sh" "-c"
7119 (format (cperl-pod2man-build-command) pod2man-args))
7120 'Man-bgproc-sentinel)))))
7122 ;;; Updated version by him too
7123 (defun cperl-build-manpage ()
7124 "Create a virtual manpage in Emacs from the POD in the file."
7129 (let ((Manual-program "perldoc"))
7130 (manual-entry buffer-file-name)))
7132 (let* ((manual-program "perldoc"))
7133 (Man-getpage-in-background buffer-file-name)))))
7135 (defun cperl-pod2man-build-command ()
7136 "Builds the entire background manpage and cleaning command."
7137 (let ((command (concat pod2man-program " %s 2>/dev/null"))
7138 (flist Man-filter-list))
7139 (while (and flist (car flist))
7140 (let ((pcom (car (car flist)))
7141 (pargs (cdr (car flist))))
7143 (concat command " | " pcom " "
7144 (mapconcat '(lambda (phrase)
7145 (if (not (stringp phrase))
7146 (error "Malformed Man-filter-list"))
7149 (setq flist (cdr flist))))
7152 (defun cperl-lazy-install ()) ; Avoid a warning
7153 (defun cperl-lazy-unstall ()) ; Avoid a warning
7155 (if (fboundp 'run-with-idle-timer)
7157 (defvar cperl-help-shown nil
7158 "Non-nil means that the help was already shown now.")
7160 (defvar cperl-lazy-installed nil
7161 "Non-nil means that the lazy-help handlers are installed now.")
7163 (defun cperl-lazy-install ()
7164 "Switches on Auto-Help on Perl constructs (put in the message area).
7165 Delay of auto-help controlled by `cperl-lazy-help-time'."
7167 (make-variable-buffer-local 'cperl-help-shown)
7168 (if (and (cperl-val 'cperl-lazy-help-time)
7169 (not cperl-lazy-installed))
7171 (add-hook 'post-command-hook 'cperl-lazy-hook)
7172 (run-with-idle-timer
7173 (cperl-val 'cperl-lazy-help-time 1000000 5)
7175 'cperl-get-help-defer)
7176 (setq cperl-lazy-installed t))))
7178 (defun cperl-lazy-unstall ()
7179 "Switches off Auto-Help on Perl constructs (put in the message area).
7180 Delay of auto-help controlled by `cperl-lazy-help-time'."
7182 (remove-hook 'post-command-hook 'cperl-lazy-hook)
7183 (cancel-function-timers 'cperl-get-help-defer)
7184 (setq cperl-lazy-installed nil))
7186 (defun cperl-lazy-hook ()
7187 (setq cperl-help-shown nil))
7189 (defun cperl-get-help-defer ()
7190 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
7191 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
7193 (setq cperl-help-shown t))))
7194 (cperl-lazy-install)))
7197 ;;; Plug for wrong font-lock:
7199 (defun cperl-font-lock-unfontify-region-function (beg end)
7200 ;; Simplified now that font-lock-unfontify-region uses save-buffer-state.
7201 (let (before-change-functions after-change-functions)
7202 (remove-text-properties beg end '(face nil))))
7204 (defvar cperl-d-l nil)
7205 (defun cperl-fontify-syntaxically (end)
7206 ;; Some vars for debugging only
7207 ;; (message "Syntaxifying...")
7208 (let ((dbg (point)) (iend end)
7209 (istate (car cperl-syntax-state))
7211 (and cperl-syntaxify-unwind
7212 (setq end (cperl-unwind-to-safe t end)))
7213 (setq start (point))
7214 (or cperl-syntax-done-to
7215 (setq cperl-syntax-done-to (point-min)))
7216 (if (or (not (boundp 'font-lock-hot-pass))
7217 (eval 'font-lock-hot-pass)
7218 t) ; Not debugged otherwise
7219 ;; Need to forget what is after `start'
7220 (setq start (min cperl-syntax-done-to start))
7221 ;; Fontification without a change
7222 (setq start (max cperl-syntax-done-to start)))
7224 (setq cperl-syntax-done-to start) ; In case what follows fails
7225 (cperl-find-pods-heres start end t nil t))
7226 (if (eq cperl-syntaxify-by-font-lock 'message)
7227 (message "Syntaxified %s..%s from %s to %s(%s), state %s-->%s"
7229 start end cperl-syntax-done-to
7230 istate (car cperl-syntax-state))) ; For debugging
7231 nil)) ; Do not iterate
7233 (defun cperl-fontify-update (end)
7234 (let ((pos (point)) prop posend)
7236 (setq prop (get-text-property pos 'cperl-postpone))
7237 (setq posend (next-single-property-change pos 'cperl-postpone nil end))
7238 (and prop (put-text-property pos posend (car prop) (cdr prop)))
7240 nil) ; Do not iterate
7242 (defun cperl-update-syntaxification (from to)
7243 (if (and cperl-use-syntax-table-text-property
7244 cperl-syntaxify-by-font-lock
7245 (or (null cperl-syntax-done-to)
7246 (< cperl-syntax-done-to to)))
7250 (cperl-fontify-syntaxically to)))))
7252 (defvar cperl-version
7253 (let ((v "Revision: 5.0"))
7254 (string-match ":\\s *\\([0-9.]+\\)" v)
7255 (substring v (match-beginning 1) (match-end 1)))
7256 "Version of IZ-supported CPerl package this file is based on.")
7258 (provide 'cperl-mode)
7260 ;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
7261 ;;; cperl-mode.el ends here