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
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-int (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 (defcustom cperl-vc-header-alist '((SCCS "($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
346 (RCS "($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/) ;"))
347 "*What to use as `vc-header-alist' in CPerl."
348 :type '(repeat (list symbol string))
351 (defcustom cperl-clobber-mode-lists
354 (boundp 'interpreter-mode-alist)
355 (assoc "miniperl" interpreter-mode-alist)
356 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
357 "*Whether to install us into `interpreter-' and `extension' mode lists."
361 (defcustom cperl-info-on-command-no-prompt nil
362 "*Not-nil (and non-null) means not to prompt on C-h f.
363 The opposite behaviour is always available if prefixed with C-c.
364 Can be overwritten by `cperl-hairy' if nil."
365 :type '(choice (const null) boolean)
366 :group 'cperl-affected-by-hairy)
368 (defcustom cperl-clobber-lisp-bindings nil
369 "*Not-nil (and non-null) means not overwrite C-h f.
370 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
371 Can be overwritten by `cperl-hairy' if nil."
372 :type '(choice (const null) boolean)
373 :group 'cperl-affected-by-hairy)
375 (defcustom cperl-lazy-help-time nil
376 "*Not-nil (and non-null) means to show lazy help after given idle time.
377 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
378 :type '(choice (const null) (const nil) integer)
379 :group 'cperl-affected-by-hairy)
381 (defcustom cperl-pod-face 'font-lock-comment-face
382 "*Face for POD highlighting."
386 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
387 "*Face for POD highlighting.
388 Font for POD headers."
392 (defcustom cperl-here-face 'font-lock-string-face
393 "*Face for here-docs highlighting."
397 (defcustom cperl-invalid-face 'underline
398 "*Face for highlighting trailing whitespace."
403 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
404 "*Not-nil after evaluation means to highlight POD and here-docs sections."
408 (defcustom cperl-fontify-m-as-s t
409 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
413 (defcustom cperl-highlight-variables-indiscriminately nil
414 "*Non-nil means perform additional highlighting on variables.
415 Currently only changes how scalar variables are highlighted.
416 Note that that variable is only read at initialization time for
417 the variable `cperl-font-lock-keywords-2', so changing it after you've
418 entered CPerl mode the first time will have no effect."
422 (defcustom cperl-pod-here-scan t
423 "*Not-nil means look for POD and here-docs sections during startup.
424 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
428 (defcustom cperl-regexp-scan t
429 "*Not-nil means make marking of regular expression more thorough.
430 Effective only with `cperl-pod-here-scan'. Not implemented yet."
434 (defcustom cperl-imenu-addback nil
435 "*Not-nil means add backreferences to generated `imenu's.
436 May require patched `imenu' and `imenu-go'. Obsolete."
438 :group 'cperl-help-system)
440 (defcustom cperl-max-help-size 66
441 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
442 :type '(choice integer (const nil))
443 :group 'cperl-help-system)
445 (defcustom cperl-shrink-wrap-info-frame t
446 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
448 :group 'cperl-help-system)
450 (defcustom cperl-info-page "perl"
451 "*Name of the info page containing perl docs.
452 Older version of this page was called `perl5', newer `perl'."
454 :group 'cperl-help-system)
456 (defcustom cperl-use-syntax-table-text-property
457 (boundp 'parse-sexp-lookup-properties)
458 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
462 (defcustom cperl-use-syntax-table-text-property-for-tags
463 cperl-use-syntax-table-text-property
464 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
468 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
469 "*Regexp to match files to scan when generating TAGS."
473 (defcustom cperl-noscan-files-regexp
474 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
475 "*Regexp to match files/dirs to skip when generating TAGS."
479 (defcustom cperl-regexp-indent-step nil
480 "*Indentation used when beautifying regexps.
481 If nil, the value of `cperl-indent-level' will be used."
482 :type '(choice integer (const nil))
483 :group 'cperl-indentation-details)
485 (defcustom cperl-indent-left-aligned-comments t
486 "*Non-nil means that the comment starting in leftmost column should indent."
488 :group 'cperl-indentation-details)
490 (defcustom cperl-under-as-char nil
491 "*Non-nil means that the _ (underline) should be treated as word char."
495 (defcustom cperl-extra-perl-args ""
496 "*Extra arguments to use when starting Perl.
497 Currently used with `cperl-check-syntax' only."
501 (defcustom cperl-message-electric-keyword t
502 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
504 :group 'cperl-help-system)
506 (defcustom cperl-indent-region-fix-constructs 1
507 "*Amount of space to insert between `}' and `else' or `elsif'
508 in `cperl-indent-region'. Set to nil to leave as is. Values other
509 than 1 and nil will probably not work."
510 :type '(choice (const nil) (const 1))
511 :group 'cperl-indentation-details)
513 (defcustom cperl-break-one-line-blocks-when-indent t
514 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
515 need to be reformatted into multiline ones when indenting a region."
517 :group 'cperl-indentation-details)
519 (defcustom cperl-fix-hanging-brace-when-indent t
520 "*Non-nil means that BLOCK-end `}' may be put on a separate line
521 when indenting a region.
522 Braces followed by else/elsif/while/until are excepted."
524 :group 'cperl-indentation-details)
526 (defcustom cperl-merge-trailing-else t
527 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
528 may be merged to be on the same line when indenting a region."
530 :group 'cperl-indentation-details)
532 (defcustom cperl-indent-parens-as-block nil
533 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
534 but for trailing \",\" inside the group, which won't increase indentation.
535 One should tune up `cperl-close-paren-offset' as well."
537 :group 'cperl-indentation-details)
539 (defcustom cperl-syntaxify-by-font-lock
540 (and cperl-can-font-lock
541 (boundp 'parse-sexp-lookup-properties))
542 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
543 :type '(choice (const message) boolean)
546 (defcustom cperl-syntaxify-unwind
548 "*Non-nil means that CPerl unwinds to a start of a long construction
549 when syntaxifying a chunk of buffer."
553 (defcustom cperl-ps-print-face-properties
554 '((font-lock-keyword-face nil nil bold shadow)
555 (font-lock-variable-name-face nil nil bold)
556 (font-lock-function-name-face nil nil bold italic box)
557 (font-lock-constant-face nil "LightGray" bold)
558 (cperl-array-face nil "LightGray" bold underline)
559 (cperl-hash-face nil "LightGray" bold italic underline)
560 (font-lock-comment-face nil "LightGray" italic)
561 (font-lock-string-face nil nil italic underline)
562 (cperl-nonoverridable-face nil nil italic underline)
563 (font-lock-type-face nil nil underline)
564 (underline nil "LightGray" strikeout))
565 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
566 :type '(repeat (cons symbol
567 (cons (choice (const nil) string)
568 (cons (choice (const nil) string)
572 (defvar cperl-dark-background
573 (cperl-choose-color "navy" "os2blue" "darkgreen"))
574 (defvar cperl-dark-foreground
575 (cperl-choose-color "orchid1" "orange"))
577 (defface cperl-nonoverridable-face
578 `((((class grayscale) (background light))
579 (:background "Gray90" :slant italic :underline t))
580 (((class grayscale) (background dark))
581 (:foreground "Gray80" :slant italic :underline t :weight bold))
582 (((class color) (background light))
583 (:foreground "chartreuse3"))
584 (((class color) (background dark))
585 (:foreground ,cperl-dark-foreground))
586 (t (:weight bold :underline t)))
587 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
590 (defface cperl-array-face
591 `((((class grayscale) (background light))
592 (:background "Gray90" :weight bold))
593 (((class grayscale) (background dark))
594 (:foreground "Gray80" :weight bold))
595 (((class color) (background light))
596 (:foreground "Blue" :background "lightyellow2" :weight bold))
597 (((class color) (background dark))
598 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
600 "Font Lock mode face used to highlight array names."
603 (defface cperl-hash-face
604 `((((class grayscale) (background light))
605 (:background "Gray90" :weight bold :slant italic))
606 (((class grayscale) (background dark))
607 (:foreground "Gray80" :weight bold :slant italic))
608 (((class color) (background light))
609 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
610 (((class color) (background dark))
611 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
612 (t (:weight bold :slant italic)))
613 "Font Lock mode face used to highlight hash names."
618 ;;; Short extra-docs.
620 (defvar cperl-tips 'please-ignore-this-line
621 "Get maybe newer version of this package from
622 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
624 ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
625 Subdirectory `cperl-mode' may contain yet newer development releases and/or
626 patches to related files.
628 For best results apply to an older Emacs the patches from
629 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
630 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
631 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
632 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
634 Get support packages choose-color.el (or font-lock-extra.el before
635 19.30), imenu-go.el from the same place. \(Look for other files there
636 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
637 later you should use choose-color.el *instead* of font-lock-extra.el
638 \(and you will not get smart highlighting in C :-().
640 Note that to enable Compile choices in the menu you need to install
643 If your Emacs does not default to `cperl-mode' on Perl files, and you
644 want it to: put the following into your .emacs file:
646 (defalias 'perl-mode 'cperl-mode)
649 $CPAN/doc/manual/info/perl-info.tar.gz
651 http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
653 If you use imenu-go, run imenu on perl5-info buffer (you can do it
654 from Perl menu). If many files are related, generate TAGS files from
655 Tools/Tags submenu in Perl menu.
657 If some class structure is too complicated, use Tools/Hierarchy-view
658 from Perl menu, or hierarchic view of imenu. The second one uses the
659 current buffer only, the first one requires generation of TAGS from
660 Perl/Tools/Tags menu beforehand.
662 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
664 Switch auto-help on/off with Perl/Tools/Auto-help.
666 Though with contemporary Emaxen CPerl mode should maintain the correct
667 parsing of Perl even when editing, sometimes it may be lost. Fix this by
671 In cases of more severe confusion sometimes it is helpful to do
673 \\[load-library] cperl-mode RET
676 Before reporting (non-)problems look in the problem section of online
677 micro-docs on what I know about CPerl problems.")
679 (defvar cperl-problems 'please-ignore-this-line
680 "Description of problems in CPerl mode.
681 Some faces will not be shown on some versions of Emacs unless you
682 install choose-color.el, available from
683 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
685 `fill-paragraph' on a comment may leave the point behind the
686 paragraph. Parsing of lines with several <<EOF is not implemented
689 Emacs had a _very_ restricted syntax parsing engine until version
690 20.1. Most problems below are corrected starting from this version of
691 Emacs, and all of them should be fixed in version 20.3. (Or apply
692 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
693 this respect (until 2003).
695 Note that even with newer Emacsen in some very rare cases the details
696 of interaction of `font-lock' and syntaxification may be not cleaned
697 up yet. You may get slightly different colors basing on the order of
698 fontification and syntaxification. Say, the initial faces is correct,
699 but editing the buffer breaks this.
701 Even with older Emacsen CPerl mode tries to corrects some Emacs
702 misunderstandings, however, for efficiency reasons the degree of
703 correction is different for different operations. The partially
704 corrected problems are: POD sections, here-documents, regexps. The
705 operations are: highlighting, indentation, electric keywords, electric
708 This may be confusing, since the regexp s#//#/#\; may be highlighted
709 as a comment, but it will be recognized as a regexp by the indentation
710 code. Or the opposite case, when a POD section is highlighted, but
711 may break the indentation of the following code (though indentation
712 should work if the balance of delimiters is not broken by POD).
714 The main trick (to make $ a \"backslash\") makes constructions like
715 ${aaa} look like unbalanced braces. The only trick I can think of is
716 to insert it as $ {aaa} (legal in perl5, not in perl4).
718 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
719 as /($|\\s)/. Note that such a transposition is not always possible.
721 The solution is to upgrade your Emacs or patch an older one. Note
722 that Emacs 20.2 has some bugs related to `syntax-table' text
723 properties. Patches are available on the main CPerl download site,
726 If these bugs cannot be fixed on your machine (say, you have an inferior
727 environment and cannot recompile), you may still disable all the fancy stuff
728 via `cperl-use-syntax-table-text-property'.")
730 (defvar cperl-praise 'please-ignore-this-line
731 "Advantages of CPerl mode.
733 0) It uses the newest `syntax-table' property ;-);
735 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
736 mode - but the latter number may have improved too in last years) even
737 with old Emaxen which do not support `syntax-table' property.
739 When using `syntax-table' property for syntax assist hints, it should
740 handle 99.995% of lines correct - or somesuch. It automatically
741 updates syntax assist hints when you edit your script.
743 2) It is generally believed to be \"the most user-friendly Emacs
744 package\" whatever it may mean (I doubt that the people who say similar
745 things tried _all_ the rest of Emacs ;-), but this was not a lonely
748 3) Everything is customizable, one-by-one or in a big sweep;
750 4) It has many easily-accessable \"tools\":
751 a) Can run program, check syntax, start debugger;
752 b) Can lineup vertically \"middles\" of rows, like `=' in
755 c) Can insert spaces where this impoves readability (in one
756 interactive sweep over the buffer);
757 d) Has support for imenu, including:
758 1) Separate unordered list of \"interesting places\";
759 2) Separate TOC of POD sections;
760 3) Separate list of packages;
761 4) Hierarchical view of methods in (sub)packages;
762 5) and functions (by the full name - with package);
763 e) Has an interface to INFO docs for Perl; The interface is
764 very flexible, including shrink-wrapping of
765 documentation buffer/frame;
766 f) Has a builtin list of one-line explanations for perl constructs.
767 g) Can show these explanations if you stay long enough at the
768 corresponding place (or on demand);
769 h) Has an enhanced fontification (using 3 or 4 additional faces
770 comparing to font-lock - basically, different
771 namespaces in Perl have different colors);
772 i) Can construct TAGS basing on its knowledge of Perl syntax,
773 the standard menu has 6 different way to generate
774 TAGS (if \"by directory\", .xs files - with C-language
775 bindings - are included in the scan);
776 j) Can build a hierarchical view of classes (via imenu) basing
777 on generated TAGS file;
778 k) Has electric parentheses, electric newlines, uses Abbrev
779 for electric logical constructs
781 with different styles of expansion (context sensitive
782 to be not so bothering). Electric parentheses behave
783 \"as they should\" in a presence of a visible region.
784 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
790 n) Highlights (by user-choice) either 3-delimiters constructs
791 (such as tr/a/b/), or regular expressions and `y/tr';
792 o) Highlights trailing whitespace;
793 p) Is able to manipulate Perl Regular Expressions to ease
794 conversion to a more readable form.
796 5) The indentation engine was very smart, but most of tricks may be
797 not needed anymore with the support for `syntax-table' property. Has
798 progress indicator for indentation (with `imenu' loaded).
800 6) Indent-region improves inline-comments as well; also corrects
801 whitespace *inside* the conditional/loop constructs.
803 7) Fill-paragraph correctly handles multi-line comments;
805 8) Can switch to different indentation styles by one command, and restore
806 the settings present before the switch.
808 9) When doing indentation of control constructs, may correct
809 line-breaks/spacing between elements of the construct.
811 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
812 capable syntax engines).")
814 (defvar cperl-speed 'please-ignore-this-line
815 "This is an incomplete compendium of what is available in other parts
816 of CPerl documentation. (Please inform me if I skept anything.)
818 There is a perception that CPerl is slower than alternatives. This part
819 of documentation is designed to overcome this misconception.
821 *By default* CPerl tries to enable the most comfortable settings.
822 From most points of view, correctly working package is infinitely more
823 comfortable than a non-correctly working one, thus by default CPerl
824 prefers correctness over speed. Below is the guide how to change
825 settings if your preferences are different.
827 A) Speed of loading the file. When loading file, CPerl may perform a
828 scan which indicates places which cannot be parsed by primitive Emacs
829 syntax-parsing routines, and marks them up so that either
831 A1) CPerl may work around these deficiencies (for big chunks, mostly
832 PODs and HERE-documents), or
833 A2) On capable Emaxen CPerl will use improved syntax-handlings
834 which reads mark-up hints directly.
836 The scan in case A2 is much more comprehensive, thus may be slower.
838 User can disable syntax-engine-helping scan of A2 by setting
839 `cperl-use-syntax-table-text-property'
840 variable to nil (if it is set to t).
842 One can disable the scan altogether (both A1 and A2) by setting
843 `cperl-pod-here-scan'
846 B) Speed of editing operations.
848 One can add a (minor) speedup to editing operations by setting
849 `cperl-use-syntax-table-text-property'
850 variable to nil (if it is set to t). This will disable
851 syntax-engine-helping scan, thus will make many more Perl
852 constructs be wrongly recognized by CPerl, thus may lead to
853 wrongly matched parentheses, wrong indentation, etc.
855 One can unset `cperl-syntaxify-unwind'. This might speed up editing
856 of, say, long POD sections.")
858 (defvar cperl-tips-faces 'please-ignore-this-line
859 "CPerl mode uses following faces for highlighting:
861 `cperl-array-face' Array names
862 `cperl-hash-face' Hash names
863 `font-lock-comment-face' Comments, PODs and whatever is considered
864 syntaxically to be not code
865 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
866 2-arg operators s/y/tr/ or of RExen,
867 `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
868 a target of a file tests, file tests,
869 subroutine names at the moment of definition
870 (except those conflicting with Perl operators),
871 package names (when recognized), format names
872 `font-lock-keyword-face' Control flow switch constructs, declarators
873 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
874 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
875 literal parts and the terminator of formats
876 and whatever is syntaxically considered
878 `font-lock-type-face' Overridable keywords
879 `font-lock-variable-name-face' Variable declarations, indirect array and
880 hash names, POD headers/item names
881 `cperl-invalid-face' Trailing whitespace
883 Note that in several situations the highlighting tries to inform about
884 possible confusion, such as different colors for function names in
885 declarations depending on what they (do not) override, or special cases
886 m// and s/// which do not do what one would expect them to do.
888 Help with best setup of these faces for printout requested (for each of
889 the faces: please specify bold, italic, underline, shadow and box.)
895 ;;; Portability stuff:
897 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
898 `(define-key cperl-mode-map
900 `(if cperl-xemacs-p ,xemacs-key ,emacs-key)
904 (defvar cperl-del-back-ch
905 (car (append (where-is-internal 'delete-backward-char)
906 (where-is-internal 'backward-delete-char-untabify)))
907 "Character generated by key bound to `delete-backward-char'.")
909 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
910 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
912 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
915 ;; "Active regions" are on: use region only if active
916 ;; "Active regions" are off: use region unconditionally
917 (defun cperl-use-region-p ()
918 (if zmacs-regions (mark) t)))
919 (defun cperl-use-region-p ()
920 (if transient-mark-mode mark-active t))
921 (defun cperl-mark-active () mark-active))
923 (defsubst cperl-enable-font-lock ()
926 (defun cperl-putback-char (c) ; Emacs 19
927 (set 'unread-command-events (list c))) ; Avoid undefined warning
929 (if (boundp 'unread-command-events)
931 (defun cperl-putback-char (c) ; XEmacs >= 19.12
932 (setq unread-command-events (list (eval '(character-to-event c))))))
933 (defun cperl-putback-char (c) ; XEmacs <= 19.11
934 (set 'unread-command-event (eval '(character-to-event c))))) ; Avoid warnings
936 (or (fboundp 'uncomment-region)
937 (defun uncomment-region (beg end)
939 (comment-region beg end -1)))
941 (defvar cperl-do-not-fontify
942 (if (string< emacs-version "19.30")
945 "Text property which inhibits refontification.")
947 (defsubst cperl-put-do-not-fontify (from to &optional post)
948 ;; If POST, do not do it with postponed fontification
949 (if (and post cperl-syntaxify-by-font-lock)
951 (put-text-property (max (point-min) (1- from))
952 to cperl-do-not-fontify t)))
954 (defcustom cperl-mode-hook nil
955 "Hook run by CPerl mode."
959 (defvar cperl-syntax-state nil)
960 (defvar cperl-syntax-done-to nil)
961 (defvar cperl-emacs-can-parse (> (length (save-excursion
962 (parse-partial-sexp (point) (point)))) 9))
964 ;; Make customization possible "in reverse"
965 (defsubst cperl-val (symbol &optional default hairy)
967 ((eq (symbol-value symbol) 'null) default)
968 (cperl-hairy (or hairy t))
969 (t (symbol-value symbol))))
971 ;;; Probably it is too late to set these guys already, but it can help later:
973 ;;;(and cperl-clobber-mode-lists
974 ;;;(setq auto-mode-alist
975 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
976 ;;;(and (boundp 'interpreter-mode-alist)
977 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
978 ;;; '(("miniperl" . perl-mode))))))
984 '(imenu easymenu etags timer man info))
985 (if (fboundp 'ps-extend-face-list)
986 (defmacro cperl-ps-extend-face-list (arg)
987 `(ps-extend-face-list ,arg))
988 (defmacro cperl-ps-extend-face-list (arg)
989 `(error "This version of Emacs has no `ps-extend-face-list'")))
990 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
991 ;; macros instead of defsubsts don't work on Emacs, so we do the
992 ;; expansion manually. Any other suggestions?
995 (defvar cperl-mode-abbrev-table nil
996 "Abbrev table in use in CPerl mode buffers.")
998 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1000 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
1002 (if cperl-mode-map nil
1003 (setq cperl-mode-map (make-sparse-keymap))
1004 (cperl-define-key "{" 'cperl-electric-lbrace)
1005 (cperl-define-key "[" 'cperl-electric-paren)
1006 (cperl-define-key "(" 'cperl-electric-paren)
1007 (cperl-define-key "<" 'cperl-electric-paren)
1008 (cperl-define-key "}" 'cperl-electric-brace)
1009 (cperl-define-key "]" 'cperl-electric-rparen)
1010 (cperl-define-key ")" 'cperl-electric-rparen)
1011 (cperl-define-key ";" 'cperl-electric-semi)
1012 (cperl-define-key ":" 'cperl-electric-terminator)
1013 (cperl-define-key "\C-j" 'newline-and-indent)
1014 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
1015 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
1016 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1017 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
1018 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1019 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
1020 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
1021 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
1022 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1023 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1025 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1026 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1027 (cperl-define-key "\177" 'cperl-electric-backspace)
1028 (cperl-define-key "\t" 'cperl-indent-command)
1029 ;; don't clobber the backspace binding:
1030 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1031 [(control c) (control h) F])
1032 (if (cperl-val 'cperl-clobber-lisp-bindings)
1034 (cperl-define-key "\C-hf"
1035 ;;(concat (char-to-string help-char) "f") ; does not work
1036 'cperl-info-on-command
1038 (cperl-define-key "\C-hv"
1039 ;;(concat (char-to-string help-char) "v") ; does not work
1042 (cperl-define-key "\C-c\C-hf"
1043 ;;(concat (char-to-string help-char) "f") ; does not work
1044 (key-binding "\C-hf")
1045 [(control c) (control h) f])
1046 (cperl-define-key "\C-c\C-hv"
1047 ;;(concat (char-to-string help-char) "v") ; does not work
1048 (key-binding "\C-hv")
1049 [(control c) (control h) v]))
1050 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1051 [(control c) (control h) f])
1052 (cperl-define-key "\C-c\C-hv"
1053 ;;(concat (char-to-string help-char) "v") ; does not work
1055 [(control c) (control h) v]))
1056 (if (and cperl-xemacs-p
1057 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1059 ;; substitute-key-definition is usefulness-deenhanced...
1060 (cperl-define-key "\M-q" 'cperl-fill-paragraph)
1061 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1062 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
1063 (substitute-key-definition
1064 'indent-sexp 'cperl-indent-exp
1065 cperl-mode-map global-map)
1066 (substitute-key-definition
1067 'indent-region 'cperl-indent-region
1068 cperl-mode-map global-map)
1069 (substitute-key-definition
1070 'indent-for-comment 'cperl-indent-for-comment
1071 cperl-mode-map global-map)))
1074 (defvar cperl-lazy-installed)
1075 (defvar cperl-old-style nil)
1080 cperl-menu cperl-mode-map "Menu for CPerl mode"
1082 ["Beginning of function" beginning-of-defun t]
1083 ["End of function" end-of-defun t]
1084 ["Mark function" mark-defun t]
1085 ["Indent expression" cperl-indent-exp t]
1086 ["Fill paragraph/comment" fill-paragraph t]
1088 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1089 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1091 ["Beautify" cperl-beautify-regexp
1092 cperl-use-syntax-table-text-property]
1093 ["Beautify one level deep" (cperl-beautify-regexp 1)
1094 cperl-use-syntax-table-text-property]
1095 ["Beautify a group" cperl-beautify-level
1096 cperl-use-syntax-table-text-property]
1097 ["Beautify a group one level deep" (cperl-beautify-level 1)
1098 cperl-use-syntax-table-text-property]
1099 ["Contract a group" cperl-contract-level
1100 cperl-use-syntax-table-text-property]
1101 ["Contract groups" cperl-contract-levels
1102 cperl-use-syntax-table-text-property])
1103 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1105 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1106 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1107 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1109 ["Run" mode-compile (fboundp 'mode-compile)]
1110 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1111 (get-buffer "*compilation*"))]
1112 ["Next error" next-error (get-buffer "*compilation*")]
1113 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1115 ["Debugger" cperl-db t]
1118 ["Imenu" imenu (fboundp 'imenu)]
1119 ["Insert spaces if needed" cperl-find-bad-style t]
1120 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1121 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1122 ["CPerl pretty print (exprmntl)" cperl-ps-print
1123 (fboundp 'ps-extend-face-list)]
1124 ["Imenu on info" cperl-imenu-on-info (featurep 'imenu)]
1126 ;;; ["Create tags for current file" cperl-etags t]
1127 ;;; ["Add tags for current file" (cperl-etags t) t]
1128 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1129 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1130 ;;; ["Create tags for Perl files in (sub)directories"
1131 ;;; (cperl-etags nil 'recursive) t]
1132 ;;; ["Add tags for Perl files in (sub)directories"
1133 ;;; (cperl-etags t 'recursive) t])
1134 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1135 ["Create tags for current file" (cperl-write-tags nil t) t]
1136 ["Add tags for current file" (cperl-write-tags) t]
1137 ["Create tags for Perl files in directory"
1138 (cperl-write-tags nil t nil t) t]
1139 ["Add tags for Perl files in directory"
1140 (cperl-write-tags nil nil nil t) t]
1141 ["Create tags for Perl files in (sub)directories"
1142 (cperl-write-tags nil t t t) t]
1143 ["Add tags for Perl files in (sub)directories"
1144 (cperl-write-tags nil nil t t) t]))
1146 ["Define word at point" imenu-go-find-at-position
1147 (fboundp 'imenu-go-find-at-position)]
1148 ["Help on function" cperl-info-on-command t]
1149 ["Help on function at point" cperl-info-on-current-command t]
1150 ["Help on symbol at point" cperl-get-help t]
1151 ["Perldoc" cperl-perldoc t]
1152 ["Perldoc on word at point" cperl-perldoc-at-point t]
1153 ["View manpage of POD in this file" cperl-build-manpage t]
1154 ["Auto-help on" cperl-lazy-install
1155 (and (fboundp 'run-with-idle-timer)
1156 (not cperl-lazy-installed))]
1157 ["Auto-help off" cperl-lazy-unstall
1158 (and (fboundp 'run-with-idle-timer)
1159 cperl-lazy-installed)])
1161 ["Auto newline" cperl-toggle-auto-newline t]
1162 ["Electric parens" cperl-toggle-electric t]
1163 ["Electric keywords" cperl-toggle-abbrev t]
1164 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1165 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
1166 ["Auto fill" auto-fill-mode t])
1168 ["CPerl" (cperl-set-style "CPerl") t]
1169 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1170 ["GNU" (cperl-set-style "GNU") t]
1171 ["C++" (cperl-set-style "C++") t]
1172 ["FSF" (cperl-set-style "FSF") t]
1173 ["BSD" (cperl-set-style "BSD") t]
1174 ["Whitesmith" (cperl-set-style "Whitesmith") t]
1175 ["Current" (cperl-set-style "Current") t]
1176 ["Memorized" (cperl-set-style-back) cperl-old-style])
1178 ["Tips" (describe-variable 'cperl-tips) t]
1179 ["Problems" (describe-variable 'cperl-problems) t]
1180 ["Speed" (describe-variable 'cperl-speed) t]
1181 ["Praise" (describe-variable 'cperl-praise) t]
1182 ["Faces" (describe-variable 'cperl-tips-faces) t]
1183 ["CPerl mode" (describe-function 'cperl-mode) t]
1185 (message "The version of master-file for this CPerl is %s-Emacs"
1186 cperl-version) t]))))
1189 (autoload 'c-macro-expand "cmacexp"
1190 "Display the result of expanding all C macros occurring in the region.
1191 The expansion is entirely correct because it uses the C preprocessor."
1194 (defvar cperl-imenu--function-name-regexp-perl
1197 "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
1199 "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
1202 (defvar cperl-outline-regexp
1203 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1205 (defvar cperl-mode-syntax-table nil
1206 "Syntax table in use in CPerl mode buffers.")
1208 (defvar cperl-string-syntax-table nil
1209 "Syntax table in use in CPerl mode string-like chunks.")
1211 (if cperl-mode-syntax-table
1213 (setq cperl-mode-syntax-table (make-syntax-table))
1214 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1215 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1216 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1217 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1218 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1219 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1220 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1221 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1222 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1223 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1224 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1225 (modify-syntax-entry ?\n ">" cperl-mode-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 (if cperl-under-as-char
1230 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1231 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1232 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1233 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1234 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
1235 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
1239 (defvar cperl-faces-init nil)
1241 (defvar cperl-msb-fixed nil)
1242 (defvar cperl-use-major-mode 'cperl-mode)
1245 (defun cperl-mode ()
1246 "Major mode for editing Perl code.
1247 Expression and list commands understand all C brackets.
1248 Tab indents for Perl code.
1249 Paragraphs are separated by blank lines only.
1250 Delete converts tabs to spaces as it moves back.
1252 Various characters in Perl almost always come in pairs: {}, (), [],
1253 sometimes <>. When the user types the first, she gets the second as
1254 well, with optional special formatting done on {}. (Disabled by
1255 default.) You can always quote (with \\[quoted-insert]) the left
1256 \"paren\" to avoid the expansion. The processing of < is special,
1257 since most the time you mean \"less\". CPerl mode tries to guess
1258 whether you want to type pair <>, and inserts is if it
1259 appropriate. You can set `cperl-electric-parens-string' to the string that
1260 contains the parenths from the above list you want to be electrical.
1261 Electricity of parenths is controlled by `cperl-electric-parens'.
1262 You may also set `cperl-electric-parens-mark' to have electric parens
1263 look for active mark and \"embrace\" a region if possible.'
1265 CPerl mode provides expansion of the Perl control constructs:
1267 if, else, elsif, unless, while, until, continue, do,
1268 for, foreach, formy and foreachmy.
1270 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1272 The user types the keyword immediately followed by a space, which
1273 causes the construct to be expanded, and the point is positioned where
1274 she is most likely to want to be. eg. when the user types a space
1275 following \"if\" the following appears in the buffer: if () { or if ()
1276 } { } and the cursor is between the parentheses. The user can then
1277 type some boolean expression within the parens. Having done that,
1278 typing \\[cperl-linefeed] places you - appropriately indented - on a
1279 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1280 directive line, then appropriate number of new lines is inserted).
1282 If CPerl decides that you want to insert \"English\" style construct like
1286 it will not do any expansion. See also help on variable
1287 `cperl-extra-newline-before-brace'. (Note that one can switch the
1288 help message on expansion by setting `cperl-message-electric-keyword'
1291 \\[cperl-linefeed] is a convenience replacement for typing carriage
1292 return. It places you in the next line with proper indentation, or if
1293 you type it inside the inline block of control construct, like
1295 foreach (@lines) {print; print}
1297 and you are on a boundary of a statement inside braces, it will
1298 transform the construct into a multiline and will place you into an
1299 appropriately indented blank line. If you need a usual
1300 `newline-and-indent' behaviour, it is on \\[newline-and-indent],
1301 see documentation on `cperl-electric-linefeed'.
1303 Use \\[cperl-invert-if-unless] to change a construction of the form
1313 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1314 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1315 on electric space between $ and {, `cperl-electric-parens-string' is
1316 the string that contains parentheses that should be electric in CPerl
1317 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1318 setting `cperl-electric-keywords' enables electric expansion of
1319 control structures in CPerl. `cperl-electric-linefeed' governs which
1320 one of two linefeed behavior is preferable. You can enable all these
1321 options simultaneously (recommended mode of use) by setting
1322 `cperl-hairy' to t. In this case you can switch separate options off
1323 by setting them to `null'. Note that one may undo the extra
1324 whitespace inserted by semis and braces in `auto-newline'-mode by
1325 consequent \\[cperl-electric-backspace].
1327 If your site has perl5 documentation in info format, you can use commands
1328 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1329 These keys run commands `cperl-info-on-current-command' and
1330 `cperl-info-on-command', which one is which is controlled by variable
1331 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1332 \(in turn affected by `cperl-hairy').
1334 Even if you have no info-format documentation, short one-liner-style
1335 help is available on \\[cperl-get-help], and one can run perldoc or
1338 It is possible to show this help automatically after some idle time.
1339 This is regulated by variable `cperl-lazy-help-time'. Default with
1340 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1341 secs idle time . It is also possible to switch this on/off from the
1342 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1344 Use \\[cperl-lineup] to vertically lineup some construction - put the
1345 beginning of the region at the start of construction, and make region
1346 span the needed amount of lines.
1348 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1349 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1350 here-docs sections. With capable Emaxen results of scan are used
1351 for indentation too, otherwise they are used for highlighting only.
1353 Variables controlling indentation style:
1354 `cperl-tab-always-indent'
1355 Non-nil means TAB in CPerl mode should always reindent the current line,
1356 regardless of where in the line point is when the TAB command is used.
1357 `cperl-indent-left-aligned-comments'
1358 Non-nil means that the comment starting in leftmost column should indent.
1359 `cperl-auto-newline'
1360 Non-nil means automatically newline before and after braces,
1361 and after colons and semicolons, inserted in Perl code. The following
1362 \\[cperl-electric-backspace] will remove the inserted whitespace.
1363 Insertion after colons requires both this variable and
1364 `cperl-auto-newline-after-colon' set.
1365 `cperl-auto-newline-after-colon'
1366 Non-nil means automatically newline even after colons.
1367 Subject to `cperl-auto-newline' setting.
1368 `cperl-indent-level'
1369 Indentation of Perl statements within surrounding block.
1370 The surrounding block's indentation is the indentation
1371 of the line on which the open-brace appears.
1372 `cperl-continued-statement-offset'
1373 Extra indentation given to a substatement, such as the
1374 then-clause of an if, or body of a while, or just a statement continuation.
1375 `cperl-continued-brace-offset'
1376 Extra indentation given to a brace that starts a substatement.
1377 This is in addition to `cperl-continued-statement-offset'.
1378 `cperl-brace-offset'
1379 Extra indentation for line if it starts with an open brace.
1380 `cperl-brace-imaginary-offset'
1381 An open brace following other text is treated as if it the line started
1382 this far to the right of the actual line indentation.
1383 `cperl-label-offset'
1384 Extra indentation for line that is a label.
1385 `cperl-min-label-indent'
1386 Minimal indentation for line that is a label.
1388 Settings for K&R and BSD indentation styles are
1389 `cperl-indent-level' 5 8
1390 `cperl-continued-statement-offset' 5 8
1391 `cperl-brace-offset' -5 -8
1392 `cperl-label-offset' -5 -8
1394 CPerl knows several indentation styles, and may bulk set the
1395 corresponding variables. Use \\[cperl-set-style] to do this. Use
1396 \\[cperl-set-style-back] to restore the memorized preexisting values
1397 \(both available from menu).
1399 If `cperl-indent-level' is 0, the statement after opening brace in
1400 column 0 is indented on
1401 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1403 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1406 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1407 or as help on variables `cperl-tips', `cperl-problems',
1408 `cperl-praise', `cperl-speed'."
1410 (kill-all-local-variables)
1411 (use-local-map cperl-mode-map)
1412 (if (cperl-val 'cperl-electric-linefeed)
1414 (local-set-key "\C-J" 'cperl-linefeed)
1415 (local-set-key "\C-C\C-J" 'newline-and-indent)))
1417 (cperl-val 'cperl-clobber-lisp-bindings)
1418 (cperl-val 'cperl-info-on-command-no-prompt))
1420 ;; don't clobber the backspace binding:
1421 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1422 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1423 [(control c) (control h) f])))
1424 (setq major-mode cperl-use-major-mode)
1425 (setq mode-name "CPerl")
1426 (if (not cperl-mode-abbrev-table)
1427 (let ((prev-a-c abbrevs-changed))
1428 (define-abbrev-table 'cperl-mode-abbrev-table '(
1429 ("if" "if" cperl-electric-keyword 0)
1430 ("elsif" "elsif" cperl-electric-keyword 0)
1431 ("while" "while" cperl-electric-keyword 0)
1432 ("until" "until" cperl-electric-keyword 0)
1433 ("unless" "unless" cperl-electric-keyword 0)
1434 ("else" "else" cperl-electric-else 0)
1435 ("continue" "continue" cperl-electric-else 0)
1436 ("for" "for" cperl-electric-keyword 0)
1437 ("foreach" "foreach" cperl-electric-keyword 0)
1438 ("formy" "formy" cperl-electric-keyword 0)
1439 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1440 ("do" "do" cperl-electric-keyword 0)
1441 ("=pod" "=pod" cperl-electric-pod 0)
1442 ("=over" "=over" cperl-electric-pod 0)
1443 ("=head1" "=head1" cperl-electric-pod 0)
1444 ("=head2" "=head2" cperl-electric-pod 0)
1445 ("pod" "pod" cperl-electric-pod 0)
1446 ("over" "over" cperl-electric-pod 0)
1447 ("head1" "head1" cperl-electric-pod 0)
1448 ("head2" "head2" cperl-electric-pod 0)))
1449 (setq abbrevs-changed prev-a-c)))
1450 (setq local-abbrev-table cperl-mode-abbrev-table)
1451 (abbrev-mode (if (cperl-val 'cperl-electric-keywords) 1 0))
1452 (set-syntax-table cperl-mode-syntax-table)
1453 (make-local-variable 'outline-regexp)
1454 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1455 (setq outline-regexp cperl-outline-regexp)
1456 (make-local-variable 'outline-level)
1457 (setq outline-level 'cperl-outline-level)
1458 (make-local-variable 'paragraph-start)
1459 (setq paragraph-start (concat "^$\\|" page-delimiter))
1460 (make-local-variable 'paragraph-separate)
1461 (setq paragraph-separate paragraph-start)
1462 (make-local-variable 'paragraph-ignore-fill-prefix)
1463 (setq paragraph-ignore-fill-prefix t)
1464 (set (make-local-variable 'fill-paragraph-function) 'cperl-fill-paragraph)
1465 (make-local-variable 'indent-line-function)
1466 (setq indent-line-function 'cperl-indent-line)
1467 (make-local-variable 'require-final-newline)
1468 (setq require-final-newline t)
1469 (make-local-variable 'comment-start)
1470 (setq comment-start "# ")
1471 (make-local-variable 'comment-end)
1472 (setq comment-end "")
1473 (make-local-variable 'comment-column)
1474 (setq comment-column cperl-comment-column)
1475 (make-local-variable 'comment-start-skip)
1476 (setq comment-start-skip "#+ *")
1477 (make-local-variable 'defun-prompt-regexp)
1478 (setq defun-prompt-regexp "^[ \t]*sub[ \t]+\\([^ \t\n{(;]+\\)\\([ \t]*([^()]*)[ \t]*\\)?[ \t]*")
1479 (make-local-variable 'comment-indent-function)
1480 (setq comment-indent-function 'cperl-comment-indent)
1481 (make-local-variable 'parse-sexp-ignore-comments)
1482 (setq parse-sexp-ignore-comments t)
1483 (make-local-variable 'indent-region-function)
1484 (setq indent-region-function 'cperl-indent-region)
1485 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1486 (make-local-variable 'imenu-create-index-function)
1487 (setq imenu-create-index-function
1488 (function cperl-imenu--create-perl-index))
1489 (make-local-variable 'imenu-sort-function)
1490 (setq imenu-sort-function nil)
1491 (make-local-variable 'vc-header-alist)
1492 (set 'vc-header-alist cperl-vc-header-alist) ; Avoid warning
1493 (make-local-variable 'font-lock-defaults)
1494 (setq font-lock-defaults
1496 ((string< emacs-version "19.30")
1497 '(cperl-font-lock-keywords-2))
1498 ((string< emacs-version "19.33") ; Which one to use?
1499 '((cperl-font-lock-keywords
1500 cperl-font-lock-keywords-1
1501 cperl-font-lock-keywords-2)))
1503 '((cperl-load-font-lock-keywords
1504 cperl-load-font-lock-keywords-1
1505 cperl-load-font-lock-keywords-2)))))
1506 (make-local-variable 'cperl-syntax-state)
1507 (if cperl-use-syntax-table-text-property
1509 (make-local-variable 'parse-sexp-lookup-properties)
1510 ;; Do not introduce variable if not needed, we check it!
1511 (set 'parse-sexp-lookup-properties t)
1512 ;; Fix broken font-lock:
1513 (or (boundp 'font-lock-unfontify-region-function)
1514 (set 'font-lock-unfontify-region-function
1515 'font-lock-default-unfontify-region))
1516 (make-local-variable 'font-lock-unfontify-region-function)
1517 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1518 'cperl-font-lock-unfontify-region-function)
1519 (make-local-variable 'cperl-syntax-done-to)
1520 ;; Another bug: unless font-lock-syntactic-keywords, font-lock
1521 ;; ignores syntax-table text-property. (t) is a hack
1522 ;; to make font-lock think that font-lock-syntactic-keywords
1524 (make-local-variable 'font-lock-syntactic-keywords)
1525 (setq font-lock-syntactic-keywords
1526 (if cperl-syntaxify-by-font-lock
1527 '(t (cperl-fontify-syntaxically))
1529 (make-local-variable 'cperl-old-style)
1530 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1531 (set (make-local-variable 'normal-auto-fill-function)
1532 'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
1533 (or (fboundp 'cperl-old-auto-fill-mode)
1535 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1536 (defun auto-fill-mode (&optional arg)
1538 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1539 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1540 (setq auto-fill-function 'cperl-do-auto-fill))))))
1541 (if (cperl-enable-font-lock)
1542 (if (cperl-val 'cperl-font-lock)
1543 (progn (or cperl-faces-init (cperl-init-faces))
1544 (font-lock-mode 1))))
1545 (and (boundp 'msb-menu-cond)
1546 (not cperl-msb-fixed)
1548 (if (featurep 'easymenu)
1549 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
1550 (run-hooks 'cperl-mode-hook)
1551 ;; After hooks since fontification will break this
1552 (if cperl-pod-here-scan
1553 (or cperl-syntaxify-by-font-lock
1554 (progn (or cperl-faces-init (cperl-init-faces-weak))
1555 (cperl-find-pods-heres)))))
1557 ;; Fix for perldb - make default reasonable
1561 (perldb (read-from-minibuffer "Run perldb (like this): "
1562 (if (consp gud-perldb-history)
1563 (car gud-perldb-history)
1564 (concat "perl " ;;(file-name-nondirectory
1568 (buffer-file-name)))
1570 '(gud-perldb-history . 1))))
1572 (defun cperl-msb-fix ()
1573 ;; Adds perl files to msb menu, supposes that msb is already loaded
1574 (setq cperl-msb-fixed t)
1575 (let* ((l (length msb-menu-cond))
1576 (last (nth (1- l) msb-menu-cond))
1577 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1578 (handle (1- (nth 1 last))))
1579 (setcdr precdr (list
1581 '(memq major-mode '(cperl-mode perl-mode))
1586 ;; This is used by indent-for-comment
1587 ;; to decide how much to indent a comment in CPerl code
1588 ;; based on its context. Do fallback if comment is found wrong.
1590 (defvar cperl-wrong-comment)
1591 (defvar cperl-st-cfence '(14)) ; Comment-fence
1592 (defvar cperl-st-sfence '(15)) ; String-fence
1593 (defvar cperl-st-punct '(1))
1594 (defvar cperl-st-word '(2))
1595 (defvar cperl-st-bra '(4 . ?\>))
1596 (defvar cperl-st-ket '(5 . ?\<))
1599 (defun cperl-comment-indent ()
1600 (let ((p (point)) (c (current-column)) was phony)
1601 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
1602 ;; Wrong comment found
1604 (setq was (cperl-to-comment-or-eol)
1605 phony (eq (get-text-property (point) 'syntax-table)
1609 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1610 (if (eq (preceding-char) ?\#)
1615 (skip-chars-backward " \t")
1616 (max (1+ (current-column)) ; Else indent at comment column
1619 (insert comment-start)
1620 (backward-char (length comment-start)))
1621 (setq cperl-wrong-comment t)
1622 (indent-to comment-column 1) ; Indent minimum 1
1623 c))))) ; except leave at least one space.
1625 ;;;(defun cperl-comment-indent-fallback ()
1626 ;;; "Is called if the standard comment-search procedure fails.
1627 ;;;Point is at start of real comment."
1628 ;;; (let ((c (current-column)) target cnt prevc)
1629 ;;; (if (= c comment-column) nil
1630 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1631 ;;; (setq target (max (1+ (setq prevc
1632 ;;; (current-column))) ; Else indent at comment column
1633 ;;; comment-column))
1634 ;;; (if (= c comment-column) nil
1635 ;;; (delete-backward-char cnt)
1636 ;;; (while (< prevc target)
1638 ;;; (setq prevc (current-column)))
1639 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1640 ;;; (while (< prevc target)
1642 ;;; (setq prevc (current-column)))))))
1644 (defun cperl-indent-for-comment ()
1645 "Substitute for `indent-for-comment' in CPerl."
1647 (let (cperl-wrong-comment)
1648 (indent-for-comment)
1649 (if cperl-wrong-comment
1650 (progn (cperl-to-comment-or-eol)
1651 (forward-char (length comment-start))))))
1653 (defun cperl-comment-region (b e arg)
1654 "Comment or uncomment each line in the region in CPerl mode.
1655 See `comment-region'."
1656 (interactive "r\np")
1657 (let ((comment-start "#"))
1658 (comment-region b e arg)))
1660 (defun cperl-uncomment-region (b e arg)
1661 "Uncomment or comment each line in the region in CPerl mode.
1662 See `comment-region'."
1663 (interactive "r\np")
1664 (let ((comment-start "#"))
1665 (comment-region b e (- arg))))
1667 (defvar cperl-brace-recursing nil)
1669 (defun cperl-electric-brace (arg &optional only-before)
1670 "Insert character and correct line's indentation.
1671 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1672 place (even in empty line), but not after. If after \")\" and the inserted
1673 char is \"{\", insert extra newline before only if
1674 `cperl-extra-newline-before-brace'."
1677 (other-end (if (and cperl-electric-parens-mark
1683 (not cperl-brace-recursing)
1684 (cperl-val 'cperl-electric-parens)
1685 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
1686 ;; Need to insert a matching pair
1689 (setq insertpos (point-marker))
1690 (goto-char other-end)
1691 (setq last-command-char ?\{)
1692 (cperl-electric-lbrace arg insertpos))
1694 ;; Check whether we close something "usual" with `}'
1695 (if (and (eq last-command-char ?\})
1699 (up-list (- (prefix-numeric-value arg)))
1700 ;;(cperl-after-block-p (point-min))
1701 (or (cperl-after-expr-p nil "{;)")
1702 ;; after sub, else, continue
1703 (cperl-after-block-p nil 'pre)))
1705 ;; Just insert the guy
1706 (self-insert-command (prefix-numeric-value arg))
1707 (if (and (not arg) ; No args, end (of empty line or auto)
1709 (or (and (null only-before)
1711 (skip-chars-backward " \t")
1713 (and (eq last-command-char ?\{) ; Do not insert newline
1714 ;; if after ")" and `cperl-extra-newline-before-brace'
1715 ;; is nil, do not insert extra newline.
1716 (not cperl-extra-newline-before-brace)
1718 (skip-chars-backward " \t")
1719 (eq (preceding-char) ?\))))
1720 (if cperl-auto-newline
1721 (progn (cperl-indent-line) (newline) t) nil)))
1723 (self-insert-command (prefix-numeric-value arg))
1725 (if cperl-auto-newline
1726 (setq insertpos (1- (point))))
1727 (if (and cperl-auto-newline (null only-before))
1730 (cperl-indent-line)))
1732 (if insertpos (progn (goto-char insertpos)
1733 (search-forward (make-string
1734 1 last-command-char))
1735 (setq insertpos (1- (point)))))
1739 (goto-char insertpos)
1740 (self-insert-command (prefix-numeric-value arg)))
1741 (self-insert-command (prefix-numeric-value arg)))))))
1743 (defun cperl-electric-lbrace (arg &optional end)
1744 "Insert character, correct line's indentation, correct quoting by space."
1746 (let ((cperl-brace-recursing t)
1747 (cperl-auto-newline cperl-auto-newline)
1749 (if (and cperl-electric-parens-mark
1757 (and (cperl-val 'cperl-electric-lbrace-space)
1758 (eq (preceding-char) ?$)
1760 (skip-chars-backward "$")
1761 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
1763 ;; Check whether we are in comment
1767 (not (looking-at "[ \t]*#")))
1768 (cperl-after-expr-p nil "{;)"))
1770 (setq cperl-auto-newline nil))
1771 (cperl-electric-brace arg)
1772 (and (cperl-val 'cperl-electric-parens)
1773 (eq last-command-char ?{)
1774 (memq last-command-char
1775 (append cperl-electric-parens-string nil))
1776 (or (if other-end (goto-char (marker-position other-end)))
1778 (setq last-command-char ?} pos (point))
1779 (progn (cperl-electric-brace arg t)
1782 (defun cperl-electric-paren (arg)
1783 "Insert an opening parenthesis or a matching pair of parentheses.
1784 See `cperl-electric-parens'."
1786 (let ((beg (save-excursion (beginning-of-line) (point)))
1787 (other-end (if (and cperl-electric-parens-mark
1794 (if (and (cperl-val 'cperl-electric-parens)
1795 (memq last-command-char
1796 (append cperl-electric-parens-string nil))
1797 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1798 ;;(not (save-excursion (search-backward "#" beg t)))
1799 (if (eq last-command-char ?<)
1801 (and abbrev-mode ; later it is too late, may be after `for'
1803 (cperl-after-expr-p nil "{;(,:="))
1806 (self-insert-command (prefix-numeric-value arg))
1807 (if other-end (goto-char (marker-position other-end)))
1808 (insert (make-string
1809 (prefix-numeric-value arg)
1810 (cdr (assoc last-command-char '((?{ .?})
1814 (forward-char (- (prefix-numeric-value arg))))
1815 (self-insert-command (prefix-numeric-value arg)))))
1817 (defun cperl-electric-rparen (arg)
1818 "Insert a matching pair of parentheses if marking is active.
1819 If not, or if we are not at the end of marking range, would self-insert.
1820 Affected by `cperl-electric-parens'."
1822 (let ((beg (save-excursion (beginning-of-line) (point)))
1823 (other-end (if (and cperl-electric-parens-mark
1824 (cperl-val 'cperl-electric-parens)
1825 (memq last-command-char
1826 (append cperl-electric-parens-string nil))
1833 (cperl-val 'cperl-electric-parens)
1834 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
1835 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1836 ;;(not (save-excursion (search-backward "#" beg t)))
1839 (self-insert-command (prefix-numeric-value arg))
1841 (if other-end (goto-char other-end))
1842 (insert (make-string
1843 (prefix-numeric-value arg)
1844 (cdr (assoc last-command-char '((?\} . ?\{)
1849 (self-insert-command (prefix-numeric-value arg)))))
1851 (defun cperl-electric-keyword ()
1852 "Insert a construction appropriate after a keyword.
1853 Help message may be switched off by setting `cperl-message-electric-keyword'
1855 (let ((beg (save-excursion (beginning-of-line) (point)))
1856 (dollar (and (eq last-command-char ?$)
1857 (eq this-command 'self-insert-command)))
1858 (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1859 (memq this-command '(self-insert-command newline))))
1861 (and (save-excursion
1865 (setq do (looking-at "do\\>")))
1867 (cperl-after-expr-p nil "{;:"))
1871 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
1873 (save-excursion (or (not (re-search-backward "^=" nil t))
1876 (and cperl-use-syntax-table-text-property
1877 (not (eq (get-text-property (point)
1880 (save-excursion (forward-sexp -1)
1881 (not (memq (following-char) (append "$@%&*" nil))))
1883 (and (eq (preceding-char) ?y)
1884 (progn ; "foreachmy"
1890 (memq this-command '(self-insert-command newline)))))
1891 (and dollar (insert " $"))
1893 ;;(insert " () {\n}")
1895 (cperl-extra-newline-before-brace
1896 (insert (if do "\n" " ()\n"))
1902 (and do (insert " while ();")))
1904 (insert (if do " {\n} while ();" " () {\n}"))))
1905 (or (looking-at "[ \t]\\|$") (insert " "))
1907 (if dollar (progn (search-backward "$")
1911 (search-backward ")")
1912 (if (eq last-command-char ?\()
1913 (progn ; Avoid "if (())"
1914 (delete-backward-char 1)
1915 (delete-backward-char -1))))
1917 (cperl-putback-char cperl-del-back-ch))
1918 (if cperl-message-electric-keyword
1919 (message "Precede char by C-q to avoid expansion"))))))
1921 (defun cperl-ensure-newlines (n &optional pos)
1922 "Make sure there are N newlines after the point."
1923 (or pos (setq pos (point)))
1924 (if (looking-at "\n")
1928 (cperl-ensure-newlines (1- n) pos)
1931 (defun cperl-electric-pod ()
1932 "Insert a POD chunk appropriate after a =POD directive."
1933 (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1934 (memq this-command '(self-insert-command newline))))
1935 head1 notlast name p really-delete over)
1936 (and (save-excursion
1939 (eq (preceding-char) ?=)
1941 (setq head1 (looking-at "head1\\>[ \t]*$"))
1942 (setq over (and (looking-at "over\\>[ \t]*$")
1943 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
1947 (get-text-property (point) 'in-pod)
1948 (cperl-after-expr-p nil "{;:")
1949 (and (re-search-backward
1950 ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
1951 "\\(\\`\n?\\|^\n\\)=\\sw+"
1955 (and cperl-use-syntax-table-text-property
1956 (not (eq (get-text-property (point) 'syntax-type)
1960 (setq notlast (re-search-forward "^\n=" nil t)))
1964 (cperl-ensure-newlines 2)
1970 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
1971 nil t)))) ; Only one
1974 (setq name (file-name-sans-extension
1975 (file-name-nondirectory (buffer-file-name)))
1977 (insert " NAME\n\n" name
1978 " - \n\n=head1 SYNOPSIS\n\n\n\n"
1979 "=head1 DESCRIPTION")
1980 (cperl-ensure-newlines 4)
1984 (setq really-delete t))
1989 (insert "\n\n=item \n\n\n\n"
1991 (cperl-ensure-newlines 2)
1995 (setq really-delete t)))
1996 (if (and delete really-delete)
1997 (cperl-putback-char cperl-del-back-ch))))))
1999 (defun cperl-electric-else ()
2000 "Insert a construction appropriate after a keyword.
2001 Help message may be switched off by setting `cperl-message-electric-keyword'
2003 (let ((beg (save-excursion (beginning-of-line) (point))))
2004 (and (save-excursion
2006 (cperl-after-expr-p nil "{;:"))
2010 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2012 (save-excursion (or (not (re-search-backward "^=" nil t))
2014 (and cperl-use-syntax-table-text-property
2015 (not (eq (get-text-property (point)
2020 ;;(insert " {\n\n}")
2022 (cperl-extra-newline-before-brace
2028 (insert " {\n\n}")))
2029 (or (looking-at "[ \t]\\|$") (insert " "))
2033 (cperl-putback-char cperl-del-back-ch)
2034 (setq this-command 'cperl-electric-else)
2035 (if cperl-message-electric-keyword
2036 (message "Precede char by C-q to avoid expansion"))))))
2038 (defun cperl-linefeed ()
2039 "Go to end of line, open a new line and indent appropriately.
2040 If in POD, insert appropriate lines."
2042 (let ((beg (save-excursion (beginning-of-line) (point)))
2043 (end (save-excursion (end-of-line) (point)))
2044 (pos (point)) start over cut res)
2045 (if (and ; Check if we need to split:
2046 ; i.e., on a boundary and inside "{...}"
2047 (save-excursion (cperl-to-comment-or-eol)
2048 (>= (point) pos)) ; Not in a comment
2050 (skip-chars-backward " \t" beg)
2052 (looking-at "[;{]")) ; After { or ; + spaces
2053 (looking-at "[ \t]*}") ; Before }
2054 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2057 (eq (car (parse-partial-sexp pos end -1)) -1)
2058 ; Leave the level of parens
2059 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2061 (cperl-after-block-p (point-min))
2064 (setq start (point-marker))
2065 (<= start pos))))) ; Redundant? Are after the
2066 ; start of parens group.
2068 (skip-chars-backward " \t")
2069 (or (memq (preceding-char) (append ";{" nil))
2075 (or (looking-at "{[ \t]*$") ; If there is a statement
2076 ; before, move it to separate line
2080 (cperl-indent-line)))
2081 (forward-line 1) ; We are on the target line
2084 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2085 ; after, move it to separate line
2088 (search-backward "}" beg)
2089 (skip-chars-backward " \t")
2090 (or (memq (preceding-char) (append ";{" nil))
2095 (forward-line -1) ; We are on the line before target
2097 (newline-and-indent))
2098 (end-of-line) ; else - no splitting
2100 ((and (looking-at "\n[ \t]*{$")
2102 (skip-chars-backward " \t")
2103 (eq (preceding-char) ?\)))) ; Probably if () {} group
2104 ; with an extra newline.
2106 (cperl-indent-line))
2107 ((save-excursion ; In POD header
2108 (forward-paragraph -1)
2109 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2110 ;; We are after \n now, so look for the rest
2111 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2113 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2114 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2118 (forward-paragraph -1)
2121 (setq cut (buffer-substring (point)
2125 (delete-char (- (save-excursion (end-of-line) (point))
2127 (setq res (expand-abbrev))
2133 (cperl-ensure-newlines (if cut 2 4))
2135 ((get-text-property (point) 'in-pod) ; In POD section
2136 (cperl-ensure-newlines 4)
2138 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2140 (cperl-indent-line))
2142 (newline-and-indent))))))
2144 (defun cperl-electric-semi (arg)
2145 "Insert character and correct line's indentation."
2147 (if cperl-auto-newline
2148 (cperl-electric-terminator arg)
2149 (self-insert-command (prefix-numeric-value arg))
2150 (if cperl-autoindent-on-semi
2151 (cperl-indent-line))))
2153 (defun cperl-electric-terminator (arg)
2154 "Insert character and correct line's indentation."
2157 (auto (and cperl-auto-newline
2158 (or (not (eq last-command-char ?:))
2159 cperl-auto-newline-after-colon)))
2161 (if (and ;;(not arg)
2163 (not (save-excursion
2165 (skip-chars-forward " \t")
2167 ;; Ignore in comment lines
2168 (= (following-char) ?#)
2169 ;; Colon is special only after a label
2170 ;; So quickly rule out most other uses of colon
2171 ;; and do no indentation for them.
2172 (and (eq last-command-char ?:)
2175 (skip-chars-forward " \t")
2176 (and (< (point) end)
2177 (progn (goto-char (- end 1))
2178 (not (looking-at ":"))))))
2180 (beginning-of-defun)
2181 (let ((pps (parse-partial-sexp (point) end)))
2182 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2184 (self-insert-command (prefix-numeric-value arg))
2186 (if auto (setq insertpos (point-marker)))
2192 (cperl-indent-line)))
2194 (if insertpos (goto-char (1- (marker-position insertpos)))
2199 (goto-char insertpos)
2200 (self-insert-command (prefix-numeric-value arg)))
2201 (self-insert-command (prefix-numeric-value arg)))))
2203 (defun cperl-electric-backspace (arg)
2204 "Backspace, or remove the whitespace around the point inserted by an electric
2205 key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2207 (if (and cperl-auto-newline
2208 (memq last-command '(cperl-electric-semi
2209 cperl-electric-terminator
2210 cperl-electric-lbrace))
2211 (memq (preceding-char) '(?\ ?\t ?\n)))
2213 (if (eq last-command 'cperl-electric-lbrace)
2214 (skip-chars-forward " \t\n"))
2216 (skip-chars-backward " \t\n")
2217 (delete-region (point) p))
2218 (and (eq last-command 'cperl-electric-else)
2219 ;; We are removing the whitespace *inside* cperl-electric-else
2220 (setq this-command 'cperl-electric-else-really))
2221 (if (and cperl-auto-newline
2222 (eq last-command 'cperl-electric-else-really)
2223 (memq (preceding-char) '(?\ ?\t ?\n)))
2225 (skip-chars-forward " \t\n")
2227 (skip-chars-backward " \t\n")
2228 (delete-region (point) p))
2229 (if cperl-electric-backspace-untabify
2230 (backward-delete-char-untabify arg)
2231 (delete-backward-char arg)))))
2233 (put 'cperl-electric-backspace 'delete-selection 'supersede)
2235 (defun cperl-inside-parens-p ()
2239 (narrow-to-region (point)
2240 (progn (beginning-of-defun) (point)))
2241 (goto-char (point-max))
2242 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2245 (defun cperl-indent-command (&optional whole-exp)
2246 "Indent current line as Perl code, or in some cases insert a tab character.
2247 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2248 line. Otherwise, indent the current line only if point is at the left margin
2249 or in the line's indentation; otherwise insert a tab.
2251 A numeric argument, regardless of its value,
2252 means indent rigidly all the lines of the expression starting after point
2253 so that this line becomes properly indented.
2254 The relative indentation among the lines of the expression are preserved."
2256 (cperl-update-syntaxification (point) (point))
2258 ;; If arg, always indent this line as Perl
2259 ;; and shift remaining lines of expression the same amount.
2260 (let ((shift-amt (cperl-indent-line))
2263 (if cperl-tab-always-indent
2264 (beginning-of-line))
2271 (if (and shift-amt (> end beg))
2272 (indent-code-rigidly beg end shift-amt "#")))
2273 (if (and (not cperl-tab-always-indent)
2275 (skip-chars-backward " \t")
2278 (cperl-indent-line))))
2280 (defun cperl-indent-line (&optional parse-data)
2281 "Indent current line as Perl code.
2282 Return the amount the indentation changed by."
2283 (let ((case-fold-search nil)
2284 (pos (- (point-max) (point)))
2285 indent i beg shift-amt)
2286 (setq indent (cperl-calculate-indent parse-data)
2290 (cond ((or (eq indent nil) (eq indent t))
2291 (setq indent (current-indentation) i nil))
2292 ;;((eq indent t) ; Never?
2293 ;; (setq indent (cperl-calculate-indent-within-comment)))
2294 ;;((looking-at "[ \t]*#")
2297 (skip-chars-forward " \t")
2298 (if (listp indent) (setq indent (car indent)))
2299 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2301 (setq indent (max cperl-min-label-indent
2302 (+ indent cperl-label-offset)))))
2303 ((= (following-char) ?})
2304 (setq indent (- indent cperl-indent-level)))
2305 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2306 (setq indent (+ indent cperl-close-paren-offset)))
2307 ((= (following-char) ?{)
2308 (setq indent (+ indent cperl-brace-offset))))))
2309 (skip-chars-forward " \t")
2310 (setq shift-amt (and i (- indent (current-column))))
2311 (if (or (not shift-amt)
2313 (if (> (- (point-max) pos) (point))
2314 (goto-char (- (point-max) pos)))
2315 (delete-region beg (point))
2317 ;; If initial point was within line's indentation,
2318 ;; position after the indentation. Else stay at same point in text.
2319 (if (> (- (point-max) pos) (point))
2320 (goto-char (- (point-max) pos))))
2323 (defun cperl-after-label ()
2324 ;; Returns true if the point is after label. Does not do save-excursion.
2325 (and (eq (preceding-char) ?:)
2326 (memq (char-syntax (char-after (- (point) 2)))
2330 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2332 (defun cperl-get-state (&optional parse-start start-state)
2333 ;; returns list (START STATE DEPTH PRESTART),
2334 ;; START is a good place to start parsing, or equal to
2335 ;; PARSE-START if preset,
2336 ;; STATE is what is returned by `parse-partial-sexp'.
2337 ;; DEPTH is true is we are immediately after end of block
2338 ;; which contains START.
2339 ;; PRESTART is the position basing on which START was found.
2341 (let ((start-point (point)) depth state start prestart)
2342 (if (and parse-start
2343 (<= parse-start start-point))
2344 (goto-char parse-start)
2345 (beginning-of-defun)
2346 (setq start-state nil))
2347 (setq prestart (point))
2349 ;; Try to go out, if sub is not on the outermost level
2350 (while (< (point) start-point)
2351 (setq start (point) parse-start start depth nil
2352 state (parse-partial-sexp start start-point -1))
2353 (if (> (car state) -1) nil
2354 ;; The current line could start like }}}, so the indentation
2355 ;; corresponds to a different level than what we reached
2357 (beginning-of-line 2))) ; Go to the next line.
2358 (if start (goto-char start))) ; Not at the start of file
2359 (setq start (point))
2360 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2361 (list start state depth prestart))))
2363 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
2364 ;; Positions is before ?\{. Checks whether it starts a block.
2365 ;; No save-excursion!
2366 (cperl-backward-to-noncomment (point-min))
2367 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
2368 ; Label may be mixed up with `$blah :'
2369 (save-excursion (cperl-after-label))
2370 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2373 ;; Need take into account `bless', `return', `tr',...
2374 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
2375 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
2377 (skip-chars-backward " \t\n\f")
2378 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2382 "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
2384 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2386 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
2387 "Return appropriate indentation for current line as Perl code.
2388 In usual case returns an integer: the column to indent to.
2389 Returns nil if line starts inside a string, t if in a comment.
2391 Will not correct the indentation for labels, but will correct it for braces
2392 and closing parentheses and brackets."
2393 (cperl-update-syntaxification (point) (point))
2396 (and (memq (get-text-property (point) 'syntax-type)
2397 '(pod here-doc here-doc-delim format))
2398 (not (get-text-property (point) 'indentable)))
2399 ;; before start of POD - whitespace found since do not have 'pod!
2400 (and (looking-at "[ \t]*\n=")
2401 (error "Spaces before POD section!"))
2402 (and (not cperl-indent-left-aligned-comments)
2406 (let ((indent-point (point))
2407 (char-after (save-excursion
2408 (skip-chars-forward " \t")
2410 (in-pod (get-text-property (point) 'in-pod))
2411 (pre-indent-point (point))
2412 p prop look-prop is-block delim)
2415 ;; In the verbatim part, probably code example. What to do???
2420 (cperl-backward-to-noncomment nil)
2421 (setq p (max (point-min) (1- (point)))
2422 prop (get-text-property p 'syntax-type)
2423 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2425 (if (memq prop '(pod here-doc format here-doc-delim))
2427 (goto-char (or (previous-single-property-change p look-prop)
2430 (setq pre-indent-point (point)))))))
2431 (goto-char pre-indent-point)
2432 (let* ((case-fold-search nil)
2433 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2434 (start (or (nth 2 parse-data)
2437 (containing-sexp (car (cdr state)))
2440 ;;containing-sexp ;; We are buggy at toplevel :-(
2443 (setcar parse-data pre-indent-point)
2444 (setcar (cdr parse-data) state)
2445 (or (nth 2 parse-data)
2446 (setcar (cddr parse-data) start))
2447 ;; Before this point: end of statement
2448 (setq old-indent (nth 3 parse-data))))
2449 (cond ((get-text-property (point) 'indentable)
2450 ;; indent to just after the surrounding open,
2451 ;; skip blanks if we do not close the expression.
2452 (goto-char (1+ (previous-single-property-change (point) 'indentable)))
2453 (or (memq char-after (append ")]}" nil))
2454 (looking-at "[ \t]*\\(#\\|$\\)")
2455 (skip-chars-forward " \t"))
2457 ((or (nth 3 state) (nth 4 state))
2458 ;; return nil or t if should not change this line
2460 ;; XXXX Do we need to special-case this?
2461 ((null containing-sexp)
2462 ;; Line is at top level. May be data or function definition,
2463 ;; or may be function argument declaration.
2464 ;; Indent like the previous top level line
2465 ;; unless that ends in a closeparen without semicolon,
2466 ;; in which case this line is the first argument decl.
2467 (skip-chars-forward " \t")
2470 (- (current-indentation)
2471 (if (nth 2 s-s) cperl-indent-level 0)))
2472 (if (= char-after ?{) cperl-continued-brace-offset 0)
2474 (cperl-backward-to-noncomment (or old-indent (point-min)))
2475 ;; Look at previous line that's at column 0
2476 ;; to determine whether we are in top-level decls
2477 ;; or function's arg decls. Set basic-indent accordingly.
2478 ;; Now add a little if this is a continuation line.
2480 (eq (point) old-indent) ; old-indent was at comment
2481 (eq (preceding-char) ?\;)
2483 (and (eq (preceding-char) ?\})
2484 (cperl-after-block-and-statement-beg
2485 (point-min))) ; Was start - too close
2486 (memq char-after (append ")]}" nil))
2487 (and (eq (preceding-char) ?\:) ; label
2490 (skip-chars-backward " \t")
2491 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2492 (get-text-property (point) 'first-format-line))
2495 (not (eq char-after ?\C-j)))
2496 (setcdr (cddr parse-data)
2497 (list pre-indent-point)))
2499 cperl-continued-statement-offset))))
2502 (and (setq delim (= (char-after containing-sexp) ?{))
2503 (save-excursion ; Is it a hash?
2504 (goto-char containing-sexp)
2506 cperl-indent-parens-as-block))
2507 ;; group is an expression, not a block:
2508 ;; indent to just after the surrounding open parens,
2509 ;; skip blanks if we do not close the expression.
2510 (goto-char (1+ containing-sexp))
2511 (or (memq char-after
2512 (append (if delim "}" ")]}") nil))
2513 (looking-at "[ \t]*\\(#\\|$\\)")
2514 (skip-chars-forward " \t"))
2517 (eq char-after ?\}))
2518 ;; Correct indentation of trailing ?\}
2519 (+ cperl-indent-level cperl-close-paren-offset)
2521 ;;; ((and (/= (char-after containing-sexp) ?{)
2522 ;;; (not cperl-indent-parens-as-block))
2523 ;;; ;; line is expression, not statement:
2524 ;;; ;; indent to just after the surrounding open,
2525 ;;; ;; skip blanks if we do not close the expression.
2526 ;;; (goto-char (1+ containing-sexp))
2527 ;;; (or (memq char-after (append ")]}" nil))
2528 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2529 ;;; (skip-chars-forward " \t"))
2530 ;;; (current-column))
2532 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
2533 ;;; (goto-char containing-sexp)
2534 ;;; (and (not (cperl-block-p))
2535 ;;; (not cperl-indent-parens-as-block)))
2536 ;;; (goto-char (1+ containing-sexp))
2537 ;;; (or (eq char-after ?\})
2538 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2539 ;;; (skip-chars-forward " \t"))
2540 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
2541 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
2542 ;;; cperl-close-paren-offset)
2545 ;; Statement level. Is it a continuation or a new statement?
2546 ;; Find previous non-comment character.
2547 (goto-char pre-indent-point)
2548 (cperl-backward-to-noncomment containing-sexp)
2549 ;; Back up over label lines, since they don't
2550 ;; affect whether our line is a continuation.
2552 (while ;;(or (eq (preceding-char) ?\,)
2553 (and (eq (preceding-char) ?:)
2554 (or ;;(eq (char-after (- (point) 2)) ?\') ; ????
2555 (memq (char-syntax (char-after (- (point) 2)))
2558 (if (eq (preceding-char) ?\,)
2559 ;; Will go to beginning of line, essentially.
2560 ;; Will ignore embedded sexpr XXXX.
2561 (cperl-backward-to-start-of-continued-exp containing-sexp))
2563 (cperl-backward-to-noncomment containing-sexp))
2564 ;; Now we get the answer.
2565 (if (not (or (eq (1- (point)) containing-sexp)
2566 (memq (preceding-char)
2567 (append (if is-block " ;{" " ,;{") '(nil)))
2568 (and (eq (preceding-char) ?\})
2569 (cperl-after-block-and-statement-beg
2571 (get-text-property (point) 'first-format-line)))
2572 ;; This line is continuation of preceding line's statement;
2573 ;; indent `cperl-continued-statement-offset' more than the
2574 ;; previous line of the statement.
2576 ;; There might be a label on this line, just
2577 ;; consider it bad style and ignore it.
2579 (cperl-backward-to-start-of-continued-exp containing-sexp)
2580 (+ (if (memq char-after (append "}])" nil))
2582 cperl-continued-statement-offset)
2585 (not (eq char-after ?\})))
2587 ;; Now it is a hash reference
2588 (+ cperl-indent-level cperl-close-paren-offset))
2589 (if (looking-at "\\w+[ \t]*:")
2590 (if (> (current-indentation) cperl-min-label-indent)
2591 (- (current-indentation) cperl-label-offset)
2592 ;; Do not move `parse-data', this should
2593 ;; be quick anyway (this comment comes
2594 ;; from different location):
2595 (cperl-calculate-indent))
2597 (if (eq char-after ?\{)
2598 cperl-continued-brace-offset 0)))
2599 ;; This line starts a new statement.
2600 ;; Position following last unclosed open.
2601 (goto-char containing-sexp)
2602 ;; Is line first statement after an open-brace?
2604 ;; If no, find that first statement and indent like
2605 ;; it. If the first statement begins with label, do
2606 ;; not believe when the indentation of the label is too
2610 (setq old-indent (current-indentation))
2611 (let ((colon-line-end 0))
2613 (progn (skip-chars-forward " \t\n")
2614 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
2615 ;; Skip over comments and labels following openbrace.
2616 (cond ((= (following-char) ?\#)
2618 ((= (following-char) ?\=)
2620 (or (next-single-property-change (point) 'in-pod)
2621 (point-max)))) ; do not loop if no syntaxification
2624 (save-excursion (end-of-line)
2625 (setq colon-line-end (point)))
2626 (search-forward ":"))))
2627 ;; The first following code counts
2628 ;; if it is before the line we want to indent.
2629 (and (< (point) indent-point)
2630 (if (> colon-line-end (point)) ; After label
2631 (if (> (current-indentation)
2632 cperl-min-label-indent)
2633 (- (current-indentation) cperl-label-offset)
2634 ;; Do not believe: `max' is involved
2635 (+ old-indent cperl-indent-level))
2636 (current-column)))))
2637 ;; If no previous statement,
2638 ;; indent it relative to line brace is on.
2639 ;; For open brace in column zero, don't let statement
2640 ;; start there too. If cperl-indent-level is zero,
2641 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2642 ;; For open-braces not the first thing in a line,
2643 ;; add in cperl-brace-imaginary-offset.
2645 ;; If first thing on a line: ?????
2646 (+ (if (and (bolp) (zerop cperl-indent-level))
2647 (+ cperl-brace-offset cperl-continued-statement-offset)
2651 (not (eq char-after ?\})))
2653 ;; Now it is a hash reference
2654 (+ cperl-indent-level cperl-close-paren-offset))
2655 ;; Move back over whitespace before the openbrace.
2656 ;; If openbrace is not first nonwhite thing on the line,
2657 ;; add the cperl-brace-imaginary-offset.
2658 (progn (skip-chars-backward " \t")
2659 (if (bolp) 0 cperl-brace-imaginary-offset))
2660 ;; If the openbrace is preceded by a parenthesized exp,
2661 ;; move to the beginning of that;
2662 ;; possibly a different line
2664 (if (eq (preceding-char) ?\))
2666 ;; In the case it starts a subroutine, indent with
2667 ;; respect to `sub', not with respect to the
2668 ;; first thing on the line, say in the case of
2669 ;; anonymous sub in a hash.
2671 (skip-chars-backward " \t")
2672 (if (and (eq (preceding-char) ?b)
2675 (looking-at "sub\\>"))
2679 (save-excursion (beginning-of-line) (point))
2681 (progn (goto-char (1+ old-indent))
2682 (skip-chars-forward " \t")
2684 ;; Get initial indentation of the line we are on.
2685 ;; If line starts with label, calculate label indentation
2688 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2689 (if (> (current-indentation) cperl-min-label-indent)
2690 (- (current-indentation) cperl-label-offset)
2691 ;; Do not move `parse-data', this should
2693 (cperl-calculate-indent))
2694 (current-indentation))))))))))))))
2696 (defvar cperl-indent-alist
2700 (toplevel-after-parenth 2)
2701 (toplevel-continued 2)
2703 "Alist of indentation rules for CPerl mode.
2706 number: add this amount of indentation.
2708 Not finished, not used.")
2710 (defun cperl-where-am-i (&optional parse-start start-state)
2712 "Return a list of lists ((TYPE POS)...) of good points before the point.
2713 POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2715 Not finished, not used."
2717 (let* ((start-point (point))
2718 (s-s (cperl-get-state))
2721 (prestart (nth 3 s-s))
2722 (containing-sexp (car (cdr state)))
2723 (case-fold-search nil)
2724 (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
2725 (cond ((nth 3 state) ; In string
2726 (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
2727 ((nth 4 state) ; In comment
2728 (setq res (cons '(comment) res)))
2729 ((null containing-sexp)
2730 ;; Line is at top level.
2731 ;; Indent like the previous top level line
2732 ;; unless that ends in a closeparen without semicolon,
2733 ;; in which case this line is the first argument decl.
2734 (cperl-backward-to-noncomment (or parse-start (point-min)))
2735 ;;(skip-chars-backward " \t\f\n")
2738 (memq (preceding-char) (append ";}" nil)))
2739 (setq res (cons (list 'toplevel start) res)))
2740 ((eq (preceding-char) ?\) )
2741 (setq res (cons (list 'toplevel-after-parenth start) res)))
2743 (setq res (cons (list 'toplevel-continued start) res)))))
2744 ((/= (char-after containing-sexp) ?{)
2745 ;; line is expression, not statement:
2746 ;; indent to just after the surrounding open.
2747 ;; skip blanks if we do not close the expression.
2748 (setq res (cons (list 'expression-blanks
2750 (goto-char (1+ containing-sexp))
2751 (or (looking-at "[ \t]*\\(#\\|$\\)")
2752 (skip-chars-forward " \t"))
2754 (cons (list 'expression containing-sexp) res))))
2756 ;; Containing-expr starts with \{. Check whether it is a hash.
2757 (goto-char containing-sexp)
2758 (not (cperl-block-p)))
2759 (setq res (cons (list 'expression-blanks
2761 (goto-char (1+ containing-sexp))
2762 (or (looking-at "[ \t]*\\(#\\|$\\)")
2763 (skip-chars-forward " \t"))
2765 (cons (list 'expression containing-sexp) res))))
2768 (setq res (cons (list 'in-block containing-sexp) res))
2769 ;; Is it a continuation or a new statement?
2770 ;; Find previous non-comment character.
2771 (cperl-backward-to-noncomment containing-sexp)
2772 ;; Back up over label lines, since they don't
2773 ;; affect whether our line is a continuation.
2774 ;; Back up comma-delimited lines too ?????
2775 (while (or (eq (preceding-char) ?\,)
2776 (save-excursion (cperl-after-label)))
2777 (if (eq (preceding-char) ?\,)
2778 ;; Will go to beginning of line, essentially
2779 ;; Will ignore embedded sexpr XXXX.
2780 (cperl-backward-to-start-of-continued-exp containing-sexp))
2782 (cperl-backward-to-noncomment containing-sexp))
2783 ;; Now we get the answer.
2784 (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
2785 ;; This line is continuation of preceding line's statement.
2786 (list (list 'statement-continued containing-sexp))
2787 ;; This line starts a new statement.
2788 ;; Position following last unclosed open.
2789 (goto-char containing-sexp)
2790 ;; Is line first statement after an open-brace?
2792 ;; If no, find that first statement and indent like
2793 ;; it. If the first statement begins with label, do
2794 ;; not believe when the indentation of the label is too
2798 (let ((colon-line-end 0))
2799 (while (progn (skip-chars-forward " \t\n" start-point)
2800 (and (< (point) start-point)
2802 "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
2803 ;; Skip over comments and labels following openbrace.
2804 (cond ((= (following-char) ?\#)
2809 (save-excursion (end-of-line)
2810 (setq colon-line-end (point)))
2811 (search-forward ":"))))
2812 ;; Now at the point, after label, or at start
2813 ;; of first statement in the block.
2814 (and (< (point) start-point)
2815 (if (> colon-line-end (point))
2816 ;; Before statement after label
2817 (if (> (current-indentation)
2818 cperl-min-label-indent)
2819 (list (list 'label-in-block (point)))
2820 ;; Do not believe: `max' is involved
2822 (list 'label-in-block-min-indent (point))))
2824 (list 'statement-in-block (point))))))
2825 ;; If no previous statement,
2826 ;; indent it relative to line brace is on.
2827 ;; For open brace in column zero, don't let statement
2828 ;; start there too. If cperl-indent-level is zero,
2829 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2830 ;; For open-braces not the first thing in a line,
2831 ;; add in cperl-brace-imaginary-offset.
2833 ;; If first thing on a line: ?????
2834 (+ (if (and (bolp) (zerop cperl-indent-level))
2835 (+ cperl-brace-offset cperl-continued-statement-offset)
2837 ;; Move back over whitespace before the openbrace.
2838 ;; If openbrace is not first nonwhite thing on the line,
2839 ;; add the cperl-brace-imaginary-offset.
2840 (progn (skip-chars-backward " \t")
2841 (if (bolp) 0 cperl-brace-imaginary-offset))
2842 ;; If the openbrace is preceded by a parenthesized exp,
2843 ;; move to the beginning of that;
2844 ;; possibly a different line
2846 (if (eq (preceding-char) ?\))
2848 ;; Get initial indentation of the line we are on.
2849 ;; If line starts with label, calculate label indentation
2852 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2853 (if (> (current-indentation) cperl-min-label-indent)
2854 (- (current-indentation) cperl-label-offset)
2855 (cperl-calculate-indent))
2856 (current-indentation))))))))
2859 (defun cperl-calculate-indent-within-comment ()
2860 "Return the indentation amount for line, assuming that
2861 the current line is to be regarded as part of a block comment."
2862 (let (end star-start)
2865 (skip-chars-forward " \t")
2867 (and (= (following-char) ?#)
2869 (cperl-to-comment-or-eol)
2875 (defun cperl-to-comment-or-eol ()
2876 "Go to position before comment on the current line, or to end of line.
2877 Returns true if comment is found."
2878 (let (state stop-in cpoint (lim (progn (end-of-line) (point))))
2881 (eq (get-text-property (point) 'syntax-type) 'pod)
2882 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t))
2883 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
2885 (while (not stop-in)
2886 (setq state (parse-partial-sexp (point) lim nil nil nil t))
2888 ;; If fails (beginning-of-line inside sexp), then contains not-comment
2889 (if (nth 4 state) ; After `#';
2890 ; (nth 2 state) can be
2891 ; beginning of m,s,qq and so
2895 (setq cpoint (point))
2896 (goto-char (nth 2 state))
2898 ((looking-at "\\(s\\|tr\\)\\>")
2899 (or (re-search-forward
2900 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
2903 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
2904 (or (re-search-forward
2905 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
2908 (t ; It was fair comment
2909 (setq stop-in t) ; Finish
2910 (goto-char (1- cpoint)))))
2911 (setq stop-in t) ; Finish
2913 (setq stop-in t))) ; Finish
2916 (defsubst cperl-1- (p)
2917 (max (point-min) (1- p)))
2919 (defsubst cperl-1+ (p)
2920 (min (point-max) (1+ p)))
2922 (defsubst cperl-modify-syntax-type (at how)
2923 (if (< at (point-max))
2925 (put-text-property at (1+ at) 'syntax-table how)
2926 (put-text-property at (1+ at) 'rear-nonsticky t))))
2928 (defun cperl-protect-defun-start (s e)
2929 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2932 (while (re-search-forward "^\\s(" e 'to-end)
2933 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
2935 (defun cperl-commentify (bb e string &optional noface)
2936 (if cperl-use-syntax-table-text-property
2937 (if (eq noface 'n) ; Only immediate
2939 ;; We suppose that e is _after_ the end of construction, as after eol.
2940 (setq string (if string cperl-st-sfence cperl-st-cfence))
2942 ;; one-char string/comment?!
2943 (cperl-modify-syntax-type bb cperl-st-punct)
2944 (cperl-modify-syntax-type bb string)
2945 (cperl-modify-syntax-type (1- e) string))
2946 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
2947 (put-text-property (1+ bb) (1- e)
2948 'syntax-table cperl-string-syntax-table))
2949 (cperl-protect-defun-start bb e))
2952 (not cperl-pod-here-fontify)
2953 (put-text-property bb e 'face (if string 'font-lock-string-face
2954 'font-lock-comment-face)))))
2956 (defvar cperl-starters '(( ?\( . ?\) )
2961 (defun cperl-forward-re (lim end is-2arg set-st st-l err-l argument
2962 &optional ostart oend)
2963 ;; Works *before* syntax recognition is done
2964 ;; May modify syntax-type text property if the situation is too hard
2965 (let (b starter ender st i i2 go-forward reset-st)
2966 (skip-chars-forward " \t")
2967 ;; ender means matching-char matcher.
2969 starter (if (eobp) 0 (char-after b))
2970 ender (cdr (assoc starter cperl-starters)))
2971 ;; What if starter == ?\\ ????
2974 (setq st (car st-l))
2975 (setcar st-l (make-syntax-table))
2976 (setq i 0 st (car st-l))
2978 (modify-syntax-entry i "." st)
2980 (modify-syntax-entry ?\\ "\\" st)))
2982 ;; Whether we have an intermediate point
2984 ;; Prepare the syntax table:
2986 (if (not ender) ; m/blah/, s/x//, s/x/y/
2987 (modify-syntax-entry starter "$" st)
2988 (modify-syntax-entry starter (concat "(" (list ender)) st)
2989 (modify-syntax-entry ender (concat ")" (list starter)) st)))
2992 ;; We use `$' syntax class to find matching stuff, but $$
2993 ;; is recognized the same as $, so we need to check this manually.
2994 (if (and (eq starter (char-after (cperl-1+ b)))
2996 ;; $ has TeXish matching rules, so $$ equiv $...
2998 (setq reset-st (syntax-table))
2999 (set-syntax-table st)
3001 (if (<= (point) (1+ b))
3002 (error "Unfinished regular expression"))
3003 (set-syntax-table reset-st)
3005 ;; Now the problem is with m;blah;;
3007 (eq (preceding-char)
3008 (char-after (- (point) 2)))
3011 (= 0 (% (skip-chars-backward "\\\\") 2)))
3013 ;; Now we are after the first part.
3014 (and is-2arg ; Have trailing part
3016 (eq (following-char) starter) ; Empty trailing part
3018 (or (eq (char-syntax (following-char)) ?.)
3019 ;; Make trailing letter into punctuation
3020 (cperl-modify-syntax-type (point) cperl-st-punct))
3021 (setq is-2arg nil go-forward t))) ; Ignore the tail
3022 (if is-2arg ; Not number => have second part
3024 (setq i (point) i2 i)
3026 (if (memq (following-char) '(?\ ?\t ?\n ?\f))
3028 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3029 (goto-char (match-end 0))
3030 (skip-chars-forward " \t\n\f"))
3033 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3034 (if ender (modify-syntax-entry ender "." st))
3036 (setq ender (cperl-forward-re lim end nil t st-l err-l
3037 argument starter ender)
3038 ender (nth 2 ender)))))
3039 (error (goto-char lim)
3042 (set-syntax-table reset-st))
3045 "End of `%s%s%c ... %c' string/RE not found: %s"
3047 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3048 starter (or ender starter) bb)
3049 (or (car err-l) (setcar err-l b)))))
3052 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3053 (if ender (modify-syntax-entry ender "." st))))
3054 ;; i: have 2 args, after end of the first arg
3055 ;; i2: start of the second arg, if any (before delim iff `ender').
3056 ;; ender: the last arg bounded by parens-like chars, the second one of them
3057 ;; starter: the starting delimiter of the first arg
3058 ;; go-forward: has 2 args, and the second part is empty
3059 (list i i2 ender starter go-forward)))
3061 (defvar font-lock-string-face)
3062 ;;(defvar font-lock-reference-face)
3063 (defvar font-lock-constant-face)
3064 (defsubst cperl-postpone-fontification (b e type val &optional now)
3065 ;; Do after syntactic fontification?
3066 (if cperl-syntaxify-by-font-lock
3067 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3068 (put-text-property b e type val)))
3070 ;;; Here is how the global structures (those which cannot be
3071 ;;; recognized locally) are marked:
3073 ;; Start-to-end is marked `in-pod' ==> t
3074 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3075 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3077 ;; Start-to-end is marked `here-doc-group' ==> t
3078 ;; The body is marked `syntax-type' ==> `here-doc'
3079 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3081 ;; First line (to =) marked `first-format-line' ==> t
3082 ;; After-this--to-end is marked `syntax-type' ==> `format'
3083 ;; d) 'Q'uoted string:
3084 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3085 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3087 (defun cperl-unwind-to-safe (before &optional end)
3088 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3089 (let ((pos (point)) opos)
3091 (while (and pos (get-text-property pos 'syntax-type))
3092 (setq pos (previous-single-property-change pos 'syntax-type))
3096 (goto-char (cperl-1- pos))
3099 (goto-char (setq pos (cperl-1- pos))))
3101 (goto-char (point-min))))
3103 (and (looking-at "\n*=")
3104 (/= 0 (skip-chars-backward "\n"))
3108 ;; Do the same for end, going small steps
3110 (while (and end (get-text-property end 'syntax-type))
3112 end (next-single-property-change end 'syntax-type)))
3115 (defvar cperl-nonoverridable-face)
3116 (defvar font-lock-function-name-face)
3117 (defvar font-lock-comment-face)
3119 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max)
3120 "Scans the buffer for hard-to-parse Perl constructions.
3121 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3122 the sections using `cperl-pod-head-face', `cperl-pod-face',
3125 (or min (setq min (point-min)
3126 cperl-syntax-state nil
3127 cperl-syntax-done-to min))
3128 (or max (setq max (point-max)))
3129 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3130 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3131 is-REx is-x-REx REx-comment-start REx-comment-end was-comment i2
3132 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3133 (modified (buffer-modified-p))
3134 (after-change-functions nil)
3135 (use-syntax-state (and cperl-syntax-state
3136 (>= min (car cperl-syntax-state))))
3137 (state-point (if use-syntax-state
3138 (car cperl-syntax-state)
3140 (state (if use-syntax-state
3141 (cdr cperl-syntax-state)))
3142 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3143 (st-l (list nil)) (err-l (list nil))
3144 ;; Somehow font-lock may be not loaded yet...
3145 (font-lock-string-face (if (boundp 'font-lock-string-face)
3146 font-lock-string-face
3147 'font-lock-string-face))
3148 (font-lock-constant-face (if (boundp 'font-lock-constant-face)
3149 font-lock-constant-face
3150 'font-lock-constant-face))
3151 (font-lock-function-name-face
3152 (if (boundp 'font-lock-function-name-face)
3153 font-lock-function-name-face
3154 'font-lock-function-name-face))
3155 (font-lock-comment-face
3156 (if (boundp 'font-lock-comment-face)
3157 font-lock-comment-face
3158 'font-lock-comment-face))
3159 (cperl-nonoverridable-face
3160 (if (boundp 'cperl-nonoverridable-face)
3161 cperl-nonoverridable-face
3162 'cperl-nonoverridable-face))
3163 (stop-point (if ignore-max
3168 "\\(\\`\n?\\|^\n\\)="
3170 ;; One extra () before this:
3173 ;; First variant "BLAH" or just ``.
3174 "[ \t]*" ; Yes, whitespace is allowed!
3175 "\\([\"'`]\\)" ; 2 + 1 = 3
3176 "\\([^\"'`\n]*\\)" ; 3 + 1
3179 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3180 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3181 ;; Do not have <<= or << 30 or <<30 or << $blah.
3182 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3183 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3186 ;; 1+6 extra () before this:
3187 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3188 (if cperl-use-syntax-table-text-property
3191 ;; 1+6+2=9 extra () before this:
3192 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3194 ;; 1+6+2+1=10 extra () before this:
3195 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3197 ;; 1+6+2+1+1=11 extra () before this:
3198 "\\<sub\\>[ \t]*\\([a-zA-Z_:'0-9]+[ \t]*\\)?\\(([^()]*)\\)"
3200 ;; 1+6+2+1+1+2=13 extra () before this:
3203 ;; 1+6+2+1+1+2+1=14 extra () before this:
3204 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3205 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3207 "__\\(END\\|DATA\\)__"
3208 ;; 1+6+2+1+1+2+1+1+1=16 extra () before this:
3210 "\\\\\\(['`\"($]\\)")
3216 (message "Scanning for \"hard\" Perl constructions..."))
3217 (and cperl-pod-here-fontify
3218 ;; We had evals here, do not know why...
3219 (setq face cperl-pod-face
3220 head-face cperl-pod-head-face
3221 here-face cperl-here-face))
3222 (remove-text-properties min max
3223 '(syntax-type t in-pod t syntax-table t
3230 ;; Need to remove face as well...
3232 (and (eq system-type 'emx)
3233 (looking-at "extproc[ \t]") ; Analogue of #!
3234 (cperl-commentify min
3235 (save-excursion (end-of-line) (point))
3239 (re-search-forward search max t))
3240 (setq tmpend nil) ; Valid for most cases
3242 ((match-beginning 1) ; POD section
3243 ;; "\\(\\`\n?\\|^\n\\)="
3244 (if (looking-at "cut\\>")
3246 nil ; Doing a chunk only
3247 (message "=cut is not preceded by a POD section")
3248 (or (car err-l) (setcar err-l (point))))
3253 tb (match-beginning 0)
3254 b1 nil) ; error condition
3255 ;; We do not search to max, since we may be called from
3256 ;; some hook of fontification, and max is random
3257 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
3260 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3262 (message "=cut is not preceded by an empty line")
3264 (or (car err-l) (setcar err-l b))))))
3265 (beginning-of-line 2) ; An empty line after =cut is not POD!
3269 (remove-text-properties
3270 max e '(syntax-type t in-pod t syntax-table t
3278 (put-text-property b e 'in-pod t)
3279 (put-text-property b e 'syntax-type 'in-pod)
3281 (while (re-search-forward "\n\n[ \t]" e t)
3282 ;; We start 'pod 1 char earlier to include the preceding line
3284 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3285 (cperl-put-do-not-fontify b (point) t)
3286 ;; mark the non-literal parts as PODs
3287 (if cperl-pod-here-fontify
3288 (cperl-postpone-fontification b (point) 'face face t))
3289 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3292 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3293 (cperl-put-do-not-fontify (point) e t)
3294 (if cperl-pod-here-fontify
3296 ;; mark the non-literal parts as PODs
3297 (cperl-postpone-fontification (point) e 'face face t)
3300 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3302 (cperl-postpone-fontification
3303 (match-beginning 1) (match-end 1)
3305 (while (re-search-forward
3307 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3310 (cperl-postpone-fontification
3311 (match-beginning 1) (match-end 1)
3313 (cperl-commentify bb e nil)
3315 (or (eq e (point-max))
3316 (forward-char -1)))) ; Prepare for immediate POD start.
3318 ;; We do only one here-per-line
3319 ;; ;; One extra () before this:
3322 ;; ;; First variant "BLAH" or just ``.
3323 ;; "[ \t]*" ; Yes, whitespace is allowed!
3324 ;; "\\([\"'`]\\)" ; 2 + 1
3325 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3328 ;; ;; Second variant: Identifier or \ID or empty
3329 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3330 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3331 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3332 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3334 ((match-beginning 2) ; 1 + 1
3335 ;; Abort in comment:
3337 (setq state (parse-partial-sexp state-point b nil nil state)
3339 tb (match-beginning 0)
3340 i (or (nth 3 state) (nth 4 state)))
3345 (not (match-beginning 6)) ; Empty
3347 "[ \t]*[=0-9$@%&(]"))))
3348 (if c ; Not here-doc
3350 (if (match-beginning 5) ;4 + 1
3351 (setq b1 (match-beginning 5) ; 4 + 1
3352 e1 (match-end 5)) ; 4 + 1
3353 (setq b1 (match-beginning 4) ; 3 + 1
3354 e1 (match-end 4))) ; 3 + 1
3355 (setq tag (buffer-substring b1 e1)
3356 qtag (regexp-quote tag))
3357 (cond (cperl-pod-here-fontify
3358 ;; Highlight the starting delimiter
3359 (cperl-postpone-fontification b1 e1 'face font-lock-constant-face)
3360 (cperl-put-do-not-fontify b1 e1 t)))
3363 ;; We do not search to max, since we may be called from
3364 ;; some hook of fontification, and max is random
3365 (or (and (re-search-forward (concat "^" qtag "$")
3367 (eq (following-char) ?\n))
3368 (progn ; Pretend we matched at the end
3369 (goto-char (point-max))
3370 (re-search-forward "\\'")
3371 (message "End of here-document `%s' not found." tag)
3372 (or (car err-l) (setcar err-l b))))
3373 (if cperl-pod-here-fontify
3375 ;; Highlight the ending delimiter
3376 (cperl-postpone-fontification (match-beginning 0) (match-end 0)
3377 'face font-lock-constant-face)
3378 (cperl-put-do-not-fontify b (match-end 0) t)
3379 ;; Highlight the HERE-DOC
3380 (cperl-postpone-fontification b (match-beginning 0)
3382 (setq e1 (cperl-1+ (match-end 0)))
3383 (put-text-property b (match-beginning 0)
3384 'syntax-type 'here-doc)
3385 (put-text-property (match-beginning 0) e1
3386 'syntax-type 'here-doc-delim)
3387 (put-text-property b e1
3389 (cperl-commentify b e1 nil)
3390 (cperl-put-do-not-fontify b (match-end 0) t)
3394 ((match-beginning 8)
3395 ;; 1+6=7 extra () before this:
3396 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3398 name (if (match-beginning 8) ; 7 + 1
3399 (buffer-substring (match-beginning 8) ; 7 + 1
3400 (match-end 8)) ; 7 + 1
3402 tb (match-beginning 0))
3404 (put-text-property (save-excursion
3407 b 'first-format-line 't)
3408 (if cperl-pod-here-fontify
3409 (while (and (eq (forward-line) 0)
3410 (not (looking-at "^[.;]$")))
3412 ((looking-at "^#")) ; Skip comments
3413 ((and argument ; Skip argument multi-lines
3414 (looking-at "^[ \t]*{"))
3416 (setq argument nil))
3417 (argument ; Skip argument lines
3418 (setq argument nil))
3421 (setq argument (looking-at "^[^\n]*[@^]"))
3423 ;; Highlight the format line
3424 (cperl-postpone-fontification b1 (point)
3425 'face font-lock-string-face)
3426 (cperl-commentify b1 (point) nil)
3427 (cperl-put-do-not-fontify b1 (point) t))))
3428 ;; We do not search to max, since we may be called from
3429 ;; some hook of fontification, and max is random
3430 (re-search-forward "^[.;]$" stop-point 'toend))
3432 (if (looking-at "^\\.$") ; ";" is not supported yet
3434 ;; Highlight the ending delimiter
3435 (cperl-postpone-fontification (point) (+ (point) 2)
3436 'face font-lock-string-face)
3437 (cperl-commentify (point) (+ (point) 2) nil)
3438 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
3439 (message "End of format `%s' not found." name)
3440 (or (car err-l) (setcar err-l b)))
3444 (put-text-property b (point) 'syntax-type 'format))
3446 ((or (match-beginning 10) (match-beginning 11))
3447 ;; 1+6+2=9 extra () before this:
3448 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3450 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3451 (setq b1 (if (match-beginning 10) 10 11)
3452 argument (buffer-substring
3453 (match-beginning b1) (match-end b1))
3456 c (char-after (match-beginning b1))
3457 bb (char-after (1- (match-beginning b1))) ; tmp holder
3458 ;; bb == "Not a stringy"
3459 bb (if (eq b1 10) ; user variables/whatever
3460 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
3461 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
3462 ((eq bb ?\:) ; $opt::s
3464 (- (match-beginning b1) 2))
3466 ((eq bb ?\>) ; $foo->s
3468 (- (match-beginning b1) 2))
3471 (not (eq (char-after ; &&m/blah/
3472 (- (match-beginning b1) 2))
3475 ;; <file> or <$file>
3477 ;; Do not stringify <FH>, <$fh> :
3480 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
3481 tb (match-beginning 0))
3482 (goto-char (match-beginning b1))
3483 (cperl-backward-to-noncomment (point-min))
3485 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
3491 ;; What is below: regexp-p?
3493 (or (memq (preceding-char)
3494 (append (if (memq c '(?\? ?\<))
3497 "~{(=|&+-*!,;:") nil))
3498 (and (eq (preceding-char) ?\})
3499 (cperl-after-block-p (point-min)))
3500 (and (eq (char-syntax (preceding-char)) ?w)
3503 ;; After these keywords `/' starts a RE. One should add all the
3504 ;; functions/builtins which expect an argument, but ...
3505 (if (eq (preceding-char) ?-)
3507 (looking-at "[a-zA-Z]\\>")
3509 (not (memq (preceding-char)
3512 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
3513 (and (eq (preceding-char) ?.)
3514 (eq (char-after (- (point) 2)) ?.))
3516 ;; m|blah| ? foo : bar;
3519 cperl-use-syntax-table-text-property
3523 (looking-at "\\s|")))))))
3526 ;; Check for $a -> y
3527 (setq b1 (preceding-char)
3530 (eq (char-after (- go 2)) ?-))
3533 (or bb (setq state (parse-partial-sexp
3534 state-point b nil nil state)
3536 (setq bb (or bb (nth 3 state) (nth 4 state)))
3540 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3541 (goto-char (match-end 0))
3542 (skip-chars-forward " \t\n\f"))
3543 (cond ((and (eq (following-char) ?\})
3545 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
3547 (skip-chars-backward " \t\n\f")
3548 (if (memq (preceding-char) (append "$@%&*" nil))
3554 (looking-at ; $foo -> {s}
3555 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
3556 (and ; $foo[12] -> {s}
3557 (memq (following-char) '(?\{ ?\[))
3560 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
3563 ((and (eq (following-char) ?=)
3564 (eq (char-after (1+ (point))) ?\>))
3565 ;; Check for { foo => 1, s => 2 }
3566 ;; Apparently s=> is never a substitution...
3568 ((and (eq (following-char) ?:)
3569 (eq b1 ?\{) ; Check for $ { s::bar }
3570 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
3573 (skip-chars-backward " \t\n\f")
3574 (memq (preceding-char)
3575 (append "$@%&*" nil))))
3579 ;; Skip whitespace and comments...
3580 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3581 (goto-char (match-end 0))
3582 (skip-chars-forward " \t\n\f"))
3584 (put-text-property b (point) 'syntax-type 'prestring))
3585 ;; qtag means two-arg matcher, may be reset to
3586 ;; 2 or 3 later if some special quoting is needed.
3587 ;; e1 means matching-char matcher.
3590 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
3591 ;; We do not search to max, since we may be called from
3592 ;; some hook of fontification, and max is random
3593 i (cperl-forward-re stop-point end
3595 t st-l err-l argument)
3596 ;; Note that if `go', then it is considered as 1-arg
3597 b1 (nth 1 i) ; start of the second part
3598 tag (nth 2 i) ; ender-char, true if second part
3599 ; is with matching chars []
3600 go (nth 4 i) ; There is a 1-char part after the end
3601 i (car i) ; intermediate point
3603 ;; Before end of the second part if non-matching: ///
3604 tail (if (and i (not tag))
3606 e (if i i e1) ; end of the first part
3607 qtag nil ; need to preserve backslashitis
3608 is-x-REx nil) ; REx has //x modifier
3609 ;; Commenting \\ is dangerous, what about ( ?
3611 (eq (char-after i) ?\\)
3613 (if (looking-at "\\sw*x") ; qr//x
3616 ;; Considered as 1arg form
3618 (cperl-commentify b (point) t)
3619 (put-text-property b (point) 'syntax-type 'string)
3621 ;; ignore other text properties:
3622 (string-match "^qw$" argument))
3623 (put-text-property b (point) 'indentable t))
3625 (setq e1 (cperl-1+ e1))
3628 (cperl-commentify b i t)
3629 (if (looking-at "\\sw*e") ; s///e
3633 (cperl-find-pods-heres b1 (1- (point)) t end)
3635 (goto-char (1+ max)))
3636 (if (and tag (eq (preceding-char) ?\>))
3638 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
3639 (cperl-modify-syntax-type i cperl-st-bra)))
3640 (put-text-property b i 'syntax-type 'string)
3642 (put-text-property b i 'indentable t)))
3643 (cperl-commentify b1 (point) t)
3644 (put-text-property b (point) 'syntax-type 'string)
3646 (put-text-property b i 'indentable t))
3648 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
3650 ;; Now: tail: if the second part is non-matching without ///e
3651 (if (eq (char-syntax (following-char)) ?w)
3653 (forward-word 1) ; skip modifiers s///s
3654 (if tail (cperl-commentify tail (point) t))
3655 (cperl-postpone-fontification
3656 e1 (point) 'face 'cperl-nonoverridable-face)))
3657 ;; Check whether it is m// which means "previous match"
3658 ;; and highlight differently
3660 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
3661 (or (not (= (length argument) 0))
3665 ;; split // *is* using zero-pattern
3671 (not (looking-at "split\\>")))
3673 (cperl-postpone-fontification
3674 b e 'face font-lock-function-name-face)
3675 (if (or i2 ; Has 2 args
3676 (and cperl-fontify-m-as-s
3678 (string-match "^\\(m\\|qr\\)$" argument)
3679 (and (eq 0 (length argument))
3680 (not (eq ?\< (char-after b)))))))
3682 (cperl-postpone-fontification
3683 b (cperl-1+ b) 'face font-lock-constant-face)
3684 (cperl-postpone-fontification
3685 (1- e) e 'face font-lock-constant-face)))
3686 (if (and is-REx cperl-regexp-scan)
3687 ;; Process RExen better
3694 (if (eq (char-after b) ?\#)
3695 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
3696 "\\((\\?#\\)\\|\\(#\\)")
3697 (if (eq (char-after b) ?\#)
3701 (goto-char (match-beginning 0))
3702 (setq REx-comment-start (point)
3706 ;; XXX not working if outside delimiter is #
3707 (eq (preceding-char) ?\\)
3708 (= (% (skip-chars-backward "$\\\\") 2) -1)))
3709 ;; Not a comment, avoid loop:
3710 (progn (setq was-comment nil)
3712 (if (match-beginning 2)
3714 (beginning-of-line 2)
3716 (goto-char (1- e))))
3717 ;; Works also if the outside delimiters are ().
3718 (or (search-forward ")" (1- e) 'toend)
3720 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
3721 REx-comment-start))))
3726 (setq REx-comment-end (point))
3728 REx-comment-start REx-comment-end nil)
3729 (cperl-postpone-fontification
3730 REx-comment-start REx-comment-end
3731 'face font-lock-comment-face))))))
3732 (if (and is-REx is-x-REx)
3733 (put-text-property (1+ b) (1- e)
3734 'syntax-subtype 'x-REx)))
3737 (cperl-postpone-fontification
3738 (1- e1) e1 'face font-lock-constant-face)
3739 (if (assoc (char-after b) cperl-starters)
3740 (cperl-postpone-fontification
3741 b1 (1+ b1) 'face font-lock-constant-face))))
3744 ((match-beginning 13) ; sub with prototypes
3745 (setq b (match-beginning 0))
3746 (if (memq (char-after (1- b))
3747 '(?\$ ?\@ ?\% ?\& ?\*))
3749 (setq state (parse-partial-sexp
3750 state-point b nil nil state)
3752 (if (or (nth 3 state) (nth 4 state))
3755 (cperl-commentify (match-beginning 13) (match-end 13) t))
3756 (goto-char (match-end 0))))
3757 ;; 1+6+2+1+1+2=13 extra () before this:
3759 ((and (match-beginning 14)
3760 (eq (preceding-char) ?\')) ; $'
3761 (setq b (1- (point))
3762 state (parse-partial-sexp
3763 state-point (1- b) nil nil state)
3765 (if (nth 3 state) ; in string
3766 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3768 ;; 1+6+2+1+1+2=13 extra () before this:
3770 ((match-beginning 14) ; ${
3771 (setq bb (match-beginning 0))
3772 (cperl-modify-syntax-type bb cperl-st-punct))
3773 ;; 1+6+2+1+1+2+1=14 extra () before this:
3774 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3775 ((match-beginning 15) ; old $abc'efg syntax
3776 (setq bb (match-end 0)
3777 b (match-beginning 0)
3778 state (parse-partial-sexp
3779 state-point b nil nil state)
3781 (if (nth 3 state) ; in string
3783 (put-text-property (1- bb) bb 'syntax-table cperl-st-word))
3785 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3786 ;; "__\\(END\\|DATA\\)__"
3787 ((match-beginning 16) ; __END__, __DATA__
3788 (setq bb (match-end 0)
3789 b (match-beginning 0)
3790 state (parse-partial-sexp
3791 state-point b nil nil state)
3793 (if (or (nth 3 state) (nth 4 state))
3795 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3796 (cperl-commentify b bb nil)
3799 ((match-beginning 17) ; "\\\\\\(['`\"($]\\)"
3800 ;; Trailing backslash ==> non-quoting outside string/comment
3801 (setq bb (match-end 0)
3802 b (match-beginning 0))
3804 (skip-chars-backward "\\\\")
3805 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
3806 (setq state (parse-partial-sexp
3807 state-point b nil nil state)
3809 (if (or (nth 3 state) (nth 4 state) )
3811 (cperl-modify-syntax-type b cperl-st-punct))
3813 (t (error "Error in regexp of the sniffer")))
3814 (if (> (point) stop-point)
3817 (message "Garbage after __END__/__DATA__ ignored")
3818 (message "Unbalanced syntax found while scanning")
3819 (or (car err-l) (setcar err-l b)))
3820 (goto-char stop-point))))
3821 (setq cperl-syntax-state (cons state-point state)
3822 cperl-syntax-done-to (or tmpend (max (point) max))))
3823 (if (car err-l) (goto-char (car err-l))
3825 (message "Scanning for \"hard\" Perl constructions... done"))))
3826 (and (buffer-modified-p)
3828 (set-buffer-modified-p nil))
3829 (set-syntax-table cperl-mode-syntax-table))
3832 (defun cperl-backward-to-noncomment (lim)
3833 ;; Stops at lim or after non-whitespace that is not in comment
3835 (while (and (not stop) (> (point) (or lim 1)))
3836 (skip-chars-backward " \t\n\f" lim)
3839 (if (memq (setq pr (get-text-property (point) 'syntax-type))
3840 '(pod here-doc here-doc-delim))
3841 (cperl-unwind-to-safe nil)
3842 (or (looking-at "^[ \t]*\\(#\\|$\\)")
3843 (progn (cperl-to-comment-or-eol) (bolp))
3845 (skip-chars-backward " \t")
3846 (if (< p (point)) (goto-char p))
3849 (defun cperl-after-block-p (lim &optional pre-block)
3850 "Return true if the preceeding } ends a block or a following { starts one.
3851 Would not look before LIM. If PRE-BLOCK is nil checks preceeding }.
3852 otherwise following {."
3853 ;; We suppose that the preceding char is }.
3857 (or pre-block (forward-sexp -1))
3858 (cperl-backward-to-noncomment lim)
3859 (or (eq (point) lim)
3860 (eq (preceding-char) ?\) ) ; if () {} sub f () {}
3861 (if (eq (char-syntax (preceding-char)) ?w) ; else {}
3864 (or (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
3867 (cperl-backward-to-noncomment lim)
3868 (and (eq (char-syntax (preceding-char)) ?w)
3871 (looking-at "sub\\>"))))))
3872 (cperl-after-expr-p lim))))
3875 (defun cperl-after-expr-p (&optional lim chars test)
3876 "Return true if the position is good for start of expression.
3877 TEST is the expression to evaluate at the found position. If absent,
3878 CHARS is a string that contains good characters to have before us (however,
3879 `}' is treated \"smartly\" if it is not in the list)."
3880 (let ((lim (or lim (point-min)))
3882 (cperl-update-syntaxification (point) (point))
3884 (while (and (not stop) (> (point) lim))
3885 (skip-chars-backward " \t\n\f" lim)
3888 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
3889 ;; '(pod here-doc here-doc-delim))
3890 (if (get-text-property (point) 'here-doc-group)
3893 (previous-single-property-change (point) 'here-doc-group))
3894 (beginning-of-line 0)))
3895 (if (get-text-property (point) 'in-pod)
3898 (previous-single-property-change (point) 'in-pod))
3899 (beginning-of-line 0)))
3900 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
3901 ;; Else: last iteration, or a label
3902 (cperl-to-comment-or-eol) ; Will not move past "." after a format
3903 (skip-chars-backward " \t")
3904 (if (< p (point)) (goto-char p))
3906 (if (and (eq (preceding-char) ?:)
3909 (skip-chars-backward " \t\n\f" lim)
3910 (eq (char-syntax (preceding-char)) ?w)))
3911 (forward-sexp -1) ; Possibly label. Skip it
3914 (or (bobp) ; ???? Needed
3916 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
3918 (if test (eval test)
3919 (or (memq (preceding-char) (append (or chars "{;") nil))
3920 (and (eq (preceding-char) ?\})
3921 (cperl-after-block-p lim))
3922 (and (eq (following-char) ?.) ; in format: see comment above
3923 (eq (get-text-property (point) 'syntax-type)
3926 (defun cperl-backward-to-start-of-continued-exp (lim)
3927 (if (memq (preceding-char) (append ")]}\"'`" nil))
3930 (if (<= (point) lim)
3931 (goto-char (1+ lim)))
3932 (skip-chars-forward " \t"))
3934 (defun cperl-after-block-and-statement-beg (lim)
3935 ;; We assume that we are after ?\}
3937 (cperl-after-block-p lim)
3940 (cperl-backward-to-noncomment (point-min))
3943 (not (= (char-syntax (preceding-char)) ?w))
3948 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
3951 (defun cperl-indent-exp ()
3952 "Simple variant of indentation of continued-sexp.
3954 Will not indent comment if it starts at `comment-indent' or looks like
3955 continuation of the comment on the previous line.
3957 If `cperl-indent-region-fix-constructs', will improve spacing on
3958 conditional/loop constructs."
3961 (let ((tmp-end (progn (end-of-line) (point))) top done)
3966 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
3968 (setq top (point))) ; Get the outermost parenths in line
3970 (while (< (point) tmp-end)
3971 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
3972 (or (eolp) (forward-sexp 1)))
3973 (if (> (point) tmp-end)
3976 (setq tmp-end (point)))
3979 (setq tmp-end (point-marker)))
3980 (if cperl-indent-region-fix-constructs
3981 (cperl-fix-line-spacing tmp-end))
3982 (cperl-indent-region (point) tmp-end))))
3984 (defun cperl-fix-line-spacing (&optional end parse-data)
3985 "Improve whitespace in a conditional/loop construct.
3986 Returns some position at the last line."
3989 (setq end (point-max)))
3990 (let ((ee (save-excursion (end-of-line) (point)))
3991 (cperl-indent-region-fix-constructs
3992 (or cperl-indent-region-fix-constructs 1))
3993 p pp ml have-brace ret)
4000 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
4001 (setq have-brace (save-excursion (search-forward "}" ee t)))))
4002 nil ; Do not need to do anything
4006 (if (and cperl-merge-trailing-else
4008 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
4010 (search-forward "}")
4012 (skip-chars-forward " \t\n")
4013 (delete-region p (point))
4014 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4015 (beginning-of-line)))
4018 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
4020 (search-forward "}")
4021 (delete-horizontal-space)
4022 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4023 (beginning-of-line)))
4027 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4030 (delete-horizontal-space)
4031 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4032 (beginning-of-line)))
4036 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
4039 (delete-horizontal-space)
4040 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4041 (beginning-of-line)))
4043 ;; foreach my $var (
4045 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4048 (delete-horizontal-space)
4050 (make-string cperl-indent-region-fix-constructs ?\ ))
4051 (beginning-of-line)))
4053 ;; } foreach my $var () {
4055 "[ \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]*{")
4057 (setq ml (match-beginning 8))
4058 (re-search-forward "[({]")
4061 (if (eq (following-char) ?\( )
4065 ;; after `else' or nothing
4066 (if ml ; after `else'
4067 (skip-chars-backward " \t\n")
4068 (beginning-of-line))
4070 ;; Now after the sexp before the brace
4071 ;; Multiline expr should be special
4072 (setq ml (and pp (save-excursion (goto-char p)
4073 (search-forward "\n" pp t))))
4074 (if (and (or (not pp) (< pp end))
4075 (looking-at "[ \t\n]*{"))
4078 ((bolp) ; Were before `{', no if/else/etc
4080 ((looking-at "\\(\t*\\| [ \t]+\\){")
4081 (delete-horizontal-space)
4083 cperl-extra-newline-before-brace-multiline
4084 cperl-extra-newline-before-brace)
4086 (delete-horizontal-space)
4089 (if (cperl-indent-line parse-data)
4091 (cperl-fix-line-spacing end parse-data)
4092 (setq ret (point)))))
4094 (make-string cperl-indent-region-fix-constructs ?\ ))))
4095 ((and (looking-at "[ \t]*\n")
4097 cperl-extra-newline-before-brace-multiline
4098 cperl-extra-newline-before-brace)))
4100 (skip-chars-forward " \t\n")
4101 (delete-region pp (point))
4103 (make-string cperl-indent-region-fix-constructs ?\ ))))
4104 ;; Now we are before `{'
4105 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
4107 (skip-chars-forward " \t\n")
4112 (setq ml (search-forward "\n" p t))
4113 (if (or cperl-break-one-line-blocks-when-indent ml)
4114 ;; not good: multi-line BLOCK
4117 (delete-horizontal-space)
4120 (if (cperl-indent-line parse-data)
4121 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
4123 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
4124 ;; Now check whether there is a hanging `}'
4128 cperl-fix-hanging-brace-when-indent
4130 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
4134 (if (and (<= (point) pp)
4135 (eq (preceding-char) ?\} )
4136 (cperl-after-block-and-statement-beg (point-min)))
4143 (skip-chars-backward " \t")
4145 ;; `}' was the first thing on the line, insert NL *after* it.
4147 (cperl-indent-line parse-data)
4148 (search-forward "}")
4149 (delete-horizontal-space)
4151 (delete-horizontal-space)
4152 (or (eq (preceding-char) ?\;)
4154 (and (eq (preceding-char) ?\} )
4155 (cperl-after-block-p (point-min)))
4159 (if (cperl-indent-line parse-data)
4160 (setq ret (cperl-fix-line-spacing end parse-data)))
4161 (beginning-of-line)))))
4164 (defvar cperl-update-start) ; Do not need to make them local
4165 (defvar cperl-update-end)
4166 (defun cperl-delay-update-hook (beg end old-len)
4167 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
4168 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
4170 (defun cperl-indent-region (start end)
4171 "Simple variant of indentation of region in CPerl mode.
4172 Should be slow. Will not indent comment if it starts at `comment-indent'
4173 or looks like continuation of the comment on the previous line.
4174 Indents all the lines whose first character is between START and END
4177 If `cperl-indent-region-fix-constructs', will improve spacing on
4178 conditional/loop constructs."
4180 (cperl-update-syntaxification end end)
4182 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
4183 (let ((indent-info (if cperl-emacs-can-parse
4184 (list nil nil nil) ; Cannot use '(), since will modify
4186 (pm 0) (imenu-scanning-message "Indenting... (%3d%%)")
4187 after-change-functions ; Speed it up!
4188 st comm old-comm-indent new-comm-indent p pp i empty)
4189 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
4191 (setq old-comm-indent (and (cperl-to-comment-or-eol)
4193 new-comm-indent old-comm-indent)
4195 (setq end (set-marker (make-marker) end)) ; indentation changes pos
4196 (or (bolp) (beginning-of-line 2))
4197 (or (fboundp 'imenu-progress-message)
4198 (message "Indenting... For feedback load `imenu'..."))
4199 (while (and (<= (point) end) (not (eobp))) ; bol to check start
4200 (and (fboundp 'imenu-progress-message)
4201 (imenu-progress-message
4202 pm (/ (* 100 (- (point) start)) (- end start -1))))
4205 (setq empty (looking-at "[ \t]*\n"))
4206 (and (setq comm (looking-at "[ \t]*#"))
4207 (or (eq (current-indentation) (or old-comm-indent
4209 (setq old-comm-indent nil))))
4210 (if (and old-comm-indent
4212 (= (current-indentation) old-comm-indent)
4213 (not (eq (get-text-property (point) 'syntax-type) 'pod))
4214 (not (eq (get-text-property (point) 'syntax-table)
4216 (let ((comment-column new-comm-indent))
4217 (indent-for-comment)))
4219 (setq i (cperl-indent-line indent-info))
4223 (if cperl-indent-region-fix-constructs
4224 (goto-char (cperl-fix-line-spacing end indent-info)))
4225 (if (setq old-comm-indent
4226 (and (cperl-to-comment-or-eol)
4227 (not (memq (get-text-property (point)
4230 (not (eq (get-text-property (point)
4234 (progn (indent-for-comment)
4235 (skip-chars-backward " \t")
4236 (skip-chars-backward "#")
4237 (setq new-comm-indent (current-column))))))))
4238 (beginning-of-line 2))
4239 (if (fboundp 'imenu-progress-message)
4240 (imenu-progress-message pm 100)
4242 ;; Now run the update hooks
4243 (and after-change-functions
4246 (goto-char cperl-update-end)
4249 (goto-char cperl-update-start)
4251 (delete-char -1))))))
4253 ;; Stolen from lisp-mode with a lot of improvements
4255 (defun cperl-fill-paragraph (&optional justify iteration)
4256 "Like `fill-paragraph', but handle CPerl comments.
4257 If any of the current line is a comment, fill the comment or the
4258 block of it that point is in, preserving the comment's initial
4259 indentation and initial hashes. Behaves usually outside of comment."
4260 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
4261 (let (;; Non-nil if the current line contains a comment.
4264 ;; If has-comment, the appropriate fill-prefix for the comment.
4266 ;; Line that contains code and comment (or nil)
4268 c spaces len dc (comment-column comment-column))
4269 ;; Figure out what kind of comment we are looking at.
4274 ;; A line with nothing but a comment on it?
4275 ((looking-at "[ \t]*#[# \t]*")
4277 comment-fill-prefix (buffer-substring (match-beginning 0)
4280 ;; A line with some code, followed by a comment? Remember that the
4281 ;; semi which starts the comment shouldn't be part of a string or
4283 ((cperl-to-comment-or-eol)
4284 (setq has-comment t)
4285 (looking-at "#+[ \t]*")
4286 (setq start (point) c (current-column)
4288 (concat (make-string (current-column) ?\ )
4289 (buffer-substring (match-beginning 0) (match-end 0)))
4290 spaces (progn (skip-chars-backward " \t")
4291 (buffer-substring (point) start))
4292 dc (- c (current-column)) len (- start (point))
4293 start (point-marker))
4295 (insert (make-string dc ?-)))))
4296 (if (not has-comment)
4297 (fill-paragraph justify) ; Do the usual thing outside of comment
4298 ;; Narrow to include only the comment, and then fill the region.
4301 ;; Find the first line we should include in the region to fill.
4302 (if start (progn (beginning-of-line) (point))
4304 (while (and (zerop (forward-line -1))
4305 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4306 ;; We may have gone to far. Go forward again.
4307 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
4310 ;; Find the beginning of the first line past the region to fill.
4312 (while (progn (forward-line 1)
4313 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4315 ;; Remove existing hashes
4317 (goto-char (point-min))
4318 (while (progn (forward-line 1) (< (point) (point-max)))
4319 (skip-chars-forward " \t")
4320 (and (looking-at "#+")
4321 (delete-char (- (match-end 0) (match-beginning 0))))))
4323 ;; Lines with only hashes on them can be paragraph boundaries.
4324 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
4325 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
4326 (fill-prefix comment-fill-prefix))
4327 (fill-paragraph justify)))
4332 (progn (delete-char dc) (insert spaces)))
4333 (if (or (= (current-column) c) iteration) nil
4334 (setq comment-column c)
4335 (indent-for-comment)
4336 ;; Repeat once more, flagging as iteration
4337 (cperl-fill-paragraph justify t)))))))
4339 (defun cperl-do-auto-fill ()
4340 ;; Break out if the line is short enough
4341 (if (> (save-excursion
4345 (let ((c (save-excursion (beginning-of-line)
4346 (cperl-to-comment-or-eol) (point)))
4347 (s (memq (following-char) '(?\ ?\t))) marker)
4349 ;; Don't break line inside code: only inside comment.
4351 (setq marker (point-marker))
4352 (fill-paragraph nil)
4354 ;; Is not enough, sometimes marker is a start of line
4355 (if (bolp) (progn (re-search-forward "#+[ \t]*")
4356 (goto-char (match-end 0))))
4357 ;; Following space could have gone:
4358 (if (or (not s) (memq (following-char) '(?\ ?\t))) nil
4361 ;; Previous space could have gone:
4362 (or (memq (preceding-char) '(?\ ?\t)) (insert " "))))))
4364 (defun cperl-imenu-addback (lst &optional isback name)
4365 ;; We suppose that the lst is a DAG, unless the first element only
4366 ;; loops back, and ISBACK is set. Thus this function cannot be
4367 ;; applied twice without ISBACK set.
4368 (cond ((not cperl-imenu-addback) lst)
4371 (setq name "+++BACK+++"))
4372 (mapcar (lambda (elt)
4373 (if (and (listp elt) (listp (cdr elt)))
4375 ;; In the other order it goes up
4376 ;; one level only ;-(
4377 (setcdr elt (cons (cons name lst)
4379 (cperl-imenu-addback (cdr elt) t name))))
4380 (if isback (cdr lst) lst))
4383 (defun cperl-imenu--create-perl-index (&optional regexp)
4384 (require 'imenu) ; May be called from TAGS creator
4385 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
4386 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
4387 (index-meth-alist '()) meth
4388 packages ends-ranges p marker
4389 (prev-pos 0) char fchar index index1 name (end-range 0) package)
4390 (goto-char (point-min))
4392 (message "Scanning Perl for index")
4393 (imenu-progress-message prev-pos 0))
4394 (cperl-update-syntaxification (point-max) (point-max))
4395 ;; Search for the function
4396 (progn ;;save-match-data
4397 (while (re-search-forward
4398 (or regexp cperl-imenu--function-name-regexp-perl)
4401 (imenu-progress-message prev-pos))
4403 ((and ; Skip some noise if building tags
4404 (match-beginning 2) ; package or sub
4405 (eq (char-after (match-beginning 2)) ?p) ; package
4406 (not (save-match-data
4407 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
4410 (match-beginning 2) ; package or sub
4411 ;; Skip if quoted (will not skip multi-line ''-strings :-():
4412 (null (get-text-property (match-beginning 1) 'syntax-table))
4413 (null (get-text-property (match-beginning 1) 'syntax-type))
4414 (null (get-text-property (match-beginning 1) 'in-pod)))
4416 (goto-char (match-beginning 2))
4417 (setq fchar (following-char)))
4418 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4419 ;; (goto-char (match-end 0))) ; Messes what follows
4420 (setq char (following-char) ; ?\; for "sub foo () ;"
4423 (while (and ends-ranges (>= p (car ends-ranges)))
4424 ;; delete obsolete entries
4425 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
4426 (setq package (or (car packages) "")
4427 end-range (or (car ends-ranges) 0))
4429 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4431 (set-text-properties 0 (length name) nil name)
4433 package (concat name "::")
4434 name (concat "package " name)
4437 (parse-partial-sexp (point) (point-max) -1) (point))
4438 ends-ranges (cons end-range ends-ranges)
4439 packages (cons package packages)))
4441 ;; Skip this function name if it is a prototype declaration.
4442 (if (and (eq fchar ?s) (eq char ?\;)) nil
4443 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4444 marker (make-marker))
4445 (set-text-properties 0 (length name) nil name)
4446 (set-marker marker (match-end 3))
4448 (setq name (concat "package " name))
4449 (cond ((string-match "[:']" name)
4451 ((> p end-range) nil)
4453 (setq name (concat package name) meth t))))
4454 (setq index (cons name marker))
4456 (push index index-pack-alist)
4457 (push index index-alist))
4458 (if meth (push index index-meth-alist))
4459 (push index index-unsorted-alist)))
4460 ((match-beginning 5) ; POD section
4461 ;; (beginning-of-line)
4462 (setq index (imenu-example--name-and-position)
4463 name (buffer-substring (match-beginning 6) (match-end 6)))
4464 (set-text-properties 0 (length name) nil name)
4465 (if (eq (char-after (match-beginning 5)) ?2)
4466 (setq name (concat " " name)))
4468 (setq index1 (cons (concat "=" name) (cdr index)))
4469 (push index index-pod-alist)
4470 (push index1 index-unsorted-alist)))))
4472 (imenu-progress-message prev-pos 100))
4474 (if (default-value 'imenu-sort-function)
4475 (sort index-alist (default-value 'imenu-sort-function))
4476 (nreverse index-alist)))
4477 (and index-pod-alist
4478 (push (cons "+POD headers+..."
4479 (nreverse index-pod-alist))
4481 (and (or index-pack-alist index-meth-alist)
4482 (let ((lst index-pack-alist) hier-list pack elt group name)
4483 ;; Remove "package ", reverse and uniquify.
4485 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
4486 (if (assoc name hier-list) nil
4487 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
4488 (setq lst index-meth-alist)
4490 (setq elt (car lst) lst (cdr lst))
4491 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
4492 (setq pack (substring (car elt) 0 (match-beginning 0)))
4493 (if (setq group (assoc pack hier-list))
4494 (if (listp (cdr group))
4495 ;; Have some functions already
4497 (cons (cons (substring
4499 (+ 2 (match-beginning 0)))
4502 (setcdr group (list (cons (substring
4504 (+ 2 (match-beginning 0)))
4508 (list (cons (substring
4510 (+ 2 (match-beginning 0)))
4513 (push (cons "+Hierarchy+..."
4516 (and index-pack-alist
4517 (push (cons "+Packages+..."
4518 (nreverse index-pack-alist))
4520 (and (or index-pack-alist index-pod-alist
4521 (default-value 'imenu-sort-function))
4522 index-unsorted-alist
4523 (push (cons "+Unsorted List+..."
4524 (nreverse index-unsorted-alist))
4526 (cperl-imenu-addback index-alist)))
4529 ;; Suggested by Mark A. Hershberger
4530 (defun cperl-outline-level ()
4531 (looking-at outline-regexp)
4532 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4533 ((match-beginning 2)
4534 (if (eq (char-after (match-beginning 2)) ?p)
4537 ((match-beginning 5)
4538 (if (eq (char-after (match-beginning 5)) ?1)
4541 (t 3))) ; should not happen
4544 (defvar cperl-compilation-error-regexp-alist
4545 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4546 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
4548 "Alist that specifies how to match errors in perl output.")
4550 (if (fboundp 'eval-after-load)
4553 '(setq perl-compilation-error-regexp-alist
4554 cperl-compilation-error-regexp-alist)))
4557 (defun cperl-windowed-init ()
4558 "Initialization under windowed version."
4559 (if (or (featurep 'ps-print) cperl-faces-init)
4560 ;; Need to init anyway:
4561 (or cperl-faces-init (cperl-init-faces))
4562 (add-hook 'font-lock-mode-hook
4565 (if (memq major-mode '(perl-mode cperl-mode))
4567 (or cperl-faces-init (cperl-init-faces)))))))
4568 (if (fboundp 'eval-after-load)
4571 '(or cperl-faces-init (cperl-init-faces))))))
4573 (defvar cperl-font-lock-keywords-1 nil
4574 "Additional expressions to highlight in Perl mode. Minimal set.")
4575 (defvar cperl-font-lock-keywords nil
4576 "Additional expressions to highlight in Perl mode. Default set.")
4577 (defvar cperl-font-lock-keywords-2 nil
4578 "Additional expressions to highlight in Perl mode. Maximal set")
4580 (defun cperl-load-font-lock-keywords ()
4581 (or cperl-faces-init (cperl-init-faces))
4582 cperl-font-lock-keywords)
4584 (defun cperl-load-font-lock-keywords-1 ()
4585 (or cperl-faces-init (cperl-init-faces))
4586 cperl-font-lock-keywords-1)
4588 (defun cperl-load-font-lock-keywords-2 ()
4589 (or cperl-faces-init (cperl-init-faces))
4590 cperl-font-lock-keywords-2)
4592 (defun cperl-init-faces-weak ()
4593 ;; Allow `cperl-find-pods-heres' to run.
4594 (or (boundp 'font-lock-constant-face)
4595 (cperl-force-face font-lock-constant-face
4596 "Face for constant and label names")
4597 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4600 (defun cperl-init-faces ()
4601 (condition-case errs
4603 (require 'font-lock)
4604 (and (fboundp 'font-lock-fontify-anchored-keywords)
4605 (featurep 'font-lock-extra)
4606 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
4607 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
4608 (if (fboundp 'font-lock-fontify-anchored-keywords)
4609 (setq font-lock-anchored t))
4611 t-font-lock-keywords
4613 `("[ \t]+$" 0 ',cperl-invalid-face t)
4616 "\\(^\\|[^$@%&\\]\\)\\<\\("
4619 '("if" "until" "while" "elsif" "else" "unless" "for"
4620 "foreach" "continue" "exit" "die" "last" "goto" "next"
4621 "redo" "return" "local" "exec" "sub" "do" "dump" "use"
4622 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
4623 "\\|") ; Flow control
4624 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
4625 ; In what follows we use `type' style
4626 ; for overwritable builtins
4629 "\\(^\\|[^$@%&\\]\\)\\<\\("
4630 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4631 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4632 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4633 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4634 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4635 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4636 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4637 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4638 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4639 ;; "gethostbyname" "gethostent" "getlogin"
4640 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4641 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4642 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4643 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4644 ;; "getservbyport" "getservent" "getsockname"
4645 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4646 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
4647 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
4648 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4649 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4650 ;; "quotemeta" "rand" "read" "readdir" "readline"
4651 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4652 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4653 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4654 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4655 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4656 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4657 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4658 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
4659 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
4660 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4661 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4662 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
4663 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
4664 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
4665 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
4666 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
4667 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
4668 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
4669 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
4670 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
4671 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
4672 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
4673 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
4674 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
4675 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
4676 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
4677 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
4678 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
4679 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
4680 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
4681 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
4682 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
4683 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
4684 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
4685 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
4686 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
4687 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
4688 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
4689 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
4690 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
4691 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
4692 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
4693 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
4694 "\\)\\>") 2 'font-lock-type-face)
4695 ;; In what follows we use `other' style
4696 ;; for nonoverwritable builtins
4697 ;; Somehow 's', 'm' are not auto-generated???
4700 "\\(^\\|[^$@%&\\]\\)\\<\\("
4701 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
4702 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4703 ;; "eval" "exists" "for" "foreach" "format" "goto"
4704 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4705 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4706 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4707 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4708 ;; "undef" "unless" "unshift" "untie" "until" "use"
4710 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
4711 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
4712 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
4713 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
4714 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
4715 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
4716 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
4717 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
4718 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
4719 "\\|[sm]" ; Added manually
4720 "\\)\\>") 2 'cperl-nonoverridable-face)
4721 ;; (mapconcat 'identity
4722 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4723 ;; "#include" "#define" "#undef")
4725 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
4726 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
4727 '("\\<sub[ \t]+\\([^ \t{;()]+\\)[ \t]*\\(([^()]*)[ \t]*\\)?[#{\n]" 1
4728 font-lock-function-name-face)
4729 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4730 2 font-lock-function-name-face)
4731 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
4732 1 font-lock-function-name-face)
4733 (cond ((featurep 'font-lock-extra)
4734 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4735 (2 font-lock-string-face t)
4736 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
4738 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4739 (2 font-lock-string-face t)
4740 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4742 (1 font-lock-string-face t))))
4743 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4744 2 font-lock-string-face t)))
4745 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
4746 font-lock-string-face t)
4747 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
4748 font-lock-constant-face) ; labels
4749 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
4750 2 font-lock-constant-face)
4751 ;; Uncomment to get perl-mode-like vars
4752 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
4753 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
4754 ;;; (2 (cons font-lock-variable-name-face '(underline))))
4755 (cond ((featurep 'font-lock-extra)
4756 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4757 (3 font-lock-variable-name-face)
4759 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4760 (1 font-lock-variable-name-face)
4761 (2 '(restart 2 nil) nil t)))
4762 nil t))) ; local variables, multiple
4764 '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4765 (3 font-lock-variable-name-face)
4766 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)"
4768 (1 font-lock-variable-name-face))))
4769 (t '("^[ \t{}]*\\(my\\|local\\our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4770 3 font-lock-variable-name-face)))
4771 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
4772 4 font-lock-variable-name-face)))
4774 t-font-lock-keywords-1
4775 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4776 (not cperl-xemacs-p) ; not yet as of XEmacs 19.12
4778 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
4779 (if (eq (char-after (match-beginning 2)) ?%)
4782 t) ; arrays and hashes
4783 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
4785 (if (= (- (match-end 2) (match-beginning 2)) 1)
4786 (if (eq (char-after (match-beginning 3)) ?{)
4788 cperl-array-face) ; arrays and hashes
4789 font-lock-variable-name-face) ; Just to put something
4791 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4792 ;;; Too much noise from \s* @s[ and friends
4793 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
4794 ;;(3 font-lock-function-name-face t t)
4796 ;; (if (cperl-slash-is-regexp)
4797 ;; font-lock-function-name-face 'default) nil t))
4799 (if cperl-highlight-variables-indiscriminately
4800 (setq t-font-lock-keywords-1
4801 (append t-font-lock-keywords-1
4802 (list '("[$*]{?\\(\\sw+\\)" 1
4803 font-lock-variable-name-face)))))
4804 (setq cperl-font-lock-keywords-1
4805 (if cperl-syntaxify-by-font-lock
4806 (cons 'cperl-fontify-update
4807 t-font-lock-keywords)
4808 t-font-lock-keywords)
4809 cperl-font-lock-keywords cperl-font-lock-keywords-1
4810 cperl-font-lock-keywords-2 (append
4811 cperl-font-lock-keywords-1
4812 t-font-lock-keywords-1)))
4813 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
4814 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
4815 (eval ; Avoid a warning
4816 '(font-lock-require-faces
4818 ;; Color-light Color-dark Gray-light Gray-dark Mono
4819 (list 'font-lock-comment-face
4820 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
4825 (list 'font-lock-string-face
4826 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
4831 (list 'font-lock-function-name-face
4833 "Blue" "LightSkyBlue" "Gray50" "LightGray"
4834 (cdr (assq 'background-color ; if mono
4835 (frame-parameters))))
4838 (cdr (assq 'foreground-color ; if mono
4839 (frame-parameters))))
4843 (list 'font-lock-variable-name-face
4844 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
4849 (list 'font-lock-type-face
4850 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
4855 (list 'font-lock-constant-face
4856 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
4861 (list 'cperl-nonoverridable-face
4862 ["chartreuse3" ("orchid1" "orange")
4868 (list 'cperl-array-face
4869 ["blue" "yellow" nil "Gray80"]
4870 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4875 (list 'cperl-hash-face
4876 ["red" "red" nil "Gray80"]
4877 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4882 ;; Do it the dull way, without choose-color
4883 (defvar cperl-guessed-background nil
4884 "Display characteristics as guessed by cperl.")
4885 ;; (or (fboundp 'x-color-defined-p)
4886 ;; (defalias 'x-color-defined-p
4887 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4888 ;; ;; XEmacs >= 19.12
4889 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4891 ;; (t 'x-valid-color-name-p))))
4892 (cperl-force-face font-lock-constant-face
4893 "Face for constant and label names")
4894 (cperl-force-face font-lock-variable-name-face
4895 "Face for variable names")
4896 (cperl-force-face font-lock-type-face
4897 "Face for data types")
4898 (cperl-force-face cperl-nonoverridable-face
4899 "Face for data types from another group")
4900 (cperl-force-face font-lock-comment-face
4901 "Face for comments")
4902 (cperl-force-face font-lock-function-name-face
4903 "Face for function names")
4904 (cperl-force-face cperl-hash-face
4906 (cperl-force-face cperl-array-face
4908 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4909 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4910 ;;(or (boundp 'font-lock-type-face)
4911 ;; (defconst font-lock-type-face
4912 ;; 'font-lock-type-face
4913 ;; "Face to use for data types."))
4914 ;;(or (boundp 'cperl-nonoverridable-face)
4915 ;; (defconst cperl-nonoverridable-face
4916 ;; 'cperl-nonoverridable-face
4917 ;; "Face to use for data types from another group."))
4918 ;;(if (not cperl-xemacs-p) nil
4919 ;; (or (boundp 'font-lock-comment-face)
4920 ;; (defconst font-lock-comment-face
4921 ;; 'font-lock-comment-face
4922 ;; "Face to use for comments."))
4923 ;; (or (boundp 'font-lock-keyword-face)
4924 ;; (defconst font-lock-keyword-face
4925 ;; 'font-lock-keyword-face
4926 ;; "Face to use for keywords."))
4927 ;; (or (boundp 'font-lock-function-name-face)
4928 ;; (defconst font-lock-function-name-face
4929 ;; 'font-lock-function-name-face
4930 ;; "Face to use for function names.")))
4932 (not (cperl-is-face 'cperl-array-face))
4933 (cperl-is-face 'font-lock-emphasized-face))
4934 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
4936 (not (cperl-is-face 'cperl-hash-face))
4937 (cperl-is-face 'font-lock-other-emphasized-face))
4938 (copy-face 'font-lock-other-emphasized-face
4941 (not (cperl-is-face 'cperl-nonoverridable-face))
4942 (cperl-is-face 'font-lock-other-type-face))
4943 (copy-face 'font-lock-other-type-face
4944 'cperl-nonoverridable-face))
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
4951 ;; '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-face)
4992 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
4994 ((eq background 'light)
4995 (set-face-foreground 'cperl-nonoverridable-face
4996 (if (x-color-defined-p "chartreuse3")
4999 ((eq background 'dark)
5000 (set-face-foreground 'cperl-nonoverridable-face
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-face
5056 ;; font-lock-constant-face
5057 (append '(cperl-nonoverridable-face
5061 ;; font-lock-type-face
5062 (append '(cperl-array-face
5065 cperl-nonoverridable-face)
5066 ps-underlined-faces))))
5068 (defvar ps-print-face-extension-alist)
5070 (defun cperl-ps-print (&optional file)
5071 "Pretty-print in CPerl style.
5072 If optional argument FILE is an empty string, prints to printer, otherwise
5073 to the file FILE. If FILE is nil, prompts for a file name.
5075 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
5078 (setq file (read-from-minibuffer
5079 "Print to file (if empty - to printer): "
5080 (concat (buffer-file-name) ".ps")
5081 nil nil 'file-name-history)))
5082 (or (> (length file) 0)
5084 (require 'ps-print) ; To get ps-print-face-extension-alist
5085 (let ((ps-print-color-p t)
5086 (ps-print-face-extension-alist ps-print-face-extension-alist))
5087 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
5088 (ps-print-buffer-with-faces file)))
5090 ;;; (defun cperl-ps-print-init ()
5091 ;;; "Initialization of `ps-print' components for faces used in CPerl."
5092 ;;; ;; Guard against old versions
5093 ;;; (defvar ps-underlined-faces nil)
5094 ;;; (defvar ps-bold-faces nil)
5095 ;;; (defvar ps-italic-faces nil)
5096 ;;; (setq ps-bold-faces
5097 ;;; (append '(font-lock-emphasized-face
5098 ;;; cperl-array-face
5099 ;;; font-lock-keyword-face
5100 ;;; font-lock-variable-name-face
5101 ;;; font-lock-constant-face
5102 ;;; font-lock-reference-face
5103 ;;; font-lock-other-emphasized-face
5104 ;;; cperl-hash-face)
5106 ;;; (setq ps-italic-faces
5107 ;;; (append '(cperl-nonoverridable-face
5108 ;;; font-lock-constant-face
5109 ;;; font-lock-reference-face
5110 ;;; font-lock-other-emphasized-face
5111 ;;; cperl-hash-face)
5112 ;;; ps-italic-faces))
5113 ;;; (setq ps-underlined-faces
5114 ;;; (append '(font-lock-emphasized-face
5115 ;;; cperl-array-face
5116 ;;; font-lock-other-emphasized-face
5118 ;;; cperl-nonoverridable-face font-lock-type-face)
5119 ;;; ps-underlined-faces))
5120 ;;; (cons 'font-lock-type-face ps-underlined-faces))
5123 (if (cperl-enable-font-lock) (cperl-windowed-init))
5125 (defconst cperl-styles-entries
5126 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
5127 cperl-label-offset cperl-extra-newline-before-brace
5128 cperl-merge-trailing-else
5129 cperl-continued-statement-offset))
5131 (defconst cperl-style-alist
5132 '(("CPerl" ; =GNU without extra-newline-before-brace
5133 (cperl-indent-level . 2)
5134 (cperl-brace-offset . 0)
5135 (cperl-continued-brace-offset . 0)
5136 (cperl-label-offset . -2)
5137 (cperl-extra-newline-before-brace . nil)
5138 (cperl-merge-trailing-else . t)
5139 (cperl-continued-statement-offset . 2))
5140 ("PerlStyle" ; CPerl with 4 as indent
5141 (cperl-indent-level . 4)
5142 (cperl-brace-offset . 0)
5143 (cperl-continued-brace-offset . 0)
5144 (cperl-label-offset . -4)
5145 (cperl-extra-newline-before-brace . nil)
5146 (cperl-merge-trailing-else . t)
5147 (cperl-continued-statement-offset . 4))
5149 (cperl-indent-level . 2)
5150 (cperl-brace-offset . 0)
5151 (cperl-continued-brace-offset . 0)
5152 (cperl-label-offset . -2)
5153 (cperl-extra-newline-before-brace . t)
5154 (cperl-merge-trailing-else . nil)
5155 (cperl-continued-statement-offset . 2))
5157 (cperl-indent-level . 5)
5158 (cperl-brace-offset . 0)
5159 (cperl-continued-brace-offset . -5)
5160 (cperl-label-offset . -5)
5161 ;;(cperl-extra-newline-before-brace . nil) ; ???
5162 (cperl-merge-trailing-else . nil)
5163 (cperl-continued-statement-offset . 5))
5165 (cperl-indent-level . 4)
5166 (cperl-brace-offset . 0)
5167 (cperl-continued-brace-offset . -4)
5168 (cperl-label-offset . -4)
5169 ;;(cperl-extra-newline-before-brace . nil) ; ???
5170 (cperl-continued-statement-offset . 4))
5172 (cperl-indent-level . 4)
5173 (cperl-brace-offset . 0)
5174 (cperl-continued-brace-offset . -4)
5175 (cperl-label-offset . -4)
5176 (cperl-continued-statement-offset . 4)
5177 (cperl-merge-trailing-else . nil)
5178 (cperl-extra-newline-before-brace . t))
5181 (cperl-indent-level . 4)
5182 (cperl-brace-offset . 0)
5183 (cperl-continued-brace-offset . 0)
5184 (cperl-label-offset . -4)
5185 ;;(cperl-extra-newline-before-brace . nil) ; ???
5186 (cperl-continued-statement-offset . 4)))
5187 "(Experimental) list of variables to set to get a particular indentation style.
5188 Should be used via `cperl-set-style' or via Perl menu.")
5190 (defun cperl-set-style (style)
5191 "Set CPerl mode variables to use one of several different indentation styles.
5192 The arguments are a string representing the desired style.
5193 The list of styles is in `cperl-style-alist', available styles
5194 are GNU, K&R, BSD, C++ and Whitesmith.
5196 The current value of style is memorized (unless there is a memorized
5197 data already), may be restored by `cperl-set-style-back'.
5199 Chosing \"Current\" style will not change style, so this may be used for
5200 side-effect of memorizing only."
5202 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
5203 cperl-style-alist)))
5204 (list (completing-read "Enter style: " list nil 'insist))))
5206 (setq cperl-old-style
5209 (cons name (eval name))))
5210 cperl-styles-entries)))
5211 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
5213 (setq setting (car style) style (cdr style))
5214 (set (car setting) (cdr setting)))))
5216 (defun cperl-set-style-back ()
5217 "Restore a style memorised by `cperl-set-style'."
5219 (or cperl-old-style (error "The style was not changed"))
5221 (while cperl-old-style
5222 (setq setting (car cperl-old-style)
5223 cperl-old-style (cdr cperl-old-style))
5224 (set (car setting) (cdr setting)))))
5226 (defun cperl-check-syntax ()
5228 (require 'mode-compile)
5229 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
5230 (eval '(mode-compile)))) ; Avoid a warning
5232 (defun cperl-info-buffer (type)
5233 ;; Returns buffer with documentation. Creates if missing.
5234 ;; If TYPE, this vars buffer.
5235 ;; Special care is taken to not stomp over an existing info buffer
5236 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
5237 (info (get-buffer bname))
5238 (oldbuf (get-buffer "*info*")))
5240 (save-window-excursion
5245 (rename-buffer "*info-perl-tmp*")))
5246 (save-window-excursion
5248 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
5249 (set-buffer "*info*")
5250 (rename-buffer bname)
5252 (set-buffer "*info-perl-tmp*")
5253 (rename-buffer "*info*")
5254 (set-buffer bname)))
5255 (make-local-variable 'window-min-height)
5256 (setq window-min-height 2)
5257 (current-buffer)))))
5259 (defun cperl-word-at-point (&optional p)
5260 "Return the word at point or at P."
5262 (if p (goto-char p))
5263 (or (cperl-word-at-point-hard)
5266 (funcall (or (and (boundp 'find-tag-default-function)
5267 find-tag-default-function)
5268 (get major-mode 'find-tag-default-function)
5269 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
5270 ;; automatically used within `find-tag-default':
5271 'find-tag-default))))))
5273 (defun cperl-info-on-command (command)
5274 "Show documentation for Perl command COMMAND in other window.
5275 If perl-info buffer is shown in some frame, uses this frame.
5276 Customized by setting variables `cperl-shrink-wrap-info-frame',
5277 `cperl-max-help-size'."
5279 (let* ((default (cperl-word-at-point))
5281 (format "Find doc for Perl function (default %s): "
5283 (list (if (equal read "")
5287 (let ((buffer (current-buffer))
5288 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
5289 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
5290 max-height char-height buf-list)
5291 (if (string-match "^-[a-zA-Z]$" command)
5292 (setq cmd-desc "^-X[ \t\n]"))
5293 (setq isvar (string-match "^[$@%]" command)
5294 buf (cperl-info-buffer isvar)
5295 iniwin (selected-window)
5296 fr1 (window-frame iniwin))
5298 (beginning-of-buffer)
5300 (progn (re-search-forward "^-X[ \t\n]")
5302 (if (re-search-forward cmd-desc nil t)
5304 ;; Go back to beginning of the group (ex, for qq)
5305 (if (re-search-backward "^[ \t\n\f]")
5310 buf-list (list buf "*info-perl-var*" "*info-perl*"))
5311 (while (and (not win) buf-list)
5312 (setq win (get-buffer-window (car buf-list) t))
5313 (setq buf-list (cdr buf-list)))
5315 (eq (window-buffer win) buf)
5316 (set-window-buffer win buf))
5317 (and win (setq fr2 (window-frame win)))
5318 (if (or (not fr2) (eq fr1 fr2))
5320 (special-display-popup-frame buf) ; Make it visible
5321 (select-window win))
5322 (goto-char pos) ; Needed (?!).
5324 (setq iniheight (window-height)
5325 frheight (frame-height)
5326 not-loner (< iniheight (1- frheight))) ; Are not alone
5327 (cond ((if not-loner cperl-max-help-size
5328 cperl-shrink-wrap-info-frame)
5334 (if (re-search-forward
5335 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
5336 (match-beginning 0) (point-max)))))
5339 (/ (* (- frheight 3) cperl-max-help-size) 100)
5340 (setq char-height (frame-char-height))
5341 ;; Non-functioning under OS/2:
5342 (if (eq char-height 1) (setq char-height 18))
5343 ;; Title, menubar, + 2 for slack
5344 (- (/ (x-display-pixel-height) char-height) 4)))
5345 (if (> height max-height) (setq height max-height))
5346 ;;(message "was %s doing %s" iniheight height)
5348 (enlarge-window (- height iniheight))
5349 (set-frame-height (window-frame win) (1+ height)))))
5350 (set-window-start (selected-window) pos))
5351 (message "No entry for %s found." command))
5352 ;;(pop-to-buffer buffer)
5353 (select-window iniwin)))
5355 (defun cperl-info-on-current-command ()
5356 "Show documentation for Perl command at point in other window."
5358 (cperl-info-on-command (cperl-word-at-point)))
5360 (defun cperl-imenu-info-imenu-search ()
5361 (if (looking-at "^-X[ \t\n]") nil
5363 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
5366 (defun cperl-imenu-info-imenu-name ()
5368 (match-beginning 1) (match-end 1)))
5370 (defun cperl-imenu-on-info ()
5372 (let* ((buffer (current-buffer))
5373 imenu-create-index-function
5374 imenu-prev-index-position-function
5375 imenu-extract-index-name-function
5376 (index-item (save-restriction
5377 (save-window-excursion
5378 (set-buffer (cperl-info-buffer nil))
5379 (setq imenu-create-index-function
5380 'imenu-default-create-index-function
5381 imenu-prev-index-position-function
5382 'cperl-imenu-info-imenu-search
5383 imenu-extract-index-name-function
5384 'cperl-imenu-info-imenu-name)
5385 (imenu-choose-buffer-index)))))
5389 (pop-to-buffer "*info-perl*")
5391 ((markerp (cdr index-item))
5392 (goto-char (marker-position (cdr index-item))))
5394 (goto-char (cdr index-item))))
5395 (set-window-start (selected-window) (point))
5396 (pop-to-buffer buffer)))))
5398 (defun cperl-lineup (beg end &optional step minshift)
5399 "Lineup construction in a region.
5400 Beginning of region should be at the start of a construction.
5401 All first occurrences of this construction in the lines that are
5402 partially contained in the region are lined up at the same column.
5404 MINSHIFT is the minimal amount of space to insert before the construction.
5405 STEP is the tabwidth to position constructions.
5406 If STEP is nil, `cperl-lineup-step' will be used
5407 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
5408 Will not move the position at the start to the left."
5410 (let (search col tcol seen b e)
5414 (setq end (point-marker))
5416 (skip-chars-forward " \t\f")
5417 (setq beg (point-marker))
5418 (indent-region beg end nil)
5420 (setq col (current-column))
5421 (if (looking-at "[a-zA-Z0-9_]")
5422 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
5426 (buffer-substring (match-beginning 0)
5427 (match-end 0))) "\\>"))
5428 (error "Cannot line up in a middle of the word"))
5429 (if (looking-at "$")
5430 (error "Cannot line up end of line"))
5431 (setq search (regexp-quote (char-to-string (following-char)))))
5432 (setq step (or step cperl-lineup-step cperl-indent-level))
5433 (or minshift (setq minshift 1))
5435 (beginning-of-line 2)
5436 (and (< (point) end)
5437 (re-search-forward search end t)
5438 (goto-char (match-beginning 0))))
5439 (setq tcol (current-column) seen t)
5440 (if (> tcol col) (setq col tcol)))
5442 (error "The construction to line up occurred only once"))
5444 (setq col (+ col minshift))
5445 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5449 (skip-chars-backward " \t")
5450 (delete-region (point) e)
5451 (indent-to-column col) ;(make-string (- col (current-column)) ?\ ))
5452 (beginning-of-line 2)
5453 (and (< (point) end)
5454 (re-search-forward search end t)
5455 (goto-char (match-beginning 0)))))))) ; No body
5457 (defun cperl-etags (&optional add all files)
5458 "Run etags with appropriate options for Perl files.
5459 If optional argument ALL is `recursive', will process Perl files
5460 in subdirectories too."
5463 (args '("-l" "none" "-r" "/\\<\\(package\\|sub\\)[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([{#]\\|$\\)\\)/\\4/"))
5465 (if add (setq args (cons "-a" args)))
5466 (or files (setq files (list buffer-file-name)))
5468 ((eq all 'recursive)
5469 ;;(error "Not implemented: recursive")
5470 (setq args (append (list "-e"
5471 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
5473 find(\\&wanted, '.');
5478 ;;(error "Not implemented: all")
5479 (setq args (append (list "-e"
5480 "push @ARGV, <*.PL *.pl *.pm>;
5485 (setq args (append args files))))
5486 (setq res (apply 'call-process cmd nil nil nil args))
5488 (message "etags returned \"%s\"" res))))
5490 (defun cperl-toggle-auto-newline ()
5491 "Toggle the state of `cperl-auto-newline'."
5493 (setq cperl-auto-newline (not cperl-auto-newline))
5494 (message "Newlines will %sbe auto-inserted now."
5495 (if cperl-auto-newline "" "not ")))
5497 (defun cperl-toggle-abbrev ()
5498 "Toggle the state of automatic keyword expansion in CPerl mode."
5500 (abbrev-mode (if abbrev-mode 0 1))
5501 (message "Perl control structure will %sbe auto-inserted now."
5502 (if abbrev-mode "" "not ")))
5505 (defun cperl-toggle-electric ()
5506 "Toggle the state of parentheses doubling in CPerl mode."
5508 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5509 (message "Parentheses will %sbe auto-doubled now."
5510 (if (cperl-val 'cperl-electric-parens) "" "not ")))
5512 (defun cperl-toggle-autohelp ()
5513 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
5514 Delay of auto-help controlled by `cperl-lazy-help-time'."
5516 (if (fboundp 'run-with-idle-timer)
5518 (if cperl-lazy-installed
5519 (cperl-lazy-unstall)
5520 (cperl-lazy-install))
5521 (message "Perl help messages will %sbe automatically shown now."
5522 (if cperl-lazy-installed "" "not ")))
5523 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
5525 (defun cperl-toggle-construct-fix ()
5526 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
5528 (setq cperl-indent-region-fix-constructs
5529 (if cperl-indent-region-fix-constructs
5532 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
5533 (if cperl-indent-region-fix-constructs "" "not ")))
5535 ;;;; Tags file creation.
5537 (defvar cperl-tmp-buffer " *cperl-tmp*")
5539 (defun cperl-setup-tmp-buf ()
5540 (set-buffer (get-buffer-create cperl-tmp-buffer))
5541 (set-syntax-table cperl-mode-syntax-table)
5542 (buffer-disable-undo)
5544 (if cperl-use-syntax-table-text-property-for-tags
5546 (make-local-variable 'parse-sexp-lookup-properties)
5547 ;; Do not introduce variable if not needed, we check it!
5548 (set 'parse-sexp-lookup-properties t))))
5550 (defun cperl-xsub-scan ()
5552 (let ((index-alist '())
5553 (prev-pos 0) index index1 name package prefix)
5554 (goto-char (point-min))
5556 (message "Scanning XSUB for index")
5557 (imenu-progress-message prev-pos 0))
5558 ;; Search for the function
5559 (progn ;;save-match-data
5560 (while (re-search-forward
5561 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5564 (imenu-progress-message prev-pos))
5566 ((match-beginning 2) ; SECTION
5567 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
5568 (goto-char (match-beginning 0))
5569 (skip-chars-forward " \t")
5571 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
5572 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
5574 ((not package) nil) ; C language section
5575 ((match-beginning 3) ; XSUB
5576 (goto-char (1+ (match-beginning 3)))
5577 (setq index (imenu-example--name-and-position))
5578 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
5579 (if (and prefix (string-match (concat "^" prefix) name))
5580 (setq name (substring name (length prefix))))
5581 (cond ((string-match "::" name) nil)
5583 (setq index1 (cons (concat package "::" name) (cdr index)))
5584 (push index1 index-alist)))
5586 (push index index-alist))
5588 ;; (beginning-of-line)
5589 (setq index (imenu-example--name-and-position))
5590 (setcar index (concat package "::BOOT:"))
5591 (push index index-alist)))))
5593 (imenu-progress-message prev-pos 100))
5596 (defvar cperl-unreadable-ok nil)
5598 (defun cperl-find-tags (ifile xs topdir)
5599 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
5600 (cperl-pod-here-fontify nil) f file)
5602 (if b (set-buffer b)
5603 (cperl-setup-tmp-buf))
5606 (setq file (car (insert-file-contents ifile)))
5607 (error (if cperl-unreadable-ok nil
5609 (format "File %s unreadable. Continue? " ifile))
5610 (setq cperl-unreadable-ok t)
5611 (error "Aborting: unreadable file %s" ifile)))))
5613 (message "Unreadable file %s" ifile)
5614 (message "Scanning file %s ..." file)
5615 (if (and cperl-use-syntax-table-text-property-for-tags
5617 (condition-case err ; after __END__ may have garbage
5618 (cperl-find-pods-heres nil nil noninteractive)
5619 (error (message "While scanning for syntax: %s" err))))
5621 (setq lst (cperl-xsub-scan))
5622 (setq ind (cperl-imenu--create-perl-index))
5623 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
5628 (cond ((string-match "^[_a-zA-Z]" (car elt))
5629 (goto-char (cdr elt))
5630 (beginning-of-line) ; pos should be of the start of the line
5633 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
5634 (buffer-substring (progn
5635 (goto-char (cdr elt))
5636 ;; After name now...
5637 (or (eolp) (forward-char 1))
5645 (setq elt (car lst) lst (cdr lst))
5650 (if (string-match "^package " (car elt))
5651 (substring (car elt) 8)
5654 (number-to-string (elt elt 2)) ; Line
5656 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
5658 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
5659 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
5661 ;; Need to insert the name without package as well
5662 (setq lst (cons (cons (substring (elt elt 3)
5670 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5671 (set-text-properties 0 (length rel) nil rel)
5672 (and (equal topdir (substring rel 0 (length topdir)))
5673 (setq rel (substring file (length topdir))))
5674 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
5675 (setq ret (buffer-substring 1 (point-max)))
5678 (message "Scanning file %s finished" file))
5681 (defun cperl-add-tags-recurse-noxs ()
5682 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5684 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5685 -f cperl-add-tags-recurse
5687 (cperl-write-tags nil nil t t nil t))
5689 (defun cperl-add-tags-recurse ()
5690 "Add to TAGS file data for Perl files in the current directory and kids.
5692 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5693 -f cperl-add-tags-recurse
5695 (cperl-write-tags nil nil t t))
5697 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
5698 ;; If INBUFFER, do not select buffer, and do not save
5699 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5702 (setq file (if dir default-directory (buffer-file-name)))
5703 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
5705 (setq topdir default-directory))
5706 (let ((tags-file-name "TAGS")
5707 (case-fold-search (eq system-type 'emx))
5710 (cond (inbuffer nil) ; Already there
5711 ((file-exists-p tags-file-name)
5713 (visit-tags-table-buffer)
5714 (visit-tags-table-buffer tags-file-name)))
5715 (t (set-buffer (find-file-noselect tags-file-name))))
5718 (cond ((eq erase 'ignore))
5721 (setq erase 'ignore)))
5724 (directory-files file t
5725 (if recurse nil cperl-scan-files-regexp)
5728 (if cperl-unreadable-ok nil
5730 (format "Directory %s unreadable. Continue? " file))
5731 (setq cperl-unreadable-ok t
5732 tm nil) ; Return empty list
5733 (error "Aborting: unreadable directory %s" file)))))))
5737 ((string-match cperl-noscan-files-regexp file)
5739 ((not (file-directory-p file))
5740 (if (string-match cperl-scan-files-regexp file)
5741 (cperl-write-tags file erase recurse nil t noxs topdir)))
5743 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
5746 (setq xs (string-match "\\.xs$" file))
5747 (if (not (and xs noxs))
5749 (cond ((eq erase 'ignore) (goto-char (point-max)))
5750 (erase (erase-buffer))
5754 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5755 (set-text-properties 0 (length rel) nil rel)
5756 (and (equal topdir (substring rel 0 (length topdir)))
5757 (setq rel (substring file (length topdir))))
5758 (if (search-forward (concat "\f\n" rel ",") nil t)
5760 (search-backward "\f\n")
5761 (delete-region (point)
5764 (if (search-forward "\f\n"
5768 (goto-char (point-max)))))
5769 (insert (cperl-find-tags file xs topdir))))))
5770 (if inbuffer nil ; Delegate to the caller
5771 (save-buffer 0) ; No backup
5772 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
5773 (initialize-new-tags-table))))))
5775 (defvar cperl-tags-hier-regexp-list
5782 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
5784 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
5787 (defvar cperl-hierarchy '(() ())
5788 "Global hierarchy of classes.")
5790 (defun cperl-tags-hier-fill ()
5791 ;; Suppose we are in a tag table cooked by cperl.
5793 (let (type pack name pos line chunk ord cons1 file str info fileind)
5794 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5795 (setq pos (match-beginning 0)
5796 pack (match-beginning 2))
5798 (if (looking-at (concat
5807 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
5808 name (buffer-substring (match-beginning 2) (match-end 2))
5809 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5810 line (buffer-substring (match-beginning 3) (match-end 3))
5813 fileind (format "%s:%s" file line)
5814 ;; Moves to beginning of the next line:
5815 info (cperl-etags-snarf-tag file line))
5818 ;; Make new member of hierarchy name ==> file ==> pos if needed
5819 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
5821 (setcdr cons1 (cons (cons fileind (vector file info))
5823 ;; First occurrence of the name, start alist
5824 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5826 (setcar (cdr cperl-hierarchy)
5827 (cons cons1 (nth 1 cperl-hierarchy)))
5828 (setcar cperl-hierarchy
5829 (cons cons1 (car cperl-hierarchy)))))))
5832 (defun cperl-tags-hier-init (&optional update)
5833 "Show hierarchical menu of classes and methods.
5834 Finds info about classes by a scan of loaded TAGS files.
5835 Supposes that the TAGS files contain fully qualified function names.
5836 One may build such TAGS files from CPerl mode menu."
5840 (if (or update (null (nth 2 cperl-hierarchy)))
5841 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
5844 (setcdr elt (cdr (nth 1 elt)))))))
5845 pack name cons1 to l1 l2 l3 l4 b)
5846 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5847 (setq cperl-hierarchy (list l1 l2 l3))
5848 (if cperl-xemacs-p ; Not checked
5851 ;; Does this work in XEmacs?
5852 (call-interactively 'visit-tags-table))
5853 (message "Updating list of classes...")
5854 (set-buffer (get-file-buffer tags-file-name))
5855 (cperl-tags-hier-fill))
5857 (call-interactively 'visit-tags-table))
5861 (message "Updating list of classes... %s" tagsfile)
5862 (set-buffer (get-file-buffer tagsfile))
5863 (cperl-tags-hier-fill)))
5865 (message "Updating list of classes... postprocessing..."))
5866 (mapcar remover (car cperl-hierarchy))
5867 (mapcar remover (nth 1 cperl-hierarchy))
5868 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
5869 (cons "Methods: " (car cperl-hierarchy))))
5870 (cperl-tags-treeify to 1)
5871 (setcar (nthcdr 2 cperl-hierarchy)
5872 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
5873 (message "Updating list of classes: done, requesting display...")
5874 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5876 (or (nth 2 cperl-hierarchy)
5877 (error "No items found"))
5879 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
5880 (if (if (fboundp 'display-popup-menus-p)
5881 (let ((f 'display-popup-menus-p))
5884 (x-popup-menu t (nth 2 cperl-hierarchy))
5886 (tmm-prompt (nth 2 cperl-hierarchy))))
5887 (if (and update (listp update))
5888 (progn (while (cdr update) (setq update (cdr update)))
5889 (setq update (car update)))) ; Get the last from the list
5890 (if (vectorp update)
5892 (find-file (elt update 0))
5893 (cperl-etags-goto-tag-location (elt update 1))))
5894 (if (eq update -999) (cperl-tags-hier-init t)))
5896 (defun cperl-tags-treeify (to level)
5897 ;; cadr of `to' is read-write. On start it is a cons
5898 (let* ((regexp (concat "^\\(" (mapconcat
5900 (make-list level "[_a-zA-Z0-9]+")
5903 (packages (cdr (nth 1 to)))
5904 (methods (cdr (nth 2 to)))
5905 l1 head tail cons1 cons2 ord writeto packs recurse
5906 root-packages root-functions ms many_ms same_name ps
5910 (cond ((and (string-match regexp (car elt))
5911 (or (eq ord 1) (match-end 2)))
5912 (setq head (substring (car elt) 0 (match-end 1))
5913 tail (if (match-end 2) (substring (car elt)
5916 (if (setq cons1 (assoc head writeto)) nil
5917 ;; Need to init new head
5918 (setcdr writeto (cons (list head (list "Packages: ")
5921 (setq cons1 (nth 1 writeto)))
5922 (setq cons2 (nth ord cons1)) ; Either packs or meths
5923 (setcdr cons2 (cons elt (cdr cons2))))
5925 (setq root-functions (cons elt root-functions)))
5927 (setq root-packages (cons elt root-packages))))))))
5928 (setcdr to l1) ; Init to dynamic space
5931 (mapcar move-deeper packages)
5933 (mapcar move-deeper methods)
5935 (mapcar (function (lambda (elt)
5936 (cperl-tags-treeify elt (1+ level))))
5938 ;;Now clean up leaders with one child only
5939 (mapcar (function (lambda (elt)
5940 (if (not (and (listp (cdr elt))
5941 (eq (length elt) 2))) nil
5942 (setcar elt (car (nth 1 elt)))
5943 (setcdr elt (cdr (nth 1 elt))))))
5945 ;; Sort the roots of subtrees
5946 (if (default-value 'imenu-sort-function)
5948 (sort (cdr to) (default-value 'imenu-sort-function))))
5949 ;; Now add back functions removed from display
5950 (mapcar (function (lambda (elt)
5951 (setcdr to (cons elt (cdr to)))))
5952 (if (default-value 'imenu-sort-function)
5954 (sort root-functions (default-value 'imenu-sort-function)))
5956 ;; Now add back packages removed from display
5957 (mapcar (function (lambda (elt)
5958 (setcdr to (cons (cons (concat "package " (car elt))
5961 (if (default-value 'imenu-sort-function)
5963 (sort root-packages (default-value 'imenu-sort-function)))
5967 ;;; '(keymap "Name1"
5971 ;;; ("Tail1" "x") ("Tail2" "y"))))
5973 (defun cperl-list-fold (list name limit)
5974 (let (list1 list2 elt1 (num 0))
5975 (if (<= (length list) limit) list
5976 (setq list1 nil list2 nil)
5981 (if (<= num imenu-max-items)
5982 (setq list2 (cons elt1 list2))
5983 (setq list1 (cons (cons name
5988 (nreverse (cons (cons name
5992 (defun cperl-menu-to-keymap (menu &optional name)
5998 (cond ((listp (cdr elt))
5999 (setq list (cperl-list-fold
6000 (cdr elt) (car elt) imenu-max-items))
6003 (cperl-menu-to-keymap list))))
6005 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
6006 (cperl-list-fold menu "Root" imenu-max-items)))))
6009 (defvar cperl-bad-style-regexp
6010 (mapconcat 'identity
6011 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
6012 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
6014 "Finds places such that insertion of a whitespace may help a lot.")
6016 (defvar cperl-not-bad-style-regexp
6019 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
6020 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
6021 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
6022 "<\\$?\\sw+\\(\\.\\sw+\\)?>" ; <IN> <stdin.h>
6023 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
6030 "\\\\[&$@*\\\\]" ; \&func
6033 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
6036 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
6037 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
6038 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
6042 "If matches at the start of match found by `my-bad-c-style-regexp',
6043 insertion of a whitespace will not help.")
6047 (defun cperl-find-bad-style ()
6048 "Find places in the buffer where insertion of a whitespace may help.
6049 Prompts user for insertion of spaces.
6050 Currently it is tuned to C and Perl syntax."
6052 (let (found-bad (p (point)))
6053 (setq last-nonmenu-event 13) ; To disable popup
6054 (beginning-of-buffer)
6055 (map-y-or-n-p "Insert space here? "
6056 (lambda (arg) (insert " "))
6057 'cperl-next-bad-style
6058 '("location" "locations" "insert a space into")
6059 '((?\C-r (lambda (arg)
6060 (let ((buffer-quit-function
6061 'exit-recursive-edit))
6062 (message "Exit with Esc Esc")
6064 t)) ; Consider acted upon
6065 "edit, exit with Esc Esc")
6067 (let ((buffer-quit-function
6068 'exit-recursive-edit))
6069 (message "Exit with Esc Esc")
6071 t)) ; Consider acted upon
6072 "edit, exit with Esc Esc"))
6074 (if found-bad (goto-char found-bad)
6076 (message "No appropriate place found"))))
6078 (defun cperl-next-bad-style ()
6079 (let (p (not-found t) (point (point)) found)
6080 (while (and not-found
6081 (re-search-forward cperl-bad-style-regexp nil 'to-end))
6083 (goto-char (match-beginning 0))
6085 (looking-at cperl-not-bad-style-regexp)
6086 ;; Check for a < -b and friends
6087 (and (eq (following-char) ?\-)
6089 (skip-chars-backward " \t\n")
6090 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
6091 ;; Now check for syntax type
6093 (setq found (point))
6094 (beginning-of-defun)
6095 (let ((pps (parse-partial-sexp (point) found)))
6096 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
6097 (goto-char (match-end 0))
6105 (defvar cperl-have-help-regexp
6109 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
6110 "[$@]\\^[a-zA-Z]" ; Special variable
6111 "[$@][^ \n\t]" ; Special variable
6112 "-[a-zA-Z]" ; File test
6113 "\\\\[a-zA-Z0]" ; Special chars
6114 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
6115 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
6116 "[a-zA-Z_0-9:]+" ; symbol or number
6123 "Matches places in the buffer we can find help for.")
6125 (defvar cperl-message-on-help-error t)
6126 (defvar cperl-help-from-timer nil)
6128 (defun cperl-word-at-point-hard ()
6129 ;; Does not save-excursion
6130 ;; Get to the something meaningful
6131 (or (eobp) (eolp) (forward-char 1))
6132 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
6133 (save-excursion (beginning-of-line) (point))
6136 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
6137 ;; (skip-chars-backward " \n\t\r({[]});,")
6138 ;; (or (bobp) (backward-char 1))))
6141 ((looking-at "[a-zA-Z0-9_:]") ; symbol
6142 (skip-chars-backward "a-zA-Z0-9_:")
6144 ((and (eq (preceding-char) ?^) ; $^I
6145 (eq (char-after (- (point) 2)) ?\$))
6147 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
6149 ((and (eq (preceding-char) ?\=)
6150 (eq (current-column) 1))
6151 (forward-char -1))) ; =head1
6152 (if (and (eq (preceding-char) ?\<)
6153 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
6155 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
6157 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
6159 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
6160 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
6162 ((and (eq (preceding-char) ?\$)
6163 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
6165 ((and (eq (following-char) ?\>)
6166 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
6169 (and (eq (preceding-char) ?\<)
6170 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
6171 (search-backward "<"))))
6172 ((and (eq (following-char) ?\$)
6173 (eq (preceding-char) ?\<)
6174 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
6176 (if (looking-at cperl-have-help-regexp)
6177 (buffer-substring (match-beginning 0) (match-end 0))))
6179 (defun cperl-get-help ()
6180 "Get one-line docs on the symbol at the point.
6181 The data for these docs is a little bit obsolete and may be in fact longer
6182 than a line. Your contribution to update/shorten it is appreciated."
6184 (save-match-data ; May be called "inside" query-replace
6186 (let ((word (cperl-word-at-point-hard)))
6188 (if (and cperl-help-from-timer ; Bail out if not in mainland
6189 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
6190 (or (memq (get-text-property (point) 'face)
6191 '(font-lock-comment-face font-lock-string-face))
6192 (memq (get-text-property (point) 'syntax-type)
6193 '(pod here-doc format))))
6195 (cperl-describe-perl-symbol word))
6196 (if cperl-message-on-help-error
6197 (message "Nothing found for %s..."
6198 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
6200 ;;; Stolen from perl-descr.el by Johan Vromans:
6202 (defvar cperl-doc-buffer " *perl-doc*"
6203 "Where the documentation can be found.")
6205 (defun cperl-describe-perl-symbol (val)
6206 "Display the documentation of symbol at point, a Perl operator."
6207 (let ((enable-recursive-minibuffers t)
6210 ((string-match "^[&*][a-zA-Z_]" val)
6211 (setq val (concat (substring val 0 1) "NAME")))
6212 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
6213 (setq val (concat "@" (substring val 1 (match-end 1)))))
6214 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
6215 (setq val (concat "%" (substring val 1 (match-end 1)))))
6216 ((and (string= val "x") (string-match "^x=" val))
6218 ((string-match "^\\$[\C-a-\C-z]" val)
6219 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
6220 ((string-match "^CORE::" val)
6221 (setq val "CORE::"))
6222 ((string-match "^SUPER::" val)
6223 (setq val "SUPER::"))
6224 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
6225 (setq val "<NAME>")))
6226 (setq regexp (concat "^"
6227 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
6229 "\\([ \t([/]\\|$\\)"))
6231 ;; get the buffer with the documentation text
6232 (cperl-switch-to-doc-buffer)
6234 ;; lookup in the doc
6235 (goto-char (point-min))
6236 (let ((case-fold-search nil))
6238 (if (re-search-forward regexp (point-max) t)
6240 (beginning-of-line 1)
6241 (let ((lnstart (point)))
6243 (message "%s" (buffer-substring lnstart (point)))))
6244 (if cperl-message-on-help-error
6245 (message "No definition for %s" val)))))))
6247 (defvar cperl-short-docs 'please-ignore-this-line
6248 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
6249 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
6250 ... Range (list context); flip/flop [no flop when flip] (scalar context).
6251 ! ... Logical negation.
6252 ... != ... Numeric inequality.
6253 ... !~ ... Search pattern, substitution, or translation (negated).
6254 $! In numeric context: errno. In a string context: error string.
6255 $\" The separator which joins elements of arrays interpolated in strings.
6256 $# The output format for printed numbers. Default is %.15g or close.
6257 $$ Process number of this script. Changes in the fork()ed child process.
6258 $% The current page number of the currently selected output channel.
6260 The following variables are always local to the current block:
6262 $1 Match of the 1st set of parentheses in the last match (auto-local).
6263 $2 Match of the 2nd set of parentheses in the last match (auto-local).
6264 $3 Match of the 3rd set of parentheses in the last match (auto-local).
6265 $4 Match of the 4th set of parentheses in the last match (auto-local).
6266 $5 Match of the 5th set of parentheses in the last match (auto-local).
6267 $6 Match of the 6th set of parentheses in the last match (auto-local).
6268 $7 Match of the 7th set of parentheses in the last match (auto-local).
6269 $8 Match of the 8th set of parentheses in the last match (auto-local).
6270 $9 Match of the 9th set of parentheses in the last match (auto-local).
6271 $& The string matched by the last pattern match (auto-local).
6272 $' The string after what was matched by the last match (auto-local).
6273 $` The string before what was matched by the last match (auto-local).
6275 $( The real gid of this process.
6276 $) The effective gid of this process.
6277 $* Deprecated: Set to 1 to do multiline matching within a string.
6278 $+ The last bracket matched by the last search pattern.
6279 $, The output field separator for the print operator.
6280 $- The number of lines left on the page.
6281 $. The current input line number of the last filehandle that was read.
6282 $/ The input record separator, newline by default.
6283 $0 Name of the file containing the current perl script (read/write).
6284 $: String may be broken after these characters to fill ^-lines in a format.
6285 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
6286 $< The real uid of this process.
6287 $= The page length of the current output channel. Default is 60 lines.
6288 $> The effective uid of this process.
6289 $? The status returned by the last ``, pipe close or `system'.
6290 $@ The perl error message from the last eval or do @var{EXPR} command.
6291 $ARGV The name of the current file used with <> .
6292 $[ Deprecated: The index of the first element/char in an array/string.
6293 $\\ The output record separator for the print operator.
6294 $] The perl version string as displayed with perl -v.
6295 $^ The name of the current top-of-page format.
6296 $^A The current value of the write() accumulator for format() lines.
6297 $^D The value of the perl debug (-D) flags.
6298 $^E Information about the last system error other than that provided by $!.
6299 $^F The highest system file descriptor, ordinarily 2.
6300 $^H The current set of syntax checks enabled by `use strict'.
6301 $^I The value of the in-place edit extension (perl -i option).
6302 $^L What formats output to perform a formfeed. Default is \f.
6303 $^M A buffer for emergency memory allocation when running out of memory.
6304 $^O The operating system name under which this copy of Perl was built.
6305 $^P Internal debugging flag.
6306 $^T The time the script was started. Used by -A/-M/-C file tests.
6307 $^W True if warnings are requested (perl -w flag).
6308 $^X The name under which perl was invoked (argv[0] in C-speech).
6309 $_ The default input and pattern-searching space.
6310 $| Auto-flush after write/print on current output channel? Default 0.
6311 $~ The name of the current report format.
6312 ... % ... Modulo division.
6313 ... %= ... Modulo division assignment.
6314 %ENV Contains the current environment.
6315 %INC List of files that have been require-d or do-ne.
6316 %SIG Used to set signal handlers for various signals.
6317 ... & ... Bitwise and.
6318 ... && ... Logical and.
6319 ... &&= ... Logical and assignment.
6320 ... &= ... Bitwise and assignment.
6321 ... * ... Multiplication.
6322 ... ** ... Exponentiation.
6323 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6324 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
6325 ... + ... Addition. +EXPR Makes EXPR into scalar context.
6326 ++ Auto-increment (magical on strings). ++EXPR EXPR++
6327 ... += ... Addition assignment.
6329 ... - ... Subtraction.
6330 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6331 ... -= ... Subtraction assignment.
6332 -A Access time in days since script started.
6333 -B File is a non-text (binary) file.
6334 -C Inode change time in days since script started.
6335 -M Age in days since script started.
6336 -O File is owned by real uid.
6337 -R File is readable by real uid.
6338 -S File is a socket .
6339 -T File is a text file.
6340 -W File is writable by real uid.
6341 -X File is executable by real uid.
6342 -b File is a block special file.
6343 -c File is a character special file.
6344 -d File is a directory.
6346 -f File is a plain file.
6347 -g File has setgid bit set.
6348 -k File has sticky bit set.
6349 -l File is a symbolic link.
6350 -o File is owned by effective uid.
6351 -p File is a named pipe (FIFO).
6352 -r File is readable by effective uid.
6353 -s File has non-zero size.
6354 -t Tests if filehandle (STDIN by default) is opened to a tty.
6355 -u File has setuid bit set.
6356 -w File is writable by effective uid.
6357 -x File is executable by effective uid.
6358 -z File has zero size.
6359 . Concatenate strings.
6360 .. Range (list context); flip/flop (scalar context) operator.
6361 .= Concatenate assignment strings
6362 ... / ... Division. /PATTERN/ioxsmg Pattern match
6363 ... /= ... Division assignment.
6364 /PATTERN/ioxsmg Pattern match.
6365 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6366 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6367 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6368 <> Reads line from union of files in @ARGV (= command line) and STDIN.
6369 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6370 ... <= ... Numeric less than or equal to.
6371 ... <=> ... Numeric compare.
6372 ... = ... Assignment.
6373 ... == ... Numeric equality.
6374 ... =~ ... Search pattern, substitution, or translation
6375 ... > ... Numeric greater than.
6376 ... >= ... Numeric greater than or equal to.
6377 ... >> ... Bitwise shift right.
6378 ... >>= ... Bitwise shift right assignment.
6379 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6380 ?PATTERN? One-time pattern match.
6381 @ARGV Command line arguments (not including the command name - see $0).
6382 @INC List of places to look for perl scripts during do/include/use.
6383 @_ Parameter array for subroutines; result of split() unless in list context.
6384 \\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
6385 \\0 Octal char, e.g. \\033.
6386 \\E Case modification terminator. See \\Q, \\L, and \\U.
6387 \\L Lowercase until \\E . See also \l, lc.
6388 \\U Upcase until \\E . See also \u, uc.
6389 \\Q Quote metacharacters until \\E . See also quotemeta.
6390 \\a Alarm character (octal 007).
6391 \\b Backspace character (octal 010).
6392 \\c Control character, e.g. \\c[ .
6393 \\e Escape character (octal 033).
6394 \\f Formfeed character (octal 014).
6395 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
6396 \\n Newline character (octal 012 on most systems).
6397 \\r Return character (octal 015 on most systems).
6398 \\t Tab character (octal 011).
6399 \\u Upcase the next character. See also \\U and \\l, ucfirst.
6400 \\x Hex character, e.g. \\x1b.
6401 ... ^ ... Bitwise exclusive or.
6402 __END__ Ends program source.
6403 __DATA__ Ends program source.
6404 __FILE__ Current (source) filename.
6405 __LINE__ Current line in current source.
6406 __PACKAGE__ Current package.
6407 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6408 ARGVOUT Output filehandle with -i flag.
6409 BEGIN { ... } Immediately executed (during compilation) piece of code.
6410 END { ... } Pseudo-subroutine executed after the script finishes.
6411 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
6412 INIT { ... } Pseudo-subroutine executed before the script starts running.
6413 DATA Input filehandle for what follows after __END__ or __DATA__.
6414 accept(NEWSOCKET,GENERICSOCKET)
6427 ... cmp ... String compare.
6428 connect(SOCKET,NAME)
6429 continue of { block } continue { block }. Is executed after `next' or at end.
6431 crypt(PLAINTEXT,SALT)
6433 dbmopen(%HASH,DBNAME,MODE)
6437 do { ... }|SUBR while|until EXPR executes at least once
6438 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6448 ... eq ... String equality.
6449 eval(EXPR) or eval { BLOCK }
6453 fcntl(FILEHANDLE,FUNCTION,SCALAR)
6455 flock(FILEHANDLE,OPERATION)
6456 for (EXPR;EXPR;EXPR) { ... }
6457 foreach [VAR] (@ARRAY) { ... }
6459 ... ge ... String greater than or equal.
6464 gethostbyaddr(ADDR,ADDRTYPE)
6468 getnetbyaddr(ADDR,ADDRTYPE)
6474 getpriority(WHICH,WHO)
6475 getprotobyname(NAME)
6476 getprotobynumber(NUMBER)
6481 getservbyname(NAME,PROTO)
6482 getservbyport(PORT,PROTO)
6485 getsockopt(SOCKET,LEVEL,OPTNAME)
6488 ... gt ... String greater than.
6490 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6491 index(STR,SUBSTR[,OFFSET])
6493 ioctl(FILEHANDLE,FUNCTION,SCALAR)
6498 ... le ... String less than or equal.
6500 link(OLDFILE,NEWFILE)
6501 listen(SOCKET,QUEUESIZE)
6505 lstat(EXPR|FILEHANDLE|VAR)
6506 ... lt ... String less than.
6508 mkdir(FILENAME,MODE)
6511 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6512 msgsnd(ID,MSG,FLAGS)
6513 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6514 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
6515 ... ne ... String inequality.
6518 open(FILEHANDLE[,EXPR])
6519 opendir(DIRHANDLE,EXPR)
6520 ord(EXPR) ASCII value of the first char of the string.
6522 package NAME Introduces package context.
6523 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6525 print [FILEHANDLE] [(LIST)]
6526 printf [FILEHANDLE] (FORMAT,LIST)
6528 q/STRING/ Synonym for 'STRING'
6529 qq/STRING/ Synonym for \"STRING\"
6530 qx/STRING/ Synonym for `STRING`
6532 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6535 recv(SOCKET,SCALAR,LEN,FLAGS)
6537 rename(OLDNAME,NEWNAME)
6538 require [FILENAME | PERL_VERSION]
6542 rewinddir(DIRHANDLE)
6543 rindex(STR,SUBSTR[,OFFSET])
6545 s/PATTERN/REPLACEMENT/gieoxsm
6547 seek(FILEHANDLE,POSITION,WHENCE)
6548 seekdir(DIRHANDLE,POS)
6549 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6550 semctl(ID,SEMNUM,CMD,ARG)
6551 semget(KEY,NSEMS,SIZE,FLAGS)
6553 send(SOCKET,MSG,FLAGS[,TO])
6555 sethostent(STAYOPEN)
6558 setpriority(WHICH,WHO,PRIORITY)
6559 setprotoent(STAYOPEN)
6561 setservent(STAYOPEN)
6562 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6565 shmget(KEY,SIZE,FLAGS)
6566 shmread(ID,VAR,POS,SIZE)
6567 shmwrite(ID,STRING,POS,SIZE)
6568 shutdown(SOCKET,HOW)
6571 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6572 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6573 sort [SUBROUTINE] (LIST)
6574 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6575 split[(/PATTERN/[,EXPR[,LIMIT]])]
6576 sprintf(FORMAT,LIST)
6579 stat(EXPR|FILEHANDLE|VAR)
6581 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6582 substr(EXPR,OFFSET[,LEN])
6583 symlink(OLDFILE,NEWFILE)
6585 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6587 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6592 tr/SEARCHLIST/REPLACEMENTLIST/cds
6593 truncate(FILE|EXPR,LENGTH)
6596 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6598 unpack(TEMPLATE,EXPR)
6600 until (EXPR) { ... } EXPR until EXPR
6603 vec(EXPR,OFFSET,BITS)
6606 wantarray Returns true if the sub/eval is called in list context.
6608 while (EXPR) { ... } EXPR while EXPR
6609 write[(EXPR|FILEHANDLE)]
6610 ... x ... Repeat string or array.
6611 x= ... Repetition assignment.
6612 y/SEARCHLIST/REPLACEMENTLIST/
6613 ... | ... Bitwise or.
6614 ... || ... Logical or.
6615 ~ ... Unary bitwise complement.
6616 #! OS interpreter indicator. If contains `perl', used for options, and -x.
6617 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6618 CORE:: Prefix to access builtin function if imported sub obscures it.
6619 SUPER:: Prefix to lookup for a method in @ISA classes.
6620 DESTROY Shorthand for `sub DESTROY {...}'.
6621 ... EQ ... Obsolete synonym of `eq'.
6622 ... GE ... Obsolete synonym of `ge'.
6623 ... GT ... Obsolete synonym of `gt'.
6624 ... LE ... Obsolete synonym of `le'.
6625 ... LT ... Obsolete synonym of `lt'.
6626 ... NE ... Obsolete synonym of `ne'.
6627 abs [ EXPR ] absolute value
6628 ... and ... Low-precedence synonym for &&.
6629 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6630 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6631 chr Converts a number to char with the same ordinal.
6632 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6633 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6634 exists $HASH{KEY} True if the key exists.
6635 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6636 formline PICTURE, LIST Backdoor into \"format\" processing.
6637 glob EXPR Synonym of <EXPR>.
6638 lc [ EXPR ] Returns lowercased EXPR.
6639 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
6640 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
6641 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6642 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6643 not ... Low-precedence synonym for ! - negation.
6644 ... or ... Low-precedence synonym for ||.
6645 pos STRING Set/Get end-position of the last match over this string, see \\G.
6646 quotemeta [ EXPR ] Quote regexp metacharacters.
6647 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6648 readline FH Synonym of <FH>.
6649 readpipe CMD Synonym of `CMD`.
6650 ref [ EXPR ] Type of EXPR when dereferenced.
6651 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6652 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6653 tied Returns internal object for a tied data.
6654 uc [ EXPR ] Returns upcased EXPR.
6655 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6656 untie VAR Unlink an object from a simple Perl variable.
6657 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6658 ... xor ... Low-precedence synonym for exclusive or.
6659 prototype \&SUB Returns prototype of the function given a reference.
6660 =head1 Top-level heading.
6661 =head2 Second-level heading.
6662 =head3 Third-level heading (is there such?).
6663 =over [ NUMBER ] Start list.
6664 =item [ TITLE ] Start new item in the list.
6666 =cut Switch from POD to Perl.
6667 =pod Switch from Perl to POD.
6670 (defun cperl-switch-to-doc-buffer ()
6671 "Go to the perl documentation buffer and insert the documentation."
6673 (let ((buf (get-buffer-create cperl-doc-buffer)))
6675 (switch-to-buffer-other-window buf)
6677 (if (= (buffer-size) 0)
6679 (insert (documentation-property 'cperl-short-docs
6680 'variable-documentation))
6681 (setq buffer-read-only t)))))
6683 (defun cperl-beautify-regexp-piece (b e embed level)
6684 ;; b is before the starting delimiter, e before the ending
6685 ;; e should be a marker, may be changed, but remains "correct".
6686 ;; EMBED is nil iff we process the whole REx.
6687 ;; The REx is guarantied to have //x
6688 ;; LEVEL shows how many levels deep to go
6689 ;; position at enter and at leave is not defined
6690 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
6694 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
6698 ((looking-at "(\\?[^a-zA-Z]")
6700 ((looking-at "(\\?") ; (?i)
6704 (setq c (if embed (current-indentation) (1- (current-column)))
6705 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
6706 (or (looking-at "[ \t]*[\n#]")
6711 (if (re-search-forward "[^ \t]" e t)
6712 (progn ; Something before the ending delimiter
6714 (delete-horizontal-space)
6716 (indent-to-column c)
6717 (set-marker e (point))))
6720 (while (< (point) (marker-position e))
6724 (skip-chars-forward " \t")
6725 (delete-region s (point))
6726 (indent-to-column c1)
6730 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
6731 "\\|" ; Embedded variable
6732 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
6735 "\\|" ; simple-code simple-code*?
6736 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
6740 "\\((\\(\\?\\)?\\)" ; 7 8
6743 (goto-char (match-end 0))
6745 (cond ((match-beginning 1) ; Alphanum word + junk
6747 ((or (match-beginning 3) ; $ab[12]
6748 (and (match-beginning 5) ; X* X+ X{2,3}
6749 (eq (preceding-char) ?\{)))
6752 ((match-beginning 6) ; []
6754 (if (looking-at "\\^?\\]")
6755 (goto-char (match-end 0)))
6756 ;; XXXX POSIX classes?!
6757 (while (and (not pos)
6758 (re-search-forward "\\[:\\|\\]" e t))
6759 (if (eq (preceding-char) ?:)
6760 (or (re-search-forward ":\\]" e t)
6761 (error "[:POSIX:]-group in []-group not terminated"))
6763 (or (eq (preceding-char) ?\])
6764 (error "[]-group not terminated"))
6765 (if (eq (following-char) ?\{)
6768 (and (eq (following-char) ??)
6770 (re-search-forward "\\=\\([*+?]\\??\\)" e t)))
6771 ((match-beginning 7) ; ()
6772 (goto-char (match-beginning 0))
6773 (setq pos (current-column))
6776 (delete-horizontal-space)
6778 (indent-to-column c1)))
6781 ;; (or (forward-sexp 1)
6784 ;; (error "()-group not terminated")))
6785 (set-marker m (1- (point)))
6786 (set-marker m1 (point))
6788 (if (progn ; indent rigidly if multiline
6789 ;; In fact does not make a lot of sense, since
6790 ;; the starting position can be already lost due
6791 ;; to insertion of "\n" and " "
6793 (search-forward "\n" m1 t))
6794 (indent-rigidly (point) m1 (- c1 pos)))
6795 (setq level (1- level))
6797 ((not (match-beginning 8))
6798 (cperl-beautify-regexp-piece tmp m t level))
6799 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
6801 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
6802 (goto-char (+ 2 tmp))
6804 (cperl-beautify-regexp-piece (point) m t level))
6805 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
6806 (goto-char (+ 3 tmp))
6807 (cperl-beautify-regexp-piece (point) m t level))
6809 (cperl-beautify-regexp-piece tmp m t level))))
6811 (cond ((looking-at "[*+?]\\??")
6812 (goto-char (match-end 0)))
6813 ((eq (following-char) ?\{)
6815 (if (eq (following-char) ?\?)
6817 (skip-chars-forward " \t")
6819 (if (looking-at "[#\n]")
6821 (or (eolp) (indent-for-comment))
6822 (beginning-of-line 2))
6823 (delete-horizontal-space)
6827 ((match-beginning 9) ; |
6831 (if (re-search-forward "[^ \t]" tmp t)
6834 (delete-horizontal-space)
6837 (delete-region (point) tmp))
6838 (indent-to-column c)
6840 (skip-chars-forward " \t")
6842 (if (looking-at "[#\n]")
6843 (beginning-of-line 2)
6844 (delete-horizontal-space)
6848 (or (looking-at "[ \t\n]")
6851 (skip-chars-forward " \t"))
6852 (or (looking-at "[#\n]")
6853 (error "Unknown code `%s' in a regexp"
6854 (buffer-substring (point) (1+ (point)))))
6855 (and inline (end-of-line 2)))
6856 ;; Special-case the last line of group
6857 (if (and (>= (point) (marker-position e))
6858 (/= (current-indentation) c))
6862 (skip-chars-forward " \t")
6863 (delete-region s (point))
6864 (indent-to-column c)))))
6866 (defun cperl-make-regexp-x ()
6867 ;; Returns position of the start
6868 ;; XXX this is called too often! Need to cache the result!
6870 (or cperl-use-syntax-table-text-property
6871 (error "I need to have a regexp marked!"))
6873 (if (looking-at "\\s|")
6875 (if (looking-at "\\([smy]\\|qr\\)\\s|")
6877 (re-search-backward "\\s|"))) ; Assume it is scanned already.
6879 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
6880 (sub-p (eq (preceding-char) ?s)) s)
6882 (set-marker e (1- (point)))
6883 (setq delim (preceding-char))
6884 (if (and sub-p (eq delim (char-after (- (point) 2))))
6885 (error "Possible s/blah// - do not know how to deal with"))
6886 (if sub-p (forward-sexp 1))
6887 (if (looking-at "\\sw*x")
6890 ;; Protect fragile " ", "#"
6893 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
6899 (defun cperl-beautify-regexp (&optional deep)
6900 "Do it. (Experimental, may change semantics, recheck the result.)
6901 We suppose that the regexp is scanned already."
6903 (setq deep (if deep (prefix-numeric-value deep) -1))
6905 (goto-char (cperl-make-regexp-x))
6906 (let ((b (point)) (e (make-marker)))
6908 (set-marker e (1- (point)))
6909 (cperl-beautify-regexp-piece b e nil deep))))
6911 (defun cperl-regext-to-level-start ()
6912 "Goto start of an enclosing group in regexp.
6913 We suppose that the regexp is scanned already."
6915 (let ((limit (cperl-make-regexp-x)) done)
6917 (or (eq (following-char) ?\()
6918 (search-backward "(" (1+ limit) t)
6919 (error "Cannot find `(' which starts a group"))
6922 (skip-chars-backward "\\")
6923 (looking-at "\\(\\\\\\\\\\)*(")))
6924 (or done (forward-char -1)))))
6926 (defun cperl-contract-level ()
6927 "Find an enclosing group in regexp and contract it.
6928 \(Experimental, may change semantics, recheck the result.)
6929 We suppose that the regexp is scanned already."
6931 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
6932 (cperl-regext-to-level-start)
6933 (let ((b (point)) (e (make-marker)) s c)
6935 (set-marker e (1- (point)))
6937 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
6939 ((match-beginning 1) ; #-comment
6940 (or c (setq c (current-indentation)))
6941 (beginning-of-line 2) ; Skip
6943 (skip-chars-forward " \t")
6944 (delete-region s (point))
6945 (indent-to-column c))
6948 (just-one-space))))))
6950 (defun cperl-contract-levels ()
6951 "Find an enclosing group in regexp and contract all the kids.
6952 \(Experimental, may change semantics, recheck the result.)
6953 We suppose that the regexp is scanned already."
6957 (cperl-regext-to-level-start)
6958 (error ; We are outside outermost group
6959 (goto-char (cperl-make-regexp-x))))
6960 (let ((b (point)) (e (make-marker)) s c)
6962 (set-marker e (1- (point)))
6964 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
6966 ((match-beginning 1) ; Skip
6969 (cperl-contract-level)))))))
6971 (defun cperl-beautify-level (&optional deep)
6972 "Find an enclosing group in regexp and beautify it.
6973 \(Experimental, may change semantics, recheck the result.)
6974 We suppose that the regexp is scanned already."
6976 (setq deep (if deep (prefix-numeric-value deep) -1))
6978 (cperl-regext-to-level-start)
6979 (let ((b (point)) (e (make-marker)))
6981 (set-marker e (1- (point)))
6982 (cperl-beautify-regexp-piece b e nil deep))))
6984 (defun cperl-invert-if-unless ()
6985 "Change `if (A) {B}' into `B if A;' etc if possible."
6987 (or (looking-at "\\<")
6989 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
6990 (let ((pos1 (point))
6991 pos2 pos3 pos4 pos5 s1 s2 state p pos45
6992 (s0 (buffer-substring (match-beginning 0) (match-end 0))))
6997 (if (eq (following-char) ?\( )
7004 ;; XXXX In fact may be `A if (B); {C}' ...
7005 (if (and (eq (following-char) ?\{ )
7007 (cperl-backward-to-noncomment pos3)
7008 (eq (preceding-char) ?\) )))
7009 (if (condition-case nil
7014 (looking-at "\\<els\\(e\\|if\\)\\>"))
7017 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" s0)
7018 (goto-char (1- pos5))
7019 (cperl-backward-to-noncomment pos4)
7020 (if (eq (preceding-char) ?\;)
7022 (setq pos45 (point))
7024 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
7025 (setq p (match-beginning 0)
7026 s1 (buffer-substring p (match-end 0))
7027 state (parse-partial-sexp pos4 p))
7031 (error "`%s' inside `%s' BLOCK" s1 s0))
7032 (goto-char (match-end 0)))
7034 (goto-char (1+ pos4))
7035 (skip-chars-forward " \t\n")
7036 (setq s2 (buffer-substring (point) pos45))
7038 (or (looking-at ";?[ \t\n]*}")
7040 (skip-chars-forward "; \t\n")
7041 (setq s2 (concat s2 "\n" (buffer-substring (point) (1- pos5))))))
7044 (goto-char (1- pos3))
7045 (cperl-backward-to-noncomment pos2)
7046 (or (looking-at "[ \t\n]*)")
7047 (goto-char (1- pos3)))
7049 (goto-char (1+ pos2))
7050 (skip-chars-forward " \t\n")
7051 (setq s1 (buffer-substring (point) p))
7052 (delete-region pos4 pos5)
7053 (delete-region pos2 pos3)
7060 (delete-horizontal-space)
7062 (delete-horizontal-space)
7065 (cperl-indent-line))
7066 (error "`%s' (EXPR) not with an {BLOCK}" s0)))
7067 (error "`%s' not with an (EXPR)" s0)))
7068 (error "Not at `if', `unless', `while', `until', `for' or `foreach'")))
7070 ;;; By Anthony Foiani <afoiani@uswest.com>
7071 ;;; Getting help on modules in C-h f ?
7072 ;;; This is a modified version of `man'.
7073 ;;; Need to teach it how to lookup functions
7074 (defun cperl-perldoc (word)
7075 "Run `perldoc' on WORD."
7077 (list (let* ((default-entry (cperl-word-at-point))
7079 (format "perldoc entry%s: "
7080 (if (string= default-entry "")
7082 (format " (default %s)" default-entry))))))
7083 (if (string= input "")
7084 (if (string= default-entry "")
7085 (error "No perldoc args given")
7089 (let* ((case-fold-search nil)
7091 (string-match "^[a-z]+$" word)
7092 (string-match (concat "^" word "\\>")
7093 (documentation-property
7095 'variable-documentation))))
7096 (manual-program (if is-func "perldoc -f" "perldoc")))
7099 (let ((Manual-program "perldoc")
7100 (Manual-switches (if is-func (list "-f"))))
7101 (manual-entry word)))
7103 (Man-getpage-in-background word)))))
7105 (defun cperl-perldoc-at-point ()
7106 "Run a `perldoc' on the word around point."
7108 (cperl-perldoc (cperl-word-at-point)))
7110 (defcustom pod2man-program "pod2man"
7111 "*File name for `pod2man'."
7115 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
7116 (defun cperl-pod-to-manpage ()
7117 "Create a virtual manpage in Emacs from the Perl Online Documentation."
7120 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
7121 (bufname (concat "Man " buffer-file-name))
7122 (buffer (generate-new-buffer bufname)))
7125 (let ((process-environment (copy-sequence process-environment)))
7126 ;; Prevent any attempt to use display terminal fanciness.
7127 (setenv "TERM" "dumb")
7128 (set-process-sentinel
7129 (start-process pod2man-program buffer "sh" "-c"
7130 (format (cperl-pod2man-build-command) pod2man-args))
7131 'Man-bgproc-sentinel)))))
7133 ;;; Updated version by him too
7134 (defun cperl-build-manpage ()
7135 "Create a virtual manpage in Emacs from the POD in the file."
7140 (let ((Manual-program "perldoc"))
7141 (manual-entry buffer-file-name)))
7143 (let* ((manual-program "perldoc"))
7144 (Man-getpage-in-background buffer-file-name)))))
7146 (defun cperl-pod2man-build-command ()
7147 "Builds the entire background manpage and cleaning command."
7148 (let ((command (concat pod2man-program " %s 2>/dev/null"))
7149 (flist Man-filter-list))
7150 (while (and flist (car flist))
7151 (let ((pcom (car (car flist)))
7152 (pargs (cdr (car flist))))
7154 (concat command " | " pcom " "
7155 (mapconcat '(lambda (phrase)
7156 (if (not (stringp phrase))
7157 (error "Malformed Man-filter-list"))
7160 (setq flist (cdr flist))))
7163 (defun cperl-lazy-install ()) ; Avoid a warning
7164 (defun cperl-lazy-unstall ()) ; Avoid a warning
7166 (if (fboundp 'run-with-idle-timer)
7168 (defvar cperl-help-shown nil
7169 "Non-nil means that the help was already shown now.")
7171 (defvar cperl-lazy-installed nil
7172 "Non-nil means that the lazy-help handlers are installed now.")
7174 (defun cperl-lazy-install ()
7175 "Switches on Auto-Help on Perl constructs (put in the message area).
7176 Delay of auto-help controlled by `cperl-lazy-help-time'."
7178 (make-variable-buffer-local 'cperl-help-shown)
7179 (if (and (cperl-val 'cperl-lazy-help-time)
7180 (not cperl-lazy-installed))
7182 (add-hook 'post-command-hook 'cperl-lazy-hook)
7183 (run-with-idle-timer
7184 (cperl-val 'cperl-lazy-help-time 1000000 5)
7186 'cperl-get-help-defer)
7187 (setq cperl-lazy-installed t))))
7189 (defun cperl-lazy-unstall ()
7190 "Switches off Auto-Help on Perl constructs (put in the message area).
7191 Delay of auto-help controlled by `cperl-lazy-help-time'."
7193 (remove-hook 'post-command-hook 'cperl-lazy-hook)
7194 (cancel-function-timers 'cperl-get-help-defer)
7195 (setq cperl-lazy-installed nil))
7197 (defun cperl-lazy-hook ()
7198 (setq cperl-help-shown nil))
7200 (defun cperl-get-help-defer ()
7201 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
7202 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
7204 (setq cperl-help-shown t))))
7205 (cperl-lazy-install)))
7208 ;;; Plug for wrong font-lock:
7210 (defun cperl-font-lock-unfontify-region-function (beg end)
7211 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
7212 (inhibit-read-only t) (inhibit-point-motion-hooks t)
7213 before-change-functions after-change-functions
7214 deactivate-mark buffer-file-name buffer-file-truename)
7215 (remove-text-properties beg end '(face nil))
7216 (when (and (not modified) (buffer-modified-p))
7217 (set-buffer-modified-p nil))))
7219 (defvar cperl-d-l nil)
7220 (defun cperl-fontify-syntaxically (end)
7221 ;; Some vars for debugging only
7222 ;; (message "Syntaxifying...")
7223 (let ((dbg (point)) (iend end)
7224 (istate (car cperl-syntax-state))
7226 (and cperl-syntaxify-unwind
7227 (setq end (cperl-unwind-to-safe t end)))
7228 (setq start (point))
7229 (or cperl-syntax-done-to
7230 (setq cperl-syntax-done-to (point-min)))
7231 (if (or (not (boundp 'font-lock-hot-pass))
7232 (eval 'font-lock-hot-pass)
7233 t) ; Not debugged otherwise
7234 ;; Need to forget what is after `start'
7235 (setq start (min cperl-syntax-done-to start))
7236 ;; Fontification without a change
7237 (setq start (max cperl-syntax-done-to start)))
7239 (setq cperl-syntax-done-to start) ; In case what follows fails
7240 (cperl-find-pods-heres start end t nil t))
7241 (if (eq cperl-syntaxify-by-font-lock 'message)
7242 (message "Syntaxified %s..%s from %s to %s(%s), state %s-->%s"
7244 start end cperl-syntax-done-to
7245 istate (car cperl-syntax-state))) ; For debugging
7246 nil)) ; Do not iterate
7248 (defun cperl-fontify-update (end)
7249 (let ((pos (point)) prop posend)
7251 (setq prop (get-text-property pos 'cperl-postpone))
7252 (setq posend (next-single-property-change pos 'cperl-postpone nil end))
7253 (and prop (put-text-property pos posend (car prop) (cdr prop)))
7255 nil) ; Do not iterate
7257 (defun cperl-update-syntaxification (from to)
7258 (if (and cperl-use-syntax-table-text-property
7259 cperl-syntaxify-by-font-lock
7260 (or (null cperl-syntax-done-to)
7261 (< cperl-syntax-done-to to)))
7265 (cperl-fontify-syntaxically to)))))
7267 (defvar cperl-version
7268 (let ((v "Revision: 5.0"))
7269 (string-match ":\\s *\\([0-9.]+\\)" v)
7270 (substring v (match-beginning 1) (match-end 1)))
7271 "Version of IZ-supported CPerl package this file is based on.")
7273 (provide 'cperl-mode)
7275 ;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
7276 ;;; cperl-mode.el ends here