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, 2003
4 ;; Free Software Foundation, Inc.
6 ;; Author: Ilya Zakharevich and Bob Olson
7 ;; Maintainer: Ilya Zakharevich <cperl@ilyaz.org>
8 ;; Keywords: languages, Perl
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
27 ;;; Corrections made by Ilya Zakharevich cperl@ilyaz.org
31 ;; You can either fine-tune the bells and whistles of this mode or
32 ;; bulk enable them by putting
34 ;; (setq cperl-hairy t)
36 ;; in your .emacs file. (Emacs rulers do not consider it politically
37 ;; correct to make whistles enabled by default.)
39 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
40 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
41 ;; `cperl-praise', `cperl-speed'. <<<<<<
43 ;; The mode information (on C-h m) provides some customization help.
44 ;; If you use font-lock feature of this mode, it is advisable to use
45 ;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
47 ;; Faces used now: three faces for first-class and second-class keywords
48 ;; and control flow words, one for each: comments, string, labels,
49 ;; functions definitions and packages, arrays, hashes, and variable
50 ;; definitions. If you do not see all these faces, your font-lock does
51 ;; not define them, so you need to define them manually.
53 ;; This mode supports font-lock, imenu and mode-compile. In the
54 ;; hairy version font-lock is on, but you should activate imenu
55 ;; yourself (note that mode-compile is not standard yet). Well, you
56 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
57 ;; to bind it like that:
59 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
61 ;;; Font lock bugs as of v4.32:
63 ;; The following kinds of Perl code erroneously start strings:
65 ;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
66 ;; likewise with m, tr, y, q, qX instead of s
70 ;; Some macros are needed for `defcustom'
75 (defconst cperl-xemacs-p
(string-match "XEmacs\\|Lucid" emacs-version
))
76 (defvar cperl-can-font-lock
78 (and (boundp 'emacs-major-version
)
80 (> emacs-major-version
20)))))
81 (if cperl-can-font-lock
83 (defvar msb-menu-cond
)
84 (defvar gud-perldb-history
)
85 (defvar font-lock-background-mode
) ; not in Emacs
86 (defvar font-lock-display-type
) ; ditto
87 (defmacro cperl-is-face
(arg) ; Takes quoted arg
88 (cond ((fboundp 'find-face
)
90 (;;(and (fboundp 'face-list)
93 `(member ,arg
(and (fboundp 'face-list
)
97 (defmacro cperl-make-face
(arg descr
) ; Takes unquoted arg
98 (cond ((fboundp 'make-face
)
99 `(make-face (quote ,arg
)))
101 `(defvar ,arg
(quote ,arg
) ,descr
))))
102 (defmacro cperl-force-face
(arg descr
) ; Takes unquoted arg
104 (or (cperl-is-face (quote ,arg
))
105 (cperl-make-face ,arg
,descr
))
106 (or (boundp (quote ,arg
)) ; We use unquoted variants too
107 (defvar ,arg
(quote ,arg
) ,descr
))))
109 (defmacro cperl-etags-snarf-tag
(file line
)
111 (beginning-of-line 2)
113 (defmacro cperl-etags-snarf-tag
(file line
)
116 (defmacro cperl-etags-goto-tag-location
(elt)
118 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
119 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
120 ;; Probably will not work due to some save-excursion???
121 ;; Or save-file-position?
122 ;; (message "Did I get to line %s?" (elt (, elt) 1))
123 `(goto-line (string-to-int (elt ,elt
1))))
125 (defmacro cperl-etags-goto-tag-location
(elt)
126 `(etags-goto-tag-location ,elt
))))
128 (defconst cperl-xemacs-p
(string-match "XEmacs\\|Lucid" emacs-version
))
130 (defvar cperl-can-font-lock
132 (and (boundp 'emacs-major-version
)
134 (> emacs-major-version
20)))))
136 (defun cperl-choose-color (&rest list
)
140 (if (or (x-color-defined-p (car list
))
142 (setq answer
(car list
))))
143 (setq list
(cdr list
)))
147 "Major mode for editing Perl code."
152 (defgroup cperl-indentation-details nil
157 (defgroup cperl-affected-by-hairy nil
158 "Variables affected by `cperl-hairy'."
162 (defgroup cperl-autoinsert-details nil
163 "Auto-insert tuneup."
167 (defgroup cperl-faces nil
168 "Fontification colors."
172 (defgroup cperl-speed nil
173 "Speed vs. validity tuneup."
177 (defgroup cperl-help-system nil
178 "Help system tuneup."
183 (defcustom cperl-extra-newline-before-brace nil
184 "*Non-nil means that if, elsif, while, until, else, for, foreach
185 and do constructs look like:
196 :group
'cperl-autoinsert-details
)
198 (defcustom cperl-extra-newline-before-brace-multiline
199 cperl-extra-newline-before-brace
200 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
201 for constructs with multiline if/unless/while/until/for/foreach condition."
203 :group
'cperl-autoinsert-details
)
205 (defcustom cperl-indent-level
2
206 "*Indentation of CPerl statements with respect to containing block."
208 :group
'cperl-indentation-details
)
210 (defcustom cperl-lineup-step nil
211 "*`cperl-lineup' will always lineup at multiple of this number.
212 If nil, the value of `cperl-indent-level' will be used."
213 :type
'(choice (const nil
) integer
)
214 :group
'cperl-indentation-details
)
216 (defcustom cperl-brace-imaginary-offset
0
217 "*Imagined indentation of a Perl open brace that actually follows a statement.
218 An open brace following other text is treated as if it were this far
219 to the right of the start of its line."
221 :group
'cperl-indentation-details
)
223 (defcustom cperl-brace-offset
0
224 "*Extra indentation for braces, compared with other text in same context."
226 :group
'cperl-indentation-details
)
227 (defcustom cperl-label-offset -
2
228 "*Offset of CPerl label lines relative to usual indentation."
230 :group
'cperl-indentation-details
)
231 (defcustom cperl-min-label-indent
1
232 "*Minimal offset of CPerl label lines."
234 :group
'cperl-indentation-details
)
235 (defcustom cperl-continued-statement-offset
2
236 "*Extra indent for lines not starting new statements."
238 :group
'cperl-indentation-details
)
239 (defcustom cperl-continued-brace-offset
0
240 "*Extra indent for substatements that start with open-braces.
241 This is in addition to cperl-continued-statement-offset."
243 :group
'cperl-indentation-details
)
244 (defcustom cperl-close-paren-offset -
1
245 "*Extra indent for substatements that start with close-parenthesis."
247 :group
'cperl-indentation-details
)
249 (defcustom cperl-auto-newline nil
250 "*Non-nil means automatically newline before and after braces,
251 and after colons and semicolons, inserted in CPerl code. The following
252 \\[cperl-electric-backspace] will remove the inserted whitespace.
253 Insertion after colons requires both this variable and
254 `cperl-auto-newline-after-colon' set."
256 :group
'cperl-autoinsert-details
)
258 (defcustom cperl-autoindent-on-semi nil
259 "*Non-nil means automatically indent after insertion of (semi)colon.
260 Active if `cperl-auto-newline' is false."
262 :group
'cperl-autoinsert-details
)
264 (defcustom cperl-auto-newline-after-colon nil
265 "*Non-nil means automatically newline even after colons.
266 Subject to `cperl-auto-newline' setting."
268 :group
'cperl-autoinsert-details
)
270 (defcustom cperl-tab-always-indent t
271 "*Non-nil means TAB in CPerl mode should always reindent the current line,
272 regardless of where in the line point is when the TAB command is used."
274 :group
'cperl-indentation-details
)
276 (defcustom cperl-font-lock nil
277 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
278 Can be overwritten by `cperl-hairy' if nil."
279 :type
'(choice (const null
) boolean
)
280 :group
'cperl-affected-by-hairy
)
282 (defcustom cperl-electric-lbrace-space nil
283 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
284 Can be overwritten by `cperl-hairy' if nil."
285 :type
'(choice (const null
) boolean
)
286 :group
'cperl-affected-by-hairy
)
288 (defcustom cperl-electric-parens-string
"({[]})<"
289 "*String of parentheses that should be electric in CPerl.
290 Closing ones are electric only if the region is highlighted."
292 :group
'cperl-affected-by-hairy
)
294 (defcustom cperl-electric-parens nil
295 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
296 Can be overwritten by `cperl-hairy' if nil."
297 :type
'(choice (const null
) boolean
)
298 :group
'cperl-affected-by-hairy
)
300 (defvar zmacs-regions
) ; Avoid warning
302 (defcustom cperl-electric-parens-mark
304 (or (and (boundp 'transient-mark-mode
) ; For Emacs
306 (and (boundp 'zmacs-regions
) ; For XEmacs
308 "*Not-nil means that electric parens look for active mark.
309 Default is yes if there is visual feedback on mark."
311 :group
'cperl-autoinsert-details
)
313 (defcustom cperl-electric-linefeed nil
314 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
315 In any case these two mean plain and hairy linefeeds together.
316 Can be overwritten by `cperl-hairy' if nil."
317 :type
'(choice (const null
) boolean
)
318 :group
'cperl-affected-by-hairy
)
320 (defcustom cperl-electric-keywords nil
321 "*Not-nil (and non-null) means keywords are electric in CPerl.
322 Can be overwritten by `cperl-hairy' if nil."
323 :type
'(choice (const null
) boolean
)
324 :group
'cperl-affected-by-hairy
)
326 (defcustom cperl-electric-backspace-untabify t
327 "*Not-nil means electric-backspace will untabify in CPerl."
329 :group
'cperl-autoinsert-details
)
331 (defcustom cperl-hairy nil
332 "*Not-nil means most of the bells and whistles are enabled in CPerl.
333 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
334 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
335 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
336 `cperl-lazy-help-time'."
338 :group
'cperl-affected-by-hairy
)
340 (defcustom cperl-comment-column
32
341 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
343 :group
'cperl-indentation-details
)
345 (defcustom cperl-vc-header-alist
'((SCCS "($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
346 (RCS "($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/) ;"))
347 "*What to use as `vc-header-alist' in CPerl."
348 :type
'(repeat (list symbol string
))
351 (defcustom cperl-clobber-mode-lists
354 (boundp 'interpreter-mode-alist
)
355 (assoc "miniperl" interpreter-mode-alist
)
356 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist
)))
357 "*Whether to install us into `interpreter-' and `extension' mode lists."
361 (defcustom cperl-info-on-command-no-prompt nil
362 "*Not-nil (and non-null) means not to prompt on C-h f.
363 The opposite behaviour is always available if prefixed with C-c.
364 Can be overwritten by `cperl-hairy' if nil."
365 :type
'(choice (const null
) boolean
)
366 :group
'cperl-affected-by-hairy
)
368 (defcustom cperl-clobber-lisp-bindings nil
369 "*Not-nil (and non-null) means not overwrite C-h f.
370 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
371 Can be overwritten by `cperl-hairy' if nil."
372 :type
'(choice (const null
) boolean
)
373 :group
'cperl-affected-by-hairy
)
375 (defcustom cperl-lazy-help-time nil
376 "*Not-nil (and non-null) means to show lazy help after given idle time.
377 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
378 :type
'(choice (const null
) (const nil
) integer
)
379 :group
'cperl-affected-by-hairy
)
381 (defcustom cperl-pod-face
'font-lock-comment-face
382 "*Face for POD highlighting."
386 (defcustom cperl-pod-head-face
'font-lock-variable-name-face
387 "*Face for POD highlighting.
388 Font for POD headers."
392 (defcustom cperl-here-face
'font-lock-string-face
393 "*Face for here-docs highlighting."
397 (defcustom cperl-invalid-face
'underline
398 "*Face for highlighting trailing whitespace."
403 (defcustom cperl-pod-here-fontify
'(featurep 'font-lock
)
404 "*Not-nil after evaluation means to highlight POD and here-docs sections."
408 (defcustom cperl-fontify-m-as-s t
409 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
413 (defcustom cperl-highlight-variables-indiscriminately nil
414 "*Non-nil means perform additional highlighting on variables.
415 Currently only changes how scalar variables are highlighted.
416 Note that that variable is only read at initialization time for
417 the variable `cperl-font-lock-keywords-2', so changing it after you've
418 entered CPerl mode the first time will have no effect."
422 (defcustom cperl-pod-here-scan t
423 "*Not-nil means look for POD and here-docs sections during startup.
424 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
428 (defcustom cperl-regexp-scan t
429 "*Not-nil means make marking of regular expression more thorough.
430 Effective only with `cperl-pod-here-scan'. Not implemented yet."
434 (defcustom cperl-imenu-addback nil
435 "*Not-nil means add backreferences to generated `imenu's.
436 May require patched `imenu' and `imenu-go'. Obsolete."
438 :group
'cperl-help-system
)
440 (defcustom cperl-max-help-size
66
441 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
442 :type
'(choice integer
(const nil
))
443 :group
'cperl-help-system
)
445 (defcustom cperl-shrink-wrap-info-frame t
446 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
448 :group
'cperl-help-system
)
450 (defcustom cperl-info-page
"perl"
451 "*Name of the info page containing perl docs.
452 Older version of this page was called `perl5', newer `perl'."
454 :group
'cperl-help-system
)
456 (defcustom cperl-use-syntax-table-text-property
457 (boundp 'parse-sexp-lookup-properties
)
458 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
462 (defcustom cperl-use-syntax-table-text-property-for-tags
463 cperl-use-syntax-table-text-property
464 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
468 (defcustom cperl-scan-files-regexp
"\\.\\([pP][Llm]\\|xs\\)$"
469 "*Regexp to match files to scan when generating TAGS."
473 (defcustom cperl-noscan-files-regexp
474 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
475 "*Regexp to match files/dirs to skip when generating TAGS."
479 (defcustom cperl-regexp-indent-step nil
480 "*Indentation used when beautifying regexps.
481 If nil, the value of `cperl-indent-level' will be used."
482 :type
'(choice integer
(const nil
))
483 :group
'cperl-indentation-details
)
485 (defcustom cperl-indent-left-aligned-comments t
486 "*Non-nil means that the comment starting in leftmost column should indent."
488 :group
'cperl-indentation-details
)
490 (defcustom cperl-under-as-char nil
491 "*Non-nil means that the _ (underline) should be treated as word char."
495 (defcustom cperl-extra-perl-args
""
496 "*Extra arguments to use when starting Perl.
497 Currently used with `cperl-check-syntax' only."
501 (defcustom cperl-message-electric-keyword t
502 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
504 :group
'cperl-help-system
)
506 (defcustom cperl-indent-region-fix-constructs
1
507 "*Amount of space to insert between `}' and `else' or `elsif'
508 in `cperl-indent-region'. Set to nil to leave as is. Values other
509 than 1 and nil will probably not work."
510 :type
'(choice (const nil
) (const 1))
511 :group
'cperl-indentation-details
)
513 (defcustom cperl-break-one-line-blocks-when-indent t
514 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
515 need to be reformatted into multiline ones when indenting a region."
517 :group
'cperl-indentation-details
)
519 (defcustom cperl-fix-hanging-brace-when-indent t
520 "*Non-nil means that BLOCK-end `}' may be put on a separate line
521 when indenting a region.
522 Braces followed by else/elsif/while/until are excepted."
524 :group
'cperl-indentation-details
)
526 (defcustom cperl-merge-trailing-else t
527 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
528 may be merged to be on the same line when indenting a region."
530 :group
'cperl-indentation-details
)
532 (defcustom cperl-indent-parens-as-block nil
533 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
534 but for trailing \",\" inside the group, which won't increase indentation.
535 One should tune up `cperl-close-paren-offset' as well."
537 :group
'cperl-indentation-details
)
539 (defcustom cperl-syntaxify-by-font-lock
540 (and cperl-can-font-lock
541 (boundp 'parse-sexp-lookup-properties
))
542 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
543 :type
'(choice (const message
) boolean
)
546 (defcustom cperl-syntaxify-unwind
548 "*Non-nil means that CPerl unwinds to a start of a long construction
549 when syntaxifying a chunk of buffer."
553 (defcustom cperl-ps-print-face-properties
554 '((font-lock-keyword-face nil nil bold shadow
)
555 (font-lock-variable-name-face nil nil bold
)
556 (font-lock-function-name-face nil nil bold italic box
)
557 (font-lock-constant-face nil
"LightGray" bold
)
558 (cperl-array-face nil
"LightGray" bold underline
)
559 (cperl-hash-face nil
"LightGray" bold italic underline
)
560 (font-lock-comment-face nil
"LightGray" italic
)
561 (font-lock-string-face nil nil italic underline
)
562 (cperl-nonoverridable-face nil nil italic underline
)
563 (font-lock-type-face nil nil underline
)
564 (underline nil
"LightGray" strikeout
))
565 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
566 :type
'(repeat (cons symbol
567 (cons (choice (const nil
) string
)
568 (cons (choice (const nil
) string
)
572 (defvar cperl-dark-background
573 (cperl-choose-color "navy" "os2blue" "darkgreen"))
574 (defvar cperl-dark-foreground
575 (cperl-choose-color "orchid1" "orange"))
577 (defface cperl-nonoverridable-face
578 `((((class grayscale
) (background light
))
579 (:background
"Gray90" :slant italic
:underline t
))
580 (((class grayscale
) (background dark
))
581 (:foreground
"Gray80" :slant italic
:underline t
:weight bold
))
582 (((class color
) (background light
))
583 (:foreground
"chartreuse3"))
584 (((class color
) (background dark
))
585 (:foreground
,cperl-dark-foreground
))
586 (t (:weight bold
:underline t
)))
587 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
590 (defface cperl-array-face
591 `((((class grayscale
) (background light
))
592 (:background
"Gray90" :weight bold
))
593 (((class grayscale
) (background dark
))
594 (:foreground
"Gray80" :weight bold
))
595 (((class color
) (background light
))
596 (:foreground
"Blue" :background
"lightyellow2" :weight bold
))
597 (((class color
) (background dark
))
598 (:foreground
"yellow" :background
,cperl-dark-background
:weight bold
))
600 "Font Lock mode face used to highlight array names."
603 (defface cperl-hash-face
604 `((((class grayscale
) (background light
))
605 (:background
"Gray90" :weight bold
:slant italic
))
606 (((class grayscale
) (background dark
))
607 (:foreground
"Gray80" :weight bold
:slant italic
))
608 (((class color
) (background light
))
609 (:foreground
"Red" :background
"lightyellow2" :weight bold
:slant italic
))
610 (((class color
) (background dark
))
611 (:foreground
"Red" :background
,cperl-dark-background
:weight bold
:slant italic
))
612 (t (:weight bold
:slant italic
)))
613 "Font Lock mode face used to highlight hash names."
618 ;;; Short extra-docs.
620 (defvar cperl-tips
'please-ignore-this-line
621 "Get maybe newer version of this package from
622 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
624 ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
625 Subdirectory `cperl-mode' may contain yet newer development releases and/or
626 patches to related files.
628 For best results apply to an older Emacs the patches from
629 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
630 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
631 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
632 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
634 Get support packages choose-color.el (or font-lock-extra.el before
635 19.30), imenu-go.el from the same place. \(Look for other files there
636 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
637 later you should use choose-color.el *instead* of font-lock-extra.el
638 \(and you will not get smart highlighting in C :-().
640 Note that to enable Compile choices in the menu you need to install
643 If your Emacs does not default to `cperl-mode' on Perl files, and you
644 want it to: put the following into your .emacs file:
646 (defalias 'perl-mode 'cperl-mode)
649 $CPAN/doc/manual/info/perl-info.tar.gz
651 http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
653 If you use imenu-go, run imenu on perl5-info buffer (you can do it
654 from Perl menu). If many files are related, generate TAGS files from
655 Tools/Tags submenu in Perl menu.
657 If some class structure is too complicated, use Tools/Hierarchy-view
658 from Perl menu, or hierarchic view of imenu. The second one uses the
659 current buffer only, the first one requires generation of TAGS from
660 Perl/Tools/Tags menu beforehand.
662 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
664 Switch auto-help on/off with Perl/Tools/Auto-help.
666 Though with contemporary Emaxen CPerl mode should maintain the correct
667 parsing of Perl even when editing, sometimes it may be lost. Fix this by
671 In cases of more severe confusion sometimes it is helpful to do
673 \\[load-library] cperl-mode RET
676 Before reporting (non-)problems look in the problem section of online
677 micro-docs on what I know about CPerl problems.")
679 (defvar cperl-problems
'please-ignore-this-line
680 "Description of problems in CPerl mode.
681 Some faces will not be shown on some versions of Emacs unless you
682 install choose-color.el, available from
683 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
685 `fill-paragraph' on a comment may leave the point behind the
686 paragraph. Parsing of lines with several <<EOF is not implemented
689 Emacs had a _very_ restricted syntax parsing engine until version
690 20.1. Most problems below are corrected starting from this version of
691 Emacs, and all of them should be fixed in version 20.3. (Or apply
692 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
693 this respect (until 2003).
695 Note that even with newer Emacsen in some very rare cases the details
696 of interaction of `font-lock' and syntaxification may be not cleaned
697 up yet. You may get slightly different colors basing on the order of
698 fontification and syntaxification. Say, the initial faces is correct,
699 but editing the buffer breaks this.
701 Even with older Emacsen CPerl mode tries to corrects some Emacs
702 misunderstandings, however, for efficiency reasons the degree of
703 correction is different for different operations. The partially
704 corrected problems are: POD sections, here-documents, regexps. The
705 operations are: highlighting, indentation, electric keywords, electric
708 This may be confusing, since the regexp s#//#/#\; may be highlighted
709 as a comment, but it will be recognized as a regexp by the indentation
710 code. Or the opposite case, when a POD section is highlighted, but
711 may break the indentation of the following code (though indentation
712 should work if the balance of delimiters is not broken by POD).
714 The main trick (to make $ a \"backslash\") makes constructions like
715 ${aaa} look like unbalanced braces. The only trick I can think of is
716 to insert it as $ {aaa} (legal in perl5, not in perl4).
718 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
719 as /($|\\s)/. Note that such a transposition is not always possible.
721 The solution is to upgrade your Emacs or patch an older one. Note
722 that Emacs 20.2 has some bugs related to `syntax-table' text
723 properties. Patches are available on the main CPerl download site,
726 If these bugs cannot be fixed on your machine (say, you have an inferior
727 environment and cannot recompile), you may still disable all the fancy stuff
728 via `cperl-use-syntax-table-text-property'.")
730 (defvar cperl-praise
'please-ignore-this-line
731 "Advantages of CPerl mode.
733 0) It uses the newest `syntax-table' property ;-);
735 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
736 mode - but the latter number may have improved too in last years) even
737 with old Emaxen which do not support `syntax-table' property.
739 When using `syntax-table' property for syntax assist hints, it should
740 handle 99.995% of lines correct - or somesuch. It automatically
741 updates syntax assist hints when you edit your script.
743 2) It is generally believed to be \"the most user-friendly Emacs
744 package\" whatever it may mean (I doubt that the people who say similar
745 things tried _all_ the rest of Emacs ;-), but this was not a lonely
748 3) Everything is customizable, one-by-one or in a big sweep;
750 4) It has many easily-accessable \"tools\":
751 a) Can run program, check syntax, start debugger;
752 b) Can lineup vertically \"middles\" of rows, like `=' in
755 c) Can insert spaces where this impoves readability (in one
756 interactive sweep over the buffer);
757 d) Has support for imenu, including:
758 1) Separate unordered list of \"interesting places\";
759 2) Separate TOC of POD sections;
760 3) Separate list of packages;
761 4) Hierarchical view of methods in (sub)packages;
762 5) and functions (by the full name - with package);
763 e) Has an interface to INFO docs for Perl; The interface is
764 very flexible, including shrink-wrapping of
765 documentation buffer/frame;
766 f) Has a builtin list of one-line explanations for perl constructs.
767 g) Can show these explanations if you stay long enough at the
768 corresponding place (or on demand);
769 h) Has an enhanced fontification (using 3 or 4 additional faces
770 comparing to font-lock - basically, different
771 namespaces in Perl have different colors);
772 i) Can construct TAGS basing on its knowledge of Perl syntax,
773 the standard menu has 6 different way to generate
774 TAGS (if \"by directory\", .xs files - with C-language
775 bindings - are included in the scan);
776 j) Can build a hierarchical view of classes (via imenu) basing
777 on generated TAGS file;
778 k) Has electric parentheses, electric newlines, uses Abbrev
779 for electric logical constructs
781 with different styles of expansion (context sensitive
782 to be not so bothering). Electric parentheses behave
783 \"as they should\" in a presence of a visible region.
784 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
790 n) Highlights (by user-choice) either 3-delimiters constructs
791 (such as tr/a/b/), or regular expressions and `y/tr';
792 o) Highlights trailing whitespace;
793 p) Is able to manipulate Perl Regular Expressions to ease
794 conversion to a more readable form.
796 5) The indentation engine was very smart, but most of tricks may be
797 not needed anymore with the support for `syntax-table' property. Has
798 progress indicator for indentation (with `imenu' loaded).
800 6) Indent-region improves inline-comments as well; also corrects
801 whitespace *inside* the conditional/loop constructs.
803 7) Fill-paragraph correctly handles multi-line comments;
805 8) Can switch to different indentation styles by one command, and restore
806 the settings present before the switch.
808 9) When doing indentation of control constructs, may correct
809 line-breaks/spacing between elements of the construct.
811 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
812 capable syntax engines).")
814 (defvar cperl-speed
'please-ignore-this-line
815 "This is an incomplete compendium of what is available in other parts
816 of CPerl documentation. (Please inform me if I skept anything.)
818 There is a perception that CPerl is slower than alternatives. This part
819 of documentation is designed to overcome this misconception.
821 *By default* CPerl tries to enable the most comfortable settings.
822 From most points of view, correctly working package is infinitely more
823 comfortable than a non-correctly working one, thus by default CPerl
824 prefers correctness over speed. Below is the guide how to change
825 settings if your preferences are different.
827 A) Speed of loading the file. When loading file, CPerl may perform a
828 scan which indicates places which cannot be parsed by primitive Emacs
829 syntax-parsing routines, and marks them up so that either
831 A1) CPerl may work around these deficiencies (for big chunks, mostly
832 PODs and HERE-documents), or
833 A2) On capable Emaxen CPerl will use improved syntax-handlings
834 which reads mark-up hints directly.
836 The scan in case A2 is much more comprehensive, thus may be slower.
838 User can disable syntax-engine-helping scan of A2 by setting
839 `cperl-use-syntax-table-text-property'
840 variable to nil (if it is set to t).
842 One can disable the scan altogether (both A1 and A2) by setting
843 `cperl-pod-here-scan'
846 B) Speed of editing operations.
848 One can add a (minor) speedup to editing operations by setting
849 `cperl-use-syntax-table-text-property'
850 variable to nil (if it is set to t). This will disable
851 syntax-engine-helping scan, thus will make many more Perl
852 constructs be wrongly recognized by CPerl, thus may lead to
853 wrongly matched parentheses, wrong indentation, etc.
855 One can unset `cperl-syntaxify-unwind'. This might speed up editing
856 of, say, long POD sections.")
858 (defvar cperl-tips-faces
'please-ignore-this-line
859 "CPerl mode uses following faces for highlighting:
861 `cperl-array-face' Array names
862 `cperl-hash-face' Hash names
863 `font-lock-comment-face' Comments, PODs and whatever is considered
864 syntaxically to be not code
865 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
866 2-arg operators s/y/tr/ or of RExen,
867 `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
868 a target of a file tests, file tests,
869 subroutine names at the moment of definition
870 (except those conflicting with Perl operators),
871 package names (when recognized), format names
872 `font-lock-keyword-face' Control flow switch constructs, declarators
873 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
874 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
875 literal parts and the terminator of formats
876 and whatever is syntaxically considered
878 `font-lock-type-face' Overridable keywords
879 `font-lock-variable-name-face' Variable declarations, indirect array and
880 hash names, POD headers/item names
881 `cperl-invalid-face' Trailing whitespace
883 Note that in several situations the highlighting tries to inform about
884 possible confusion, such as different colors for function names in
885 declarations depending on what they (do not) override, or special cases
886 m// and s/// which do not do what one would expect them to do.
888 Help with best setup of these faces for printout requested (for each of
889 the faces: please specify bold, italic, underline, shadow and box.)
895 ;;; Portability stuff:
897 (defmacro cperl-define-key
(emacs-key definition
&optional xemacs-key
)
898 `(define-key cperl-mode-map
900 `(if cperl-xemacs-p
,xemacs-key
,emacs-key
)
904 (defvar cperl-del-back-ch
905 (car (append (where-is-internal 'delete-backward-char
)
906 (where-is-internal 'backward-delete-char-untabify
)))
907 "Character generated by key bound to `delete-backward-char'.")
909 (and (vectorp cperl-del-back-ch
) (= (length cperl-del-back-ch
) 1)
910 (setq cperl-del-back-ch
(aref cperl-del-back-ch
0)))
912 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
915 ;; "Active regions" are on: use region only if active
916 ;; "Active regions" are off: use region unconditionally
917 (defun cperl-use-region-p ()
918 (if zmacs-regions
(mark) t
)))
919 (defun cperl-use-region-p ()
920 (if transient-mark-mode mark-active t
))
921 (defun cperl-mark-active () mark-active
))
923 (defsubst cperl-enable-font-lock
()
926 (defun cperl-putback-char (c) ; Emacs 19
927 (set 'unread-command-events
(list c
))) ; Avoid undefined warning
929 (if (boundp 'unread-command-events
)
931 (defun cperl-putback-char (c) ; XEmacs >= 19.12
932 (setq unread-command-events
(list (eval '(character-to-event c
))))))
933 (defun cperl-putback-char (c) ; XEmacs <= 19.11
934 (set 'unread-command-event
(eval '(character-to-event c
))))) ; Avoid warnings
936 (or (fboundp 'uncomment-region
)
937 (defun uncomment-region (beg end
)
939 (comment-region beg end -
1)))
941 (defvar cperl-do-not-fontify
942 (if (string< emacs-version
"19.30")
945 "Text property which inhibits refontification.")
947 (defsubst cperl-put-do-not-fontify
(from to
&optional post
)
948 ;; If POST, do not do it with postponed fontification
949 (if (and post cperl-syntaxify-by-font-lock
)
951 (put-text-property (max (point-min) (1- from
))
952 to cperl-do-not-fontify t
)))
954 (defcustom cperl-mode-hook nil
955 "Hook run by CPerl mode."
959 (defvar cperl-syntax-state nil
)
960 (defvar cperl-syntax-done-to nil
)
961 (defvar cperl-emacs-can-parse
(> (length (save-excursion
962 (parse-partial-sexp (point) (point)))) 9))
964 ;; Make customization possible "in reverse"
965 (defsubst cperl-val
(symbol &optional default hairy
)
967 ((eq (symbol-value symbol
) 'null
) default
)
968 (cperl-hairy (or hairy t
))
969 (t (symbol-value symbol
))))
971 ;;; Probably it is too late to set these guys already, but it can help later:
973 ;;;(and cperl-clobber-mode-lists
974 ;;;(setq auto-mode-alist
975 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
976 ;;;(and (boundp 'interpreter-mode-alist)
977 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
978 ;;; '(("miniperl" . perl-mode))))))
984 '(imenu easymenu etags timer man info
))
985 (if (fboundp 'ps-extend-face-list
)
986 (defmacro cperl-ps-extend-face-list
(arg)
987 `(ps-extend-face-list ,arg
))
988 (defmacro cperl-ps-extend-face-list
(arg)
989 `(error "This version of Emacs has no `ps-extend-face-list'")))
990 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
991 ;; macros instead of defsubsts don't work on Emacs, so we do the
992 ;; expansion manually. Any other suggestions?
995 (defvar cperl-mode-abbrev-table nil
996 "Abbrev table in use in CPerl mode buffers.")
998 (add-hook 'edit-var-mode-alist
'(perl-mode (regexp .
"^cperl-")))
1000 (defvar cperl-mode-map
() "Keymap used in CPerl mode.")
1002 (if cperl-mode-map nil
1003 (setq cperl-mode-map
(make-sparse-keymap))
1004 (cperl-define-key "{" 'cperl-electric-lbrace
)
1005 (cperl-define-key "[" 'cperl-electric-paren
)
1006 (cperl-define-key "(" 'cperl-electric-paren
)
1007 (cperl-define-key "<" 'cperl-electric-paren
)
1008 (cperl-define-key "}" 'cperl-electric-brace
)
1009 (cperl-define-key "]" 'cperl-electric-rparen
)
1010 (cperl-define-key ")" 'cperl-electric-rparen
)
1011 (cperl-define-key ";" 'cperl-electric-semi
)
1012 (cperl-define-key ":" 'cperl-electric-terminator
)
1013 (cperl-define-key "\C-j" 'newline-and-indent
)
1014 (cperl-define-key "\C-c\C-j" 'cperl-linefeed
)
1015 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless
)
1016 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline
)
1017 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev
)
1018 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix
)
1019 (cperl-define-key "\C-c\C-f" 'auto-fill-mode
)
1020 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric
)
1021 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp
)
1022 (cperl-define-key "\e\C-q" 'cperl-indent-exp
) ; Usually not bound
1023 (cperl-define-key [?\C-\M-\|
] 'cperl-lineup
1025 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1026 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1027 (cperl-define-key "\177" 'cperl-electric-backspace
)
1028 (cperl-define-key "\t" 'cperl-indent-command
)
1029 ;; don't clobber the backspace binding:
1030 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1031 [(control c
) (control h
) F
])
1032 (if (cperl-val 'cperl-clobber-lisp-bindings
)
1034 (cperl-define-key "\C-hf"
1035 ;;(concat (char-to-string help-char) "f") ; does not work
1036 'cperl-info-on-command
1038 (cperl-define-key "\C-hv"
1039 ;;(concat (char-to-string help-char) "v") ; does not work
1042 (cperl-define-key "\C-c\C-hf"
1043 ;;(concat (char-to-string help-char) "f") ; does not work
1044 (key-binding "\C-hf")
1045 [(control c
) (control h
) f
])
1046 (cperl-define-key "\C-c\C-hv"
1047 ;;(concat (char-to-string help-char) "v") ; does not work
1048 (key-binding "\C-hv")
1049 [(control c
) (control h
) v
]))
1050 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1051 [(control c
) (control h
) f
])
1052 (cperl-define-key "\C-c\C-hv"
1053 ;;(concat (char-to-string help-char) "v") ; does not work
1055 [(control c
) (control h
) v
]))
1056 (if (and cperl-xemacs-p
1057 (<= emacs-minor-version
11) (<= emacs-major-version
19))
1059 ;; substitute-key-definition is usefulness-deenhanced...
1060 (cperl-define-key "\M-q" 'cperl-fill-paragraph
)
1061 (cperl-define-key "\e;" 'cperl-indent-for-comment
)
1062 (cperl-define-key "\e\C-\\" 'cperl-indent-region
))
1063 (substitute-key-definition
1064 'indent-sexp
'cperl-indent-exp
1065 cperl-mode-map global-map
)
1066 (substitute-key-definition
1067 'fill-paragraph
'cperl-fill-paragraph
1068 cperl-mode-map global-map
)
1069 (substitute-key-definition
1070 'indent-region
'cperl-indent-region
1071 cperl-mode-map global-map
)
1072 (substitute-key-definition
1073 'indent-for-comment
'cperl-indent-for-comment
1074 cperl-mode-map global-map
)))
1077 (defvar cperl-lazy-installed
)
1078 (defvar cperl-old-style nil
)
1083 cperl-menu cperl-mode-map
"Menu for CPerl mode"
1085 ["Beginning of function" beginning-of-defun
t]
1086 ["End of function" end-of-defun
t]
1087 ["Mark function" mark-defun
t]
1088 ["Indent expression" cperl-indent-exp t
]
1089 ["Fill paragraph/comment" cperl-fill-paragraph t
]
1091 ["Line up a construction" cperl-lineup
(cperl-use-region-p)]
1092 ["Invert if/unless/while etc" cperl-invert-if-unless t
]
1094 ["Beautify" cperl-beautify-regexp
1095 cperl-use-syntax-table-text-property
]
1096 ["Beautify one level deep" (cperl-beautify-regexp 1)
1097 cperl-use-syntax-table-text-property
]
1098 ["Beautify a group" cperl-beautify-level
1099 cperl-use-syntax-table-text-property
]
1100 ["Beautify a group one level deep" (cperl-beautify-level 1)
1101 cperl-use-syntax-table-text-property
]
1102 ["Contract a group" cperl-contract-level
1103 cperl-use-syntax-table-text-property
]
1104 ["Contract groups" cperl-contract-levels
1105 cperl-use-syntax-table-text-property
])
1106 ["Refresh \"hard\" constructions" cperl-find-pods-heres t
]
1108 ["Indent region" cperl-indent-region
(cperl-use-region-p)]
1109 ["Comment region" cperl-comment-region
(cperl-use-region-p)]
1110 ["Uncomment region" cperl-uncomment-region
(cperl-use-region-p)]
1112 ["Run" mode-compile
(fboundp 'mode-compile
)]
1113 ["Kill" mode-compile-kill
(and (fboundp 'mode-compile-kill
)
1114 (get-buffer "*compilation*"))]
1115 ["Next error" next-error
(get-buffer "*compilation*")]
1116 ["Check syntax" cperl-check-syntax
(fboundp 'mode-compile
)]
1118 ["Debugger" cperl-db t
]
1121 ["Imenu" imenu
(fboundp 'imenu
)]
1122 ["Insert spaces if needed" cperl-find-bad-style t
]
1123 ["Class Hierarchy from TAGS" cperl-tags-hier-init t
]
1124 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1125 ["CPerl pretty print (exprmntl)" cperl-ps-print
1126 (fboundp 'ps-extend-face-list
)]
1127 ["Imenu on info" cperl-imenu-on-info
(featurep 'imenu
)]
1129 ;;; ["Create tags for current file" cperl-etags t]
1130 ;;; ["Add tags for current file" (cperl-etags t) t]
1131 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1132 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1133 ;;; ["Create tags for Perl files in (sub)directories"
1134 ;;; (cperl-etags nil 'recursive) t]
1135 ;;; ["Add tags for Perl files in (sub)directories"
1136 ;;; (cperl-etags t 'recursive) t])
1137 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1138 ["Create tags for current file" (cperl-write-tags nil t
) t
]
1139 ["Add tags for current file" (cperl-write-tags) t
]
1140 ["Create tags for Perl files in directory"
1141 (cperl-write-tags nil t nil t
) t
]
1142 ["Add tags for Perl files in directory"
1143 (cperl-write-tags nil nil nil t
) t
]
1144 ["Create tags for Perl files in (sub)directories"
1145 (cperl-write-tags nil t t t
) t
]
1146 ["Add tags for Perl files in (sub)directories"
1147 (cperl-write-tags nil nil t t
) t
]))
1149 ["Define word at point" imenu-go-find-at-position
1150 (fboundp 'imenu-go-find-at-position
)]
1151 ["Help on function" cperl-info-on-command t
]
1152 ["Help on function at point" cperl-info-on-current-command t
]
1153 ["Help on symbol at point" cperl-get-help t
]
1154 ["Perldoc" cperl-perldoc t
]
1155 ["Perldoc on word at point" cperl-perldoc-at-point t
]
1156 ["View manpage of POD in this file" cperl-build-manpage t
]
1157 ["Auto-help on" cperl-lazy-install
1158 (and (fboundp 'run-with-idle-timer
)
1159 (not cperl-lazy-installed
))]
1160 ["Auto-help off" cperl-lazy-unstall
1161 (and (fboundp 'run-with-idle-timer
)
1162 cperl-lazy-installed
)])
1164 ["Auto newline" cperl-toggle-auto-newline t
]
1165 ["Electric parens" cperl-toggle-electric t
]
1166 ["Electric keywords" cperl-toggle-abbrev t
]
1167 ["Fix whitespace on indent" cperl-toggle-construct-fix t
]
1168 ["Auto-help on Perl constructs" cperl-toggle-autohelp t
]
1169 ["Auto fill" auto-fill-mode t
])
1171 ["CPerl" (cperl-set-style "CPerl") t
]
1172 ["PerlStyle" (cperl-set-style "PerlStyle") t
]
1173 ["GNU" (cperl-set-style "GNU") t
]
1174 ["C++" (cperl-set-style "C++") t
]
1175 ["FSF" (cperl-set-style "FSF") t
]
1176 ["BSD" (cperl-set-style "BSD") t
]
1177 ["Whitesmith" (cperl-set-style "Whitesmith") t
]
1178 ["Current" (cperl-set-style "Current") t
]
1179 ["Memorized" (cperl-set-style-back) cperl-old-style
])
1181 ["Tips" (describe-variable 'cperl-tips
) t
]
1182 ["Problems" (describe-variable 'cperl-problems
) t
]
1183 ["Speed" (describe-variable 'cperl-speed
) t
]
1184 ["Praise" (describe-variable 'cperl-praise
) t
]
1185 ["Faces" (describe-variable 'cperl-tips-faces
) t
]
1186 ["CPerl mode" (describe-function 'cperl-mode
) t
]
1188 (message "The version of master-file for this CPerl is %s-Emacs"
1189 cperl-version
) t
]))))
1192 (autoload 'c-macro-expand
"cmacexp"
1193 "Display the result of expanding all C macros occurring in the region.
1194 The expansion is entirely correct because it uses the C preprocessor."
1197 (defvar cperl-imenu--function-name-regexp-perl
1200 "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
1202 "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
1205 (defvar cperl-outline-regexp
1206 (concat cperl-imenu--function-name-regexp-perl
"\\|" "\\`"))
1208 (defvar cperl-mode-syntax-table nil
1209 "Syntax table in use in CPerl mode buffers.")
1211 (defvar cperl-string-syntax-table nil
1212 "Syntax table in use in CPerl mode string-like chunks.")
1214 (if cperl-mode-syntax-table
1216 (setq cperl-mode-syntax-table
(make-syntax-table))
1217 (modify-syntax-entry ?
\\ "\\" cperl-mode-syntax-table
)
1218 (modify-syntax-entry ?
/ "." cperl-mode-syntax-table
)
1219 (modify-syntax-entry ?
* "." cperl-mode-syntax-table
)
1220 (modify-syntax-entry ?
+ "." cperl-mode-syntax-table
)
1221 (modify-syntax-entry ?-
"." cperl-mode-syntax-table
)
1222 (modify-syntax-entry ?
= "." cperl-mode-syntax-table
)
1223 (modify-syntax-entry ?%
"." cperl-mode-syntax-table
)
1224 (modify-syntax-entry ?
< "." cperl-mode-syntax-table
)
1225 (modify-syntax-entry ?
> "." cperl-mode-syntax-table
)
1226 (modify-syntax-entry ?
& "." cperl-mode-syntax-table
)
1227 (modify-syntax-entry ?$
"\\" cperl-mode-syntax-table
)
1228 (modify-syntax-entry ?
\n ">" 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 (if cperl-under-as-char
1233 (modify-syntax-entry ?_
"w" cperl-mode-syntax-table
))
1234 (modify-syntax-entry ?
: "_" cperl-mode-syntax-table
)
1235 (modify-syntax-entry ?|
"." cperl-mode-syntax-table
)
1236 (setq cperl-string-syntax-table
(copy-syntax-table cperl-mode-syntax-table
))
1237 (modify-syntax-entry ?$
"." cperl-string-syntax-table
)
1238 (modify-syntax-entry ?
# "." cperl-string-syntax-table
)) ; (?# comment )
1242 (defvar cperl-faces-init nil
)
1244 (defvar cperl-msb-fixed nil
)
1245 (defvar cperl-use-major-mode
'cperl-mode
)
1248 (defun cperl-mode ()
1249 "Major mode for editing Perl code.
1250 Expression and list commands understand all C brackets.
1251 Tab indents for Perl code.
1252 Paragraphs are separated by blank lines only.
1253 Delete converts tabs to spaces as it moves back.
1255 Various characters in Perl almost always come in pairs: {}, (), [],
1256 sometimes <>. When the user types the first, she gets the second as
1257 well, with optional special formatting done on {}. (Disabled by
1258 default.) You can always quote (with \\[quoted-insert]) the left
1259 \"paren\" to avoid the expansion. The processing of < is special,
1260 since most the time you mean \"less\". CPerl mode tries to guess
1261 whether you want to type pair <>, and inserts is if it
1262 appropriate. You can set `cperl-electric-parens-string' to the string that
1263 contains the parenths from the above list you want to be electrical.
1264 Electricity of parenths is controlled by `cperl-electric-parens'.
1265 You may also set `cperl-electric-parens-mark' to have electric parens
1266 look for active mark and \"embrace\" a region if possible.'
1268 CPerl mode provides expansion of the Perl control constructs:
1270 if, else, elsif, unless, while, until, continue, do,
1271 for, foreach, formy and foreachmy.
1273 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1275 The user types the keyword immediately followed by a space, which
1276 causes the construct to be expanded, and the point is positioned where
1277 she is most likely to want to be. eg. when the user types a space
1278 following \"if\" the following appears in the buffer: if () { or if ()
1279 } { } and the cursor is between the parentheses. The user can then
1280 type some boolean expression within the parens. Having done that,
1281 typing \\[cperl-linefeed] places you - appropriately indented - on a
1282 new line between the braces (if you typed \\[cperl-linefeed] in a POD
1283 directive line, then appropriate number of new lines is inserted).
1285 If CPerl decides that you want to insert \"English\" style construct like
1289 it will not do any expansion. See also help on variable
1290 `cperl-extra-newline-before-brace'. (Note that one can switch the
1291 help message on expansion by setting `cperl-message-electric-keyword'
1294 \\[cperl-linefeed] is a convenience replacement for typing carriage
1295 return. It places you in the next line with proper indentation, or if
1296 you type it inside the inline block of control construct, like
1298 foreach (@lines) {print; print}
1300 and you are on a boundary of a statement inside braces, it will
1301 transform the construct into a multiline and will place you into an
1302 appropriately indented blank line. If you need a usual
1303 `newline-and-indent' behaviour, it is on \\[newline-and-indent],
1304 see documentation on `cperl-electric-linefeed'.
1306 Use \\[cperl-invert-if-unless] to change a construction of the form
1316 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1317 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1318 on electric space between $ and {, `cperl-electric-parens-string' is
1319 the string that contains parentheses that should be electric in CPerl
1320 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1321 setting `cperl-electric-keywords' enables electric expansion of
1322 control structures in CPerl. `cperl-electric-linefeed' governs which
1323 one of two linefeed behavior is preferable. You can enable all these
1324 options simultaneously (recommended mode of use) by setting
1325 `cperl-hairy' to t. In this case you can switch separate options off
1326 by setting them to `null'. Note that one may undo the extra
1327 whitespace inserted by semis and braces in `auto-newline'-mode by
1328 consequent \\[cperl-electric-backspace].
1330 If your site has perl5 documentation in info format, you can use commands
1331 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1332 These keys run commands `cperl-info-on-current-command' and
1333 `cperl-info-on-command', which one is which is controlled by variable
1334 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1335 \(in turn affected by `cperl-hairy').
1337 Even if you have no info-format documentation, short one-liner-style
1338 help is available on \\[cperl-get-help], and one can run perldoc or
1341 It is possible to show this help automatically after some idle time.
1342 This is regulated by variable `cperl-lazy-help-time'. Default with
1343 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1344 secs idle time . It is also possible to switch this on/off from the
1345 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
1347 Use \\[cperl-lineup] to vertically lineup some construction - put the
1348 beginning of the region at the start of construction, and make region
1349 span the needed amount of lines.
1351 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1352 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1353 here-docs sections. With capable Emaxen results of scan are used
1354 for indentation too, otherwise they are used for highlighting only.
1356 Variables controlling indentation style:
1357 `cperl-tab-always-indent'
1358 Non-nil means TAB in CPerl mode should always reindent the current line,
1359 regardless of where in the line point is when the TAB command is used.
1360 `cperl-indent-left-aligned-comments'
1361 Non-nil means that the comment starting in leftmost column should indent.
1362 `cperl-auto-newline'
1363 Non-nil means automatically newline before and after braces,
1364 and after colons and semicolons, inserted in Perl code. The following
1365 \\[cperl-electric-backspace] will remove the inserted whitespace.
1366 Insertion after colons requires both this variable and
1367 `cperl-auto-newline-after-colon' set.
1368 `cperl-auto-newline-after-colon'
1369 Non-nil means automatically newline even after colons.
1370 Subject to `cperl-auto-newline' setting.
1371 `cperl-indent-level'
1372 Indentation of Perl statements within surrounding block.
1373 The surrounding block's indentation is the indentation
1374 of the line on which the open-brace appears.
1375 `cperl-continued-statement-offset'
1376 Extra indentation given to a substatement, such as the
1377 then-clause of an if, or body of a while, or just a statement continuation.
1378 `cperl-continued-brace-offset'
1379 Extra indentation given to a brace that starts a substatement.
1380 This is in addition to `cperl-continued-statement-offset'.
1381 `cperl-brace-offset'
1382 Extra indentation for line if it starts with an open brace.
1383 `cperl-brace-imaginary-offset'
1384 An open brace following other text is treated as if it the line started
1385 this far to the right of the actual line indentation.
1386 `cperl-label-offset'
1387 Extra indentation for line that is a label.
1388 `cperl-min-label-indent'
1389 Minimal indentation for line that is a label.
1391 Settings for K&R and BSD indentation styles are
1392 `cperl-indent-level' 5 8
1393 `cperl-continued-statement-offset' 5 8
1394 `cperl-brace-offset' -5 -8
1395 `cperl-label-offset' -5 -8
1397 CPerl knows several indentation styles, and may bulk set the
1398 corresponding variables. Use \\[cperl-set-style] to do this. Use
1399 \\[cperl-set-style-back] to restore the memorized preexisting values
1400 \(both available from menu).
1402 If `cperl-indent-level' is 0, the statement after opening brace in
1403 column 0 is indented on
1404 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1406 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1409 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1410 or as help on variables `cperl-tips', `cperl-problems',
1411 `cperl-praise', `cperl-speed'."
1413 (kill-all-local-variables)
1414 (use-local-map cperl-mode-map
)
1415 (if (cperl-val 'cperl-electric-linefeed
)
1417 (local-set-key "\C-J" 'cperl-linefeed
)
1418 (local-set-key "\C-C\C-J" 'newline-and-indent
)))
1420 (cperl-val 'cperl-clobber-lisp-bindings
)
1421 (cperl-val 'cperl-info-on-command-no-prompt
))
1423 ;; don't clobber the backspace binding:
1424 (cperl-define-key "\C-hf" 'cperl-info-on-current-command
[(control h
) f
])
1425 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1426 [(control c
) (control h
) f
])))
1427 (setq major-mode cperl-use-major-mode
)
1428 (setq mode-name
"CPerl")
1429 (if (not cperl-mode-abbrev-table
)
1430 (let ((prev-a-c abbrevs-changed
))
1431 (define-abbrev-table 'cperl-mode-abbrev-table
'(
1432 ("if" "if" cperl-electric-keyword
0)
1433 ("elsif" "elsif" cperl-electric-keyword
0)
1434 ("while" "while" cperl-electric-keyword
0)
1435 ("until" "until" cperl-electric-keyword
0)
1436 ("unless" "unless" cperl-electric-keyword
0)
1437 ("else" "else" cperl-electric-else
0)
1438 ("continue" "continue" cperl-electric-else
0)
1439 ("for" "for" cperl-electric-keyword
0)
1440 ("foreach" "foreach" cperl-electric-keyword
0)
1441 ("formy" "formy" cperl-electric-keyword
0)
1442 ("foreachmy" "foreachmy" cperl-electric-keyword
0)
1443 ("do" "do" cperl-electric-keyword
0)
1444 ("=pod" "=pod" cperl-electric-pod
0)
1445 ("=over" "=over" cperl-electric-pod
0)
1446 ("=head1" "=head1" cperl-electric-pod
0)
1447 ("=head2" "=head2" cperl-electric-pod
0)
1448 ("pod" "pod" cperl-electric-pod
0)
1449 ("over" "over" cperl-electric-pod
0)
1450 ("head1" "head1" cperl-electric-pod
0)
1451 ("head2" "head2" cperl-electric-pod
0)))
1452 (setq abbrevs-changed prev-a-c
)))
1453 (setq local-abbrev-table cperl-mode-abbrev-table
)
1454 (abbrev-mode (if (cperl-val 'cperl-electric-keywords
) 1 0))
1455 (set-syntax-table cperl-mode-syntax-table
)
1456 (make-local-variable 'outline-regexp
)
1457 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1458 (setq outline-regexp cperl-outline-regexp
)
1459 (make-local-variable 'outline-level
)
1460 (setq outline-level
'cperl-outline-level
)
1461 (make-local-variable 'paragraph-start
)
1462 (setq paragraph-start
(concat "^$\\|" page-delimiter
))
1463 (make-local-variable 'paragraph-separate
)
1464 (setq paragraph-separate paragraph-start
)
1465 (make-local-variable 'paragraph-ignore-fill-prefix
)
1466 (setq paragraph-ignore-fill-prefix t
)
1467 (make-local-variable 'indent-line-function
)
1468 (setq indent-line-function
'cperl-indent-line
)
1469 (make-local-variable 'require-final-newline
)
1470 (setq require-final-newline t
)
1471 (make-local-variable 'comment-start
)
1472 (setq comment-start
"# ")
1473 (make-local-variable 'comment-end
)
1474 (setq comment-end
"")
1475 (make-local-variable 'comment-column
)
1476 (setq comment-column cperl-comment-column
)
1477 (make-local-variable 'comment-start-skip
)
1478 (setq comment-start-skip
"#+ *")
1479 (make-local-variable 'defun-prompt-regexp
)
1480 (setq defun-prompt-regexp
"^[ \t]*sub[ \t]+\\([^ \t\n{(;]+\\)\\([ \t]*([^()]*)[ \t]*\\)?[ \t]*")
1481 (make-local-variable 'comment-indent-function
)
1482 (setq comment-indent-function
'cperl-comment-indent
)
1483 (make-local-variable 'parse-sexp-ignore-comments
)
1484 (setq parse-sexp-ignore-comments t
)
1485 (make-local-variable 'indent-region-function
)
1486 (setq indent-region-function
'cperl-indent-region
)
1487 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1488 (make-local-variable 'imenu-create-index-function
)
1489 (setq imenu-create-index-function
1490 (function cperl-imenu--create-perl-index
))
1491 (make-local-variable 'imenu-sort-function
)
1492 (setq imenu-sort-function nil
)
1493 (make-local-variable 'vc-header-alist
)
1494 (set 'vc-header-alist cperl-vc-header-alist
) ; Avoid warning
1495 (make-local-variable 'font-lock-defaults
)
1496 (setq font-lock-defaults
1498 ((string< emacs-version
"19.30")
1499 '(cperl-font-lock-keywords-2))
1500 ((string< emacs-version
"19.33") ; Which one to use?
1501 '((cperl-font-lock-keywords
1502 cperl-font-lock-keywords-1
1503 cperl-font-lock-keywords-2
)))
1505 '((cperl-load-font-lock-keywords
1506 cperl-load-font-lock-keywords-1
1507 cperl-load-font-lock-keywords-2
)))))
1508 (make-local-variable 'cperl-syntax-state
)
1509 (if cperl-use-syntax-table-text-property
1511 (make-local-variable 'parse-sexp-lookup-properties
)
1512 ;; Do not introduce variable if not needed, we check it!
1513 (set 'parse-sexp-lookup-properties t
)
1514 ;; Fix broken font-lock:
1515 (or (boundp 'font-lock-unfontify-region-function
)
1516 (set 'font-lock-unfontify-region-function
1517 'font-lock-default-unfontify-region
))
1518 (make-local-variable 'font-lock-unfontify-region-function
)
1519 (set 'font-lock-unfontify-region-function
; not present with old Emacs
1520 'cperl-font-lock-unfontify-region-function
)
1521 (make-local-variable 'cperl-syntax-done-to
)
1522 ;; Another bug: unless font-lock-syntactic-keywords, font-lock
1523 ;; ignores syntax-table text-property. (t) is a hack
1524 ;; to make font-lock think that font-lock-syntactic-keywords
1526 (make-local-variable 'font-lock-syntactic-keywords
)
1527 (setq font-lock-syntactic-keywords
1528 (if cperl-syntaxify-by-font-lock
1529 '(t (cperl-fontify-syntaxically))
1531 (make-local-variable 'cperl-old-style
)
1532 (if (boundp 'normal-auto-fill-function
) ; 19.33 and later
1533 (set (make-local-variable 'normal-auto-fill-function
)
1534 'cperl-do-auto-fill
) ; RMS has it as #'cperl-do-auto-fill ???
1535 (or (fboundp 'cperl-old-auto-fill-mode
)
1537 (fset 'cperl-old-auto-fill-mode
(symbol-function 'auto-fill-mode
))
1538 (defun auto-fill-mode (&optional arg
)
1540 (eval '(cperl-old-auto-fill-mode arg
)) ; Avoid a warning
1541 (and auto-fill-function
(memq major-mode
'(perl-mode cperl-mode
))
1542 (setq auto-fill-function
'cperl-do-auto-fill
))))))
1543 (if (cperl-enable-font-lock)
1544 (if (cperl-val 'cperl-font-lock
)
1545 (progn (or cperl-faces-init
(cperl-init-faces))
1546 (font-lock-mode 1))))
1547 (and (boundp 'msb-menu-cond
)
1548 (not cperl-msb-fixed
)
1550 (if (featurep 'easymenu
)
1551 (easy-menu-add cperl-menu
)) ; A NOP in Emacs.
1552 (run-hooks 'cperl-mode-hook
)
1553 ;; After hooks since fontification will break this
1554 (if cperl-pod-here-scan
1555 (or cperl-syntaxify-by-font-lock
1556 (progn (or cperl-faces-init
(cperl-init-faces-weak))
1557 (cperl-find-pods-heres)))))
1559 ;; Fix for perldb - make default reasonable
1563 (perldb (read-from-minibuffer "Run perldb (like this): "
1564 (if (consp gud-perldb-history
)
1565 (car gud-perldb-history
)
1566 (concat "perl " ;;(file-name-nondirectory
1570 (buffer-file-name)))
1572 '(gud-perldb-history .
1))))
1574 (defun cperl-msb-fix ()
1575 ;; Adds perl files to msb menu, supposes that msb is already loaded
1576 (setq cperl-msb-fixed t
)
1577 (let* ((l (length msb-menu-cond
))
1578 (last (nth (1- l
) msb-menu-cond
))
1579 (precdr (nthcdr (- l
2) msb-menu-cond
)) ; cdr of this is last
1580 (handle (1- (nth 1 last
))))
1581 (setcdr precdr
(list
1583 '(memq major-mode
'(cperl-mode perl-mode
))
1588 ;; This is used by indent-for-comment
1589 ;; to decide how much to indent a comment in CPerl code
1590 ;; based on its context. Do fallback if comment is found wrong.
1592 (defvar cperl-wrong-comment
)
1593 (defvar cperl-st-cfence
'(14)) ; Comment-fence
1594 (defvar cperl-st-sfence
'(15)) ; String-fence
1595 (defvar cperl-st-punct
'(1))
1596 (defvar cperl-st-word
'(2))
1597 (defvar cperl-st-bra
'(4 . ?\
>))
1598 (defvar cperl-st-ket
'(5 . ?\
<))
1601 (defun cperl-comment-indent ()
1602 (let ((p (point)) (c (current-column)) was phony
)
1603 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
1604 ;; Wrong comment found
1606 (setq was
(cperl-to-comment-or-eol)
1607 phony
(eq (get-text-property (point) 'syntax-table
)
1611 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1612 (if (eq (preceding-char) ?\
#)
1617 (skip-chars-backward " \t")
1618 (max (1+ (current-column)) ; Else indent at comment column
1621 (insert comment-start
)
1622 (backward-char (length comment-start
)))
1623 (setq cperl-wrong-comment t
)
1624 (indent-to comment-column
1) ; Indent minimum 1
1625 c
))))) ; except leave at least one space.
1627 ;;;(defun cperl-comment-indent-fallback ()
1628 ;;; "Is called if the standard comment-search procedure fails.
1629 ;;;Point is at start of real comment."
1630 ;;; (let ((c (current-column)) target cnt prevc)
1631 ;;; (if (= c comment-column) nil
1632 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1633 ;;; (setq target (max (1+ (setq prevc
1634 ;;; (current-column))) ; Else indent at comment column
1635 ;;; comment-column))
1636 ;;; (if (= c comment-column) nil
1637 ;;; (delete-backward-char cnt)
1638 ;;; (while (< prevc target)
1640 ;;; (setq prevc (current-column)))
1641 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1642 ;;; (while (< prevc target)
1644 ;;; (setq prevc (current-column)))))))
1646 (defun cperl-indent-for-comment ()
1647 "Substitute for `indent-for-comment' in CPerl."
1649 (let (cperl-wrong-comment)
1650 (indent-for-comment)
1651 (if cperl-wrong-comment
1652 (progn (cperl-to-comment-or-eol)
1653 (forward-char (length comment-start
))))))
1655 (defun cperl-comment-region (b e arg
)
1656 "Comment or uncomment each line in the region in CPerl mode.
1657 See `comment-region'."
1658 (interactive "r\np")
1659 (let ((comment-start "#"))
1660 (comment-region b e arg
)))
1662 (defun cperl-uncomment-region (b e arg
)
1663 "Uncomment or comment each line in the region in CPerl mode.
1664 See `comment-region'."
1665 (interactive "r\np")
1666 (let ((comment-start "#"))
1667 (comment-region b e
(- arg
))))
1669 (defvar cperl-brace-recursing nil
)
1671 (defun cperl-electric-brace (arg &optional only-before
)
1672 "Insert character and correct line's indentation.
1673 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1674 place (even in empty line), but not after. If after \")\" and the inserted
1675 char is \"{\", insert extra newline before only if
1676 `cperl-extra-newline-before-brace'."
1679 (other-end (if (and cperl-electric-parens-mark
1685 (not cperl-brace-recursing
)
1686 (cperl-val 'cperl-electric-parens
)
1687 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
1688 ;; Need to insert a matching pair
1691 (setq insertpos
(point-marker))
1692 (goto-char other-end
)
1693 (setq last-command-char ?\
{)
1694 (cperl-electric-lbrace arg insertpos
))
1696 ;; Check whether we close something "usual" with `}'
1697 (if (and (eq last-command-char ?\
})
1701 (up-list (- (prefix-numeric-value arg
)))
1702 ;;(cperl-after-block-p (point-min))
1703 (or (cperl-after-expr-p nil
"{;)")
1704 ;; after sub, else, continue
1705 (cperl-after-block-p nil
'pre
)))
1707 ;; Just insert the guy
1708 (self-insert-command (prefix-numeric-value arg
))
1709 (if (and (not arg
) ; No args, end (of empty line or auto)
1711 (or (and (null only-before
)
1713 (skip-chars-backward " \t")
1715 (and (eq last-command-char ?\
{) ; Do not insert newline
1716 ;; if after ")" and `cperl-extra-newline-before-brace'
1717 ;; is nil, do not insert extra newline.
1718 (not cperl-extra-newline-before-brace
)
1720 (skip-chars-backward " \t")
1721 (eq (preceding-char) ?\
))))
1722 (if cperl-auto-newline
1723 (progn (cperl-indent-line) (newline) t
) nil
)))
1725 (self-insert-command (prefix-numeric-value arg
))
1727 (if cperl-auto-newline
1728 (setq insertpos
(1- (point))))
1729 (if (and cperl-auto-newline
(null only-before
))
1732 (cperl-indent-line)))
1734 (if insertpos
(progn (goto-char insertpos
)
1735 (search-forward (make-string
1736 1 last-command-char
))
1737 (setq insertpos
(1- (point)))))
1741 (goto-char insertpos
)
1742 (self-insert-command (prefix-numeric-value arg
)))
1743 (self-insert-command (prefix-numeric-value arg
)))))))
1745 (defun cperl-electric-lbrace (arg &optional end
)
1746 "Insert character, correct line's indentation, correct quoting by space."
1748 (let ((cperl-brace-recursing t
)
1749 (cperl-auto-newline cperl-auto-newline
)
1751 (if (and cperl-electric-parens-mark
1759 (and (cperl-val 'cperl-electric-lbrace-space
)
1760 (eq (preceding-char) ?$
)
1762 (skip-chars-backward "$")
1763 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
1765 ;; Check whether we are in comment
1769 (not (looking-at "[ \t]*#")))
1770 (cperl-after-expr-p nil
"{;)"))
1772 (setq cperl-auto-newline nil
))
1773 (cperl-electric-brace arg
)
1774 (and (cperl-val 'cperl-electric-parens
)
1775 (eq last-command-char ?
{)
1776 (memq last-command-char
1777 (append cperl-electric-parens-string nil
))
1778 (or (if other-end
(goto-char (marker-position other-end
)))
1780 (setq last-command-char ?
} pos
(point))
1781 (progn (cperl-electric-brace arg t
)
1784 (defun cperl-electric-paren (arg)
1785 "Insert an opening parenthesis or a matching pair of parentheses.
1786 See `cperl-electric-parens'."
1788 (let ((beg (save-excursion (beginning-of-line) (point)))
1789 (other-end (if (and cperl-electric-parens-mark
1796 (if (and (cperl-val 'cperl-electric-parens
)
1797 (memq last-command-char
1798 (append cperl-electric-parens-string nil
))
1799 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1800 ;;(not (save-excursion (search-backward "#" beg t)))
1801 (if (eq last-command-char ?
<)
1803 (and abbrev-mode
; later it is too late, may be after `for'
1805 (cperl-after-expr-p nil
"{;(,:="))
1808 (self-insert-command (prefix-numeric-value arg
))
1809 (if other-end
(goto-char (marker-position other-end
)))
1810 (insert (make-string
1811 (prefix-numeric-value arg
)
1812 (cdr (assoc last-command-char
'((?
{ .?
})
1816 (forward-char (- (prefix-numeric-value arg
))))
1817 (self-insert-command (prefix-numeric-value arg
)))))
1819 (defun cperl-electric-rparen (arg)
1820 "Insert a matching pair of parentheses if marking is active.
1821 If not, or if we are not at the end of marking range, would self-insert.
1822 Affected by `cperl-electric-parens'."
1824 (let ((beg (save-excursion (beginning-of-line) (point)))
1825 (other-end (if (and cperl-electric-parens-mark
1826 (cperl-val 'cperl-electric-parens
)
1827 (memq last-command-char
1828 (append cperl-electric-parens-string nil
))
1835 (cperl-val 'cperl-electric-parens
)
1836 (memq last-command-char
'( ?\
) ?\
] ?\
} ?\
> ))
1837 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1838 ;;(not (save-excursion (search-backward "#" beg t)))
1841 (self-insert-command (prefix-numeric-value arg
))
1843 (if other-end
(goto-char other-end
))
1844 (insert (make-string
1845 (prefix-numeric-value arg
)
1846 (cdr (assoc last-command-char
'((?\
} . ?\
{)
1851 (self-insert-command (prefix-numeric-value arg
)))))
1853 (defun cperl-electric-keyword ()
1854 "Insert a construction appropriate after a keyword.
1855 Help message may be switched off by setting `cperl-message-electric-keyword'
1857 (let ((beg (save-excursion (beginning-of-line) (point)))
1858 (dollar (and (eq last-command-char ?$
)
1859 (eq this-command
'self-insert-command
)))
1860 (delete (and (memq last-command-char
'(?\ ?
\n ?
\t ?
\f))
1861 (memq this-command
'(self-insert-command newline
))))
1863 (and (save-excursion
1867 (setq do
(looking-at "do\\>")))
1869 (cperl-after-expr-p nil
"{;:"))
1873 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
1875 (save-excursion (or (not (re-search-backward "^=" nil t
))
1878 (and cperl-use-syntax-table-text-property
1879 (not (eq (get-text-property (point)
1882 (save-excursion (forward-sexp -
1)
1883 (not (memq (following-char) (append "$@%&*" nil
))))
1885 (and (eq (preceding-char) ?y
)
1886 (progn ; "foreachmy"
1892 (memq this-command
'(self-insert-command newline
)))))
1893 (and dollar
(insert " $"))
1895 ;;(insert " () {\n}")
1897 (cperl-extra-newline-before-brace
1898 (insert (if do
"\n" " ()\n"))
1904 (and do
(insert " while ();")))
1906 (insert (if do
" {\n} while ();" " () {\n}"))))
1907 (or (looking-at "[ \t]\\|$") (insert " "))
1909 (if dollar
(progn (search-backward "$")
1913 (search-backward ")")
1914 (if (eq last-command-char ?\
()
1915 (progn ; Avoid "if (())"
1916 (delete-backward-char 1)
1917 (delete-backward-char -
1))))
1919 (cperl-putback-char cperl-del-back-ch
))
1920 (if cperl-message-electric-keyword
1921 (message "Precede char by C-q to avoid expansion"))))))
1923 (defun cperl-ensure-newlines (n &optional pos
)
1924 "Make sure there are N newlines after the point."
1925 (or pos
(setq pos
(point)))
1926 (if (looking-at "\n")
1930 (cperl-ensure-newlines (1- n
) pos
)
1933 (defun cperl-electric-pod ()
1934 "Insert a POD chunk appropriate after a =POD directive."
1935 (let ((delete (and (memq last-command-char
'(?\ ?
\n ?
\t ?
\f))
1936 (memq this-command
'(self-insert-command newline
))))
1937 head1 notlast name p really-delete over
)
1938 (and (save-excursion
1941 (eq (preceding-char) ?
=)
1943 (setq head1
(looking-at "head1\\>[ \t]*$"))
1944 (setq over
(and (looking-at "over\\>[ \t]*$")
1945 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
1949 (get-text-property (point) 'in-pod
)
1950 (cperl-after-expr-p nil
"{;:")
1951 (and (re-search-backward
1952 ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
1953 "\\(\\`\n?\\|^\n\\)=\\sw+"
1957 (and cperl-use-syntax-table-text-property
1958 (not (eq (get-text-property (point) 'syntax-type
)
1962 (setq notlast
(re-search-forward "^\n=" nil t
)))
1966 (cperl-ensure-newlines 2)
1972 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
1973 nil t
)))) ; Only one
1976 (setq name
(file-name-sans-extension
1977 (file-name-nondirectory (buffer-file-name)))
1979 (insert " NAME\n\n" name
1980 " - \n\n=head1 SYNOPSIS\n\n\n\n"
1981 "=head1 DESCRIPTION")
1982 (cperl-ensure-newlines 4)
1986 (setq really-delete t
))
1991 (insert "\n\n=item \n\n\n\n"
1993 (cperl-ensure-newlines 2)
1997 (setq really-delete t
)))
1998 (if (and delete really-delete
)
1999 (cperl-putback-char cperl-del-back-ch
))))))
2001 (defun cperl-electric-else ()
2002 "Insert a construction appropriate after a keyword.
2003 Help message may be switched off by setting `cperl-message-electric-keyword'
2005 (let ((beg (save-excursion (beginning-of-line) (point))))
2006 (and (save-excursion
2008 (cperl-after-expr-p nil
"{;:"))
2012 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
2014 (save-excursion (or (not (re-search-backward "^=" nil t
))
2016 (and cperl-use-syntax-table-text-property
2017 (not (eq (get-text-property (point)
2022 ;;(insert " {\n\n}")
2024 (cperl-extra-newline-before-brace
2030 (insert " {\n\n}")))
2031 (or (looking-at "[ \t]\\|$") (insert " "))
2035 (cperl-putback-char cperl-del-back-ch
)
2036 (setq this-command
'cperl-electric-else
)
2037 (if cperl-message-electric-keyword
2038 (message "Precede char by C-q to avoid expansion"))))))
2040 (defun cperl-linefeed ()
2041 "Go to end of line, open a new line and indent appropriately.
2042 If in POD, insert appropriate lines."
2044 (let ((beg (save-excursion (beginning-of-line) (point)))
2045 (end (save-excursion (end-of-line) (point)))
2046 (pos (point)) start over cut res
)
2047 (if (and ; Check if we need to split:
2048 ; i.e., on a boundary and inside "{...}"
2049 (save-excursion (cperl-to-comment-or-eol)
2050 (>= (point) pos
)) ; Not in a comment
2052 (skip-chars-backward " \t" beg
)
2054 (looking-at "[;{]")) ; After { or ; + spaces
2055 (looking-at "[ \t]*}") ; Before }
2056 (re-search-forward "\\=[ \t]*;" end t
)) ; Before spaces + ;
2059 (eq (car (parse-partial-sexp pos end -
1)) -
1)
2060 ; Leave the level of parens
2061 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2063 (cperl-after-block-p (point-min))
2066 (setq start
(point-marker))
2067 (<= start pos
))))) ; Redundant? Are after the
2068 ; start of parens group.
2070 (skip-chars-backward " \t")
2071 (or (memq (preceding-char) (append ";{" nil
))
2077 (or (looking-at "{[ \t]*$") ; If there is a statement
2078 ; before, move it to separate line
2082 (cperl-indent-line)))
2083 (forward-line 1) ; We are on the target line
2086 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2087 ; after, move it to separate line
2090 (search-backward "}" beg
)
2091 (skip-chars-backward " \t")
2092 (or (memq (preceding-char) (append ";{" nil
))
2097 (forward-line -
1) ; We are on the line before target
2099 (newline-and-indent))
2100 (end-of-line) ; else - no splitting
2102 ((and (looking-at "\n[ \t]*{$")
2104 (skip-chars-backward " \t")
2105 (eq (preceding-char) ?\
)))) ; Probably if () {} group
2106 ; with an extra newline.
2108 (cperl-indent-line))
2109 ((save-excursion ; In POD header
2110 (forward-paragraph -
1)
2111 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2112 ;; We are after \n now, so look for the rest
2113 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
2115 (setq cut
(looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2116 (setq over
(looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2120 (forward-paragraph -
1)
2123 (setq cut
(buffer-substring (point)
2127 (delete-char (- (save-excursion (end-of-line) (point))
2129 (setq res
(expand-abbrev))
2135 (cperl-ensure-newlines (if cut
2 4))
2137 ((get-text-property (point) 'in-pod
) ; In POD section
2138 (cperl-ensure-newlines 4)
2140 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2142 (cperl-indent-line))
2144 (newline-and-indent))))))
2146 (defun cperl-electric-semi (arg)
2147 "Insert character and correct line's indentation."
2149 (if cperl-auto-newline
2150 (cperl-electric-terminator arg
)
2151 (self-insert-command (prefix-numeric-value arg
))
2152 (if cperl-autoindent-on-semi
2153 (cperl-indent-line))))
2155 (defun cperl-electric-terminator (arg)
2156 "Insert character and correct line's indentation."
2159 (auto (and cperl-auto-newline
2160 (or (not (eq last-command-char ?
:))
2161 cperl-auto-newline-after-colon
)))
2163 (if (and ;;(not arg)
2165 (not (save-excursion
2167 (skip-chars-forward " \t")
2169 ;; Ignore in comment lines
2170 (= (following-char) ?
#)
2171 ;; Colon is special only after a label
2172 ;; So quickly rule out most other uses of colon
2173 ;; and do no indentation for them.
2174 (and (eq last-command-char ?
:)
2177 (skip-chars-forward " \t")
2178 (and (< (point) end
)
2179 (progn (goto-char (- end
1))
2180 (not (looking-at ":"))))))
2182 (beginning-of-defun)
2183 (let ((pps (parse-partial-sexp (point) end
)))
2184 (or (nth 3 pps
) (nth 4 pps
) (nth 5 pps
))))))))
2186 (self-insert-command (prefix-numeric-value arg
))
2188 (if auto
(setq insertpos
(point-marker)))
2194 (cperl-indent-line)))
2196 (if insertpos
(goto-char (1- (marker-position insertpos
)))
2201 (goto-char insertpos
)
2202 (self-insert-command (prefix-numeric-value arg
)))
2203 (self-insert-command (prefix-numeric-value arg
)))))
2205 (defun cperl-electric-backspace (arg)
2206 "Backspace, or remove the whitespace around the point inserted by an electric
2207 key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2209 (if (and cperl-auto-newline
2210 (memq last-command
'(cperl-electric-semi
2211 cperl-electric-terminator
2212 cperl-electric-lbrace
))
2213 (memq (preceding-char) '(?\ ?
\t ?
\n)))
2215 (if (eq last-command
'cperl-electric-lbrace
)
2216 (skip-chars-forward " \t\n"))
2218 (skip-chars-backward " \t\n")
2219 (delete-region (point) p
))
2220 (and (eq last-command
'cperl-electric-else
)
2221 ;; We are removing the whitespace *inside* cperl-electric-else
2222 (setq this-command
'cperl-electric-else-really
))
2223 (if (and cperl-auto-newline
2224 (eq last-command
'cperl-electric-else-really
)
2225 (memq (preceding-char) '(?\ ?
\t ?
\n)))
2227 (skip-chars-forward " \t\n")
2229 (skip-chars-backward " \t\n")
2230 (delete-region (point) p
))
2231 (if cperl-electric-backspace-untabify
2232 (backward-delete-char-untabify arg
)
2233 (delete-backward-char arg
)))))
2235 (put 'cperl-electric-backspace
'delete-selection
'supersede
)
2237 (defun cperl-inside-parens-p ()
2241 (narrow-to-region (point)
2242 (progn (beginning-of-defun) (point)))
2243 (goto-char (point-max))
2244 (= (char-after (or (scan-lists (point) -
1 1) (point-min))) ?\
()))
2247 (defun cperl-indent-command (&optional whole-exp
)
2248 "Indent current line as Perl code, or in some cases insert a tab character.
2249 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2250 line. Otherwise, indent the current line only if point is at the left margin
2251 or in the line's indentation; otherwise insert a tab.
2253 A numeric argument, regardless of its value,
2254 means indent rigidly all the lines of the expression starting after point
2255 so that this line becomes properly indented.
2256 The relative indentation among the lines of the expression are preserved."
2258 (cperl-update-syntaxification (point) (point))
2260 ;; If arg, always indent this line as Perl
2261 ;; and shift remaining lines of expression the same amount.
2262 (let ((shift-amt (cperl-indent-line))
2265 (if cperl-tab-always-indent
2266 (beginning-of-line))
2273 (if (and shift-amt
(> end beg
))
2274 (indent-code-rigidly beg end shift-amt
"#")))
2275 (if (and (not cperl-tab-always-indent
)
2277 (skip-chars-backward " \t")
2280 (cperl-indent-line))))
2282 (defun cperl-indent-line (&optional parse-data
)
2283 "Indent current line as Perl code.
2284 Return the amount the indentation changed by."
2285 (let ((case-fold-search nil
)
2286 (pos (- (point-max) (point)))
2287 indent i beg shift-amt
)
2288 (setq indent
(cperl-calculate-indent parse-data
)
2292 (cond ((or (eq indent nil
) (eq indent t
))
2293 (setq indent
(current-indentation) i nil
))
2294 ;;((eq indent t) ; Never?
2295 ;; (setq indent (cperl-calculate-indent-within-comment)))
2296 ;;((looking-at "[ \t]*#")
2299 (skip-chars-forward " \t")
2300 (if (listp indent
) (setq indent
(car indent
)))
2301 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2303 (setq indent
(max cperl-min-label-indent
2304 (+ indent cperl-label-offset
)))))
2305 ((= (following-char) ?
})
2306 (setq indent
(- indent cperl-indent-level
)))
2307 ((memq (following-char) '(?\
) ?\
])) ; To line up with opening paren.
2308 (setq indent
(+ indent cperl-close-paren-offset
)))
2309 ((= (following-char) ?
{)
2310 (setq indent
(+ indent cperl-brace-offset
))))))
2311 (skip-chars-forward " \t")
2312 (setq shift-amt
(and i
(- indent
(current-column))))
2313 (if (or (not shift-amt
)
2315 (if (> (- (point-max) pos
) (point))
2316 (goto-char (- (point-max) pos
)))
2317 (delete-region beg
(point))
2319 ;; If initial point was within line's indentation,
2320 ;; position after the indentation. Else stay at same point in text.
2321 (if (> (- (point-max) pos
) (point))
2322 (goto-char (- (point-max) pos
))))
2325 (defun cperl-after-label ()
2326 ;; Returns true if the point is after label. Does not do save-excursion.
2327 (and (eq (preceding-char) ?
:)
2328 (memq (char-syntax (char-after (- (point) 2)))
2332 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2334 (defun cperl-get-state (&optional parse-start start-state
)
2335 ;; returns list (START STATE DEPTH PRESTART),
2336 ;; START is a good place to start parsing, or equal to
2337 ;; PARSE-START if preset,
2338 ;; STATE is what is returned by `parse-partial-sexp'.
2339 ;; DEPTH is true is we are immediately after end of block
2340 ;; which contains START.
2341 ;; PRESTART is the position basing on which START was found.
2343 (let ((start-point (point)) depth state start prestart
)
2344 (if (and parse-start
2345 (<= parse-start start-point
))
2346 (goto-char parse-start
)
2347 (beginning-of-defun)
2348 (setq start-state nil
))
2349 (setq prestart
(point))
2351 ;; Try to go out, if sub is not on the outermost level
2352 (while (< (point) start-point
)
2353 (setq start
(point) parse-start start depth nil
2354 state
(parse-partial-sexp start start-point -
1))
2355 (if (> (car state
) -
1) nil
2356 ;; The current line could start like }}}, so the indentation
2357 ;; corresponds to a different level than what we reached
2359 (beginning-of-line 2))) ; Go to the next line.
2360 (if start
(goto-char start
))) ; Not at the start of file
2361 (setq start
(point))
2362 (or state
(setq state
(parse-partial-sexp start start-point -
1 nil start-state
)))
2363 (list start state depth prestart
))))
2365 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
2366 ;; Positions is before ?\{. Checks whether it starts a block.
2367 ;; No save-excursion!
2368 (cperl-backward-to-noncomment (point-min))
2369 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil
)) ; Or label! \C-@ at bobp
2370 ; Label may be mixed up with `$blah :'
2371 (save-excursion (cperl-after-label))
2372 (and (memq (char-syntax (preceding-char)) '(?w ?_
))
2375 ;; Need take into account `bless', `return', `tr',...
2376 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
2377 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
2379 (skip-chars-backward " \t\n\f")
2380 (and (memq (char-syntax (preceding-char)) '(?w ?_
))
2384 "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
2386 (defvar cperl-look-for-prop
'((pod in-pod
) (here-doc-delim here-doc-group
)))
2388 (defun cperl-calculate-indent (&optional parse-data
) ; was parse-start
2389 "Return appropriate indentation for current line as Perl code.
2390 In usual case returns an integer: the column to indent to.
2391 Returns nil if line starts inside a string, t if in a comment.
2393 Will not correct the indentation for labels, but will correct it for braces
2394 and closing parentheses and brackets."
2395 (cperl-update-syntaxification (point) (point))
2398 (and (memq (get-text-property (point) 'syntax-type
)
2399 '(pod here-doc here-doc-delim format
))
2400 (not (get-text-property (point) 'indentable
)))
2401 ;; before start of POD - whitespace found since do not have 'pod!
2402 (and (looking-at "[ \t]*\n=")
2403 (error "Spaces before POD section!"))
2404 (and (not cperl-indent-left-aligned-comments
)
2408 (let ((indent-point (point))
2409 (char-after (save-excursion
2410 (skip-chars-forward " \t")
2412 (in-pod (get-text-property (point) 'in-pod
))
2413 (pre-indent-point (point))
2414 p prop look-prop is-block delim
)
2417 ;; In the verbatim part, probably code example. What to do???
2422 (cperl-backward-to-noncomment nil
)
2423 (setq p
(max (point-min) (1- (point)))
2424 prop
(get-text-property p
'syntax-type
)
2425 look-prop
(or (nth 1 (assoc prop cperl-look-for-prop
))
2427 (if (memq prop
'(pod here-doc format here-doc-delim
))
2429 (goto-char (or (previous-single-property-change p look-prop
)
2432 (setq pre-indent-point
(point)))))))
2433 (goto-char pre-indent-point
)
2434 (let* ((case-fold-search nil
)
2435 (s-s (cperl-get-state (car parse-data
) (nth 1 parse-data
)))
2436 (start (or (nth 2 parse-data
)
2439 (containing-sexp (car (cdr state
)))
2442 ;;containing-sexp ;; We are buggy at toplevel :-(
2445 (setcar parse-data pre-indent-point
)
2446 (setcar (cdr parse-data
) state
)
2447 (or (nth 2 parse-data
)
2448 (setcar (cddr parse-data
) start
))
2449 ;; Before this point: end of statement
2450 (setq old-indent
(nth 3 parse-data
))))
2451 (cond ((get-text-property (point) 'indentable
)
2452 ;; indent to just after the surrounding open,
2453 ;; skip blanks if we do not close the expression.
2454 (goto-char (1+ (previous-single-property-change (point) 'indentable
)))
2455 (or (memq char-after
(append ")]}" nil
))
2456 (looking-at "[ \t]*\\(#\\|$\\)")
2457 (skip-chars-forward " \t"))
2459 ((or (nth 3 state
) (nth 4 state
))
2460 ;; return nil or t if should not change this line
2462 ;; XXXX Do we need to special-case this?
2463 ((null containing-sexp
)
2464 ;; Line is at top level. May be data or function definition,
2465 ;; or may be function argument declaration.
2466 ;; Indent like the previous top level line
2467 ;; unless that ends in a closeparen without semicolon,
2468 ;; in which case this line is the first argument decl.
2469 (skip-chars-forward " \t")
2472 (- (current-indentation)
2473 (if (nth 2 s-s
) cperl-indent-level
0)))
2474 (if (= char-after ?
{) cperl-continued-brace-offset
0)
2476 (cperl-backward-to-noncomment (or old-indent
(point-min)))
2477 ;; Look at previous line that's at column 0
2478 ;; to determine whether we are in top-level decls
2479 ;; or function's arg decls. Set basic-indent accordingly.
2480 ;; Now add a little if this is a continuation line.
2482 (eq (point) old-indent
) ; old-indent was at comment
2483 (eq (preceding-char) ?\
;)
2485 (and (eq (preceding-char) ?\
})
2486 (cperl-after-block-and-statement-beg
2487 (point-min))) ; Was start - too close
2488 (memq char-after
(append ")]}" nil
))
2489 (and (eq (preceding-char) ?\
:) ; label
2492 (skip-chars-backward " \t")
2493 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
2494 (get-text-property (point) 'first-format-line
))
2497 (not (eq char-after ?\C-j
)))
2498 (setcdr (cddr parse-data
)
2499 (list pre-indent-point
)))
2501 cperl-continued-statement-offset
))))
2504 (and (setq delim
(= (char-after containing-sexp
) ?
{))
2505 (save-excursion ; Is it a hash?
2506 (goto-char containing-sexp
)
2508 cperl-indent-parens-as-block
))
2509 ;; group is an expression, not a block:
2510 ;; indent to just after the surrounding open parens,
2511 ;; skip blanks if we do not close the expression.
2512 (goto-char (1+ containing-sexp
))
2513 (or (memq char-after
2514 (append (if delim
"}" ")]}") nil
))
2515 (looking-at "[ \t]*\\(#\\|$\\)")
2516 (skip-chars-forward " \t"))
2519 (eq char-after ?\
}))
2520 ;; Correct indentation of trailing ?\}
2521 (+ cperl-indent-level cperl-close-paren-offset
)
2523 ;;; ((and (/= (char-after containing-sexp) ?{)
2524 ;;; (not cperl-indent-parens-as-block))
2525 ;;; ;; line is expression, not statement:
2526 ;;; ;; indent to just after the surrounding open,
2527 ;;; ;; skip blanks if we do not close the expression.
2528 ;;; (goto-char (1+ containing-sexp))
2529 ;;; (or (memq char-after (append ")]}" nil))
2530 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2531 ;;; (skip-chars-forward " \t"))
2532 ;;; (current-column))
2534 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
2535 ;;; (goto-char containing-sexp)
2536 ;;; (and (not (cperl-block-p))
2537 ;;; (not cperl-indent-parens-as-block)))
2538 ;;; (goto-char (1+ containing-sexp))
2539 ;;; (or (eq char-after ?\})
2540 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2541 ;;; (skip-chars-forward " \t"))
2542 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
2543 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
2544 ;;; cperl-close-paren-offset)
2547 ;; Statement level. Is it a continuation or a new statement?
2548 ;; Find previous non-comment character.
2549 (goto-char pre-indent-point
)
2550 (cperl-backward-to-noncomment containing-sexp
)
2551 ;; Back up over label lines, since they don't
2552 ;; affect whether our line is a continuation.
2554 (while ;;(or (eq (preceding-char) ?\,)
2555 (and (eq (preceding-char) ?
:)
2556 (or ;;(eq (char-after (- (point) 2)) ?\') ; ????
2557 (memq (char-syntax (char-after (- (point) 2)))
2560 (if (eq (preceding-char) ?\
,)
2561 ;; Will go to beginning of line, essentially.
2562 ;; Will ignore embedded sexpr XXXX.
2563 (cperl-backward-to-start-of-continued-exp containing-sexp
))
2565 (cperl-backward-to-noncomment containing-sexp
))
2566 ;; Now we get the answer.
2567 (if (not (or (eq (1- (point)) containing-sexp
)
2568 (memq (preceding-char)
2569 (append (if is-block
" ;{" " ,;{") '(nil)))
2570 (and (eq (preceding-char) ?\
})
2571 (cperl-after-block-and-statement-beg
2573 (get-text-property (point) 'first-format-line
)))
2574 ;; This line is continuation of preceding line's statement;
2575 ;; indent `cperl-continued-statement-offset' more than the
2576 ;; previous line of the statement.
2578 ;; There might be a label on this line, just
2579 ;; consider it bad style and ignore it.
2581 (cperl-backward-to-start-of-continued-exp containing-sexp
)
2582 (+ (if (memq char-after
(append "}])" nil
))
2584 cperl-continued-statement-offset
)
2587 (not (eq char-after ?\
})))
2589 ;; Now it is a hash reference
2590 (+ cperl-indent-level cperl-close-paren-offset
))
2591 (if (looking-at "\\w+[ \t]*:")
2592 (if (> (current-indentation) cperl-min-label-indent
)
2593 (- (current-indentation) cperl-label-offset
)
2594 ;; Do not move `parse-data', this should
2595 ;; be quick anyway (this comment comes
2596 ;; from different location):
2597 (cperl-calculate-indent))
2599 (if (eq char-after ?\
{)
2600 cperl-continued-brace-offset
0)))
2601 ;; This line starts a new statement.
2602 ;; Position following last unclosed open.
2603 (goto-char containing-sexp
)
2604 ;; Is line first statement after an open-brace?
2606 ;; If no, find that first statement and indent like
2607 ;; it. If the first statement begins with label, do
2608 ;; not believe when the indentation of the label is too
2612 (setq old-indent
(current-indentation))
2613 (let ((colon-line-end 0))
2615 (progn (skip-chars-forward " \t\n")
2616 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
2617 ;; Skip over comments and labels following openbrace.
2618 (cond ((= (following-char) ?\
#)
2620 ((= (following-char) ?\
=)
2622 (or (next-single-property-change (point) 'in-pod
)
2623 (point-max)))) ; do not loop if no syntaxification
2626 (save-excursion (end-of-line)
2627 (setq colon-line-end
(point)))
2628 (search-forward ":"))))
2629 ;; The first following code counts
2630 ;; if it is before the line we want to indent.
2631 (and (< (point) indent-point
)
2632 (if (> colon-line-end
(point)) ; After label
2633 (if (> (current-indentation)
2634 cperl-min-label-indent
)
2635 (- (current-indentation) cperl-label-offset
)
2636 ;; Do not believe: `max' is involved
2637 (+ old-indent cperl-indent-level
))
2638 (current-column)))))
2639 ;; If no previous statement,
2640 ;; indent it relative to line brace is on.
2641 ;; For open brace in column zero, don't let statement
2642 ;; start there too. If cperl-indent-level is zero,
2643 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2644 ;; For open-braces not the first thing in a line,
2645 ;; add in cperl-brace-imaginary-offset.
2647 ;; If first thing on a line: ?????
2648 (+ (if (and (bolp) (zerop cperl-indent-level
))
2649 (+ cperl-brace-offset cperl-continued-statement-offset
)
2653 (not (eq char-after ?\
})))
2655 ;; Now it is a hash reference
2656 (+ cperl-indent-level cperl-close-paren-offset
))
2657 ;; Move back over whitespace before the openbrace.
2658 ;; If openbrace is not first nonwhite thing on the line,
2659 ;; add the cperl-brace-imaginary-offset.
2660 (progn (skip-chars-backward " \t")
2661 (if (bolp) 0 cperl-brace-imaginary-offset
))
2662 ;; If the openbrace is preceded by a parenthesized exp,
2663 ;; move to the beginning of that;
2664 ;; possibly a different line
2666 (if (eq (preceding-char) ?\
))
2668 ;; In the case it starts a subroutine, indent with
2669 ;; respect to `sub', not with respect to the
2670 ;; first thing on the line, say in the case of
2671 ;; anonymous sub in a hash.
2673 (skip-chars-backward " \t")
2674 (if (and (eq (preceding-char) ?b
)
2677 (looking-at "sub\\>"))
2681 (save-excursion (beginning-of-line) (point))
2683 (progn (goto-char (1+ old-indent
))
2684 (skip-chars-forward " \t")
2686 ;; Get initial indentation of the line we are on.
2687 ;; If line starts with label, calculate label indentation
2690 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2691 (if (> (current-indentation) cperl-min-label-indent
)
2692 (- (current-indentation) cperl-label-offset
)
2693 ;; Do not move `parse-data', this should
2695 (cperl-calculate-indent))
2696 (current-indentation))))))))))))))
2698 (defvar cperl-indent-alist
2702 (toplevel-after-parenth 2)
2703 (toplevel-continued 2)
2705 "Alist of indentation rules for CPerl mode.
2708 number: add this amount of indentation.
2710 Not finished, not used.")
2712 (defun cperl-where-am-i (&optional parse-start start-state
)
2714 "Return a list of lists ((TYPE POS)...) of good points before the point.
2715 POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2717 Not finished, not used."
2719 (let* ((start-point (point))
2720 (s-s (cperl-get-state))
2723 (prestart (nth 3 s-s
))
2724 (containing-sexp (car (cdr state
)))
2725 (case-fold-search nil
)
2726 (res (list (list 'parse-start start
) (list 'parse-prestart prestart
))))
2727 (cond ((nth 3 state
) ; In string
2728 (setq res
(cons (list 'string nil
(nth 3 state
)) res
))) ; What started string
2729 ((nth 4 state
) ; In comment
2730 (setq res
(cons '(comment) res
)))
2731 ((null containing-sexp
)
2732 ;; Line is at top level.
2733 ;; Indent like the previous top level line
2734 ;; unless that ends in a closeparen without semicolon,
2735 ;; in which case this line is the first argument decl.
2736 (cperl-backward-to-noncomment (or parse-start
(point-min)))
2737 ;;(skip-chars-backward " \t\f\n")
2740 (memq (preceding-char) (append ";}" nil
)))
2741 (setq res
(cons (list 'toplevel start
) res
)))
2742 ((eq (preceding-char) ?\
) )
2743 (setq res
(cons (list 'toplevel-after-parenth start
) res
)))
2745 (setq res
(cons (list 'toplevel-continued start
) res
)))))
2746 ((/= (char-after containing-sexp
) ?
{)
2747 ;; line is expression, not statement:
2748 ;; indent to just after the surrounding open.
2749 ;; skip blanks if we do not close the expression.
2750 (setq res
(cons (list 'expression-blanks
2752 (goto-char (1+ containing-sexp
))
2753 (or (looking-at "[ \t]*\\(#\\|$\\)")
2754 (skip-chars-forward " \t"))
2756 (cons (list 'expression containing-sexp
) res
))))
2758 ;; Containing-expr starts with \{. Check whether it is a hash.
2759 (goto-char containing-sexp
)
2760 (not (cperl-block-p)))
2761 (setq res
(cons (list 'expression-blanks
2763 (goto-char (1+ containing-sexp
))
2764 (or (looking-at "[ \t]*\\(#\\|$\\)")
2765 (skip-chars-forward " \t"))
2767 (cons (list 'expression containing-sexp
) res
))))
2770 (setq res
(cons (list 'in-block containing-sexp
) res
))
2771 ;; Is it a continuation or a new statement?
2772 ;; Find previous non-comment character.
2773 (cperl-backward-to-noncomment containing-sexp
)
2774 ;; Back up over label lines, since they don't
2775 ;; affect whether our line is a continuation.
2776 ;; Back up comma-delimited lines too ?????
2777 (while (or (eq (preceding-char) ?\
,)
2778 (save-excursion (cperl-after-label)))
2779 (if (eq (preceding-char) ?\
,)
2780 ;; Will go to beginning of line, essentially
2781 ;; Will ignore embedded sexpr XXXX.
2782 (cperl-backward-to-start-of-continued-exp containing-sexp
))
2784 (cperl-backward-to-noncomment containing-sexp
))
2785 ;; Now we get the answer.
2786 (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
2787 ;; This line is continuation of preceding line's statement.
2788 (list (list 'statement-continued containing-sexp
))
2789 ;; This line starts a new statement.
2790 ;; Position following last unclosed open.
2791 (goto-char containing-sexp
)
2792 ;; Is line first statement after an open-brace?
2794 ;; If no, find that first statement and indent like
2795 ;; it. If the first statement begins with label, do
2796 ;; not believe when the indentation of the label is too
2800 (let ((colon-line-end 0))
2801 (while (progn (skip-chars-forward " \t\n" start-point
)
2802 (and (< (point) start-point
)
2804 "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
2805 ;; Skip over comments and labels following openbrace.
2806 (cond ((= (following-char) ?\
#)
2811 (save-excursion (end-of-line)
2812 (setq colon-line-end
(point)))
2813 (search-forward ":"))))
2814 ;; Now at the point, after label, or at start
2815 ;; of first statement in the block.
2816 (and (< (point) start-point
)
2817 (if (> colon-line-end
(point))
2818 ;; Before statement after label
2819 (if (> (current-indentation)
2820 cperl-min-label-indent
)
2821 (list (list 'label-in-block
(point)))
2822 ;; Do not believe: `max' is involved
2824 (list 'label-in-block-min-indent
(point))))
2826 (list 'statement-in-block
(point))))))
2827 ;; If no previous statement,
2828 ;; indent it relative to line brace is on.
2829 ;; For open brace in column zero, don't let statement
2830 ;; start there too. If cperl-indent-level is zero,
2831 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2832 ;; For open-braces not the first thing in a line,
2833 ;; add in cperl-brace-imaginary-offset.
2835 ;; If first thing on a line: ?????
2836 (+ (if (and (bolp) (zerop cperl-indent-level
))
2837 (+ cperl-brace-offset cperl-continued-statement-offset
)
2839 ;; Move back over whitespace before the openbrace.
2840 ;; If openbrace is not first nonwhite thing on the line,
2841 ;; add the cperl-brace-imaginary-offset.
2842 (progn (skip-chars-backward " \t")
2843 (if (bolp) 0 cperl-brace-imaginary-offset
))
2844 ;; If the openbrace is preceded by a parenthesized exp,
2845 ;; move to the beginning of that;
2846 ;; possibly a different line
2848 (if (eq (preceding-char) ?\
))
2850 ;; Get initial indentation of the line we are on.
2851 ;; If line starts with label, calculate label indentation
2854 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2855 (if (> (current-indentation) cperl-min-label-indent
)
2856 (- (current-indentation) cperl-label-offset
)
2857 (cperl-calculate-indent))
2858 (current-indentation))))))))
2861 (defun cperl-calculate-indent-within-comment ()
2862 "Return the indentation amount for line, assuming that
2863 the current line is to be regarded as part of a block comment."
2864 (let (end star-start
)
2867 (skip-chars-forward " \t")
2869 (and (= (following-char) ?
#)
2871 (cperl-to-comment-or-eol)
2877 (defun cperl-to-comment-or-eol ()
2878 "Go to position before comment on the current line, or to end of line.
2879 Returns true if comment is found."
2880 (let (state stop-in cpoint
(lim (progn (end-of-line) (point))))
2883 (eq (get-text-property (point) 'syntax-type
) 'pod
)
2884 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t
))
2885 (if (eq (preceding-char) ?\
#) (progn (backward-char 1) t
))
2887 (while (not stop-in
)
2888 (setq state
(parse-partial-sexp (point) lim nil nil nil t
))
2890 ;; If fails (beginning-of-line inside sexp), then contains not-comment
2891 (if (nth 4 state
) ; After `#';
2892 ; (nth 2 state) can be
2893 ; beginning of m,s,qq and so
2897 (setq cpoint
(point))
2898 (goto-char (nth 2 state
))
2900 ((looking-at "\\(s\\|tr\\)\\>")
2901 (or (re-search-forward
2902 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
2905 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
2906 (or (re-search-forward
2907 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
2910 (t ; It was fair comment
2911 (setq stop-in t
) ; Finish
2912 (goto-char (1- cpoint
)))))
2913 (setq stop-in t
) ; Finish
2915 (setq stop-in t
))) ; Finish
2918 (defsubst cperl-1-
(p)
2919 (max (point-min) (1- p
)))
2921 (defsubst cperl-1
+ (p)
2922 (min (point-max) (1+ p
)))
2924 (defsubst cperl-modify-syntax-type
(at how
)
2925 (if (< at
(point-max))
2927 (put-text-property at
(1+ at
) 'syntax-table how
)
2928 (put-text-property at
(1+ at
) 'rear-nonsticky t
))))
2930 (defun cperl-protect-defun-start (s e
)
2931 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2934 (while (re-search-forward "^\\s(" e
'to-end
)
2935 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct
))))
2937 (defun cperl-commentify (bb e string
&optional noface
)
2938 (if cperl-use-syntax-table-text-property
2939 (if (eq noface
'n
) ; Only immediate
2941 ;; We suppose that e is _after_ the end of construction, as after eol.
2942 (setq string
(if string cperl-st-sfence cperl-st-cfence
))
2944 ;; one-char string/comment?!
2945 (cperl-modify-syntax-type bb cperl-st-punct
)
2946 (cperl-modify-syntax-type bb string
)
2947 (cperl-modify-syntax-type (1- e
) string
))
2948 (if (and (eq string cperl-st-sfence
) (> (- e
2) bb
))
2949 (put-text-property (1+ bb
) (1- e
)
2950 'syntax-table cperl-string-syntax-table
))
2951 (cperl-protect-defun-start bb e
))
2954 (not cperl-pod-here-fontify
)
2955 (put-text-property bb e
'face
(if string
'font-lock-string-face
2956 'font-lock-comment-face
)))))
2958 (defvar cperl-starters
'(( ?\
( . ?\
) )
2963 (defun cperl-forward-re (lim end is-2arg set-st st-l err-l argument
2964 &optional ostart oend
)
2965 ;; Works *before* syntax recognition is done
2966 ;; May modify syntax-type text property if the situation is too hard
2967 (let (b starter ender st i i2 go-forward reset-st
)
2968 (skip-chars-forward " \t")
2969 ;; ender means matching-char matcher.
2971 starter
(if (eobp) 0 (char-after b
))
2972 ender
(cdr (assoc starter cperl-starters
)))
2973 ;; What if starter == ?\\ ????
2976 (setq st
(car st-l
))
2977 (setcar st-l
(make-syntax-table))
2978 (setq i
0 st
(car st-l
))
2980 (modify-syntax-entry i
"." st
)
2982 (modify-syntax-entry ?
\\ "\\" st
)))
2984 ;; Whether we have an intermediate point
2986 ;; Prepare the syntax table:
2988 (if (not ender
) ; m/blah/, s/x//, s/x/y/
2989 (modify-syntax-entry starter
"$" st
)
2990 (modify-syntax-entry starter
(concat "(" (list ender
)) st
)
2991 (modify-syntax-entry ender
(concat ")" (list starter
)) st
)))
2994 ;; We use `$' syntax class to find matching stuff, but $$
2995 ;; is recognized the same as $, so we need to check this manually.
2996 (if (and (eq starter
(char-after (cperl-1+ b
)))
2998 ;; $ has TeXish matching rules, so $$ equiv $...
3000 (setq reset-st
(syntax-table))
3001 (set-syntax-table st
)
3003 (if (<= (point) (1+ b
))
3004 (error "Unfinished regular expression"))
3005 (set-syntax-table reset-st
)
3007 ;; Now the problem is with m;blah;;
3009 (eq (preceding-char)
3010 (char-after (- (point) 2)))
3013 (= 0 (%
(skip-chars-backward "\\\\") 2)))
3015 ;; Now we are after the first part.
3016 (and is-2arg
; Have trailing part
3018 (eq (following-char) starter
) ; Empty trailing part
3020 (or (eq (char-syntax (following-char)) ?.
)
3021 ;; Make trailing letter into punctuation
3022 (cperl-modify-syntax-type (point) cperl-st-punct
))
3023 (setq is-2arg nil go-forward t
))) ; Ignore the tail
3024 (if is-2arg
; Not number => have second part
3026 (setq i
(point) i2 i
)
3028 (if (memq (following-char) '(?\ ?
\t ?
\n ?
\f))
3030 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3031 (goto-char (match-end 0))
3032 (skip-chars-forward " \t\n\f"))
3035 (modify-syntax-entry starter
(if (eq starter ?
\\) "\\" ".") st
)
3036 (if ender
(modify-syntax-entry ender
"." st
))
3038 (setq ender
(cperl-forward-re lim end nil t st-l err-l
3039 argument starter ender
)
3040 ender
(nth 2 ender
)))))
3041 (error (goto-char lim
)
3044 (set-syntax-table reset-st
))
3047 "End of `%s%s%c ... %c' string/RE not found: %s"
3049 (if ostart
(format "%c ... %c" ostart
(or oend ostart
)) "")
3050 starter
(or ender starter
) bb
)
3051 (or (car err-l
) (setcar err-l b
)))))
3054 (modify-syntax-entry starter
(if (eq starter ?
\\) "\\" ".") st
)
3055 (if ender
(modify-syntax-entry ender
"." st
))))
3056 ;; i: have 2 args, after end of the first arg
3057 ;; i2: start of the second arg, if any (before delim iff `ender').
3058 ;; ender: the last arg bounded by parens-like chars, the second one of them
3059 ;; starter: the starting delimiter of the first arg
3060 ;; go-forward: has 2 args, and the second part is empty
3061 (list i i2 ender starter go-forward
)))
3063 (defvar font-lock-string-face
)
3064 ;;(defvar font-lock-reference-face)
3065 (defvar font-lock-constant-face
)
3066 (defsubst cperl-postpone-fontification
(b e type val
&optional now
)
3067 ;; Do after syntactic fontification?
3068 (if cperl-syntaxify-by-font-lock
3069 (or now
(put-text-property b e
'cperl-postpone
(cons type val
)))
3070 (put-text-property b e type val
)))
3072 ;;; Here is how the global structures (those which cannot be
3073 ;;; recognized locally) are marked:
3075 ;; Start-to-end is marked `in-pod' ==> t
3076 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3077 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3079 ;; Start-to-end is marked `here-doc-group' ==> t
3080 ;; The body is marked `syntax-type' ==> `here-doc'
3081 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3083 ;; First line (to =) marked `first-format-line' ==> t
3084 ;; After-this--to-end is marked `syntax-type' ==> `format'
3085 ;; d) 'Q'uoted string:
3086 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3087 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3089 (defun cperl-unwind-to-safe (before &optional end
)
3090 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3091 (let ((pos (point)) opos
)
3093 (while (and pos
(get-text-property pos
'syntax-type
))
3094 (setq pos
(previous-single-property-change pos
'syntax-type
))
3098 (goto-char (cperl-1- pos
))
3101 (goto-char (setq pos
(cperl-1- pos
))))
3103 (goto-char (point-min))))
3105 (and (looking-at "\n*=")
3106 (/= 0 (skip-chars-backward "\n"))
3110 ;; Do the same for end, going small steps
3112 (while (and end
(get-text-property end
'syntax-type
))
3114 end
(next-single-property-change end
'syntax-type
)))
3117 (defvar cperl-nonoverridable-face
)
3118 (defvar font-lock-function-name-face
)
3119 (defvar font-lock-comment-face
)
3121 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max
)
3122 "Scans the buffer for hard-to-parse Perl constructions.
3123 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3124 the sections using `cperl-pod-head-face', `cperl-pod-face',
3127 (or min
(setq min
(point-min)
3128 cperl-syntax-state nil
3129 cperl-syntax-done-to min
))
3130 (or max
(setq max
(point-max)))
3131 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify
)) go tmpend
3132 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3133 is-REx is-x-REx REx-comment-start REx-comment-end was-comment i2
3134 (case-fold-search nil
) (inhibit-read-only t
) (buffer-undo-list t
)
3135 (modified (buffer-modified-p))
3136 (after-change-functions nil
)
3137 (use-syntax-state (and cperl-syntax-state
3138 (>= min
(car cperl-syntax-state
))))
3139 (state-point (if use-syntax-state
3140 (car cperl-syntax-state
)
3142 (state (if use-syntax-state
3143 (cdr cperl-syntax-state
)))
3144 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3145 (st-l (list nil
)) (err-l (list nil
))
3146 ;; Somehow font-lock may be not loaded yet...
3147 (font-lock-string-face (if (boundp 'font-lock-string-face
)
3148 font-lock-string-face
3149 'font-lock-string-face
))
3150 (font-lock-constant-face (if (boundp 'font-lock-constant-face
)
3151 font-lock-constant-face
3152 'font-lock-constant-face
))
3153 (font-lock-function-name-face
3154 (if (boundp 'font-lock-function-name-face
)
3155 font-lock-function-name-face
3156 'font-lock-function-name-face
))
3157 (font-lock-comment-face
3158 (if (boundp 'font-lock-comment-face
)
3159 font-lock-comment-face
3160 'font-lock-comment-face
))
3161 (cperl-nonoverridable-face
3162 (if (boundp 'cperl-nonoverridable-face
)
3163 cperl-nonoverridable-face
3164 'cperl-nonoverridable-face
))
3165 (stop-point (if ignore-max
3170 "\\(\\`\n?\\|^\n\\)="
3172 ;; One extra () before this:
3175 ;; First variant "BLAH" or just ``.
3176 "[ \t]*" ; Yes, whitespace is allowed!
3177 "\\([\"'`]\\)" ; 2 + 1 = 3
3178 "\\([^\"'`\n]*\\)" ; 3 + 1
3181 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3182 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3183 ;; Do not have <<= or << 30 or <<30 or << $blah.
3184 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3185 "\\(\\)" ; To preserve count of pars :-( 6 + 1
3188 ;; 1+6 extra () before this:
3189 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3190 (if cperl-use-syntax-table-text-property
3193 ;; 1+6+2=9 extra () before this:
3194 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3196 ;; 1+6+2+1=10 extra () before this:
3197 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3199 ;; 1+6+2+1+1=11 extra () before this:
3200 "\\<sub\\>[ \t]*\\([a-zA-Z_:'0-9]+[ \t]*\\)?\\(([^()]*)\\)"
3202 ;; 1+6+2+1+1+2=13 extra () before this:
3205 ;; 1+6+2+1+1+2+1=14 extra () before this:
3206 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3207 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3209 "__\\(END\\|DATA\\)__"
3210 ;; 1+6+2+1+1+2+1+1+1=16 extra () before this:
3212 "\\\\\\(['`\"($]\\)")
3218 (message "Scanning for \"hard\" Perl constructions..."))
3219 (and cperl-pod-here-fontify
3220 ;; We had evals here, do not know why...
3221 (setq face cperl-pod-face
3222 head-face cperl-pod-head-face
3223 here-face cperl-here-face
))
3224 (remove-text-properties min max
3225 '(syntax-type t in-pod t syntax-table t
3232 ;; Need to remove face as well...
3234 (and (eq system-type
'emx
)
3235 (looking-at "extproc[ \t]") ; Analogue of #!
3236 (cperl-commentify min
3237 (save-excursion (end-of-line) (point))
3241 (re-search-forward search max t
))
3242 (setq tmpend nil
) ; Valid for most cases
3244 ((match-beginning 1) ; POD section
3245 ;; "\\(\\`\n?\\|^\n\\)="
3246 (if (looking-at "cut\\>")
3248 nil
; Doing a chunk only
3249 (message "=cut is not preceded by a POD section")
3250 (or (car err-l
) (setcar err-l
(point))))
3255 tb
(match-beginning 0)
3256 b1 nil
) ; error condition
3257 ;; We do not search to max, since we may be called from
3258 ;; some hook of fontification, and max is random
3259 (or (re-search-forward "^\n=cut\\>" stop-point
'toend
)
3262 (if (re-search-forward "\n=cut\\>" stop-point
'toend
)
3264 (message "=cut is not preceded by an empty line")
3266 (or (car err-l
) (setcar err-l b
))))))
3267 (beginning-of-line 2) ; An empty line after =cut is not POD!
3271 (remove-text-properties
3272 max e
'(syntax-type t in-pod t syntax-table t
3280 (put-text-property b e
'in-pod t
)
3281 (put-text-property b e
'syntax-type
'in-pod
)
3283 (while (re-search-forward "\n\n[ \t]" e t
)
3284 ;; We start 'pod 1 char earlier to include the preceding line
3286 (put-text-property (cperl-1- b
) (point) 'syntax-type
'pod
)
3287 (cperl-put-do-not-fontify b
(point) t
)
3288 ;; mark the non-literal parts as PODs
3289 (if cperl-pod-here-fontify
3290 (cperl-postpone-fontification b
(point) 'face face t
))
3291 (re-search-forward "\n\n[^ \t\f\n]" e
'toend
)
3294 (put-text-property (cperl-1- (point)) e
'syntax-type
'pod
)
3295 (cperl-put-do-not-fontify (point) e t
)
3296 (if cperl-pod-here-fontify
3298 ;; mark the non-literal parts as PODs
3299 (cperl-postpone-fontification (point) e
'face face t
)
3302 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
3304 (cperl-postpone-fontification
3305 (match-beginning 1) (match-end 1)
3307 (while (re-search-forward
3309 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3312 (cperl-postpone-fontification
3313 (match-beginning 1) (match-end 1)
3315 (cperl-commentify bb e nil
)
3317 (or (eq e
(point-max))
3318 (forward-char -
1)))) ; Prepare for immediate POD start.
3320 ;; We do only one here-per-line
3321 ;; ;; One extra () before this:
3324 ;; ;; First variant "BLAH" or just ``.
3325 ;; "[ \t]*" ; Yes, whitespace is allowed!
3326 ;; "\\([\"'`]\\)" ; 2 + 1
3327 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3330 ;; ;; Second variant: Identifier or \ID or empty
3331 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3332 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3333 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3334 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3336 ((match-beginning 2) ; 1 + 1
3337 ;; Abort in comment:
3339 (setq state
(parse-partial-sexp state-point b nil nil state
)
3341 tb
(match-beginning 0)
3342 i
(or (nth 3 state
) (nth 4 state
)))
3347 (not (match-beginning 6)) ; Empty
3349 "[ \t]*[=0-9$@%&(]"))))
3350 (if c
; Not here-doc
3352 (if (match-beginning 5) ;4 + 1
3353 (setq b1
(match-beginning 5) ; 4 + 1
3354 e1
(match-end 5)) ; 4 + 1
3355 (setq b1
(match-beginning 4) ; 3 + 1
3356 e1
(match-end 4))) ; 3 + 1
3357 (setq tag
(buffer-substring b1 e1
)
3358 qtag
(regexp-quote tag
))
3359 (cond (cperl-pod-here-fontify
3360 ;; Highlight the starting delimiter
3361 (cperl-postpone-fontification b1 e1
'face font-lock-constant-face
)
3362 (cperl-put-do-not-fontify b1 e1 t
)))
3365 ;; We do not search to max, since we may be called from
3366 ;; some hook of fontification, and max is random
3367 (or (and (re-search-forward (concat "^" qtag
"$")
3369 (eq (following-char) ?
\n))
3370 (progn ; Pretend we matched at the end
3371 (goto-char (point-max))
3372 (re-search-forward "\\'")
3373 (message "End of here-document `%s' not found." tag
)
3374 (or (car err-l
) (setcar err-l b
))))
3375 (if cperl-pod-here-fontify
3377 ;; Highlight the ending delimiter
3378 (cperl-postpone-fontification (match-beginning 0) (match-end 0)
3379 'face font-lock-constant-face
)
3380 (cperl-put-do-not-fontify b
(match-end 0) t
)
3381 ;; Highlight the HERE-DOC
3382 (cperl-postpone-fontification b
(match-beginning 0)
3384 (setq e1
(cperl-1+ (match-end 0)))
3385 (put-text-property b
(match-beginning 0)
3386 'syntax-type
'here-doc
)
3387 (put-text-property (match-beginning 0) e1
3388 'syntax-type
'here-doc-delim
)
3389 (put-text-property b e1
3391 (cperl-commentify b e1 nil
)
3392 (cperl-put-do-not-fontify b
(match-end 0) t
)
3396 ((match-beginning 8)
3397 ;; 1+6=7 extra () before this:
3398 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3400 name
(if (match-beginning 8) ; 7 + 1
3401 (buffer-substring (match-beginning 8) ; 7 + 1
3402 (match-end 8)) ; 7 + 1
3404 tb
(match-beginning 0))
3406 (put-text-property (save-excursion
3409 b
'first-format-line
't
)
3410 (if cperl-pod-here-fontify
3411 (while (and (eq (forward-line) 0)
3412 (not (looking-at "^[.;]$")))
3414 ((looking-at "^#")) ; Skip comments
3415 ((and argument
; Skip argument multi-lines
3416 (looking-at "^[ \t]*{"))
3418 (setq argument nil
))
3419 (argument ; Skip argument lines
3420 (setq argument nil
))
3423 (setq argument
(looking-at "^[^\n]*[@^]"))
3425 ;; Highlight the format line
3426 (cperl-postpone-fontification b1
(point)
3427 'face font-lock-string-face
)
3428 (cperl-commentify b1
(point) nil
)
3429 (cperl-put-do-not-fontify b1
(point) t
))))
3430 ;; We do not search to max, since we may be called from
3431 ;; some hook of fontification, and max is random
3432 (re-search-forward "^[.;]$" stop-point
'toend
))
3434 (if (looking-at "^\\.$") ; ";" is not supported yet
3436 ;; Highlight the ending delimiter
3437 (cperl-postpone-fontification (point) (+ (point) 2)
3438 'face font-lock-string-face
)
3439 (cperl-commentify (point) (+ (point) 2) nil
)
3440 (cperl-put-do-not-fontify (point) (+ (point) 2) t
))
3441 (message "End of format `%s' not found." name
)
3442 (or (car err-l
) (setcar err-l b
)))
3446 (put-text-property b
(point) 'syntax-type
'format
))
3448 ((or (match-beginning 10) (match-beginning 11))
3449 ;; 1+6+2=9 extra () before this:
3450 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3452 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3453 (setq b1
(if (match-beginning 10) 10 11)
3454 argument
(buffer-substring
3455 (match-beginning b1
) (match-end b1
))
3458 c
(char-after (match-beginning b1
))
3459 bb
(char-after (1- (match-beginning b1
))) ; tmp holder
3460 ;; bb == "Not a stringy"
3461 bb
(if (eq b1
10) ; user variables/whatever
3462 (and (memq bb
(append "$@%*#_:-&>" nil
)) ; $#y)
3463 (cond ((eq bb ?-
) (eq c ?s
)) ; -s file test
3464 ((eq bb ?\
:) ; $opt::s
3466 (- (match-beginning b1
) 2))
3468 ((eq bb ?\
>) ; $foo->s
3470 (- (match-beginning b1
) 2))
3473 (not (eq (char-after ; &&m/blah/
3474 (- (match-beginning b1
) 2))
3477 ;; <file> or <$file>
3479 ;; Do not stringify <FH>, <$fh> :
3482 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
3483 tb
(match-beginning 0))
3484 (goto-char (match-beginning b1
))
3485 (cperl-backward-to-noncomment (point-min))
3487 (if (eq b1
11) ; bare /blah/ or ?blah? or <foo>
3493 ;; What is below: regexp-p?
3495 (or (memq (preceding-char)
3496 (append (if (memq c
'(?
\? ?\
<))
3499 "~{(=|&+-*!,;:") nil
))
3500 (and (eq (preceding-char) ?\
})
3501 (cperl-after-block-p (point-min)))
3502 (and (eq (char-syntax (preceding-char)) ?w
)
3505 ;; After these keywords `/' starts a RE. One should add all the
3506 ;; functions/builtins which expect an argument, but ...
3507 (if (eq (preceding-char) ?-
)
3509 (looking-at "[a-zA-Z]\\>")
3511 (not (memq (preceding-char)
3514 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
3515 (and (eq (preceding-char) ?.
)
3516 (eq (char-after (- (point) 2)) ?.
))
3518 ;; m|blah| ? foo : bar;
3521 cperl-use-syntax-table-text-property
3525 (looking-at "\\s|")))))))
3528 ;; Check for $a -> y
3529 (setq b1
(preceding-char)
3532 (eq (char-after (- go
2)) ?-
))
3535 (or bb
(setq state
(parse-partial-sexp
3536 state-point b nil nil state
)
3538 (setq bb
(or bb
(nth 3 state
) (nth 4 state
)))
3542 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3543 (goto-char (match-end 0))
3544 (skip-chars-forward " \t\n\f"))
3545 (cond ((and (eq (following-char) ?\
})
3547 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
3549 (skip-chars-backward " \t\n\f")
3550 (if (memq (preceding-char) (append "$@%&*" nil
))
3556 (looking-at ; $foo -> {s}
3557 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
3558 (and ; $foo[12] -> {s}
3559 (memq (following-char) '(?\
{ ?\
[))
3562 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
3565 ((and (eq (following-char) ?
=)
3566 (eq (char-after (1+ (point))) ?\
>))
3567 ;; Check for { foo => 1, s => 2 }
3568 ;; Apparently s=> is never a substitution...
3570 ((and (eq (following-char) ?
:)
3571 (eq b1 ?\
{) ; Check for $ { s::bar }
3572 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
3575 (skip-chars-backward " \t\n\f")
3576 (memq (preceding-char)
3577 (append "$@%&*" nil
))))
3581 ;; Skip whitespace and comments...
3582 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3583 (goto-char (match-end 0))
3584 (skip-chars-forward " \t\n\f"))
3586 (put-text-property b
(point) 'syntax-type
'prestring
))
3587 ;; qtag means two-arg matcher, may be reset to
3588 ;; 2 or 3 later if some special quoting is needed.
3589 ;; e1 means matching-char matcher.
3592 i2
(string-match "^\\([sy]\\|tr\\)$" argument
)
3593 ;; We do not search to max, since we may be called from
3594 ;; some hook of fontification, and max is random
3595 i
(cperl-forward-re stop-point end
3597 t st-l err-l argument
)
3598 ;; Note that if `go', then it is considered as 1-arg
3599 b1
(nth 1 i
) ; start of the second part
3600 tag
(nth 2 i
) ; ender-char, true if second part
3601 ; is with matching chars []
3602 go
(nth 4 i
) ; There is a 1-char part after the end
3603 i
(car i
) ; intermediate point
3605 ;; Before end of the second part if non-matching: ///
3606 tail
(if (and i
(not tag
))
3608 e
(if i i e1
) ; end of the first part
3609 qtag nil
; need to preserve backslashitis
3610 is-x-REx nil
) ; REx has //x modifier
3611 ;; Commenting \\ is dangerous, what about ( ?
3613 (eq (char-after i
) ?
\\)
3615 (if (looking-at "\\sw*x") ; qr//x
3618 ;; Considered as 1arg form
3620 (cperl-commentify b
(point) t
)
3621 (put-text-property b
(point) 'syntax-type
'string
)
3623 ;; ignore other text properties:
3624 (string-match "^qw$" argument
))
3625 (put-text-property b
(point) 'indentable t
))
3627 (setq e1
(cperl-1+ e1
))
3630 (cperl-commentify b i t
)
3631 (if (looking-at "\\sw*e") ; s///e
3635 (cperl-find-pods-heres b1
(1- (point)) t end
)
3637 (goto-char (1+ max
)))
3638 (if (and tag
(eq (preceding-char) ?\
>))
3640 (cperl-modify-syntax-type (1- (point)) cperl-st-ket
)
3641 (cperl-modify-syntax-type i cperl-st-bra
)))
3642 (put-text-property b i
'syntax-type
'string
)
3644 (put-text-property b i
'indentable t
)))
3645 (cperl-commentify b1
(point) t
)
3646 (put-text-property b
(point) 'syntax-type
'string
)
3648 (put-text-property b i
'indentable t
))
3650 (cperl-modify-syntax-type (1+ i
) cperl-st-punct
))
3652 ;; Now: tail: if the second part is non-matching without ///e
3653 (if (eq (char-syntax (following-char)) ?w
)
3655 (forward-word 1) ; skip modifiers s///s
3656 (if tail
(cperl-commentify tail
(point) t
))
3657 (cperl-postpone-fontification
3658 e1
(point) 'face
'cperl-nonoverridable-face
)))
3659 ;; Check whether it is m// which means "previous match"
3660 ;; and highlight differently
3662 (and (string-match "^\\([sm]?\\|qr\\)$" argument
)
3663 (or (not (= (length argument
) 0))
3667 ;; split // *is* using zero-pattern
3673 (not (looking-at "split\\>")))
3675 (cperl-postpone-fontification
3676 b e
'face font-lock-function-name-face
)
3677 (if (or i2
; Has 2 args
3678 (and cperl-fontify-m-as-s
3680 (string-match "^\\(m\\|qr\\)$" argument
)
3681 (and (eq 0 (length argument
))
3682 (not (eq ?\
< (char-after b
)))))))
3684 (cperl-postpone-fontification
3685 b
(cperl-1+ b
) 'face font-lock-constant-face
)
3686 (cperl-postpone-fontification
3687 (1- e
) e
'face font-lock-constant-face
)))
3688 (if (and is-REx cperl-regexp-scan
)
3689 ;; Process RExen better
3696 (if (eq (char-after b
) ?\
#)
3697 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
3698 "\\((\\?#\\)\\|\\(#\\)")
3699 (if (eq (char-after b
) ?\
#)
3703 (goto-char (match-beginning 0))
3704 (setq REx-comment-start
(point)
3708 ;; XXX not working if outside delimiter is #
3709 (eq (preceding-char) ?
\\)
3710 (= (%
(skip-chars-backward "$\\\\") 2) -
1)))
3711 ;; Not a comment, avoid loop:
3712 (progn (setq was-comment nil
)
3714 (if (match-beginning 2)
3716 (beginning-of-line 2)
3718 (goto-char (1- e
))))
3719 ;; Works also if the outside delimiters are ().
3720 (or (search-forward ")" (1- e
) 'toend
)
3722 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
3723 REx-comment-start
))))
3728 (setq REx-comment-end
(point))
3730 REx-comment-start REx-comment-end nil
)
3731 (cperl-postpone-fontification
3732 REx-comment-start REx-comment-end
3733 'face font-lock-comment-face
))))))
3734 (if (and is-REx is-x-REx
)
3735 (put-text-property (1+ b
) (1- e
)
3736 'syntax-subtype
'x-REx
)))
3739 (cperl-postpone-fontification
3740 (1- e1
) e1
'face font-lock-constant-face
)
3741 (if (assoc (char-after b
) cperl-starters
)
3742 (cperl-postpone-fontification
3743 b1
(1+ b1
) 'face font-lock-constant-face
))))
3746 ((match-beginning 13) ; sub with prototypes
3747 (setq b
(match-beginning 0))
3748 (if (memq (char-after (1- b
))
3749 '(?\$ ?\
@ ?\% ?\
& ?\
*))
3751 (setq state
(parse-partial-sexp
3752 state-point b nil nil state
)
3754 (if (or (nth 3 state
) (nth 4 state
))
3757 (cperl-commentify (match-beginning 13) (match-end 13) t
))
3758 (goto-char (match-end 0))))
3759 ;; 1+6+2+1+1+2=13 extra () before this:
3761 ((and (match-beginning 14)
3762 (eq (preceding-char) ?
\')) ; $'
3763 (setq b
(1- (point))
3764 state
(parse-partial-sexp
3765 state-point
(1- b
) nil nil state
)
3767 (if (nth 3 state
) ; in string
3768 (cperl-modify-syntax-type (1- b
) cperl-st-punct
))
3770 ;; 1+6+2+1+1+2=13 extra () before this:
3772 ((match-beginning 14) ; ${
3773 (setq bb
(match-beginning 0))
3774 (cperl-modify-syntax-type bb cperl-st-punct
))
3775 ;; 1+6+2+1+1+2+1=14 extra () before this:
3776 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3777 ((match-beginning 15) ; old $abc'efg syntax
3778 (setq bb
(match-end 0)
3779 b
(match-beginning 0)
3780 state
(parse-partial-sexp
3781 state-point b nil nil state
)
3783 (if (nth 3 state
) ; in string
3785 (put-text-property (1- bb
) bb
'syntax-table cperl-st-word
))
3787 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3788 ;; "__\\(END\\|DATA\\)__"
3789 ((match-beginning 16) ; __END__, __DATA__
3790 (setq bb
(match-end 0)
3791 b
(match-beginning 0)
3792 state
(parse-partial-sexp
3793 state-point b nil nil state
)
3795 (if (or (nth 3 state
) (nth 4 state
))
3797 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3798 (cperl-commentify b bb nil
)
3801 ((match-beginning 17) ; "\\\\\\(['`\"($]\\)"
3802 ;; Trailing backslash ==> non-quoting outside string/comment
3803 (setq bb
(match-end 0)
3804 b
(match-beginning 0))
3806 (skip-chars-backward "\\\\")
3807 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
3808 (setq state
(parse-partial-sexp
3809 state-point b nil nil state
)
3811 (if (or (nth 3 state
) (nth 4 state
) )
3813 (cperl-modify-syntax-type b cperl-st-punct
))
3815 (t (error "Error in regexp of the sniffer")))
3816 (if (> (point) stop-point
)
3819 (message "Garbage after __END__/__DATA__ ignored")
3820 (message "Unbalanced syntax found while scanning")
3821 (or (car err-l
) (setcar err-l b
)))
3822 (goto-char stop-point
))))
3823 (setq cperl-syntax-state
(cons state-point state
)
3824 cperl-syntax-done-to
(or tmpend
(max (point) max
))))
3825 (if (car err-l
) (goto-char (car err-l
))
3827 (message "Scanning for \"hard\" Perl constructions... done"))))
3828 (and (buffer-modified-p)
3830 (set-buffer-modified-p nil
))
3831 (set-syntax-table cperl-mode-syntax-table
))
3834 (defun cperl-backward-to-noncomment (lim)
3835 ;; Stops at lim or after non-whitespace that is not in comment
3837 (while (and (not stop
) (> (point) (or lim
1)))
3838 (skip-chars-backward " \t\n\f" lim
)
3841 (if (memq (setq pr
(get-text-property (point) 'syntax-type
))
3842 '(pod here-doc here-doc-delim
))
3843 (cperl-unwind-to-safe nil
)
3844 (or (looking-at "^[ \t]*\\(#\\|$\\)")
3845 (progn (cperl-to-comment-or-eol) (bolp))
3847 (skip-chars-backward " \t")
3848 (if (< p
(point)) (goto-char p
))
3851 (defun cperl-after-block-p (lim &optional pre-block
)
3852 "Return true if the preceeding } ends a block or a following { starts one.
3853 Would not look before LIM. If PRE-BLOCK is nil checks preceeding }.
3854 otherwise following {."
3855 ;; We suppose that the preceding char is }.
3859 (or pre-block
(forward-sexp -
1))
3860 (cperl-backward-to-noncomment lim
)
3861 (or (eq (point) lim
)
3862 (eq (preceding-char) ?\
) ) ; if () {} sub f () {}
3863 (if (eq (char-syntax (preceding-char)) ?w
) ; else {}
3866 (or (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
3869 (cperl-backward-to-noncomment lim
)
3870 (and (eq (char-syntax (preceding-char)) ?w
)
3873 (looking-at "sub\\>"))))))
3874 (cperl-after-expr-p lim
))))
3877 (defun cperl-after-expr-p (&optional lim chars test
)
3878 "Return true if the position is good for start of expression.
3879 TEST is the expression to evaluate at the found position. If absent,
3880 CHARS is a string that contains good characters to have before us (however,
3881 `}' is treated \"smartly\" if it is not in the list)."
3882 (let ((lim (or lim
(point-min)))
3884 (cperl-update-syntaxification (point) (point))
3886 (while (and (not stop
) (> (point) lim
))
3887 (skip-chars-backward " \t\n\f" lim
)
3890 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
3891 ;; '(pod here-doc here-doc-delim))
3892 (if (get-text-property (point) 'here-doc-group
)
3895 (previous-single-property-change (point) 'here-doc-group
))
3896 (beginning-of-line 0)))
3897 (if (get-text-property (point) 'in-pod
)
3900 (previous-single-property-change (point) 'in-pod
))
3901 (beginning-of-line 0)))
3902 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil
; Only comment, skip
3903 ;; Else: last iteration, or a label
3904 (cperl-to-comment-or-eol) ; Will not move past "." after a format
3905 (skip-chars-backward " \t")
3906 (if (< p
(point)) (goto-char p
))
3908 (if (and (eq (preceding-char) ?
:)
3911 (skip-chars-backward " \t\n\f" lim
)
3912 (eq (char-syntax (preceding-char)) ?w
)))
3913 (forward-sexp -
1) ; Possibly label. Skip it
3916 (or (bobp) ; ???? Needed
3918 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
3920 (if test
(eval test
)
3921 (or (memq (preceding-char) (append (or chars
"{;") nil
))
3922 (and (eq (preceding-char) ?\
})
3923 (cperl-after-block-p lim
))
3924 (and (eq (following-char) ?.
) ; in format: see comment above
3925 (eq (get-text-property (point) 'syntax-type
)
3928 (defun cperl-backward-to-start-of-continued-exp (lim)
3929 (if (memq (preceding-char) (append ")]}\"'`" nil
))
3932 (if (<= (point) lim
)
3933 (goto-char (1+ lim
)))
3934 (skip-chars-forward " \t"))
3936 (defun cperl-after-block-and-statement-beg (lim)
3937 ;; We assume that we are after ?\}
3939 (cperl-after-block-p lim
)
3942 (cperl-backward-to-noncomment (point-min))
3945 (not (= (char-syntax (preceding-char)) ?w
))
3950 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
3953 (defun cperl-indent-exp ()
3954 "Simple variant of indentation of continued-sexp.
3956 Will not indent comment if it starts at `comment-indent' or looks like
3957 continuation of the comment on the previous line.
3959 If `cperl-indent-region-fix-constructs', will improve spacing on
3960 conditional/loop constructs."
3963 (let ((tmp-end (progn (end-of-line) (point))) top done
)
3968 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
3970 (setq top
(point))) ; Get the outermost parenths in line
3972 (while (< (point) tmp-end
)
3973 (parse-partial-sexp (point) tmp-end nil t
) ; To start-sexp or eol
3974 (or (eolp) (forward-sexp 1)))
3975 (if (> (point) tmp-end
)
3978 (setq tmp-end
(point)))
3981 (setq tmp-end
(point-marker)))
3982 (if cperl-indent-region-fix-constructs
3983 (cperl-fix-line-spacing tmp-end
))
3984 (cperl-indent-region (point) tmp-end
))))
3986 (defun cperl-fix-line-spacing (&optional end parse-data
)
3987 "Improve whitespace in a conditional/loop construct.
3988 Returns some position at the last line."
3991 (setq end
(point-max)))
3992 (let ((ee (save-excursion (end-of-line) (point)))
3993 (cperl-indent-region-fix-constructs
3994 (or cperl-indent-region-fix-constructs
1))
3995 p pp ml have-brace ret
)
4002 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
4003 (setq have-brace
(save-excursion (search-forward "}" ee t
)))))
4004 nil
; Do not need to do anything
4008 (if (and cperl-merge-trailing-else
4010 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
4012 (search-forward "}")
4014 (skip-chars-forward " \t\n")
4015 (delete-region p
(point))
4016 (insert (make-string cperl-indent-region-fix-constructs ?\
))
4017 (beginning-of-line)))
4020 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
4022 (search-forward "}")
4023 (delete-horizontal-space)
4024 (insert (make-string cperl-indent-region-fix-constructs ?\
))
4025 (beginning-of-line)))
4029 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4032 (delete-horizontal-space)
4033 (insert (make-string cperl-indent-region-fix-constructs ?\
))
4034 (beginning-of-line)))
4038 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
4041 (delete-horizontal-space)
4042 (insert (make-string cperl-indent-region-fix-constructs ?\
))
4043 (beginning-of-line)))
4045 ;; foreach my $var (
4047 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4050 (delete-horizontal-space)
4052 (make-string cperl-indent-region-fix-constructs ?\
))
4053 (beginning-of-line)))
4055 ;; } foreach my $var () {
4057 "[ \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]*{")
4059 (setq ml
(match-beginning 8))
4060 (re-search-forward "[({]")
4063 (if (eq (following-char) ?\
( )
4067 ;; after `else' or nothing
4068 (if ml
; after `else'
4069 (skip-chars-backward " \t\n")
4070 (beginning-of-line))
4072 ;; Now after the sexp before the brace
4073 ;; Multiline expr should be special
4074 (setq ml
(and pp
(save-excursion (goto-char p
)
4075 (search-forward "\n" pp t
))))
4076 (if (and (or (not pp
) (< pp end
))
4077 (looking-at "[ \t\n]*{"))
4080 ((bolp) ; Were before `{', no if/else/etc
4082 ((looking-at "\\(\t*\\| [ \t]+\\){")
4083 (delete-horizontal-space)
4085 cperl-extra-newline-before-brace-multiline
4086 cperl-extra-newline-before-brace
)
4088 (delete-horizontal-space)
4091 (if (cperl-indent-line parse-data
)
4093 (cperl-fix-line-spacing end parse-data
)
4094 (setq ret
(point)))))
4096 (make-string cperl-indent-region-fix-constructs ?\
))))
4097 ((and (looking-at "[ \t]*\n")
4099 cperl-extra-newline-before-brace-multiline
4100 cperl-extra-newline-before-brace
)))
4102 (skip-chars-forward " \t\n")
4103 (delete-region pp
(point))
4105 (make-string cperl-indent-region-fix-constructs ?\
))))
4106 ;; Now we are before `{'
4107 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
4109 (skip-chars-forward " \t\n")
4114 (setq ml
(search-forward "\n" p t
))
4115 (if (or cperl-break-one-line-blocks-when-indent ml
)
4116 ;; not good: multi-line BLOCK
4119 (delete-horizontal-space)
4122 (if (cperl-indent-line parse-data
)
4123 (setq ret
(cperl-fix-line-spacing end parse-data
)))))))))))
4125 (setq p
(point) pp
(save-excursion (end-of-line) (point))) ; May be different from ee.
4126 ;; Now check whether there is a hanging `}'
4130 cperl-fix-hanging-brace-when-indent
4132 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
4136 (if (and (<= (point) pp
)
4137 (eq (preceding-char) ?\
} )
4138 (cperl-after-block-and-statement-beg (point-min)))
4145 (skip-chars-backward " \t")
4147 ;; `}' was the first thing on the line, insert NL *after* it.
4149 (cperl-indent-line parse-data
)
4150 (search-forward "}")
4151 (delete-horizontal-space)
4153 (delete-horizontal-space)
4154 (or (eq (preceding-char) ?\
;)
4156 (and (eq (preceding-char) ?\
} )
4157 (cperl-after-block-p (point-min)))
4161 (if (cperl-indent-line parse-data
)
4162 (setq ret
(cperl-fix-line-spacing end parse-data
)))
4163 (beginning-of-line)))))
4166 (defvar cperl-update-start
) ; Do not need to make them local
4167 (defvar cperl-update-end
)
4168 (defun cperl-delay-update-hook (beg end old-len
)
4169 (setq cperl-update-start
(min beg
(or cperl-update-start
(point-max))))
4170 (setq cperl-update-end
(max end
(or cperl-update-end
(point-min)))))
4172 (defun cperl-indent-region (start end
)
4173 "Simple variant of indentation of region in CPerl mode.
4174 Should be slow. Will not indent comment if it starts at `comment-indent'
4175 or looks like continuation of the comment on the previous line.
4176 Indents all the lines whose first character is between START and END
4179 If `cperl-indent-region-fix-constructs', will improve spacing on
4180 conditional/loop constructs."
4182 (cperl-update-syntaxification end end
)
4184 (let (cperl-update-start cperl-update-end
(h-a-c after-change-functions
))
4185 (let ((indent-info (if cperl-emacs-can-parse
4186 (list nil nil nil
) ; Cannot use '(), since will modify
4188 (pm 0) (imenu-scanning-message "Indenting... (%3d%%)")
4189 after-change-functions
; Speed it up!
4190 st comm old-comm-indent new-comm-indent p pp i empty
)
4191 (if h-a-c
(add-hook 'after-change-functions
'cperl-delay-update-hook
))
4193 (setq old-comm-indent
(and (cperl-to-comment-or-eol)
4195 new-comm-indent old-comm-indent
)
4197 (setq end
(set-marker (make-marker) end
)) ; indentation changes pos
4198 (or (bolp) (beginning-of-line 2))
4199 (or (fboundp 'imenu-progress-message
)
4200 (message "Indenting... For feedback load `imenu'..."))
4201 (while (and (<= (point) end
) (not (eobp))) ; bol to check start
4202 (and (fboundp 'imenu-progress-message
)
4203 (imenu-progress-message
4204 pm
(/ (* 100 (- (point) start
)) (- end start -
1))))
4207 (setq empty
(looking-at "[ \t]*\n"))
4208 (and (setq comm
(looking-at "[ \t]*#"))
4209 (or (eq (current-indentation) (or old-comm-indent
4211 (setq old-comm-indent nil
))))
4212 (if (and old-comm-indent
4214 (= (current-indentation) old-comm-indent
)
4215 (not (eq (get-text-property (point) 'syntax-type
) 'pod
))
4216 (not (eq (get-text-property (point) 'syntax-table
)
4218 (let ((comment-column new-comm-indent
))
4219 (indent-for-comment)))
4221 (setq i
(cperl-indent-line indent-info
))
4225 (if cperl-indent-region-fix-constructs
4226 (goto-char (cperl-fix-line-spacing end indent-info
)))
4227 (if (setq old-comm-indent
4228 (and (cperl-to-comment-or-eol)
4229 (not (memq (get-text-property (point)
4232 (not (eq (get-text-property (point)
4236 (progn (indent-for-comment)
4237 (skip-chars-backward " \t")
4238 (skip-chars-backward "#")
4239 (setq new-comm-indent
(current-column))))))))
4240 (beginning-of-line 2))
4241 (if (fboundp 'imenu-progress-message
)
4242 (imenu-progress-message pm
100)
4244 ;; Now run the update hooks
4245 (and after-change-functions
4248 (goto-char cperl-update-end
)
4251 (goto-char cperl-update-start
)
4253 (delete-char -
1))))))
4255 ;; Stolen from lisp-mode with a lot of improvements
4257 (defun cperl-fill-paragraph (&optional justify iteration
)
4258 "Like \\[fill-paragraph], but handle CPerl comments.
4259 If any of the current line is a comment, fill the comment or the
4260 block of it that point is in, preserving the comment's initial
4261 indentation and initial hashes. Behaves usually outside of comment."
4263 (let (;; Non-nil if the current line contains a comment.
4266 ;; If has-comment, the appropriate fill-prefix for the comment.
4268 ;; Line that contains code and comment (or nil)
4270 c spaces len dc
(comment-column comment-column
))
4271 ;; Figure out what kind of comment we are looking at.
4276 ;; A line with nothing but a comment on it?
4277 ((looking-at "[ \t]*#[# \t]*")
4279 comment-fill-prefix
(buffer-substring (match-beginning 0)
4282 ;; A line with some code, followed by a comment? Remember that the
4283 ;; semi which starts the comment shouldn't be part of a string or
4285 ((cperl-to-comment-or-eol)
4286 (setq has-comment t
)
4287 (looking-at "#+[ \t]*")
4288 (setq start
(point) c
(current-column)
4290 (concat (make-string (current-column) ?\
)
4291 (buffer-substring (match-beginning 0) (match-end 0)))
4292 spaces
(progn (skip-chars-backward " \t")
4293 (buffer-substring (point) start
))
4294 dc
(- c
(current-column)) len
(- start
(point))
4295 start
(point-marker))
4297 (insert (make-string dc ?-
)))))
4298 (if (not has-comment
)
4299 (fill-paragraph justify
) ; Do the usual thing outside of comment
4300 ;; Narrow to include only the comment, and then fill the region.
4303 ;; Find the first line we should include in the region to fill.
4304 (if start
(progn (beginning-of-line) (point))
4306 (while (and (zerop (forward-line -
1))
4307 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4308 ;; We may have gone to far. Go forward again.
4309 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
4312 ;; Find the beginning of the first line past the region to fill.
4314 (while (progn (forward-line 1)
4315 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4317 ;; Remove existing hashes
4318 (goto-char (point-min))
4319 (while (progn (forward-line 1) (< (point) (point-max)))
4320 (skip-chars-forward " \t")
4321 (and (looking-at "#+")
4322 (delete-char (- (match-end 0) (match-beginning 0)))))
4324 ;; Lines with only hashes on them can be paragraph boundaries.
4325 (let ((paragraph-start (concat paragraph-start
"\\|^[ \t#]*$"))
4326 (paragraph-separate (concat paragraph-start
"\\|^[ \t#]*$"))
4327 (fill-prefix comment-fill-prefix
))
4328 (fill-paragraph justify
)))
4333 (progn (delete-char dc
) (insert spaces
)))
4334 (if (or (= (current-column) c
) iteration
) nil
4335 (setq comment-column c
)
4336 (indent-for-comment)
4337 ;; Repeat once more, flagging as iteration
4338 (cperl-fill-paragraph justify t
)))))))
4340 (defun cperl-do-auto-fill ()
4341 ;; Break out if the line is short enough
4342 (if (> (save-excursion
4346 (let ((c (save-excursion (beginning-of-line)
4347 (cperl-to-comment-or-eol) (point)))
4348 (s (memq (following-char) '(?\ ?
\t))) marker
)
4349 (if (>= c
(point)) nil
4350 (setq marker
(point-marker))
4351 (cperl-fill-paragraph)
4353 ;; Is not enough, sometimes marker is a start of line
4354 (if (bolp) (progn (re-search-forward "#+[ \t]*")
4355 (goto-char (match-end 0))))
4356 ;; Following space could have gone:
4357 (if (or (not s
) (memq (following-char) '(?\ ?
\t))) nil
4360 ;; Previous space could have gone:
4361 (or (memq (preceding-char) '(?\ ?
\t)) (insert " "))))))
4363 (defun cperl-imenu-addback (lst &optional isback name
)
4364 ;; We suppose that the lst is a DAG, unless the first element only
4365 ;; loops back, and ISBACK is set. Thus this function cannot be
4366 ;; applied twice without ISBACK set.
4367 (cond ((not cperl-imenu-addback
) lst
)
4370 (setq name
"+++BACK+++"))
4371 (mapcar (lambda (elt)
4372 (if (and (listp elt
) (listp (cdr elt
)))
4374 ;; In the other order it goes up
4375 ;; one level only ;-(
4376 (setcdr elt
(cons (cons name lst
)
4378 (cperl-imenu-addback (cdr elt
) t name
))))
4379 (if isback
(cdr lst
) lst
))
4382 (defun cperl-imenu--create-perl-index (&optional regexp
)
4383 (require 'imenu
) ; May be called from TAGS creator
4384 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
4385 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function
))
4386 (index-meth-alist '()) meth
4387 packages ends-ranges p marker
4388 (prev-pos 0) char fchar index index1 name
(end-range 0) package
)
4389 (goto-char (point-min))
4391 (message "Scanning Perl for index")
4392 (imenu-progress-message prev-pos
0))
4393 (cperl-update-syntaxification (point-max) (point-max))
4394 ;; Search for the function
4395 (progn ;;save-match-data
4396 (while (re-search-forward
4397 (or regexp cperl-imenu--function-name-regexp-perl
)
4400 (imenu-progress-message prev-pos
))
4402 ((and ; Skip some noise if building tags
4403 (match-beginning 2) ; package or sub
4404 (eq (char-after (match-beginning 2)) ?p
) ; package
4405 (not (save-match-data
4406 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
4409 (match-beginning 2) ; package or sub
4410 ;; Skip if quoted (will not skip multi-line ''-strings :-():
4411 (null (get-text-property (match-beginning 1) 'syntax-table
))
4412 (null (get-text-property (match-beginning 1) 'syntax-type
))
4413 (null (get-text-property (match-beginning 1) 'in-pod
)))
4415 (goto-char (match-beginning 2))
4416 (setq fchar
(following-char)))
4417 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4418 ;; (goto-char (match-end 0))) ; Messes what follows
4419 (setq char
(following-char) ; ?\; for "sub foo () ;"
4422 (while (and ends-ranges
(>= p
(car ends-ranges
)))
4423 ;; delete obsolete entries
4424 (setq ends-ranges
(cdr ends-ranges
) packages
(cdr packages
)))
4425 (setq package
(or (car packages
) "")
4426 end-range
(or (car ends-ranges
) 0))
4428 (setq name
(buffer-substring (match-beginning 3) (match-end 3))
4430 (set-text-properties 0 (length name
) nil name
)
4432 package
(concat name
"::")
4433 name
(concat "package " name
)
4436 (parse-partial-sexp (point) (point-max) -
1) (point))
4437 ends-ranges
(cons end-range ends-ranges
)
4438 packages
(cons package packages
)))
4440 ;; Skip this function name if it is a prototype declaration.
4441 (if (and (eq fchar ?s
) (eq char ?\
;)) nil
4442 (setq name
(buffer-substring (match-beginning 3) (match-end 3))
4443 marker
(make-marker))
4444 (set-text-properties 0 (length name
) nil name
)
4445 (set-marker marker
(match-end 3))
4447 (setq name
(concat "package " name
))
4448 (cond ((string-match "[:']" name
)
4450 ((> p end-range
) nil
)
4452 (setq name
(concat package name
) meth t
))))
4453 (setq index
(cons name marker
))
4455 (push index index-pack-alist
)
4456 (push index index-alist
))
4457 (if meth
(push index index-meth-alist
))
4458 (push index index-unsorted-alist
)))
4459 ((match-beginning 5) ; POD section
4460 ;; (beginning-of-line)
4461 (setq index
(imenu-example--name-and-position)
4462 name
(buffer-substring (match-beginning 6) (match-end 6)))
4463 (set-text-properties 0 (length name
) nil name
)
4464 (if (eq (char-after (match-beginning 5)) ?
2)
4465 (setq name
(concat " " name
)))
4467 (setq index1
(cons (concat "=" name
) (cdr index
)))
4468 (push index index-pod-alist
)
4469 (push index1 index-unsorted-alist
)))))
4471 (imenu-progress-message prev-pos
100))
4473 (if (default-value 'imenu-sort-function
)
4474 (sort index-alist
(default-value 'imenu-sort-function
))
4475 (nreverse index-alist
)))
4476 (and index-pod-alist
4477 (push (cons "+POD headers+..."
4478 (nreverse index-pod-alist
))
4480 (and (or index-pack-alist index-meth-alist
)
4481 (let ((lst index-pack-alist
) hier-list pack elt group name
)
4482 ;; Remove "package ", reverse and uniquify.
4484 (setq elt
(car lst
) lst
(cdr lst
) name
(substring (car elt
) 8))
4485 (if (assoc name hier-list
) nil
4486 (setq hier-list
(cons (cons name
(cdr elt
)) hier-list
))))
4487 (setq lst index-meth-alist
)
4489 (setq elt
(car lst
) lst
(cdr lst
))
4490 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt
))
4491 (setq pack
(substring (car elt
) 0 (match-beginning 0)))
4492 (if (setq group
(assoc pack hier-list
))
4493 (if (listp (cdr group
))
4494 ;; Have some functions already
4496 (cons (cons (substring
4498 (+ 2 (match-beginning 0)))
4501 (setcdr group
(list (cons (substring
4503 (+ 2 (match-beginning 0)))
4507 (list (cons (substring
4509 (+ 2 (match-beginning 0)))
4512 (push (cons "+Hierarchy+..."
4515 (and index-pack-alist
4516 (push (cons "+Packages+..."
4517 (nreverse index-pack-alist
))
4519 (and (or index-pack-alist index-pod-alist
4520 (default-value 'imenu-sort-function
))
4521 index-unsorted-alist
4522 (push (cons "+Unsorted List+..."
4523 (nreverse index-unsorted-alist
))
4525 (cperl-imenu-addback index-alist
)))
4528 ;; Suggested by Mark A. Hershberger
4529 (defun cperl-outline-level ()
4530 (looking-at outline-regexp
)
4531 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
4532 ((match-beginning 2)
4533 (if (eq (char-after (match-beginning 2)) ?p
)
4536 ((match-beginning 5)
4537 (if (eq (char-after (match-beginning 5)) ?
1)
4540 (t 3))) ; should not happen
4543 (defvar cperl-compilation-error-regexp-alist
4544 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4545 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
4547 "Alist that specifies how to match errors in perl output.")
4549 (if (fboundp 'eval-after-load
)
4552 '(setq perl-compilation-error-regexp-alist
4553 cperl-compilation-error-regexp-alist
)))
4556 (defun cperl-windowed-init ()
4557 "Initialization under windowed version."
4558 (if (or (featurep 'ps-print
) cperl-faces-init
)
4559 ;; Need to init anyway:
4560 (or cperl-faces-init
(cperl-init-faces))
4561 (add-hook 'font-lock-mode-hook
4564 (if (memq major-mode
'(perl-mode cperl-mode
))
4566 (or cperl-faces-init
(cperl-init-faces)))))))
4567 (if (fboundp 'eval-after-load
)
4570 '(or cperl-faces-init
(cperl-init-faces))))))
4572 (defvar cperl-font-lock-keywords-1 nil
4573 "Additional expressions to highlight in Perl mode. Minimal set.")
4574 (defvar cperl-font-lock-keywords nil
4575 "Additional expressions to highlight in Perl mode. Default set.")
4576 (defvar cperl-font-lock-keywords-2 nil
4577 "Additional expressions to highlight in Perl mode. Maximal set")
4579 (defun cperl-load-font-lock-keywords ()
4580 (or cperl-faces-init
(cperl-init-faces))
4581 cperl-font-lock-keywords
)
4583 (defun cperl-load-font-lock-keywords-1 ()
4584 (or cperl-faces-init
(cperl-init-faces))
4585 cperl-font-lock-keywords-1
)
4587 (defun cperl-load-font-lock-keywords-2 ()
4588 (or cperl-faces-init
(cperl-init-faces))
4589 cperl-font-lock-keywords-2
)
4591 (defun cperl-init-faces-weak ()
4592 ;; Allow `cperl-find-pods-heres' to run.
4593 (or (boundp 'font-lock-constant-face
)
4594 (cperl-force-face font-lock-constant-face
4595 "Face for constant and label names")
4596 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4599 (defun cperl-init-faces ()
4600 (condition-case errs
4602 (require 'font-lock
)
4603 (and (fboundp 'font-lock-fontify-anchored-keywords
)
4604 (featurep 'font-lock-extra
)
4605 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
4606 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored
)
4607 (if (fboundp 'font-lock-fontify-anchored-keywords
)
4608 (setq font-lock-anchored t
))
4610 t-font-lock-keywords
4612 `("[ \t]+$" 0 ',cperl-invalid-face t
)
4615 "\\(^\\|[^$@%&\\]\\)\\<\\("
4618 '("if" "until" "while" "elsif" "else" "unless" "for"
4619 "foreach" "continue" "exit" "die" "last" "goto" "next"
4620 "redo" "return" "local" "exec" "sub" "do" "dump" "use"
4621 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
4622 "\\|") ; Flow control
4623 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
4624 ; In what follows we use `type' style
4625 ; for overwritable builtins
4628 "\\(^\\|[^$@%&\\]\\)\\<\\("
4629 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4630 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4631 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4632 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4633 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4634 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4635 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4636 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4637 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4638 ;; "gethostbyname" "gethostent" "getlogin"
4639 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4640 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4641 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4642 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4643 ;; "getservbyport" "getservent" "getsockname"
4644 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4645 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
4646 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
4647 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4648 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4649 ;; "quotemeta" "rand" "read" "readdir" "readline"
4650 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4651 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4652 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4653 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4654 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4655 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4656 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4657 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
4658 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
4659 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4660 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4661 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
4662 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
4663 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
4664 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
4665 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
4666 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
4667 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
4668 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
4669 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
4670 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
4671 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
4672 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
4673 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
4674 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
4675 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
4676 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
4677 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
4678 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
4679 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
4680 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
4681 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
4682 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
4683 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
4684 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
4685 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
4686 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
4687 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
4688 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
4689 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
4690 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
4691 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
4692 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
4693 "\\)\\>") 2 'font-lock-type-face
)
4694 ;; In what follows we use `other' style
4695 ;; for nonoverwritable builtins
4696 ;; Somehow 's', 'm' are not auto-generated???
4699 "\\(^\\|[^$@%&\\]\\)\\<\\("
4700 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
4701 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4702 ;; "eval" "exists" "for" "foreach" "format" "goto"
4703 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4704 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4705 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4706 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4707 ;; "undef" "unless" "unshift" "untie" "until" "use"
4709 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
4710 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
4711 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
4712 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
4713 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
4714 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
4715 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
4716 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
4717 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
4718 "\\|[sm]" ; Added manually
4719 "\\)\\>") 2 'cperl-nonoverridable-face
)
4720 ;; (mapconcat 'identity
4721 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4722 ;; "#include" "#define" "#undef")
4724 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
4725 font-lock-function-name-face keep
) ; Not very good, triggers at "[a-z]"
4726 '("\\<sub[ \t]+\\([^ \t{;()]+\\)[ \t]*\\(([^()]*)[ \t]*\\)?[#{\n]" 1
4727 font-lock-function-name-face
)
4728 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4729 2 font-lock-function-name-face
)
4730 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
4731 1 font-lock-function-name-face
)
4732 (cond ((featurep 'font-lock-extra
)
4733 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4734 (2 font-lock-string-face t
)
4735 (0 '(restart 2 t
)))) ; To highlight $a{bc}{ef}
4737 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4738 (2 font-lock-string-face t
)
4739 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4741 (1 font-lock-string-face t
))))
4742 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4743 2 font-lock-string-face t
)))
4744 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
4745 font-lock-string-face t
)
4746 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
4747 font-lock-constant-face
) ; labels
4748 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
4749 2 font-lock-constant-face
)
4750 ;; Uncomment to get perl-mode-like vars
4751 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
4752 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
4753 ;;; (2 (cons font-lock-variable-name-face '(underline))))
4754 (cond ((featurep 'font-lock-extra
)
4755 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4756 (3 font-lock-variable-name-face
)
4758 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4759 (1 font-lock-variable-name-face
)
4760 (2 '(restart 2 nil
) nil t
)))
4761 nil t
))) ; local variables, multiple
4763 '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4764 (3 font-lock-variable-name-face
)
4765 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)"
4767 (1 font-lock-variable-name-face
))))
4768 (t '("^[ \t{}]*\\(my\\|local\\our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4769 3 font-lock-variable-name-face
)))
4770 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
4771 4 font-lock-variable-name-face
)))
4773 t-font-lock-keywords-1
4774 (and (fboundp 'turn-on-font-lock
) ; Check for newer font-lock
4775 (not cperl-xemacs-p
) ; not yet as of XEmacs 19.12
4777 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
4778 (if (eq (char-after (match-beginning 2)) ?%
)
4781 t
) ; arrays and hashes
4782 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
4784 (if (= (- (match-end 2) (match-beginning 2)) 1)
4785 (if (eq (char-after (match-beginning 3)) ?
{)
4787 cperl-array-face
) ; arrays and hashes
4788 font-lock-variable-name-face
) ; Just to put something
4790 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4791 ;;; Too much noise from \s* @s[ and friends
4792 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
4793 ;;(3 font-lock-function-name-face t t)
4795 ;; (if (cperl-slash-is-regexp)
4796 ;; font-lock-function-name-face 'default) nil t))
4798 (if cperl-highlight-variables-indiscriminately
4799 (setq t-font-lock-keywords-1
4800 (append t-font-lock-keywords-1
4801 (list '("[$*]{?\\(\\sw+\\)" 1
4802 font-lock-variable-name-face
)))))
4803 (setq cperl-font-lock-keywords-1
4804 (if cperl-syntaxify-by-font-lock
4805 (cons 'cperl-fontify-update
4806 t-font-lock-keywords
)
4807 t-font-lock-keywords
)
4808 cperl-font-lock-keywords cperl-font-lock-keywords-1
4809 cperl-font-lock-keywords-2
(append
4810 cperl-font-lock-keywords-1
4811 t-font-lock-keywords-1
)))
4812 (if (fboundp 'ps-print-buffer
) (cperl-ps-print-init))
4813 (if (or (featurep 'choose-color
) (featurep 'font-lock-extra
))
4814 (eval ; Avoid a warning
4815 '(font-lock-require-faces
4817 ;; Color-light Color-dark Gray-light Gray-dark Mono
4818 (list 'font-lock-comment-face
4819 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
4824 (list 'font-lock-string-face
4825 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
4830 (list 'font-lock-function-name-face
4832 "Blue" "LightSkyBlue" "Gray50" "LightGray"
4833 (cdr (assq 'background-color
; if mono
4834 (frame-parameters))))
4837 (cdr (assq 'foreground-color
; if mono
4838 (frame-parameters))))
4842 (list 'font-lock-variable-name-face
4843 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
4848 (list 'font-lock-type-face
4849 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
4854 (list 'font-lock-constant-face
4855 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
4860 (list 'cperl-nonoverridable-face
4861 ["chartreuse3" ("orchid1" "orange")
4867 (list 'cperl-array-face
4868 ["blue" "yellow" nil
"Gray80"]
4869 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4874 (list 'cperl-hash-face
4875 ["red" "red" nil
"Gray80"]
4876 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4881 ;; Do it the dull way, without choose-color
4882 (defvar cperl-guessed-background nil
4883 "Display characteristics as guessed by cperl.")
4884 ;; (or (fboundp 'x-color-defined-p)
4885 ;; (defalias 'x-color-defined-p
4886 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4887 ;; ;; XEmacs >= 19.12
4888 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4890 ;; (t 'x-valid-color-name-p))))
4891 (cperl-force-face font-lock-constant-face
4892 "Face for constant and label names")
4893 (cperl-force-face font-lock-variable-name-face
4894 "Face for variable names")
4895 (cperl-force-face font-lock-type-face
4896 "Face for data types")
4897 (cperl-force-face cperl-nonoverridable-face
4898 "Face for data types from another group")
4899 (cperl-force-face font-lock-comment-face
4900 "Face for comments")
4901 (cperl-force-face font-lock-function-name-face
4902 "Face for function names")
4903 (cperl-force-face cperl-hash-face
4905 (cperl-force-face cperl-array-face
4907 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4908 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4909 ;;(or (boundp 'font-lock-type-face)
4910 ;; (defconst font-lock-type-face
4911 ;; 'font-lock-type-face
4912 ;; "Face to use for data types."))
4913 ;;(or (boundp 'cperl-nonoverridable-face)
4914 ;; (defconst cperl-nonoverridable-face
4915 ;; 'cperl-nonoverridable-face
4916 ;; "Face to use for data types from another group."))
4917 ;;(if (not cperl-xemacs-p) nil
4918 ;; (or (boundp 'font-lock-comment-face)
4919 ;; (defconst font-lock-comment-face
4920 ;; 'font-lock-comment-face
4921 ;; "Face to use for comments."))
4922 ;; (or (boundp 'font-lock-keyword-face)
4923 ;; (defconst font-lock-keyword-face
4924 ;; 'font-lock-keyword-face
4925 ;; "Face to use for keywords."))
4926 ;; (or (boundp 'font-lock-function-name-face)
4927 ;; (defconst font-lock-function-name-face
4928 ;; 'font-lock-function-name-face
4929 ;; "Face to use for function names.")))
4931 (not (cperl-is-face 'cperl-array-face
))
4932 (cperl-is-face 'font-lock-emphasized-face
))
4933 (copy-face 'font-lock-emphasized-face
'cperl-array-face
))
4935 (not (cperl-is-face 'cperl-hash-face
))
4936 (cperl-is-face 'font-lock-other-emphasized-face
))
4937 (copy-face 'font-lock-other-emphasized-face
4940 (not (cperl-is-face 'cperl-nonoverridable-face
))
4941 (cperl-is-face 'font-lock-other-type-face
))
4942 (copy-face 'font-lock-other-type-face
4943 'cperl-nonoverridable-face
))
4944 ;;(or (boundp 'cperl-hash-face)
4945 ;; (defconst cperl-hash-face
4947 ;; "Face to use for hashes."))
4948 ;;(or (boundp 'cperl-array-face)
4949 ;; (defconst cperl-array-face
4950 ;; 'cperl-array-face
4951 ;; "Face to use for arrays."))
4952 ;; Here we try to guess background
4954 (if (boundp 'font-lock-background-mode
)
4955 font-lock-background-mode
4957 (face-list (and (fboundp 'face-list
) (face-list))))
4958 ;;;; (fset 'cperl-is-face
4959 ;;;; (cond ((fboundp 'find-face)
4960 ;;;; (symbol-function 'find-face))
4962 ;;;; (function (lambda (face) (member face face-list))))
4964 ;;;; (function (lambda (face) (boundp face))))))
4965 (defvar cperl-guessed-background
4966 (if (and (boundp 'font-lock-display-type
)
4967 (eq font-lock-display-type
'grayscale
))
4970 "Background as guessed by CPerl mode")
4971 (and (not (cperl-is-face 'font-lock-constant-face
))
4972 (cperl-is-face 'font-lock-reference-face
)
4973 (copy-face 'font-lock-reference-face
'font-lock-constant-face
))
4974 (if (cperl-is-face 'font-lock-type-face
) nil
4975 (copy-face 'default
'font-lock-type-face
)
4977 ((eq background
'light
)
4978 (set-face-foreground 'font-lock-type-face
4979 (if (x-color-defined-p "seagreen")
4982 ((eq background
'dark
)
4983 (set-face-foreground 'font-lock-type-face
4984 (if (x-color-defined-p "os2pink")
4988 (set-face-background 'font-lock-type-face
"gray90"))))
4989 (if (cperl-is-face 'cperl-nonoverridable-face
)
4991 (copy-face 'font-lock-type-face
'cperl-nonoverridable-face
)
4993 ((eq background
'light
)
4994 (set-face-foreground 'cperl-nonoverridable-face
4995 (if (x-color-defined-p "chartreuse3")
4998 ((eq background
'dark
)
4999 (set-face-foreground 'cperl-nonoverridable-face
5000 (if (x-color-defined-p "orchid1")
5003 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
5004 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
5006 ;;; ((eq background 'light)
5007 ;;; (set-face-background 'font-lock-other-emphasized-face
5008 ;;; (if (x-color-defined-p "lightyellow2")
5010 ;;; (if (x-color-defined-p "lightyellow")
5012 ;;; "light yellow"))))
5013 ;;; ((eq background 'dark)
5014 ;;; (set-face-background 'font-lock-other-emphasized-face
5015 ;;; (if (x-color-defined-p "navy")
5017 ;;; (if (x-color-defined-p "darkgreen")
5019 ;;; "dark green"))))
5020 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
5021 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
5022 ;;; (copy-face 'bold 'font-lock-emphasized-face)
5024 ;;; ((eq background 'light)
5025 ;;; (set-face-background 'font-lock-emphasized-face
5026 ;;; (if (x-color-defined-p "lightyellow2")
5028 ;;; "lightyellow")))
5029 ;;; ((eq background 'dark)
5030 ;;; (set-face-background 'font-lock-emphasized-face
5031 ;;; (if (x-color-defined-p "navy")
5033 ;;; (if (x-color-defined-p "darkgreen")
5035 ;;; "dark green"))))
5036 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
5037 (if (cperl-is-face 'font-lock-variable-name-face
) nil
5038 (copy-face 'italic
'font-lock-variable-name-face
))
5039 (if (cperl-is-face 'font-lock-constant-face
) nil
5040 (copy-face 'italic
'font-lock-constant-face
))))
5041 (setq cperl-faces-init t
))
5042 (error (message "cperl-init-faces (ignored): %s" errs
))))
5045 (defun cperl-ps-print-init ()
5046 "Initialization of `ps-print' components for faces used in CPerl."
5047 (eval-after-load "ps-print"
5048 '(setq ps-bold-faces
5049 ;; font-lock-variable-name-face
5050 ;; font-lock-constant-face
5051 (append '(cperl-array-face
5055 ;; font-lock-constant-face
5056 (append '(cperl-nonoverridable-face
5060 ;; font-lock-type-face
5061 (append '(cperl-array-face
5064 cperl-nonoverridable-face
)
5065 ps-underlined-faces
))))
5067 (defvar ps-print-face-extension-alist
)
5069 (defun cperl-ps-print (&optional file
)
5070 "Pretty-print in CPerl style.
5071 If optional argument FILE is an empty string, prints to printer, otherwise
5072 to the file FILE. If FILE is nil, prompts for a file name.
5074 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
5077 (setq file
(read-from-minibuffer
5078 "Print to file (if empty - to printer): "
5079 (concat (buffer-file-name) ".ps")
5080 nil nil
'file-name-history
)))
5081 (or (> (length file
) 0)
5083 (require 'ps-print
) ; To get ps-print-face-extension-alist
5084 (let ((ps-print-color-p t
)
5085 (ps-print-face-extension-alist ps-print-face-extension-alist
))
5086 (cperl-ps-extend-face-list cperl-ps-print-face-properties
)
5087 (ps-print-buffer-with-faces file
)))
5089 ;;; (defun cperl-ps-print-init ()
5090 ;;; "Initialization of `ps-print' components for faces used in CPerl."
5091 ;;; ;; Guard against old versions
5092 ;;; (defvar ps-underlined-faces nil)
5093 ;;; (defvar ps-bold-faces nil)
5094 ;;; (defvar ps-italic-faces nil)
5095 ;;; (setq ps-bold-faces
5096 ;;; (append '(font-lock-emphasized-face
5097 ;;; cperl-array-face
5098 ;;; font-lock-keyword-face
5099 ;;; font-lock-variable-name-face
5100 ;;; font-lock-constant-face
5101 ;;; font-lock-reference-face
5102 ;;; font-lock-other-emphasized-face
5103 ;;; cperl-hash-face)
5105 ;;; (setq ps-italic-faces
5106 ;;; (append '(cperl-nonoverridable-face
5107 ;;; font-lock-constant-face
5108 ;;; font-lock-reference-face
5109 ;;; font-lock-other-emphasized-face
5110 ;;; cperl-hash-face)
5111 ;;; ps-italic-faces))
5112 ;;; (setq ps-underlined-faces
5113 ;;; (append '(font-lock-emphasized-face
5114 ;;; cperl-array-face
5115 ;;; font-lock-other-emphasized-face
5117 ;;; cperl-nonoverridable-face font-lock-type-face)
5118 ;;; ps-underlined-faces))
5119 ;;; (cons 'font-lock-type-face ps-underlined-faces))
5122 (if (cperl-enable-font-lock) (cperl-windowed-init))
5124 (defconst cperl-styles-entries
5125 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
5126 cperl-label-offset cperl-extra-newline-before-brace
5127 cperl-merge-trailing-else
5128 cperl-continued-statement-offset
))
5130 (defconst cperl-style-alist
5131 '(("CPerl" ; =GNU without extra-newline-before-brace
5132 (cperl-indent-level .
2)
5133 (cperl-brace-offset .
0)
5134 (cperl-continued-brace-offset .
0)
5135 (cperl-label-offset . -
2)
5136 (cperl-extra-newline-before-brace . nil
)
5137 (cperl-merge-trailing-else . t
)
5138 (cperl-continued-statement-offset .
2))
5139 ("PerlStyle" ; CPerl with 4 as indent
5140 (cperl-indent-level .
4)
5141 (cperl-brace-offset .
0)
5142 (cperl-continued-brace-offset .
0)
5143 (cperl-label-offset . -
4)
5144 (cperl-extra-newline-before-brace . nil
)
5145 (cperl-merge-trailing-else . t
)
5146 (cperl-continued-statement-offset .
4))
5148 (cperl-indent-level .
2)
5149 (cperl-brace-offset .
0)
5150 (cperl-continued-brace-offset .
0)
5151 (cperl-label-offset . -
2)
5152 (cperl-extra-newline-before-brace . t
)
5153 (cperl-merge-trailing-else . nil
)
5154 (cperl-continued-statement-offset .
2))
5156 (cperl-indent-level .
5)
5157 (cperl-brace-offset .
0)
5158 (cperl-continued-brace-offset . -
5)
5159 (cperl-label-offset . -
5)
5160 ;;(cperl-extra-newline-before-brace . nil) ; ???
5161 (cperl-merge-trailing-else . nil
)
5162 (cperl-continued-statement-offset .
5))
5164 (cperl-indent-level .
4)
5165 (cperl-brace-offset .
0)
5166 (cperl-continued-brace-offset . -
4)
5167 (cperl-label-offset . -
4)
5168 ;;(cperl-extra-newline-before-brace . nil) ; ???
5169 (cperl-continued-statement-offset .
4))
5171 (cperl-indent-level .
4)
5172 (cperl-brace-offset .
0)
5173 (cperl-continued-brace-offset . -
4)
5174 (cperl-label-offset . -
4)
5175 (cperl-continued-statement-offset .
4)
5176 (cperl-merge-trailing-else . nil
)
5177 (cperl-extra-newline-before-brace . t
))
5180 (cperl-indent-level .
4)
5181 (cperl-brace-offset .
0)
5182 (cperl-continued-brace-offset .
0)
5183 (cperl-label-offset . -
4)
5184 ;;(cperl-extra-newline-before-brace . nil) ; ???
5185 (cperl-continued-statement-offset .
4)))
5186 "(Experimental) list of variables to set to get a particular indentation style.
5187 Should be used via `cperl-set-style' or via Perl menu.")
5189 (defun cperl-set-style (style)
5190 "Set CPerl mode variables to use one of several different indentation styles.
5191 The arguments are a string representing the desired style.
5192 The list of styles is in `cperl-style-alist', available styles
5193 are GNU, K&R, BSD, C++ and Whitesmith.
5195 The current value of style is memorized (unless there is a memorized
5196 data already), may be restored by `cperl-set-style-back'.
5198 Chosing \"Current\" style will not change style, so this may be used for
5199 side-effect of memorizing only."
5201 (let ((list (mapcar (function (lambda (elt) (list (car elt
))))
5202 cperl-style-alist
)))
5203 (list (completing-read "Enter style: " list nil
'insist
))))
5205 (setq cperl-old-style
5208 (cons name
(eval name
))))
5209 cperl-styles-entries
)))
5210 (let ((style (cdr (assoc style cperl-style-alist
))) setting str sym
)
5212 (setq setting
(car style
) style
(cdr style
))
5213 (set (car setting
) (cdr setting
)))))
5215 (defun cperl-set-style-back ()
5216 "Restore a style memorised by `cperl-set-style'."
5218 (or cperl-old-style
(error "The style was not changed"))
5220 (while cperl-old-style
5221 (setq setting
(car cperl-old-style
)
5222 cperl-old-style
(cdr cperl-old-style
))
5223 (set (car setting
) (cdr setting
)))))
5225 (defun cperl-check-syntax ()
5227 (require 'mode-compile
)
5228 (let ((perl-dbg-flags (concat cperl-extra-perl-args
" -wc")))
5229 (eval '(mode-compile)))) ; Avoid a warning
5231 (defun cperl-info-buffer (type)
5232 ;; Returns buffer with documentation. Creates if missing.
5233 ;; If TYPE, this vars buffer.
5234 ;; Special care is taken to not stomp over an existing info buffer
5235 (let* ((bname (if type
"*info-perl-var*" "*info-perl*"))
5236 (info (get-buffer bname
))
5237 (oldbuf (get-buffer "*info*")))
5239 (save-window-excursion
5244 (rename-buffer "*info-perl-tmp*")))
5245 (save-window-excursion
5247 (Info-find-node cperl-info-page
(if type
"perlvar" "perlfunc"))
5248 (set-buffer "*info*")
5249 (rename-buffer bname
)
5251 (set-buffer "*info-perl-tmp*")
5252 (rename-buffer "*info*")
5253 (set-buffer bname
)))
5254 (make-local-variable 'window-min-height
)
5255 (setq window-min-height
2)
5256 (current-buffer)))))
5258 (defun cperl-word-at-point (&optional p
)
5259 "Return the word at point or at P."
5261 (if p
(goto-char p
))
5262 (or (cperl-word-at-point-hard)
5265 (funcall (or (and (boundp 'find-tag-default-function
)
5266 find-tag-default-function
)
5267 (get major-mode
'find-tag-default-function
)
5268 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
5269 ;; automatically used within `find-tag-default':
5270 'find-tag-default
))))))
5272 (defun cperl-info-on-command (command)
5273 "Show documentation for Perl command COMMAND in other window.
5274 If perl-info buffer is shown in some frame, uses this frame.
5275 Customized by setting variables `cperl-shrink-wrap-info-frame',
5276 `cperl-max-help-size'."
5278 (let* ((default (cperl-word-at-point))
5280 (format "Find doc for Perl function (default %s): "
5282 (list (if (equal read
"")
5286 (let ((buffer (current-buffer))
5287 (cmd-desc (concat "^" (regexp-quote command
) "[^a-zA-Z_0-9]")) ; "tr///"
5288 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
5289 max-height char-height buf-list
)
5290 (if (string-match "^-[a-zA-Z]$" command
)
5291 (setq cmd-desc
"^-X[ \t\n]"))
5292 (setq isvar
(string-match "^[$@%]" command
)
5293 buf
(cperl-info-buffer isvar
)
5294 iniwin
(selected-window)
5295 fr1
(window-frame iniwin
))
5297 (beginning-of-buffer)
5299 (progn (re-search-forward "^-X[ \t\n]")
5301 (if (re-search-forward cmd-desc nil t
)
5303 ;; Go back to beginning of the group (ex, for qq)
5304 (if (re-search-backward "^[ \t\n\f]")
5309 buf-list
(list buf
"*info-perl-var*" "*info-perl*"))
5310 (while (and (not win
) buf-list
)
5311 (setq win
(get-buffer-window (car buf-list
) t
))
5312 (setq buf-list
(cdr buf-list
)))
5314 (eq (window-buffer win
) buf
)
5315 (set-window-buffer win buf
))
5316 (and win
(setq fr2
(window-frame win
)))
5317 (if (or (not fr2
) (eq fr1 fr2
))
5319 (special-display-popup-frame buf
) ; Make it visible
5320 (select-window win
))
5321 (goto-char pos
) ; Needed (?!).
5323 (setq iniheight
(window-height)
5324 frheight
(frame-height)
5325 not-loner
(< iniheight
(1- frheight
))) ; Are not alone
5326 (cond ((if not-loner cperl-max-help-size
5327 cperl-shrink-wrap-info-frame
)
5333 (if (re-search-forward
5334 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t
)
5335 (match-beginning 0) (point-max)))))
5338 (/ (* (- frheight
3) cperl-max-help-size
) 100)
5339 (setq char-height
(frame-char-height))
5340 ;; Non-functioning under OS/2:
5341 (if (eq char-height
1) (setq char-height
18))
5342 ;; Title, menubar, + 2 for slack
5343 (- (/ (x-display-pixel-height) char-height
) 4)))
5344 (if (> height max-height
) (setq height max-height
))
5345 ;;(message "was %s doing %s" iniheight height)
5347 (enlarge-window (- height iniheight
))
5348 (set-frame-height (window-frame win
) (1+ height
)))))
5349 (set-window-start (selected-window) pos
))
5350 (message "No entry for %s found." command
))
5351 ;;(pop-to-buffer buffer)
5352 (select-window iniwin
)))
5354 (defun cperl-info-on-current-command ()
5355 "Show documentation for Perl command at point in other window."
5357 (cperl-info-on-command (cperl-word-at-point)))
5359 (defun cperl-imenu-info-imenu-search ()
5360 (if (looking-at "^-X[ \t\n]") nil
5362 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
5365 (defun cperl-imenu-info-imenu-name ()
5367 (match-beginning 1) (match-end 1)))
5369 (defun cperl-imenu-on-info ()
5371 (let* ((buffer (current-buffer))
5372 imenu-create-index-function
5373 imenu-prev-index-position-function
5374 imenu-extract-index-name-function
5375 (index-item (save-restriction
5376 (save-window-excursion
5377 (set-buffer (cperl-info-buffer nil
))
5378 (setq imenu-create-index-function
5379 'imenu-default-create-index-function
5380 imenu-prev-index-position-function
5381 'cperl-imenu-info-imenu-search
5382 imenu-extract-index-name-function
5383 'cperl-imenu-info-imenu-name
)
5384 (imenu-choose-buffer-index)))))
5388 (pop-to-buffer "*info-perl*")
5390 ((markerp (cdr index-item
))
5391 (goto-char (marker-position (cdr index-item
))))
5393 (goto-char (cdr index-item
))))
5394 (set-window-start (selected-window) (point))
5395 (pop-to-buffer buffer
)))))
5397 (defun cperl-lineup (beg end
&optional step minshift
)
5398 "Lineup construction in a region.
5399 Beginning of region should be at the start of a construction.
5400 All first occurrences of this construction in the lines that are
5401 partially contained in the region are lined up at the same column.
5403 MINSHIFT is the minimal amount of space to insert before the construction.
5404 STEP is the tabwidth to position constructions.
5405 If STEP is nil, `cperl-lineup-step' will be used
5406 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
5407 Will not move the position at the start to the left."
5409 (let (search col tcol seen b e
)
5413 (setq end
(point-marker))
5415 (skip-chars-forward " \t\f")
5416 (setq beg
(point-marker))
5417 (indent-region beg end nil
)
5419 (setq col
(current-column))
5420 (if (looking-at "[a-zA-Z0-9_]")
5421 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
5425 (buffer-substring (match-beginning 0)
5426 (match-end 0))) "\\>"))
5427 (error "Cannot line up in a middle of the word"))
5428 (if (looking-at "$")
5429 (error "Cannot line up end of line"))
5430 (setq search
(regexp-quote (char-to-string (following-char)))))
5431 (setq step
(or step cperl-lineup-step cperl-indent-level
))
5432 (or minshift
(setq minshift
1))
5434 (beginning-of-line 2)
5435 (and (< (point) end
)
5436 (re-search-forward search end t
)
5437 (goto-char (match-beginning 0))))
5438 (setq tcol
(current-column) seen t
)
5439 (if (> tcol col
) (setq col tcol
)))
5441 (error "The construction to line up occurred only once"))
5443 (setq col
(+ col minshift
))
5444 (if (/= (% col step
) 0) (setq step
(* step
(1+ (/ col step
)))))
5448 (skip-chars-backward " \t")
5449 (delete-region (point) e
)
5450 (indent-to-column col
) ;(make-string (- col (current-column)) ?\ ))
5451 (beginning-of-line 2)
5452 (and (< (point) end
)
5453 (re-search-forward search end t
)
5454 (goto-char (match-beginning 0)))))))) ; No body
5456 (defun cperl-etags (&optional add all files
)
5457 "Run etags with appropriate options for Perl files.
5458 If optional argument ALL is `recursive', will process Perl files
5459 in subdirectories too."
5462 (args '("-l" "none" "-r" "/\\<\\(package\\|sub\\)[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([{#]\\|$\\)\\)/\\4/"))
5464 (if add
(setq args
(cons "-a" args
)))
5465 (or files
(setq files
(list buffer-file-name
)))
5467 ((eq all
'recursive
)
5468 ;;(error "Not implemented: recursive")
5469 (setq args
(append (list "-e"
5470 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
5472 find(\\&wanted, '.');
5477 ;;(error "Not implemented: all")
5478 (setq args
(append (list "-e"
5479 "push @ARGV, <*.PL *.pl *.pm>;
5484 (setq args
(append args files
))))
5485 (setq res
(apply 'call-process cmd nil nil nil args
))
5487 (message "etags returned \"%s\"" res
))))
5489 (defun cperl-toggle-auto-newline ()
5490 "Toggle the state of `cperl-auto-newline'."
5492 (setq cperl-auto-newline
(not cperl-auto-newline
))
5493 (message "Newlines will %sbe auto-inserted now."
5494 (if cperl-auto-newline
"" "not ")))
5496 (defun cperl-toggle-abbrev ()
5497 "Toggle the state of automatic keyword expansion in CPerl mode."
5499 (abbrev-mode (if abbrev-mode
0 1))
5500 (message "Perl control structure will %sbe auto-inserted now."
5501 (if abbrev-mode
"" "not ")))
5504 (defun cperl-toggle-electric ()
5505 "Toggle the state of parentheses doubling in CPerl mode."
5507 (setq cperl-electric-parens
(if (cperl-val 'cperl-electric-parens
) 'null t
))
5508 (message "Parentheses will %sbe auto-doubled now."
5509 (if (cperl-val 'cperl-electric-parens
) "" "not ")))
5511 (defun cperl-toggle-autohelp ()
5512 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
5513 Delay of auto-help controlled by `cperl-lazy-help-time'."
5515 (if (fboundp 'run-with-idle-timer
)
5517 (if cperl-lazy-installed
5518 (cperl-lazy-unstall)
5519 (cperl-lazy-install))
5520 (message "Perl help messages will %sbe automatically shown now."
5521 (if cperl-lazy-installed
"" "not ")))
5522 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
5524 (defun cperl-toggle-construct-fix ()
5525 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
5527 (setq cperl-indent-region-fix-constructs
5528 (if cperl-indent-region-fix-constructs
5531 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
5532 (if cperl-indent-region-fix-constructs
"" "not ")))
5534 ;;;; Tags file creation.
5536 (defvar cperl-tmp-buffer
" *cperl-tmp*")
5538 (defun cperl-setup-tmp-buf ()
5539 (set-buffer (get-buffer-create cperl-tmp-buffer
))
5540 (set-syntax-table cperl-mode-syntax-table
)
5541 (buffer-disable-undo)
5543 (if cperl-use-syntax-table-text-property-for-tags
5545 (make-local-variable 'parse-sexp-lookup-properties
)
5546 ;; Do not introduce variable if not needed, we check it!
5547 (set 'parse-sexp-lookup-properties t
))))
5549 (defun cperl-xsub-scan ()
5551 (let ((index-alist '())
5552 (prev-pos 0) index index1 name package prefix
)
5553 (goto-char (point-min))
5555 (message "Scanning XSUB for index")
5556 (imenu-progress-message prev-pos
0))
5557 ;; Search for the function
5558 (progn ;;save-match-data
5559 (while (re-search-forward
5560 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5563 (imenu-progress-message prev-pos
))
5565 ((match-beginning 2) ; SECTION
5566 (setq package
(buffer-substring (match-beginning 2) (match-end 2)))
5567 (goto-char (match-beginning 0))
5568 (skip-chars-forward " \t")
5570 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
5571 (setq prefix
(buffer-substring (match-beginning 1) (match-end 1)))
5573 ((not package
) nil
) ; C language section
5574 ((match-beginning 3) ; XSUB
5575 (goto-char (1+ (match-beginning 3)))
5576 (setq index
(imenu-example--name-and-position))
5577 (setq name
(buffer-substring (match-beginning 3) (match-end 3)))
5578 (if (and prefix
(string-match (concat "^" prefix
) name
))
5579 (setq name
(substring name
(length prefix
))))
5580 (cond ((string-match "::" name
) nil
)
5582 (setq index1
(cons (concat package
"::" name
) (cdr index
)))
5583 (push index1 index-alist
)))
5585 (push index index-alist
))
5587 ;; (beginning-of-line)
5588 (setq index
(imenu-example--name-and-position))
5589 (setcar index
(concat package
"::BOOT:"))
5590 (push index index-alist
)))))
5592 (imenu-progress-message prev-pos
100))
5595 (defvar cperl-unreadable-ok nil
)
5597 (defun cperl-find-tags (ifile xs topdir
)
5598 (let ((b (get-buffer cperl-tmp-buffer
)) ind lst elt pos ret rel
5599 (cperl-pod-here-fontify nil
) f file
)
5601 (if b
(set-buffer b
)
5602 (cperl-setup-tmp-buf))
5605 (setq file
(car (insert-file-contents ifile
)))
5606 (error (if cperl-unreadable-ok nil
5608 (format "File %s unreadable. Continue? " ifile
))
5609 (setq cperl-unreadable-ok t
)
5610 (error "Aborting: unreadable file %s" ifile
)))))
5612 (message "Unreadable file %s" ifile
)
5613 (message "Scanning file %s ..." file
)
5614 (if (and cperl-use-syntax-table-text-property-for-tags
5616 (condition-case err
; after __END__ may have garbage
5617 (cperl-find-pods-heres nil nil noninteractive
)
5618 (error (message "While scanning for syntax: %s" err
))))
5620 (setq lst
(cperl-xsub-scan))
5621 (setq ind
(cperl-imenu--create-perl-index))
5622 (setq lst
(cdr (assoc "+Unsorted List+..." ind
))))
5627 (cond ((string-match "^[_a-zA-Z]" (car elt
))
5628 (goto-char (cdr elt
))
5629 (beginning-of-line) ; pos should be of the start of the line
5632 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
5633 (buffer-substring (progn
5634 (goto-char (cdr elt
))
5635 ;; After name now...
5636 (or (eolp) (forward-char 1))
5644 (setq elt
(car lst
) lst
(cdr lst
))
5649 (if (string-match "^package " (car elt
))
5650 (substring (car elt
) 8)
5653 (number-to-string (elt elt
2)) ; Line
5655 (number-to-string (1- (elt elt
1))) ; Char pos 0-based
5657 (if (and (string-match "^[_a-zA-Z]+::" (car elt
))
5658 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
5660 ;; Need to insert the name without package as well
5661 (setq lst
(cons (cons (substring (elt elt
3)
5669 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5670 (set-text-properties 0 (length rel
) nil rel
)
5671 (and (equal topdir
(substring rel
0 (length topdir
)))
5672 (setq rel
(substring file
(length topdir
))))
5673 (insert "\f\n" rel
"," (number-to-string (1- pos
)) "\n")
5674 (setq ret
(buffer-substring 1 (point-max)))
5677 (message "Scanning file %s finished" file
))
5680 (defun cperl-add-tags-recurse-noxs ()
5681 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5683 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5684 -f cperl-add-tags-recurse
5686 (cperl-write-tags nil nil t t nil t
))
5688 (defun cperl-add-tags-recurse ()
5689 "Add to TAGS file data for Perl files in the current directory and kids.
5691 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5692 -f cperl-add-tags-recurse
5694 (cperl-write-tags nil nil t t
))
5696 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir
)
5697 ;; If INBUFFER, do not select buffer, and do not save
5698 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5701 (setq file
(if dir default-directory
(buffer-file-name)))
5702 (if (and (not dir
) (buffer-modified-p)) (error "Save buffer first!")))
5704 (setq topdir default-directory
))
5705 (let ((tags-file-name "TAGS")
5706 (case-fold-search (eq system-type
'emx
))
5709 (cond (inbuffer nil
) ; Already there
5710 ((file-exists-p tags-file-name
)
5712 (visit-tags-table-buffer)
5713 (visit-tags-table-buffer tags-file-name
)))
5714 (t (set-buffer (find-file-noselect tags-file-name
))))
5717 (cond ((eq erase
'ignore
))
5720 (setq erase
'ignore
)))
5723 (directory-files file t
5724 (if recurse nil cperl-scan-files-regexp
)
5727 (if cperl-unreadable-ok nil
5729 (format "Directory %s unreadable. Continue? " file
))
5730 (setq cperl-unreadable-ok t
5731 tm nil
) ; Return empty list
5732 (error "Aborting: unreadable directory %s" file
)))))))
5736 ((string-match cperl-noscan-files-regexp file
)
5738 ((not (file-directory-p file
))
5739 (if (string-match cperl-scan-files-regexp file
)
5740 (cperl-write-tags file erase recurse nil t noxs topdir
)))
5742 (t (cperl-write-tags file erase recurse t t noxs topdir
)))))
5745 (setq xs
(string-match "\\.xs$" file
))
5746 (if (not (and xs noxs
))
5748 (cond ((eq erase
'ignore
) (goto-char (point-max)))
5749 (erase (erase-buffer))
5753 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5754 (set-text-properties 0 (length rel
) nil rel
)
5755 (and (equal topdir
(substring rel
0 (length topdir
)))
5756 (setq rel
(substring file
(length topdir
))))
5757 (if (search-forward (concat "\f\n" rel
",") nil t
)
5759 (search-backward "\f\n")
5760 (delete-region (point)
5763 (if (search-forward "\f\n"
5767 (goto-char (point-max)))))
5768 (insert (cperl-find-tags file xs topdir
))))))
5769 (if inbuffer nil
; Delegate to the caller
5770 (save-buffer 0) ; No backup
5771 (if (fboundp 'initialize-new-tags-table
) ; Do we need something special in XEmacs?
5772 (initialize-new-tags-table))))))
5774 (defvar cperl-tags-hier-regexp-list
5781 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
5783 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
5786 (defvar cperl-hierarchy
'(() ())
5787 "Global hierarchy of classes.")
5789 (defun cperl-tags-hier-fill ()
5790 ;; Suppose we are in a tag table cooked by cperl.
5792 (let (type pack name pos line chunk ord cons1 file str info fileind
)
5793 (while (re-search-forward cperl-tags-hier-regexp-list nil t
)
5794 (setq pos
(match-beginning 0)
5795 pack
(match-beginning 2))
5797 (if (looking-at (concat
5806 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
5807 name
(buffer-substring (match-beginning 2) (match-end 2))
5808 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5809 line
(buffer-substring (match-beginning 3) (match-end 3))
5812 fileind
(format "%s:%s" file line
)
5813 ;; Moves to beginning of the next line:
5814 info
(cperl-etags-snarf-tag file line
))
5817 ;; Make new member of hierarchy name ==> file ==> pos if needed
5818 (if (setq cons1
(assoc name
(nth ord cperl-hierarchy
)))
5820 (setcdr cons1
(cons (cons fileind
(vector file info
))
5822 ;; First occurrence of the name, start alist
5823 (setq cons1
(cons name
(list (cons fileind
(vector file info
)))))
5825 (setcar (cdr cperl-hierarchy
)
5826 (cons cons1
(nth 1 cperl-hierarchy
)))
5827 (setcar cperl-hierarchy
5828 (cons cons1
(car cperl-hierarchy
)))))))
5831 (defun cperl-tags-hier-init (&optional update
)
5832 "Show hierarchical menu of classes and methods.
5833 Finds info about classes by a scan of loaded TAGS files.
5834 Supposes that the TAGS files contain fully qualified function names.
5835 One may build such TAGS files from CPerl mode menu."
5839 (if (or update
(null (nth 2 cperl-hierarchy
)))
5840 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
5843 (setcdr elt
(cdr (nth 1 elt
)))))))
5844 pack name cons1 to l1 l2 l3 l4 b
)
5845 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5846 (setq cperl-hierarchy
(list l1 l2 l3
))
5847 (if cperl-xemacs-p
; Not checked
5850 ;; Does this work in XEmacs?
5851 (call-interactively 'visit-tags-table
))
5852 (message "Updating list of classes...")
5853 (set-buffer (get-file-buffer tags-file-name
))
5854 (cperl-tags-hier-fill))
5856 (call-interactively 'visit-tags-table
))
5860 (message "Updating list of classes... %s" tagsfile
)
5861 (set-buffer (get-file-buffer tagsfile
))
5862 (cperl-tags-hier-fill)))
5864 (message "Updating list of classes... postprocessing..."))
5865 (mapcar remover
(car cperl-hierarchy
))
5866 (mapcar remover
(nth 1 cperl-hierarchy
))
5867 (setq to
(list nil
(cons "Packages: " (nth 1 cperl-hierarchy
))
5868 (cons "Methods: " (car cperl-hierarchy
))))
5869 (cperl-tags-treeify to
1)
5870 (setcar (nthcdr 2 cperl-hierarchy
)
5871 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -
999) (cdr to
))))
5872 (message "Updating list of classes: done, requesting display...")
5873 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5875 (or (nth 2 cperl-hierarchy
)
5876 (error "No items found"))
5878 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
5879 (if (if (fboundp 'display-popup-menus-p
)
5880 (let ((f 'display-popup-menus-p
))
5883 (x-popup-menu t
(nth 2 cperl-hierarchy
))
5885 (tmm-prompt (nth 2 cperl-hierarchy
))))
5886 (if (and update
(listp update
))
5887 (progn (while (cdr update
) (setq update
(cdr update
)))
5888 (setq update
(car update
)))) ; Get the last from the list
5889 (if (vectorp update
)
5891 (find-file (elt update
0))
5892 (cperl-etags-goto-tag-location (elt update
1))))
5893 (if (eq update -
999) (cperl-tags-hier-init t
)))
5895 (defun cperl-tags-treeify (to level
)
5896 ;; cadr of `to' is read-write. On start it is a cons
5897 (let* ((regexp (concat "^\\(" (mapconcat
5899 (make-list level
"[_a-zA-Z0-9]+")
5902 (packages (cdr (nth 1 to
)))
5903 (methods (cdr (nth 2 to
)))
5904 l1 head tail cons1 cons2 ord writeto packs recurse
5905 root-packages root-functions ms many_ms same_name ps
5909 (cond ((and (string-match regexp
(car elt
))
5910 (or (eq ord
1) (match-end 2)))
5911 (setq head
(substring (car elt
) 0 (match-end 1))
5912 tail
(if (match-end 2) (substring (car elt
)
5915 (if (setq cons1
(assoc head writeto
)) nil
5916 ;; Need to init new head
5917 (setcdr writeto
(cons (list head
(list "Packages: ")
5920 (setq cons1
(nth 1 writeto
)))
5921 (setq cons2
(nth ord cons1
)) ; Either packs or meths
5922 (setcdr cons2
(cons elt
(cdr cons2
))))
5924 (setq root-functions
(cons elt root-functions
)))
5926 (setq root-packages
(cons elt root-packages
))))))))
5927 (setcdr to l1
) ; Init to dynamic space
5930 (mapcar move-deeper packages
)
5932 (mapcar move-deeper methods
)
5934 (mapcar (function (lambda (elt)
5935 (cperl-tags-treeify elt
(1+ level
))))
5937 ;;Now clean up leaders with one child only
5938 (mapcar (function (lambda (elt)
5939 (if (not (and (listp (cdr elt
))
5940 (eq (length elt
) 2))) nil
5941 (setcar elt
(car (nth 1 elt
)))
5942 (setcdr elt
(cdr (nth 1 elt
))))))
5944 ;; Sort the roots of subtrees
5945 (if (default-value 'imenu-sort-function
)
5947 (sort (cdr to
) (default-value 'imenu-sort-function
))))
5948 ;; Now add back functions removed from display
5949 (mapcar (function (lambda (elt)
5950 (setcdr to
(cons elt
(cdr to
)))))
5951 (if (default-value 'imenu-sort-function
)
5953 (sort root-functions
(default-value 'imenu-sort-function
)))
5955 ;; Now add back packages removed from display
5956 (mapcar (function (lambda (elt)
5957 (setcdr to
(cons (cons (concat "package " (car elt
))
5960 (if (default-value 'imenu-sort-function
)
5962 (sort root-packages
(default-value 'imenu-sort-function
)))
5966 ;;; '(keymap "Name1"
5970 ;;; ("Tail1" "x") ("Tail2" "y"))))
5972 (defun cperl-list-fold (list name limit
)
5973 (let (list1 list2 elt1
(num 0))
5974 (if (<= (length list
) limit
) list
5975 (setq list1 nil list2 nil
)
5980 (if (<= num imenu-max-items
)
5981 (setq list2
(cons elt1 list2
))
5982 (setq list1
(cons (cons name
5987 (nreverse (cons (cons name
5991 (defun cperl-menu-to-keymap (menu &optional name
)
5997 (cond ((listp (cdr elt
))
5998 (setq list
(cperl-list-fold
5999 (cdr elt
) (car elt
) imenu-max-items
))
6002 (cperl-menu-to-keymap list
))))
6004 (list (cdr elt
) (car elt
) t
))))) ; t is needed in 19.34
6005 (cperl-list-fold menu
"Root" imenu-max-items
)))))
6008 (defvar cperl-bad-style-regexp
6009 (mapconcat 'identity
6010 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
6011 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
6013 "Finds places such that insertion of a whitespace may help a lot.")
6015 (defvar cperl-not-bad-style-regexp
6018 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
6019 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
6020 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
6021 "<\\$?\\sw+\\(\\.\\sw+\\)?>" ; <IN> <stdin.h>
6022 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
6029 "\\\\[&$@*\\\\]" ; \&func
6032 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
6035 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
6036 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
6037 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
6041 "If matches at the start of match found by `my-bad-c-style-regexp',
6042 insertion of a whitespace will not help.")
6046 (defun cperl-find-bad-style ()
6047 "Find places in the buffer where insertion of a whitespace may help.
6048 Prompts user for insertion of spaces.
6049 Currently it is tuned to C and Perl syntax."
6051 (let (found-bad (p (point)))
6052 (setq last-nonmenu-event
13) ; To disable popup
6053 (beginning-of-buffer)
6054 (map-y-or-n-p "Insert space here? "
6055 (lambda (arg) (insert " "))
6056 'cperl-next-bad-style
6057 '("location" "locations" "insert a space into")
6058 '((?\C-r
(lambda (arg)
6059 (let ((buffer-quit-function
6060 'exit-recursive-edit
))
6061 (message "Exit with Esc Esc")
6063 t
)) ; Consider acted upon
6064 "edit, exit with Esc Esc")
6066 (let ((buffer-quit-function
6067 'exit-recursive-edit
))
6068 (message "Exit with Esc Esc")
6070 t
)) ; Consider acted upon
6071 "edit, exit with Esc Esc"))
6073 (if found-bad
(goto-char found-bad
)
6075 (message "No appropriate place found"))))
6077 (defun cperl-next-bad-style ()
6078 (let (p (not-found t
) (point (point)) found
)
6079 (while (and not-found
6080 (re-search-forward cperl-bad-style-regexp nil
'to-end
))
6082 (goto-char (match-beginning 0))
6084 (looking-at cperl-not-bad-style-regexp
)
6085 ;; Check for a < -b and friends
6086 (and (eq (following-char) ?\-
)
6088 (skip-chars-backward " \t\n")
6089 (memq (preceding-char) '(?\
= ?\
> ?\
< ?\
, ?\
( ?\
[ ?\
{))))
6090 ;; Now check for syntax type
6092 (setq found
(point))
6093 (beginning-of-defun)
6094 (let ((pps (parse-partial-sexp (point) found
)))
6095 (or (nth 3 pps
) (nth 4 pps
) (nth 5 pps
)))))
6096 (goto-char (match-end 0))
6104 (defvar cperl-have-help-regexp
6108 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
6109 "[$@]\\^[a-zA-Z]" ; Special variable
6110 "[$@][^ \n\t]" ; Special variable
6111 "-[a-zA-Z]" ; File test
6112 "\\\\[a-zA-Z0]" ; Special chars
6113 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
6114 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
6115 "[a-zA-Z_0-9:]+" ; symbol or number
6122 "Matches places in the buffer we can find help for.")
6124 (defvar cperl-message-on-help-error t
)
6125 (defvar cperl-help-from-timer nil
)
6127 (defun cperl-word-at-point-hard ()
6128 ;; Does not save-excursion
6129 ;; Get to the something meaningful
6130 (or (eobp) (eolp) (forward-char 1))
6131 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
6132 (save-excursion (beginning-of-line) (point))
6135 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
6136 ;; (skip-chars-backward " \n\t\r({[]});,")
6137 ;; (or (bobp) (backward-char 1))))
6140 ((looking-at "[a-zA-Z0-9_:]") ; symbol
6141 (skip-chars-backward "a-zA-Z0-9_:")
6143 ((and (eq (preceding-char) ?^
) ; $^I
6144 (eq (char-after (- (point) 2)) ?\$
))
6146 ((memq (preceding-char) (append "*$@%&\\" nil
)) ; *glob
6148 ((and (eq (preceding-char) ?\
=)
6149 (eq (current-column) 1))
6150 (forward-char -
1))) ; =head1
6151 (if (and (eq (preceding-char) ?\
<)
6152 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
6154 ((and (looking-at "=") (eq (preceding-char) ?x
)) ; x=
6156 ((and (looking-at "\\^") (eq (preceding-char) ?\$
)) ; $^I
6158 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
6159 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
6161 ((and (eq (preceding-char) ?\$
)
6162 (not (eq (char-after (- (point) 2)) ?\$
))) ; $-
6164 ((and (eq (following-char) ?\
>)
6165 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
6168 (and (eq (preceding-char) ?\
<)
6169 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
6170 (search-backward "<"))))
6171 ((and (eq (following-char) ?\$
)
6172 (eq (preceding-char) ?\
<)
6173 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
6175 (if (looking-at cperl-have-help-regexp
)
6176 (buffer-substring (match-beginning 0) (match-end 0))))
6178 (defun cperl-get-help ()
6179 "Get one-line docs on the symbol at the point.
6180 The data for these docs is a little bit obsolete and may be in fact longer
6181 than a line. Your contribution to update/shorten it is appreciated."
6183 (save-match-data ; May be called "inside" query-replace
6185 (let ((word (cperl-word-at-point-hard)))
6187 (if (and cperl-help-from-timer
; Bail out if not in mainland
6188 (not (string-match "^#!\\|\\\\\\|^=" word
)) ; Show help even in comments/strings.
6189 (or (memq (get-text-property (point) 'face
)
6190 '(font-lock-comment-face font-lock-string-face
))
6191 (memq (get-text-property (point) 'syntax-type
)
6192 '(pod here-doc format
))))
6194 (cperl-describe-perl-symbol word
))
6195 (if cperl-message-on-help-error
6196 (message "Nothing found for %s..."
6197 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
6199 ;;; Stolen from perl-descr.el by Johan Vromans:
6201 (defvar cperl-doc-buffer
" *perl-doc*"
6202 "Where the documentation can be found.")
6204 (defun cperl-describe-perl-symbol (val)
6205 "Display the documentation of symbol at point, a Perl operator."
6206 (let ((enable-recursive-minibuffers t
)
6209 ((string-match "^[&*][a-zA-Z_]" val
)
6210 (setq val
(concat (substring val
0 1) "NAME")))
6211 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val
)
6212 (setq val
(concat "@" (substring val
1 (match-end 1)))))
6213 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val
)
6214 (setq val
(concat "%" (substring val
1 (match-end 1)))))
6215 ((and (string= val
"x") (string-match "^x=" val
))
6217 ((string-match "^\\$[\C-a-\C-z]" val
)
6218 (setq val
(concat "$^" (char-to-string (+ ?A -
1 (aref val
1))))))
6219 ((string-match "^CORE::" val
)
6220 (setq val
"CORE::"))
6221 ((string-match "^SUPER::" val
)
6222 (setq val
"SUPER::"))
6223 ((and (string= "<" val
) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val
))
6224 (setq val
"<NAME>")))
6225 (setq regexp
(concat "^"
6226 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
6228 "\\([ \t([/]\\|$\\)"))
6230 ;; get the buffer with the documentation text
6231 (cperl-switch-to-doc-buffer)
6233 ;; lookup in the doc
6234 (goto-char (point-min))
6235 (let ((case-fold-search nil
))
6237 (if (re-search-forward regexp
(point-max) t
)
6239 (beginning-of-line 1)
6240 (let ((lnstart (point)))
6242 (message "%s" (buffer-substring lnstart
(point)))))
6243 (if cperl-message-on-help-error
6244 (message "No definition for %s" val
)))))))
6246 (defvar cperl-short-docs
'please-ignore-this-line
6247 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
6248 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
6249 ... Range (list context); flip/flop [no flop when flip] (scalar context).
6250 ! ... Logical negation.
6251 ... != ... Numeric inequality.
6252 ... !~ ... Search pattern, substitution, or translation (negated).
6253 $! In numeric context: errno. In a string context: error string.
6254 $\" The separator which joins elements of arrays interpolated in strings.
6255 $# The output format for printed numbers. Default is %.15g or close.
6256 $$ Process number of this script. Changes in the fork()ed child process.
6257 $% The current page number of the currently selected output channel.
6259 The following variables are always local to the current block:
6261 $1 Match of the 1st set of parentheses in the last match (auto-local).
6262 $2 Match of the 2nd set of parentheses in the last match (auto-local).
6263 $3 Match of the 3rd set of parentheses in the last match (auto-local).
6264 $4 Match of the 4th set of parentheses in the last match (auto-local).
6265 $5 Match of the 5th set of parentheses in the last match (auto-local).
6266 $6 Match of the 6th set of parentheses in the last match (auto-local).
6267 $7 Match of the 7th set of parentheses in the last match (auto-local).
6268 $8 Match of the 8th set of parentheses in the last match (auto-local).
6269 $9 Match of the 9th set of parentheses in the last match (auto-local).
6270 $& The string matched by the last pattern match (auto-local).
6271 $' The string after what was matched by the last match (auto-local).
6272 $` The string before what was matched by the last match (auto-local).
6274 $( The real gid of this process.
6275 $) The effective gid of this process.
6276 $* Deprecated: Set to 1 to do multiline matching within a string.
6277 $+ The last bracket matched by the last search pattern.
6278 $, The output field separator for the print operator.
6279 $- The number of lines left on the page.
6280 $. The current input line number of the last filehandle that was read.
6281 $/ The input record separator, newline by default.
6282 $0 Name of the file containing the current perl script (read/write).
6283 $: String may be broken after these characters to fill ^-lines in a format.
6284 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
6285 $< The real uid of this process.
6286 $= The page length of the current output channel. Default is 60 lines.
6287 $> The effective uid of this process.
6288 $? The status returned by the last ``, pipe close or `system'.
6289 $@ The perl error message from the last eval or do @var{EXPR} command.
6290 $ARGV The name of the current file used with <> .
6291 $[ Deprecated: The index of the first element/char in an array/string.
6292 $\\ The output record separator for the print operator.
6293 $] The perl version string as displayed with perl -v.
6294 $^ The name of the current top-of-page format.
6295 $^A The current value of the write() accumulator for format() lines.
6296 $^D The value of the perl debug (-D) flags.
6297 $^E Information about the last system error other than that provided by $!.
6298 $^F The highest system file descriptor, ordinarily 2.
6299 $^H The current set of syntax checks enabled by `use strict'.
6300 $^I The value of the in-place edit extension (perl -i option).
6301 $^L What formats output to perform a formfeed. Default is \f.
6302 $^M A buffer for emergency memory allocation when running out of memory.
6303 $^O The operating system name under which this copy of Perl was built.
6304 $^P Internal debugging flag.
6305 $^T The time the script was started. Used by -A/-M/-C file tests.
6306 $^W True if warnings are requested (perl -w flag).
6307 $^X The name under which perl was invoked (argv[0] in C-speech).
6308 $_ The default input and pattern-searching space.
6309 $| Auto-flush after write/print on current output channel? Default 0.
6310 $~ The name of the current report format.
6311 ... % ... Modulo division.
6312 ... %= ... Modulo division assignment.
6313 %ENV Contains the current environment.
6314 %INC List of files that have been require-d or do-ne.
6315 %SIG Used to set signal handlers for various signals.
6316 ... & ... Bitwise and.
6317 ... && ... Logical and.
6318 ... &&= ... Logical and assignment.
6319 ... &= ... Bitwise and assignment.
6320 ... * ... Multiplication.
6321 ... ** ... Exponentiation.
6322 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6323 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
6324 ... + ... Addition. +EXPR Makes EXPR into scalar context.
6325 ++ Auto-increment (magical on strings). ++EXPR EXPR++
6326 ... += ... Addition assignment.
6328 ... - ... Subtraction.
6329 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6330 ... -= ... Subtraction assignment.
6331 -A Access time in days since script started.
6332 -B File is a non-text (binary) file.
6333 -C Inode change time in days since script started.
6334 -M Age in days since script started.
6335 -O File is owned by real uid.
6336 -R File is readable by real uid.
6337 -S File is a socket .
6338 -T File is a text file.
6339 -W File is writable by real uid.
6340 -X File is executable by real uid.
6341 -b File is a block special file.
6342 -c File is a character special file.
6343 -d File is a directory.
6345 -f File is a plain file.
6346 -g File has setgid bit set.
6347 -k File has sticky bit set.
6348 -l File is a symbolic link.
6349 -o File is owned by effective uid.
6350 -p File is a named pipe (FIFO).
6351 -r File is readable by effective uid.
6352 -s File has non-zero size.
6353 -t Tests if filehandle (STDIN by default) is opened to a tty.
6354 -u File has setuid bit set.
6355 -w File is writable by effective uid.
6356 -x File is executable by effective uid.
6357 -z File has zero size.
6358 . Concatenate strings.
6359 .. Range (list context); flip/flop (scalar context) operator.
6360 .= Concatenate assignment strings
6361 ... / ... Division. /PATTERN/ioxsmg Pattern match
6362 ... /= ... Division assignment.
6363 /PATTERN/ioxsmg Pattern match.
6364 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6365 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6366 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6367 <> Reads line from union of files in @ARGV (= command line) and STDIN.
6368 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6369 ... <= ... Numeric less than or equal to.
6370 ... <=> ... Numeric compare.
6371 ... = ... Assignment.
6372 ... == ... Numeric equality.
6373 ... =~ ... Search pattern, substitution, or translation
6374 ... > ... Numeric greater than.
6375 ... >= ... Numeric greater than or equal to.
6376 ... >> ... Bitwise shift right.
6377 ... >>= ... Bitwise shift right assignment.
6378 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6379 ?PATTERN? One-time pattern match.
6380 @ARGV Command line arguments (not including the command name - see $0).
6381 @INC List of places to look for perl scripts during do/include/use.
6382 @_ Parameter array for subroutines; result of split() unless in list context.
6383 \\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
6384 \\0 Octal char, e.g. \\033.
6385 \\E Case modification terminator. See \\Q, \\L, and \\U.
6386 \\L Lowercase until \\E . See also \l, lc.
6387 \\U Upcase until \\E . See also \u, uc.
6388 \\Q Quote metacharacters until \\E . See also quotemeta.
6389 \\a Alarm character (octal 007).
6390 \\b Backspace character (octal 010).
6391 \\c Control character, e.g. \\c[ .
6392 \\e Escape character (octal 033).
6393 \\f Formfeed character (octal 014).
6394 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
6395 \\n Newline character (octal 012 on most systems).
6396 \\r Return character (octal 015 on most systems).
6397 \\t Tab character (octal 011).
6398 \\u Upcase the next character. See also \\U and \\l, ucfirst.
6399 \\x Hex character, e.g. \\x1b.
6400 ... ^ ... Bitwise exclusive or.
6401 __END__ Ends program source.
6402 __DATA__ Ends program source.
6403 __FILE__ Current (source) filename.
6404 __LINE__ Current line in current source.
6405 __PACKAGE__ Current package.
6406 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6407 ARGVOUT Output filehandle with -i flag.
6408 BEGIN { ... } Immediately executed (during compilation) piece of code.
6409 END { ... } Pseudo-subroutine executed after the script finishes.
6410 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
6411 INIT { ... } Pseudo-subroutine executed before the script starts running.
6412 DATA Input filehandle for what follows after __END__ or __DATA__.
6413 accept(NEWSOCKET,GENERICSOCKET)
6426 ... cmp ... String compare.
6427 connect(SOCKET,NAME)
6428 continue of { block } continue { block }. Is executed after `next' or at end.
6430 crypt(PLAINTEXT,SALT)
6432 dbmopen(%HASH,DBNAME,MODE)
6436 do { ... }|SUBR while|until EXPR executes at least once
6437 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6447 ... eq ... String equality.
6448 eval(EXPR) or eval { BLOCK }
6452 fcntl(FILEHANDLE,FUNCTION,SCALAR)
6454 flock(FILEHANDLE,OPERATION)
6455 for (EXPR;EXPR;EXPR) { ... }
6456 foreach [VAR] (@ARRAY) { ... }
6458 ... ge ... String greater than or equal.
6463 gethostbyaddr(ADDR,ADDRTYPE)
6467 getnetbyaddr(ADDR,ADDRTYPE)
6473 getpriority(WHICH,WHO)
6474 getprotobyname(NAME)
6475 getprotobynumber(NUMBER)
6480 getservbyname(NAME,PROTO)
6481 getservbyport(PORT,PROTO)
6484 getsockopt(SOCKET,LEVEL,OPTNAME)
6487 ... gt ... String greater than.
6489 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6490 index(STR,SUBSTR[,OFFSET])
6492 ioctl(FILEHANDLE,FUNCTION,SCALAR)
6497 ... le ... String less than or equal.
6499 link(OLDFILE,NEWFILE)
6500 listen(SOCKET,QUEUESIZE)
6504 lstat(EXPR|FILEHANDLE|VAR)
6505 ... lt ... String less than.
6507 mkdir(FILENAME,MODE)
6510 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6511 msgsnd(ID,MSG,FLAGS)
6512 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6513 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
6514 ... ne ... String inequality.
6517 open(FILEHANDLE[,EXPR])
6518 opendir(DIRHANDLE,EXPR)
6519 ord(EXPR) ASCII value of the first char of the string.
6521 package NAME Introduces package context.
6522 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6524 print [FILEHANDLE] [(LIST)]
6525 printf [FILEHANDLE] (FORMAT,LIST)
6527 q/STRING/ Synonym for 'STRING'
6528 qq/STRING/ Synonym for \"STRING\"
6529 qx/STRING/ Synonym for `STRING`
6531 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6534 recv(SOCKET,SCALAR,LEN,FLAGS)
6536 rename(OLDNAME,NEWNAME)
6537 require [FILENAME | PERL_VERSION]
6541 rewinddir(DIRHANDLE)
6542 rindex(STR,SUBSTR[,OFFSET])
6544 s/PATTERN/REPLACEMENT/gieoxsm
6546 seek(FILEHANDLE,POSITION,WHENCE)
6547 seekdir(DIRHANDLE,POS)
6548 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6549 semctl(ID,SEMNUM,CMD,ARG)
6550 semget(KEY,NSEMS,SIZE,FLAGS)
6552 send(SOCKET,MSG,FLAGS[,TO])
6554 sethostent(STAYOPEN)
6557 setpriority(WHICH,WHO,PRIORITY)
6558 setprotoent(STAYOPEN)
6560 setservent(STAYOPEN)
6561 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6564 shmget(KEY,SIZE,FLAGS)
6565 shmread(ID,VAR,POS,SIZE)
6566 shmwrite(ID,STRING,POS,SIZE)
6567 shutdown(SOCKET,HOW)
6570 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6571 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6572 sort [SUBROUTINE] (LIST)
6573 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6574 split[(/PATTERN/[,EXPR[,LIMIT]])]
6575 sprintf(FORMAT,LIST)
6578 stat(EXPR|FILEHANDLE|VAR)
6580 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6581 substr(EXPR,OFFSET[,LEN])
6582 symlink(OLDFILE,NEWFILE)
6584 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6586 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6591 tr/SEARCHLIST/REPLACEMENTLIST/cds
6592 truncate(FILE|EXPR,LENGTH)
6595 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6597 unpack(TEMPLATE,EXPR)
6599 until (EXPR) { ... } EXPR until EXPR
6602 vec(EXPR,OFFSET,BITS)
6605 wantarray Returns true if the sub/eval is called in list context.
6607 while (EXPR) { ... } EXPR while EXPR
6608 write[(EXPR|FILEHANDLE)]
6609 ... x ... Repeat string or array.
6610 x= ... Repetition assignment.
6611 y/SEARCHLIST/REPLACEMENTLIST/
6612 ... | ... Bitwise or.
6613 ... || ... Logical or.
6614 ~ ... Unary bitwise complement.
6615 #! OS interpreter indicator. If contains `perl', used for options, and -x.
6616 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6617 CORE:: Prefix to access builtin function if imported sub obscures it.
6618 SUPER:: Prefix to lookup for a method in @ISA classes.
6619 DESTROY Shorthand for `sub DESTROY {...}'.
6620 ... EQ ... Obsolete synonym of `eq'.
6621 ... GE ... Obsolete synonym of `ge'.
6622 ... GT ... Obsolete synonym of `gt'.
6623 ... LE ... Obsolete synonym of `le'.
6624 ... LT ... Obsolete synonym of `lt'.
6625 ... NE ... Obsolete synonym of `ne'.
6626 abs [ EXPR ] absolute value
6627 ... and ... Low-precedence synonym for &&.
6628 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6629 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6630 chr Converts a number to char with the same ordinal.
6631 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6632 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6633 exists $HASH{KEY} True if the key exists.
6634 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6635 formline PICTURE, LIST Backdoor into \"format\" processing.
6636 glob EXPR Synonym of <EXPR>.
6637 lc [ EXPR ] Returns lowercased EXPR.
6638 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
6639 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
6640 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6641 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6642 not ... Low-precedence synonym for ! - negation.
6643 ... or ... Low-precedence synonym for ||.
6644 pos STRING Set/Get end-position of the last match over this string, see \\G.
6645 quotemeta [ EXPR ] Quote regexp metacharacters.
6646 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6647 readline FH Synonym of <FH>.
6648 readpipe CMD Synonym of `CMD`.
6649 ref [ EXPR ] Type of EXPR when dereferenced.
6650 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6651 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6652 tied Returns internal object for a tied data.
6653 uc [ EXPR ] Returns upcased EXPR.
6654 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6655 untie VAR Unlink an object from a simple Perl variable.
6656 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6657 ... xor ... Low-precedence synonym for exclusive or.
6658 prototype \&SUB Returns prototype of the function given a reference.
6659 =head1 Top-level heading.
6660 =head2 Second-level heading.
6661 =head3 Third-level heading (is there such?).
6662 =over [ NUMBER ] Start list.
6663 =item [ TITLE ] Start new item in the list.
6665 =cut Switch from POD to Perl.
6666 =pod Switch from Perl to POD.
6669 (defun cperl-switch-to-doc-buffer ()
6670 "Go to the perl documentation buffer and insert the documentation."
6672 (let ((buf (get-buffer-create cperl-doc-buffer
)))
6674 (switch-to-buffer-other-window buf
)
6676 (if (= (buffer-size) 0)
6678 (insert (documentation-property 'cperl-short-docs
6679 'variable-documentation
))
6680 (setq buffer-read-only t
)))))
6682 (defun cperl-beautify-regexp-piece (b e embed level
)
6683 ;; b is before the starting delimiter, e before the ending
6684 ;; e should be a marker, may be changed, but remains "correct".
6685 ;; EMBED is nil iff we process the whole REx.
6686 ;; The REx is guarantied to have //x
6687 ;; LEVEL shows how many levels deep to go
6688 ;; position at enter and at leave is not defined
6689 (let (s c tmp
(m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos
)
6693 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
6697 ((looking-at "(\\?[^a-zA-Z]")
6699 ((looking-at "(\\?") ; (?i)
6703 (setq c
(if embed
(current-indentation) (1- (current-column)))
6704 c1
(+ c
(or cperl-regexp-indent-step cperl-indent-level
)))
6705 (or (looking-at "[ \t]*[\n#]")
6710 (if (re-search-forward "[^ \t]" e t
)
6711 (progn ; Something before the ending delimiter
6713 (delete-horizontal-space)
6715 (indent-to-column c
)
6716 (set-marker e
(point))))
6719 (while (< (point) (marker-position e
))
6723 (skip-chars-forward " \t")
6724 (delete-region s
(point))
6725 (indent-to-column c1
)
6729 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
6730 "\\|" ; Embedded variable
6731 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
6734 "\\|" ; simple-code simple-code*?
6735 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
6739 "\\((\\(\\?\\)?\\)" ; 7 8
6742 (goto-char (match-end 0))
6744 (cond ((match-beginning 1) ; Alphanum word + junk
6746 ((or (match-beginning 3) ; $ab[12]
6747 (and (match-beginning 5) ; X* X+ X{2,3}
6748 (eq (preceding-char) ?\
{)))
6751 ((match-beginning 6) ; []
6753 (if (looking-at "\\^?\\]")
6754 (goto-char (match-end 0)))
6755 ;; XXXX POSIX classes?!
6756 (while (and (not pos
)
6757 (re-search-forward "\\[:\\|\\]" e t
))
6758 (if (eq (preceding-char) ?
:)
6759 (or (re-search-forward ":\\]" e t
)
6760 (error "[:POSIX:]-group in []-group not terminated"))
6762 (or (eq (preceding-char) ?\
])
6763 (error "[]-group not terminated"))
6764 (if (eq (following-char) ?\
{)
6767 (and (eq (following-char) ??
)
6769 (re-search-forward "\\=\\([*+?]\\??\\)" e t
)))
6770 ((match-beginning 7) ; ()
6771 (goto-char (match-beginning 0))
6772 (setq pos
(current-column))
6775 (delete-horizontal-space)
6777 (indent-to-column c1
)))
6780 ;; (or (forward-sexp 1)
6783 ;; (error "()-group not terminated")))
6784 (set-marker m
(1- (point)))
6785 (set-marker m1
(point))
6787 (if (progn ; indent rigidly if multiline
6788 ;; In fact does not make a lot of sense, since
6789 ;; the starting position can be already lost due
6790 ;; to insertion of "\n" and " "
6792 (search-forward "\n" m1 t
))
6793 (indent-rigidly (point) m1
(- c1 pos
)))
6794 (setq level
(1- level
))
6796 ((not (match-beginning 8))
6797 (cperl-beautify-regexp-piece tmp m t level
))
6798 ((eq (char-after (+ 2 tmp
)) ?\
{) ; Code
6800 ((eq (char-after (+ 2 tmp
)) ?\
() ; Conditional
6801 (goto-char (+ 2 tmp
))
6803 (cperl-beautify-regexp-piece (point) m t level
))
6804 ((eq (char-after (+ 2 tmp
)) ?
<) ; Lookbehind
6805 (goto-char (+ 3 tmp
))
6806 (cperl-beautify-regexp-piece (point) m t level
))
6808 (cperl-beautify-regexp-piece tmp m t level
))))
6810 (cond ((looking-at "[*+?]\\??")
6811 (goto-char (match-end 0)))
6812 ((eq (following-char) ?\
{)
6814 (if (eq (following-char) ?
\?)
6816 (skip-chars-forward " \t")
6818 (if (looking-at "[#\n]")
6820 (or (eolp) (indent-for-comment))
6821 (beginning-of-line 2))
6822 (delete-horizontal-space)
6826 ((match-beginning 9) ; |
6830 (if (re-search-forward "[^ \t]" tmp t
)
6833 (delete-horizontal-space)
6836 (delete-region (point) tmp
))
6837 (indent-to-column c
)
6839 (skip-chars-forward " \t")
6841 (if (looking-at "[#\n]")
6842 (beginning-of-line 2)
6843 (delete-horizontal-space)
6847 (or (looking-at "[ \t\n]")
6850 (skip-chars-forward " \t"))
6851 (or (looking-at "[#\n]")
6852 (error "Unknown code `%s' in a regexp"
6853 (buffer-substring (point) (1+ (point)))))
6854 (and inline
(end-of-line 2)))
6855 ;; Special-case the last line of group
6856 (if (and (>= (point) (marker-position e
))
6857 (/= (current-indentation) c
))
6861 (skip-chars-forward " \t")
6862 (delete-region s
(point))
6863 (indent-to-column c
)))))
6865 (defun cperl-make-regexp-x ()
6866 ;; Returns position of the start
6867 ;; XXX this is called too often! Need to cache the result!
6869 (or cperl-use-syntax-table-text-property
6870 (error "I need to have a regexp marked!"))
6872 (if (looking-at "\\s|")
6874 (if (looking-at "\\([smy]\\|qr\\)\\s|")
6876 (re-search-backward "\\s|"))) ; Assume it is scanned already.
6878 (let ((b (point)) (e (make-marker)) have-x delim
(c (current-column))
6879 (sub-p (eq (preceding-char) ?s
)) s
)
6881 (set-marker e
(1- (point)))
6882 (setq delim
(preceding-char))
6883 (if (and sub-p
(eq delim
(char-after (- (point) 2))))
6884 (error "Possible s/blah// - do not know how to deal with"))
6885 (if sub-p
(forward-sexp 1))
6886 (if (looking-at "\\sw*x")
6889 ;; Protect fragile " ", "#"
6892 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t
) ; Need to include (?#) too?
6898 (defun cperl-beautify-regexp (&optional deep
)
6899 "Do it. (Experimental, may change semantics, recheck the result.)
6900 We suppose that the regexp is scanned already."
6902 (setq deep
(if deep
(prefix-numeric-value deep
) -
1))
6904 (goto-char (cperl-make-regexp-x))
6905 (let ((b (point)) (e (make-marker)))
6907 (set-marker e
(1- (point)))
6908 (cperl-beautify-regexp-piece b e nil deep
))))
6910 (defun cperl-regext-to-level-start ()
6911 "Goto start of an enclosing group in regexp.
6912 We suppose that the regexp is scanned already."
6914 (let ((limit (cperl-make-regexp-x)) done
)
6916 (or (eq (following-char) ?\
()
6917 (search-backward "(" (1+ limit
) t
)
6918 (error "Cannot find `(' which starts a group"))
6921 (skip-chars-backward "\\")
6922 (looking-at "\\(\\\\\\\\\\)*(")))
6923 (or done
(forward-char -
1)))))
6925 (defun cperl-contract-level ()
6926 "Find an enclosing group in regexp and contract it.
6927 \(Experimental, may change semantics, recheck the result.)
6928 We suppose that the regexp is scanned already."
6930 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
6931 (cperl-regext-to-level-start)
6932 (let ((b (point)) (e (make-marker)) s c
)
6934 (set-marker e
(1- (point)))
6936 (while (re-search-forward "\\(#\\)\\|\n" e
'to-end
)
6938 ((match-beginning 1) ; #-comment
6939 (or c
(setq c
(current-indentation)))
6940 (beginning-of-line 2) ; Skip
6942 (skip-chars-forward " \t")
6943 (delete-region s
(point))
6944 (indent-to-column c
))
6947 (just-one-space))))))
6949 (defun cperl-contract-levels ()
6950 "Find an enclosing group in regexp and contract all the kids.
6951 \(Experimental, may change semantics, recheck the result.)
6952 We suppose that the regexp is scanned already."
6956 (cperl-regext-to-level-start)
6957 (error ; We are outside outermost group
6958 (goto-char (cperl-make-regexp-x))))
6959 (let ((b (point)) (e (make-marker)) s c
)
6961 (set-marker e
(1- (point)))
6963 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t
)
6965 ((match-beginning 1) ; Skip
6968 (cperl-contract-level)))))))
6970 (defun cperl-beautify-level (&optional deep
)
6971 "Find an enclosing group in regexp and beautify it.
6972 \(Experimental, may change semantics, recheck the result.)
6973 We suppose that the regexp is scanned already."
6975 (setq deep
(if deep
(prefix-numeric-value deep
) -
1))
6977 (cperl-regext-to-level-start)
6978 (let ((b (point)) (e (make-marker)))
6980 (set-marker e
(1- (point)))
6981 (cperl-beautify-regexp-piece b e nil deep
))))
6983 (defun cperl-invert-if-unless ()
6984 "Change `if (A) {B}' into `B if A;' etc if possible."
6986 (or (looking-at "\\<")
6988 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
6989 (let ((pos1 (point))
6990 pos2 pos3 pos4 pos5 s1 s2 state p pos45
6991 (s0 (buffer-substring (match-beginning 0) (match-end 0))))
6996 (if (eq (following-char) ?\
( )
7003 ;; XXXX In fact may be `A if (B); {C}' ...
7004 (if (and (eq (following-char) ?\
{ )
7006 (cperl-backward-to-noncomment pos3
)
7007 (eq (preceding-char) ?\
) )))
7008 (if (condition-case nil
7013 (looking-at "\\<els\\(e\\|if\\)\\>"))
7016 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" s0
)
7017 (goto-char (1- pos5
))
7018 (cperl-backward-to-noncomment pos4
)
7019 (if (eq (preceding-char) ?\
;)
7021 (setq pos45
(point))
7023 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t
)
7024 (setq p
(match-beginning 0)
7025 s1
(buffer-substring p
(match-end 0))
7026 state
(parse-partial-sexp pos4 p
))
7030 (error "`%s' inside `%s' BLOCK" s1 s0
))
7031 (goto-char (match-end 0)))
7033 (goto-char (1+ pos4
))
7034 (skip-chars-forward " \t\n")
7035 (setq s2
(buffer-substring (point) pos45
))
7037 (or (looking-at ";?[ \t\n]*}")
7039 (skip-chars-forward "; \t\n")
7040 (setq s2
(concat s2
"\n" (buffer-substring (point) (1- pos5
))))))
7043 (goto-char (1- pos3
))
7044 (cperl-backward-to-noncomment pos2
)
7045 (or (looking-at "[ \t\n]*)")
7046 (goto-char (1- pos3
)))
7048 (goto-char (1+ pos2
))
7049 (skip-chars-forward " \t\n")
7050 (setq s1
(buffer-substring (point) p
))
7051 (delete-region pos4 pos5
)
7052 (delete-region pos2 pos3
)
7059 (delete-horizontal-space)
7061 (delete-horizontal-space)
7064 (cperl-indent-line))
7065 (error "`%s' (EXPR) not with an {BLOCK}" s0
)))
7066 (error "`%s' not with an (EXPR)" s0
)))
7067 (error "Not at `if', `unless', `while', `until', `for' or `foreach'")))
7069 ;;; By Anthony Foiani <afoiani@uswest.com>
7070 ;;; Getting help on modules in C-h f ?
7071 ;;; This is a modified version of `man'.
7072 ;;; Need to teach it how to lookup functions
7073 (defun cperl-perldoc (word)
7074 "Run `perldoc' on WORD."
7076 (list (let* ((default-entry (cperl-word-at-point))
7078 (format "perldoc entry%s: "
7079 (if (string= default-entry
"")
7081 (format " (default %s)" default-entry
))))))
7082 (if (string= input
"")
7083 (if (string= default-entry
"")
7084 (error "No perldoc args given")
7088 (let* ((case-fold-search nil
)
7090 (string-match "^[a-z]+$" word
)
7091 (string-match (concat "^" word
"\\>")
7092 (documentation-property
7094 'variable-documentation
))))
7095 (manual-program (if is-func
"perldoc -f" "perldoc")))
7098 (let ((Manual-program "perldoc")
7099 (Manual-switches (if is-func
(list "-f"))))
7100 (manual-entry word
)))
7102 (Man-getpage-in-background word
)))))
7104 (defun cperl-perldoc-at-point ()
7105 "Run a `perldoc' on the word around point."
7107 (cperl-perldoc (cperl-word-at-point)))
7109 (defcustom pod2man-program
"pod2man"
7110 "*File name for `pod2man'."
7114 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
7115 (defun cperl-pod-to-manpage ()
7116 "Create a virtual manpage in Emacs from the Perl Online Documentation."
7119 (let* ((pod2man-args (concat buffer-file-name
" | nroff -man "))
7120 (bufname (concat "Man " buffer-file-name
))
7121 (buffer (generate-new-buffer bufname
)))
7124 (let ((process-environment (copy-sequence process-environment
)))
7125 ;; Prevent any attempt to use display terminal fanciness.
7126 (setenv "TERM" "dumb")
7127 (set-process-sentinel
7128 (start-process pod2man-program buffer
"sh" "-c"
7129 (format (cperl-pod2man-build-command) pod2man-args
))
7130 'Man-bgproc-sentinel
)))))
7132 ;;; Updated version by him too
7133 (defun cperl-build-manpage ()
7134 "Create a virtual manpage in Emacs from the POD in the file."
7139 (let ((Manual-program "perldoc"))
7140 (manual-entry buffer-file-name
)))
7142 (let* ((manual-program "perldoc"))
7143 (Man-getpage-in-background buffer-file-name
)))))
7145 (defun cperl-pod2man-build-command ()
7146 "Builds the entire background manpage and cleaning command."
7147 (let ((command (concat pod2man-program
" %s 2>/dev/null"))
7148 (flist Man-filter-list
))
7149 (while (and flist
(car flist
))
7150 (let ((pcom (car (car flist
)))
7151 (pargs (cdr (car flist
))))
7153 (concat command
" | " pcom
" "
7154 (mapconcat '(lambda (phrase)
7155 (if (not (stringp phrase
))
7156 (error "Malformed Man-filter-list"))
7159 (setq flist
(cdr flist
))))
7162 (defun cperl-lazy-install ()) ; Avoid a warning
7163 (defun cperl-lazy-unstall ()) ; Avoid a warning
7165 (if (fboundp 'run-with-idle-timer
)
7167 (defvar cperl-help-shown nil
7168 "Non-nil means that the help was already shown now.")
7170 (defvar cperl-lazy-installed nil
7171 "Non-nil means that the lazy-help handlers are installed now.")
7173 (defun cperl-lazy-install ()
7174 "Switches on Auto-Help on Perl constructs (put in the message area).
7175 Delay of auto-help controlled by `cperl-lazy-help-time'."
7177 (make-variable-buffer-local 'cperl-help-shown
)
7178 (if (and (cperl-val 'cperl-lazy-help-time
)
7179 (not cperl-lazy-installed
))
7181 (add-hook 'post-command-hook
'cperl-lazy-hook
)
7182 (run-with-idle-timer
7183 (cperl-val 'cperl-lazy-help-time
1000000 5)
7185 'cperl-get-help-defer
)
7186 (setq cperl-lazy-installed t
))))
7188 (defun cperl-lazy-unstall ()
7189 "Switches off Auto-Help on Perl constructs (put in the message area).
7190 Delay of auto-help controlled by `cperl-lazy-help-time'."
7192 (remove-hook 'post-command-hook
'cperl-lazy-hook
)
7193 (cancel-function-timers 'cperl-get-help-defer
)
7194 (setq cperl-lazy-installed nil
))
7196 (defun cperl-lazy-hook ()
7197 (setq cperl-help-shown nil
))
7199 (defun cperl-get-help-defer ()
7200 (if (not (memq major-mode
'(perl-mode cperl-mode
))) nil
7201 (let ((cperl-message-on-help-error nil
) (cperl-help-from-timer t
))
7203 (setq cperl-help-shown t
))))
7204 (cperl-lazy-install)))
7207 ;;; Plug for wrong font-lock:
7209 (defun cperl-font-lock-unfontify-region-function (beg end
)
7210 (let* ((modified (buffer-modified-p)) (buffer-undo-list t
)
7211 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
7212 before-change-functions after-change-functions
7213 deactivate-mark buffer-file-name buffer-file-truename
)
7214 (remove-text-properties beg end
'(face nil
))
7215 (when (and (not modified
) (buffer-modified-p))
7216 (set-buffer-modified-p nil
))))
7218 (defvar cperl-d-l nil
)
7219 (defun cperl-fontify-syntaxically (end)
7220 ;; Some vars for debugging only
7221 ;; (message "Syntaxifying...")
7222 (let ((dbg (point)) (iend end
)
7223 (istate (car cperl-syntax-state
))
7225 (and cperl-syntaxify-unwind
7226 (setq end
(cperl-unwind-to-safe t end
)))
7227 (setq start
(point))
7228 (or cperl-syntax-done-to
7229 (setq cperl-syntax-done-to
(point-min)))
7230 (if (or (not (boundp 'font-lock-hot-pass
))
7231 (eval 'font-lock-hot-pass
)
7232 t
) ; Not debugged otherwise
7233 ;; Need to forget what is after `start'
7234 (setq start
(min cperl-syntax-done-to start
))
7235 ;; Fontification without a change
7236 (setq start
(max cperl-syntax-done-to start
)))
7238 (setq cperl-syntax-done-to start
) ; In case what follows fails
7239 (cperl-find-pods-heres start end t nil t
))
7240 (if (eq cperl-syntaxify-by-font-lock
'message
)
7241 (message "Syntaxified %s..%s from %s to %s(%s), state %s-->%s"
7243 start end cperl-syntax-done-to
7244 istate
(car cperl-syntax-state
))) ; For debugging
7245 nil
)) ; Do not iterate
7247 (defun cperl-fontify-update (end)
7248 (let ((pos (point)) prop posend
)
7250 (setq prop
(get-text-property pos
'cperl-postpone
))
7251 (setq posend
(next-single-property-change pos
'cperl-postpone nil end
))
7252 (and prop
(put-text-property pos posend
(car prop
) (cdr prop
)))
7254 nil
) ; Do not iterate
7256 (defun cperl-update-syntaxification (from to
)
7257 (if (and cperl-use-syntax-table-text-property
7258 cperl-syntaxify-by-font-lock
7259 (or (null cperl-syntax-done-to
)
7260 (< cperl-syntax-done-to to
)))
7264 (cperl-fontify-syntaxically to
)))))
7266 (defvar cperl-version
7267 (let ((v "Revision: 5.0"))
7268 (string-match ":\\s *\\([0-9.]+\\)" v
)
7269 (substring v
(match-beginning 1) (match-end 1)))
7270 "Version of IZ-supported CPerl package this file is based on.")
7272 (provide 'cperl-mode
)
7274 ;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
7275 ;;; cperl-mode.el ends here