1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
3 ;; Copyright (C) 1985,86,87,91,92,93,94,95,96,97,98,99,2000,03,2004,2005
4 ;; Free Software Foundation, Inc.
6 ;; Author: Ilya Zakharevich and Bob Olson
7 ;; Maintainer: Ilya Zakharevich <cperl@ilyaz.org>
8 ;; Keywords: languages, Perl
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Corrections made by Ilya Zakharevich cperl@ilyaz.org
31 ;; You can either fine-tune the bells and whistles of this mode or
32 ;; bulk enable them by putting
34 ;; (setq cperl-hairy t)
36 ;; in your .emacs file. (Emacs rulers do not consider it politically
37 ;; correct to make whistles enabled by default.)
39 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
40 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
41 ;; `cperl-praise', `cperl-speed'. <<<<<<
43 ;; The mode information (on C-h m) provides some customization help.
44 ;; If you use font-lock feature of this mode, it is advisable to use
45 ;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
47 ;; Faces used now: three faces for first-class and second-class keywords
48 ;; and control flow words, one for each: comments, string, labels,
49 ;; functions definitions and packages, arrays, hashes, and variable
50 ;; definitions. If you do not see all these faces, your font-lock does
51 ;; not define them, so you need to define them manually.
53 ;; This mode supports font-lock, imenu and mode-compile. In the
54 ;; hairy version font-lock is on, but you should activate imenu
55 ;; yourself (note that mode-compile is not standard yet). Well, you
56 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
57 ;; to bind it like that:
59 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
61 ;;; Font lock bugs as of v4.32:
63 ;; The following kinds of Perl code erroneously start strings:
65 ;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
66 ;; likewise with m, tr, y, q, qX instead of s
70 ;; Some macros are needed for `defcustom'
75 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
76 (defvar cperl-can-font-lock
78 (and (boundp 'emacs-major-version)
80 (> emacs-major-version 20)))))
81 (if cperl-can-font-lock
83 (defvar msb-menu-cond)
84 (defvar gud-perldb-history)
85 (defvar font-lock-background-mode) ; not in Emacs
86 (defvar font-lock-display-type) ; ditto
87 (defmacro cperl-is-face (arg) ; Takes quoted arg
88 (cond ((fboundp 'find-face)
90 (;;(and (fboundp 'face-list)
93 `(member ,arg (and (fboundp 'face-list)
97 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
98 (cond ((fboundp 'make-face)
99 `(make-face (quote ,arg)))
101 `(defvar ,arg (quote ,arg) ,descr))))
102 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
104 (or (cperl-is-face (quote ,arg))
105 (cperl-make-face ,arg ,descr))
106 (or (boundp (quote ,arg)) ; We use unquoted variants too
107 (defvar ,arg (quote ,arg) ,descr))))
109 (defmacro cperl-etags-snarf-tag (file line)
111 (beginning-of-line 2)
113 (defmacro cperl-etags-snarf-tag (file line)
116 (defmacro cperl-etags-goto-tag-location (elt)
118 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
119 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
120 ;; Probably will not work due to some save-excursion???
121 ;; Or save-file-position?
122 ;; (message "Did I get to line %s?" (elt (, elt) 1))
123 `(goto-line (string-to-number (elt ,elt 1))))
125 (defmacro cperl-etags-goto-tag-location (elt)
126 `(etags-goto-tag-location ,elt))))
128 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
130 (defvar cperl-can-font-lock
132 (and (boundp 'emacs-major-version)
134 (> emacs-major-version 20)))))
136 (defun cperl-choose-color (&rest list)
140 (if (or (x-color-defined-p (car list))
142 (setq answer (car list))))
143 (setq list (cdr list)))
147 "Major mode for editing Perl code."
152 (defgroup cperl-indentation-details nil
157 (defgroup cperl-affected-by-hairy nil
158 "Variables affected by `cperl-hairy'."
162 (defgroup cperl-autoinsert-details nil
163 "Auto-insert tuneup."
167 (defgroup cperl-faces nil
168 "Fontification colors."
172 (defgroup cperl-speed nil
173 "Speed vs. validity tuneup."
177 (defgroup cperl-help-system nil
178 "Help system tuneup."
183 (defcustom cperl-extra-newline-before-brace nil
184 "*Non-nil means that if, elsif, while, until, else, for, foreach
185 and do constructs look like:
196 :group 'cperl-autoinsert-details)
198 (defcustom cperl-extra-newline-before-brace-multiline
199 cperl-extra-newline-before-brace
200 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
201 for constructs with multiline if/unless/while/until/for/foreach condition."
203 :group 'cperl-autoinsert-details)
205 (defcustom cperl-indent-level 2
206 "*Indentation of CPerl statements with respect to containing block."
208 :group 'cperl-indentation-details)
210 (defcustom cperl-lineup-step nil
211 "*`cperl-lineup' will always lineup at multiple of this number.
212 If nil, the value of `cperl-indent-level' will be used."
213 :type '(choice (const nil) integer)
214 :group 'cperl-indentation-details)
216 (defcustom cperl-brace-imaginary-offset 0
217 "*Imagined indentation of a Perl open brace that actually follows a statement.
218 An open brace following other text is treated as if it were this far
219 to the right of the start of its line."
221 :group 'cperl-indentation-details)
223 (defcustom cperl-brace-offset 0
224 "*Extra indentation for braces, compared with other text in same context."
226 :group 'cperl-indentation-details)
227 (defcustom cperl-label-offset -2
228 "*Offset of CPerl label lines relative to usual indentation."
230 :group 'cperl-indentation-details)
231 (defcustom cperl-min-label-indent 1
232 "*Minimal offset of CPerl label lines."
234 :group 'cperl-indentation-details)
235 (defcustom cperl-continued-statement-offset 2
236 "*Extra indent for lines not starting new statements."
238 :group 'cperl-indentation-details)
239 (defcustom cperl-continued-brace-offset 0
240 "*Extra indent for substatements that start with open-braces.
241 This is in addition to cperl-continued-statement-offset."
243 :group 'cperl-indentation-details)
244 (defcustom cperl-close-paren-offset -1
245 "*Extra indent for substatements that start with close-parenthesis."
247 :group 'cperl-indentation-details)
249 (defcustom cperl-auto-newline nil
250 "*Non-nil means automatically newline before and after braces,
251 and after colons and semicolons, inserted in CPerl code. The following
252 \\[cperl-electric-backspace] will remove the inserted whitespace.
253 Insertion after colons requires both this variable and
254 `cperl-auto-newline-after-colon' set."
256 :group 'cperl-autoinsert-details)
258 (defcustom cperl-autoindent-on-semi nil
259 "*Non-nil means automatically indent after insertion of (semi)colon.
260 Active if `cperl-auto-newline' is false."
262 :group 'cperl-autoinsert-details)
264 (defcustom cperl-auto-newline-after-colon nil
265 "*Non-nil means automatically newline even after colons.
266 Subject to `cperl-auto-newline' setting."
268 :group 'cperl-autoinsert-details)
270 (defcustom cperl-tab-always-indent t
271 "*Non-nil means TAB in CPerl mode should always reindent the current line,
272 regardless of where in the line point is when the TAB command is used."
274 :group 'cperl-indentation-details)
276 (defcustom cperl-font-lock nil
277 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
278 Can be overwritten by `cperl-hairy' if nil."
279 :type '(choice (const null) boolean)
280 :group 'cperl-affected-by-hairy)
282 (defcustom cperl-electric-lbrace-space nil
283 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
284 Can be overwritten by `cperl-hairy' if nil."
285 :type '(choice (const null) boolean)
286 :group 'cperl-affected-by-hairy)
288 (defcustom cperl-electric-parens-string "({[]})<"
289 "*String of parentheses that should be electric in CPerl.
290 Closing ones are electric only if the region is highlighted."
292 :group 'cperl-affected-by-hairy)
294 (defcustom cperl-electric-parens nil
295 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
296 Can be overwritten by `cperl-hairy' if nil."
297 :type '(choice (const null) boolean)
298 :group 'cperl-affected-by-hairy)
300 (defvar zmacs-regions) ; Avoid warning
302 (defcustom cperl-electric-parens-mark
304 (or (and (boundp 'transient-mark-mode) ; For Emacs
306 (and (boundp 'zmacs-regions) ; For XEmacs
308 "*Not-nil means that electric parens look for active mark.
309 Default is yes if there is visual feedback on mark."
311 :group 'cperl-autoinsert-details)
313 (defcustom cperl-electric-linefeed nil
314 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
315 In any case these two mean plain and hairy linefeeds together.
316 Can be overwritten by `cperl-hairy' if nil."
317 :type '(choice (const null) boolean)
318 :group 'cperl-affected-by-hairy)
320 (defcustom cperl-electric-keywords nil
321 "*Not-nil (and non-null) means keywords are electric in CPerl.
322 Can be overwritten by `cperl-hairy' if nil."
323 :type '(choice (const null) boolean)
324 :group 'cperl-affected-by-hairy)
326 (defcustom cperl-electric-backspace-untabify t
327 "*Not-nil means electric-backspace will untabify in CPerl."
329 :group 'cperl-autoinsert-details)
331 (defcustom cperl-hairy nil
332 "*Not-nil means most of the bells and whistles are enabled in CPerl.
333 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
334 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
335 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
336 `cperl-lazy-help-time'."
338 :group 'cperl-affected-by-hairy)
340 (defcustom cperl-comment-column 32
341 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
343 :group 'cperl-indentation-details)
345 (defvar cperl-vc-header-alist nil)
346 (make-obsolete-variable
347 'cperl-vc-header-alist
348 "use cperl-vc-rcs-header or cperl-vc-sccs-header instead.")
350 (defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
351 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
352 :type '(repeat string)
355 (defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/) ;")
356 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
357 :type '(repeat string)
360 (defcustom cperl-clobber-mode-lists
363 (boundp 'interpreter-mode-alist)
364 (assoc "miniperl" interpreter-mode-alist)
365 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
366 "*Whether to install us into `interpreter-' and `extension' mode lists."
370 (defcustom cperl-info-on-command-no-prompt nil
371 "*Not-nil (and non-null) means not to prompt on C-h f.
372 The opposite behavior is always available if prefixed with C-c.
373 Can be overwritten by `cperl-hairy' if nil."
374 :type '(choice (const null) boolean)
375 :group 'cperl-affected-by-hairy)
377 (defcustom cperl-clobber-lisp-bindings nil
378 "*Not-nil (and non-null) means not overwrite C-h f.
379 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
380 Can be overwritten by `cperl-hairy' if nil."
381 :type '(choice (const null) boolean)
382 :group 'cperl-affected-by-hairy)
384 (defcustom cperl-lazy-help-time nil
385 "*Not-nil (and non-null) means to show lazy help after given idle time.
386 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
387 :type '(choice (const null) (const nil) integer)
388 :group 'cperl-affected-by-hairy)
390 (defcustom cperl-pod-face 'font-lock-comment-face
391 "*Face for POD highlighting."
395 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
396 "*Face for POD highlighting.
397 Font for POD headers."
401 (defcustom cperl-here-face 'font-lock-string-face
402 "*Face for here-docs highlighting."
406 (defcustom cperl-invalid-face 'underline
407 "*Face for highlighting trailing whitespace."
412 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
413 "*Not-nil after evaluation means to highlight POD and here-docs sections."
417 (defcustom cperl-fontify-m-as-s t
418 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
422 (defcustom cperl-highlight-variables-indiscriminately nil
423 "*Non-nil means perform additional highlighting on variables.
424 Currently only changes how scalar variables are highlighted.
425 Note that that variable is only read at initialization time for
426 the variable `cperl-font-lock-keywords-2', so changing it after you've
427 entered CPerl mode the first time will have no effect."
431 (defcustom cperl-pod-here-scan t
432 "*Not-nil means look for POD and here-docs sections during startup.
433 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
437 (defcustom cperl-regexp-scan t
438 "*Not-nil means make marking of regular expression more thorough.
439 Effective only with `cperl-pod-here-scan'. Not implemented yet."
443 (defcustom cperl-imenu-addback nil
444 "*Not-nil means add backreferences to generated `imenu's.
445 May require patched `imenu' and `imenu-go'. Obsolete."
447 :group 'cperl-help-system)
449 (defcustom cperl-max-help-size 66
450 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
451 :type '(choice integer (const nil))
452 :group 'cperl-help-system)
454 (defcustom cperl-shrink-wrap-info-frame t
455 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
457 :group 'cperl-help-system)
459 (defcustom cperl-info-page "perl"
460 "*Name of the info page containing perl docs.
461 Older version of this page was called `perl5', newer `perl'."
463 :group 'cperl-help-system)
465 (defcustom cperl-use-syntax-table-text-property
466 (boundp 'parse-sexp-lookup-properties)
467 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
471 (defcustom cperl-use-syntax-table-text-property-for-tags
472 cperl-use-syntax-table-text-property
473 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
477 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
478 "*Regexp to match files to scan when generating TAGS."
482 (defcustom cperl-noscan-files-regexp
483 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
484 "*Regexp to match files/dirs to skip when generating TAGS."
488 (defcustom cperl-regexp-indent-step nil
489 "*Indentation used when beautifying regexps.
490 If nil, the value of `cperl-indent-level' will be used."
491 :type '(choice integer (const nil))
492 :group 'cperl-indentation-details)
494 (defcustom cperl-indent-left-aligned-comments t
495 "*Non-nil means that the comment starting in leftmost column should indent."
497 :group 'cperl-indentation-details)
499 (defcustom cperl-under-as-char nil
500 "*Non-nil means that the _ (underline) should be treated as word char."
504 (defcustom cperl-extra-perl-args ""
505 "*Extra arguments to use when starting Perl.
506 Currently used with `cperl-check-syntax' only."
510 (defcustom cperl-message-electric-keyword t
511 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
513 :group 'cperl-help-system)
515 (defcustom cperl-indent-region-fix-constructs 1
516 "*Amount of space to insert between `}' and `else' or `elsif'
517 in `cperl-indent-region'. Set to nil to leave as is. Values other
518 than 1 and nil will probably not work."
519 :type '(choice (const nil) (const 1))
520 :group 'cperl-indentation-details)
522 (defcustom cperl-break-one-line-blocks-when-indent t
523 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
524 need to be reformatted into multiline ones when indenting a region."
526 :group 'cperl-indentation-details)
528 (defcustom cperl-fix-hanging-brace-when-indent t
529 "*Non-nil means that BLOCK-end `}' may be put on a separate line
530 when indenting a region.
531 Braces followed by else/elsif/while/until are excepted."
533 :group 'cperl-indentation-details)
535 (defcustom cperl-merge-trailing-else t
536 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
537 may be merged to be on the same line when indenting a region."
539 :group 'cperl-indentation-details)
541 (defcustom cperl-indent-parens-as-block nil
542 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
543 but for trailing \",\" inside the group, which won't increase indentation.
544 One should tune up `cperl-close-paren-offset' as well."
546 :group 'cperl-indentation-details)
548 (defcustom cperl-syntaxify-by-font-lock
549 (and cperl-can-font-lock
550 (boundp 'parse-sexp-lookup-properties))
551 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
552 :type '(choice (const message) boolean)
555 (defcustom cperl-syntaxify-unwind
557 "*Non-nil means that CPerl unwinds to a start of a long construction
558 when syntaxifying a chunk of buffer."
562 (defcustom cperl-ps-print-face-properties
563 '((font-lock-keyword-face nil nil bold shadow)
564 (font-lock-variable-name-face nil nil bold)
565 (font-lock-function-name-face nil nil bold italic box)
566 (font-lock-constant-face nil "LightGray" bold)
567 (cperl-array nil "LightGray" bold underline)
568 (cperl-hash nil "LightGray" bold italic underline)
569 (font-lock-comment-face nil "LightGray" italic)
570 (font-lock-string-face nil nil italic underline)
571 (cperl-nonoverridable nil nil italic underline)
572 (font-lock-type-face nil nil underline)
573 (underline nil "LightGray" strikeout))
574 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
575 :type '(repeat (cons symbol
576 (cons (choice (const nil) string)
577 (cons (choice (const nil) string)
581 (defvar cperl-dark-background
582 (cperl-choose-color "navy" "os2blue" "darkgreen"))
583 (defvar cperl-dark-foreground
584 (cperl-choose-color "orchid1" "orange"))
586 (defface cperl-nonoverridable
587 `((((class grayscale) (background light))
588 (:background "Gray90" :slant italic :underline t))
589 (((class grayscale) (background dark))
590 (:foreground "Gray80" :slant italic :underline t :weight bold))
591 (((class color) (background light))
592 (:foreground "chartreuse3"))
593 (((class color) (background dark))
594 (:foreground ,cperl-dark-foreground))
595 (t (:weight bold :underline t)))
596 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
598 ;; backward-compatibility alias
599 (put 'cperl-nonoverridable-face 'face-alias 'cperl-nonoverridable)
602 `((((class grayscale) (background light))
603 (:background "Gray90" :weight bold))
604 (((class grayscale) (background dark))
605 (:foreground "Gray80" :weight bold))
606 (((class color) (background light))
607 (:foreground "Blue" :background "lightyellow2" :weight bold))
608 (((class color) (background dark))
609 (:foreground "yellow" :background ,cperl-dark-background :weight bold))
611 "Font Lock mode face used to highlight array names."
613 ;; backward-compatibility alias
614 (put 'cperl-array-face 'face-alias 'cperl-array)
617 `((((class grayscale) (background light))
618 (:background "Gray90" :weight bold :slant italic))
619 (((class grayscale) (background dark))
620 (:foreground "Gray80" :weight bold :slant italic))
621 (((class color) (background light))
622 (:foreground "Red" :background "lightyellow2" :weight bold :slant italic))
623 (((class color) (background dark))
624 (:foreground "Red" :background ,cperl-dark-background :weight bold :slant italic))
625 (t (:weight bold :slant italic)))
626 "Font Lock mode face used to highlight hash names."
628 ;; backward-compatibility alias
629 (put 'cperl-hash-face 'face-alias 'cperl-hash)
633 ;;; Short extra-docs.
635 (defvar cperl-tips 'please-ignore-this-line
636 "Get maybe newer version of this package from
637 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
639 ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
640 Subdirectory `cperl-mode' may contain yet newer development releases and/or
641 patches to related files.
643 For best results apply to an older Emacs the patches from
644 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
645 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
646 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
647 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
649 Get support packages choose-color.el (or font-lock-extra.el before
650 19.30), imenu-go.el from the same place. \(Look for other files there
651 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
652 later you should use choose-color.el *instead* of font-lock-extra.el
653 \(and you will not get smart highlighting in C :-().
655 Note that to enable Compile choices in the menu you need to install
658 If your Emacs does not default to `cperl-mode' on Perl files, and you
659 want it to: put the following into your .emacs file:
661 (defalias 'perl-mode 'cperl-mode)
664 $CPAN/doc/manual/info/perl-info.tar.gz
666 http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
668 If you use imenu-go, run imenu on perl5-info buffer (you can do it
669 from Perl menu). If many files are related, generate TAGS files from
670 Tools/Tags submenu in Perl menu.
672 If some class structure is too complicated, use Tools/Hierarchy-view
673 from Perl menu, or hierarchic view of imenu. The second one uses the
674 current buffer only, the first one requires generation of TAGS from
675 Perl/Tools/Tags menu beforehand.
677 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
679 Switch auto-help on/off with Perl/Tools/Auto-help.
681 Though with contemporary Emaxen CPerl mode should maintain the correct
682 parsing of Perl even when editing, sometimes it may be lost. Fix this by
686 In cases of more severe confusion sometimes it is helpful to do
688 \\[load-library] cperl-mode RET
691 Before reporting (non-)problems look in the problem section of online
692 micro-docs on what I know about CPerl problems.")
694 (defvar cperl-problems 'please-ignore-this-line
695 "Description of problems in CPerl mode.
696 Some faces will not be shown on some versions of Emacs unless you
697 install choose-color.el, available from
698 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
700 `fill-paragraph' on a comment may leave the point behind the
701 paragraph. Parsing of lines with several <<EOF is not implemented
704 Emacs had a _very_ restricted syntax parsing engine until version
705 20.1. Most problems below are corrected starting from this version of
706 Emacs, and all of them should be fixed in version 20.3. (Or apply
707 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
708 this respect (until 2003).
710 Note that even with newer Emacsen in some very rare cases the details
711 of interaction of `font-lock' and syntaxification may be not cleaned
712 up yet. You may get slightly different colors basing on the order of
713 fontification and syntaxification. Say, the initial faces is correct,
714 but editing the buffer breaks this.
716 Even with older Emacsen CPerl mode tries to corrects some Emacs
717 misunderstandings, however, for efficiency reasons the degree of
718 correction is different for different operations. The partially
719 corrected problems are: POD sections, here-documents, regexps. The
720 operations are: highlighting, indentation, electric keywords, electric
723 This may be confusing, since the regexp s#//#/#\; may be highlighted
724 as a comment, but it will be recognized as a regexp by the indentation
725 code. Or the opposite case, when a POD section is highlighted, but
726 may break the indentation of the following code (though indentation
727 should work if the balance of delimiters is not broken by POD).
729 The main trick (to make $ a \"backslash\") makes constructions like
730 ${aaa} look like unbalanced braces. The only trick I can think of is
731 to insert it as $ {aaa} (valid in perl5, not in perl4).
733 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
734 as /($|\\s)/. Note that such a transposition is not always possible.
736 The solution is to upgrade your Emacs or patch an older one. Note
737 that Emacs 20.2 has some bugs related to `syntax-table' text
738 properties. Patches are available on the main CPerl download site,
741 If these bugs cannot be fixed on your machine (say, you have an inferior
742 environment and cannot recompile), you may still disable all the fancy stuff
743 via `cperl-use-syntax-table-text-property'.")
745 (defvar cperl-praise 'please-ignore-this-line
746 "Advantages of CPerl mode.
748 0) It uses the newest `syntax-table' property ;-);
750 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
751 mode - but the latter number may have improved too in last years) even
752 with old Emaxen which do not support `syntax-table' property.
754 When using `syntax-table' property for syntax assist hints, it should
755 handle 99.995% of lines correct - or somesuch. It automatically
756 updates syntax assist hints when you edit your script.
758 2) It is generally believed to be \"the most user-friendly Emacs
759 package\" whatever it may mean (I doubt that the people who say similar
760 things tried _all_ the rest of Emacs ;-), but this was not a lonely
763 3) Everything is customizable, one-by-one or in a big sweep;
765 4) It has many easily-accessable \"tools\":
766 a) Can run program, check syntax, start debugger;
767 b) Can lineup vertically \"middles\" of rows, like `=' in
770 c) Can insert spaces where this impoves readability (in one
771 interactive sweep over the buffer);
772 d) Has support for imenu, including:
773 1) Separate unordered list of \"interesting places\";
774 2) Separate TOC of POD sections;
775 3) Separate list of packages;
776 4) Hierarchical view of methods in (sub)packages;
777 5) and functions (by the full name - with package);
778 e) Has an interface to INFO docs for Perl; The interface is
779 very flexible, including shrink-wrapping of
780 documentation buffer/frame;
781 f) Has a builtin list of one-line explanations for perl constructs.
782 g) Can show these explanations if you stay long enough at the
783 corresponding place (or on demand);
784 h) Has an enhanced fontification (using 3 or 4 additional faces
785 comparing to font-lock - basically, different
786 namespaces in Perl have different colors);
787 i) Can construct TAGS basing on its knowledge of Perl syntax,
788 the standard menu has 6 different way to generate
789 TAGS (if \"by directory\", .xs files - with C-language
790 bindings - are included in the scan);
791 j) Can build a hierarchical view of classes (via imenu) basing
792 on generated TAGS file;
793 k) Has electric parentheses, electric newlines, uses Abbrev
794 for electric logical constructs
796 with different styles of expansion (context sensitive
797 to be not so bothering). Electric parentheses behave
798 \"as they should\" in a presence of a visible region.
799 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
805 n) Highlights (by user-choice) either 3-delimiters constructs
806 (such as tr/a/b/), or regular expressions and `y/tr';
807 o) Highlights trailing whitespace;
808 p) Is able to manipulate Perl Regular Expressions to ease
809 conversion to a more readable form.
811 5) The indentation engine was very smart, but most of tricks may be
812 not needed anymore with the support for `syntax-table' property. Has
813 progress indicator for indentation (with `imenu' loaded).
815 6) Indent-region improves inline-comments as well; also corrects
816 whitespace *inside* the conditional/loop constructs.
818 7) Fill-paragraph correctly handles multi-line comments;
820 8) Can switch to different indentation styles by one command, and restore
821 the settings present before the switch.
823 9) When doing indentation of control constructs, may correct
824 line-breaks/spacing between elements of the construct.
826 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
827 capable syntax engines).")
829 (defvar cperl-speed 'please-ignore-this-line
830 "This is an incomplete compendium of what is available in other parts
831 of CPerl documentation. (Please inform me if I skept anything.)
833 There is a perception that CPerl is slower than alternatives. This part
834 of documentation is designed to overcome this misconception.
836 *By default* CPerl tries to enable the most comfortable settings.
837 From most points of view, correctly working package is infinitely more
838 comfortable than a non-correctly working one, thus by default CPerl
839 prefers correctness over speed. Below is the guide how to change
840 settings if your preferences are different.
842 A) Speed of loading the file. When loading file, CPerl may perform a
843 scan which indicates places which cannot be parsed by primitive Emacs
844 syntax-parsing routines, and marks them up so that either
846 A1) CPerl may work around these deficiencies (for big chunks, mostly
847 PODs and HERE-documents), or
848 A2) On capable Emaxen CPerl will use improved syntax-handlings
849 which reads mark-up hints directly.
851 The scan in case A2 is much more comprehensive, thus may be slower.
853 User can disable syntax-engine-helping scan of A2 by setting
854 `cperl-use-syntax-table-text-property'
855 variable to nil (if it is set to t).
857 One can disable the scan altogether (both A1 and A2) by setting
858 `cperl-pod-here-scan'
861 B) Speed of editing operations.
863 One can add a (minor) speedup to editing operations by setting
864 `cperl-use-syntax-table-text-property'
865 variable to nil (if it is set to t). This will disable
866 syntax-engine-helping scan, thus will make many more Perl
867 constructs be wrongly recognized by CPerl, thus may lead to
868 wrongly matched parentheses, wrong indentation, etc.
870 One can unset `cperl-syntaxify-unwind'. This might speed up editing
871 of, say, long POD sections.")
873 (defvar cperl-tips-faces 'please-ignore-this-line
874 "CPerl mode uses following faces for highlighting:
876 `cperl-array' Array names
877 `cperl-hash' Hash names
878 `font-lock-comment-face' Comments, PODs and whatever is considered
879 syntaxically to be not code
880 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
881 2-arg operators s/y/tr/ or of RExen,
882 `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
883 a target of a file tests, file tests,
884 subroutine names at the moment of definition
885 (except those conflicting with Perl operators),
886 package names (when recognized), format names
887 `font-lock-keyword-face' Control flow switch constructs, declarators
888 `cperl-nonoverridable' Non-overridable keywords, modifiers of RExen
889 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
890 literal parts and the terminator of formats
891 and whatever is syntaxically considered
893 `font-lock-type-face' Overridable keywords
894 `font-lock-variable-name-face' Variable declarations, indirect array and
895 hash names, POD headers/item names
896 `cperl-invalid' Trailing whitespace
898 Note that in several situations the highlighting tries to inform about
899 possible confusion, such as different colors for function names in
900 declarations depending on what they (do not) override, or special cases
901 m// and s/// which do not do what one would expect them to do.
903 Help with best setup of these faces for printout requested (for each of
904 the faces: please specify bold, italic, underline, shadow and box.)
910 ;;; Portability stuff:
912 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
913 `(define-key cperl-mode-map
915 `(if cperl-xemacs-p ,xemacs-key ,emacs-key)
919 (defvar cperl-del-back-ch
920 (car (append (where-is-internal 'delete-backward-char)
921 (where-is-internal 'backward-delete-char-untabify)))
922 "Character generated by key bound to `delete-backward-char'.")
924 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
925 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
927 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
930 ;; "Active regions" are on: use region only if active
931 ;; "Active regions" are off: use region unconditionally
932 (defun cperl-use-region-p ()
933 (if zmacs-regions (mark) t)))
934 (defun cperl-use-region-p ()
935 (if transient-mark-mode mark-active t))
936 (defun cperl-mark-active () mark-active))
938 (defsubst cperl-enable-font-lock ()
941 (defun cperl-putback-char (c) ; Emacs 19
942 (set 'unread-command-events (list c))) ; Avoid undefined warning
945 (defun cperl-putback-char (c) ; XEmacs >= 19.12
946 (setq unread-command-events (list (eval '(character-to-event c))))))
948 (or (fboundp 'uncomment-region)
949 (defun uncomment-region (beg end)
951 (comment-region beg end -1)))
953 (defvar cperl-do-not-fontify
954 (if (string< emacs-version "19.30")
957 "Text property which inhibits refontification.")
959 (defsubst cperl-put-do-not-fontify (from to &optional post)
960 ;; If POST, do not do it with postponed fontification
961 (if (and post cperl-syntaxify-by-font-lock)
963 (put-text-property (max (point-min) (1- from))
964 to cperl-do-not-fontify t)))
966 (defcustom cperl-mode-hook nil
967 "Hook run by CPerl mode."
971 (defvar cperl-syntax-state nil)
972 (defvar cperl-syntax-done-to nil)
973 (defvar cperl-emacs-can-parse (> (length (save-excursion
974 (parse-partial-sexp (point) (point)))) 9))
976 ;; Make customization possible "in reverse"
977 (defsubst cperl-val (symbol &optional default hairy)
979 ((eq (symbol-value symbol) 'null) default)
980 (cperl-hairy (or hairy t))
981 (t (symbol-value symbol))))
983 ;;; Probably it is too late to set these guys already, but it can help later:
985 ;;;(and cperl-clobber-mode-lists
986 ;;;(setq auto-mode-alist
987 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
988 ;;;(and (boundp 'interpreter-mode-alist)
989 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
990 ;;; '(("miniperl" . perl-mode))))))
996 '(imenu easymenu etags timer man info))
997 (if (fboundp 'ps-extend-face-list)
998 (defmacro cperl-ps-extend-face-list (arg)
999 `(ps-extend-face-list ,arg))
1000 (defmacro cperl-ps-extend-face-list (arg)
1001 `(error "This version of Emacs has no `ps-extend-face-list'")))
1002 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1003 ;; macros instead of defsubsts don't work on Emacs, so we do the
1004 ;; expansion manually. Any other suggestions?
1007 (defvar cperl-mode-abbrev-table nil
1008 "Abbrev table in use in CPerl mode buffers.")
1010 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1012 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
1014 (if cperl-mode-map nil
1015 (setq cperl-mode-map (make-sparse-keymap))
1016 (cperl-define-key "{" 'cperl-electric-lbrace)
1017 (cperl-define-key "[" 'cperl-electric-paren)
1018 (cperl-define-key "(" 'cperl-electric-paren)
1019 (cperl-define-key "<" 'cperl-electric-paren)
1020 (cperl-define-key "}" 'cperl-electric-brace)
1021 (cperl-define-key "]" 'cperl-electric-rparen)
1022 (cperl-define-key ")" 'cperl-electric-rparen)
1023 (cperl-define-key ";" 'cperl-electric-semi)
1024 (cperl-define-key ":" 'cperl-electric-terminator)
1025 (cperl-define-key "\C-j" 'newline-and-indent)
1026 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
1027 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
1028 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1029 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
1030 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1031 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
1032 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
1033 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
1034 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1035 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1037 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1038 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1039 (cperl-define-key "\177" 'cperl-electric-backspace)
1040 (cperl-define-key "\t" 'cperl-indent-command)
1041 ;; don't clobber the backspace binding:
1042 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1043 [(control c) (control h) F])
1044 (if (cperl-val 'cperl-clobber-lisp-bindings)
1046 (cperl-define-key "\C-hf"
1047 ;;(concat (char-to-string help-char) "f") ; does not work
1048 'cperl-info-on-command
1050 (cperl-define-key "\C-hv"
1051 ;;(concat (char-to-string help-char) "v") ; does not work
1054 (cperl-define-key "\C-c\C-hf"
1055 ;;(concat (char-to-string help-char) "f") ; does not work
1056 (key-binding "\C-hf")
1057 [(control c) (control h) f])
1058 (cperl-define-key "\C-c\C-hv"
1059 ;;(concat (char-to-string help-char) "v") ; does not work
1060 (key-binding "\C-hv")
1061 [(control c) (control h) v]))
1062 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1063 [(control c) (control h) f])
1064 (cperl-define-key "\C-c\C-hv"
1065 ;;(concat (char-to-string help-char) "v") ; does not work
1067 [(control c) (control h) v]))
1068 (if (and cperl-xemacs-p
1069 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1071 ;; substitute-key-definition is usefulness-deenhanced...
1072 (cperl-define-key "\M-q" 'cperl-fill-paragraph)
1073 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1074 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
1075 (substitute-key-definition
1076 'indent-sexp 'cperl-indent-exp
1077 cperl-mode-map global-map)
1078 (substitute-key-definition
1079 'indent-region 'cperl-indent-region
1080 cperl-mode-map global-map)
1081 (substitute-key-definition
1082 'indent-for-comment 'cperl-indent-for-comment
1083 cperl-mode-map global-map)))
1086 (defvar cperl-lazy-installed)
1087 (defvar cperl-old-style nil)
1092 cperl-menu cperl-mode-map "Menu for CPerl mode"
1094 ["Beginning of function" beginning-of-defun t]
1095 ["End of function" end-of-defun t]
1096 ["Mark function" mark-defun t]
1097 ["Indent expression" cperl-indent-exp t]
1098 ["Fill paragraph/comment" fill-paragraph t]
1100 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
1101 ["Invert if/unless/while etc" cperl-invert-if-unless t]
1103 ["Beautify" cperl-beautify-regexp
1104 cperl-use-syntax-table-text-property]
1105 ["Beautify one level deep" (cperl-beautify-regexp 1)
1106 cperl-use-syntax-table-text-property]
1107 ["Beautify a group" cperl-beautify-level
1108 cperl-use-syntax-table-text-property]
1109 ["Beautify a group one level deep" (cperl-beautify-level 1)
1110 cperl-use-syntax-table-text-property]
1111 ["Contract a group" cperl-contract-level
1112 cperl-use-syntax-table-text-property]
1113 ["Contract groups" cperl-contract-levels
1114 cperl-use-syntax-table-text-property])
1115 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1117 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1118 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1119 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1121 ["Run" mode-compile (fboundp 'mode-compile)]
1122 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1123 (get-buffer "*compilation*"))]
1124 ["Next error" next-error (get-buffer "*compilation*")]
1125 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1127 ["Debugger" cperl-db t]
1130 ["Imenu" imenu (fboundp 'imenu)]
1131 ["Insert spaces if needed" cperl-find-bad-style t]
1132 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1133 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1134 ["CPerl pretty print (exprmntl)" cperl-ps-print
1135 (fboundp 'ps-extend-face-list)]
1136 ["Imenu on info" cperl-imenu-on-info (featurep 'imenu)]
1138 ;;; ["Create tags for current file" cperl-etags t]
1139 ;;; ["Add tags for current file" (cperl-etags t) t]
1140 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1141 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1142 ;;; ["Create tags for Perl files in (sub)directories"
1143 ;;; (cperl-etags nil 'recursive) t]
1144 ;;; ["Add tags for Perl files in (sub)directories"
1145 ;;; (cperl-etags t 'recursive) t])
1146 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1147 ["Create tags for current file" (cperl-write-tags nil t) t]
1148 ["Add tags for current file" (cperl-write-tags) t]
1149 ["Create tags for Perl files in directory"
1150 (cperl-write-tags nil t nil t) t]
1151 ["Add tags for Perl files in directory"
1152 (cperl-write-tags nil nil nil t) t]
1153 ["Create tags for Perl files in (sub)directories"
1154 (cperl-write-tags nil t t t) t]
1155 ["Add tags for Perl files in (sub)directories"
1156 (cperl-write-tags nil nil t t) t]))
1158 ["Define word at point" imenu-go-find-at-position
1159 (fboundp 'imenu-go-find-at-position)]
1160 ["Help on function" cperl-info-on-command t]
1161 ["Help on function at point" cperl-info-on-current-command t]
1162 ["Help on symbol at point" cperl-get-help t]
1163 ["Perldoc" cperl-perldoc t]
1164 ["Perldoc on word at point" cperl-perldoc-at-point t]
1165 ["View manpage of POD in this file" cperl-build-manpage t]
1166 ["Auto-help on" cperl-lazy-install
1167 (and (fboundp 'run-with-idle-timer)
1168 (not cperl-lazy-installed))]
1169 ["Auto-help off" cperl-lazy-unstall
1170 (and (fboundp 'run-with-idle-timer)
1171 cperl-lazy-installed)])
1173 ["Auto newline" cperl-toggle-auto-newline t]
1174 ["Electric parens" cperl-toggle-electric t]
1175 ["Electric keywords" cperl-toggle-abbrev t]
1176 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
1177 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
1178 ["Auto fill" auto-fill-mode t])
1180 ["CPerl" (cperl-set-style "CPerl") t]
1181 ["PerlStyle" (cperl-set-style "PerlStyle") t]
1182 ["GNU" (cperl-set-style "GNU") t]
1183 ["C++" (cperl-set-style "C++") t]
1184 ["FSF" (cperl-set-style "FSF") t]
1185 ["BSD" (cperl-set-style "BSD") t]
1186 ["Whitesmith" (cperl-set-style "Whitesmith") t]
1187 ["Current" (cperl-set-style "Current") t]
1188 ["Memorized" (cperl-set-style-back) cperl-old-style])
1190 ["Tips" (describe-variable 'cperl-tips) t]
1191 ["Problems" (describe-variable 'cperl-problems) t]
1192 ["Speed" (describe-variable 'cperl-speed) t]
1193 ["Praise" (describe-variable 'cperl-praise) t]
1194 ["Faces" (describe-variable 'cperl-tips-faces) t]
1195 ["CPerl mode" (describe-function 'cperl-mode) t]
1197 (message "The version of master-file for this CPerl is %s-Emacs"
1198 cperl-version) t]))))
1201 (autoload 'c-macro-expand "cmacexp"
1202 "Display the result of expanding all C macros occurring in the region.
1203 The expansion is entirely correct because it uses the C preprocessor."
1206 (defvar cperl-imenu--function-name-regexp-perl
1209 "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
1211 "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
1214 (defvar cperl-outline-regexp
1215 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
1217 (defvar cperl-mode-syntax-table nil
1218 "Syntax table in use in CPerl mode buffers.")
1220 (defvar cperl-string-syntax-table nil
1221 "Syntax table in use in CPerl mode string-like chunks.")
1223 (if cperl-mode-syntax-table
1225 (setq cperl-mode-syntax-table (make-syntax-table))
1226 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1227 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1228 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1229 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1230 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1231 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1232 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1233 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1234 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1235 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1236 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1237 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
1238 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1239 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1240 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1241 (if cperl-under-as-char
1242 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1243 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1244 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1245 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1246 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
1247 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
1251 (defvar cperl-faces-init nil)
1253 (defvar cperl-msb-fixed nil)
1254 (defvar cperl-use-major-mode 'cperl-mode)
1257 (defun cperl-mode ()
1258 "Major mode for editing Perl code.
1259 Expression and list commands understand all C brackets.
1260 Tab indents for Perl code.
1261 Paragraphs are separated by blank lines only.
1262 Delete converts tabs to spaces as it moves back.
1264 Various characters in Perl almost always come in pairs: {}, (), [],
1265 sometimes <>. When the user types the first, she gets the second as
1266 well, with optional special formatting done on {}. (Disabled by
1267 default.) You can always quote (with \\[quoted-insert]) the left
1268 \"paren\" to avoid the expansion. The processing of < is special,
1269 since most the time you mean \"less\". CPerl mode tries to guess
1270 whether you want to type pair <>, and inserts is if it
1271 appropriate. You can set `cperl-electric-parens-string' to the string that
1272 contains the parenths from the above list you want to be electrical.
1273 Electricity of parenths is controlled by `cperl-electric-parens'.
1274 You may also set `cperl-electric-parens-mark' to have electric parens
1275 look for active mark and \"embrace\" a region if possible.'
1277 CPerl mode provides expansion of the Perl control constructs:
1279 if, else, elsif, unless, while, until, continue, do,
1280 for, foreach, formy and foreachmy.
1282 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1284 The user types the keyword immediately followed by a space, which
1285 causes the construct to be expanded, and the point is positioned where
1286 she is most likely to want to be. eg. when the user types a space
1287 following \"if\" the following appears in the buffer: if () { or if ()
1288 } { } and the cursor is between the parentheses. The user can then
1289 type some boolean expression within the parens. Having done that,
1290 typing \\[cperl-linefeed] places you - appropriately indented - on a
1291 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1292 directive line, then appropriate number of new lines is inserted).
1294 If CPerl decides that you want to insert \"English\" style construct like
1298 it will not do any expansion. See also help on variable
1299 `cperl-extra-newline-before-brace'. (Note that one can switch the
1300 help message on expansion by setting `cperl-message-electric-keyword'
1303 \\[cperl-linefeed] is a convenience replacement for typing carriage
1304 return. It places you in the next line with proper indentation, or if
1305 you type it inside the inline block of control construct, like
1307 foreach (@lines) {print; print}
1309 and you are on a boundary of a statement inside braces, it will
1310 transform the construct into a multiline and will place you into an
1311 appropriately indented blank line. If you need a usual
1312 `newline-and-indent' behavior, it is on \\[newline-and-indent],
1313 see documentation on `cperl-electric-linefeed'.
1315 Use \\[cperl-invert-if-unless] to change a construction of the form
1325 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1326 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1327 on electric space between $ and {, `cperl-electric-parens-string' is
1328 the string that contains parentheses that should be electric in CPerl
1329 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1330 setting `cperl-electric-keywords' enables electric expansion of
1331 control structures in CPerl. `cperl-electric-linefeed' governs which
1332 one of two linefeed behavior is preferable. You can enable all these
1333 options simultaneously (recommended mode of use) by setting
1334 `cperl-hairy' to t. In this case you can switch separate options off
1335 by setting them to `null'. Note that one may undo the extra
1336 whitespace inserted by semis and braces in `auto-newline'-mode by
1337 consequent \\[cperl-electric-backspace].
1339 If your site has perl5 documentation in info format, you can use commands
1340 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1341 These keys run commands `cperl-info-on-current-command' and
1342 `cperl-info-on-command', which one is which is controlled by variable
1343 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1344 \(in turn affected by `cperl-hairy').
1346 Even if you have no info-format documentation, short one-liner-style
1347 help is available on \\[cperl-get-help], and one can run perldoc or
1350 It is possible to show this help automatically after some idle time.
1351 This is regulated by variable `cperl-lazy-help-time'. Default with
1352 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1353 secs idle time . It is also possible to switch this on/off from the
1354 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1356 Use \\[cperl-lineup] to vertically lineup some construction - put the
1357 beginning of the region at the start of construction, and make region
1358 span the needed amount of lines.
1360 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1361 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1362 here-docs sections. With capable Emaxen results of scan are used
1363 for indentation too, otherwise they are used for highlighting only.
1365 Variables controlling indentation style:
1366 `cperl-tab-always-indent'
1367 Non-nil means TAB in CPerl mode should always reindent the current line,
1368 regardless of where in the line point is when the TAB command is used.
1369 `cperl-indent-left-aligned-comments'
1370 Non-nil means that the comment starting in leftmost column should indent.
1371 `cperl-auto-newline'
1372 Non-nil means automatically newline before and after braces,
1373 and after colons and semicolons, inserted in Perl code. The following
1374 \\[cperl-electric-backspace] will remove the inserted whitespace.
1375 Insertion after colons requires both this variable and
1376 `cperl-auto-newline-after-colon' set.
1377 `cperl-auto-newline-after-colon'
1378 Non-nil means automatically newline even after colons.
1379 Subject to `cperl-auto-newline' setting.
1380 `cperl-indent-level'
1381 Indentation of Perl statements within surrounding block.
1382 The surrounding block's indentation is the indentation
1383 of the line on which the open-brace appears.
1384 `cperl-continued-statement-offset'
1385 Extra indentation given to a substatement, such as the
1386 then-clause of an if, or body of a while, or just a statement continuation.
1387 `cperl-continued-brace-offset'
1388 Extra indentation given to a brace that starts a substatement.
1389 This is in addition to `cperl-continued-statement-offset'.
1390 `cperl-brace-offset'
1391 Extra indentation for line if it starts with an open brace.
1392 `cperl-brace-imaginary-offset'
1393 An open brace following other text is treated as if it the line started
1394 this far to the right of the actual line indentation.
1395 `cperl-label-offset'
1396 Extra indentation for line that is a label.
1397 `cperl-min-label-indent'
1398 Minimal indentation for line that is a label.
1400 Settings for K&R and BSD indentation styles are
1401 `cperl-indent-level' 5 8
1402 `cperl-continued-statement-offset' 5 8
1403 `cperl-brace-offset' -5 -8
1404 `cperl-label-offset' -5 -8
1406 CPerl knows several indentation styles, and may bulk set the
1407 corresponding variables. Use \\[cperl-set-style] to do this. Use
1408 \\[cperl-set-style-back] to restore the memorized preexisting values
1409 \(both available from menu).
1411 If `cperl-indent-level' is 0, the statement after opening brace in
1412 column 0 is indented on
1413 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1415 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1418 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1419 or as help on variables `cperl-tips', `cperl-problems',
1420 `cperl-praise', `cperl-speed'."
1422 (kill-all-local-variables)
1423 (use-local-map cperl-mode-map)
1424 (if (cperl-val 'cperl-electric-linefeed)
1426 (local-set-key "\C-J" 'cperl-linefeed)
1427 (local-set-key "\C-C\C-J" 'newline-and-indent)))
1429 (cperl-val 'cperl-clobber-lisp-bindings)
1430 (cperl-val 'cperl-info-on-command-no-prompt))
1432 ;; don't clobber the backspace binding:
1433 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1434 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1435 [(control c) (control h) f])))
1436 (setq major-mode cperl-use-major-mode)
1437 (setq mode-name "CPerl")
1438 (if (not cperl-mode-abbrev-table)
1439 (let ((prev-a-c abbrevs-changed))
1440 (define-abbrev-table 'cperl-mode-abbrev-table '(
1441 ("if" "if" cperl-electric-keyword 0)
1442 ("elsif" "elsif" cperl-electric-keyword 0)
1443 ("while" "while" cperl-electric-keyword 0)
1444 ("until" "until" cperl-electric-keyword 0)
1445 ("unless" "unless" cperl-electric-keyword 0)
1446 ("else" "else" cperl-electric-else 0)
1447 ("continue" "continue" cperl-electric-else 0)
1448 ("for" "for" cperl-electric-keyword 0)
1449 ("foreach" "foreach" cperl-electric-keyword 0)
1450 ("formy" "formy" cperl-electric-keyword 0)
1451 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1452 ("do" "do" cperl-electric-keyword 0)
1453 ("=pod" "=pod" cperl-electric-pod 0)
1454 ("=over" "=over" cperl-electric-pod 0)
1455 ("=head1" "=head1" cperl-electric-pod 0)
1456 ("=head2" "=head2" cperl-electric-pod 0)
1457 ("pod" "pod" cperl-electric-pod 0)
1458 ("over" "over" cperl-electric-pod 0)
1459 ("head1" "head1" cperl-electric-pod 0)
1460 ("head2" "head2" cperl-electric-pod 0)))
1461 (setq abbrevs-changed prev-a-c)))
1462 (setq local-abbrev-table cperl-mode-abbrev-table)
1463 (abbrev-mode (if (cperl-val 'cperl-electric-keywords) 1 0))
1464 (set-syntax-table cperl-mode-syntax-table)
1465 (make-local-variable 'outline-regexp)
1466 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1467 (setq outline-regexp cperl-outline-regexp)
1468 (make-local-variable 'outline-level)
1469 (setq outline-level 'cperl-outline-level)
1470 (make-local-variable 'paragraph-start)
1471 (setq paragraph-start (concat "^$\\|" page-delimiter))
1472 (make-local-variable 'paragraph-separate)
1473 (setq paragraph-separate paragraph-start)
1474 (make-local-variable 'paragraph-ignore-fill-prefix)
1475 (setq paragraph-ignore-fill-prefix t)
1476 (set (make-local-variable 'fill-paragraph-function) 'cperl-fill-paragraph)
1477 (make-local-variable 'indent-line-function)
1478 (setq indent-line-function 'cperl-indent-line)
1479 (make-local-variable 'require-final-newline)
1480 (setq require-final-newline mode-require-final-newline)
1481 (make-local-variable 'comment-start)
1482 (setq comment-start "# ")
1483 (make-local-variable 'comment-end)
1484 (setq comment-end "")
1485 (make-local-variable 'comment-column)
1486 (setq comment-column cperl-comment-column)
1487 (make-local-variable 'comment-start-skip)
1488 (setq comment-start-skip "#+ *")
1489 (make-local-variable 'defun-prompt-regexp)
1490 (setq defun-prompt-regexp "^[ \t]*sub[ \t\n]+\\([^ \t\n{(;]+\\)\\([ \t\n]*([^()]*)[ \t\n]*\\)?[ \t\n]*")
1491 (make-local-variable 'comment-indent-function)
1492 (setq comment-indent-function 'cperl-comment-indent)
1493 (make-local-variable 'parse-sexp-ignore-comments)
1494 (setq parse-sexp-ignore-comments t)
1495 (make-local-variable 'indent-region-function)
1496 (setq indent-region-function 'cperl-indent-region)
1497 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1498 (make-local-variable 'imenu-create-index-function)
1499 (setq imenu-create-index-function
1500 (function cperl-imenu--create-perl-index))
1501 (make-local-variable 'imenu-sort-function)
1502 (setq imenu-sort-function nil)
1503 (make-local-variable 'vc-rcs-header)
1504 (set 'vc-rcs-header cperl-vc-rcs-header)
1505 (make-local-variable 'vc-sccs-header)
1506 (set 'vc-sccs-header cperl-vc-sccs-header)
1507 (make-local-variable 'font-lock-defaults)
1508 (setq font-lock-defaults
1510 ((string< emacs-version "19.30")
1511 '(cperl-font-lock-keywords-2))
1512 ((string< emacs-version "19.33") ; Which one to use?
1513 '((cperl-font-lock-keywords
1514 cperl-font-lock-keywords-1
1515 cperl-font-lock-keywords-2)))
1517 '((cperl-load-font-lock-keywords
1518 cperl-load-font-lock-keywords-1
1519 cperl-load-font-lock-keywords-2)
1520 nil nil ((?_ . "w"))))))
1521 (make-local-variable 'cperl-syntax-state)
1522 (if cperl-use-syntax-table-text-property
1524 (make-local-variable 'parse-sexp-lookup-properties)
1525 ;; Do not introduce variable if not needed, we check it!
1526 (set 'parse-sexp-lookup-properties t)
1527 ;; Fix broken font-lock:
1528 (or (boundp 'font-lock-unfontify-region-function)
1529 (set 'font-lock-unfontify-region-function
1530 'font-lock-default-unfontify-region))
1531 (make-local-variable 'font-lock-unfontify-region-function)
1532 (set 'font-lock-unfontify-region-function ; not present with old Emacs
1533 'cperl-font-lock-unfontify-region-function)
1534 (make-local-variable 'cperl-syntax-done-to)
1535 (make-local-variable 'font-lock-syntactic-keywords)
1536 (setq font-lock-syntactic-keywords
1537 (if cperl-syntaxify-by-font-lock
1538 '((cperl-fontify-syntaxically))
1539 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1540 ;; used to ignore syntax-table text-properties. (t) is a hack
1541 ;; to make font-lock think that font-lock-syntactic-keywords
1544 (make-local-variable 'cperl-old-style)
1545 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
1546 (set (make-local-variable 'normal-auto-fill-function)
1547 'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
1548 (or (fboundp 'cperl-old-auto-fill-mode)
1550 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
1551 (defun auto-fill-mode (&optional arg)
1553 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
1554 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
1555 (setq auto-fill-function 'cperl-do-auto-fill))))))
1556 (if (cperl-enable-font-lock)
1557 (if (cperl-val 'cperl-font-lock)
1558 (progn (or cperl-faces-init (cperl-init-faces))
1559 (font-lock-mode 1))))
1560 (and (boundp 'msb-menu-cond)
1561 (not cperl-msb-fixed)
1563 (if (featurep 'easymenu)
1564 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
1565 (run-mode-hooks 'cperl-mode-hook)
1566 ;; After hooks since fontification will break this
1567 (if cperl-pod-here-scan
1568 (or cperl-syntaxify-by-font-lock
1569 (progn (or cperl-faces-init (cperl-init-faces-weak))
1570 (cperl-find-pods-heres)))))
1572 ;; Fix for perldb - make default reasonable
1576 (perldb (read-from-minibuffer "Run perldb (like this): "
1577 (if (consp gud-perldb-history)
1578 (car gud-perldb-history)
1579 (concat "perl " ;;(file-name-nondirectory
1583 (buffer-file-name)))
1585 '(gud-perldb-history . 1))))
1587 (defun cperl-msb-fix ()
1588 ;; Adds perl files to msb menu, supposes that msb is already loaded
1589 (setq cperl-msb-fixed t)
1590 (let* ((l (length msb-menu-cond))
1591 (last (nth (1- l) msb-menu-cond))
1592 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1593 (handle (1- (nth 1 last))))
1594 (setcdr precdr (list
1596 '(memq major-mode '(cperl-mode perl-mode))
1601 ;; This is used by indent-for-comment
1602 ;; to decide how much to indent a comment in CPerl code
1603 ;; based on its context. Do fallback if comment is found wrong.
1605 (defvar cperl-wrong-comment)
1606 (defvar cperl-st-cfence '(14)) ; Comment-fence
1607 (defvar cperl-st-sfence '(15)) ; String-fence
1608 (defvar cperl-st-punct '(1))
1609 (defvar cperl-st-word '(2))
1610 (defvar cperl-st-bra '(4 . ?\>))
1611 (defvar cperl-st-ket '(5 . ?\<))
1614 (defun cperl-comment-indent ()
1615 (let ((p (point)) (c (current-column)) was phony)
1616 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
1617 ;; Wrong comment found
1619 (setq was (cperl-to-comment-or-eol)
1620 phony (eq (get-text-property (point) 'syntax-table)
1624 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1625 (if (eq (preceding-char) ?\#)
1630 (skip-chars-backward " \t")
1631 (max (1+ (current-column)) ; Else indent at comment column
1634 (insert comment-start)
1635 (backward-char (length comment-start)))
1636 (setq cperl-wrong-comment t)
1637 (indent-to comment-column 1) ; Indent minimum 1
1638 c))))) ; except leave at least one space.
1640 ;;;(defun cperl-comment-indent-fallback ()
1641 ;;; "Is called if the standard comment-search procedure fails.
1642 ;;;Point is at start of real comment."
1643 ;;; (let ((c (current-column)) target cnt prevc)
1644 ;;; (if (= c comment-column) nil
1645 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1646 ;;; (setq target (max (1+ (setq prevc
1647 ;;; (current-column))) ; Else indent at comment column
1648 ;;; comment-column))
1649 ;;; (if (= c comment-column) nil
1650 ;;; (delete-backward-char cnt)
1651 ;;; (while (< prevc target)
1653 ;;; (setq prevc (current-column)))
1654 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1655 ;;; (while (< prevc target)
1657 ;;; (setq prevc (current-column)))))))
1659 (defun cperl-indent-for-comment ()
1660 "Substitute for `indent-for-comment' in CPerl."
1662 (let (cperl-wrong-comment)
1663 (indent-for-comment)
1664 (if cperl-wrong-comment
1665 (progn (cperl-to-comment-or-eol)
1666 (forward-char (length comment-start))))))
1668 (defun cperl-comment-region (b e arg)
1669 "Comment or uncomment each line in the region in CPerl mode.
1670 See `comment-region'."
1671 (interactive "r\np")
1672 (let ((comment-start "#"))
1673 (comment-region b e arg)))
1675 (defun cperl-uncomment-region (b e arg)
1676 "Uncomment or comment each line in the region in CPerl mode.
1677 See `comment-region'."
1678 (interactive "r\np")
1679 (let ((comment-start "#"))
1680 (comment-region b e (- arg))))
1682 (defvar cperl-brace-recursing nil)
1684 (defun cperl-electric-brace (arg &optional only-before)
1685 "Insert character and correct line's indentation.
1686 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1687 place (even in empty line), but not after. If after \")\" and the inserted
1688 char is \"{\", insert extra newline before only if
1689 `cperl-extra-newline-before-brace'."
1692 (other-end (if (and cperl-electric-parens-mark
1698 (not cperl-brace-recursing)
1699 (cperl-val 'cperl-electric-parens)
1700 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
1701 ;; Need to insert a matching pair
1704 (setq insertpos (point-marker))
1705 (goto-char other-end)
1706 (setq last-command-char ?\{)
1707 (cperl-electric-lbrace arg insertpos))
1709 ;; Check whether we close something "usual" with `}'
1710 (if (and (eq last-command-char ?\})
1714 (up-list (- (prefix-numeric-value arg)))
1715 ;;(cperl-after-block-p (point-min))
1716 (or (cperl-after-expr-p nil "{;)")
1717 ;; after sub, else, continue
1718 (cperl-after-block-p nil 'pre)))
1720 ;; Just insert the guy
1721 (self-insert-command (prefix-numeric-value arg))
1722 (if (and (not arg) ; No args, end (of empty line or auto)
1724 (or (and (null only-before)
1726 (skip-chars-backward " \t")
1728 (and (eq last-command-char ?\{) ; Do not insert newline
1729 ;; if after ")" and `cperl-extra-newline-before-brace'
1730 ;; is nil, do not insert extra newline.
1731 (not cperl-extra-newline-before-brace)
1733 (skip-chars-backward " \t")
1734 (eq (preceding-char) ?\))))
1735 (if cperl-auto-newline
1736 (progn (cperl-indent-line) (newline) t) nil)))
1738 (self-insert-command (prefix-numeric-value arg))
1740 (if cperl-auto-newline
1741 (setq insertpos (1- (point))))
1742 (if (and cperl-auto-newline (null only-before))
1745 (cperl-indent-line)))
1747 (if insertpos (progn (goto-char insertpos)
1748 (search-forward (make-string
1749 1 last-command-char))
1750 (setq insertpos (1- (point)))))
1754 (goto-char insertpos)
1755 (self-insert-command (prefix-numeric-value arg)))
1756 (self-insert-command (prefix-numeric-value arg)))))))
1758 (defun cperl-electric-lbrace (arg &optional end)
1759 "Insert character, correct line's indentation, correct quoting by space."
1761 (let ((cperl-brace-recursing t)
1762 (cperl-auto-newline cperl-auto-newline)
1764 (if (and cperl-electric-parens-mark
1772 (and (cperl-val 'cperl-electric-lbrace-space)
1773 (eq (preceding-char) ?$)
1775 (skip-chars-backward "$")
1776 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
1778 ;; Check whether we are in comment
1782 (not (looking-at "[ \t]*#")))
1783 (cperl-after-expr-p nil "{;)"))
1785 (setq cperl-auto-newline nil))
1786 (cperl-electric-brace arg)
1787 (and (cperl-val 'cperl-electric-parens)
1788 (eq last-command-char ?{)
1789 (memq last-command-char
1790 (append cperl-electric-parens-string nil))
1791 (or (if other-end (goto-char (marker-position other-end)))
1793 (setq last-command-char ?} pos (point))
1794 (progn (cperl-electric-brace arg t)
1797 (defun cperl-electric-paren (arg)
1798 "Insert an opening parenthesis or a matching pair of parentheses.
1799 See `cperl-electric-parens'."
1801 (let ((beg (save-excursion (beginning-of-line) (point)))
1802 (other-end (if (and cperl-electric-parens-mark
1809 (if (and (cperl-val 'cperl-electric-parens)
1810 (memq last-command-char
1811 (append cperl-electric-parens-string nil))
1812 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1813 ;;(not (save-excursion (search-backward "#" beg t)))
1814 (if (eq last-command-char ?<)
1816 (and abbrev-mode ; later it is too late, may be after `for'
1818 (cperl-after-expr-p nil "{;(,:="))
1821 (self-insert-command (prefix-numeric-value arg))
1822 (if other-end (goto-char (marker-position other-end)))
1823 (insert (make-string
1824 (prefix-numeric-value arg)
1825 (cdr (assoc last-command-char '((?{ .?})
1829 (forward-char (- (prefix-numeric-value arg))))
1830 (self-insert-command (prefix-numeric-value arg)))))
1832 (defun cperl-electric-rparen (arg)
1833 "Insert a matching pair of parentheses if marking is active.
1834 If not, or if we are not at the end of marking range, would self-insert.
1835 Affected by `cperl-electric-parens'."
1837 (let ((beg (save-excursion (beginning-of-line) (point)))
1838 (other-end (if (and cperl-electric-parens-mark
1839 (cperl-val 'cperl-electric-parens)
1840 (memq last-command-char
1841 (append cperl-electric-parens-string nil))
1848 (cperl-val 'cperl-electric-parens)
1849 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
1850 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1851 ;;(not (save-excursion (search-backward "#" beg t)))
1854 (self-insert-command (prefix-numeric-value arg))
1856 (if other-end (goto-char other-end))
1857 (insert (make-string
1858 (prefix-numeric-value arg)
1859 (cdr (assoc last-command-char '((?\} . ?\{)
1864 (self-insert-command (prefix-numeric-value arg)))))
1866 (defun cperl-electric-keyword ()
1867 "Insert a construction appropriate after a keyword.
1868 Help message may be switched off by setting `cperl-message-electric-keyword'
1870 (let ((beg (save-excursion (beginning-of-line) (point)))
1871 (dollar (and (eq last-command-char ?$)
1872 (eq this-command 'self-insert-command)))
1873 (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1874 (memq this-command '(self-insert-command newline))))
1876 (and (save-excursion
1880 (setq do (looking-at "do\\>")))
1882 (cperl-after-expr-p nil "{;:"))
1886 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
1888 (save-excursion (or (not (re-search-backward "^=" nil t))
1891 (and cperl-use-syntax-table-text-property
1892 (not (eq (get-text-property (point)
1895 (save-excursion (forward-sexp -1)
1896 (not (memq (following-char) (append "$@%&*" nil))))
1898 (and (eq (preceding-char) ?y)
1899 (progn ; "foreachmy"
1905 (memq this-command '(self-insert-command newline)))))
1906 (and dollar (insert " $"))
1908 ;;(insert " () {\n}")
1910 (cperl-extra-newline-before-brace
1911 (insert (if do "\n" " ()\n"))
1917 (and do (insert " while ();")))
1919 (insert (if do " {\n} while ();" " () {\n}"))))
1920 (or (looking-at "[ \t]\\|$") (insert " "))
1922 (if dollar (progn (search-backward "$")
1926 (search-backward ")")
1927 (if (eq last-command-char ?\()
1928 (progn ; Avoid "if (())"
1929 (delete-backward-char 1)
1930 (delete-backward-char -1))))
1932 (cperl-putback-char cperl-del-back-ch))
1933 (if cperl-message-electric-keyword
1934 (message "Precede char by C-q to avoid expansion"))))))
1936 (defun cperl-ensure-newlines (n &optional pos)
1937 "Make sure there are N newlines after the point."
1938 (or pos (setq pos (point)))
1939 (if (looking-at "\n")
1943 (cperl-ensure-newlines (1- n) pos)
1946 (defun cperl-electric-pod ()
1947 "Insert a POD chunk appropriate after a =POD directive."
1948 (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1949 (memq this-command '(self-insert-command newline))))
1950 head1 notlast name p really-delete over)
1951 (and (save-excursion
1954 (eq (preceding-char) ?=)
1956 (setq head1 (looking-at "head1\\>[ \t]*$"))
1957 (setq over (and (looking-at "over\\>[ \t]*$")
1958 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
1962 (get-text-property (point) 'in-pod)
1963 (cperl-after-expr-p nil "{;:")
1964 (and (re-search-backward
1965 ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
1966 "\\(\\`\n?\\|^\n\\)=\\sw+"
1970 (and cperl-use-syntax-table-text-property
1971 (not (eq (get-text-property (point) 'syntax-type)
1975 (setq notlast (re-search-forward "^\n=" nil t)))
1979 (cperl-ensure-newlines 2)
1985 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
1986 nil t)))) ; Only one
1989 (setq name (file-name-sans-extension
1990 (file-name-nondirectory (buffer-file-name)))
1992 (insert " NAME\n\n" name
1993 " - \n\n=head1 SYNOPSIS\n\n\n\n"
1994 "=head1 DESCRIPTION")
1995 (cperl-ensure-newlines 4)
1999 (setq really-delete t))
2004 (insert "\n\n=item \n\n\n\n"
2006 (cperl-ensure-newlines 2)
2010 (setq really-delete t)))
2011 (if (and delete really-delete)
2012 (cperl-putback-char cperl-del-back-ch))))))
2014 (defun cperl-electric-else ()
2015 "Insert a construction appropriate after a keyword.
2016 Help message may be switched off by setting `cperl-message-electric-keyword'
2018 (let ((beg (save-excursion (beginning-of-line) (point))))
2019 (and (save-excursion
2021 (cperl-after-expr-p nil "{;:"))
2025 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2027 (save-excursion (or (not (re-search-backward "^=" nil t))
2029 (and cperl-use-syntax-table-text-property
2030 (not (eq (get-text-property (point)
2035 ;;(insert " {\n\n}")
2037 (cperl-extra-newline-before-brace
2043 (insert " {\n\n}")))
2044 (or (looking-at "[ \t]\\|$") (insert " "))
2048 (cperl-putback-char cperl-del-back-ch)
2049 (setq this-command 'cperl-electric-else)
2050 (if cperl-message-electric-keyword
2051 (message "Precede char by C-q to avoid expansion"))))))
2053 (defun cperl-linefeed ()
2054 "Go to end of line, open a new line and indent appropriately.
2055 If in POD, insert appropriate lines."
2057 (let ((beg (save-excursion (beginning-of-line) (point)))
2058 (end (save-excursion (end-of-line) (point)))
2059 (pos (point)) start over cut res)
2060 (if (and ; Check if we need to split:
2061 ; i.e., on a boundary and inside "{...}"
2062 (save-excursion (cperl-to-comment-or-eol)
2063 (>= (point) pos)) ; Not in a comment
2065 (skip-chars-backward " \t" beg)
2067 (looking-at "[;{]")) ; After { or ; + spaces
2068 (looking-at "[ \t]*}") ; Before }
2069 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2072 (eq (car (parse-partial-sexp pos end -1)) -1)
2073 ; Leave the level of parens
2074 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2076 (cperl-after-block-p (point-min))
2079 (setq start (point-marker))
2080 (<= start pos))))) ; Redundant? Are after the
2081 ; start of parens group.
2083 (skip-chars-backward " \t")
2084 (or (memq (preceding-char) (append ";{" nil))
2090 (or (looking-at "{[ \t]*$") ; If there is a statement
2091 ; before, move it to separate line
2095 (cperl-indent-line)))
2096 (forward-line 1) ; We are on the target line
2099 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2100 ; after, move it to separate line
2103 (search-backward "}" beg)
2104 (skip-chars-backward " \t")
2105 (or (memq (preceding-char) (append ";{" nil))
2110 (forward-line -1) ; We are on the line before target
2112 (newline-and-indent))
2113 (end-of-line) ; else - no splitting
2115 ((and (looking-at "\n[ \t]*{$")
2117 (skip-chars-backward " \t")
2118 (eq (preceding-char) ?\)))) ; Probably if () {} group
2119 ; with an extra newline.
2121 (cperl-indent-line))
2122 ((save-excursion ; In POD header
2123 (forward-paragraph -1)
2124 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2125 ;; We are after \n now, so look for the rest
2126 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2128 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2129 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2133 (forward-paragraph -1)
2136 (setq cut (buffer-substring (point)
2140 (delete-char (- (save-excursion (end-of-line) (point))
2142 (setq res (expand-abbrev))
2148 (cperl-ensure-newlines (if cut 2 4))
2150 ((get-text-property (point) 'in-pod) ; In POD section
2151 (cperl-ensure-newlines 4)
2153 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2155 (cperl-indent-line))
2157 (newline-and-indent))))))
2159 (defun cperl-electric-semi (arg)
2160 "Insert character and correct line's indentation."
2162 (if cperl-auto-newline
2163 (cperl-electric-terminator arg)
2164 (self-insert-command (prefix-numeric-value arg))
2165 (if cperl-autoindent-on-semi
2166 (cperl-indent-line))))
2168 (defun cperl-electric-terminator (arg)
2169 "Insert character and correct line's indentation."
2172 (auto (and cperl-auto-newline
2173 (or (not (eq last-command-char ?:))
2174 cperl-auto-newline-after-colon)))
2176 (if (and ;;(not arg)
2178 (not (save-excursion
2180 (skip-chars-forward " \t")
2182 ;; Ignore in comment lines
2183 (= (following-char) ?#)
2184 ;; Colon is special only after a label
2185 ;; So quickly rule out most other uses of colon
2186 ;; and do no indentation for them.
2187 (and (eq last-command-char ?:)
2190 (skip-chars-forward " \t")
2191 (and (< (point) end)
2192 (progn (goto-char (- end 1))
2193 (not (looking-at ":"))))))
2195 (beginning-of-defun)
2196 (let ((pps (parse-partial-sexp (point) end)))
2197 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2199 (self-insert-command (prefix-numeric-value arg))
2201 (if auto (setq insertpos (point-marker)))
2207 (cperl-indent-line)))
2209 (if insertpos (goto-char (1- (marker-position insertpos)))
2214 (goto-char insertpos)
2215 (self-insert-command (prefix-numeric-value arg)))
2216 (self-insert-command (prefix-numeric-value arg)))))
2218 (defun cperl-electric-backspace (arg)
2219 "Backspace, or remove the whitespace around the point inserted by an electric
2220 key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2222 (if (and cperl-auto-newline
2223 (memq last-command '(cperl-electric-semi
2224 cperl-electric-terminator
2225 cperl-electric-lbrace))
2226 (memq (preceding-char) '(?\ ?\t ?\n)))
2228 (if (eq last-command 'cperl-electric-lbrace)
2229 (skip-chars-forward " \t\n"))
2231 (skip-chars-backward " \t\n")
2232 (delete-region (point) p))
2233 (and (eq last-command 'cperl-electric-else)
2234 ;; We are removing the whitespace *inside* cperl-electric-else
2235 (setq this-command 'cperl-electric-else-really))
2236 (if (and cperl-auto-newline
2237 (eq last-command 'cperl-electric-else-really)
2238 (memq (preceding-char) '(?\ ?\t ?\n)))
2240 (skip-chars-forward " \t\n")
2242 (skip-chars-backward " \t\n")
2243 (delete-region (point) p))
2244 (if cperl-electric-backspace-untabify
2245 (backward-delete-char-untabify arg)
2246 (delete-backward-char arg)))))
2248 (put 'cperl-electric-backspace 'delete-selection 'supersede)
2250 (defun cperl-inside-parens-p ()
2254 (narrow-to-region (point)
2255 (progn (beginning-of-defun) (point)))
2256 (goto-char (point-max))
2257 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2260 (defun cperl-indent-command (&optional whole-exp)
2261 "Indent current line as Perl code, or in some cases insert a tab character.
2262 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2263 line. Otherwise, indent the current line only if point is at the left margin
2264 or in the line's indentation; otherwise insert a tab.
2266 A numeric argument, regardless of its value,
2267 means indent rigidly all the lines of the expression starting after point
2268 so that this line becomes properly indented.
2269 The relative indentation among the lines of the expression are preserved."
2271 (cperl-update-syntaxification (point) (point))
2273 ;; If arg, always indent this line as Perl
2274 ;; and shift remaining lines of expression the same amount.
2275 (let ((shift-amt (cperl-indent-line))
2278 (if cperl-tab-always-indent
2279 (beginning-of-line))
2286 (if (and shift-amt (> end beg))
2287 (indent-code-rigidly beg end shift-amt "#")))
2288 (if (and (not cperl-tab-always-indent)
2290 (skip-chars-backward " \t")
2293 (cperl-indent-line))))
2295 (defun cperl-indent-line (&optional parse-data)
2296 "Indent current line as Perl code.
2297 Return the amount the indentation changed by."
2298 (let ((case-fold-search nil)
2299 (pos (- (point-max) (point)))
2300 indent i beg shift-amt)
2301 (setq indent (cperl-calculate-indent parse-data)
2305 (cond ((or (eq indent nil) (eq indent t))
2306 (setq indent (current-indentation) i nil))
2307 ;;((eq indent t) ; Never?
2308 ;; (setq indent (cperl-calculate-indent-within-comment)))
2309 ;;((looking-at "[ \t]*#")
2312 (skip-chars-forward " \t")
2313 (if (listp indent) (setq indent (car indent)))
2314 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2316 (setq indent (max cperl-min-label-indent
2317 (+ indent cperl-label-offset)))))
2318 ((= (following-char) ?})
2319 (setq indent (- indent cperl-indent-level)))
2320 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2321 (setq indent (+ indent cperl-close-paren-offset)))
2322 ((= (following-char) ?{)
2323 (setq indent (+ indent cperl-brace-offset))))))
2324 (skip-chars-forward " \t")
2325 (setq shift-amt (and i (- indent (current-column))))
2326 (if (or (not shift-amt)
2328 (if (> (- (point-max) pos) (point))
2329 (goto-char (- (point-max) pos)))
2330 (delete-region beg (point))
2332 ;; If initial point was within line's indentation,
2333 ;; position after the indentation. Else stay at same point in text.
2334 (if (> (- (point-max) pos) (point))
2335 (goto-char (- (point-max) pos))))
2338 (defun cperl-after-label ()
2339 ;; Returns true if the point is after label. Does not do save-excursion.
2340 (and (eq (preceding-char) ?:)
2341 (memq (char-syntax (char-after (- (point) 2)))
2345 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2347 (defun cperl-get-state (&optional parse-start start-state)
2348 ;; returns list (START STATE DEPTH PRESTART),
2349 ;; START is a good place to start parsing, or equal to
2350 ;; PARSE-START if preset,
2351 ;; STATE is what is returned by `parse-partial-sexp'.
2352 ;; DEPTH is true is we are immediately after end of block
2353 ;; which contains START.
2354 ;; PRESTART is the position basing on which START was found.
2356 (let ((start-point (point)) depth state start prestart)
2357 (if (and parse-start
2358 (<= parse-start start-point))
2359 (goto-char parse-start)
2360 (beginning-of-defun)
2361 (setq start-state nil))
2362 (setq prestart (point))
2364 ;; Try to go out, if sub is not on the outermost level
2365 (while (< (point) start-point)
2366 (setq start (point) parse-start start depth nil
2367 state (parse-partial-sexp start start-point -1))
2368 (if (> (car state) -1) nil
2369 ;; The current line could start like }}}, so the indentation
2370 ;; corresponds to a different level than what we reached
2372 (beginning-of-line 2))) ; Go to the next line.
2373 (if start (goto-char start))) ; Not at the start of file
2374 (setq start (point))
2375 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2376 (list start state depth prestart))))
2378 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
2379 ;; Positions is before ?\{. Checks whether it starts a block.
2380 ;; No save-excursion!
2381 (cperl-backward-to-noncomment (point-min))
2382 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
2383 ; Label may be mixed up with `$blah :'
2384 (save-excursion (cperl-after-label))
2385 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2388 ;; Need take into account `bless', `return', `tr',...
2389 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
2390 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
2392 (skip-chars-backward " \t\n\f")
2393 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2397 "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
2399 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2401 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
2402 "Return appropriate indentation for current line as Perl code.
2403 In usual case returns an integer: the column to indent to.
2404 Returns nil if line starts inside a string, t if in a comment.
2406 Will not correct the indentation for labels, but will correct it for braces
2407 and closing parentheses and brackets."
2408 (cperl-update-syntaxification (point) (point))
2411 (and (memq (get-text-property (point) 'syntax-type)
2412 '(pod here-doc here-doc-delim format))
2413 (not (get-text-property (point) 'indentable)))
2414 ;; before start of POD - whitespace found since do not have 'pod!
2415 (and (looking-at "[ \t]*\n=")
2416 (error "Spaces before POD section!"))
2417 (and (not cperl-indent-left-aligned-comments)
2421 (let ((indent-point (point))
2422 (char-after (save-excursion
2423 (skip-chars-forward " \t")
2425 (in-pod (get-text-property (point) 'in-pod))
2426 (pre-indent-point (point))
2427 p prop look-prop is-block delim)
2430 ;; In the verbatim part, probably code example. What to do???
2435 (cperl-backward-to-noncomment nil)
2436 (setq p (max (point-min) (1- (point)))
2437 prop (get-text-property p 'syntax-type)
2438 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2440 (if (memq prop '(pod here-doc format here-doc-delim))
2442 (goto-char (or (previous-single-property-change p look-prop)
2445 (setq pre-indent-point (point)))))))
2446 (goto-char pre-indent-point)
2447 (let* ((case-fold-search nil)
2448 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
2449 (start (or (nth 2 parse-data)
2452 (containing-sexp (car (cdr state)))
2455 ;;containing-sexp ;; We are buggy at toplevel :-(
2458 (setcar parse-data pre-indent-point)
2459 (setcar (cdr parse-data) state)
2460 (or (nth 2 parse-data)
2461 (setcar (cddr parse-data) start))
2462 ;; Before this point: end of statement
2463 (setq old-indent (nth 3 parse-data))))
2464 (cond ((get-text-property (point) 'indentable)
2465 ;; indent to just after the surrounding open,
2466 ;; skip blanks if we do not close the expression.
2467 (goto-char (1+ (previous-single-property-change (point) 'indentable)))
2468 (or (memq char-after (append ")]}" nil))
2469 (looking-at "[ \t]*\\(#\\|$\\)")
2470 (skip-chars-forward " \t"))
2472 ((or (nth 3 state) (nth 4 state))
2473 ;; return nil or t if should not change this line
2475 ;; XXXX Do we need to special-case this?
2476 ((null containing-sexp)
2477 ;; Line is at top level. May be data or function definition,
2478 ;; or may be function argument declaration.
2479 ;; Indent like the previous top level line
2480 ;; unless that ends in a closeparen without semicolon,
2481 ;; in which case this line is the first argument decl.
2482 (skip-chars-forward " \t")
2485 (- (current-indentation)
2486 (if (nth 2 s-s) cperl-indent-level 0)))
2487 (if (= char-after ?{) cperl-continued-brace-offset 0)
2489 (cperl-backward-to-noncomment (or old-indent (point-min)))
2490 ;; Look at previous line that's at column 0
2491 ;; to determine whether we are in top-level decls
2492 ;; or function's arg decls. Set basic-indent accordingly.
2493 ;; Now add a little if this is a continuation line.
2495 (eq (point) old-indent) ; old-indent was at comment
2496 (eq (preceding-char) ?\;)
2498 (and (eq (preceding-char) ?\})
2499 (cperl-after-block-and-statement-beg
2500 (point-min))) ; Was start - too close
2501 (memq char-after (append ")]}" nil))
2502 (and (eq (preceding-char) ?\:) ; label
2505 (skip-chars-backward " \t")
2506 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2507 (get-text-property (point) 'first-format-line))
2510 (not (eq char-after ?\C-j)))
2511 (setcdr (cddr parse-data)
2512 (list pre-indent-point)))
2514 cperl-continued-statement-offset))))
2517 (and (setq delim (= (char-after containing-sexp) ?{))
2518 (save-excursion ; Is it a hash?
2519 (goto-char containing-sexp)
2521 cperl-indent-parens-as-block))
2522 ;; group is an expression, not a block:
2523 ;; indent to just after the surrounding open parens,
2524 ;; skip blanks if we do not close the expression.
2525 (goto-char (1+ containing-sexp))
2526 (or (memq char-after
2527 (append (if delim "}" ")]}") nil))
2528 (looking-at "[ \t]*\\(#\\|$\\)")
2529 (skip-chars-forward " \t"))
2532 (eq char-after ?\}))
2533 ;; Correct indentation of trailing ?\}
2534 (+ cperl-indent-level cperl-close-paren-offset)
2536 ;;; ((and (/= (char-after containing-sexp) ?{)
2537 ;;; (not cperl-indent-parens-as-block))
2538 ;;; ;; line is expression, not statement:
2539 ;;; ;; indent to just after the surrounding open,
2540 ;;; ;; skip blanks if we do not close the expression.
2541 ;;; (goto-char (1+ containing-sexp))
2542 ;;; (or (memq char-after (append ")]}" nil))
2543 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2544 ;;; (skip-chars-forward " \t"))
2545 ;;; (current-column))
2547 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
2548 ;;; (goto-char containing-sexp)
2549 ;;; (and (not (cperl-block-p))
2550 ;;; (not cperl-indent-parens-as-block)))
2551 ;;; (goto-char (1+ containing-sexp))
2552 ;;; (or (eq char-after ?\})
2553 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2554 ;;; (skip-chars-forward " \t"))
2555 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
2556 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
2557 ;;; cperl-close-paren-offset)
2560 ;; Statement level. Is it a continuation or a new statement?
2561 ;; Find previous non-comment character.
2562 (goto-char pre-indent-point)
2563 (cperl-backward-to-noncomment containing-sexp)
2564 ;; Back up over label lines, since they don't
2565 ;; affect whether our line is a continuation.
2567 (while ;;(or (eq (preceding-char) ?\,)
2568 (and (eq (preceding-char) ?:)
2569 (or ;;(eq (char-after (- (point) 2)) ?\') ; ????
2570 (memq (char-syntax (char-after (- (point) 2)))
2573 (if (eq (preceding-char) ?\,)
2574 ;; Will go to beginning of line, essentially.
2575 ;; Will ignore embedded sexpr XXXX.
2576 (cperl-backward-to-start-of-continued-exp containing-sexp))
2578 (cperl-backward-to-noncomment containing-sexp))
2579 ;; Now we get the answer.
2580 (if (not (or (eq (1- (point)) containing-sexp)
2581 (memq (preceding-char)
2582 (append (if is-block " ;{" " ,;{") '(nil)))
2583 (and (eq (preceding-char) ?\})
2584 (cperl-after-block-and-statement-beg
2586 (get-text-property (point) 'first-format-line)))
2587 ;; This line is continuation of preceding line's statement;
2588 ;; indent `cperl-continued-statement-offset' more than the
2589 ;; previous line of the statement.
2591 ;; There might be a label on this line, just
2592 ;; consider it bad style and ignore it.
2594 (cperl-backward-to-start-of-continued-exp containing-sexp)
2595 (+ (if (memq char-after (append "}])" nil))
2597 cperl-continued-statement-offset)
2600 (not (eq char-after ?\})))
2602 ;; Now it is a hash reference
2603 (+ cperl-indent-level cperl-close-paren-offset))
2604 (if (looking-at "\\w+[ \t]*:")
2605 (if (> (current-indentation) cperl-min-label-indent)
2606 (- (current-indentation) cperl-label-offset)
2607 ;; Do not move `parse-data', this should
2608 ;; be quick anyway (this comment comes
2609 ;; from different location):
2610 (cperl-calculate-indent))
2612 (if (eq char-after ?\{)
2613 cperl-continued-brace-offset 0)))
2614 ;; This line starts a new statement.
2615 ;; Position following last unclosed open.
2616 (goto-char containing-sexp)
2617 ;; Is line first statement after an open-brace?
2619 ;; If no, find that first statement and indent like
2620 ;; it. If the first statement begins with label, do
2621 ;; not believe when the indentation of the label is too
2625 (setq old-indent (current-indentation))
2626 (let ((colon-line-end 0))
2628 (progn (skip-chars-forward " \t\n")
2629 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
2630 ;; Skip over comments and labels following openbrace.
2631 (cond ((= (following-char) ?\#)
2633 ((= (following-char) ?\=)
2635 (or (next-single-property-change (point) 'in-pod)
2636 (point-max)))) ; do not loop if no syntaxification
2639 (save-excursion (end-of-line)
2640 (setq colon-line-end (point)))
2641 (search-forward ":"))))
2642 ;; The first following code counts
2643 ;; if it is before the line we want to indent.
2644 (and (< (point) indent-point)
2645 (if (> colon-line-end (point)) ; After label
2646 (if (> (current-indentation)
2647 cperl-min-label-indent)
2648 (- (current-indentation) cperl-label-offset)
2649 ;; Do not believe: `max' is involved
2650 (+ old-indent cperl-indent-level))
2651 (current-column)))))
2652 ;; If no previous statement,
2653 ;; indent it relative to line brace is on.
2654 ;; For open brace in column zero, don't let statement
2655 ;; start there too. If cperl-indent-level is zero,
2656 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2657 ;; For open-braces not the first thing in a line,
2658 ;; add in cperl-brace-imaginary-offset.
2660 ;; If first thing on a line: ?????
2661 (+ (if (and (bolp) (zerop cperl-indent-level))
2662 (+ cperl-brace-offset cperl-continued-statement-offset)
2666 (not (eq char-after ?\})))
2668 ;; Now it is a hash reference
2669 (+ cperl-indent-level cperl-close-paren-offset))
2670 ;; Move back over whitespace before the openbrace.
2671 ;; If openbrace is not first nonwhite thing on the line,
2672 ;; add the cperl-brace-imaginary-offset.
2673 (progn (skip-chars-backward " \t")
2674 (if (bolp) 0 cperl-brace-imaginary-offset))
2675 ;; If the openbrace is preceded by a parenthesized exp,
2676 ;; move to the beginning of that;
2677 ;; possibly a different line
2679 (if (eq (preceding-char) ?\))
2681 ;; In the case it starts a subroutine, indent with
2682 ;; respect to `sub', not with respect to the
2683 ;; first thing on the line, say in the case of
2684 ;; anonymous sub in a hash.
2686 (skip-chars-backward " \t")
2687 (if (and (eq (preceding-char) ?b)
2690 (looking-at "sub\\>"))
2694 (save-excursion (beginning-of-line) (point))
2696 (progn (goto-char (1+ old-indent))
2697 (skip-chars-forward " \t")
2699 ;; Get initial indentation of the line we are on.
2700 ;; If line starts with label, calculate label indentation
2703 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2704 (if (> (current-indentation) cperl-min-label-indent)
2705 (- (current-indentation) cperl-label-offset)
2706 ;; Do not move `parse-data', this should
2708 (cperl-calculate-indent))
2709 (current-indentation))))))))))))))
2711 ;; (defvar cperl-indent-alist
2715 ;; (toplevel-after-parenth 2)
2716 ;; (toplevel-continued 2)
2718 ;; "Alist of indentation rules for CPerl mode.
2720 ;; nil: do not indent;
2721 ;; number: add this amount of indentation.
2723 ;; Not finished, not used.")
2725 ;; (defun cperl-where-am-i (&optional parse-start start-state)
2727 ;; "Return a list of lists ((TYPE POS)...) of good points before the point.
2728 ;; ;; POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2730 ;; ;; Not finished, not used."
2732 ;; (let* ((start-point (point))
2733 ;; (s-s (cperl-get-state))
2734 ;; (start (nth 0 s-s))
2735 ;; (state (nth 1 s-s))
2736 ;; (prestart (nth 3 s-s))
2737 ;; (containing-sexp (car (cdr state)))
2738 ;; (case-fold-search nil)
2739 ;; (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
2740 ;; (cond ((nth 3 state) ; In string
2741 ;; (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
2742 ;; ((nth 4 state) ; In comment
2743 ;; (setq res (cons '(comment) res)))
2744 ;; ((null containing-sexp)
2745 ;; ;; Line is at top level.
2746 ;; ;; Indent like the previous top level line
2747 ;; ;; unless that ends in a closeparen without semicolon,
2748 ;; ;; in which case this line is the first argument decl.
2749 ;; (cperl-backward-to-noncomment (or parse-start (point-min)))
2750 ;; ;;(skip-chars-backward " \t\f\n")
2753 ;; (memq (preceding-char) (append ";}" nil)))
2754 ;; (setq res (cons (list 'toplevel start) res)))
2755 ;; ((eq (preceding-char) ?\) )
2756 ;; (setq res (cons (list 'toplevel-after-parenth start) res)))
2758 ;; (setq res (cons (list 'toplevel-continued start) res)))))
2759 ;; ((/= (char-after containing-sexp) ?{)
2760 ;; ;; line is expression, not statement:
2761 ;; ;; indent to just after the surrounding open.
2762 ;; ;; skip blanks if we do not close the expression.
2763 ;; (setq res (cons (list 'expression-blanks
2765 ;; (goto-char (1+ containing-sexp))
2766 ;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2767 ;; (skip-chars-forward " \t"))
2769 ;; (cons (list 'expression containing-sexp) res))))
2771 ;; ;; Containing-expr starts with \{. Check whether it is a hash.
2772 ;; (goto-char containing-sexp)
2773 ;; (not (cperl-block-p)))
2774 ;; (setq res (cons (list 'expression-blanks
2776 ;; (goto-char (1+ containing-sexp))
2777 ;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2778 ;; (skip-chars-forward " \t"))
2780 ;; (cons (list 'expression containing-sexp) res))))
2782 ;; ;; Statement level.
2783 ;; (setq res (cons (list 'in-block containing-sexp) res))
2784 ;; ;; Is it a continuation or a new statement?
2785 ;; ;; Find previous non-comment character.
2786 ;; (cperl-backward-to-noncomment containing-sexp)
2787 ;; ;; Back up over label lines, since they don't
2788 ;; ;; affect whether our line is a continuation.
2789 ;; ;; Back up comma-delimited lines too ?????
2790 ;; (while (or (eq (preceding-char) ?\,)
2791 ;; (save-excursion (cperl-after-label)))
2792 ;; (if (eq (preceding-char) ?\,)
2793 ;; ;; Will go to beginning of line, essentially
2794 ;; ;; Will ignore embedded sexpr XXXX.
2795 ;; (cperl-backward-to-start-of-continued-exp containing-sexp))
2796 ;; (beginning-of-line)
2797 ;; (cperl-backward-to-noncomment containing-sexp))
2798 ;; ;; Now we get the answer.
2799 ;; (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
2800 ;; ;; This line is continuation of preceding line's statement.
2801 ;; (list (list 'statement-continued containing-sexp))
2802 ;; ;; This line starts a new statement.
2803 ;; ;; Position following last unclosed open.
2804 ;; (goto-char containing-sexp)
2805 ;; ;; Is line first statement after an open-brace?
2807 ;; ;; If no, find that first statement and indent like
2808 ;; ;; it. If the first statement begins with label, do
2809 ;; ;; not believe when the indentation of the label is too
2813 ;; (let ((colon-line-end 0))
2814 ;; (while (progn (skip-chars-forward " \t\n" start-point)
2815 ;; (and (< (point) start-point)
2817 ;; "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
2818 ;; ;; Skip over comments and labels following openbrace.
2819 ;; (cond ((= (following-char) ?\#)
2820 ;; ;;(forward-line 1)
2824 ;; (save-excursion (end-of-line)
2825 ;; (setq colon-line-end (point)))
2826 ;; (search-forward ":"))))
2827 ;; ;; Now at the point, after label, or at start
2828 ;; ;; of first statement in the block.
2829 ;; (and (< (point) start-point)
2830 ;; (if (> colon-line-end (point))
2831 ;; ;; Before statement after label
2832 ;; (if (> (current-indentation)
2833 ;; cperl-min-label-indent)
2834 ;; (list (list 'label-in-block (point)))
2835 ;; ;; Do not believe: `max' is involved
2837 ;; (list 'label-in-block-min-indent (point))))
2838 ;; ;; Before statement
2839 ;; (list 'statement-in-block (point))))))
2840 ;; ;; If no previous statement,
2841 ;; ;; indent it relative to line brace is on.
2842 ;; ;; For open brace in column zero, don't let statement
2843 ;; ;; start there too. If cperl-indent-level is zero,
2844 ;; ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2845 ;; ;; For open-braces not the first thing in a line,
2846 ;; ;; add in cperl-brace-imaginary-offset.
2848 ;; ;; If first thing on a line: ?????
2849 ;; (+ (if (and (bolp) (zerop cperl-indent-level))
2850 ;; (+ cperl-brace-offset cperl-continued-statement-offset)
2851 ;; cperl-indent-level)
2852 ;; ;; Move back over whitespace before the openbrace.
2853 ;; ;; If openbrace is not first nonwhite thing on the line,
2854 ;; ;; add the cperl-brace-imaginary-offset.
2855 ;; (progn (skip-chars-backward " \t")
2856 ;; (if (bolp) 0 cperl-brace-imaginary-offset))
2857 ;; ;; If the openbrace is preceded by a parenthesized exp,
2858 ;; ;; move to the beginning of that;
2859 ;; ;; possibly a different line
2861 ;; (if (eq (preceding-char) ?\))
2862 ;; (forward-sexp -1))
2863 ;; ;; Get initial indentation of the line we are on.
2864 ;; ;; If line starts with label, calculate label indentation
2865 ;; (if (save-excursion
2866 ;; (beginning-of-line)
2867 ;; (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2868 ;; (if (> (current-indentation) cperl-min-label-indent)
2869 ;; (- (current-indentation) cperl-label-offset)
2870 ;; (cperl-calculate-indent))
2871 ;; (current-indentation))))))))
2874 (defun cperl-calculate-indent-within-comment ()
2875 "Return the indentation amount for line, assuming that
2876 the current line is to be regarded as part of a block comment."
2877 (let (end star-start)
2880 (skip-chars-forward " \t")
2882 (and (= (following-char) ?#)
2884 (cperl-to-comment-or-eol)
2890 (defun cperl-to-comment-or-eol ()
2891 "Go to position before comment on the current line, or to end of line.
2892 Returns true if comment is found."
2893 (let (state stop-in cpoint (lim (progn (end-of-line) (point))))
2896 (eq (get-text-property (point) 'syntax-type) 'pod)
2897 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t))
2898 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
2900 (while (not stop-in)
2901 (setq state (parse-partial-sexp (point) lim nil nil nil t))
2903 ;; If fails (beginning-of-line inside sexp), then contains not-comment
2904 (if (nth 4 state) ; After `#';
2905 ; (nth 2 state) can be
2906 ; beginning of m,s,qq and so
2910 (setq cpoint (point))
2911 (goto-char (nth 2 state))
2913 ((looking-at "\\(s\\|tr\\)\\>")
2914 (or (re-search-forward
2915 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
2918 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
2919 (or (re-search-forward
2920 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
2923 (t ; It was fair comment
2924 (setq stop-in t) ; Finish
2925 (goto-char (1- cpoint)))))
2926 (setq stop-in t) ; Finish
2928 (setq stop-in t))) ; Finish
2931 (defsubst cperl-1- (p)
2932 (max (point-min) (1- p)))
2934 (defsubst cperl-1+ (p)
2935 (min (point-max) (1+ p)))
2937 (defsubst cperl-modify-syntax-type (at how)
2938 (if (< at (point-max))
2940 (put-text-property at (1+ at) 'syntax-table how)
2941 (put-text-property at (1+ at) 'rear-nonsticky t))))
2943 (defun cperl-protect-defun-start (s e)
2944 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2947 (while (re-search-forward "^\\s(" e 'to-end)
2948 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
2950 (defun cperl-commentify (bb e string &optional noface)
2951 (if cperl-use-syntax-table-text-property
2952 (if (eq noface 'n) ; Only immediate
2954 ;; We suppose that e is _after_ the end of construction, as after eol.
2955 (setq string (if string cperl-st-sfence cperl-st-cfence))
2957 ;; one-char string/comment?!
2958 (cperl-modify-syntax-type bb cperl-st-punct)
2959 (cperl-modify-syntax-type bb string)
2960 (cperl-modify-syntax-type (1- e) string))
2961 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
2962 (put-text-property (1+ bb) (1- e)
2963 'syntax-table cperl-string-syntax-table))
2964 (cperl-protect-defun-start bb e))
2967 (not cperl-pod-here-fontify)
2968 (put-text-property bb e 'face (if string 'font-lock-string-face
2969 'font-lock-comment-face)))))
2971 (defvar cperl-starters '(( ?\( . ?\) )
2976 (defun cperl-forward-re (lim end is-2arg set-st st-l err-l argument
2977 &optional ostart oend)
2978 ;; Works *before* syntax recognition is done
2979 ;; May modify syntax-type text property if the situation is too hard
2980 (let (b starter ender st i i2 go-forward reset-st)
2981 (skip-chars-forward " \t")
2982 ;; ender means matching-char matcher.
2984 starter (if (eobp) 0 (char-after b))
2985 ender (cdr (assoc starter cperl-starters)))
2986 ;; What if starter == ?\\ ????
2989 (setq st (car st-l))
2990 (setcar st-l (make-syntax-table))
2991 (setq i 0 st (car st-l))
2993 (modify-syntax-entry i "." st)
2995 (modify-syntax-entry ?\\ "\\" st)))
2997 ;; Whether we have an intermediate point
2999 ;; Prepare the syntax table:
3001 (if (not ender) ; m/blah/, s/x//, s/x/y/
3002 (modify-syntax-entry starter "$" st)
3003 (modify-syntax-entry starter (concat "(" (list ender)) st)
3004 (modify-syntax-entry ender (concat ")" (list starter)) st)))
3007 ;; We use `$' syntax class to find matching stuff, but $$
3008 ;; is recognized the same as $, so we need to check this manually.
3009 (if (and (eq starter (char-after (cperl-1+ b)))
3011 ;; $ has TeXish matching rules, so $$ equiv $...
3013 (setq reset-st (syntax-table))
3014 (set-syntax-table st)
3016 (if (<= (point) (1+ b))
3017 (error "Unfinished regular expression"))
3018 (set-syntax-table reset-st)
3020 ;; Now the problem is with m;blah;;
3022 (eq (preceding-char)
3023 (char-after (- (point) 2)))
3026 (= 0 (% (skip-chars-backward "\\\\") 2)))
3028 ;; Now we are after the first part.
3029 (and is-2arg ; Have trailing part
3031 (eq (following-char) starter) ; Empty trailing part
3033 (or (eq (char-syntax (following-char)) ?.)
3034 ;; Make trailing letter into punctuation
3035 (cperl-modify-syntax-type (point) cperl-st-punct))
3036 (setq is-2arg nil go-forward t))) ; Ignore the tail
3037 (if is-2arg ; Not number => have second part
3039 (setq i (point) i2 i)
3041 (if (memq (following-char) '(?\ ?\t ?\n ?\f))
3043 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3044 (goto-char (match-end 0))
3045 (skip-chars-forward " \t\n\f"))
3048 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3049 (if ender (modify-syntax-entry ender "." st))
3051 (setq ender (cperl-forward-re lim end nil t st-l err-l
3052 argument starter ender)
3053 ender (nth 2 ender)))))
3054 (error (goto-char lim)
3057 (set-syntax-table reset-st))
3060 "End of `%s%s%c ... %c' string/RE not found: %s"
3062 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3063 starter (or ender starter) bb)
3064 (or (car err-l) (setcar err-l b)))))
3067 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
3068 (if ender (modify-syntax-entry ender "." st))))
3069 ;; i: have 2 args, after end of the first arg
3070 ;; i2: start of the second arg, if any (before delim iff `ender').
3071 ;; ender: the last arg bounded by parens-like chars, the second one of them
3072 ;; starter: the starting delimiter of the first arg
3073 ;; go-forward: has 2 args, and the second part is empty
3074 (list i i2 ender starter go-forward)))
3076 (defvar font-lock-string-face)
3077 ;;(defvar font-lock-reference-face)
3078 (defvar font-lock-constant-face)
3079 (defsubst cperl-postpone-fontification (b e type val &optional now)
3080 ;; Do after syntactic fontification?
3081 (if cperl-syntaxify-by-font-lock
3082 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3083 (put-text-property b e type val)))
3085 ;;; Here is how the global structures (those which cannot be
3086 ;;; recognized locally) are marked:
3088 ;; Start-to-end is marked `in-pod' ==> t
3089 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3090 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3092 ;; Start-to-end is marked `here-doc-group' ==> t
3093 ;; The body is marked `syntax-type' ==> `here-doc'
3094 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3096 ;; First line (to =) marked `first-format-line' ==> t
3097 ;; After-this--to-end is marked `syntax-type' ==> `format'
3098 ;; d) 'Q'uoted string:
3099 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3100 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3102 (defun cperl-unwind-to-safe (before &optional end)
3103 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3104 (let ((pos (point)) opos)
3106 (while (and pos (get-text-property pos 'syntax-type))
3107 (setq pos (previous-single-property-change pos 'syntax-type))
3111 (goto-char (cperl-1- pos))
3114 (goto-char (setq pos (cperl-1- pos))))
3116 (goto-char (point-min))))
3118 (and (looking-at "\n*=")
3119 (/= 0 (skip-chars-backward "\n"))
3123 ;; Do the same for end, going small steps
3125 (while (and end (get-text-property end 'syntax-type))
3127 end (next-single-property-change end 'syntax-type)))
3130 (defvar cperl-nonoverridable-face)
3131 (defvar font-lock-function-name-face)
3132 (defvar font-lock-comment-face)
3134 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max)
3135 "Scans the buffer for hard-to-parse Perl constructions.
3136 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3137 the sections using `cperl-pod-head-face', `cperl-pod-face',
3140 (or min (setq min (point-min)
3141 cperl-syntax-state nil
3142 cperl-syntax-done-to min))
3143 (or max (setq max (point-max)))
3144 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3145 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3146 is-REx is-x-REx REx-comment-start REx-comment-end was-comment i2
3147 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3148 (modified (buffer-modified-p))
3149 (after-change-functions nil)
3150 (use-syntax-state (and cperl-syntax-state
3151 (>= min (car cperl-syntax-state))))
3152 (state-point (if use-syntax-state
3153 (car cperl-syntax-state)
3155 (state (if use-syntax-state
3156 (cdr cperl-syntax-state)))
3157 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3158 (st-l (list nil)) (err-l (list nil))
3159 ;; Somehow font-lock may be not loaded yet...
3160 (font-lock-string-face (if (boundp 'font-lock-string-face)
3161 font-lock-string-face
3162 'font-lock-string-face))
3163 (font-lock-constant-face (if (boundp 'font-lock-constant-face)
3164 font-lock-constant-face
3165 'font-lock-constant-face))
3166 (font-lock-function-name-face
3167 (if (boundp 'font-lock-function-name-face)
3168 font-lock-function-name-face
3169 'font-lock-function-name-face))
3170 (font-lock-comment-face
3171 (if (boundp 'font-lock-comment-face)
3172 font-lock-comment-face
3173 'font-lock-comment-face))
3174 (cperl-nonoverridable-face
3175 (if (boundp 'cperl-nonoverridable-face)
3176 cperl-nonoverridable-face
3177 'cperl-nonoverridable))
3178 (stop-point (if ignore-max
3183 "\\(\\`\n?\\|^\n\\)="
3185 ;; One extra () before this:
3188 ;; First variant "BLAH" or just ``.
3189 "[ \t]*" ; Yes, whitespace is allowed!
3190 "\\([\"'`]\\)" ; 2 + 1 = 3
3191 "\\([^\"'`\n]*\\)" ; 3 + 1
3194 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3195 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3196 ;; Do not have <<= or << 30 or <<30 or << $blah.
3197 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3198 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3201 ;; 1+6 extra () before this:
3202 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3203 (if cperl-use-syntax-table-text-property
3206 ;; 1+6+2=9 extra () before this:
3207 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3209 ;; 1+6+2+1=10 extra () before this:
3210 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3212 ;; 1+6+2+1+1=11 extra () before this:
3213 "\\<sub\\>[ \t]*\\([a-zA-Z_:'0-9]+[ \t]*\\)?\\(([^()]*)\\)"
3215 ;; 1+6+2+1+1+2=13 extra () before this:
3218 ;; 1+6+2+1+1+2+1=14 extra () before this:
3219 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3220 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3222 "__\\(END\\|DATA\\)__"
3223 ;; 1+6+2+1+1+2+1+1+1=16 extra () before this:
3225 "\\\\\\(['`\"($]\\)")
3231 (message "Scanning for \"hard\" Perl constructions..."))
3232 (and cperl-pod-here-fontify
3233 ;; We had evals here, do not know why...
3234 (setq face cperl-pod-face
3235 head-face cperl-pod-head-face
3236 here-face cperl-here-face))
3237 (remove-text-properties min max
3238 '(syntax-type t in-pod t syntax-table t
3245 ;; Need to remove face as well...
3247 (and (eq system-type 'emx)
3248 (looking-at "extproc[ \t]") ; Analogue of #!
3249 (cperl-commentify min
3250 (save-excursion (end-of-line) (point))
3254 (re-search-forward search max t))
3255 (setq tmpend nil) ; Valid for most cases
3257 ((match-beginning 1) ; POD section
3258 ;; "\\(\\`\n?\\|^\n\\)="
3259 (if (looking-at "cut\\>")
3261 nil ; Doing a chunk only
3262 (message "=cut is not preceded by a POD section")
3263 (or (car err-l) (setcar err-l (point))))
3268 tb (match-beginning 0)
3269 b1 nil) ; error condition
3270 ;; We do not search to max, since we may be called from
3271 ;; some hook of fontification, and max is random
3272 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
3275 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
3277 (message "=cut is not preceded by an empty line")
3279 (or (car err-l) (setcar err-l b))))))
3280 (beginning-of-line 2) ; An empty line after =cut is not POD!
3284 (remove-text-properties
3285 max e '(syntax-type t in-pod t syntax-table t
3293 (put-text-property b e 'in-pod t)
3294 (put-text-property b e 'syntax-type 'in-pod)
3296 (while (re-search-forward "\n\n[ \t]" e t)
3297 ;; We start 'pod 1 char earlier to include the preceding line
3299 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3300 (cperl-put-do-not-fontify b (point) t)
3301 ;; mark the non-literal parts as PODs
3302 (if cperl-pod-here-fontify
3303 (cperl-postpone-fontification b (point) 'face face t))
3304 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3307 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3308 (cperl-put-do-not-fontify (point) e t)
3309 (if cperl-pod-here-fontify
3311 ;; mark the non-literal parts as PODs
3312 (cperl-postpone-fontification (point) e 'face face t)
3315 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3317 (cperl-postpone-fontification
3318 (match-beginning 1) (match-end 1)
3320 (while (re-search-forward
3322 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3325 (cperl-postpone-fontification
3326 (match-beginning 1) (match-end 1)
3328 (cperl-commentify bb e nil)
3330 (or (eq e (point-max))
3331 (forward-char -1)))) ; Prepare for immediate POD start.
3333 ;; We do only one here-per-line
3334 ;; ;; One extra () before this:
3337 ;; ;; First variant "BLAH" or just ``.
3338 ;; "[ \t]*" ; Yes, whitespace is allowed!
3339 ;; "\\([\"'`]\\)" ; 2 + 1
3340 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3343 ;; ;; Second variant: Identifier or \ID or empty
3344 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3345 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3346 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3347 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3349 ((match-beginning 2) ; 1 + 1
3350 ;; Abort in comment:
3352 (setq state (parse-partial-sexp state-point b nil nil state)
3354 tb (match-beginning 0)
3355 i (or (nth 3 state) (nth 4 state)))
3360 (not (match-beginning 6)) ; Empty
3362 "[ \t]*[=0-9$@%&(]"))))
3363 (if c ; Not here-doc
3365 (if (match-beginning 5) ;4 + 1
3366 (setq b1 (match-beginning 5) ; 4 + 1
3367 e1 (match-end 5)) ; 4 + 1
3368 (setq b1 (match-beginning 4) ; 3 + 1
3369 e1 (match-end 4))) ; 3 + 1
3370 (setq tag (buffer-substring b1 e1)
3371 qtag (regexp-quote tag))
3372 (cond (cperl-pod-here-fontify
3373 ;; Highlight the starting delimiter
3374 (cperl-postpone-fontification b1 e1 'face font-lock-constant-face)
3375 (cperl-put-do-not-fontify b1 e1 t)))
3378 ;; We do not search to max, since we may be called from
3379 ;; some hook of fontification, and max is random
3380 (or (and (re-search-forward (concat "^" qtag "$")
3382 (eq (following-char) ?\n))
3383 (progn ; Pretend we matched at the end
3384 (goto-char (point-max))
3385 (re-search-forward "\\'")
3386 (message "End of here-document `%s' not found." tag)
3387 (or (car err-l) (setcar err-l b))))
3388 (if cperl-pod-here-fontify
3390 ;; Highlight the ending delimiter
3391 (cperl-postpone-fontification (match-beginning 0) (match-end 0)
3392 'face font-lock-constant-face)
3393 (cperl-put-do-not-fontify b (match-end 0) t)
3394 ;; Highlight the HERE-DOC
3395 (cperl-postpone-fontification b (match-beginning 0)
3397 (setq e1 (cperl-1+ (match-end 0)))
3398 (put-text-property b (match-beginning 0)
3399 'syntax-type 'here-doc)
3400 (put-text-property (match-beginning 0) e1
3401 'syntax-type 'here-doc-delim)
3402 (put-text-property b e1
3404 (cperl-commentify b e1 nil)
3405 (cperl-put-do-not-fontify b (match-end 0) t)
3409 ((match-beginning 8)
3410 ;; 1+6=7 extra () before this:
3411 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3413 name (if (match-beginning 8) ; 7 + 1
3414 (buffer-substring (match-beginning 8) ; 7 + 1
3415 (match-end 8)) ; 7 + 1
3417 tb (match-beginning 0))
3419 (put-text-property (save-excursion
3422 b 'first-format-line 't)
3423 (if cperl-pod-here-fontify
3424 (while (and (eq (forward-line) 0)
3425 (not (looking-at "^[.;]$")))
3427 ((looking-at "^#")) ; Skip comments
3428 ((and argument ; Skip argument multi-lines
3429 (looking-at "^[ \t]*{"))
3431 (setq argument nil))
3432 (argument ; Skip argument lines
3433 (setq argument nil))
3436 (setq argument (looking-at "^[^\n]*[@^]"))
3438 ;; Highlight the format line
3439 (cperl-postpone-fontification b1 (point)
3440 'face font-lock-string-face)
3441 (cperl-commentify b1 (point) nil)
3442 (cperl-put-do-not-fontify b1 (point) t))))
3443 ;; We do not search to max, since we may be called from
3444 ;; some hook of fontification, and max is random
3445 (re-search-forward "^[.;]$" stop-point 'toend))
3447 (if (looking-at "^\\.$") ; ";" is not supported yet
3449 ;; Highlight the ending delimiter
3450 (cperl-postpone-fontification (point) (+ (point) 2)
3451 'face font-lock-string-face)
3452 (cperl-commentify (point) (+ (point) 2) nil)
3453 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
3454 (message "End of format `%s' not found." name)
3455 (or (car err-l) (setcar err-l b)))
3459 (put-text-property b (point) 'syntax-type 'format))
3461 ((or (match-beginning 10) (match-beginning 11))
3462 ;; 1+6+2=9 extra () before this:
3463 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3465 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3466 (setq b1 (if (match-beginning 10) 10 11)
3467 argument (buffer-substring
3468 (match-beginning b1) (match-end b1))
3471 c (char-after (match-beginning b1))
3472 bb (char-after (1- (match-beginning b1))) ; tmp holder
3473 ;; bb == "Not a stringy"
3474 bb (if (eq b1 10) ; user variables/whatever
3475 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
3476 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
3477 ((eq bb ?\:) ; $opt::s
3479 (- (match-beginning b1) 2))
3481 ((eq bb ?\>) ; $foo->s
3483 (- (match-beginning b1) 2))
3486 (not (eq (char-after ; &&m/blah/
3487 (- (match-beginning b1) 2))
3490 ;; <file> or <$file>
3492 ;; Do not stringify <FH>, <$fh> :
3495 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
3496 tb (match-beginning 0))
3497 (goto-char (match-beginning b1))
3498 (cperl-backward-to-noncomment (point-min))
3500 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
3506 ;; What is below: regexp-p?
3508 (or (memq (preceding-char)
3509 (append (if (memq c '(?\? ?\<))
3512 "~{(=|&+-*!,;:") nil))
3513 (and (eq (preceding-char) ?\})
3514 (cperl-after-block-p (point-min)))
3515 (and (eq (char-syntax (preceding-char)) ?w)
3518 ;; After these keywords `/' starts a RE. One should add all the
3519 ;; functions/builtins which expect an argument, but ...
3520 (if (eq (preceding-char) ?-)
3522 (looking-at "[a-zA-Z]\\>")
3524 (not (memq (preceding-char)
3527 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
3528 (and (eq (preceding-char) ?.)
3529 (eq (char-after (- (point) 2)) ?.))
3531 ;; m|blah| ? foo : bar;
3534 cperl-use-syntax-table-text-property
3538 (looking-at "\\s|")))))))
3541 ;; Check for $a -> y
3542 (setq b1 (preceding-char)
3545 (eq (char-after (- go 2)) ?-))
3548 (or bb (setq state (parse-partial-sexp
3549 state-point b nil nil state)
3551 (setq bb (or bb (nth 3 state) (nth 4 state)))
3555 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3556 (goto-char (match-end 0))
3557 (skip-chars-forward " \t\n\f"))
3558 (cond ((and (eq (following-char) ?\})
3560 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
3562 (skip-chars-backward " \t\n\f")
3563 (if (memq (preceding-char) (append "$@%&*" nil))
3569 (looking-at ; $foo -> {s}
3570 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
3571 (and ; $foo[12] -> {s}
3572 (memq (following-char) '(?\{ ?\[))
3575 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
3578 ((and (eq (following-char) ?=)
3579 (eq (char-after (1+ (point))) ?\>))
3580 ;; Check for { foo => 1, s => 2 }
3581 ;; Apparently s=> is never a substitution...
3583 ((and (eq (following-char) ?:)
3584 (eq b1 ?\{) ; Check for $ { s::bar }
3585 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
3588 (skip-chars-backward " \t\n\f")
3589 (memq (preceding-char)
3590 (append "$@%&*" nil))))
3594 ;; Skip whitespace and comments...
3595 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3596 (goto-char (match-end 0))
3597 (skip-chars-forward " \t\n\f"))
3599 (put-text-property b (point) 'syntax-type 'prestring))
3600 ;; qtag means two-arg matcher, may be reset to
3601 ;; 2 or 3 later if some special quoting is needed.
3602 ;; e1 means matching-char matcher.
3605 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
3606 ;; We do not search to max, since we may be called from
3607 ;; some hook of fontification, and max is random
3608 i (cperl-forward-re stop-point end
3610 t st-l err-l argument)
3611 ;; Note that if `go', then it is considered as 1-arg
3612 b1 (nth 1 i) ; start of the second part
3613 tag (nth 2 i) ; ender-char, true if second part
3614 ; is with matching chars []
3615 go (nth 4 i) ; There is a 1-char part after the end
3616 i (car i) ; intermediate point
3618 ;; Before end of the second part if non-matching: ///
3619 tail (if (and i (not tag))
3621 e (if i i e1) ; end of the first part
3622 qtag nil ; need to preserve backslashitis
3623 is-x-REx nil) ; REx has //x modifier
3624 ;; Commenting \\ is dangerous, what about ( ?
3626 (eq (char-after i) ?\\)
3628 (if (looking-at "\\sw*x") ; qr//x
3631 ;; Considered as 1arg form
3633 (cperl-commentify b (point) t)
3634 (put-text-property b (point) 'syntax-type 'string)
3636 ;; ignore other text properties:
3637 (string-match "^qw$" argument))
3638 (put-text-property b (point) 'indentable t))
3640 (setq e1 (cperl-1+ e1))
3643 (cperl-commentify b i t)
3644 (if (looking-at "\\sw*e") ; s///e
3648 (cperl-find-pods-heres b1 (1- (point)) t end)
3650 (goto-char (1+ max)))
3651 (if (and tag (eq (preceding-char) ?\>))
3653 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
3654 (cperl-modify-syntax-type i cperl-st-bra)))
3655 (put-text-property b i 'syntax-type 'string)
3657 (put-text-property b i 'indentable t)))
3658 (cperl-commentify b1 (point) t)
3659 (put-text-property b (point) 'syntax-type 'string)
3661 (put-text-property b i 'indentable t))
3663 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
3665 ;; Now: tail: if the second part is non-matching without ///e
3666 (if (eq (char-syntax (following-char)) ?w)
3668 (forward-word 1) ; skip modifiers s///s
3669 (if tail (cperl-commentify tail (point) t))
3670 (cperl-postpone-fontification
3671 e1 (point) 'face 'cperl-nonoverridable)))
3672 ;; Check whether it is m// which means "previous match"
3673 ;; and highlight differently
3675 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
3676 (or (not (= (length argument) 0))
3680 ;; split // *is* using zero-pattern
3686 (not (looking-at "split\\>")))
3688 (cperl-postpone-fontification
3689 b e 'face font-lock-function-name-face)
3690 (if (or i2 ; Has 2 args
3691 (and cperl-fontify-m-as-s
3693 (string-match "^\\(m\\|qr\\)$" argument)
3694 (and (eq 0 (length argument))
3695 (not (eq ?\< (char-after b)))))))
3697 (cperl-postpone-fontification
3698 b (cperl-1+ b) 'face font-lock-constant-face)
3699 (cperl-postpone-fontification
3700 (1- e) e 'face font-lock-constant-face)))
3701 (if (and is-REx cperl-regexp-scan)
3702 ;; Process RExen better
3709 (if (eq (char-after b) ?\#)
3710 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
3711 "\\((\\?#\\)\\|\\(#\\)")
3712 (if (eq (char-after b) ?\#)
3716 (goto-char (match-beginning 0))
3717 (setq REx-comment-start (point)
3721 ;; XXX not working if outside delimiter is #
3722 (eq (preceding-char) ?\\)
3723 (= (% (skip-chars-backward "$\\\\") 2) -1)))
3724 ;; Not a comment, avoid loop:
3725 (progn (setq was-comment nil)
3727 (if (match-beginning 2)
3729 (beginning-of-line 2)
3731 (goto-char (1- e))))
3732 ;; Works also if the outside delimiters are ().
3733 (or (search-forward ")" (1- e) 'toend)
3735 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
3736 REx-comment-start))))
3741 (setq REx-comment-end (point))
3743 REx-comment-start REx-comment-end nil)
3744 (cperl-postpone-fontification
3745 REx-comment-start REx-comment-end
3746 'face font-lock-comment-face))))))
3747 (if (and is-REx is-x-REx)
3748 (put-text-property (1+ b) (1- e)
3749 'syntax-subtype 'x-REx)))
3752 (cperl-postpone-fontification
3753 (1- e1) e1 'face font-lock-constant-face)
3754 (if (assoc (char-after b) cperl-starters)
3755 (cperl-postpone-fontification
3756 b1 (1+ b1) 'face font-lock-constant-face))))
3759 ((match-beginning 13) ; sub with prototypes
3760 (setq b (match-beginning 0))
3761 (if (memq (char-after (1- b))
3762 '(?\$ ?\@ ?\% ?\& ?\*))
3764 (setq state (parse-partial-sexp
3765 state-point b nil nil state)
3767 (if (or (nth 3 state) (nth 4 state))
3770 (cperl-commentify (match-beginning 13) (match-end 13) t))
3771 (goto-char (match-end 0))))
3772 ;; 1+6+2+1+1+2=13 extra () before this:
3774 ((and (match-beginning 14)
3775 (eq (preceding-char) ?\')) ; $'
3776 (setq b (1- (point))
3777 state (parse-partial-sexp
3778 state-point (1- b) nil nil state)
3780 (if (nth 3 state) ; in string
3781 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3783 ;; 1+6+2+1+1+2=13 extra () before this:
3785 ((match-beginning 14) ; ${
3786 (setq bb (match-beginning 0))
3787 (cperl-modify-syntax-type bb cperl-st-punct))
3788 ;; 1+6+2+1+1+2+1=14 extra () before this:
3789 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3790 ((match-beginning 15) ; old $abc'efg syntax
3791 (setq bb (match-end 0)
3792 b (match-beginning 0)
3793 state (parse-partial-sexp
3794 state-point b nil nil state)
3796 (if (nth 3 state) ; in string
3798 (put-text-property (1- bb) bb 'syntax-table cperl-st-word))
3800 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3801 ;; "__\\(END\\|DATA\\)__"
3802 ((match-beginning 16) ; __END__, __DATA__
3803 (setq bb (match-end 0)
3804 b (match-beginning 0)
3805 state (parse-partial-sexp
3806 state-point b nil nil state)
3808 (if (or (nth 3 state) (nth 4 state))
3810 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3811 (cperl-commentify b bb nil)
3814 ((match-beginning 17) ; "\\\\\\(['`\"($]\\)"
3815 ;; Trailing backslash ==> non-quoting outside string/comment
3816 (setq bb (match-end 0)
3817 b (match-beginning 0))
3819 (skip-chars-backward "\\\\")
3820 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
3821 (setq state (parse-partial-sexp
3822 state-point b nil nil state)
3824 (if (or (nth 3 state) (nth 4 state) )
3826 (cperl-modify-syntax-type b cperl-st-punct))
3828 (t (error "Error in regexp of the sniffer")))
3829 (if (> (point) stop-point)
3832 (message "Garbage after __END__/__DATA__ ignored")
3833 (message "Unbalanced syntax found while scanning")
3834 (or (car err-l) (setcar err-l b)))
3835 (goto-char stop-point))))
3836 (setq cperl-syntax-state (cons state-point state)
3837 cperl-syntax-done-to (or tmpend (max (point) max))))
3838 (if (car err-l) (goto-char (car err-l))
3840 (message "Scanning for \"hard\" Perl constructions... done"))))
3841 (and (buffer-modified-p)
3843 (set-buffer-modified-p nil))
3844 ;; I do not understand what this is doing here. It breaks font-locking
3845 ;; because it resets the syntax-table from font-lock-syntax-table to
3846 ;; cperl-mode-syntax-table.
3847 ;; (set-syntax-table cperl-mode-syntax-table)
3851 (defun cperl-backward-to-noncomment (lim)
3852 ;; Stops at lim or after non-whitespace that is not in comment
3854 (while (and (not stop) (> (point) (or lim 1)))
3855 (skip-chars-backward " \t\n\f" lim)
3858 (if (memq (setq pr (get-text-property (point) 'syntax-type))
3859 '(pod here-doc here-doc-delim))
3860 (cperl-unwind-to-safe nil)
3861 (or (looking-at "^[ \t]*\\(#\\|$\\)")
3862 (progn (cperl-to-comment-or-eol) (bolp))
3864 (skip-chars-backward " \t")
3865 (if (< p (point)) (goto-char p))
3868 (defun cperl-after-block-p (lim &optional pre-block)
3869 "Return true if the preceeding } ends a block or a following { starts one.
3870 Would not look before LIM. If PRE-BLOCK is nil checks preceeding }.
3871 otherwise following {."
3872 ;; We suppose that the preceding char is }.
3876 (or pre-block (forward-sexp -1))
3877 (cperl-backward-to-noncomment lim)
3878 (or (eq (point) lim)
3879 (eq (preceding-char) ?\) ) ; if () {} sub f () {}
3880 (if (eq (char-syntax (preceding-char)) ?w) ; else {}
3883 (or (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
3886 (cperl-backward-to-noncomment lim)
3887 (and (eq (char-syntax (preceding-char)) ?w)
3890 (looking-at "sub\\>"))))))
3891 (cperl-after-expr-p lim))))
3894 (defun cperl-after-expr-p (&optional lim chars test)
3895 "Return true if the position is good for start of expression.
3896 TEST is the expression to evaluate at the found position. If absent,
3897 CHARS is a string that contains good characters to have before us (however,
3898 `}' is treated \"smartly\" if it is not in the list)."
3899 (let ((lim (or lim (point-min)))
3901 (cperl-update-syntaxification (point) (point))
3903 (while (and (not stop) (> (point) lim))
3904 (skip-chars-backward " \t\n\f" lim)
3907 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
3908 ;; '(pod here-doc here-doc-delim))
3909 (if (get-text-property (point) 'here-doc-group)
3912 (previous-single-property-change (point) 'here-doc-group))
3913 (beginning-of-line 0)))
3914 (if (get-text-property (point) 'in-pod)
3917 (previous-single-property-change (point) 'in-pod))
3918 (beginning-of-line 0)))
3919 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
3920 ;; Else: last iteration, or a label
3921 (cperl-to-comment-or-eol) ; Will not move past "." after a format
3922 (skip-chars-backward " \t")
3923 (if (< p (point)) (goto-char p))
3925 (if (and (eq (preceding-char) ?:)
3928 (skip-chars-backward " \t\n\f" lim)
3929 (eq (char-syntax (preceding-char)) ?w)))
3930 (forward-sexp -1) ; Possibly label. Skip it
3933 (or (bobp) ; ???? Needed
3935 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
3937 (if test (eval test)
3938 (or (memq (preceding-char) (append (or chars "{;") nil))
3939 (and (eq (preceding-char) ?\})
3940 (cperl-after-block-p lim))
3941 (and (eq (following-char) ?.) ; in format: see comment above
3942 (eq (get-text-property (point) 'syntax-type)
3945 (defun cperl-backward-to-start-of-continued-exp (lim)
3946 (if (memq (preceding-char) (append ")]}\"'`" nil))
3949 (if (<= (point) lim)
3950 (goto-char (1+ lim)))
3951 (skip-chars-forward " \t"))
3953 (defun cperl-after-block-and-statement-beg (lim)
3954 ;; We assume that we are after ?\}
3956 (cperl-after-block-p lim)
3959 (cperl-backward-to-noncomment (point-min))
3962 (not (= (char-syntax (preceding-char)) ?w))
3967 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
3970 (defun cperl-indent-exp ()
3971 "Simple variant of indentation of continued-sexp.
3973 Will not indent comment if it starts at `comment-indent' or looks like
3974 continuation of the comment on the previous line.
3976 If `cperl-indent-region-fix-constructs', will improve spacing on
3977 conditional/loop constructs."
3980 (let ((tmp-end (progn (end-of-line) (point))) top done)
3985 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
3987 (setq top (point))) ; Get the outermost parenths in line
3989 (while (< (point) tmp-end)
3990 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
3991 (or (eolp) (forward-sexp 1)))
3992 (if (> (point) tmp-end)
3995 (setq tmp-end (point)))
3998 (setq tmp-end (point-marker)))
3999 (if cperl-indent-region-fix-constructs
4000 (cperl-fix-line-spacing tmp-end))
4001 (cperl-indent-region (point) tmp-end))))
4003 (defun cperl-fix-line-spacing (&optional end parse-data)
4004 "Improve whitespace in a conditional/loop construct.
4005 Returns some position at the last line."
4008 (setq end (point-max)))
4009 (let ((ee (save-excursion (end-of-line) (point)))
4010 (cperl-indent-region-fix-constructs
4011 (or cperl-indent-region-fix-constructs 1))
4012 p pp ml have-brace ret)
4019 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
4020 (setq have-brace (save-excursion (search-forward "}" ee t)))))
4021 nil ; Do not need to do anything
4025 (if (and cperl-merge-trailing-else
4027 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
4029 (search-forward "}")
4031 (skip-chars-forward " \t\n")
4032 (delete-region p (point))
4033 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4034 (beginning-of-line)))
4037 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
4039 (search-forward "}")
4040 (delete-horizontal-space)
4041 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4042 (beginning-of-line)))
4046 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4049 (delete-horizontal-space)
4050 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4051 (beginning-of-line)))
4055 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
4058 (delete-horizontal-space)
4059 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
4060 (beginning-of-line)))
4062 ;; foreach my $var (
4064 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4067 (delete-horizontal-space)
4069 (make-string cperl-indent-region-fix-constructs ?\ ))
4070 (beginning-of-line)))
4072 ;; } foreach my $var () {
4074 "[ \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]*{")
4076 (setq ml (match-beginning 8))
4077 (re-search-forward "[({]")
4080 (if (eq (following-char) ?\( )
4084 ;; after `else' or nothing
4085 (if ml ; after `else'
4086 (skip-chars-backward " \t\n")
4087 (beginning-of-line))
4089 ;; Now after the sexp before the brace
4090 ;; Multiline expr should be special
4091 (setq ml (and pp (save-excursion (goto-char p)
4092 (search-forward "\n" pp t))))
4093 (if (and (or (not pp) (< pp end))
4094 (looking-at "[ \t\n]*{"))
4097 ((bolp) ; Were before `{', no if/else/etc
4099 ((looking-at "\\(\t*\\| [ \t]+\\){")
4100 (delete-horizontal-space)
4102 cperl-extra-newline-before-brace-multiline
4103 cperl-extra-newline-before-brace)
4105 (delete-horizontal-space)
4108 (if (cperl-indent-line parse-data)
4110 (cperl-fix-line-spacing end parse-data)
4111 (setq ret (point)))))
4113 (make-string cperl-indent-region-fix-constructs ?\ ))))
4114 ((and (looking-at "[ \t]*\n")
4116 cperl-extra-newline-before-brace-multiline
4117 cperl-extra-newline-before-brace)))
4119 (skip-chars-forward " \t\n")
4120 (delete-region pp (point))
4122 (make-string cperl-indent-region-fix-constructs ?\ ))))
4123 ;; Now we are before `{'
4124 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
4126 (skip-chars-forward " \t\n")
4131 (setq ml (search-forward "\n" p t))
4132 (if (or cperl-break-one-line-blocks-when-indent ml)
4133 ;; not good: multi-line BLOCK
4136 (delete-horizontal-space)
4139 (if (cperl-indent-line parse-data)
4140 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
4142 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
4143 ;; Now check whether there is a hanging `}'
4147 cperl-fix-hanging-brace-when-indent
4149 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
4153 (if (and (<= (point) pp)
4154 (eq (preceding-char) ?\} )
4155 (cperl-after-block-and-statement-beg (point-min)))
4162 (skip-chars-backward " \t")
4164 ;; `}' was the first thing on the line, insert NL *after* it.
4166 (cperl-indent-line parse-data)
4167 (search-forward "}")
4168 (delete-horizontal-space)
4170 (delete-horizontal-space)
4171 (or (eq (preceding-char) ?\;)
4173 (and (eq (preceding-char) ?\} )
4174 (cperl-after-block-p (point-min)))
4178 (if (cperl-indent-line parse-data)
4179 (setq ret (cperl-fix-line-spacing end parse-data)))
4180 (beginning-of-line)))))
4183 (defvar cperl-update-start) ; Do not need to make them local
4184 (defvar cperl-update-end)
4185 (defun cperl-delay-update-hook (beg end old-len)
4186 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
4187 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
4189 (defun cperl-indent-region (start end)
4190 "Simple variant of indentation of region in CPerl mode.
4191 Should be slow. Will not indent comment if it starts at `comment-indent'
4192 or looks like continuation of the comment on the previous line.
4193 Indents all the lines whose first character is between START and END
4196 If `cperl-indent-region-fix-constructs', will improve spacing on
4197 conditional/loop constructs."
4199 (cperl-update-syntaxification end end)
4201 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
4202 (let ((indent-info (if cperl-emacs-can-parse
4203 (list nil nil nil) ; Cannot use '(), since will modify
4206 after-change-functions ; Speed it up!
4207 st comm old-comm-indent new-comm-indent p pp i empty)
4208 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
4210 (setq old-comm-indent (and (cperl-to-comment-or-eol)
4212 new-comm-indent old-comm-indent)
4214 (setq end (set-marker (make-marker) end)) ; indentation changes pos
4215 (or (bolp) (beginning-of-line 2))
4216 (while (and (<= (point) end) (not (eobp))) ; bol to check start
4219 (setq empty (looking-at "[ \t]*\n"))
4220 (and (setq comm (looking-at "[ \t]*#"))
4221 (or (eq (current-indentation) (or old-comm-indent
4223 (setq old-comm-indent nil))))
4224 (if (and old-comm-indent
4226 (= (current-indentation) old-comm-indent)
4227 (not (eq (get-text-property (point) 'syntax-type) 'pod))
4228 (not (eq (get-text-property (point) 'syntax-table)
4230 (let ((comment-column new-comm-indent))
4231 (indent-for-comment)))
4233 (setq i (cperl-indent-line indent-info))
4237 (if cperl-indent-region-fix-constructs
4238 (goto-char (cperl-fix-line-spacing end indent-info)))
4239 (if (setq old-comm-indent
4240 (and (cperl-to-comment-or-eol)
4241 (not (memq (get-text-property (point)
4244 (not (eq (get-text-property (point)
4248 (progn (indent-for-comment)
4249 (skip-chars-backward " \t")
4250 (skip-chars-backward "#")
4251 (setq new-comm-indent (current-column))))))))
4252 (beginning-of-line 2)))
4253 ;; Now run the update hooks
4254 (and after-change-functions
4257 (goto-char cperl-update-end)
4260 (goto-char cperl-update-start)
4262 (delete-char -1))))))
4264 ;; Stolen from lisp-mode with a lot of improvements
4266 (defun cperl-fill-paragraph (&optional justify iteration)
4267 "Like `fill-paragraph', but handle CPerl comments.
4268 If any of the current line is a comment, fill the comment or the
4269 block of it that point is in, preserving the comment's initial
4270 indentation and initial hashes. Behaves usually outside of comment."
4271 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
4272 (let (;; Non-nil if the current line contains a comment.
4275 ;; If has-comment, the appropriate fill-prefix for the comment.
4277 ;; Line that contains code and comment (or nil)
4279 c spaces len dc (comment-column comment-column))
4280 ;; Figure out what kind of comment we are looking at.
4285 ;; A line with nothing but a comment on it?
4286 ((looking-at "[ \t]*#[# \t]*")
4288 comment-fill-prefix (buffer-substring (match-beginning 0)
4291 ;; A line with some code, followed by a comment? Remember that the
4292 ;; semi which starts the comment shouldn't be part of a string or
4294 ((cperl-to-comment-or-eol)
4295 (setq has-comment t)
4296 (looking-at "#+[ \t]*")
4297 (setq start (point) c (current-column)
4299 (concat (make-string (current-column) ?\ )
4300 (buffer-substring (match-beginning 0) (match-end 0)))
4301 spaces (progn (skip-chars-backward " \t")
4302 (buffer-substring (point) start))
4303 dc (- c (current-column)) len (- start (point))
4304 start (point-marker))
4306 (insert (make-string dc ?-)))))
4307 (if (not has-comment)
4308 (fill-paragraph justify) ; Do the usual thing outside of comment
4309 ;; Narrow to include only the comment, and then fill the region.
4312 ;; Find the first line we should include in the region to fill.
4313 (if start (progn (beginning-of-line) (point))
4315 (while (and (zerop (forward-line -1))
4316 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4317 ;; We may have gone to far. Go forward again.
4318 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
4321 ;; Find the beginning of the first line past the region to fill.
4323 (while (progn (forward-line 1)
4324 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4326 ;; Remove existing hashes
4328 (goto-char (point-min))
4329 (while (progn (forward-line 1) (< (point) (point-max)))
4330 (skip-chars-forward " \t")
4331 (and (looking-at "#+")
4332 (delete-char (- (match-end 0) (match-beginning 0))))))
4334 ;; Lines with only hashes on them can be paragraph boundaries.
4335 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
4336 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
4337 (fill-prefix comment-fill-prefix))
4338 (fill-paragraph justify)))
4343 (progn (delete-char dc) (insert spaces)))
4344 (if (or (= (current-column) c) iteration) nil
4345 (setq comment-column c)
4346 (indent-for-comment)
4347 ;; Repeat once more, flagging as iteration
4348 (cperl-fill-paragraph justify t)))))))
4350 (defun cperl-do-auto-fill ()
4351 ;; Break out if the line is short enough
4352 (if (> (save-excursion
4356 (let ((c (save-excursion (beginning-of-line)
4357 (cperl-to-comment-or-eol) (point)))
4358 (s (memq (following-char) '(?\ ?\t))) marker)
4360 ;; Don't break line inside code: only inside comment.
4362 (setq marker (point-marker))
4363 (fill-paragraph nil)
4365 ;; Is not enough, sometimes marker is a start of line
4366 (if (bolp) (progn (re-search-forward "#+[ \t]*")
4367 (goto-char (match-end 0))))
4368 ;; Following space could have gone:
4369 (if (or (not s) (memq (following-char) '(?\ ?\t))) nil
4372 ;; Previous space could have gone:
4373 (or (memq (preceding-char) '(?\ ?\t)) (insert " "))))))
4375 (defun cperl-imenu-addback (lst &optional isback name)
4376 ;; We suppose that the lst is a DAG, unless the first element only
4377 ;; loops back, and ISBACK is set. Thus this function cannot be
4378 ;; applied twice without ISBACK set.
4379 (cond ((not cperl-imenu-addback) lst)
4382 (setq name "+++BACK+++"))
4383 (mapcar (lambda (elt)
4384 (if (and (listp elt) (listp (cdr elt)))
4386 ;; In the other order it goes up
4387 ;; one level only ;-(
4388 (setcdr elt (cons (cons name lst)
4390 (cperl-imenu-addback (cdr elt) t name))))
4391 (if isback (cdr lst) lst))
4394 (defun cperl-imenu--create-perl-index (&optional regexp)
4395 (require 'imenu) ; May be called from TAGS creator
4396 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
4397 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
4398 (index-meth-alist '()) meth
4399 packages ends-ranges p marker
4400 (prev-pos 0) char fchar index index1 name (end-range 0) package)
4401 (goto-char (point-min))
4402 (cperl-update-syntaxification (point-max) (point-max))
4403 ;; Search for the function
4404 (progn ;;save-match-data
4405 (while (re-search-forward
4406 (or regexp cperl-imenu--function-name-regexp-perl)
4409 ((and ; Skip some noise if building tags
4410 (match-beginning 2) ; package or sub
4411 (eq (char-after (match-beginning 2)) ?p) ; package
4412 (not (save-match-data
4413 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
4416 (match-beginning 2) ; package or sub
4417 ;; Skip if quoted (will not skip multi-line ''-strings :-():
4418 (null (get-text-property (match-beginning 1) 'syntax-table))
4419 (null (get-text-property (match-beginning 1) 'syntax-type))
4420 (null (get-text-property (match-beginning 1) 'in-pod)))
4422 (goto-char (match-beginning 2))
4423 (setq fchar (following-char)))
4424 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4425 ;; (goto-char (match-end 0))) ; Messes what follows
4426 (setq char (following-char) ; ?\; for "sub foo () ;"
4429 (while (and ends-ranges (>= p (car ends-ranges)))
4430 ;; delete obsolete entries
4431 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
4432 (setq package (or (car packages) "")
4433 end-range (or (car ends-ranges) 0))
4435 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4437 (set-text-properties 0 (length name) nil name)
4439 package (concat name "::")
4440 name (concat "package " name)
4443 (parse-partial-sexp (point) (point-max) -1) (point))
4444 ends-ranges (cons end-range ends-ranges)
4445 packages (cons package packages)))
4447 ;; Skip this function name if it is a prototype declaration.
4448 (if (and (eq fchar ?s) (eq char ?\;)) nil
4449 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4450 marker (make-marker))
4451 (set-text-properties 0 (length name) nil name)
4452 (set-marker marker (match-end 3))
4454 (setq name (concat "package " name))
4455 (cond ((string-match "[:']" name)
4457 ((> p end-range) nil)
4459 (setq name (concat package name) meth t))))
4460 (setq index (cons name marker))
4462 (push index index-pack-alist)
4463 (push index index-alist))
4464 (if meth (push index index-meth-alist))
4465 (push index index-unsorted-alist)))
4466 ((match-beginning 5) ; POD section
4467 ;; (beginning-of-line)
4468 (setq index (imenu-example--name-and-position)
4469 name (buffer-substring (match-beginning 6) (match-end 6)))
4470 (set-text-properties 0 (length name) nil name)
4471 (if (eq (char-after (match-beginning 5)) ?2)
4472 (setq name (concat " " name)))
4474 (setq index1 (cons (concat "=" name) (cdr index)))
4475 (push index index-pod-alist)
4476 (push index1 index-unsorted-alist)))))
4478 (if (default-value 'imenu-sort-function)
4479 (sort index-alist (default-value 'imenu-sort-function))
4480 (nreverse index-alist)))
4481 (and index-pod-alist
4482 (push (cons "+POD headers+..."
4483 (nreverse index-pod-alist))
4485 (and (or index-pack-alist index-meth-alist)
4486 (let ((lst index-pack-alist) hier-list pack elt group name)
4487 ;; Remove "package ", reverse and uniquify.
4489 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
4490 (if (assoc name hier-list) nil
4491 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
4492 (setq lst index-meth-alist)
4494 (setq elt (car lst) lst (cdr lst))
4495 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
4496 (setq pack (substring (car elt) 0 (match-beginning 0)))
4497 (if (setq group (assoc pack hier-list))
4498 (if (listp (cdr group))
4499 ;; Have some functions already
4501 (cons (cons (substring
4503 (+ 2 (match-beginning 0)))
4506 (setcdr group (list (cons (substring
4508 (+ 2 (match-beginning 0)))
4512 (list (cons (substring
4514 (+ 2 (match-beginning 0)))
4517 (push (cons "+Hierarchy+..."
4520 (and index-pack-alist
4521 (push (cons "+Packages+..."
4522 (nreverse index-pack-alist))
4524 (and (or index-pack-alist index-pod-alist
4525 (default-value 'imenu-sort-function))
4526 index-unsorted-alist
4527 (push (cons "+Unsorted List+..."
4528 (nreverse index-unsorted-alist))
4530 (cperl-imenu-addback index-alist)))
4533 ;; Suggested by Mark A. Hershberger
4534 (defun cperl-outline-level ()
4535 (looking-at outline-regexp)
4536 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4537 ((match-beginning 2)
4538 (if (eq (char-after (match-beginning 2)) ?p)
4541 ((match-beginning 5)
4542 (if (eq (char-after (match-beginning 5)) ?1)
4545 (t 3))) ; should not happen
4548 (defvar cperl-compilation-error-regexp-alist
4549 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4550 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
4552 "Alist that specifies how to match errors in perl output.")
4554 (if (fboundp 'eval-after-load)
4557 '(setq perl-compilation-error-regexp-alist
4558 cperl-compilation-error-regexp-alist)))
4561 (defun cperl-windowed-init ()
4562 "Initialization under windowed version."
4563 (if (or (featurep 'ps-print) cperl-faces-init)
4564 ;; Need to init anyway:
4565 (or cperl-faces-init (cperl-init-faces))
4566 (add-hook 'font-lock-mode-hook
4569 (if (memq major-mode '(perl-mode cperl-mode))
4571 (or cperl-faces-init (cperl-init-faces)))))))
4572 (if (fboundp 'eval-after-load)
4575 '(or cperl-faces-init (cperl-init-faces))))))
4577 (defvar cperl-font-lock-keywords-1 nil
4578 "Additional expressions to highlight in Perl mode. Minimal set.")
4579 (defvar cperl-font-lock-keywords nil
4580 "Additional expressions to highlight in Perl mode. Default set.")
4581 (defvar cperl-font-lock-keywords-2 nil
4582 "Additional expressions to highlight in Perl mode. Maximal set")
4584 (defun cperl-load-font-lock-keywords ()
4585 (or cperl-faces-init (cperl-init-faces))
4586 cperl-font-lock-keywords)
4588 (defun cperl-load-font-lock-keywords-1 ()
4589 (or cperl-faces-init (cperl-init-faces))
4590 cperl-font-lock-keywords-1)
4592 (defun cperl-load-font-lock-keywords-2 ()
4593 (or cperl-faces-init (cperl-init-faces))
4594 cperl-font-lock-keywords-2)
4596 (defun cperl-init-faces-weak ()
4597 ;; Allow `cperl-find-pods-heres' to run.
4598 (or (boundp 'font-lock-constant-face)
4599 (cperl-force-face font-lock-constant-face
4600 "Face for constant and label names")
4601 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4604 (defun cperl-init-faces ()
4605 (condition-case errs
4607 (require 'font-lock)
4608 (and (fboundp 'font-lock-fontify-anchored-keywords)
4609 (featurep 'font-lock-extra)
4610 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
4611 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
4612 (if (fboundp 'font-lock-fontify-anchored-keywords)
4613 (setq font-lock-anchored t))
4615 t-font-lock-keywords
4617 `("[ \t]+$" 0 ',cperl-invalid-face t)
4620 "\\(^\\|[^$@%&\\]\\)\\<\\("
4623 '("if" "until" "while" "elsif" "else" "unless" "for"
4624 "foreach" "continue" "exit" "die" "last" "goto" "next"
4625 "redo" "return" "local" "exec" "sub" "do" "dump" "use"
4626 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
4627 "\\|") ; Flow control
4628 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
4629 ; In what follows we use `type' style
4630 ; for overwritable builtins
4633 "\\(^\\|[^$@%&\\]\\)\\<\\("
4634 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4635 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4636 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4637 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4638 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4639 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4640 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4641 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4642 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4643 ;; "gethostbyname" "gethostent" "getlogin"
4644 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4645 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4646 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4647 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4648 ;; "getservbyport" "getservent" "getsockname"
4649 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4650 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
4651 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
4652 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4653 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4654 ;; "quotemeta" "rand" "read" "readdir" "readline"
4655 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4656 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4657 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4658 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4659 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4660 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4661 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4662 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
4663 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
4664 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4665 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4666 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
4667 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
4668 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
4669 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
4670 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
4671 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
4672 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
4673 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
4674 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
4675 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
4676 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
4677 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
4678 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
4679 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
4680 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
4681 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
4682 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
4683 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
4684 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
4685 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
4686 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
4687 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
4688 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
4689 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
4690 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
4691 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
4692 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
4693 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
4694 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
4695 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
4696 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
4697 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
4698 "\\)\\>") 2 'font-lock-type-face)
4699 ;; In what follows we use `other' style
4700 ;; for nonoverwritable builtins
4701 ;; Somehow 's', 'm' are not auto-generated???
4704 "\\(^\\|[^$@%&\\]\\)\\<\\("
4705 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
4706 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4707 ;; "eval" "exists" "for" "foreach" "format" "goto"
4708 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4709 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4710 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4711 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4712 ;; "undef" "unless" "unshift" "untie" "until" "use"
4714 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
4715 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
4716 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
4717 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
4718 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
4719 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
4720 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
4721 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
4722 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
4723 "\\|[sm]" ; Added manually
4724 "\\)\\>") 2 'cperl-nonoverridable)
4725 ;; (mapconcat 'identity
4726 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4727 ;; "#include" "#define" "#undef")
4729 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
4730 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
4731 '("\\<sub[ \t]+\\([^ \t{;()]+\\)[ \t]*\\(([^()]*)[ \t]*\\)?[#{\n]" 1
4732 font-lock-function-name-face)
4733 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4734 2 font-lock-function-name-face)
4735 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
4736 1 font-lock-function-name-face)
4737 (cond ((featurep 'font-lock-extra)
4738 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4739 (2 font-lock-string-face t)
4740 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
4742 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4743 (2 font-lock-string-face t)
4744 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4746 (1 font-lock-string-face t))))
4747 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4748 2 font-lock-string-face t)))
4749 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
4750 font-lock-string-face t)
4751 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
4752 font-lock-constant-face) ; labels
4753 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
4754 2 font-lock-constant-face)
4755 ;; Uncomment to get perl-mode-like vars
4756 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
4757 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
4758 ;;; (2 (cons font-lock-variable-name-face '(underline))))
4759 (cond ((featurep 'font-lock-extra)
4760 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4761 (3 font-lock-variable-name-face)
4763 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4764 (1 font-lock-variable-name-face)
4765 (2 '(restart 2 nil) nil t)))
4766 nil t))) ; local variables, multiple
4768 '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4769 (3 font-lock-variable-name-face)
4770 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)"
4772 (1 font-lock-variable-name-face))))
4773 (t '("^[ \t{}]*\\(my\\|local\\our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4774 3 font-lock-variable-name-face)))
4775 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
4776 4 font-lock-variable-name-face)
4777 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
4778 '("\\(?:^\\|[^smywqrx$]\\)\\(!\\)" 1 font-lock-negation-char-face)
4779 '("\\[\\(\\^\\)" 1 font-lock-negation-char-face prepend)))
4781 t-font-lock-keywords-1
4782 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4783 (not cperl-xemacs-p) ; not yet as of XEmacs 19.12
4785 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
4786 (if (eq (char-after (match-beginning 2)) ?%)
4789 t) ; arrays and hashes
4790 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
4792 (if (= (- (match-end 2) (match-beginning 2)) 1)
4793 (if (eq (char-after (match-beginning 3)) ?{)
4795 'cperl-array) ; arrays and hashes
4796 font-lock-variable-name-face) ; Just to put something
4798 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4799 ;;; Too much noise from \s* @s[ and friends
4800 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
4801 ;;(3 font-lock-function-name-face t t)
4803 ;; (if (cperl-slash-is-regexp)
4804 ;; font-lock-function-name-face 'default) nil t))
4806 (if cperl-highlight-variables-indiscriminately
4807 (setq t-font-lock-keywords-1
4808 (append t-font-lock-keywords-1
4809 (list '("[$*]{?\\(\\sw+\\)" 1
4810 font-lock-variable-name-face)))))
4811 (setq cperl-font-lock-keywords-1
4812 (if cperl-syntaxify-by-font-lock
4813 (cons 'cperl-fontify-update
4814 t-font-lock-keywords)
4815 t-font-lock-keywords)
4816 cperl-font-lock-keywords cperl-font-lock-keywords-1
4817 cperl-font-lock-keywords-2 (append
4818 cperl-font-lock-keywords-1
4819 t-font-lock-keywords-1)))
4820 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
4821 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
4822 (eval ; Avoid a warning
4823 '(font-lock-require-faces
4825 ;; Color-light Color-dark Gray-light Gray-dark Mono
4826 (list 'font-lock-comment-face
4827 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
4832 (list 'font-lock-string-face
4833 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
4838 (list 'font-lock-function-name-face
4840 "Blue" "LightSkyBlue" "Gray50" "LightGray"
4841 (cdr (assq 'background-color ; if mono
4842 (frame-parameters))))
4845 (cdr (assq 'foreground-color ; if mono
4846 (frame-parameters))))
4850 (list 'font-lock-variable-name-face
4851 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
4856 (list 'font-lock-type-face
4857 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
4862 (list 'font-lock-constant-face
4863 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
4868 (list 'cperl-nonoverridable
4869 ["chartreuse3" ("orchid1" "orange")
4876 ["blue" "yellow" nil "Gray80"]
4877 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4883 ["red" "red" nil "Gray80"]
4884 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4889 ;; Do it the dull way, without choose-color
4890 (defvar cperl-guessed-background nil
4891 "Display characteristics as guessed by cperl.")
4892 ;; (or (fboundp 'x-color-defined-p)
4893 ;; (defalias 'x-color-defined-p
4894 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4895 ;; ;; XEmacs >= 19.12
4896 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4898 ;; (t 'x-valid-color-name-p))))
4899 (cperl-force-face font-lock-constant-face
4900 "Face for constant and label names")
4901 (cperl-force-face font-lock-variable-name-face
4902 "Face for variable names")
4903 (cperl-force-face font-lock-type-face
4904 "Face for data types")
4905 (cperl-force-face cperl-nonoverridable
4906 "Face for data types from another group")
4907 (cperl-force-face font-lock-comment-face
4908 "Face for comments")
4909 (cperl-force-face font-lock-function-name-face
4910 "Face for function names")
4911 (cperl-force-face cperl-hash
4913 (cperl-force-face cperl-array
4915 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4916 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4917 ;;(or (boundp 'font-lock-type-face)
4918 ;; (defconst font-lock-type-face
4919 ;; 'font-lock-type-face
4920 ;; "Face to use for data types."))
4921 ;;(or (boundp 'cperl-nonoverridable-face)
4922 ;; (defconst cperl-nonoverridable-face
4923 ;; 'cperl-nonoverridable
4924 ;; "Face to use for data types from another group."))
4925 ;;(if (not cperl-xemacs-p) nil
4926 ;; (or (boundp 'font-lock-comment-face)
4927 ;; (defconst font-lock-comment-face
4928 ;; 'font-lock-comment-face
4929 ;; "Face to use for comments."))
4930 ;; (or (boundp 'font-lock-keyword-face)
4931 ;; (defconst font-lock-keyword-face
4932 ;; 'font-lock-keyword-face
4933 ;; "Face to use for keywords."))
4934 ;; (or (boundp 'font-lock-function-name-face)
4935 ;; (defconst font-lock-function-name-face
4936 ;; 'font-lock-function-name-face
4937 ;; "Face to use for function names.")))
4939 (not (cperl-is-face 'cperl-array))
4940 (cperl-is-face 'font-lock-emphasized-face))
4941 (copy-face 'font-lock-emphasized-face 'cperl-array))
4943 (not (cperl-is-face 'cperl-hash))
4944 (cperl-is-face 'font-lock-other-emphasized-face))
4945 (copy-face 'font-lock-other-emphasized-face 'cperl-hash))
4947 (not (cperl-is-face 'cperl-nonoverridable))
4948 (cperl-is-face 'font-lock-other-type-face))
4949 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable))
4950 ;;(or (boundp 'cperl-hash-face)
4951 ;; (defconst cperl-hash-face
4953 ;; "Face to use for hashes."))
4954 ;;(or (boundp 'cperl-array-face)
4955 ;; (defconst cperl-array-face
4957 ;; "Face to use for arrays."))
4958 ;; Here we try to guess background
4960 (if (boundp 'font-lock-background-mode)
4961 font-lock-background-mode
4963 (face-list (and (fboundp 'face-list) (face-list))))
4964 ;;;; (fset 'cperl-is-face
4965 ;;;; (cond ((fboundp 'find-face)
4966 ;;;; (symbol-function 'find-face))
4968 ;;;; (function (lambda (face) (member face face-list))))
4970 ;;;; (function (lambda (face) (boundp face))))))
4971 (defvar cperl-guessed-background
4972 (if (and (boundp 'font-lock-display-type)
4973 (eq font-lock-display-type 'grayscale))
4976 "Background as guessed by CPerl mode")
4977 (and (not (cperl-is-face 'font-lock-constant-face))
4978 (cperl-is-face 'font-lock-reference-face)
4979 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
4980 (if (cperl-is-face 'font-lock-type-face) nil
4981 (copy-face 'default 'font-lock-type-face)
4983 ((eq background 'light)
4984 (set-face-foreground 'font-lock-type-face
4985 (if (x-color-defined-p "seagreen")
4988 ((eq background 'dark)
4989 (set-face-foreground 'font-lock-type-face
4990 (if (x-color-defined-p "os2pink")
4994 (set-face-background 'font-lock-type-face "gray90"))))
4995 (if (cperl-is-face 'cperl-nonoverridable)
4997 (copy-face 'font-lock-type-face 'cperl-nonoverridable)
4999 ((eq background 'light)
5000 (set-face-foreground 'cperl-nonoverridable
5001 (if (x-color-defined-p "chartreuse3")
5004 ((eq background 'dark)
5005 (set-face-foreground 'cperl-nonoverridable
5006 (if (x-color-defined-p "orchid1")
5009 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
5010 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
5012 ;;; ((eq background 'light)
5013 ;;; (set-face-background 'font-lock-other-emphasized-face
5014 ;;; (if (x-color-defined-p "lightyellow2")
5016 ;;; (if (x-color-defined-p "lightyellow")
5018 ;;; "light yellow"))))
5019 ;;; ((eq background 'dark)
5020 ;;; (set-face-background 'font-lock-other-emphasized-face
5021 ;;; (if (x-color-defined-p "navy")
5023 ;;; (if (x-color-defined-p "darkgreen")
5025 ;;; "dark green"))))
5026 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
5027 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
5028 ;;; (copy-face 'bold 'font-lock-emphasized-face)
5030 ;;; ((eq background 'light)
5031 ;;; (set-face-background 'font-lock-emphasized-face
5032 ;;; (if (x-color-defined-p "lightyellow2")
5034 ;;; "lightyellow")))
5035 ;;; ((eq background 'dark)
5036 ;;; (set-face-background 'font-lock-emphasized-face
5037 ;;; (if (x-color-defined-p "navy")
5039 ;;; (if (x-color-defined-p "darkgreen")
5041 ;;; "dark green"))))
5042 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
5043 (if (cperl-is-face 'font-lock-variable-name-face) nil
5044 (copy-face 'italic 'font-lock-variable-name-face))
5045 (if (cperl-is-face 'font-lock-constant-face) nil
5046 (copy-face 'italic 'font-lock-constant-face))))
5047 (setq cperl-faces-init t))
5048 (error (message "cperl-init-faces (ignored): %s" errs))))
5051 (defun cperl-ps-print-init ()
5052 "Initialization of `ps-print' components for faces used in CPerl."
5053 (eval-after-load "ps-print"
5054 '(setq ps-bold-faces
5055 ;; font-lock-variable-name-face
5056 ;; font-lock-constant-face
5057 (append '(cperl-array cperl-hash)
5060 ;; font-lock-constant-face
5061 (append '(cperl-nonoverridable cperl-hash)
5064 ;; font-lock-type-face
5065 (append '(cperl-array cperl-hash underline cperl-nonoverridable)
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
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
5106 ;;; (setq ps-italic-faces
5107 ;;; (append '(cperl-nonoverridable
5108 ;;; font-lock-constant-face
5109 ;;; font-lock-reference-face
5110 ;;; font-lock-other-emphasized-face
5112 ;;; ps-italic-faces))
5113 ;;; (setq ps-underlined-faces
5114 ;;; (append '(font-lock-emphasized-face
5116 ;;; font-lock-other-emphasized-face
5118 ;;; cperl-nonoverridable 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 memorized 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 (goto-char (point-min))
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))
5555 ;; Search for the function
5556 (progn ;;save-match-data
5557 (while (re-search-forward
5558 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5561 ((match-beginning 2) ; SECTION
5562 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
5563 (goto-char (match-beginning 0))
5564 (skip-chars-forward " \t")
5566 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
5567 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
5569 ((not package) nil) ; C language section
5570 ((match-beginning 3) ; XSUB
5571 (goto-char (1+ (match-beginning 3)))
5572 (setq index (imenu-example--name-and-position))
5573 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
5574 (if (and prefix (string-match (concat "^" prefix) name))
5575 (setq name (substring name (length prefix))))
5576 (cond ((string-match "::" name) nil)
5578 (setq index1 (cons (concat package "::" name) (cdr index)))
5579 (push index1 index-alist)))
5581 (push index index-alist))
5583 ;; (beginning-of-line)
5584 (setq index (imenu-example--name-and-position))
5585 (setcar index (concat package "::BOOT:"))
5586 (push index index-alist)))))
5589 (defvar cperl-unreadable-ok nil)
5591 (defun cperl-find-tags (ifile xs topdir)
5592 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
5593 (cperl-pod-here-fontify nil) f file)
5595 (if b (set-buffer b)
5596 (cperl-setup-tmp-buf))
5599 (setq file (car (insert-file-contents ifile)))
5600 (error (if cperl-unreadable-ok nil
5602 (format "File %s unreadable. Continue? " ifile))
5603 (setq cperl-unreadable-ok t)
5604 (error "Aborting: unreadable file %s" ifile)))))
5606 (message "Unreadable file %s" ifile)
5607 (message "Scanning file %s ..." file)
5608 (if (and cperl-use-syntax-table-text-property-for-tags
5610 (condition-case err ; after __END__ may have garbage
5611 (cperl-find-pods-heres nil nil noninteractive)
5612 (error (message "While scanning for syntax: %s" err))))
5614 (setq lst (cperl-xsub-scan))
5615 (setq ind (cperl-imenu--create-perl-index))
5616 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
5621 (cond ((string-match "^[_a-zA-Z]" (car elt))
5622 (goto-char (cdr elt))
5623 (beginning-of-line) ; pos should be of the start of the line
5626 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
5627 (buffer-substring (progn
5628 (goto-char (cdr elt))
5629 ;; After name now...
5630 (or (eolp) (forward-char 1))
5638 (setq elt (car lst) lst (cdr lst))
5643 (if (string-match "^package " (car elt))
5644 (substring (car elt) 8)
5647 (number-to-string (elt elt 2)) ; Line
5649 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
5651 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
5652 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
5654 ;; Need to insert the name without package as well
5655 (setq lst (cons (cons (substring (elt elt 3)
5663 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5664 (set-text-properties 0 (length rel) nil rel)
5665 (and (equal topdir (substring rel 0 (length topdir)))
5666 (setq rel (substring file (length topdir))))
5667 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
5668 (setq ret (buffer-substring 1 (point-max)))
5671 (message "Scanning file %s finished" file))
5674 (defun cperl-add-tags-recurse-noxs ()
5675 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5677 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5678 -f cperl-add-tags-recurse
5680 (cperl-write-tags nil nil t t nil t))
5682 (defun cperl-add-tags-recurse ()
5683 "Add to TAGS file data for Perl files in the current directory and kids.
5685 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5686 -f cperl-add-tags-recurse
5688 (cperl-write-tags nil nil t t))
5690 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
5691 ;; If INBUFFER, do not select buffer, and do not save
5692 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5695 (setq file (if dir default-directory (buffer-file-name)))
5696 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
5698 (setq topdir default-directory))
5699 (let ((tags-file-name "TAGS")
5700 (case-fold-search (eq system-type 'emx))
5703 (cond (inbuffer nil) ; Already there
5704 ((file-exists-p tags-file-name)
5706 (visit-tags-table-buffer)
5707 (visit-tags-table-buffer tags-file-name)))
5708 (t (set-buffer (find-file-noselect tags-file-name))))
5711 (cond ((eq erase 'ignore))
5714 (setq erase 'ignore)))
5717 (directory-files file t
5718 (if recurse nil cperl-scan-files-regexp)
5721 (if cperl-unreadable-ok nil
5723 (format "Directory %s unreadable. Continue? " file))
5724 (setq cperl-unreadable-ok t
5725 tm nil) ; Return empty list
5726 (error "Aborting: unreadable directory %s" file)))))))
5730 ((string-match cperl-noscan-files-regexp file)
5732 ((not (file-directory-p file))
5733 (if (string-match cperl-scan-files-regexp file)
5734 (cperl-write-tags file erase recurse nil t noxs topdir)))
5736 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
5739 (setq xs (string-match "\\.xs$" file))
5740 (if (not (and xs noxs))
5742 (cond ((eq erase 'ignore) (goto-char (point-max)))
5743 (erase (erase-buffer))
5747 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5748 (set-text-properties 0 (length rel) nil rel)
5749 (and (equal topdir (substring rel 0 (length topdir)))
5750 (setq rel (substring file (length topdir))))
5751 (if (search-forward (concat "\f\n" rel ",") nil t)
5753 (search-backward "\f\n")
5754 (delete-region (point)
5757 (if (search-forward "\f\n"
5761 (goto-char (point-max)))))
5762 (insert (cperl-find-tags file xs topdir))))))
5763 (if inbuffer nil ; Delegate to the caller
5764 (save-buffer 0) ; No backup
5765 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
5766 (initialize-new-tags-table))))))
5768 (defvar cperl-tags-hier-regexp-list
5775 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
5777 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
5780 (defvar cperl-hierarchy '(() ())
5781 "Global hierarchy of classes.")
5783 (defun cperl-tags-hier-fill ()
5784 ;; Suppose we are in a tag table cooked by cperl.
5786 (let (type pack name pos line chunk ord cons1 file str info fileind)
5787 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5788 (setq pos (match-beginning 0)
5789 pack (match-beginning 2))
5791 (if (looking-at (concat
5800 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
5801 name (buffer-substring (match-beginning 2) (match-end 2))
5802 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5803 line (buffer-substring (match-beginning 3) (match-end 3))
5806 fileind (format "%s:%s" file line)
5807 ;; Moves to beginning of the next line:
5808 info (cperl-etags-snarf-tag file line))
5811 ;; Make new member of hierarchy name ==> file ==> pos if needed
5812 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
5814 (setcdr cons1 (cons (cons fileind (vector file info))
5816 ;; First occurrence of the name, start alist
5817 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5819 (setcar (cdr cperl-hierarchy)
5820 (cons cons1 (nth 1 cperl-hierarchy)))
5821 (setcar cperl-hierarchy
5822 (cons cons1 (car cperl-hierarchy)))))))
5825 (defun cperl-tags-hier-init (&optional update)
5826 "Show hierarchical menu of classes and methods.
5827 Finds info about classes by a scan of loaded TAGS files.
5828 Supposes that the TAGS files contain fully qualified function names.
5829 One may build such TAGS files from CPerl mode menu."
5833 (if (or update (null (nth 2 cperl-hierarchy)))
5834 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
5837 (setcdr elt (cdr (nth 1 elt)))))))
5838 pack name cons1 to l1 l2 l3 l4 b)
5839 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5840 (setq cperl-hierarchy (list l1 l2 l3))
5841 (if cperl-xemacs-p ; Not checked
5844 ;; Does this work in XEmacs?
5845 (call-interactively 'visit-tags-table))
5846 (message "Updating list of classes...")
5847 (set-buffer (get-file-buffer tags-file-name))
5848 (cperl-tags-hier-fill))
5850 (call-interactively 'visit-tags-table))
5854 (message "Updating list of classes... %s" tagsfile)
5855 (set-buffer (get-file-buffer tagsfile))
5856 (cperl-tags-hier-fill)))
5858 (message "Updating list of classes... postprocessing..."))
5859 (mapcar remover (car cperl-hierarchy))
5860 (mapcar remover (nth 1 cperl-hierarchy))
5861 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
5862 (cons "Methods: " (car cperl-hierarchy))))
5863 (cperl-tags-treeify to 1)
5864 (setcar (nthcdr 2 cperl-hierarchy)
5865 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
5866 (message "Updating list of classes: done, requesting display...")
5867 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5869 (or (nth 2 cperl-hierarchy)
5870 (error "No items found"))
5872 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
5873 (if (if (fboundp 'display-popup-menus-p)
5874 (let ((f 'display-popup-menus-p))
5877 (x-popup-menu t (nth 2 cperl-hierarchy))
5879 (tmm-prompt (nth 2 cperl-hierarchy))))
5880 (if (and update (listp update))
5881 (progn (while (cdr update) (setq update (cdr update)))
5882 (setq update (car update)))) ; Get the last from the list
5883 (if (vectorp update)
5885 (find-file (elt update 0))
5886 (cperl-etags-goto-tag-location (elt update 1))))
5887 (if (eq update -999) (cperl-tags-hier-init t)))
5889 (defun cperl-tags-treeify (to level)
5890 ;; cadr of `to' is read-write. On start it is a cons
5891 (let* ((regexp (concat "^\\(" (mapconcat
5893 (make-list level "[_a-zA-Z0-9]+")
5896 (packages (cdr (nth 1 to)))
5897 (methods (cdr (nth 2 to)))
5898 l1 head tail cons1 cons2 ord writeto packs recurse
5899 root-packages root-functions ms many_ms same_name ps
5903 (cond ((and (string-match regexp (car elt))
5904 (or (eq ord 1) (match-end 2)))
5905 (setq head (substring (car elt) 0 (match-end 1))
5906 tail (if (match-end 2) (substring (car elt)
5909 (if (setq cons1 (assoc head writeto)) nil
5910 ;; Need to init new head
5911 (setcdr writeto (cons (list head (list "Packages: ")
5914 (setq cons1 (nth 1 writeto)))
5915 (setq cons2 (nth ord cons1)) ; Either packs or meths
5916 (setcdr cons2 (cons elt (cdr cons2))))
5918 (setq root-functions (cons elt root-functions)))
5920 (setq root-packages (cons elt root-packages))))))))
5921 (setcdr to l1) ; Init to dynamic space
5924 (mapcar move-deeper packages)
5926 (mapcar move-deeper methods)
5928 (mapcar (function (lambda (elt)
5929 (cperl-tags-treeify elt (1+ level))))
5931 ;;Now clean up leaders with one child only
5932 (mapcar (function (lambda (elt)
5933 (if (not (and (listp (cdr elt))
5934 (eq (length elt) 2))) nil
5935 (setcar elt (car (nth 1 elt)))
5936 (setcdr elt (cdr (nth 1 elt))))))
5938 ;; Sort the roots of subtrees
5939 (if (default-value 'imenu-sort-function)
5941 (sort (cdr to) (default-value 'imenu-sort-function))))
5942 ;; Now add back functions removed from display
5943 (mapcar (function (lambda (elt)
5944 (setcdr to (cons elt (cdr to)))))
5945 (if (default-value 'imenu-sort-function)
5947 (sort root-functions (default-value 'imenu-sort-function)))
5949 ;; Now add back packages removed from display
5950 (mapcar (function (lambda (elt)
5951 (setcdr to (cons (cons (concat "package " (car elt))
5954 (if (default-value 'imenu-sort-function)
5956 (sort root-packages (default-value 'imenu-sort-function)))
5960 ;;; '(keymap "Name1"
5964 ;;; ("Tail1" "x") ("Tail2" "y"))))
5966 (defun cperl-list-fold (list name limit)
5967 (let (list1 list2 elt1 (num 0))
5968 (if (<= (length list) limit) list
5969 (setq list1 nil list2 nil)
5974 (if (<= num imenu-max-items)
5975 (setq list2 (cons elt1 list2))
5976 (setq list1 (cons (cons name
5981 (nreverse (cons (cons name
5985 (defun cperl-menu-to-keymap (menu &optional name)
5991 (cond ((listp (cdr elt))
5992 (setq list (cperl-list-fold
5993 (cdr elt) (car elt) imenu-max-items))
5996 (cperl-menu-to-keymap list))))
5998 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
5999 (cperl-list-fold menu "Root" imenu-max-items)))))
6002 (defvar cperl-bad-style-regexp
6003 (mapconcat 'identity
6004 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
6005 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
6007 "Finds places such that insertion of a whitespace may help a lot.")
6009 (defvar cperl-not-bad-style-regexp
6012 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
6013 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
6014 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
6015 "<\\$?\\sw+\\(\\.\\sw+\\)?>" ; <IN> <stdin.h>
6016 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
6023 "\\\\[&$@*\\\\]" ; \&func
6026 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
6029 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
6030 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
6031 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
6035 "If matches at the start of match found by `my-bad-c-style-regexp',
6036 insertion of a whitespace will not help.")
6040 (defun cperl-find-bad-style ()
6041 "Find places in the buffer where insertion of a whitespace may help.
6042 Prompts user for insertion of spaces.
6043 Currently it is tuned to C and Perl syntax."
6045 (let (found-bad (p (point)))
6046 (setq last-nonmenu-event 13) ; To disable popup
6047 (with-no-warnings ; It is useful to push the mark here.
6048 (beginning-of-buffer))
6049 (map-y-or-n-p "Insert space here? "
6050 (lambda (arg) (insert " "))
6051 'cperl-next-bad-style
6052 '("location" "locations" "insert a space into")
6053 '((?\C-r (lambda (arg)
6054 (let ((buffer-quit-function
6055 'exit-recursive-edit))
6056 (message "Exit with Esc Esc")
6058 t)) ; Consider acted upon
6059 "edit, exit with Esc Esc")
6061 (let ((buffer-quit-function
6062 'exit-recursive-edit))
6063 (message "Exit with Esc Esc")
6065 t)) ; Consider acted upon
6066 "edit, exit with Esc Esc"))
6068 (if found-bad (goto-char found-bad)
6070 (message "No appropriate place found"))))
6072 (defun cperl-next-bad-style ()
6073 (let (p (not-found t) (point (point)) found)
6074 (while (and not-found
6075 (re-search-forward cperl-bad-style-regexp nil 'to-end))
6077 (goto-char (match-beginning 0))
6079 (looking-at cperl-not-bad-style-regexp)
6080 ;; Check for a < -b and friends
6081 (and (eq (following-char) ?\-)
6083 (skip-chars-backward " \t\n")
6084 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
6085 ;; Now check for syntax type
6087 (setq found (point))
6088 (beginning-of-defun)
6089 (let ((pps (parse-partial-sexp (point) found)))
6090 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
6091 (goto-char (match-end 0))
6099 (defvar cperl-have-help-regexp
6103 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
6104 "[$@]\\^[a-zA-Z]" ; Special variable
6105 "[$@][^ \n\t]" ; Special variable
6106 "-[a-zA-Z]" ; File test
6107 "\\\\[a-zA-Z0]" ; Special chars
6108 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
6109 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
6110 "[a-zA-Z_0-9:]+" ; symbol or number
6117 "Matches places in the buffer we can find help for.")
6119 (defvar cperl-message-on-help-error t)
6120 (defvar cperl-help-from-timer nil)
6122 (defun cperl-word-at-point-hard ()
6123 ;; Does not save-excursion
6124 ;; Get to the something meaningful
6125 (or (eobp) (eolp) (forward-char 1))
6126 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
6127 (save-excursion (beginning-of-line) (point))
6130 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
6131 ;; (skip-chars-backward " \n\t\r({[]});,")
6132 ;; (or (bobp) (backward-char 1))))
6135 ((looking-at "[a-zA-Z0-9_:]") ; symbol
6136 (skip-chars-backward "a-zA-Z0-9_:")
6138 ((and (eq (preceding-char) ?^) ; $^I
6139 (eq (char-after (- (point) 2)) ?\$))
6141 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
6143 ((and (eq (preceding-char) ?\=)
6144 (eq (current-column) 1))
6145 (forward-char -1))) ; =head1
6146 (if (and (eq (preceding-char) ?\<)
6147 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
6149 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
6151 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
6153 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
6154 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
6156 ((and (eq (preceding-char) ?\$)
6157 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
6159 ((and (eq (following-char) ?\>)
6160 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
6163 (and (eq (preceding-char) ?\<)
6164 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
6165 (search-backward "<"))))
6166 ((and (eq (following-char) ?\$)
6167 (eq (preceding-char) ?\<)
6168 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
6170 (if (looking-at cperl-have-help-regexp)
6171 (buffer-substring (match-beginning 0) (match-end 0))))
6173 (defun cperl-get-help ()
6174 "Get one-line docs on the symbol at the point.
6175 The data for these docs is a little bit obsolete and may be in fact longer
6176 than a line. Your contribution to update/shorten it is appreciated."
6178 (save-match-data ; May be called "inside" query-replace
6180 (let ((word (cperl-word-at-point-hard)))
6182 (if (and cperl-help-from-timer ; Bail out if not in mainland
6183 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
6184 (or (memq (get-text-property (point) 'face)
6185 '(font-lock-comment-face font-lock-string-face))
6186 (memq (get-text-property (point) 'syntax-type)
6187 '(pod here-doc format))))
6189 (cperl-describe-perl-symbol word))
6190 (if cperl-message-on-help-error
6191 (message "Nothing found for %s..."
6192 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
6194 ;;; Stolen from perl-descr.el by Johan Vromans:
6196 (defvar cperl-doc-buffer " *perl-doc*"
6197 "Where the documentation can be found.")
6199 (defun cperl-describe-perl-symbol (val)
6200 "Display the documentation of symbol at point, a Perl operator."
6201 (let ((enable-recursive-minibuffers t)
6204 ((string-match "^[&*][a-zA-Z_]" val)
6205 (setq val (concat (substring val 0 1) "NAME")))
6206 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
6207 (setq val (concat "@" (substring val 1 (match-end 1)))))
6208 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
6209 (setq val (concat "%" (substring val 1 (match-end 1)))))
6210 ((and (string= val "x") (string-match "^x=" val))
6212 ((string-match "^\\$[\C-a-\C-z]" val)
6213 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
6214 ((string-match "^CORE::" val)
6215 (setq val "CORE::"))
6216 ((string-match "^SUPER::" val)
6217 (setq val "SUPER::"))
6218 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
6219 (setq val "<NAME>")))
6220 (setq regexp (concat "^"
6221 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
6223 "\\([ \t([/]\\|$\\)"))
6225 ;; get the buffer with the documentation text
6226 (cperl-switch-to-doc-buffer)
6228 ;; lookup in the doc
6229 (goto-char (point-min))
6230 (let ((case-fold-search nil))
6232 (if (re-search-forward regexp (point-max) t)
6234 (beginning-of-line 1)
6235 (let ((lnstart (point)))
6237 (message "%s" (buffer-substring lnstart (point)))))
6238 (if cperl-message-on-help-error
6239 (message "No definition for %s" val)))))))
6241 (defvar cperl-short-docs 'please-ignore-this-line
6242 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
6243 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
6244 ... Range (list context); flip/flop [no flop when flip] (scalar context).
6245 ! ... Logical negation.
6246 ... != ... Numeric inequality.
6247 ... !~ ... Search pattern, substitution, or translation (negated).
6248 $! In numeric context: errno. In a string context: error string.
6249 $\" The separator which joins elements of arrays interpolated in strings.
6250 $# The output format for printed numbers. Default is %.15g or close.
6251 $$ Process number of this script. Changes in the fork()ed child process.
6252 $% The current page number of the currently selected output channel.
6254 The following variables are always local to the current block:
6256 $1 Match of the 1st set of parentheses in the last match (auto-local).
6257 $2 Match of the 2nd set of parentheses in the last match (auto-local).
6258 $3 Match of the 3rd set of parentheses in the last match (auto-local).
6259 $4 Match of the 4th set of parentheses in the last match (auto-local).
6260 $5 Match of the 5th set of parentheses in the last match (auto-local).
6261 $6 Match of the 6th set of parentheses in the last match (auto-local).
6262 $7 Match of the 7th set of parentheses in the last match (auto-local).
6263 $8 Match of the 8th set of parentheses in the last match (auto-local).
6264 $9 Match of the 9th set of parentheses in the last match (auto-local).
6265 $& The string matched by the last pattern match (auto-local).
6266 $' The string after what was matched by the last match (auto-local).
6267 $` The string before what was matched by the last match (auto-local).
6269 $( The real gid of this process.
6270 $) The effective gid of this process.
6271 $* Deprecated: Set to 1 to do multiline matching within a string.
6272 $+ The last bracket matched by the last search pattern.
6273 $, The output field separator for the print operator.
6274 $- The number of lines left on the page.
6275 $. The current input line number of the last filehandle that was read.
6276 $/ The input record separator, newline by default.
6277 $0 Name of the file containing the current perl script (read/write).
6278 $: String may be broken after these characters to fill ^-lines in a format.
6279 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
6280 $< The real uid of this process.
6281 $= The page length of the current output channel. Default is 60 lines.
6282 $> The effective uid of this process.
6283 $? The status returned by the last ``, pipe close or `system'.
6284 $@ The perl error message from the last eval or do @var{EXPR} command.
6285 $ARGV The name of the current file used with <> .
6286 $[ Deprecated: The index of the first element/char in an array/string.
6287 $\\ The output record separator for the print operator.
6288 $] The perl version string as displayed with perl -v.
6289 $^ The name of the current top-of-page format.
6290 $^A The current value of the write() accumulator for format() lines.
6291 $^D The value of the perl debug (-D) flags.
6292 $^E Information about the last system error other than that provided by $!.
6293 $^F The highest system file descriptor, ordinarily 2.
6294 $^H The current set of syntax checks enabled by `use strict'.
6295 $^I The value of the in-place edit extension (perl -i option).
6296 $^L What formats output to perform a formfeed. Default is \f.
6297 $^M A buffer for emergency memory allocation when running out of memory.
6298 $^O The operating system name under which this copy of Perl was built.
6299 $^P Internal debugging flag.
6300 $^T The time the script was started. Used by -A/-M/-C file tests.
6301 $^W True if warnings are requested (perl -w flag).
6302 $^X The name under which perl was invoked (argv[0] in C-speech).
6303 $_ The default input and pattern-searching space.
6304 $| Auto-flush after write/print on current output channel? Default 0.
6305 $~ The name of the current report format.
6306 ... % ... Modulo division.
6307 ... %= ... Modulo division assignment.
6308 %ENV Contains the current environment.
6309 %INC List of files that have been require-d or do-ne.
6310 %SIG Used to set signal handlers for various signals.
6311 ... & ... Bitwise and.
6312 ... && ... Logical and.
6313 ... &&= ... Logical and assignment.
6314 ... &= ... Bitwise and assignment.
6315 ... * ... Multiplication.
6316 ... ** ... Exponentiation.
6317 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6318 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
6319 ... + ... Addition. +EXPR Makes EXPR into scalar context.
6320 ++ Auto-increment (magical on strings). ++EXPR EXPR++
6321 ... += ... Addition assignment.
6323 ... - ... Subtraction.
6324 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6325 ... -= ... Subtraction assignment.
6326 -A Access time in days since script started.
6327 -B File is a non-text (binary) file.
6328 -C Inode change time in days since script started.
6329 -M Age in days since script started.
6330 -O File is owned by real uid.
6331 -R File is readable by real uid.
6332 -S File is a socket .
6333 -T File is a text file.
6334 -W File is writable by real uid.
6335 -X File is executable by real uid.
6336 -b File is a block special file.
6337 -c File is a character special file.
6338 -d File is a directory.
6340 -f File is a plain file.
6341 -g File has setgid bit set.
6342 -k File has sticky bit set.
6343 -l File is a symbolic link.
6344 -o File is owned by effective uid.
6345 -p File is a named pipe (FIFO).
6346 -r File is readable by effective uid.
6347 -s File has non-zero size.
6348 -t Tests if filehandle (STDIN by default) is opened to a tty.
6349 -u File has setuid bit set.
6350 -w File is writable by effective uid.
6351 -x File is executable by effective uid.
6352 -z File has zero size.
6353 . Concatenate strings.
6354 .. Range (list context); flip/flop (scalar context) operator.
6355 .= Concatenate assignment strings
6356 ... / ... Division. /PATTERN/ioxsmg Pattern match
6357 ... /= ... Division assignment.
6358 /PATTERN/ioxsmg Pattern match.
6359 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6360 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6361 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6362 <> Reads line from union of files in @ARGV (= command line) and STDIN.
6363 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6364 ... <= ... Numeric less than or equal to.
6365 ... <=> ... Numeric compare.
6366 ... = ... Assignment.
6367 ... == ... Numeric equality.
6368 ... =~ ... Search pattern, substitution, or translation
6369 ... > ... Numeric greater than.
6370 ... >= ... Numeric greater than or equal to.
6371 ... >> ... Bitwise shift right.
6372 ... >>= ... Bitwise shift right assignment.
6373 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6374 ?PATTERN? One-time pattern match.
6375 @ARGV Command line arguments (not including the command name - see $0).
6376 @INC List of places to look for perl scripts during do/include/use.
6377 @_ Parameter array for subroutines; result of split() unless in list context.
6378 \\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
6379 \\0 Octal char, e.g. \\033.
6380 \\E Case modification terminator. See \\Q, \\L, and \\U.
6381 \\L Lowercase until \\E . See also \l, lc.
6382 \\U Upcase until \\E . See also \u, uc.
6383 \\Q Quote metacharacters until \\E . See also quotemeta.
6384 \\a Alarm character (octal 007).
6385 \\b Backspace character (octal 010).
6386 \\c Control character, e.g. \\c[ .
6387 \\e Escape character (octal 033).
6388 \\f Formfeed character (octal 014).
6389 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
6390 \\n Newline character (octal 012 on most systems).
6391 \\r Return character (octal 015 on most systems).
6392 \\t Tab character (octal 011).
6393 \\u Upcase the next character. See also \\U and \\l, ucfirst.
6394 \\x Hex character, e.g. \\x1b.
6395 ... ^ ... Bitwise exclusive or.
6396 __END__ Ends program source.
6397 __DATA__ Ends program source.
6398 __FILE__ Current (source) filename.
6399 __LINE__ Current line in current source.
6400 __PACKAGE__ Current package.
6401 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6402 ARGVOUT Output filehandle with -i flag.
6403 BEGIN { ... } Immediately executed (during compilation) piece of code.
6404 END { ... } Pseudo-subroutine executed after the script finishes.
6405 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
6406 INIT { ... } Pseudo-subroutine executed before the script starts running.
6407 DATA Input filehandle for what follows after __END__ or __DATA__.
6408 accept(NEWSOCKET,GENERICSOCKET)
6421 ... cmp ... String compare.
6422 connect(SOCKET,NAME)
6423 continue of { block } continue { block }. Is executed after `next' or at end.
6425 crypt(PLAINTEXT,SALT)
6427 dbmopen(%HASH,DBNAME,MODE)
6431 do { ... }|SUBR while|until EXPR executes at least once
6432 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6442 ... eq ... String equality.
6443 eval(EXPR) or eval { BLOCK }
6447 fcntl(FILEHANDLE,FUNCTION,SCALAR)
6449 flock(FILEHANDLE,OPERATION)
6450 for (EXPR;EXPR;EXPR) { ... }
6451 foreach [VAR] (@ARRAY) { ... }
6453 ... ge ... String greater than or equal.
6458 gethostbyaddr(ADDR,ADDRTYPE)
6462 getnetbyaddr(ADDR,ADDRTYPE)
6468 getpriority(WHICH,WHO)
6469 getprotobyname(NAME)
6470 getprotobynumber(NUMBER)
6475 getservbyname(NAME,PROTO)
6476 getservbyport(PORT,PROTO)
6479 getsockopt(SOCKET,LEVEL,OPTNAME)
6482 ... gt ... String greater than.
6484 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6485 index(STR,SUBSTR[,OFFSET])
6487 ioctl(FILEHANDLE,FUNCTION,SCALAR)
6492 ... le ... String less than or equal.
6494 link(OLDFILE,NEWFILE)
6495 listen(SOCKET,QUEUESIZE)
6499 lstat(EXPR|FILEHANDLE|VAR)
6500 ... lt ... String less than.
6502 mkdir(FILENAME,MODE)
6505 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6506 msgsnd(ID,MSG,FLAGS)
6507 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6508 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
6509 ... ne ... String inequality.
6512 open(FILEHANDLE[,EXPR])
6513 opendir(DIRHANDLE,EXPR)
6514 ord(EXPR) ASCII value of the first char of the string.
6516 package NAME Introduces package context.
6517 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6519 print [FILEHANDLE] [(LIST)]
6520 printf [FILEHANDLE] (FORMAT,LIST)
6522 q/STRING/ Synonym for 'STRING'
6523 qq/STRING/ Synonym for \"STRING\"
6524 qx/STRING/ Synonym for `STRING`
6526 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6529 recv(SOCKET,SCALAR,LEN,FLAGS)
6531 rename(OLDNAME,NEWNAME)
6532 require [FILENAME | PERL_VERSION]
6536 rewinddir(DIRHANDLE)
6537 rindex(STR,SUBSTR[,OFFSET])
6539 s/PATTERN/REPLACEMENT/gieoxsm
6541 seek(FILEHANDLE,POSITION,WHENCE)
6542 seekdir(DIRHANDLE,POS)
6543 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6544 semctl(ID,SEMNUM,CMD,ARG)
6545 semget(KEY,NSEMS,SIZE,FLAGS)
6547 send(SOCKET,MSG,FLAGS[,TO])
6549 sethostent(STAYOPEN)
6552 setpriority(WHICH,WHO,PRIORITY)
6553 setprotoent(STAYOPEN)
6555 setservent(STAYOPEN)
6556 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6559 shmget(KEY,SIZE,FLAGS)
6560 shmread(ID,VAR,POS,SIZE)
6561 shmwrite(ID,STRING,POS,SIZE)
6562 shutdown(SOCKET,HOW)
6565 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6566 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6567 sort [SUBROUTINE] (LIST)
6568 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6569 split[(/PATTERN/[,EXPR[,LIMIT]])]
6570 sprintf(FORMAT,LIST)
6573 stat(EXPR|FILEHANDLE|VAR)
6575 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6576 substr(EXPR,OFFSET[,LEN])
6577 symlink(OLDFILE,NEWFILE)
6579 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6581 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6586 tr/SEARCHLIST/REPLACEMENTLIST/cds
6587 truncate(FILE|EXPR,LENGTH)
6590 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6592 unpack(TEMPLATE,EXPR)
6594 until (EXPR) { ... } EXPR until EXPR
6597 vec(EXPR,OFFSET,BITS)
6600 wantarray Returns true if the sub/eval is called in list context.
6602 while (EXPR) { ... } EXPR while EXPR
6603 write[(EXPR|FILEHANDLE)]
6604 ... x ... Repeat string or array.
6605 x= ... Repetition assignment.
6606 y/SEARCHLIST/REPLACEMENTLIST/
6607 ... | ... Bitwise or.
6608 ... || ... Logical or.
6609 ~ ... Unary bitwise complement.
6610 #! OS interpreter indicator. If contains `perl', used for options, and -x.
6611 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6612 CORE:: Prefix to access builtin function if imported sub obscures it.
6613 SUPER:: Prefix to lookup for a method in @ISA classes.
6614 DESTROY Shorthand for `sub DESTROY {...}'.
6615 ... EQ ... Obsolete synonym of `eq'.
6616 ... GE ... Obsolete synonym of `ge'.
6617 ... GT ... Obsolete synonym of `gt'.
6618 ... LE ... Obsolete synonym of `le'.
6619 ... LT ... Obsolete synonym of `lt'.
6620 ... NE ... Obsolete synonym of `ne'.
6621 abs [ EXPR ] absolute value
6622 ... and ... Low-precedence synonym for &&.
6623 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6624 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6625 chr Converts a number to char with the same ordinal.
6626 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6627 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6628 exists $HASH{KEY} True if the key exists.
6629 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6630 formline PICTURE, LIST Backdoor into \"format\" processing.
6631 glob EXPR Synonym of <EXPR>.
6632 lc [ EXPR ] Returns lowercased EXPR.
6633 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
6634 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
6635 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6636 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6637 not ... Low-precedence synonym for ! - negation.
6638 ... or ... Low-precedence synonym for ||.
6639 pos STRING Set/Get end-position of the last match over this string, see \\G.
6640 quotemeta [ EXPR ] Quote regexp metacharacters.
6641 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6642 readline FH Synonym of <FH>.
6643 readpipe CMD Synonym of `CMD`.
6644 ref [ EXPR ] Type of EXPR when dereferenced.
6645 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6646 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6647 tied Returns internal object for a tied data.
6648 uc [ EXPR ] Returns upcased EXPR.
6649 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6650 untie VAR Unlink an object from a simple Perl variable.
6651 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6652 ... xor ... Low-precedence synonym for exclusive or.
6653 prototype \&SUB Returns prototype of the function given a reference.
6654 =head1 Top-level heading.
6655 =head2 Second-level heading.
6656 =head3 Third-level heading (is there such?).
6657 =over [ NUMBER ] Start list.
6658 =item [ TITLE ] Start new item in the list.
6660 =cut Switch from POD to Perl.
6661 =pod Switch from Perl to POD.
6664 (defun cperl-switch-to-doc-buffer (&optional interactive)
6665 "Go to the perl documentation buffer and insert the documentation."
6667 (let ((buf (get-buffer-create cperl-doc-buffer)))
6669 (switch-to-buffer-other-window buf)
6671 (if (= (buffer-size) 0)
6673 (insert (documentation-property 'cperl-short-docs
6674 'variable-documentation))
6675 (setq buffer-read-only t)))))
6677 (defun cperl-beautify-regexp-piece (b e embed level)
6678 ;; b is before the starting delimiter, e before the ending
6679 ;; e should be a marker, may be changed, but remains "correct".
6680 ;; EMBED is nil iff we process the whole REx.
6681 ;; The REx is guarantied to have //x
6682 ;; LEVEL shows how many levels deep to go
6683 ;; position at enter and at leave is not defined
6684 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
6688 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
6692 ((looking-at "(\\?[^a-zA-Z]")
6694 ((looking-at "(\\?") ; (?i)
6698 (setq c (if embed (current-indentation) (1- (current-column)))
6699 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
6700 (or (looking-at "[ \t]*[\n#]")
6705 (if (re-search-forward "[^ \t]" e t)
6706 (progn ; Something before the ending delimiter
6708 (delete-horizontal-space)
6710 (indent-to-column c)
6711 (set-marker e (point))))
6714 (while (< (point) (marker-position e))
6718 (skip-chars-forward " \t")
6719 (delete-region s (point))
6720 (indent-to-column c1)
6724 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
6725 "\\|" ; Embedded variable
6726 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
6729 "\\|" ; simple-code simple-code*?
6730 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
6734 "\\((\\(\\?\\)?\\)" ; 7 8
6737 (goto-char (match-end 0))
6739 (cond ((match-beginning 1) ; Alphanum word + junk
6741 ((or (match-beginning 3) ; $ab[12]
6742 (and (match-beginning 5) ; X* X+ X{2,3}
6743 (eq (preceding-char) ?\{)))
6746 ((match-beginning 6) ; []
6748 (if (looking-at "\\^?\\]")
6749 (goto-char (match-end 0)))
6750 ;; XXXX POSIX classes?!
6751 (while (and (not pos)
6752 (re-search-forward "\\[:\\|\\]" e t))
6753 (if (eq (preceding-char) ?:)
6754 (or (re-search-forward ":\\]" e t)
6755 (error "[:POSIX:]-group in []-group not terminated"))
6757 (or (eq (preceding-char) ?\])
6758 (error "[]-group not terminated"))
6759 (if (eq (following-char) ?\{)
6762 (and (eq (following-char) ??)
6764 (re-search-forward "\\=\\([*+?]\\??\\)" e t)))
6765 ((match-beginning 7) ; ()
6766 (goto-char (match-beginning 0))
6767 (setq pos (current-column))
6770 (delete-horizontal-space)
6772 (indent-to-column c1)))
6775 ;; (or (forward-sexp 1)
6778 ;; (error "()-group not terminated")))
6779 (set-marker m (1- (point)))
6780 (set-marker m1 (point))
6782 (if (progn ; indent rigidly if multiline
6783 ;; In fact does not make a lot of sense, since
6784 ;; the starting position can be already lost due
6785 ;; to insertion of "\n" and " "
6787 (search-forward "\n" m1 t))
6788 (indent-rigidly (point) m1 (- c1 pos)))
6789 (setq level (1- level))
6791 ((not (match-beginning 8))
6792 (cperl-beautify-regexp-piece tmp m t level))
6793 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
6795 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
6796 (goto-char (+ 2 tmp))
6798 (cperl-beautify-regexp-piece (point) m t level))
6799 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
6800 (goto-char (+ 3 tmp))
6801 (cperl-beautify-regexp-piece (point) m t level))
6803 (cperl-beautify-regexp-piece tmp m t level))))
6805 (cond ((looking-at "[*+?]\\??")
6806 (goto-char (match-end 0)))
6807 ((eq (following-char) ?\{)
6809 (if (eq (following-char) ?\?)
6811 (skip-chars-forward " \t")
6813 (if (looking-at "[#\n]")
6815 (or (eolp) (indent-for-comment))
6816 (beginning-of-line 2))
6817 (delete-horizontal-space)
6821 ((match-beginning 9) ; |
6825 (if (re-search-forward "[^ \t]" tmp t)
6828 (delete-horizontal-space)
6831 (delete-region (point) tmp))
6832 (indent-to-column c)
6834 (skip-chars-forward " \t")
6836 (if (looking-at "[#\n]")
6837 (beginning-of-line 2)
6838 (delete-horizontal-space)
6842 (or (looking-at "[ \t\n]")
6845 (skip-chars-forward " \t"))
6846 (or (looking-at "[#\n]")
6847 (error "Unknown code `%s' in a regexp"
6848 (buffer-substring (point) (1+ (point)))))
6849 (and inline (end-of-line 2)))
6850 ;; Special-case the last line of group
6851 (if (and (>= (point) (marker-position e))
6852 (/= (current-indentation) c))
6856 (skip-chars-forward " \t")
6857 (delete-region s (point))
6858 (indent-to-column c)))))
6860 (defun cperl-make-regexp-x ()
6861 ;; Returns position of the start
6862 ;; XXX this is called too often! Need to cache the result!
6864 (or cperl-use-syntax-table-text-property
6865 (error "I need to have a regexp marked!"))
6867 (if (looking-at "\\s|")
6869 (if (looking-at "\\([smy]\\|qr\\)\\s|")
6871 (re-search-backward "\\s|"))) ; Assume it is scanned already.
6873 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
6874 (sub-p (eq (preceding-char) ?s)) s)
6876 (set-marker e (1- (point)))
6877 (setq delim (preceding-char))
6878 (if (and sub-p (eq delim (char-after (- (point) 2))))
6879 (error "Possible s/blah// - do not know how to deal with"))
6880 (if sub-p (forward-sexp 1))
6881 (if (looking-at "\\sw*x")
6884 ;; Protect fragile " ", "#"
6887 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
6893 (defun cperl-beautify-regexp (&optional deep)
6894 "Do it. (Experimental, may change semantics, recheck the result.)
6895 We suppose that the regexp is scanned already."
6897 (setq deep (if deep (prefix-numeric-value deep) -1))
6899 (goto-char (cperl-make-regexp-x))
6900 (let ((b (point)) (e (make-marker)))
6902 (set-marker e (1- (point)))
6903 (cperl-beautify-regexp-piece b e nil deep))))
6905 (defun cperl-regext-to-level-start ()
6906 "Goto start of an enclosing group in regexp.
6907 We suppose that the regexp is scanned already."
6909 (let ((limit (cperl-make-regexp-x)) done)
6911 (or (eq (following-char) ?\()
6912 (search-backward "(" (1+ limit) t)
6913 (error "Cannot find `(' which starts a group"))
6916 (skip-chars-backward "\\")
6917 (looking-at "\\(\\\\\\\\\\)*(")))
6918 (or done (forward-char -1)))))
6920 (defun cperl-contract-level ()
6921 "Find an enclosing group in regexp and contract it.
6922 \(Experimental, may change semantics, recheck the result.)
6923 We suppose that the regexp is scanned already."
6925 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
6926 (cperl-regext-to-level-start)
6927 (let ((b (point)) (e (make-marker)) s c)
6929 (set-marker e (1- (point)))
6931 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
6933 ((match-beginning 1) ; #-comment
6934 (or c (setq c (current-indentation)))
6935 (beginning-of-line 2) ; Skip
6937 (skip-chars-forward " \t")
6938 (delete-region s (point))
6939 (indent-to-column c))
6942 (just-one-space))))))
6944 (defun cperl-contract-levels ()
6945 "Find an enclosing group in regexp and contract all the kids.
6946 \(Experimental, may change semantics, recheck the result.)
6947 We suppose that the regexp is scanned already."
6951 (cperl-regext-to-level-start)
6952 (error ; We are outside outermost group
6953 (goto-char (cperl-make-regexp-x))))
6954 (let ((b (point)) (e (make-marker)) s c)
6956 (set-marker e (1- (point)))
6958 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
6960 ((match-beginning 1) ; Skip
6963 (cperl-contract-level)))))))
6965 (defun cperl-beautify-level (&optional deep)
6966 "Find an enclosing group in regexp and beautify it.
6967 \(Experimental, may change semantics, recheck the result.)
6968 We suppose that the regexp is scanned already."
6970 (setq deep (if deep (prefix-numeric-value deep) -1))
6972 (cperl-regext-to-level-start)
6973 (let ((b (point)) (e (make-marker)))
6975 (set-marker e (1- (point)))
6976 (cperl-beautify-regexp-piece b e nil deep))))
6978 (defun cperl-invert-if-unless ()
6979 "Change `if (A) {B}' into `B if A;' etc if possible."
6981 (or (looking-at "\\<")
6983 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
6984 (let ((pos1 (point))
6985 pos2 pos3 pos4 pos5 s1 s2 state p pos45
6986 (s0 (buffer-substring (match-beginning 0) (match-end 0))))
6991 (if (eq (following-char) ?\( )
6998 ;; XXXX In fact may be `A if (B); {C}' ...
6999 (if (and (eq (following-char) ?\{ )
7001 (cperl-backward-to-noncomment pos3)
7002 (eq (preceding-char) ?\) )))
7003 (if (condition-case nil
7008 (looking-at "\\<els\\(e\\|if\\)\\>"))
7011 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" s0)
7012 (goto-char (1- pos5))
7013 (cperl-backward-to-noncomment pos4)
7014 (if (eq (preceding-char) ?\;)
7016 (setq pos45 (point))
7018 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
7019 (setq p (match-beginning 0)
7020 s1 (buffer-substring p (match-end 0))
7021 state (parse-partial-sexp pos4 p))
7025 (error "`%s' inside `%s' BLOCK" s1 s0))
7026 (goto-char (match-end 0)))
7028 (goto-char (1+ pos4))
7029 (skip-chars-forward " \t\n")
7030 (setq s2 (buffer-substring (point) pos45))
7032 (or (looking-at ";?[ \t\n]*}")
7034 (skip-chars-forward "; \t\n")
7035 (setq s2 (concat s2 "\n" (buffer-substring (point) (1- pos5))))))
7038 (goto-char (1- pos3))
7039 (cperl-backward-to-noncomment pos2)
7040 (or (looking-at "[ \t\n]*)")
7041 (goto-char (1- pos3)))
7043 (goto-char (1+ pos2))
7044 (skip-chars-forward " \t\n")
7045 (setq s1 (buffer-substring (point) p))
7046 (delete-region pos4 pos5)
7047 (delete-region pos2 pos3)
7054 (delete-horizontal-space)
7056 (delete-horizontal-space)
7059 (cperl-indent-line))
7060 (error "`%s' (EXPR) not with an {BLOCK}" s0)))
7061 (error "`%s' not with an (EXPR)" s0)))
7062 (error "Not at `if', `unless', `while', `until', `for' or `foreach'")))
7064 ;;; By Anthony Foiani <afoiani@uswest.com>
7065 ;;; Getting help on modules in C-h f ?
7066 ;;; This is a modified version of `man'.
7067 ;;; Need to teach it how to lookup functions
7068 (defun cperl-perldoc (word)
7069 "Run `perldoc' on WORD."
7071 (list (let* ((default-entry (cperl-word-at-point))
7073 (format "perldoc entry%s: "
7074 (if (string= default-entry "")
7076 (format " (default %s)" default-entry))))))
7077 (if (string= input "")
7078 (if (string= default-entry "")
7079 (error "No perldoc args given")
7083 (let* ((case-fold-search nil)
7085 (string-match "^[a-z]+$" word)
7086 (string-match (concat "^" word "\\>")
7087 (documentation-property
7089 'variable-documentation))))
7090 (manual-program (if is-func "perldoc -f" "perldoc")))
7093 (let ((Manual-program "perldoc")
7094 (Manual-switches (if is-func (list "-f"))))
7095 (manual-entry word)))
7097 (Man-getpage-in-background word)))))
7099 (defun cperl-perldoc-at-point ()
7100 "Run a `perldoc' on the word around point."
7102 (cperl-perldoc (cperl-word-at-point)))
7104 (defcustom pod2man-program "pod2man"
7105 "*File name for `pod2man'."
7109 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
7110 (defun cperl-pod-to-manpage ()
7111 "Create a virtual manpage in Emacs from the Perl Online Documentation."
7114 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
7115 (bufname (concat "Man " buffer-file-name))
7116 (buffer (generate-new-buffer bufname)))
7119 (let ((process-environment (copy-sequence process-environment)))
7120 ;; Prevent any attempt to use display terminal fanciness.
7121 (setenv "TERM" "dumb")
7122 (set-process-sentinel
7123 (start-process pod2man-program buffer "sh" "-c"
7124 (format (cperl-pod2man-build-command) pod2man-args))
7125 'Man-bgproc-sentinel)))))
7127 ;;; Updated version by him too
7128 (defun cperl-build-manpage ()
7129 "Create a virtual manpage in Emacs from the POD in the file."
7134 (let ((Manual-program "perldoc"))
7135 (manual-entry buffer-file-name)))
7137 (let* ((manual-program "perldoc"))
7138 (Man-getpage-in-background buffer-file-name)))))
7140 (defun cperl-pod2man-build-command ()
7141 "Builds the entire background manpage and cleaning command."
7142 (let ((command (concat pod2man-program " %s 2>/dev/null"))
7143 (flist Man-filter-list))
7144 (while (and flist (car flist))
7145 (let ((pcom (car (car flist)))
7146 (pargs (cdr (car flist))))
7148 (concat command " | " pcom " "
7149 (mapconcat '(lambda (phrase)
7150 (if (not (stringp phrase))
7151 (error "Malformed Man-filter-list"))
7154 (setq flist (cdr flist))))
7157 (defun cperl-lazy-install ()) ; Avoid a warning
7158 (defun cperl-lazy-unstall ()) ; Avoid a warning
7160 (if (fboundp 'run-with-idle-timer)
7162 (defvar cperl-help-shown nil
7163 "Non-nil means that the help was already shown now.")
7165 (defvar cperl-lazy-installed nil
7166 "Non-nil means that the lazy-help handlers are installed now.")
7168 (defun cperl-lazy-install ()
7169 "Switches on Auto-Help on Perl constructs (put in the message area).
7170 Delay of auto-help controlled by `cperl-lazy-help-time'."
7172 (make-variable-buffer-local 'cperl-help-shown)
7173 (if (and (cperl-val 'cperl-lazy-help-time)
7174 (not cperl-lazy-installed))
7176 (add-hook 'post-command-hook 'cperl-lazy-hook)
7177 (run-with-idle-timer
7178 (cperl-val 'cperl-lazy-help-time 1000000 5)
7180 'cperl-get-help-defer)
7181 (setq cperl-lazy-installed t))))
7183 (defun cperl-lazy-unstall ()
7184 "Switches off Auto-Help on Perl constructs (put in the message area).
7185 Delay of auto-help controlled by `cperl-lazy-help-time'."
7187 (remove-hook 'post-command-hook 'cperl-lazy-hook)
7188 (cancel-function-timers 'cperl-get-help-defer)
7189 (setq cperl-lazy-installed nil))
7191 (defun cperl-lazy-hook ()
7192 (setq cperl-help-shown nil))
7194 (defun cperl-get-help-defer ()
7195 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
7196 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
7198 (setq cperl-help-shown t))))
7199 (cperl-lazy-install)))
7202 ;;; Plug for wrong font-lock:
7204 (defun cperl-font-lock-unfontify-region-function (beg end)
7205 ;; Simplified now that font-lock-unfontify-region uses save-buffer-state.
7206 (let (before-change-functions after-change-functions)
7207 (remove-text-properties beg end '(face nil))))
7209 (defvar cperl-d-l nil)
7210 (defun cperl-fontify-syntaxically (end)
7211 ;; Some vars for debugging only
7212 ;; (message "Syntaxifying...")
7213 (let ((dbg (point)) (iend end)
7214 (istate (car cperl-syntax-state))
7216 (and cperl-syntaxify-unwind
7217 (setq end (cperl-unwind-to-safe t end)))
7218 (setq start (point))
7219 (or cperl-syntax-done-to
7220 (setq cperl-syntax-done-to (point-min)))
7221 (if (or (not (boundp 'font-lock-hot-pass))
7222 (eval 'font-lock-hot-pass)
7223 t) ; Not debugged otherwise
7224 ;; Need to forget what is after `start'
7225 (setq start (min cperl-syntax-done-to start))
7226 ;; Fontification without a change
7227 (setq start (max cperl-syntax-done-to start)))
7229 (setq cperl-syntax-done-to start) ; In case what follows fails
7230 (cperl-find-pods-heres start end t nil t))
7231 (if (eq cperl-syntaxify-by-font-lock 'message)
7232 (message "Syntaxified %s..%s from %s to %s(%s), state %s-->%s"
7234 start end cperl-syntax-done-to
7235 istate (car cperl-syntax-state))) ; For debugging
7236 nil)) ; Do not iterate
7238 (defun cperl-fontify-update (end)
7239 (let ((pos (point)) prop posend)
7241 (setq prop (get-text-property pos 'cperl-postpone))
7242 (setq posend (next-single-property-change pos 'cperl-postpone nil end))
7243 (and prop (put-text-property pos posend (car prop) (cdr prop)))
7245 nil) ; Do not iterate
7247 (defun cperl-update-syntaxification (from to)
7248 (if (and cperl-use-syntax-table-text-property
7249 cperl-syntaxify-by-font-lock
7250 (or (null cperl-syntax-done-to)
7251 (< cperl-syntax-done-to to)))
7255 (cperl-fontify-syntaxically to)))))
7257 (defvar cperl-version
7258 (let ((v "Revision: 5.0"))
7259 (string-match ":\\s *\\([0-9.]+\\)" v)
7260 (substring v (match-beginning 1) (match-end 1)))
7261 "Version of IZ-supported CPerl package this file is based on.")
7263 (provide 'cperl-mode)
7265 ;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
7266 ;;; cperl-mode.el ends here