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,
5 ;; Free Software Foundation, Inc.
7 ;; Author: Ilya Zakharevich and Bob Olson
8 ;; Maintainer: Ilya Zakharevich <cperl@ilyaz.org>
9 ;; Keywords: languages, Perl
11 ;; This file is part of GNU Emacs.
13 ;;; This code started from the following message of long time ago
14 ;;; (IZ), but Bob does not maintain this mode any more:
16 ;;; From: olson@mcs.anl.gov (Bob Olson)
17 ;;; Newsgroups: comp.lang.perl
18 ;;; Subject: cperl-mode: Another perl mode for Gnuemacs
19 ;;; Date: 14 Aug 91 15:20:01 GMT
21 ;; Copyright (C) Ilya Zakharevich and Bob Olson
23 ;; This file may be distributed
24 ;; either under the same terms as GNU Emacs, or under the same terms
25 ;; as Perl. You should have received a copy of Perl Artistic license
26 ;; along with the Perl distribution.
28 ;; GNU Emacs is free software; you can redistribute it and/or modify
29 ;; it under the terms of the GNU General Public License as published by
30 ;; the Free Software Foundation; either version 2, or (at your option)
33 ;; GNU Emacs is distributed in the hope that it will be useful,
34 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
35 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36 ;; GNU General Public License for more details.
38 ;; You should have received a copy of the GNU General Public License
39 ;; along with GNU Emacs; see the file COPYING. If not, write to the
40 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
41 ;; Boston, MA 02111-1307, USA.
43 ;;; Corrections made by Ilya Zakharevich cperl@ilyaz.org
44 ;;; XEmacs changes by Peter Arius arius@informatik.uni-erlangen.de
48 ;; $Id: cperl-mode.el,v 5.16 2006/02/21 11:18:21 vera Exp vera $
50 ;;; If your Emacs does not default to `cperl-mode' on Perl files:
51 ;;; To use this mode put the following into
54 ;; (autoload 'perl-mode "cperl-mode" "alternate mode for editing Perl programs" t)
56 ;; You can either fine-tune the bells and whistles of this mode or
57 ;; bulk enable them by putting
59 ;; (setq cperl-hairy t)
61 ;; in your .emacs file. (Emacs rulers do not consider it politically
62 ;; correct to make whistles enabled by default.)
64 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
65 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
66 ;; `cperl-non-problems', `cperl-praise', `cperl-speed'. <<<<<<
68 ;; Additional useful commands to put into your .emacs file (before
71 ;; (setq auto-mode-alist
72 ;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
73 ;; (setq interpreter-mode-alist (append interpreter-mode-alist
74 ;; '(("miniperl" . perl-mode))))
76 ;; The mode information (on C-h m) provides some customization help.
77 ;; If you use font-lock feature of this mode, it is advisable to use
78 ;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
80 ;; Faces used now: three faces for first-class and second-class keywords
81 ;; and control flow words, one for each: comments, string, labels,
82 ;; functions definitions and packages, arrays, hashes, and variable
83 ;; definitions. If you do not see all these faces, your font-lock does
84 ;; not define them, so you need to define them manually.
85 ;; Maybe you have an obsolete font-lock from 19.28 or earlier. Upgrade.
87 ;; If you have a grayscale monitor, and do not have the variable
88 ;; font-lock-display-type bound to 'grayscale, insert
90 ;; (setq font-lock-display-type 'grayscale)
92 ;; into your .emacs file (this is relevant before RMS Emacs 20).
94 ;; This mode supports font-lock, imenu and mode-compile. In the
95 ;; hairy version font-lock is on, but you should activate imenu
96 ;; yourself (note that mode-compile is not standard yet). Well, you
97 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
98 ;; to bind it like that:
100 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
102 ;;; Font lock bugs as of v4.32:
104 ;; The following kinds of Perl code erroneously start strings:
106 ;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
107 ;; likewise with m, tr, y, q, qX instead of s
109 ;;; In fact the version of font-lock that this version supports can be
110 ;;; much newer than the version you actually have. This means that a
111 ;;; lot of faces can be set up, but are not visible on your screen
112 ;;; since the coloring rules for this faces are not defined.
114 ;;; Updates: ========================================
116 ;;; Made less hairy by default: parentheses not electric,
117 ;;; linefeed not magic. Bug with abbrev-mode corrected.
120 ;;; Better indentation:
121 ;;; subs inside braces should work now,
122 ;;; Toplevel braces obey customization.
123 ;;; indent-for-comment knows about bad cases, cperl-indent-for-comment
124 ;;; moves cursor to a correct place.
125 ;;; cperl-indent-exp written from the scratch! Slow... (quadratic!) :-(
126 ;;; (50 secs on DB::DB (sub of 430 lines), 486/66)
127 ;;; Minor documentation fixes.
128 ;;; Imenu understands packages as prefixes (including nested).
129 ;;; Hairy options can be switched off one-by-one by setting to null.
130 ;;; Names of functions and variables changed to conform to `cperl-' style.
133 ;;; Some bugs with indentation of labels (and embedded subs) corrected.
134 ;;; `cperl-indent-region' done (slow :-()).
135 ;;; `cperl-fill-paragraph' done.
136 ;;; Better package support for `imenu'.
137 ;;; Progress indicator for indentation (with `imenu' loaded).
138 ;;; `Cperl-set' was busted, now setting the individual hairy option
139 ;;; should be better.
142 ;;; `cperl-set-style' done.
143 ;;; `cperl-check-syntax' done.
145 ;;; New config variables `cperl-close-paren-offset' and `cperl-comment-column'.
146 ;;; Bugs with `cperl-auto-newline' corrected.
147 ;;; `cperl-electric-lbrace' can work with `cperl-auto-newline' in situation
150 ;;;; 1.7 XEmacs (arius@informatik.uni-erlangen.de):
151 ;;; - use `next-command-event', if `next-command-events' does not exist
152 ;;; - use `find-face' as def. of `is-face'
153 ;;; - corrected def. of `x-color-defined-p'
154 ;;; - added const defs for font-lock-comment-face,
155 ;;; font-lock-keyword-face and font-lock-function-name-face
156 ;;; - added def. of font-lock-variable-name-face
157 ;;; - added (require 'easymenu) inside an `eval-when-compile'
158 ;;; - replaced 4-argument `substitute-key-definition' with ordinary
160 ;;; - replaced `mark-active' in menu definition by `cperl-use-region-p'.
162 ;;; - use emacs-vers.el (http://www.cs.utah.edu/~eeide/emacs/emacs-vers.el.gz)
163 ;;; for portable code?
164 ;;; - should `cperl-mode' do a
165 ;;; (if (featurep 'easymenu) (easy-menu-add cperl-menu))
166 ;;; or should this be left to the user's `cperl-mode-hook'?
168 ;;; Some bugs introduced by the above fix corrected (IZ ;-).
169 ;;; Some bugs under XEmacs introduced by the correction corrected.
171 ;;; Some more can remain since there are two many different variants.
174 ;;; We do not support fontification of arrays and hashes under
175 ;;; obsolete font-lock any more. Upgrade.
177 ;;;; after 1.8 Minor bug with parentheses.
178 ;;;; after 1.9 Improvements from Joe Marzot.
180 ;;; Does not need easymenu to compile under XEmacs.
181 ;;; `vc-insert-headers' should work better.
182 ;;; Should work with 19.29 and 19.12.
183 ;;; Small improvements to fontification.
184 ;;; Expansion of keywords does not depend on C-? being backspace.
187 ;;; 19.29 and 19.12 supported.
188 ;;; `cperl-font-lock-enhanced' deprecated. Use font-lock-extra.el.
189 ;;; Support for font-lock-extra.el.
193 ;;; Support for perl5-info.
194 ;;; `imenu-go-find-at-position' in Tools requires imenu-go.el (see hints above)
195 ;;; Imenu entries do not work with stock imenu.el. Patch sent to maintainers.
196 ;;; Fontifies `require a if b;', __DATA__.
197 ;;; Arglist for auto-fill-mode was incorrect.
200 ;;; `cperl-lineup-step' and `cperl-lineup' added: lineup constructions
202 ;;; `cperl-do-auto-fill' updated for 19.29 style.
203 ;;; `cperl-info-on-command' now has a default.
204 ;;; Workaround for broken C-h on XEmacs.
205 ;;; VC strings escaped.
206 ;;; C-h f now may prompt for function name instead of going on,
207 ;;; controlled by `cperl-info-on-command-no-prompt'.
210 ;;; Msb buffer list includes perl files
211 ;;; Indent-for-comment uses indent-to
212 ;;; Can write tag files using etags.
215 ;;; Recognizes (tries to ;-) {...} which are not blocks during indentation.
216 ;;; `cperl-close-paren-offset' affects ?\] too (and ?\} if not block)
217 ;;; Bug with auto-filling comments started with "##" corrected.
219 ;;;; Very slow now: on DB::DB 0.91, 486/66:
221 ;;;Function Name Call Count Elapsed Time Average Time
222 ;;;======================================== ========== ============ ============
223 ;;;cperl-block-p 469 3.7799999999 0.0080597014
224 ;;;cperl-get-state 505 163.39000000 0.3235445544
225 ;;;cperl-comment-indent 12 0.0299999999 0.0024999999
226 ;;;cperl-backward-to-noncomment 939 4.4599999999 0.0047497337
227 ;;;cperl-calculate-indent 505 172.22000000 0.3410297029
228 ;;;cperl-indent-line 505 172.88000000 0.3423366336
229 ;;;cperl-use-region-p 40 0.0299999999 0.0007499999
230 ;;;cperl-indent-exp 1 177.97000000 177.97000000
231 ;;;cperl-to-comment-or-eol 1453 3.9800000000 0.0027391603
232 ;;;cperl-backward-to-start-of-continued-exp 9 0.0300000000 0.0033333333
233 ;;;cperl-indent-region 1 177.94000000 177.94000000
236 ;;; Takes into account white space after opening parentheses during indent.
237 ;;; May highlight pods and here-documents: see `cperl-pod-here-scan',
238 ;;; `cperl-pod-here-fontify', `cperl-pod-face'. Does not use this info
239 ;;; for indentation so far.
240 ;;; Fontification updated to 19.30 style.
241 ;;; The change 19.29->30 did not add all the required functionality,
242 ;;; but broke "font-lock-extra.el". Get "choose-color.el" from
243 ;;; http://ilyaz.org/software/emacs
247 ;;; recognized as a start of a block.
248 ;;; Two different font-lock-levels provided.
249 ;;; `cperl-pod-head-face' introduced. Used for highlighting.
250 ;;; `imenu' marks pods, +Packages moved to the head.
253 ;;; Scan for pods highlights here-docs too.
254 ;;; Note that the tag of here-doc may be rehighlighted later by lazy-lock.
255 ;;; Only one here-doc-tag per line is supported, and one in comment
256 ;;; or a string may break fontification.
257 ;;; POD headers were supposed to fill one line only.
260 ;;; `font-lock-keywords' were set in 19.30 style _always_. Current scheme
261 ;;; may break under XEmacs.
262 ;;; `cperl-calculate-indent' dis suppose that `parse-start' was defined.
263 ;;; `fontified' tag is added to fontified text as well as `lazy-lock' (for
264 ;;; compatibility with older lazy-lock.el) (older one overfontifies
265 ;;; something nevertheless :-().
266 ;;; Will not indent something inside pod and here-documents.
267 ;;; Fontifies the package name after import/no/bootstrap.
268 ;;; Added new entry to menu with meta-info about the mode.
271 ;;; Prefontification works much better with 19.29. Should be checked
272 ;;; with 19.30 as well.
273 ;;; Some misprints in docs corrected.
274 ;;; Now $a{-text} and -text => "blah" are fontified as strings too.
275 ;;; Now the pod search is much stricter, so it can help you to find
276 ;;; pod sections which are broken because of whitespace before =blah
277 ;;; - just observe the fontification.
280 ;;; Anonymous subs are indented with respect to the level of
281 ;;; indentation of `sub' now.
282 ;;; {} is recognized as hash after `bless' and `return'.
283 ;;; Anonymous subs are split by `cperl-linefeed' as well.
284 ;;; Electric parens embrace a region if present.
285 ;;; To make `cperl-auto-newline' useful,
286 ;;; `cperl-auto-newline-after-colon' is introduced.
287 ;;; `cperl-electric-parens' is now t or nul. The old meaning is moved to
288 ;;; `cperl-electric-parens-string'.
289 ;;; `cperl-toggle-auto-newline' introduced, put on C-c C-a.
290 ;;; `cperl-toggle-abbrev' introduced, put on C-c C-k.
291 ;;; `cperl-toggle-electric' introduced, put on C-c C-e.
292 ;;; Beginning-of-defun-regexp was not anchored.
295 ;;; Auto-newline grants `cperl-extra-newline-before-brace' if "{" is typed
297 ;;; {} is recognized as expression after `tr' and friends.
300 ;;; Entry Hierarchy added to imenu. Very primitive so far.
301 ;;; One needs newer `imenu-go'.el. A patch to `imenu' is needed as well.
302 ;;; Writes its own TAGS files.
303 ;;; Class viewer based on TAGS files. Does not trace @ISA so far.
304 ;;; 19.31: Problems with scan for PODs corrected.
305 ;;; First POD header correctly fontified.
306 ;;; I needed (setq imenu-use-keymap-menu t) to get good imenu in 19.31.
307 ;;; Apparently it makes a lot of hierarchy code obsolete...
310 ;;; Tags filler now scans *.xs as well.
311 ;;; The info from *.xs scan is used by the hierarchy viewer.
312 ;;; Hierarchy viewer documented.
313 ;;; Bug in 19.31 imenu documented.
316 ;;; New location for info-files mentioned,
317 ;;; Electric-; should work better.
318 ;;; Minor bugs with POD marking.
320 ;;;; After 1.25 (probably not...)
321 ;;; `cperl-info-page' introduced.
322 ;;; To make `uncomment-region' working, `comment-region' would
323 ;;; not insert extra space.
324 ;;; Here documents delimiters better recognized
325 ;;; (empty one, and non-alphanums in quotes handled). May be wrong with 1<<14?
326 ;;; `cperl-db' added, used in menu.
327 ;;; imenu scan removes text-properties, for better debugging
328 ;;; - but the bug is in 19.31 imenu.
329 ;;; formats highlighted by font-lock and prescan, embedded comments
331 ;;; POD/friends scan merged in one pass.
332 ;;; Syntax class is not used for analyzing the code, only char-syntax
333 ;;; may be checked against _ or'ed with w.
334 ;;; Syntax class of `:' changed to be _.
335 ;;; `cperl-find-bad-style' added.
338 ;;; When search for here-documents, we ignore commented << in simplest cases.
339 ;;; `cperl-get-help' added, available on C-h v and from menu.
340 ;;; Auto-help added. Default with `cperl-hairy', switchable on/off
341 ;;; with startup variable `cperl-lazy-help-time' and from
342 ;;; menu. Requires `run-with-idle-timer'.
343 ;;; Highlighting of @abc{@efg} was wrong - interchanged two regexps.
346 ;;; Indentation: At toplevel after a label - fixed.
347 ;;; 1.27 was put to archives in binary mode ===> DOSish :-(
350 ;;; Thanks to Martin Buchholz <mrb@Eng.Sun.COM>: misprints in
351 ;;; comments and docstrings corrected, XEmacs support cleaned up.
352 ;;; The closing parenths would enclose the region into matching
353 ;;; parens under the same conditions as the opening ones.
354 ;;; Minor updates to `cperl-short-docs'.
355 ;;; Will not consider <<= as start of here-doc.
358 ;;; Added an extra advice to look into Micro-docs. ;-).
359 ;;; Enclosing of region when you press a closing parenth is regulated by
360 ;;; `cperl-electric-parens-string'.
361 ;;; Minor updates to `cperl-short-docs'.
362 ;;; `initialize-new-tags-table' called only if present (Does this help
363 ;;; with generation of tags under XEmacs?).
364 ;;; When creating/updating tag files, new info is written at the old place,
365 ;;; or at the end (is this a wanted behaviour? I need this in perl build directory).
368 ;;; All the keywords from keywords.pl included (maybe with dummy explanation).
369 ;;; No auto-help inside strings, comment, here-docs, formats, and pods.
370 ;;; Shrinkwrapping of info, regulated by `cperl-max-help-size',
371 ;;; `cperl-shrink-wrap-info-frame'.
372 ;;; Info on variables as well.
373 ;;; Recognision of HERE-DOCS improved yet more.
374 ;;; Autonewline works on `}' without warnings.
375 ;;; Autohelp works again on $_[0].
378 ;;; perl-descr.el found its author - hi, Johan!
379 ;;; Some support for correct indent after here-docs and friends (may
380 ;;; be superseeded by eminent change to Emacs internals).
381 ;;; Should work with older Emaxen as well ( `-style stuff removed).
385 ;;; Started to add support for `syntax-table' property (should work
386 ;;; with patched Emaxen), controlled by
387 ;;; `cperl-use-syntax-table-text-property'. Currently recognized:
388 ;;; All quote-like operators: m, s, y, tr, qq, qw, qx, q,
389 ;;; // in most frequent context:
391 ;;; ~ { ( = | & + - * ! , ;
393 ;;; while if unless until and or not xor split grep map
394 ;;; Here-documents, formats, PODs,
397 ;;; sub a ($); sub a ($) {}
398 ;;; (provide 'cperl-mode) was missing!
399 ;;; `cperl-after-expr-p' is now much smarter after `}'.
400 ;;; `cperl-praise' added to mini-docs.
401 ;;; Utilities try to support subs-with-prototypes.
404 ;;; `cperl-after-expr-p' is now much smarter after "() {}" and "word {}":
405 ;;; if word is "else, map, grep".
406 ;;; Updated for new values of syntax-table constants.
407 ;;; Uses `help-char' (at last!) (disabled, does not work?!)
408 ;;; A couple of regexps where missing _ in character classes.
409 ;;; -s could be considered as start of regexp, 1../blah/ was not,
410 ;;; as was not /blah/ at start of file.
413 ;;; "\C-hv" was wrongly "\C-hf"
414 ;;; C-hv was not working on `[index()]' because of [] in skip-chars-*.
415 ;;; `__PACKAGE__' supported.
416 ;;; Thanks for Greg Badros: `cperl-lazy-unstall' is more complete,
417 ;;; `cperl-get-help' is made compatible with `query-replace'.
419 ;;;; As of Apr 15, development version of 19.34 supports
420 ;;;; `syntax-table' text properties. Try setting
421 ;;;; `cperl-use-syntax-table-text-property'.
424 ;;; We scan for s{}[] as well (in simplest situations).
425 ;;; We scan for $blah'foo as well.
426 ;;; The default is to use `syntax-table' text property if Emacs is good enough.
427 ;;; `cperl-lineup' is put on C-M-| (=C-M-S-\\).
428 ;;; Start of `cperl-beautify-regexp'.
431 ;;; `cperl-tags-hier-init' did not work in text-mode.
432 ;;; `cperl-noscan-files-regexp' had a misprint.
433 ;;; Generation of Class Hierarchy was broken due to a bug in `x-popup-menu'
437 ;;; my,local highlight vars after {} too.
438 ;;; TAGS could not be created before imenu was loaded.
439 ;;; `cperl-indent-left-aligned-comments' created.
440 ;;; Logic of `cperl-indent-exp' changed a little bit, should be more
441 ;;; robust w.r.t. multiline strings.
442 ;;; Recognition of blah'foo takes into account strings.
443 ;;; Added '.al' to the list of Perl extensions.
444 ;;; Class hierarchy is "mostly" sorted (need to rethink algorthm
445 ;;; of pruning one-root-branch subtrees to get yet better sorting.)
446 ;;; Regeneration of TAGS was busted.
447 ;;; Can use `syntax-table' property when generating TAGS
448 ;;; (governed by `cperl-use-syntax-table-text-property-for-tags').
451 ;;; Can process several =pod/=cut sections one after another.
452 ;;; Knows of `extproc' when under `emx', indents with `__END__' and `__DATA__'.
453 ;;; `cperl-under-as-char' implemented (XEmacs people like broken behaviour).
454 ;;; Beautifier for regexps fixed.
455 ;;; `cperl-beautify-level', `cperl-contract-level' coded
457 ;;;; Emacs's 20.2 problems:
458 ;;; `imenu.el' has bugs, `imenu-add-to-menubar' does not work.
459 ;;; Couple of others problems with 20.2 were reported, my ability to check/fix
460 ;;; them is very reduced now.
463 ;;; 'C-M-|' in XEmacs fixed
466 ;;; &&s was not recognized as start of regular expression;
467 ;;; Will "preprocess" the contents of //e part of s///e too;
468 ;;; What to do with s# blah # foo #e ?
469 ;;; Should handle s;blah;foo;; better.
470 ;;; Now the only known problems with regular expression recognition:
471 ;;;;;;; s<foo>/bar/ - different delimiters (end ignored)
472 ;;;;;;; s/foo/\\bar/ - backslash at start of subst (made into one chunk)
473 ;;;;;;; s/foo// - empty subst (made into one chunk + '/')
474 ;;;;;;; s/foo/(bar)/ - start-group at start of subst (internal group will not match backwards)
477 ;;; We highlight closing / of s/blah/foo/e;
478 ;;; This handles s# blah # foo #e too;
479 ;;; s//blah/, s///, s/blah// works again, and s#blah## too, the algorithm
480 ;;; is much simpler now;
481 ;;; Next round of changes: s\\\ works, s<blah>/foo/,
482 ;;; comments between the first and the second part allowed
483 ;;; Another problem discovered:
484 ;;;;;;; s[foo] <blah>e - e part delimited by different <> (will not match)
485 ;;; `cperl-find-pods-heres' somehow maybe called when string-face is undefined
486 ;;; - put a stupid workaround for 20.1
489 ;;; Could indent here-docs for comments;
490 ;;; These problems fixed:
491 ;;;;;;; s/foo/\\bar/ - backslash at start of subst (made into two chunk)
492 ;;;;;;; s[foo] <blah>e - "e" part delimited by "different" <> (will match)
493 ;;; Matching brackets honor prefices, may expand abbreviations;
494 ;;; When expanding abbrevs, will remove last char only after
495 ;;; self-inserted whitespace;
496 ;;; More convenient "Refress hard constructs" in menu;
497 ;;; `cperl-add-tags-recurse', `cperl-add-tags-recurse-noxs'
498 ;;; added (for -batch mode);
499 ;;; Better handling of errors when scanning for Perl constructs;
500 ;;;;;;; Possible "problem" with class hierarchy in Perl distribution
501 ;;;;;;; directory: ./ext duplicates ./lib;
502 ;;; Write relative paths for generated TAGS;
505 ;;; s /// may be separated by "\n\f" too;
506 ;;; `s #blah' recognized as a comment;
507 ;;; Would highlight s/abc//s wrong;
508 ;;; Debugging code in `cperl-electric-keywords' was leaking a message;
511 ;;; RMS changes for 20.3 merged
513 ;;;; 2.0.1.0: RMS mode (has 3 misprints)
516 ;;; RMS whitespace changes for 20.3 merged
522 ;;; Merge `c-style-alist' since `c-mode' is no more. (Somebody who
523 ;;; uses the styles should check that they work OK!)
524 ;;; All the variable warnings go away, some undef functions too.
527 ;;; Added `cperl-perldoc' (thanks to Anthony Foiani <afoiani@uswest.com>)
528 ;;; Added `cperl-pod-to-manpage' (thanks to Nick Roberts <Nick.Roberts@src.bae.co.uk>)
529 ;;; All the function warnings go away.
532 ;;; `Perl doc', `Regexp' submenus created (latter to allow short displays).
533 ;;; `cperl-clobber-lisp-bindings' added.
534 ;;; $a->y() is not y///.
535 ;;; `cperl-after-block-p' was missing a `save-excursion' => wrong results.
536 ;;; `cperl-val' was defined too late.
537 ;;; `cperl-init-faces' was failing.
538 ;;; Init faces when loading `ps-print'.
541 ;;; `cperl-toggle-autohelp' implemented.
542 ;;; `while SPACE LESS' was buggy.
543 ;;; `-text' in `[-text => 1]' was not highlighted.
544 ;;; `cperl-after-block-p' was FALSE after `sub f {}'.
547 ;;; `foreachmy', `formy' expanded too.
548 ;;; Expand `=pod-directive'.
549 ;;; `cperl-linefeed' behaves reasonable in POD-directive lines.
550 ;;; `cperl-electric-keyword' prints a message, governed by
551 ;;; `cperl-message-electric-keyword'.
554 ;;; Typing `}' was not checking for being block or not.
555 ;;; Beautifying levels in RE: Did not know about lookbehind;
556 ;;; finding *which* level was not intuitive;
557 ;;; `cperl-beautify-levels' added.
558 ;;; Allow here-docs contain `=head1' and friends (at least for keywords).
561 ;;; Fix for broken `font-lock-unfontify-region-function'. Should
562 ;;; preserve `syntax-table' properties even with `lazy-lock'.
565 ;;; Some more compile time warnings crept in.
566 ;;; `cperl-indent-region-fix-else' implemented.
567 ;;; `cperl-fix-line-spacing' implemented.
568 ;;; `cperl-invert-if-unless' implemented (C-c C-t and in Menu).
569 ;;; Upgraded hints to mention 20.2's goods/bads.
570 ;;; Started to use `cperl-extra-newline-before-brace-multiline',
571 ;;; `cperl-break-one-line-blocks-when-indent',
572 ;;; `cperl-fix-hanging-brace-when-indent', `cperl-merge-trailing-else'.
575 ;;; Workaround for another `font-lock's `syntax-table' text-property bug.
576 ;;; `zerop' could be applied to nil.
577 ;;; At last, may work with `font-lock' without setting `cperl-font-lock'.
578 ;;; (We expect that starting from 19.33, `font-lock' supports keywords
579 ;;; being a function - what is a correct version?)
580 ;;; Rename `cperl-indent-region-fix-else' to
581 ;;; `cperl-indent-region-fix-constructs'.
582 ;;; `cperl-fix-line-spacing' could be triggered inside strings, would not
583 ;;; know what to do with BLOCKs of map/printf/etc.
584 ;;; `cperl-merge-trailing-else' and `cperl-fix-line-spacing' handle
586 ;;; Indentation after {BLOCK} knows about map/printf/etc.
587 ;;; Finally: treat after-comma lines as continuation lines.
590 ;;; `continue' made electric.
591 ;;; Electric `do' inserts `do/while'.
592 ;;; Some extra compile-time warnings crept in.
593 ;;; `font-lock' of 19.33 could not handle font-lock-keywords being a function
594 ;;; returning a symbol.
597 ;;; Changes to make syntaxification to be autoredone via `font-lock'.
598 ;;; Switched on by `cperl-syntaxify-by-font-lock', off by default so far.
601 ;;; Remove some commented out chunks.
602 ;;; Styles are slightly updated (a lot of work is needed, especially
603 ;;; with new `cperl-fix-line-spacing').
606 ;;; Old value of style is memorized when choosing a new style, may be
607 ;;; restored from the same menu.
608 ;;; Mode-documentation added to micro-docs.
609 ;;; `cperl-praise' updated.
610 ;;; `cperl-toggle-construct-fix' added on C-c C-w and menu.
611 ;;; `auto-fill-mode' added on C-c C-f and menu.
612 ;;; `PerlStyle' style added.
613 ;;; Message for termination of scan corrected.
617 ;;; Did not work with -q
621 ;;; `cperl-speed' hints added.
622 ;;; Minor style fixes.
625 ;;; Make backspace electric after expansion of `else/continue' too.
628 ;;; Starting to merge changes to RMS emacs version.
631 ;;; Merged custom stuff and darn `font-lock-constant-face'.
634 ;;; Bumped the version to 3.1
637 ;;; Fixed customization to honor cperl-hairy.
638 ;;; Created customization groups. Sent to RMS to include into 2.3.
641 ;;; Interaction of `font-lock-hot-pass' and `cperl-syntaxify-by-font-lock'.
642 ;;; (`cperl-after-block-and-statement-beg'):
643 ;;; (`cperl-after-block-p'):
644 ;;; (`cperl-after-expr-p'): It is BLOCK if we reach lim when backup sexp.
645 ;;; (`cperl-indent-region'): Make a marker for END - text added/removed.
646 ;;; (`cperl-style-alist', `cperl-styles-entries')
647 ;;; Include `cperl-merge-trailing-else' where the value is clear.
651 ;;; (`cperl-problems'): Improvements to docs.
654 ;;; (`cperl-mode'): Make lazy syntaxification possible.
655 ;;; (`cperl-find-pods-heres'): Safe a position in buffer where it is safe to
656 ;;; restart syntaxification.
657 ;;; (`cperl-syntaxify-by-font-lock'): Set to t, should be safe now.
660 ;;; (`cperl-syntaxify-by-font-lock'): Better default, customizes to
664 ;;; (`cperl-find-pods-heres'): changed so that -d ?foo? is a RE.
665 ;;; (`cperl-array-face'): changed name from `font-lock-emphasized-face'.
666 ;;; (`cperl-hash-face'): changed name from `font-lock-other-emphasized-face'.
667 ;;; Use `defface' to define these two extra faces.
670 ;;; Can use linear algorithm for indentation if Emacs supports it:
671 ;;; indenting DB::DB (800+ lines) improved from 69 sec to 11 sec
672 ;;; (73 vs 15 with imenu).
673 ;;; (`cperl-emacs-can-parse'): New state.
674 ;;; (`cperl-indent-line'): Corrected to use global state.
675 ;;; (`cperl-calculate-indent'): Likewise.
676 ;;; (`cperl-fix-line-spacing'): Likewise (not used yet).
679 ;;; (`cperl-choose-color'): Converted to a function (to be compilable in text-mode).
682 ;;; (`cperl-dark-background '): Disable without window-system.
685 ;;; Do `defface' only if window-system.
688 ;;; (`cperl-fix-line-spacing'): sped up to bail out early.
689 ;;; (`cperl-indent-region'): Disable hooks during the call (how to call them later?).
691 ;;; Now indents 820-line-long function in 6.5 sec (including syntaxification) the first time
692 ;;; (when buffer has few properties), 7.1 sec the second time.
694 ;;;Function Name Call Count Elapsed Time Average Time
695 ;;;========================================= ========== ============ ============
696 ;;;cperl-indent-exp 1 10.039999999 10.039999999
697 ;;;cperl-indent-region 1 10.0 10.0
698 ;;;cperl-indent-line 821 6.2100000000 0.0075639464
699 ;;;cperl-calculate-indent 821 5.0199999999 0.0061144945
700 ;;;cperl-backward-to-noncomment 2856 2.0500000000 0.0007177871
701 ;;;cperl-fontify-syntaxically 2 1.78 0.8900000000
702 ;;;cperl-find-pods-heres 2 1.78 0.8900000000
703 ;;;cperl-update-syntaxification 1 1.78 1.78
704 ;;;cperl-fix-line-spacing 769 1.4800000000 0.0019245773
705 ;;;cperl-after-block-and-statement-beg 163 1.4100000000 0.0086503067
706 ;;;cperl-block-p 775 1.1800000000 0.0015225806
707 ;;;cperl-to-comment-or-eol 3652 1.1200000000 0.0003066812
708 ;;;cperl-after-block-p 165 1.0500000000 0.0063636363
709 ;;;cperl-commentify 141 0.22 0.0015602836
710 ;;;cperl-get-state 813 0.16 0.0001968019
711 ;;;cperl-backward-to-start-of-continued-exp 26 0.12 0.0046153846
712 ;;;cperl-delay-update-hook 2107 0.0899999999 4.271...e-05
713 ;;;cperl-protect-defun-start 141 0.0700000000 0.0004964539
714 ;;;cperl-after-label 407 0.0599999999 0.0001474201
715 ;;;cperl-forward-re 139 0.0299999999 0.0002158273
716 ;;;cperl-comment-indent 26 0.0299999999 0.0011538461
717 ;;;cperl-use-region-p 8 0.0 0.0
718 ;;;cperl-lazy-hook 15 0.0 0.0
719 ;;;cperl-after-expr-p 8 0.0 0.0
720 ;;;cperl-font-lock-unfontify-region-function 1 0.0 0.0
722 ;;;Function Name Call Count Elapsed Time Average Time
723 ;;;========================================= ========== ============ ============
724 ;;;cperl-fix-line-spacing 769 1.4500000000 0.0018855656
725 ;;;cperl-indent-line 13 0.3100000000 0.0238461538
726 ;;;cperl-after-block-and-statement-beg 69 0.2700000000 0.0039130434
727 ;;;cperl-after-block-p 69 0.2099999999 0.0030434782
728 ;;;cperl-calculate-indent 13 0.1000000000 0.0076923076
729 ;;;cperl-backward-to-noncomment 177 0.0700000000 0.0003954802
730 ;;;cperl-get-state 13 0.0 0.0
731 ;;;cperl-to-comment-or-eol 179 0.0 0.0
732 ;;;cperl-get-help-defer 1 0.0 0.0
733 ;;;cperl-lazy-hook 11 0.0 0.0
734 ;;;cperl-after-expr-p 2 0.0 0.0
735 ;;;cperl-block-p 13 0.0 0.0
736 ;;;cperl-after-label 5 0.0 0.0
739 ;;; (`cperl-find-pods-heres'): do not warn on `=cut' if doing a chunk only.
742 ;;; (`cperl-mode'): load pseudo-faces on `cperl-find-pods-heres' (for 19.30).
743 ;;; (`x-color-defined-p'): was not compiling on XEmacs
744 ;;; (`cperl-find-pods-heres'): 1 << 6 was OK, but 1<<6 was considered as HERE
745 ;;; <file/glob> made into a string.
748 ;;; (`cperl-find-pods-heres'): Postpone addition of faces after syntactic step
749 ;;; Recognition of <FH> was wrong.
750 ;;; (`cperl-clobber-lisp-bindings'): if set, C-c variants are the old ones
751 ;;; (`cperl-unwind-to-safe'): New function.
752 ;;; (`cperl-fontify-syntaxically'): Use `cperl-unwind-to-safe' to start at reasonable position.
755 ;;; (`cperl-forward-re'): Highlight the trailing / in s/foo// as string.
756 ;;; Highlight the starting // in s//foo/ as function-name.
759 ;;; (`cperl-find-pods-heres'): Highlight `gem' in s///gem as a keyword.
762 ;;; (`cperl-find-pods-heres'): `qr' added
763 ;;; (`cperl-electric-keyword'): Likewise
764 ;;; (`cperl-electric-else'): Likewise
765 ;;; (`cperl-to-comment-or-eol'): Likewise
766 ;;; (`cperl-make-regexp-x'): Likewise
767 ;;; (`cperl-init-faces'): Likewise, and `lock' (as overridable?).
768 ;;; (`cperl-find-pods-heres'): Knows that split// is null-RE.
769 ;;; Highlights separators in 3-parts expressions
773 ;;; (`cperl-find-pods-heres'): <> was considered as a glob
774 ;;; (`cperl-syntaxify-unwind'): New configuration variable
775 ;;; (`cperl-fontify-m-as-s'): New configuration variable
778 ;;; (`cperl-find-pods-heres'): of the last line being `=head1' fixed.
780 ;;; Handling of a long construct is still buggy if only the part of
781 ;;; construct touches the updated region (we unwind to the start of
782 ;;; long construct, but the end may have residual properties).
784 ;;; (`cperl-unwind-to-safe'): would not go to beginning of buffer.
785 ;;; (`cperl-electric-pod'): check for after-expr was performed
786 ;;; inside of POD too.
789 ;;; (`cperl-backward-to-noncomment'): better treatment of PODs and HEREs.
791 ;;; Indent-line works good, but indent-region does not - at toplevel...
792 ;;; (`cperl-unwind-to-safe'): Signature changed.
793 ;;; (`x-color-defined-p'): was defmacro'ed with a tick. Remove another def.
794 ;;; (`cperl-clobber-mode-lists'): New configuration variable.
795 ;;; (`cperl-array-face'): One of definitions was garbled.
798 ;;; (`cperl-not-bad-style-regexp'): Updated.
799 ;;; (`cperl-make-regexp-x'): Misprint in a message.
800 ;;; (`cperl-find-pods-heres'): $a-1 ? foo : bar; was a regexp.
801 ;;; `<< (' was considered a start of POD.
802 ;;; Init: `cperl-is-face' was busted.
803 ;;; (`cperl-make-face'): New macros.
804 ;;; (`cperl-force-face'): New macros.
805 ;;; (`cperl-init-faces'): Corrected to use new macros;
806 ;;; `if' for copying `reference-face' to
807 ;;; `constant-face' was backward.
808 ;;; (`font-lock-other-type-face'): Done via `defface' too.
811 ;;; (`cperl-init-faces-weak'): use `cperl-force-face'.
812 ;;; (`cperl-after-block-p'): After END/BEGIN we are a block.
813 ;;; (`cperl-mode'): `font-lock-unfontify-region-function'
814 ;;; was set to a wrong function.
815 ;;; (`cperl-comment-indent'): Commenting __END__ was not working.
816 ;;; (`cperl-indent-for-comment'): Likewise.
817 ;;; (Indenting is still misbehaving at toplevel.)
820 ;;; (`cperl-unwind-to-safe'): Signature changed, unwinds end too.
821 ;;; (`cperl-find-pods-heres'): mark qq[]-etc sections as syntax-type=string
822 ;;; (`cperl-fontify-syntaxically'): Unwinds start and end to go out of
823 ;;; long strings (not very successful).
825 ;;; >>>> CPerl should be usable in write mode too now <<<<
827 ;;; (`cperl-syntaxify-by-font-lock'): Better default - off in text-mode.
828 ;;; (`cperl-tips'): Updated docs.
829 ;;; (`cperl-problems'): Updated docs.
832 ;;; (`cperl-calculate-indent'): Did not consider `,' as continuation mark for statements.
833 ;;; (`cperl-write-tags'): Correct for XEmacs's `visit-tags-table-buffer'.
836 ;;; (`cperl-calculate-indent'): Avoid parse-data optimization at toplevel.
837 ;;; Should indent correctly at toplevel too.
838 ;;; (`cperl-tags-hier-init'): Gross hack to pretend we work (are we?).
839 ;;; (`cperl-find-pods-heres'): Was not processing sub protos after a comment ine.
840 ;;; Was treating $a++ <= 5 as a glob.
843 ;;; (toplevel): require custom unprotected => failure on 19.28.
844 ;;; (`cperl-xemacs-p') defined when compile too
845 ;;; (`cperl-tags-hier-init'): Another try to work around XEmacs problems
846 ;;; Better progress messages.
847 ;;; (`cperl-find-tags'): Was writing line/pos in a wrong order,
848 ;;; pos off by 1 and not at beg-of-line.
849 ;;; (`cperl-etags-snarf-tag'): New macro
850 ;;; (`cperl-etags-goto-tag-location'): New macro
851 ;;; (`cperl-write-tags'): When removing old TAGS info was not
852 ;;; relativizing filename
855 ;;; (`cperl-version'): New variable. New menu entry
858 ;;; (`cperl-tips'): Updated.
859 ;;; (`cperl-non-problems'): Updated.
860 ;;; random: References to future 20.3 removed.
863 ;;; (`perl-font-lock-keywords'): Would not highlight `sub foo($$);'.
864 ;;; Docstrings: Menu was described as `CPerl' instead of `Perl'
867 ;;; (`cperl-toggle-construct-fix'): Was toggling to t instead of 1.
868 ;;; (`cperl-ps-print-init'): Associate `cperl-array-face', `cperl-hash-face'
869 ;;; remove `font-lock-emphasized-face'.
870 ;;; remove `font-lock-other-emphasized-face'.
871 ;;; remove `font-lock-reference-face'.
872 ;;; remove `font-lock-keyword-face'.
873 ;;; Use `eval-after-load'.
874 ;;; (`cperl-init-faces'): remove init `font-lock-other-emphasized-face'.
875 ;;; remove init `font-lock-emphasized-face'.
876 ;;; remove init `font-lock-keyword-face'.
877 ;;; (`cperl-tips-faces'): New variable and an entry into Mini-docs.
878 ;;; (`cperl-indent-region'): Do not indent whitespace lines
879 ;;; (`cperl-indent-exp'): Was not processing else-blocks.
880 ;;; (`cperl-calculate-indent'): Remove another parse-data optimization
881 ;;; at toplevel: would indent correctly.
882 ;;; (`cperl-get-state'): NOP line removed.
885 ;;; (`cperl-ps-print-init'): Remove not-CPerl-related faces.
886 ;;; (`cperl-ps-print'): New function and menu entry.
887 ;;; (`cperl-ps-print-face-properties'): New configuration variable.
888 ;;; (`cperl-invalid-face'): New configuration variable.
889 ;;; (`cperl-nonoverridable-face'): New face. Renamed from
890 ;;; `font-lock-other-type-face'.
891 ;;; (`perl-font-lock-keywords'): Highlight trailing whitespace
892 ;;; (`cperl-contract-levels'): Documentation corrected.
893 ;;; (`cperl-contract-level'): Likewise.
896 ;;; (`cperl-ps-print'): `ps-print-face-extension-alist' was not in old Emaxen,
897 ;;; same with `ps-extend-face-list'
898 ;;; (`cperl-ps-extend-face-list'): New macro.
901 ;;; (`cperl-init-faces'): Interpolate `cperl-invalid-face'.
902 ;;; (`cperl-forward-re'): Emit a meaningful error instead of a cryptic
903 ;;; one for uncomplete REx near end-of-buffer.
904 ;;; (`cperl-find-pods-heres'): Tolerate unfinished REx at end-of-buffer.
907 ;;; (`cperl-find-pods-heres'): `unwind-protect' was left commented.
910 ;;; (`cperl-invalid-face'): Change to ''underline.
913 ;;; (`cperl-find-pods-heres'): / and ? after : start a REx.
914 ;;; (`cperl-after-expr-p'): Skip labels when checking
915 ;;; (`cperl-calculate-indent'): Correct for labels when calculating
916 ;;; indentation of continuations.
917 ;;; Docstring updated.
920 ;;; Minor (mostly spelling) corrections from 20.3.3 merged.
923 ;;; (`cperl-tips'): Another workaround added. Sent to RMS for 20.4.
926 ;;; (`cperl-praise'): Mention linear-time indent.
927 ;;; (`cperl-find-pods-heres'): @if ? a : b was considered a REx.
930 ;;; (`cperl-after-expr-p'): Make true after __END__.
931 ;;; (`cperl-electric-pod'): "SYNOPSIS" was misspelled.
934 ;;; (`cperl-beautify-regexp-piece'): Was not allowing for *? after a class.
935 ;;; Allow for POSIX char-classes.
936 ;;; Remove trailing whitespace when
937 ;;; adding new linebreak.
938 ;;; Add a level counter to stop shallow.
939 ;;; Indents unprocessed groups rigidly.
940 ;;; (`cperl-beautify-regexp'): Add an optional count argument to go that
941 ;;; many levels deep.
942 ;;; (`cperl-beautify-level'): Likewise
943 ;;; Menu: Add new entries to Regexp menu to do one level
944 ;;; (`cperl-contract-level'): Was entering an infinite loop
945 ;;; (`cperl-find-pods-heres'): Typo (double quoting).
946 ;;; Was detecting < $file > as FH instead of glob.
947 ;;; Support for comments in RExen (except
948 ;;; for m#\#comment#x), governed by
949 ;;; `cperl-regexp-scan'.
950 ;;; (`cperl-regexp-scan'): New customization variable.
951 ;;; (`cperl-forward-re'): Improve logic of resetting syntax table.
953 ;;;; After 4.23 and: After 4.24:
954 ;;; (`cperl-contract-levels'): Restore position.
955 ;;; (`cperl-beautify-level'): Likewise.
956 ;;; (`cperl-beautify-regexp'): Likewise.
957 ;;; (`cperl-commentify'): Rudimental support for length=1 runs
958 ;;; (`cperl-find-pods-heres'): Process 1-char long REx comments too /a#/x
959 ;;; Processes REx-comments in #-delimited RExen.
960 ;;; MAJOR BUG CORRECTED: after a misparse
961 ;;; a body of a subroutine could be corrupted!!!
962 ;;; One might need to reeval the function body
963 ;;; to fix things. (A similar bug was
964 ;;; present in `cperl-indent-region' eons ago.)
966 ;; (defun foo () (let ((a '(t))) (insert (format "%s" a)) (setcar a 'BUG) t))
969 ;;; C-x C-e the above three lines (at end-of-line). First evaluation
970 ;;; of `foo' inserts (t), second one inserts (BUG) ?!
972 ;;; In CPerl it was triggered by inserting then deleting `/' at start of
973 ;;; / a (?# asdf {[(}asdf )ef,/;
976 ;;; (`cperl-commentify'): Was recognizing length=2 "strings" as length=1.
977 ;;; (`imenu-example--create-perl-index'):
978 ;;; Was not enforcing syntaxification-to-the-end.
979 ;;; (`cperl-invert-if-unless'): Allow `for', `foreach'.
980 ;;; (`cperl-find-pods-heres'): Quote `cperl-nonoverridable-face'.
981 ;;; Mark qw(), m()x as indentable.
982 ;;; (`cperl-init-faces'): Highlight `sysopen' too.
983 ;;; Highlight $var in `for my $var' too.
984 ;;; (`cperl-invert-if-unless'): Was leaving whitespace at end.
985 ;;; (`cperl-linefeed'): Was splitting $var{$foo} if point after `{'.
986 ;;; (`cperl-calculate-indent'): Remove old commented out code.
987 ;;; Support (primitive) indentation of qw(), m()x.
991 ;;; (`cperl-problems'): Mention `fill-paragraph' on comment. \"" and
992 ;;; q [] with intervening newlines.
993 ;;; (`cperl-autoindent-on-semi'): New customization variable.
994 ;;; (`cperl-electric-semi'): Use `cperl-autoindent-on-semi'.
995 ;;; (`cperl-tips'): Mention how to make CPerl the default mode.
996 ;;; (`cperl-mode'): Support `outline-minor-mode'
997 ;;; (Thanks to Mark A. Hershberger).
998 ;;; (`cperl-outline-level'): New function.
999 ;;; (`cperl-highlight-variables-indiscriminately'): New customization var.
1000 ;;; (`cperl-init-faces'): Use `cperl-highlight-variables-indiscriminately'.
1001 ;;; (Thanks to Sean Kamath <kamath@pogo.wv.tek.com>).
1002 ;;; (`cperl-after-block-p'): Support CHECK and INIT.
1003 ;;; (`cperl-init-faces'): Likewise and "our".
1004 ;;; (Thanks to Doug MacEachern <dougm@covalent.net>).
1005 ;;; (`cperl-short-docs'): Likewise and "our".
1009 ;;; (`cperl-find-pods-heres'): Recognize \"" as a string.
1010 ;;; Mark whitespace and comments between q and []
1011 ;;; as `syntax-type' => `prestring'.
1012 ;;; Allow whitespace between << and "FOO".
1013 ;;; (`cperl-problems'): Remove \"" and q [] with intervening newlines.
1014 ;;; Mention multiple <<EOF as unsupported.
1015 ;;; (`cperl-highlight-variables-indiscriminately'): Doc misprint fixed.
1016 ;;; (`cperl-indent-parens-as-block'): New configuration variable.
1017 ;;; (`cperl-calculate-indent'): Merge cases of indenting non-BLOCK groups.
1018 ;;; Use `cperl-indent-parens-as-block'.
1019 ;;; (`cperl-find-pods-heres'): Test for =cut without empty line instead of
1020 ;;; complaining about no =cut.
1021 ;;; (`cperl-electric-pod'): Change the REx for POD from "\n\n=" to "^\n=".
1022 ;;; (`cperl-find-pods-heres'): Likewise.
1023 ;;; (`cperl-electric-pod'): Change `forward-sexp' to `forward-word':
1024 ;;; POD could've been marked as comment already.
1025 ;;; (`cperl-unwind-to-safe'): Unwind before start of POD too.
1028 ;;; (`cperl-forward-re'): Throw an error at proper moment REx unfinished.
1031 ;;; (`x-color-defined-p'): Make an extra case to peacify the warning.
1032 ;;; Toplevel: `defvar' to peacify the warnings.
1033 ;;; (`cperl-find-pods-heres'): Could access `font-lock-comment-face' in -nw.
1034 ;;;; No -nw-compile time warnings now.
1035 ;;; (`cperl-find-tags'): TAGS file had too short substring-to-search.
1036 ;;; Be less verbose in non-interactive mode
1037 ;;; (`imenu-example--create-perl-index'): Set index-marker after name
1038 ;;; (`cperl-outline-regexp'): New variable.
1039 ;;; (`cperl-outline-level'): Made compatible with `cperl-outline-regexp'.
1040 ;;; (`cperl-mode'): Made use `cperl-outline-regexp'.
1043 ;;; (`cperl-find-pods-heres'): =cut the last thing, no blank line, was error.
1044 ;;; (`cperl-outline-level'): Make start-of-file same level as `package'.
1047 ;;; (`cperl-electric-pod'): `head1' and `over' electric only if empty.
1048 ;;; (`cperl-unreadable-ok'): New variable.
1049 ;;; (`cperl-find-tags'): Use `cperl-unreadable-ok', do not fail
1050 ;;; on an unreadable file
1051 ;;; (`cperl-write-tags'): Use `cperl-unreadable-ok', do not fail
1052 ;;; on an unreadable directory
1055 ;;; Syncronized with v1.60 from Emacs 21.3.
1056 ;;; Mostly docstring and formatting changes, and:
1058 ;;; (`cperl-noscan-files-regexp'): Do not scan CVS subdirs
1059 ;;; (`cperl-problems'): Note that newer XEmacsen may syntaxify too
1060 ;;; (`imenu-example--create-perl-index'):
1061 ;;; Renamed to `cperl-imenu--create-perl-index'
1062 ;;; (`cperl-mode'): Replace `make-variable-buffer-local' by `make-local-variable'
1063 ;;; (`cperl-setup-tmp-buf'): Likewise
1064 ;;; (`cperl-fix-line-spacing'): Fix a misprint of "t" for "\t"
1065 ;;; (`cperl-next-bad-style'): Fix misprints in character literals
1068 ;;; (`cperl-font-lock-keywords'): +etc: Aliased to perl-font-lock-keywords.
1071 ;;; Further updates of whitespace and spelling w.r.t. RMS version.
1072 ;;; (`cperl-font-lock-keywords'): +etc: Avoid warnings when aliasing.
1073 ;;; (`cperl-mode'): Use `normal-auto-fill-function' if present.
1074 ;;; (`cperl-use-major-mode'): New variable
1075 ;;; (`cperl-can-font-lock'): New variable; replaces `window-system'
1076 ;;; (`cperl-tags-hier-init'): use `display-popup-menus-p' (if present)
1077 ;;; to choose `x-popup-menu' vs `tmm-prompt'
1079 ;;;; 4.35 has the following differences from version 1.40+ of RMS Emacs:
1081 ;;; New variables `cperl-use-major-mode', `cperl-can-font-lock';
1082 ;;; `cperl-use-major-mode' is (effectively) 'cperl-mode in RMS.
1083 ;;; `cperl-under-as-char' is nil in RMS.
1084 ;;; Minor differences in docstrings, and `cperl-non-problems'.
1085 ;;; Backward compatibility addressed: (`); (function (lambda ...)); font-lock;
1086 ;;; (:italic t bold t) vs (:slant italic :weight bold) in faces;
1087 ;;; `normal-auto-fill-function'.
1088 ;;; RMS version has wrong logic in `cperl-calculate-indent': $a = { } is
1089 ;;; wrongly indented if the closing brace is on a separate line.
1090 ;;; Different choice of ordering if's for is-x-REx and (eq (char-after b) ?\#)
1091 ;;; in `cperl-find-pods-heres'. [Cosmetic]
1094 ;;; (`cperl-find-pods-heres'): If no end of HERE-doc found, mark to the end
1095 ;;; of buffer. This enables recognition of end
1096 ;;; of HERE-doc "as one types".
1097 ;;; Require "\n" after trailing tag of HERE-doc.
1098 ;;; \( made non-quoting outside of string/comment
1099 ;;; (gdj-contributed).
1100 ;;; Likewise for \$.
1101 ;;; Remove `here-doc-group' text property at start
1102 ;;; (makes this property reliable).
1103 ;;; Text property `first-format-line' ==> t.
1104 ;;; Do not recognize $opt_s and $opt::s as s///.
1105 ;;; (`cperl-perldoc'): Use case-sensitive search (contributed).
1106 ;;; (`cperl-fix-line-spacing'): Allow "_" in $vars of foreach etc. when
1107 ;;; underscore isn't a word char (gdj-contributed).
1108 ;;; (`defun-prompt-regexp'): Allow prototypes.
1109 ;;; (`cperl-vc-header-alist'): Extract numeric version from the Id.
1110 ;;; Toplevel: Put toggle-autohelp into the mode menu.
1111 ;;; Better docs for toggle/set/unset autohelp.
1112 ;;; (`cperl-electric-backspace-untabify'): New customization variable
1113 ;;; (`cperl-after-expr-p'): Works after here-docs, formats, and PODs too
1114 ;;; (affects many electric constructs).
1115 ;;; (`cperl-calculate-indent'): Takes into account `first-format-line' ==>
1116 ;;; works after format.
1117 ;;; (`cperl-short-docs'): Make it work with ... too.
1118 ;;; "array context" ==> "list context"
1119 ;;; (`cperl-electric-keyword'): make $if (etc: "$@%&*") non-electric
1120 ;;; '(' after keyword would insert a doubled paren
1121 ;;; (`cperl-electric-paren'): documented affected by `cperl-electric-parens'
1122 ;;; (`cperl-electric-rparen'): Likewise
1123 ;;; (`cperl-build-manpage'): New function by Nick Roberts
1124 ;;; (`cperl-perldoc'): Make it work in XEmacs too
1127 ;;; (`cperl-find-pods-heres'): Recognize s => 1 and {s} (as a key or varname),
1128 ;;; { s:: } and { s::bar::baz } as varnames.
1129 ;;; (`cperl-after-expr-p'): Updates syntaxification before checks
1130 ;;; (`cperl-calculate-indent'): Likewise
1131 ;;; Fix wrong indent of blocks starting with POD
1132 ;;; (`cperl-after-block-p'): Optional argument for checking for a pre-block
1133 ;;; Recognize `continue' blocks too.
1134 ;;; (`cperl-electric-brace'): use `cperl-after-block-p' for detection;
1135 ;;; Now works for else/continue/sub blocks
1136 ;;; (`cperl-short-docs'): Minor edits; make messages fit 80-column screen
1139 ;;; `cperl-add-tags-recurse-noxs-fullpath': new function (for -batch mode)
1142 ;;;;;; Major edit. Summary of most visible changes:
1144 ;;;;;; a) Multiple <<HERE per line allowed.
1145 ;;;;;; b) Handles multiline subroutine declaration headers (with comments).
1146 ;;;;;; (The exception is `cperl-etags' - but it is not used in the rest
1147 ;;;;;; of the mode.)
1148 ;;;;;; c) Fontifies multiline my/our declarations (even with comments,
1149 ;;;;;; and with legacy `font-lock').
1150 ;;;;;; d) Major speedup of syntaxification, both immediate and postponed
1151 ;;;;;; (3.5x to 15x [for different CPUs and versions of Emacs] on the
1152 ;;;;;; huge real-life document I tested).
1153 ;;;;;; e) New bindings, edits to imenu.
1154 ;;;;;; f) "_" is made into word-char during fontification/syntaxification;
1155 ;;;;;; some attempts to recognize non-word "_" during other operations too.
1156 ;;;;;; g) Detect bug in Emacs with `looking-at' inside `narrow' and bulk out.
1157 ;;;;;; h) autoload some more perldoc-related stuff
1158 ;;;;;; i) Some new convenience features: ISpell POD/HEREDOCs, narrow-to-HEREDOC
1159 ;;;;;; j) Attempt to incorporate XEmacs edits which reached me
1161 ;;;; Fine-grained changelog:
1162 ;;; `cperl-hook-after-change': New configuration variable
1163 ;;; `cperl-vc-sccs-header': Likewise
1164 ;;; `cperl-vc-sccs-header': Likewise
1165 ;;; `cperl-vc-header-alist': Default via two preceding variables
1166 ;;; `cperl-invalid-face': Remove double quoting under XEmacs
1167 ;;; (still needed under 21.2)
1168 ;;; `cperl-tips': Update URLs for resources
1169 ;;; `cperl-problems': Likewise
1170 ;;; `cperl-praise': Mention new features
1171 ;;; New C-c key bindings: for `cperl-find-bad-style',
1172 ;;; `cperl-pod-spell', `cperl-here-doc-spell', `cperl-narrow-to-here-doc',
1173 ;;; `cperl-perdoc', `cperl-perldoc-at-point'
1174 ;;; CPerl Mode menu changes: "Fix style by spaces", "Imenu on Perl Info"
1175 ;;; moved, new submenu of Tools with Ispell entries and narrowing.
1176 ;;; `cperl-after-sub-regexp': New defsubst
1177 ;;; `cperl-imenu--function-name-regexp-perl': Use `cperl-after-sub-regexp',
1178 ;;; Allows heads up to head4
1179 ;;; Allow "package;"
1180 ;;; `defun-prompt-regexp': Use `cperl-after-sub-regexp',
1181 ;;; `paren-backwards-message': ??? Something for XEmacs???
1182 ;;; `cperl-mode': Never auto-switch abbrev-mode off
1183 ;;; Try to allow '_' be non-word char
1184 ;;; Do not use `font-lock-unfontify-region-function' on XEmacs
1185 ;;; Reset syntax cache on mode start
1186 ;;; Support multiline facification (even
1187 ;;; on legacy `font-lock')
1188 ;;; `cperl-facemenu-add-face-function': ??? Some contributed code ???
1189 ;;; `cperl-after-change-function': Since `font-lock' and `lazy-lock'
1190 ;;; refuse to inform us whether the fontification is due to lazy
1191 ;;; calling or due to edit to a buffer, install our own hook
1192 ;;; (controlled by `cperl-hook-after-change')
1193 ;;; `cperl-electric-pod': =cut may have been recognized as start
1194 ;;; `cperl-block-p': Moved, updated for attributes
1195 ;;; `cperl-calculate-indent': Try to allow '_' be non-word char
1196 ;;; Support subs with attributes
1197 ;;; `cperl-where-am-i': Queit (?) a warning
1198 ;;; `cperl-cached-syntax-table' New function
1199 ;;; `cperl-forward-re': Use `cperl-cached-syntax-table'
1200 ;;; `cperl-unwind-to-safe': Recognize `syntax-type' property
1201 ;;; changing in a middle of line
1202 ;;; `cperl-find-sub-attrs': New function
1203 ;;; `cperl-find-pods-heres': Allow many <<EOP per line
1204 ;;; Allow subs with attributes
1205 ;;; Major speedups (3.5x..15x on a real-life
1206 ;;; test file nph-proxy.pl)
1207 ;;; Recognize "extproc " (OS/2)
1208 ;;; case-folded and only at start
1209 ;;; /x on s///x with empty replacement was
1212 ;;; `cperl-after-block-p': Remarks on diff with `cperl-block-p'
1213 ;;; Allow subs with attributes, labels
1214 ;;; Do not confuse "else::foo" with "else"
1215 ;;; Minor optimizations...
1216 ;;; `cperl-after-expr-p': Try to allow '_' be non-word char
1217 ;;; `cperl-fill-paragraph': Try to detect a major bug in Emacs
1218 ;;; with `looking-at' inside `narrow' and bulk out if found
1219 ;;; `cperl-imenu--create-perl-index': Updates for new
1220 ;;; `cperl-imenu--function-name-regexp-perl'
1221 ;;; `cperl-outline-level': Likewise
1222 ;;; `cperl-init-faces': Allow multiline subroutine headers
1223 ;;; and my/our declarations, and ones with comments
1224 ;;; Allow subroutine attributes
1225 ;;; `cperl-imenu-on-info': Better docstring.
1226 ;;; `cperl-etags' Rudimentary support for attributes
1227 ;;; Support for packages and "package;"
1228 ;;; `cperl-add-tags-recurse-noxs': Better (?) docstring
1229 ;;; `cperl-add-tags-recurse-noxs-fullpath': Likewise
1230 ;;; `cperl-tags-hier-init': Misprint for `fboundp' fixed
1231 ;;; `cperl-not-bad-style-regexp': Try to allow '_' be non-word char
1232 ;;; `cperl-perldoc': Add autoload
1233 ;;; `cperl-perldoc-at-point': Likewise
1234 ;;; `cperl-here-doc-spell': New function
1235 ;;; `cperl-pod-spell': Likewise
1236 ;;; `cperl-map-pods-heres': Likewise
1237 ;;; `cperl-get-here-doc-region': Likewise
1238 ;;; `cperl-font-lock-fontify-region-function': Likewise (backward compatibility
1239 ;;; for legacy `font-lock')
1240 ;;; `cperl-font-lock-unfontify-region-function': Fix style
1241 ;;; `cperl-fontify-syntaxically': Recognize and optimize away
1242 ;;; deferred calls with no-change. Governed by `cperl-hook-after-change'
1243 ;;; `cperl-fontify-update': Recognize that syntaxification region
1244 ;;; can be larger than fontification one.
1245 ;;; XXXX we leave `cperl-postpone' property, so this is quadratic...
1246 ;;; `cperl-fontify-update-bad': Temporary placeholder until
1247 ;;; it is clear how to implement `cperl-fontify-update'.
1248 ;;; `cperl-time-fontification': New function
1249 ;;; `attrib-group': New text attribute
1250 ;;; `multiline': New value: `syntax-type' text attribute
1253 ;;; `cperl-emulate-lazy-lock': New function
1254 ;;; `cperl-fontify-syntaxically': Would skip large regions
1255 ;;; Add `cperl-time-fontification', `cperl-emulate-lazy-lock' to menu
1256 ;;; Some globals were declared, but uninitialized
1258 ;;;; After 5.3, 5.4:
1259 ;;; `cperl-facemenu-add-face-function': Add docs, fix U<>
1260 ;;; Copyright message updated.
1261 ;;; `cperl-init-faces': Work around a bug in `font-lock'. May slow
1262 ;;; facification down a bit.
1263 ;;; Misprint for my|our|local for old `font-lock'
1264 ;;; "our" was not fontified same as "my|local"
1265 ;;; Highlight variables after "my" etc even in
1266 ;;; a middle of an expression
1267 ;;; Do not facify multiple variables after my etc
1268 ;;; unless parentheses are present
1271 ;;; `cperl-fontify-syntaxically': after-change hook could reset
1272 ;;; `cperl-syntax-done-to' to a middle of line; unwind to BOL.
1275 ;;; `cperl-init-faces': Allow highlighting of local ($/)
1276 ;;; `cperl-problems-old-emaxen': New variable (for the purpose of DOCSTRING).
1277 ;;; `cperl-problems': Remove fixed problems.
1278 ;;; `cperl-find-pods-heres': Recognize #-comments in m##x too
1279 ;;; Recognize charclasses (unless delimiter is \).
1280 ;;; `cperl-fontify-syntaxically': Unwinding to safe was done in wrong order
1281 ;;; `cperl-regexp-scan': Update docs
1282 ;;; `cperl-beautify-regexp-piece': use information got from regexp scan
1285 ;;; Major user visible changes:
1286 ;;; Recognition and fontification of character classes in RExen.
1287 ;;; Variable indentation of RExen according to groups
1289 ;;; `cperl-find-pods-heres': Recognize POSIX classes in REx charclasses
1290 ;;; Fontify REx charclasses in variable-name face
1291 ;;; Fontify POSIX charclasses in "type" face
1292 ;;; Fontify unmatched "]" in function-name face
1293 ;;; Mark first-char of HERE-doc as `front-sticky'
1294 ;;; Reset `front-sticky' property when needed
1295 ;;; `cperl-calculate-indent': Indents //x -RExen accordning to parens level
1296 ;;; `cperl-to-comment-or-eol': Recognize ends of `syntax-type' constructs
1297 ;;; `cperl-backward-to-noncomment': Recognize stringy `syntax-type' constructs
1298 ;;; Support `narrow'ed buffers.
1299 ;;; `cperl-praise': Remove a reservation
1300 ;;; `cperl-make-indent': New function
1301 ;;; `cperl-indent-for-comment': Use `cperl-make-indent'
1302 ;;; `cperl-indent-line': Likewise
1303 ;;; `cperl-lineup': Likewise
1304 ;;; `cperl-beautify-regexp-piece': Likewise
1305 ;;; `cperl-contract-level': Likewise
1306 ;;; `cperl-toggle-set-debug-unwind': New function
1307 ;;; New menu entry for this
1308 ;;; `fill-paragraph-function': Use when `boundp'
1309 ;;; `cperl-calculate-indent': Take into account groups when indenting RExen
1310 ;;; `cperl-to-comment-or-eol': Recognize # which end a string
1311 ;;; `cperl-modify-syntax-type': Make only syntax-table property non-sticky
1312 ;;; `cperl-fill-paragraph': Return t: needed for `fill-paragraph-function'
1313 ;;; `cperl-fontify-syntaxically': More clear debugging message
1314 ;;; `cperl-pod2man-build-command': XEmacs portability: check `Man-filter-list'
1315 ;;; `cperl-init-faces': More complicated highlight even on XEmacs (new)
1316 ;;; Merge cosmetic changes from XEmacs
1319 ;;; `cperl-1+': Moved to before the first use
1320 ;;; `cperl-1-': Likewise
1324 ;;; This code may lock Emacs hard!!! Use on your own risk!
1326 ;;; `cperl-font-locking': New internal variable
1327 ;;; `cperl-beginning-of-property': New function
1328 ;;; `cperl-calculate-indent': Use `cperl-beginning-of-property'
1329 ;;; instead of `previous-single-property-change'
1330 ;;; `cperl-unwind-to-safe': Likewise
1331 ;;; `cperl-after-expr-p': Likewise
1332 ;;; `cperl-get-here-doc-region': Likewise
1333 ;;; `cperl-font-lock-fontify-region-function': Likewise
1334 ;;; `cperl-to-comment-or-eol': Do not call `cperl-update-syntaxification'
1336 ;;; Bound `next-single-property-change'
1338 ;;; `cperl-unwind-to-safe': Bound likewise
1339 ;;; `cperl-font-lock-fontify-region-function': Likewise
1340 ;;; `cperl-find-pods-heres': Mark as recursive for `cperl-to-comment-or-eol'
1341 ;;; Initialization of
1342 ;;; `cperl-font-lock-multiline-start' could be missed if the "main"
1343 ;;; fontification did not run due to the keyword being already fontified.
1344 ;;; `cperl-pod-spell': Return t from do-one-chunk function
1345 ;;; `cperl-map-pods-heres': Stop when the worker returns nil
1346 ;;; Call `cperl-update-syntaxification'
1347 ;;; `cperl-get-here-doc-region': Call `cperl-update-syntaxification'
1348 ;;; `cperl-get-here-doc-delim': Remove unused function
1352 ;;; The possible lockup of Emacs (introduced in 5.10) fixed
1354 ;;; `cperl-unwind-to-safe': `cperl-beginning-of-property' won't return nil
1355 ;;; `cperl-syntaxify-for-menu': New customization variable
1356 ;;; `cperl-select-this-pod-or-here-doc': New function
1357 ;;; `cperl-get-here-doc-region': Extra argument.
1358 ;;; Do not adjust pos by 1.
1360 ;;; New menu entries (Perl/Tools): selection of current POD or HERE-DOC section
1361 ;;; (Debugging CPerl:) backtrace on fontification
1364 ;;; `cperl-cached-syntax-table': use `car-safe'
1365 ;;; `cperl-forward-re': Remove spurious argument SET-ST
1366 ;;; Add documentation
1367 ;;; `cperl-forward-group-in-re': New function
1368 ;;; `cperl-find-pods-heres': Find and highlight (?{}) blocks in RExen.
1369 ;;; (XXXX Temporary (?) hack is to syntax-mark them as comment)
1372 ;;; `cperl-string-syntax-table': Make { and } not-grouping
1373 ;;; (Sometimes they ARE grouping in RExen, but matching them would only
1374 ;;; confuse in many situations when they are not).
1375 ;;; `beginning-of-buffer': Replaced two occurences with goto-char...
1376 ;;; `cperl-calculate-indent': `char-after' could be nil...
1377 ;;; `cperl-find-pods-heres': REx can start after "[" too
1378 ;;; Hightlight (??{}) in RExen too
1379 ;;; `cperl-maybe-white-and-comment-rex': New constant
1380 ;;; `cperl-white-and-comment-rex': Likewise
1381 ;;; XXXX Not very efficient, but hard to make
1382 ;;; better while keeping 1 group.
1385 ;;; `cperl-find-pods-heres': $foo << identifier() is not a HERE-DOC
1386 ;;; Likewise for 1 << identifier
1389 ;;; `cperl-find-pods-heres': Different logic for $foo .= <<EOF etc
1390 ;;; Error-less condition-case could fail
1391 ;;; `cperl-font-lock-fontify-region-function': Likewise
1392 ;;; `cperl-init-faces': Likewise
1395 ;;; `cperl-find-pods-heres': Support property REx-part2
1396 ;;; `cperl-calculate-indent': Likewise
1397 ;;; Don't special-case REx with non-empty 1st line
1398 ;;; `cperl-find-pods-heres': In RExen, highlight non-literal backslashes
1399 ;;; Invert highlighting of charclasses:
1400 ;;; now the envelop is highlighted
1401 ;;; Highlight many others 0-length builtins
1402 ;;; `cperl-praise': Mention indenting and highlight in RExen.
1406 (if (fboundp 'eval-when-compile)
1414 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1415 (defvar cperl-can-font-lock
1417 (and (boundp 'emacs-major-version)
1419 (> emacs-major-version 20)))))
1420 (if cperl-can-font-lock
1421 (require 'font-lock))
1422 (defvar msb-menu-cond)
1423 (defvar gud-perldb-history)
1424 (defvar font-lock-background-mode) ; not in Emacs
1425 (defvar font-lock-display-type) ; ditto
1426 (or (fboundp 'defgroup)
1427 (defmacro defgroup (name val doc &rest arr)
1429 (or (fboundp 'custom-declare-variable)
1430 (defmacro defcustom (name val doc &rest arr)
1431 (` (defvar (, name) (, val) (, doc)))))
1432 (or (and (fboundp 'custom-declare-variable)
1433 (string< "19.31" emacs-version)) ; Checked with 19.30: defface does not work
1434 (defmacro defface (&rest arr)
1436 ;; Avoid warning (tmp definitions)
1437 (or (fboundp 'x-color-defined-p)
1438 (defmacro x-color-defined-p (col)
1439 (cond ((fboundp 'color-defined-p) (` (color-defined-p (, col))))
1441 ((fboundp 'valid-color-name-p) (` (valid-color-name-p (, col))))
1443 ((fboundp 'x-valid-color-name-p) (` (x-valid-color-name-p (, col))))
1444 (t '(error "Cannot implement color-defined-p")))))
1445 (defmacro cperl-is-face (arg) ; Takes quoted arg
1446 (cond ((fboundp 'find-face)
1447 (` (find-face (, arg))))
1448 (;;(and (fboundp 'face-list)
1450 (fboundp 'face-list)
1451 (` (member (, arg) (and (fboundp 'face-list)
1454 (` (boundp (, arg))))))
1455 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
1456 (cond ((fboundp 'make-face)
1457 (` (make-face (quote (, arg)))))
1459 (` (defvar (, arg) (quote (, arg)) (, descr))))))
1460 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
1462 (or (cperl-is-face (quote (, arg)))
1463 (cperl-make-face (, arg) (, descr)))
1464 (or (boundp (quote (, arg))) ; We use unquoted variants too
1465 (defvar (, arg) (quote (, arg)) (, descr))))))
1467 (defmacro cperl-etags-snarf-tag (file line)
1469 (beginning-of-line 2)
1470 (list (, file) (, line)))))
1471 (defmacro cperl-etags-snarf-tag (file line)
1472 (` (etags-snarf-tag))))
1474 (defmacro cperl-etags-goto-tag-location (elt)
1476 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
1477 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
1478 ;; Probably will not work due to some save-excursion???
1479 ;; Or save-file-position?
1480 ;; (message "Did I get to line %s?" (elt (, elt) 1))
1481 (goto-line (string-to-int (elt (, elt) 1)))))
1483 (defmacro cperl-etags-goto-tag-location (elt)
1484 (` (etags-goto-tag-location (, elt)))))))
1486 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1488 (defvar cperl-can-font-lock
1490 (and (boundp 'emacs-major-version)
1492 (> emacs-major-version 20)))))
1496 (error nil)) ; Already fixed by eval-when-compile
1498 (defun cperl-choose-color (&rest list)
1502 (if (or (x-color-defined-p (car list))
1504 (setq answer (car list))))
1505 (setq list (cdr list)))
1510 "Major mode for editing Perl code."
1514 (defgroup cperl-indentation-details nil
1519 (defgroup cperl-affected-by-hairy nil
1520 "Variables affected by `cperl-hairy'."
1524 (defgroup cperl-autoinsert-details nil
1525 "Auto-insert tuneup."
1529 (defgroup cperl-faces nil
1530 "Fontification colors."
1534 (defgroup cperl-speed nil
1535 "Speed vs. validity tuneup."
1539 (defgroup cperl-help-system nil
1540 "Help system tuneup."
1545 (defcustom cperl-extra-newline-before-brace nil
1546 "*Non-nil means that if, elsif, while, until, else, for, foreach
1547 and do constructs look like:
1558 :group 'cperl-autoinsert-details)
1560 (defcustom cperl-extra-newline-before-brace-multiline
1561 cperl-extra-newline-before-brace
1562 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
1563 for constructs with multiline if/unless/while/until/for/foreach condition."
1565 :group 'cperl-autoinsert-details)
1567 (defcustom cperl-indent-level 2
1568 "*Indentation of CPerl statements with respect to containing block."
1570 :group 'cperl-indentation-details)
1572 (defcustom cperl-lineup-step nil
1573 "*`cperl-lineup' will always lineup at multiple of this number.
1574 If nil, the value of `cperl-indent-level' will be used."
1575 :type '(choice (const nil) integer)
1576 :group 'cperl-indentation-details)
1578 (defcustom cperl-brace-imaginary-offset 0
1579 "*Imagined indentation of a Perl open brace that actually follows a statement.
1580 An open brace following other text is treated as if it were this far
1581 to the right of the start of its line."
1583 :group 'cperl-indentation-details)
1585 (defcustom cperl-brace-offset 0
1586 "*Extra indentation for braces, compared with other text in same context."
1588 :group 'cperl-indentation-details)
1589 (defcustom cperl-label-offset -2
1590 "*Offset of CPerl label lines relative to usual indentation."
1592 :group 'cperl-indentation-details)
1593 (defcustom cperl-min-label-indent 1
1594 "*Minimal offset of CPerl label lines."
1596 :group 'cperl-indentation-details)
1597 (defcustom cperl-continued-statement-offset 2
1598 "*Extra indent for lines not starting new statements."
1600 :group 'cperl-indentation-details)
1601 (defcustom cperl-continued-brace-offset 0
1602 "*Extra indent for substatements that start with open-braces.
1603 This is in addition to cperl-continued-statement-offset."
1605 :group 'cperl-indentation-details)
1606 (defcustom cperl-close-paren-offset -1
1607 "*Extra indent for substatements that start with close-parenthesis."
1609 :group 'cperl-indentation-details)
1611 (defcustom cperl-auto-newline nil
1612 "*Non-nil means automatically newline before and after braces,
1613 and after colons and semicolons, inserted in CPerl code. The following
1614 \\[cperl-electric-backspace] will remove the inserted whitespace.
1615 Insertion after colons requires both this variable and
1616 `cperl-auto-newline-after-colon' set."
1618 :group 'cperl-autoinsert-details)
1620 (defcustom cperl-autoindent-on-semi nil
1621 "*Non-nil means automatically indent after insertion of (semi)colon.
1622 Active if `cperl-auto-newline' is false."
1624 :group 'cperl-autoinsert-details)
1626 (defcustom cperl-auto-newline-after-colon nil
1627 "*Non-nil means automatically newline even after colons.
1628 Subject to `cperl-auto-newline' setting."
1630 :group 'cperl-autoinsert-details)
1632 (defcustom cperl-tab-always-indent t
1633 "*Non-nil means TAB in CPerl mode should always reindent the current line,
1634 regardless of where in the line point is when the TAB command is used."
1636 :group 'cperl-indentation-details)
1638 (defcustom cperl-font-lock nil
1639 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
1640 Can be overwritten by `cperl-hairy' if nil."
1641 :type '(choice (const null) boolean)
1642 :group 'cperl-affected-by-hairy)
1644 (defcustom cperl-electric-lbrace-space nil
1645 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
1646 Can be overwritten by `cperl-hairy' if nil."
1647 :type '(choice (const null) boolean)
1648 :group 'cperl-affected-by-hairy)
1650 (defcustom cperl-electric-parens-string "({[]})<"
1651 "*String of parentheses that should be electric in CPerl.
1652 Closing ones are electric only if the region is highlighted."
1654 :group 'cperl-affected-by-hairy)
1656 (defcustom cperl-electric-parens nil
1657 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
1658 Can be overwritten by `cperl-hairy' if nil."
1659 :type '(choice (const null) boolean)
1660 :group 'cperl-affected-by-hairy)
1662 (defvar zmacs-regions) ; Avoid warning
1664 (defcustom cperl-electric-parens-mark
1666 (or (and (boundp 'transient-mark-mode) ; For Emacs
1667 transient-mark-mode)
1668 (and (boundp 'zmacs-regions) ; For XEmacs
1670 "*Not-nil means that electric parens look for active mark.
1671 Default is yes if there is visual feedback on mark."
1673 :group 'cperl-autoinsert-details)
1675 (defcustom cperl-electric-linefeed nil
1676 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
1677 In any case these two mean plain and hairy linefeeds together.
1678 Can be overwritten by `cperl-hairy' if nil."
1679 :type '(choice (const null) boolean)
1680 :group 'cperl-affected-by-hairy)
1682 (defcustom cperl-electric-keywords nil
1683 "*Not-nil (and non-null) means keywords are electric in CPerl.
1684 Can be overwritten by `cperl-hairy' if nil."
1685 :type '(choice (const null) boolean)
1686 :group 'cperl-affected-by-hairy)
1688 (defcustom cperl-electric-backspace-untabify t
1689 "*Not-nil means electric-backspace will untabify in CPerl."
1691 :group 'cperl-autoinsert-details)
1693 (defcustom cperl-hairy nil
1694 "*Not-nil means most of the bells and whistles are enabled in CPerl.
1695 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
1696 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
1697 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
1698 `cperl-lazy-help-time'."
1700 :group 'cperl-affected-by-hairy)
1702 (defcustom cperl-comment-column 32
1703 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
1705 :group 'cperl-indentation-details)
1707 (defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
1708 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
1709 :type '(repeat string)
1712 (defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
1713 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
1714 :type '(repeat string)
1717 ;; This became obsolete...
1718 (defcustom cperl-vc-header-alist '()
1719 "*What to use as `vc-header-alist' in CPerl.
1720 Obsolete, with newer Emacsen use `cperl-vc-rcs-header' or
1721 `cperl-vc-sccs-header' instead. If this list is empty, `vc-header-alist'
1722 will be reconstructed basing on these two variables."
1723 :type '(repeat (list symbol string))
1726 (defcustom cperl-clobber-mode-lists
1729 (boundp 'interpreter-mode-alist)
1730 (assoc "miniperl" interpreter-mode-alist)
1731 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
1732 "*Whether to install us into `interpreter-' and `extension' mode lists."
1736 (defcustom cperl-info-on-command-no-prompt nil
1737 "*Not-nil (and non-null) means not to prompt on C-h f.
1738 The opposite behaviour is always available if prefixed with C-c.
1739 Can be overwritten by `cperl-hairy' if nil."
1740 :type '(choice (const null) boolean)
1741 :group 'cperl-affected-by-hairy)
1743 (defcustom cperl-clobber-lisp-bindings nil
1744 "*Not-nil (and non-null) means not overwrite C-h f.
1745 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
1746 Can be overwritten by `cperl-hairy' if nil."
1747 :type '(choice (const null) boolean)
1748 :group 'cperl-affected-by-hairy)
1750 (defcustom cperl-lazy-help-time nil
1751 "*Not-nil (and non-null) means to show lazy help after given idle time.
1752 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
1753 :type '(choice (const null) (const nil) integer)
1754 :group 'cperl-affected-by-hairy)
1756 (defcustom cperl-pod-face 'font-lock-comment-face
1757 "*The result of evaluation of this expression is used for POD highlighting."
1759 :group 'cperl-faces)
1761 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
1762 "*The result of evaluation of this expression is used for POD highlighting.
1763 Font for POD headers."
1765 :group 'cperl-faces)
1767 (defcustom cperl-here-face 'font-lock-string-face
1768 "*The result of evaluation of this expression is used for here-docs highlighting."
1770 :group 'cperl-faces)
1772 ;;; Some double-evaluation happened with font-locks... Needed with 21.2...
1773 (defvar cperl-singly-quote-face cperl-xemacs-p)
1775 (defcustom cperl-invalid-face ; Does not customize with '' on XEmacs
1776 (if cperl-singly-quote-face
1777 'underline ''underline) ; On older Emacsen was evaluated by `font-lock'
1778 (if cperl-singly-quote-face
1779 "*This face is used for highlighting trailing whitespace."
1780 "*The result of evaluation of this expression highlights trailing whitespace.")
1782 :group 'cperl-faces)
1784 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
1785 "*Not-nil after evaluation means to highlight POD and here-docs sections."
1787 :group 'cperl-faces)
1789 (defcustom cperl-fontify-m-as-s t
1790 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
1792 :group 'cperl-faces)
1794 (defcustom cperl-highlight-variables-indiscriminately nil
1795 "*Non-nil means perform additional highlighting on variables.
1796 Currently only changes how scalar variables are highlighted.
1797 Note that that variable is only read at initialization time for
1798 the variable `perl-font-lock-keywords-2', so changing it after you've
1799 entered CPerl mode the first time will have no effect."
1803 (defcustom cperl-pod-here-scan t
1804 "*Not-nil means look for POD and here-docs sections during startup.
1805 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
1807 :group 'cperl-speed)
1809 (defcustom cperl-regexp-scan t
1810 "*Not-nil means make marking of regular expression more thorough.
1811 Effective only with `cperl-pod-here-scan'."
1813 :group 'cperl-speed)
1815 (defcustom cperl-hook-after-change t
1816 "*Not-nil means install hook to know which regions of buffer are changed.
1817 May significantly speed up delayed fontification. Changes take effect
1820 :group 'cperl-speed)
1822 (defcustom cperl-imenu-addback nil
1823 "*Not-nil means add backreferences to generated `imenu's.
1824 May require patched `imenu' and `imenu-go'. Obsolete."
1826 :group 'cperl-help-system)
1828 (defcustom cperl-max-help-size 66
1829 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
1830 :type '(choice integer (const nil))
1831 :group 'cperl-help-system)
1833 (defcustom cperl-shrink-wrap-info-frame t
1834 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
1836 :group 'cperl-help-system)
1838 (defcustom cperl-info-page "perl"
1839 "*Name of the info page containing perl docs.
1840 Older version of this page was called `perl5', newer `perl'."
1842 :group 'cperl-help-system)
1844 (defcustom cperl-use-syntax-table-text-property
1845 (boundp 'parse-sexp-lookup-properties)
1846 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
1848 :group 'cperl-speed)
1850 (defcustom cperl-use-syntax-table-text-property-for-tags
1851 cperl-use-syntax-table-text-property
1852 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
1854 :group 'cperl-speed)
1856 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
1857 "*Regexp to match files to scan when generating TAGS."
1861 (defcustom cperl-noscan-files-regexp
1862 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
1863 "*Regexp to match files/dirs to skip when generating TAGS."
1867 (defcustom cperl-regexp-indent-step nil
1868 "*Indentation used when beautifying regexps.
1869 If nil, the value of `cperl-indent-level' will be used."
1870 :type '(choice integer (const nil))
1871 :group 'cperl-indentation-details)
1873 (defcustom cperl-indent-left-aligned-comments t
1874 "*Non-nil means that the comment starting in leftmost column should indent."
1876 :group 'cperl-indentation-details)
1878 (defcustom cperl-under-as-char t
1879 "*Non-nil means that the _ (underline) should be treated as word char."
1883 (defcustom cperl-extra-perl-args ""
1884 "*Extra arguments to use when starting Perl.
1885 Currently used with `cperl-check-syntax' only."
1889 (defcustom cperl-message-electric-keyword t
1890 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
1892 :group 'cperl-help-system)
1894 (defcustom cperl-indent-region-fix-constructs 1
1895 "*Amount of space to insert between `}' and `else' or `elsif'
1896 in `cperl-indent-region'. Set to nil to leave as is. Values other
1897 than 1 and nil will probably not work."
1898 :type '(choice (const nil) (const 1))
1899 :group 'cperl-indentation-details)
1901 (defcustom cperl-break-one-line-blocks-when-indent t
1902 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
1903 need to be reformatted into multiline ones when indenting a region."
1905 :group 'cperl-indentation-details)
1907 (defcustom cperl-fix-hanging-brace-when-indent t
1908 "*Non-nil means that BLOCK-end `}' may be put on a separate line
1909 when indenting a region.
1910 Braces followed by else/elsif/while/until are excepted."
1912 :group 'cperl-indentation-details)
1914 (defcustom cperl-merge-trailing-else t
1915 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
1916 may be merged to be on the same line when indenting a region."
1918 :group 'cperl-indentation-details)
1920 (defcustom cperl-indent-parens-as-block nil
1921 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
1922 but for trailing \",\" inside the group, which won't increase indentation.
1923 One should tune up `cperl-close-paren-offset' as well."
1925 :group 'cperl-indentation-details)
1927 (defcustom cperl-syntaxify-by-font-lock
1928 (and cperl-can-font-lock
1929 (boundp 'parse-sexp-lookup-properties))
1930 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
1931 :type '(choice (const message) boolean)
1932 :group 'cperl-speed)
1934 (defcustom cperl-syntaxify-unwind
1936 "*Non-nil means that CPerl unwinds to a start of a long construction
1937 when syntaxifying a chunk of buffer."
1939 :group 'cperl-speed)
1941 (defcustom cperl-syntaxify-for-menu
1943 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
1944 This way enabling/disabling of menu items is more correct."
1946 :group 'cperl-speed)
1948 (defcustom cperl-ps-print-face-properties
1949 '((font-lock-keyword-face nil nil bold shadow)
1950 (font-lock-variable-name-face nil nil bold)
1951 (font-lock-function-name-face nil nil bold italic box)
1952 (font-lock-constant-face nil "LightGray" bold)
1953 (cperl-array-face nil "LightGray" bold underline)
1954 (cperl-hash-face nil "LightGray" bold italic underline)
1955 (font-lock-comment-face nil "LightGray" italic)
1956 (font-lock-string-face nil nil italic underline)
1957 (cperl-nonoverridable-face nil nil italic underline)
1958 (font-lock-type-face nil nil underline)
1959 (underline nil "LightGray" strikeout))
1960 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
1961 :type '(repeat (cons symbol
1962 (cons (choice (const nil) string)
1963 (cons (choice (const nil) string)
1965 :group 'cperl-faces)
1967 (if cperl-can-font-lock
1969 (defvar cperl-dark-background
1970 (cperl-choose-color "navy" "os2blue" "darkgreen"))
1971 (defvar cperl-dark-foreground
1972 (cperl-choose-color "orchid1" "orange"))
1974 (defface cperl-nonoverridable-face
1975 (` ((((class grayscale) (background light))
1976 (:background "Gray90" :italic t :underline t))
1977 (((class grayscale) (background dark))
1978 (:foreground "Gray80" :italic t :underline t :bold t))
1979 (((class color) (background light))
1980 (:foreground "chartreuse3"))
1981 (((class color) (background dark))
1982 (:foreground (, cperl-dark-foreground)))
1983 (t (:bold t :underline t))))
1984 "Font Lock mode face used to highlight array names."
1985 :group 'cperl-faces)
1987 (defface cperl-array-face
1988 (` ((((class grayscale) (background light))
1989 (:background "Gray90" :bold t))
1990 (((class grayscale) (background dark))
1991 (:foreground "Gray80" :bold t))
1992 (((class color) (background light))
1993 (:foreground "Blue" :background "lightyellow2" :bold t))
1994 (((class color) (background dark))
1995 (:foreground "yellow" :background (, cperl-dark-background) :bold t))
1997 "Font Lock mode face used to highlight array names."
1998 :group 'cperl-faces)
2000 (defface cperl-hash-face
2001 (` ((((class grayscale) (background light))
2002 (:background "Gray90" :bold t :italic t))
2003 (((class grayscale) (background dark))
2004 (:foreground "Gray80" :bold t :italic t))
2005 (((class color) (background light))
2006 (:foreground "Red" :background "lightyellow2" :bold t :italic t))
2007 (((class color) (background dark))
2008 (:foreground "Red" :background (, cperl-dark-background) :bold t :italic t))
2009 (t (:bold t :italic t))))
2010 "Font Lock mode face used to highlight hash names."
2011 :group 'cperl-faces)))
2015 ;;; Short extra-docs.
2017 (defvar cperl-tips 'please-ignore-this-line
2018 "Get maybe newer version of this package from
2019 http://ilyaz.org/software/emacs
2020 Subdirectory `cperl-mode' may contain yet newer development releases and/or
2021 patches to related files.
2023 For best results apply to an older Emacs the patches from
2024 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
2025 \(this upgrades syntax-parsing abilities of RMS Emaxen v19.34 and
2026 v20.2 up to the level of RMS Emacs v20.3 - a must for a good Perl
2027 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
2029 Get support packages choose-color.el (or font-lock-extra.el before
2030 19.30), imenu-go.el from the same place. \(Look for other files there
2031 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
2032 later you should use choose-color.el *instead* of font-lock-extra.el
2033 \(and you will not get smart highlighting in C :-().
2035 Note that to enable Compile choices in the menu you need to install
2038 If your Emacs does not default to `cperl-mode' on Perl files, and you
2039 want it to: put the following into your .emacs file:
2041 (autoload 'perl-mode \"cperl-mode\" \"alternate mode for editing Perl programs\" t)
2045 (defalias 'perl-mode 'cperl-mode)
2048 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
2049 Also, one can generate a newer documentation running `pod2texi' converter
2050 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
2052 If you use imenu-go, run imenu on perl5-info buffer (you can do it
2053 from Perl menu). If many files are related, generate TAGS files from
2054 Tools/Tags submenu in Perl menu.
2056 If some class structure is too complicated, use Tools/Hierarchy-view
2057 from Perl menu, or hierarchic view of imenu. The second one uses the
2058 current buffer only, the first one requires generation of TAGS from
2059 Perl/Tools/Tags menu beforehand.
2061 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
2063 Switch auto-help on/off with Perl/Tools/Auto-help.
2065 Though with contemporary Emaxen CPerl mode should maintain the correct
2066 parsing of Perl even when editing, sometimes it may be lost. Fix this by
2074 In cases of more severe confusion sometimes it is helpful to do
2076 M-x load-l RET cperl-mode RET
2081 \\[load-library] cperl-mode RET
2084 Before reporting (non-)problems look in the problem section of online
2085 micro-docs on what I know about CPerl problems.")
2087 (defvar cperl-problems 'please-ignore-this-line
2088 "Description of problems in CPerl mode.
2089 Some faces will not be shown on some versions of Emacs unless you
2090 install choose-color.el, available from
2091 http://ilyaz.org/software/emacs
2093 `fill-paragraph' on a comment may leave the point behind the
2094 paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
2095 to detect it and bulk out).
2097 See documentation of a variable `cperl-problems-old-emaxen' for the
2098 problems which disappear if you upgrade Emacs to a reasonably new
2099 version (20.3 for RMS Emacs, and those of 2004 for XEmacs).")
2101 (defvar cperl-problems-old-emaxen 'please-ignore-this-line
2102 "Description of problems in CPerl mode specific for older Emacs versions.
2104 Emacs had a _very_ restricted syntax parsing engine until RMS's Emacs
2105 20.1. Most problems below are corrected starting from this version of
2106 Emacs, and all of them should be fixed in RMS's version 20.3. (Or apply
2107 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
2108 this respect (until 2003).
2110 Note that even with newer Emacsen in some very rare cases the details
2111 of interaction of `font-lock' and syntaxification may be not cleaned
2112 up yet. You may get slightly different colors basing on the order of
2113 fontification and syntaxification. Say, the initial faces is correct,
2114 but editing the buffer breaks this.
2116 Even with older Emacsen CPerl mode tries to corrects some Emacs
2117 misunderstandings, however, for efficiency reasons the degree of
2118 correction is different for different operations. The partially
2119 corrected problems are: POD sections, here-documents, regexps. The
2120 operations are: highlighting, indentation, electric keywords, electric
2123 This may be confusing, since the regexp s#//#/#\; may be highlighted
2124 as a comment, but it will be recognized as a regexp by the indentation
2125 code. Or the opposite case, when a POD section is highlighted, but
2126 may break the indentation of the following code (though indentation
2127 should work if the balance of delimiters is not broken by POD).
2129 The main trick (to make $ a \"backslash\") makes constructions like
2130 ${aaa} look like unbalanced braces. The only trick I can think of is
2131 to insert it as $ {aaa} (legal in perl5, not in perl4).
2133 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
2134 as /($|\\s)/. Note that such a transposition is not always possible.
2136 The solution is to upgrade your Emacs or patch an older one. Note
2137 that RMS's 20.2 has some bugs related to `syntax-table' text
2138 properties. Patches are available on the main CPerl download site,
2141 If these bugs cannot be fixed on your machine (say, you have an inferior
2142 environment and cannot recompile), you may still disable all the fancy stuff
2143 via `cperl-use-syntax-table-text-property'.")
2145 (defvar cperl-non-problems 'please-ignore-this-line
2146 "As you know from `problems' section, Perl syntax is too hard for CPerl on
2147 older Emacsen. Here is what you can do if you cannot upgrade, or if
2148 you want to switch off these capabilities on RMS Emacs 20.2 (+patches) or 20.3
2149 or better. Please skip this docs if you run a capable Emacs already.
2151 Most of the time, if you write your own code, you may find an equivalent
2152 \(and almost as readable) expression (what is discussed below is usually
2153 not relevant on newer Emacsen, since they can do it automatically).
2155 Try to help CPerl: add comments with embedded quotes to fix CPerl
2156 misunderstandings about the end of quotation:
2160 You won't need it too often. The reason: $ \"quotes\" the following
2161 character (this saves a life a lot of times in CPerl), thus due to
2162 Emacs parsing rules it does not consider tick (i.e., ' ) after a
2163 dollar as a closing one, but as a usual character. This is usually
2164 correct, but not in the above context.
2166 Even with older Emacsen the indentation code is pretty wise. The only
2167 drawback is that it relied on Emacs parsing to find matching
2168 parentheses. And Emacs *could not* match parentheses in Perl 100%
2171 would not break indentation, but
2177 could confuse CPerl a lot.
2179 If you still get wrong indentation in situation that you think the
2180 code should be able to parse, try:
2182 a) Check what Emacs thinks about balance of your parentheses.
2183 b) Supply the code to me (IZ).
2185 Pods were treated _very_ rudimentally. Here-documents were not
2186 treated at all (except highlighting and inhibiting indentation). Upgrade.
2188 To speed up coloring the following compromises exist:
2189 a) sub in $mypackage::sub may be highlighted.
2190 b) -z in [a-z] may be highlighted.
2191 c) if your regexp contains a keyword (like \"s\"), it may be highlighted.
2194 Imenu in 19.31 is broken. Set `imenu-use-keymap-menu' to t, and remove
2195 `car' before `imenu-choose-buffer-index' in `imenu'.
2196 `imenu-add-to-menubar' in 20.2 is broken.
2197 A lot of things on XEmacs may be broken too, judging by bug reports I
2198 receive. Note that some releases of XEmacs are better than the others
2199 as far as bugs reports I see are concerned.")
2201 (defvar cperl-praise 'please-ignore-this-line
2202 "Advantages of CPerl mode.
2204 0) It uses the newest `syntax-table' property ;-);
2206 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
2207 mode - but the latter number may have improved too in last years) even
2208 with old Emaxen which do not support `syntax-table' property.
2210 When using `syntax-table' property for syntax assist hints, it should
2211 handle 99.995% of lines correct - or somesuch. It automatically
2212 updates syntax assist hints when you edit your script.
2214 2) It is generally believed to be \"the most user-friendly Emacs
2215 package\" whatever it may mean (I doubt that the people who say similar
2216 things tried _all_ the rest of Emacs ;-), but this was not a lonely
2219 3) Everything is customizable, one-by-one or in a big sweep;
2221 4) It has many easily-accessable \"tools\":
2222 a) Can run program, check syntax, start debugger;
2223 b) Can lineup vertically \"middles\" of rows, like `=' in
2226 c) Can insert spaces where this impoves readability (in one
2227 interactive sweep over the buffer);
2228 d) Has support for imenu, including:
2229 1) Separate unordered list of \"interesting places\";
2230 2) Separate TOC of POD sections;
2231 3) Separate list of packages;
2232 4) Hierarchical view of methods in (sub)packages;
2233 5) and functions (by the full name - with package);
2234 e) Has an interface to INFO docs for Perl; The interface is
2235 very flexible, including shrink-wrapping of
2236 documentation buffer/frame;
2237 f) Has a builtin list of one-line explanations for perl constructs.
2238 g) Can show these explanations if you stay long enough at the
2239 corresponding place (or on demand);
2240 h) Has an enhanced fontification (using 3 or 4 additional faces
2241 comparing to font-lock - basically, different
2242 namespaces in Perl have different colors);
2243 i) Can construct TAGS basing on its knowledge of Perl syntax,
2244 the standard menu has 6 different way to generate
2245 TAGS (if \"by directory\", .xs files - with C-language
2246 bindings - are included in the scan);
2247 j) Can build a hierarchical view of classes (via imenu) basing
2248 on generated TAGS file;
2249 k) Has electric parentheses, electric newlines, uses Abbrev
2250 for electric logical constructs
2252 with different styles of expansion (context sensitive
2253 to be not so bothering). Electric parentheses behave
2254 \"as they should\" in a presence of a visible region.
2255 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
2261 n) Highlights (by user-choice) either 3-delimiters constructs
2262 (such as tr/a/b/), or regular expressions and `y/tr';
2263 o) Highlights trailing whitespace;
2264 p) Is able to manipulate Perl Regular Expressions to ease
2265 conversion to a more readable form.
2266 q) Can ispell POD sections and HERE-DOCs.
2267 r) Understands comments and character classes inside regular
2268 expressions; can find matching () and [] in a regular expression.
2269 s) Allows indentation of //x-style regular expressions;
2270 t) Highlights different symbols in regular expressions according
2271 to their function; much less problems with backslashitis.
2273 5) The indentation engine was very smart, but most of tricks may be
2274 not needed anymore with the support for `syntax-table' property. Has
2275 progress indicator for indentation (with `imenu' loaded).
2277 6) Indent-region improves inline-comments as well; also corrects
2278 whitespace *inside* the conditional/loop constructs.
2280 7) Fill-paragraph correctly handles multi-line comments;
2282 8) Can switch to different indentation styles by one command, and restore
2283 the settings present before the switch.
2285 9) When doing indentation of control constructs, may correct
2286 line-breaks/spacing between elements of the construct.
2288 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
2289 capable syntax engines).")
2291 (defvar cperl-speed 'please-ignore-this-line
2292 "This is an incomplete compendium of what is available in other parts
2293 of CPerl documentation. (Please inform me if I skept anything.)
2295 There is a perception that CPerl is slower than alternatives. This part
2296 of documentation is designed to overcome this misconception.
2298 *By default* CPerl tries to enable the most comfortable settings.
2299 From most points of view, correctly working package is infinitely more
2300 comfortable than a non-correctly working one, thus by default CPerl
2301 prefers correctness over speed. Below is the guide how to change
2302 settings if your preferences are different.
2304 A) Speed of loading the file. When loading file, CPerl may perform a
2305 scan which indicates places which cannot be parsed by primitive Emacs
2306 syntax-parsing routines, and marks them up so that either
2308 A1) CPerl may work around these deficiencies (for big chunks, mostly
2309 PODs and HERE-documents), or
2310 A2) On capable Emaxen CPerl will use improved syntax-handlings
2311 which reads mark-up hints directly.
2313 The scan in case A2 is much more comprehensive, thus may be slower.
2315 User can disable syntax-engine-helping scan of A2 by setting
2316 `cperl-use-syntax-table-text-property'
2317 variable to nil (if it is set to t).
2319 One can disable the scan altogether (both A1 and A2) by setting
2320 `cperl-pod-here-scan'
2323 B) Speed of editing operations.
2325 One can add a (minor) speedup to editing operations by setting
2326 `cperl-use-syntax-table-text-property'
2327 variable to nil (if it is set to t). This will disable
2328 syntax-engine-helping scan, thus will make many more Perl
2329 constructs be wrongly recognized by CPerl, thus may lead to
2330 wrongly matched parentheses, wrong indentation, etc.
2332 One can unset `cperl-syntaxify-unwind'. This might speed up editing
2333 of, say, long POD sections.")
2335 (defvar cperl-tips-faces 'please-ignore-this-line
2336 "CPerl mode uses following faces for highlighting:
2338 `cperl-array-face' Array names
2339 `cperl-hash-face' Hash names
2340 `font-lock-comment-face' Comments, PODs and whatever is considered
2341 syntaxically to be not code
2342 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
2343 2-arg operators s/y/tr/ or of RExen,
2344 `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
2345 a target of a file tests, file tests,
2346 subroutine names at the moment of definition
2347 (except those conflicting with Perl operators),
2348 package names (when recognized), format names
2349 `font-lock-keyword-face' Control flow switch constructs, declarators
2350 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
2351 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
2352 literal parts and the terminator of formats
2353 and whatever is syntaxically considered
2355 `font-lock-type-face' Overridable keywords
2356 `font-lock-variable-name-face' Variable declarations, indirect array and
2357 hash names, POD headers/item names
2358 `cperl-invalid-face' Trailing whitespace
2360 Note that in several situations the highlighting tries to inform about
2361 possible confusion, such as different colors for function names in
2362 declarations depending on what they (do not) override, or special cases
2363 m// and s/// which do not do what one would expect them to do.
2365 Help with best setup of these faces for printout requested (for each of
2366 the faces: please specify bold, italic, underline, shadow and box.)
2372 ;;; Portability stuff:
2374 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
2375 (` (define-key cperl-mode-map
2377 (` (if cperl-xemacs-p (, xemacs-key) (, emacs-key)))
2381 (defvar cperl-del-back-ch
2382 (car (append (where-is-internal 'delete-backward-char)
2383 (where-is-internal 'backward-delete-char-untabify)))
2384 "Character generated by key bound to `delete-backward-char'.")
2386 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
2387 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
2389 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
2392 ;; "Active regions" are on: use region only if active
2393 ;; "Active regions" are off: use region unconditionally
2394 (defun cperl-use-region-p ()
2395 (if zmacs-regions (mark) t)))
2396 (defun cperl-use-region-p ()
2397 (if transient-mark-mode mark-active t))
2398 (defun cperl-mark-active () mark-active))
2400 (defsubst cperl-enable-font-lock ()
2401 cperl-can-font-lock)
2403 (defun cperl-putback-char (c) ; Emacs 19
2404 (set 'unread-command-events (list c))) ; Avoid undefined warning
2406 (if (boundp 'unread-command-events)
2408 (defun cperl-putback-char (c) ; XEmacs >= 19.12
2409 (setq unread-command-events (list (eval '(character-to-event c))))))
2410 (defun cperl-putback-char (c) ; XEmacs <= 19.11
2411 (set 'unread-command-event (eval '(character-to-event c))))) ; Avoid warnings
2413 (or (fboundp 'uncomment-region)
2414 (defun uncomment-region (beg end)
2416 (comment-region beg end -1)))
2418 (defvar cperl-do-not-fontify
2419 (if (string< emacs-version "19.30")
2422 "Text property which inhibits refontification.")
2424 (defsubst cperl-put-do-not-fontify (from to &optional post)
2425 ;; If POST, do not do it with postponed fontification
2426 (if (and post cperl-syntaxify-by-font-lock)
2428 (put-text-property (max (point-min) (1- from))
2429 to cperl-do-not-fontify t)))
2431 (defcustom cperl-mode-hook nil
2432 "Hook run by CPerl mode."
2436 (defvar cperl-syntax-state nil)
2437 (defvar cperl-syntax-done-to nil)
2438 (defvar cperl-emacs-can-parse (> (length (save-excursion
2439 (parse-partial-sexp (point) (point)))) 9))
2441 ;; Make customization possible "in reverse"
2442 (defsubst cperl-val (symbol &optional default hairy)
2444 ((eq (symbol-value symbol) 'null) default)
2445 (cperl-hairy (or hairy t))
2446 (t (symbol-value symbol))))
2449 (defun cperl-make-indent (column &optional minimum keep)
2450 "Makes indent of the current line the requested amount.
2451 If ANEW, removes the old indentation. Works around a bug in ancient
2453 (let ((prop (get-text-property (point) 'syntax-type)))
2455 (delete-horizontal-space))
2456 (indent-to column minimum)
2457 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
2459 (> (current-column) 0)
2462 (or (get-text-property (point) 'syntax-type)
2463 (and (looking-at "\\=[ \t]")
2464 (put-text-property (point) (match-end 0)
2465 'syntax-type prop)))))))
2467 ;;; Probably it is too late to set these guys already, but it can help later:
2469 (and cperl-clobber-mode-lists
2470 (setq auto-mode-alist
2471 (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
2472 (and (boundp 'interpreter-mode-alist)
2473 (setq interpreter-mode-alist (append interpreter-mode-alist
2474 '(("miniperl" . perl-mode))))))
2475 (if (fboundp 'eval-when-compile)
2481 '(imenu easymenu etags timer man info))
2482 (if (fboundp 'ps-extend-face-list)
2483 (defmacro cperl-ps-extend-face-list (arg)
2484 (` (ps-extend-face-list (, arg))))
2485 (defmacro cperl-ps-extend-face-list (arg)
2486 (` (error "This version of Emacs has no `ps-extend-face-list'"))))
2487 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
2488 ;; macros instead of defsubsts don't work on Emacs, so we do the
2489 ;; expansion manually. Any other suggestions?
2490 (if cperl-can-font-lock
2491 (require 'font-lock))
2494 (defvar cperl-mode-abbrev-table nil
2495 "Abbrev table in use in CPerl mode buffers.")
2497 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
2499 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
2501 (if cperl-mode-map nil
2502 (setq cperl-mode-map (make-sparse-keymap))
2503 (cperl-define-key "{" 'cperl-electric-lbrace)
2504 (cperl-define-key "[" 'cperl-electric-paren)
2505 (cperl-define-key "(" 'cperl-electric-paren)
2506 (cperl-define-key "<" 'cperl-electric-paren)
2507 (cperl-define-key "}" 'cperl-electric-brace)
2508 (cperl-define-key "]" 'cperl-electric-rparen)
2509 (cperl-define-key ")" 'cperl-electric-rparen)
2510 (cperl-define-key ";" 'cperl-electric-semi)
2511 (cperl-define-key ":" 'cperl-electric-terminator)
2512 (cperl-define-key "\C-j" 'newline-and-indent)
2513 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
2514 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
2515 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
2516 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
2517 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
2518 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
2519 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
2520 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
2521 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
2522 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
2523 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
2524 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
2525 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
2526 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
2527 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
2528 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
2530 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
2531 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
2532 (cperl-define-key "\177" 'cperl-electric-backspace)
2533 (cperl-define-key "\t" 'cperl-indent-command)
2534 ;; don't clobber the backspace binding:
2535 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
2536 [(control c) (control h) F])
2537 (if (cperl-val 'cperl-clobber-lisp-bindings)
2539 (cperl-define-key "\C-hf"
2540 ;;(concat (char-to-string help-char) "f") ; does not work
2541 'cperl-info-on-command
2543 (cperl-define-key "\C-hv"
2544 ;;(concat (char-to-string help-char) "v") ; does not work
2547 (cperl-define-key "\C-c\C-hf"
2548 ;;(concat (char-to-string help-char) "f") ; does not work
2549 (key-binding "\C-hf")
2550 [(control c) (control h) f])
2551 (cperl-define-key "\C-c\C-hv"
2552 ;;(concat (char-to-string help-char) "v") ; does not work
2553 (key-binding "\C-hv")
2554 [(control c) (control h) v]))
2555 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
2556 [(control c) (control h) f])
2557 (cperl-define-key "\C-c\C-hv"
2558 ;;(concat (char-to-string help-char) "v") ; does not work
2560 [(control c) (control h) v]))
2561 (if (and cperl-xemacs-p
2562 (<= emacs-minor-version 11) (<= emacs-major-version 19))
2564 ;; substitute-key-definition is usefulness-deenhanced...
2565 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
2566 (cperl-define-key "\e;" 'cperl-indent-for-comment)
2567 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
2568 (or (boundp 'fill-paragraph-function)
2569 (substitute-key-definition
2570 'fill-paragraph 'cperl-fill-paragraph
2571 cperl-mode-map global-map))
2572 (substitute-key-definition
2573 'indent-sexp 'cperl-indent-exp
2574 cperl-mode-map global-map)
2575 (substitute-key-definition
2576 'indent-region 'cperl-indent-region
2577 cperl-mode-map global-map)
2578 (substitute-key-definition
2579 'indent-for-comment 'cperl-indent-for-comment
2580 cperl-mode-map global-map)))
2583 (defvar cperl-lazy-installed)
2584 (defvar cperl-old-style nil)
2589 cperl-menu cperl-mode-map "Menu for CPerl mode"
2591 ["Beginning of function" beginning-of-defun t]
2592 ["End of function" end-of-defun t]
2593 ["Mark function" mark-defun t]
2594 ["Indent expression" cperl-indent-exp t]
2595 ["Fill paragraph/comment" cperl-fill-paragraph t]
2597 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
2598 ["Invert if/unless/while etc" cperl-invert-if-unless t]
2600 ["Beautify" cperl-beautify-regexp
2601 cperl-use-syntax-table-text-property]
2602 ["Beautify one level deep" (cperl-beautify-regexp 1)
2603 cperl-use-syntax-table-text-property]
2604 ["Beautify a group" cperl-beautify-level
2605 cperl-use-syntax-table-text-property]
2606 ["Beautify a group one level deep" (cperl-beautify-level 1)
2607 cperl-use-syntax-table-text-property]
2608 ["Contract a group" cperl-contract-level
2609 cperl-use-syntax-table-text-property]
2610 ["Contract groups" cperl-contract-levels
2611 cperl-use-syntax-table-text-property])
2612 ["Insert spaces if needed to fix style" cperl-find-bad-style t]
2613 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
2615 ["Indent region" cperl-indent-region (cperl-use-region-p)]
2616 ["Comment region" cperl-comment-region (cperl-use-region-p)]
2617 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
2619 ["Run" mode-compile (fboundp 'mode-compile)]
2620 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
2621 (get-buffer "*compilation*"))]
2622 ["Next error" next-error (get-buffer "*compilation*")]
2623 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
2625 ["Debugger" cperl-db t]
2628 ["Imenu" imenu (fboundp 'imenu)]
2629 ["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
2631 ["Ispell PODs" cperl-pod-spell
2632 ;; Better not to update syntaxification here:
2633 ;; debugging syntaxificatio can be broken by this???
2635 (get-text-property (point-min) 'in-pod)
2637 (and cperl-syntaxify-for-menu
2638 (cperl-update-syntaxification (point-max) (point-max)))
2639 (next-single-property-change (point-min) 'in-pod nil (point-max)))
2641 ["Ispell HERE-DOCs" cperl-here-doc-spell
2643 (and cperl-syntaxify-for-menu
2644 (cperl-update-syntaxification (point-max) (point-max)))
2645 (next-single-property-change (point-min) 'here-doc-group nil (point-max)))
2647 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
2648 (eq 'here-doc (progn
2649 (and cperl-syntaxify-for-menu
2650 (cperl-update-syntaxification (point) (point)))
2651 (get-text-property (point) 'syntax-type)))]
2652 ["Select this HERE-DOC or POD section"
2653 cperl-select-this-pod-or-here-doc
2655 (and cperl-syntaxify-for-menu
2656 (cperl-update-syntaxification (point) (point)))
2657 (get-text-property (point) 'syntax-type))
2660 ["CPerl pretty print (exprmntl)" cperl-ps-print
2661 (fboundp 'ps-extend-face-list)]
2663 ["Syntaxify region" cperl-find-pods-heres-region
2664 (cperl-use-region-p)]
2665 ["Profile syntaxification" cperl-time-fontification t]
2666 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
2667 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t]
2668 ["Debug backtrace on syntactic scan (BEWARE!!!)"
2669 (cperl-toggle-set-debug-unwind nil t) t]
2671 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
2672 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
2674 ;;; ["Create tags for current file" cperl-etags t]
2675 ;;; ["Add tags for current file" (cperl-etags t) t]
2676 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
2677 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
2678 ;;; ["Create tags for Perl files in (sub)directories"
2679 ;;; (cperl-etags nil 'recursive) t]
2680 ;;; ["Add tags for Perl files in (sub)directories"
2681 ;;; (cperl-etags t 'recursive) t])
2682 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
2683 ["Create tags for current file" (cperl-write-tags nil t) t]
2684 ["Add tags for current file" (cperl-write-tags) t]
2685 ["Create tags for Perl files in directory"
2686 (cperl-write-tags nil t nil t) t]
2687 ["Add tags for Perl files in directory"
2688 (cperl-write-tags nil nil nil t) t]
2689 ["Create tags for Perl files in (sub)directories"
2690 (cperl-write-tags nil t t t) t]
2691 ["Add tags for Perl files in (sub)directories"
2692 (cperl-write-tags nil nil t t) t]))
2694 ["Define word at point" imenu-go-find-at-position
2695 (fboundp 'imenu-go-find-at-position)]
2696 ["Help on function" cperl-info-on-command t]
2697 ["Help on function at point" cperl-info-on-current-command t]
2698 ["Help on symbol at point" cperl-get-help t]
2699 ["Perldoc" cperl-perldoc t]
2700 ["Perldoc on word at point" cperl-perldoc-at-point t]
2701 ["View manpage of POD in this file" cperl-build-manpage t]
2702 ["Auto-help on" cperl-lazy-install
2703 (and (fboundp 'run-with-idle-timer)
2704 (not cperl-lazy-installed))]
2705 ["Auto-help off" cperl-lazy-unstall
2706 (and (fboundp 'run-with-idle-timer)
2707 cperl-lazy-installed)])
2709 ["Auto newline" cperl-toggle-auto-newline t]
2710 ["Electric parens" cperl-toggle-electric t]
2711 ["Electric keywords" cperl-toggle-abbrev t]
2712 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
2713 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
2714 ["Auto fill" auto-fill-mode t])
2716 ["CPerl" (cperl-set-style "CPerl") t]
2717 ["PerlStyle" (cperl-set-style "PerlStyle") t]
2718 ["GNU" (cperl-set-style "GNU") t]
2719 ["C++" (cperl-set-style "C++") t]
2720 ["FSF" (cperl-set-style "FSF") t]
2721 ["BSD" (cperl-set-style "BSD") t]
2722 ["Whitesmith" (cperl-set-style "Whitesmith") t]
2723 ["Current" (cperl-set-style "Current") t]
2724 ["Memorized" (cperl-set-style-back) cperl-old-style])
2726 ["Tips" (describe-variable 'cperl-tips) t]
2727 ["Problems" (describe-variable 'cperl-problems) t]
2728 ["Non-problems" (describe-variable 'cperl-non-problems) t]
2729 ["Speed" (describe-variable 'cperl-speed) t]
2730 ["Praise" (describe-variable 'cperl-praise) t]
2731 ["Faces" (describe-variable 'cperl-tips-faces) t]
2732 ["CPerl mode" (describe-function 'cperl-mode) t]
2734 (message "The version of master-file for this CPerl is %s"
2735 cperl-version) t]))))
2738 (autoload 'c-macro-expand "cmacexp"
2739 "Display the result of expanding all C macros occurring in the region.
2740 The expansion is entirely correct because it uses the C preprocessor."
2743 ;;; These two must be unwound, otherwise take exponential time
2744 (defconst cperl-maybe-white-and-comment-rex "[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
2745 "Regular expression to match optional whitespace with interpspersed comments.
2746 Should contain exactly one group.")
2748 ;;; This one is tricky to unwind; still very inefficient...
2749 (defconst cperl-white-and-comment-rex "\\([ \t\n]\\|#[^\n]*\n\\)+"
2750 "Regular expression to match whitespace with interpspersed comments.
2751 Should contain exactly one group.")
2754 ;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
2755 ;;; `cperl-outline-regexp', `defun-prompt-regexp'.
2756 ;;; Details of groups in this may be used in several functions; see comments
2757 ;;; near mentioned above variable(s)...
2758 ;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
2759 (defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
2760 "Match the text after `sub' in a subroutine declaration.
2761 If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
2762 of attributes (if present), or end of the name or prototype (whatever is
2764 (concat ; Assume n groups before this...
2765 "\\(" ; n+1=name-group
2766 cperl-white-and-comment-rex ; n+2=pre-name
2767 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
2768 "\\)" ; END n+1=name-group
2770 "\\(" ; n+4=proto-group
2771 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
2772 "\\(([^()]*)\\)" ; n+6=prototype
2773 "\\)?" ; END n+4=proto-group
2774 "\\(" ; n+7=attr-group
2775 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
2776 "\\(" ; n+9=start-attr
2780 cperl-maybe-white-and-comment-rex ; whitespace-comments
2781 "\\(\\sw\\|_\\)+" ; attr-name
2782 ;; attr-arg (1 level of internal parens allowed!)
2783 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
2784 "\\(" ; optional : (XXX allows trailing???)
2785 cperl-maybe-white-and-comment-rex ; whitespace-comments
2790 "\\)?" ; END n+6=proto-group
2793 ;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
2794 ;;; and `cperl-outline-level'.
2795 ;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
2796 (defvar cperl-imenu--function-name-regexp-perl
2799 "\\([ \t]*package" ; 2 = package-group
2800 "\\(" ; 3 = package-name-group
2801 cperl-white-and-comment-rex ; 4 = pre-package-name
2802 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
2805 (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
2806 cperl-maybe-white-and-comment-rex ; 15=pre-block
2808 "=head\\([1-4]\\)[ \t]+" ; 16=level
2809 "\\([^\n]+\\)$" ; 17=text
2812 (defvar cperl-outline-regexp
2813 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
2815 (defvar cperl-mode-syntax-table nil
2816 "Syntax table in use in CPerl mode buffers.")
2818 (defvar cperl-string-syntax-table nil
2819 "Syntax table in use in CPerl mode string-like chunks.")
2821 (defsubst cperl-1- (p)
2822 (max (point-min) (1- p)))
2824 (defsubst cperl-1+ (p)
2825 (min (point-max) (1+ p)))
2827 (if cperl-mode-syntax-table
2829 (setq cperl-mode-syntax-table (make-syntax-table))
2830 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
2831 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
2832 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
2833 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
2834 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
2835 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
2836 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
2837 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
2838 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
2839 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
2840 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
2841 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
2842 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
2843 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
2844 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
2845 (if cperl-under-as-char
2846 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
2847 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
2848 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
2849 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
2850 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
2851 (modify-syntax-entry ?\{ "." cperl-string-syntax-table)
2852 (modify-syntax-entry ?\} "." cperl-string-syntax-table)
2853 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
2857 ;; provide an alias for working with emacs 19. the perl-mode that comes
2858 ;; with it is really bad, and this lets us seamlessly replace it.
2860 (fset 'perl-mode 'cperl-mode)
2861 (defvar cperl-faces-init nil)
2863 (defvar cperl-msb-fixed nil)
2864 (defvar font-lock-syntactic-keywords)
2865 (defvar perl-font-lock-keywords)
2866 (defvar perl-font-lock-keywords-1)
2867 (defvar perl-font-lock-keywords-2)
2868 (defvar outline-level)
2869 (if (fboundp 'defvaralias)
2870 (let ((f 'defvaralias)) ; Some functions deduce stuff from the mode name...
2871 (funcall f 'cperl-font-lock-keywords 'perl-font-lock-keywords)
2872 (funcall f 'cperl-font-lock-keywords-1 'perl-font-lock-keywords-1)
2873 (funcall f 'cperl-font-lock-keywords-2 'perl-font-lock-keywords-2)))
2875 (defvar cperl-use-major-mode 'perl-mode)
2876 (defvar cperl-font-lock-multiline-start nil)
2877 (defvar cperl-font-lock-multiline nil)
2878 (defvar cperl-compilation-error-regexp-alist nil)
2879 (defvar cperl-font-locking nil)
2882 (defun cperl-mode ()
2883 "Major mode for editing Perl code.
2884 Expression and list commands understand all C brackets.
2885 Tab indents for Perl code.
2886 Paragraphs are separated by blank lines only.
2887 Delete converts tabs to spaces as it moves back.
2889 Various characters in Perl almost always come in pairs: {}, (), [],
2890 sometimes <>. When the user types the first, she gets the second as
2891 well, with optional special formatting done on {}. (Disabled by
2892 default.) You can always quote (with \\[quoted-insert]) the left
2893 \"paren\" to avoid the expansion. The processing of < is special,
2894 since most the time you mean \"less\". CPerl mode tries to guess
2895 whether you want to type pair <>, and inserts is if it
2896 appropriate. You can set `cperl-electric-parens-string' to the string that
2897 contains the parenths from the above list you want to be electrical.
2898 Electricity of parenths is controlled by `cperl-electric-parens'.
2899 You may also set `cperl-electric-parens-mark' to have electric parens
2900 look for active mark and \"embrace\" a region if possible.'
2902 CPerl mode provides expansion of the Perl control constructs:
2904 if, else, elsif, unless, while, until, continue, do,
2905 for, foreach, formy and foreachmy.
2907 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
2909 The user types the keyword immediately followed by a space, which
2910 causes the construct to be expanded, and the point is positioned where
2911 she is most likely to want to be. eg. when the user types a space
2912 following \"if\" the following appears in the buffer: if () { or if ()
2913 } { } and the cursor is between the parentheses. The user can then
2914 type some boolean expression within the parens. Having done that,
2915 typing \\[cperl-linefeed] places you - appropriately indented - on a
2916 new line between the braces (if you typed \\[cperl-linefeed] in a POD
2917 directive line, then appropriate number of new lines is inserted).
2919 If CPerl decides that you want to insert \"English\" style construct like
2923 it will not do any expansion. See also help on variable
2924 `cperl-extra-newline-before-brace'. (Note that one can switch the
2925 help message on expansion by setting `cperl-message-electric-keyword'
2928 \\[cperl-linefeed] is a convenience replacement for typing carriage
2929 return. It places you in the next line with proper indentation, or if
2930 you type it inside the inline block of control construct, like
2932 foreach (@lines) {print; print}
2934 and you are on a boundary of a statement inside braces, it will
2935 transform the construct into a multiline and will place you into an
2936 appropriately indented blank line. If you need a usual
2937 `newline-and-indent' behaviour, it is on \\[newline-and-indent],
2938 see documentation on `cperl-electric-linefeed'.
2940 Use \\[cperl-invert-if-unless] to change a construction of the form
2950 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
2951 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
2952 on electric space between $ and {, `cperl-electric-parens-string' is
2953 the string that contains parentheses that should be electric in CPerl
2954 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
2955 setting `cperl-electric-keywords' enables electric expansion of
2956 control structures in CPerl. `cperl-electric-linefeed' governs which
2957 one of two linefeed behavior is preferable. You can enable all these
2958 options simultaneously (recommended mode of use) by setting
2959 `cperl-hairy' to t. In this case you can switch separate options off
2960 by setting them to `null'. Note that one may undo the extra
2961 whitespace inserted by semis and braces in `auto-newline'-mode by
2962 consequent \\[cperl-electric-backspace].
2964 If your site has perl5 documentation in info format, you can use commands
2965 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
2966 These keys run commands `cperl-info-on-current-command' and
2967 `cperl-info-on-command', which one is which is controlled by variable
2968 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
2969 \(in turn affected by `cperl-hairy').
2971 Even if you have no info-format documentation, short one-liner-style
2972 help is available on \\[cperl-get-help], and one can run perldoc or
2975 It is possible to show this help automatically after some idle time.
2976 This is regulated by variable `cperl-lazy-help-time'. Default with
2977 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
2978 secs idle time . It is also possible to switch this on/off from the
2979 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
2981 Use \\[cperl-lineup] to vertically lineup some construction - put the
2982 beginning of the region at the start of construction, and make region
2983 span the needed amount of lines.
2985 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
2986 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
2987 here-docs sections. With capable Emaxen results of scan are used
2988 for indentation too, otherwise they are used for highlighting only.
2990 Variables controlling indentation style:
2991 `cperl-tab-always-indent'
2992 Non-nil means TAB in CPerl mode should always reindent the current line,
2993 regardless of where in the line point is when the TAB command is used.
2994 `cperl-indent-left-aligned-comments'
2995 Non-nil means that the comment starting in leftmost column should indent.
2996 `cperl-auto-newline'
2997 Non-nil means automatically newline before and after braces,
2998 and after colons and semicolons, inserted in Perl code. The following
2999 \\[cperl-electric-backspace] will remove the inserted whitespace.
3000 Insertion after colons requires both this variable and
3001 `cperl-auto-newline-after-colon' set.
3002 `cperl-auto-newline-after-colon'
3003 Non-nil means automatically newline even after colons.
3004 Subject to `cperl-auto-newline' setting.
3005 `cperl-indent-level'
3006 Indentation of Perl statements within surrounding block.
3007 The surrounding block's indentation is the indentation
3008 of the line on which the open-brace appears.
3009 `cperl-continued-statement-offset'
3010 Extra indentation given to a substatement, such as the
3011 then-clause of an if, or body of a while, or just a statement continuation.
3012 `cperl-continued-brace-offset'
3013 Extra indentation given to a brace that starts a substatement.
3014 This is in addition to `cperl-continued-statement-offset'.
3015 `cperl-brace-offset'
3016 Extra indentation for line if it starts with an open brace.
3017 `cperl-brace-imaginary-offset'
3018 An open brace following other text is treated as if it the line started
3019 this far to the right of the actual line indentation.
3020 `cperl-label-offset'
3021 Extra indentation for line that is a label.
3022 `cperl-min-label-indent'
3023 Minimal indentation for line that is a label.
3025 Settings for K&R and BSD indentation styles are
3026 `cperl-indent-level' 5 8
3027 `cperl-continued-statement-offset' 5 8
3028 `cperl-brace-offset' -5 -8
3029 `cperl-label-offset' -5 -8
3031 CPerl knows several indentation styles, and may bulk set the
3032 corresponding variables. Use \\[cperl-set-style] to do this. Use
3033 \\[cperl-set-style-back] to restore the memorized preexisting values
3034 \(both available from menu).
3036 If `cperl-indent-level' is 0, the statement after opening brace in
3037 column 0 is indented on
3038 `cperl-brace-offset'+`cperl-continued-statement-offset'.
3040 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
3043 DO NOT FORGET to read micro-docs (available from `Perl' menu)
3044 or as help on variables `cperl-tips', `cperl-problems',
3045 `cperl-non-problems', `cperl-praise', `cperl-speed'."
3047 (kill-all-local-variables)
3048 (use-local-map cperl-mode-map)
3049 (if (cperl-val 'cperl-electric-linefeed)
3051 (local-set-key "\C-J" 'cperl-linefeed)
3052 (local-set-key "\C-C\C-J" 'newline-and-indent)))
3054 (cperl-val 'cperl-clobber-lisp-bindings)
3055 (cperl-val 'cperl-info-on-command-no-prompt))
3057 ;; don't clobber the backspace binding:
3058 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
3059 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
3060 [(control c) (control h) f])))
3061 (setq major-mode cperl-use-major-mode)
3062 (setq mode-name "CPerl")
3063 (if (not cperl-mode-abbrev-table)
3064 (let ((prev-a-c abbrevs-changed))
3065 (define-abbrev-table 'cperl-mode-abbrev-table '(
3066 ("if" "if" cperl-electric-keyword 0)
3067 ("elsif" "elsif" cperl-electric-keyword 0)
3068 ("while" "while" cperl-electric-keyword 0)
3069 ("until" "until" cperl-electric-keyword 0)
3070 ("unless" "unless" cperl-electric-keyword 0)
3071 ("else" "else" cperl-electric-else 0)
3072 ("continue" "continue" cperl-electric-else 0)
3073 ("for" "for" cperl-electric-keyword 0)
3074 ("foreach" "foreach" cperl-electric-keyword 0)
3075 ("formy" "formy" cperl-electric-keyword 0)
3076 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
3077 ("do" "do" cperl-electric-keyword 0)
3078 ("=pod" "=pod" cperl-electric-pod 0)
3079 ("=over" "=over" cperl-electric-pod 0)
3080 ("=head1" "=head1" cperl-electric-pod 0)
3081 ("=head2" "=head2" cperl-electric-pod 0)
3082 ("pod" "pod" cperl-electric-pod 0)
3083 ("over" "over" cperl-electric-pod 0)
3084 ("head1" "head1" cperl-electric-pod 0)
3085 ("head2" "head2" cperl-electric-pod 0)))
3086 (setq abbrevs-changed prev-a-c)))
3087 (setq local-abbrev-table cperl-mode-abbrev-table)
3088 (if (cperl-val 'cperl-electric-keywords)
3090 (set-syntax-table cperl-mode-syntax-table)
3091 ;; Until Emacs is multi-threaded, we do not actually need it local:
3092 (make-local-variable 'cperl-font-lock-multiline-start)
3093 (make-local-variable 'cperl-font-locking)
3094 (make-local-variable 'outline-regexp)
3095 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
3096 (setq outline-regexp cperl-outline-regexp)
3097 (make-local-variable 'outline-level)
3098 (setq outline-level 'cperl-outline-level)
3099 (make-local-variable 'paragraph-start)
3100 (setq paragraph-start (concat "^$\\|" page-delimiter))
3101 (make-local-variable 'paragraph-separate)
3102 (setq paragraph-separate paragraph-start)
3103 (make-local-variable 'paragraph-ignore-fill-prefix)
3104 (setq paragraph-ignore-fill-prefix t)
3107 (make-local-variable 'paren-backwards-message)
3108 (set 'paren-backwards-message t)))
3109 (make-local-variable 'indent-line-function)
3110 (setq indent-line-function 'cperl-indent-line)
3111 (make-local-variable 'require-final-newline)
3112 (setq require-final-newline t)
3113 (make-local-variable 'comment-start)
3114 (setq comment-start "# ")
3115 (make-local-variable 'comment-end)
3116 (setq comment-end "")
3117 (make-local-variable 'comment-column)
3118 (setq comment-column cperl-comment-column)
3119 (make-local-variable 'comment-start-skip)
3120 (setq comment-start-skip "#+ *")
3121 (make-local-variable 'defun-prompt-regexp)
3123 ;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
3124 ;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
3125 (setq defun-prompt-regexp
3127 (cperl-after-sub-regexp 'named 'attr-groups)
3128 cperl-maybe-white-and-comment-rex))
3129 (make-local-variable 'comment-indent-function)
3130 (setq comment-indent-function 'cperl-comment-indent)
3131 (and (boundp 'fill-paragraph-function)
3133 (make-local-variable 'fill-paragraph-function)
3134 (set 'fill-paragraph-function 'cperl-fill-paragraph)))
3135 (make-local-variable 'parse-sexp-ignore-comments)
3136 (setq parse-sexp-ignore-comments t)
3137 (make-local-variable 'indent-region-function)
3138 (setq indent-region-function 'cperl-indent-region)
3139 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
3140 (make-local-variable 'imenu-create-index-function)
3141 (setq imenu-create-index-function
3142 (function cperl-imenu--create-perl-index))
3143 (make-local-variable 'imenu-sort-function)
3144 (setq imenu-sort-function nil)
3145 (make-local-variable 'vc-rcs-header)
3146 (set 'vc-rcs-header cperl-vc-rcs-header)
3147 (make-local-variable 'vc-sccs-header)
3148 (set 'vc-sccs-header cperl-vc-sccs-header)
3149 ;; This one is obsolete...
3150 (make-local-variable 'vc-header-alist)
3151 (set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
3152 (` ((SCCS (, (car cperl-vc-sccs-header)))
3153 (RCS (, (car cperl-vc-rcs-header)))))))
3154 (make-local-variable 'font-lock-defaults)
3155 (setq font-lock-defaults
3157 ((string< emacs-version "19.30")
3158 '(perl-font-lock-keywords-2 nil nil ((?_ . "w"))))
3159 ((string< emacs-version "19.33") ; Which one to use?
3160 '((perl-font-lock-keywords
3161 perl-font-lock-keywords-1
3162 perl-font-lock-keywords-2) nil nil ((?_ . "w"))))
3164 '((cperl-load-font-lock-keywords
3165 cperl-load-font-lock-keywords-1
3166 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
3167 (make-local-variable 'cperl-syntax-state)
3168 (setq cperl-syntax-state nil) ; reset syntaxification cache
3169 (if cperl-use-syntax-table-text-property
3171 (make-local-variable 'parse-sexp-lookup-properties)
3172 ;; Do not introduce variable if not needed, we check it!
3173 (set 'parse-sexp-lookup-properties t)
3174 ;; Fix broken font-lock:
3175 (or (boundp 'font-lock-unfontify-region-function)
3176 (set 'font-lock-unfontify-region-function
3177 'font-lock-default-unfontify-region))
3178 (unless cperl-xemacs-p ; Our: just a plug for wrong font-lock
3179 (make-local-variable 'font-lock-unfontify-region-function)
3180 (set 'font-lock-unfontify-region-function ; not present with old Emacs
3181 'cperl-font-lock-unfontify-region-function))
3182 (make-local-variable 'cperl-syntax-done-to)
3183 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
3184 ;; Another bug: unless font-lock-syntactic-keywords, font-lock
3185 ;; ignores syntax-table text-property. (t) is a hack
3186 ;; to make font-lock think that font-lock-syntactic-keywords
3188 (make-local-variable 'font-lock-syntactic-keywords)
3189 (setq font-lock-syntactic-keywords
3190 (if cperl-syntaxify-by-font-lock
3191 '(t (cperl-fontify-syntaxically))
3193 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
3195 (setq cperl-font-lock-multiline t) ; Not localized...
3196 (set 'font-lock-multiline t)) ; not present with old Emacs; auto-local
3197 (make-local-variable 'font-lock-fontify-region-function)
3198 (set 'font-lock-fontify-region-function ; not present with old Emacs
3199 'cperl-font-lock-fontify-region-function))
3200 (make-local-variable 'font-lock-fontify-region-function)
3201 (set 'font-lock-fontify-region-function ; not present with old Emacs
3202 'cperl-font-lock-fontify-region-function)
3203 (make-local-variable 'cperl-old-style)
3204 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
3205 (set (make-local-variable 'normal-auto-fill-function)
3206 'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
3207 (or (fboundp 'cperl-old-auto-fill-mode)
3209 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
3210 (defun auto-fill-mode (&optional arg)
3212 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
3213 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
3214 (setq auto-fill-function 'cperl-do-auto-fill))))))
3215 (if (cperl-enable-font-lock)
3216 (if (cperl-val 'cperl-font-lock)
3217 (progn (or cperl-faces-init (cperl-init-faces))
3218 (font-lock-mode 1))))
3219 (set (make-local-variable 'facemenu-add-face-function)
3220 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
3221 (and (boundp 'msb-menu-cond)
3222 (not cperl-msb-fixed)
3224 (if (featurep 'easymenu)
3225 (easy-menu-add cperl-menu)) ; A NOP in RMS Emacs.
3226 (run-hooks 'cperl-mode-hook)
3227 (if cperl-hook-after-change
3229 (make-local-hook 'after-change-functions)
3230 (add-hook 'after-change-functions 'cperl-after-change-function nil t)))
3231 ;; After hooks since fontification will break this
3232 (if cperl-pod-here-scan
3233 (or cperl-syntaxify-by-font-lock
3234 (progn (or cperl-faces-init (cperl-init-faces-weak))
3235 (cperl-find-pods-heres)))))
3237 ;; Fix for perldb - make default reasonable
3241 (perldb (read-from-minibuffer "Run perldb (like this): "
3242 (if (consp gud-perldb-history)
3243 (car gud-perldb-history)
3244 (concat "perl " ;;(file-name-nondirectory
3248 (buffer-file-name)))
3250 '(gud-perldb-history . 1))))
3252 (defun cperl-msb-fix ()
3253 ;; Adds perl files to msb menu, supposes that msb is already loaded
3254 (setq cperl-msb-fixed t)
3255 (let* ((l (length msb-menu-cond))
3256 (last (nth (1- l) msb-menu-cond))
3257 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
3258 (handle (1- (nth 1 last))))
3259 (setcdr precdr (list
3261 '(memq major-mode '(cperl-mode perl-mode))
3266 ;; This is used by indent-for-comment
3267 ;; to decide how much to indent a comment in CPerl code
3268 ;; based on its context. Do fallback if comment is found wrong.
3270 (defvar cperl-wrong-comment)
3271 (defvar cperl-st-cfence '(14)) ; Comment-fence
3272 (defvar cperl-st-sfence '(15)) ; String-fence
3273 (defvar cperl-st-punct '(1))
3274 (defvar cperl-st-word '(2))
3275 (defvar cperl-st-bra '(4 . ?\>))
3276 (defvar cperl-st-ket '(5 . ?\<))
3279 (defun cperl-comment-indent ()
3280 (let ((p (point)) (c (current-column)) was phony)
3281 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
3282 ;; Wrong comment found
3284 (setq was (cperl-to-comment-or-eol)
3285 phony (eq (get-text-property (point) 'syntax-table)
3289 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
3290 (if (eq (preceding-char) ?\#)
3295 (skip-chars-backward " \t")
3296 (max (1+ (current-column)) ; Else indent at comment column
3299 (insert comment-start)
3300 (backward-char (length comment-start)))
3301 (setq cperl-wrong-comment t)
3302 (cperl-make-indent comment-column 1 'keep) ; Indent minimum 1
3303 c))))) ; except leave at least one space.
3305 ;;;(defun cperl-comment-indent-fallback ()
3306 ;;; "Is called if the standard comment-search procedure fails.
3307 ;;;Point is at start of real comment."
3308 ;;; (let ((c (current-column)) target cnt prevc)
3309 ;;; (if (= c comment-column) nil
3310 ;;; (setq cnt (skip-chars-backward "[ \t]"))
3311 ;;; (setq target (max (1+ (setq prevc
3312 ;;; (current-column))) ; Else indent at comment column
3313 ;;; comment-column))
3314 ;;; (if (= c comment-column) nil
3315 ;;; (delete-backward-char cnt)
3316 ;;; (while (< prevc target)
3318 ;;; (setq prevc (current-column)))
3319 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
3320 ;;; (while (< prevc target)
3322 ;;; (setq prevc (current-column)))))))
3324 (defun cperl-indent-for-comment ()
3325 "Substitute for `indent-for-comment' in CPerl."
3327 (let (cperl-wrong-comment)
3328 (indent-for-comment)
3329 (if cperl-wrong-comment ; set by `cperl-comment-indent'
3330 (progn (cperl-to-comment-or-eol)
3331 (forward-char (length comment-start))))))
3333 (defun cperl-comment-region (b e arg)
3334 "Comment or uncomment each line in the region in CPerl mode.
3335 See `comment-region'."
3336 (interactive "r\np")
3337 (let ((comment-start "#"))
3338 (comment-region b e arg)))
3340 (defun cperl-uncomment-region (b e arg)
3341 "Uncomment or comment each line in the region in CPerl mode.
3342 See `comment-region'."
3343 (interactive "r\np")
3344 (let ((comment-start "#"))
3345 (comment-region b e (- arg))))
3347 (defvar cperl-brace-recursing nil)
3349 (defun cperl-electric-brace (arg &optional only-before)
3350 "Insert character and correct line's indentation.
3351 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
3352 place (even in empty line), but not after. If after \")\" and the inserted
3353 char is \"{\", insert extra newline before only if
3354 `cperl-extra-newline-before-brace'."
3357 (other-end (if (and cperl-electric-parens-mark
3363 (not cperl-brace-recursing)
3364 (cperl-val 'cperl-electric-parens)
3365 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
3366 ;; Need to insert a matching pair
3369 (setq insertpos (point-marker))
3370 (goto-char other-end)
3371 (setq last-command-char ?\{)
3372 (cperl-electric-lbrace arg insertpos))
3374 ;; Check whether we close something "usual" with `}'
3375 (if (and (eq last-command-char ?\})
3379 (up-list (- (prefix-numeric-value arg)))
3380 ;;(cperl-after-block-p (point-min))
3381 (or (cperl-after-expr-p nil "{;)")
3382 ;; after sub, else, continue
3383 (cperl-after-block-p nil 'pre)))
3385 ;; Just insert the guy
3386 (self-insert-command (prefix-numeric-value arg))
3387 (if (and (not arg) ; No args, end (of empty line or auto)
3389 (or (and (null only-before)
3391 (skip-chars-backward " \t")
3393 (and (eq last-command-char ?\{) ; Do not insert newline
3394 ;; if after ")" and `cperl-extra-newline-before-brace'
3395 ;; is nil, do not insert extra newline.
3396 (not cperl-extra-newline-before-brace)
3398 (skip-chars-backward " \t")
3399 (eq (preceding-char) ?\))))
3400 (if cperl-auto-newline
3401 (progn (cperl-indent-line) (newline) t) nil)))
3403 (self-insert-command (prefix-numeric-value arg))
3405 (if cperl-auto-newline
3406 (setq insertpos (1- (point))))
3407 (if (and cperl-auto-newline (null only-before))
3410 (cperl-indent-line)))
3412 (if insertpos (progn (goto-char insertpos)
3413 (search-forward (make-string
3414 1 last-command-char))
3415 (setq insertpos (1- (point)))))
3419 (goto-char insertpos)
3420 (self-insert-command (prefix-numeric-value arg)))
3421 (self-insert-command (prefix-numeric-value arg)))))))
3423 (defun cperl-electric-lbrace (arg &optional end)
3424 "Insert character, correct line's indentation, correct quoting by space."
3426 (let ((cperl-brace-recursing t)
3427 (cperl-auto-newline cperl-auto-newline)
3429 (if (and cperl-electric-parens-mark
3437 (and (cperl-val 'cperl-electric-lbrace-space)
3438 (eq (preceding-char) ?$)
3440 (skip-chars-backward "$")
3441 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
3443 ;; Check whether we are in comment
3447 (not (looking-at "[ \t]*#")))
3448 (cperl-after-expr-p nil "{;)"))
3450 (setq cperl-auto-newline nil))
3451 (cperl-electric-brace arg)
3452 (and (cperl-val 'cperl-electric-parens)
3453 (eq last-command-char ?{)
3454 (memq last-command-char
3455 (append cperl-electric-parens-string nil))
3456 (or (if other-end (goto-char (marker-position other-end)))
3458 (setq last-command-char ?} pos (point))
3459 (progn (cperl-electric-brace arg t)
3462 (defun cperl-electric-paren (arg)
3463 "Insert an opening parenthesis or a matching pair of parentheses.
3464 See `cperl-electric-parens'."
3466 (let ((beg (save-excursion (beginning-of-line) (point)))
3467 (other-end (if (and cperl-electric-parens-mark
3474 (if (and (cperl-val 'cperl-electric-parens)
3475 (memq last-command-char
3476 (append cperl-electric-parens-string nil))
3477 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
3478 ;;(not (save-excursion (search-backward "#" beg t)))
3479 (if (eq last-command-char ?<)
3481 (and abbrev-mode ; later it is too late, may be after `for'
3483 (cperl-after-expr-p nil "{;(,:="))
3486 (self-insert-command (prefix-numeric-value arg))
3487 (if other-end (goto-char (marker-position other-end)))
3488 (insert (make-string
3489 (prefix-numeric-value arg)
3490 (cdr (assoc last-command-char '((?{ .?})
3494 (forward-char (- (prefix-numeric-value arg))))
3495 (self-insert-command (prefix-numeric-value arg)))))
3497 (defun cperl-electric-rparen (arg)
3498 "Insert a matching pair of parentheses if marking is active.
3499 If not, or if we are not at the end of marking range, would self-insert.
3500 Affected by `cperl-electric-parens'."
3502 (let ((beg (save-excursion (beginning-of-line) (point)))
3503 (other-end (if (and cperl-electric-parens-mark
3504 (cperl-val 'cperl-electric-parens)
3505 (memq last-command-char
3506 (append cperl-electric-parens-string nil))
3513 (cperl-val 'cperl-electric-parens)
3514 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
3515 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
3516 ;;(not (save-excursion (search-backward "#" beg t)))
3519 (self-insert-command (prefix-numeric-value arg))
3521 (if other-end (goto-char other-end))
3522 (insert (make-string
3523 (prefix-numeric-value arg)
3524 (cdr (assoc last-command-char '((?\} . ?\{)
3529 (self-insert-command (prefix-numeric-value arg)))))
3531 (defun cperl-electric-keyword ()
3532 "Insert a construction appropriate after a keyword.
3533 Help message may be switched off by setting `cperl-message-electric-keyword'
3535 (let ((beg (save-excursion (beginning-of-line) (point)))
3536 (dollar (and (eq last-command-char ?$)
3537 (eq this-command 'self-insert-command)))
3538 (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3539 (memq this-command '(self-insert-command newline))))
3541 (and (save-excursion
3545 (setq do (looking-at "do\\>")))
3547 (cperl-after-expr-p nil "{;:"))
3551 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
3553 (save-excursion (or (not (re-search-backward "^=" nil t))
3556 (and cperl-use-syntax-table-text-property
3557 (not (eq (get-text-property (point)
3560 (save-excursion (forward-sexp -1)
3561 (not (memq (following-char) (append "$@%&*" nil))))
3563 (and (eq (preceding-char) ?y)
3564 (progn ; "foreachmy"
3570 (memq this-command '(self-insert-command newline)))))
3571 (and dollar (insert " $"))
3573 ;;(insert " () {\n}")
3575 (cperl-extra-newline-before-brace
3576 (insert (if do "\n" " ()\n"))
3582 (and do (insert " while ();")))
3584 (insert (if do " {\n} while ();" " () {\n}"))))
3585 (or (looking-at "[ \t]\\|$") (insert " "))
3587 (if dollar (progn (search-backward "$")
3591 (search-backward ")")
3592 (if (eq last-command-char ?\()
3593 (progn ; Avoid "if (())"
3594 (delete-backward-char 1)
3595 (delete-backward-char -1))))
3597 (cperl-putback-char cperl-del-back-ch))
3598 (if cperl-message-electric-keyword
3599 (message "Precede char by C-q to avoid expansion"))))))
3601 (defun cperl-ensure-newlines (n &optional pos)
3602 "Make sure there are N newlines after the point."
3603 (or pos (setq pos (point)))
3604 (if (looking-at "\n")
3608 (cperl-ensure-newlines (1- n) pos)
3611 (defun cperl-electric-pod ()
3612 "Insert a POD chunk appropriate after a =POD directive."
3613 (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3614 (memq this-command '(self-insert-command newline))))
3615 head1 notlast name p really-delete over)
3616 (and (save-excursion
3619 (eq (preceding-char) ?=)
3621 (setq head1 (looking-at "head1\\>[ \t]*$"))
3622 (setq over (and (looking-at "over\\>[ \t]*$")
3623 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
3627 (get-text-property (point) 'in-pod)
3628 (cperl-after-expr-p nil "{;:")
3629 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
3630 (not (looking-at "\n*=cut"))
3631 (or (not cperl-use-syntax-table-text-property)
3632 (eq (get-text-property (point) 'syntax-type) 'pod))))))
3635 (setq notlast (re-search-forward "^\n=" nil t)))
3639 (cperl-ensure-newlines 2)
3645 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
3646 nil t)))) ; Only one
3649 (setq name (file-name-sans-extension
3650 (file-name-nondirectory (buffer-file-name)))
3652 (insert " NAME\n\n" name
3653 " - \n\n=head1 SYNOPSIS\n\n\n\n"
3654 "=head1 DESCRIPTION")
3655 (cperl-ensure-newlines 4)
3659 (setq really-delete t))
3664 (insert "\n\n=item \n\n\n\n"
3666 (cperl-ensure-newlines 2)
3670 (setq really-delete t)))
3671 (if (and delete really-delete)
3672 (cperl-putback-char cperl-del-back-ch))))))
3674 (defun cperl-electric-else ()
3675 "Insert a construction appropriate after a keyword.
3676 Help message may be switched off by setting `cperl-message-electric-keyword'
3678 (let ((beg (save-excursion (beginning-of-line) (point))))
3679 (and (save-excursion
3681 (cperl-after-expr-p nil "{;:"))
3685 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
3687 (save-excursion (or (not (re-search-backward "^=" nil t))
3689 (and cperl-use-syntax-table-text-property
3690 (not (eq (get-text-property (point)
3695 ;;(insert " {\n\n}")
3697 (cperl-extra-newline-before-brace
3703 (insert " {\n\n}")))
3704 (or (looking-at "[ \t]\\|$") (insert " "))
3708 (cperl-putback-char cperl-del-back-ch)
3709 (setq this-command 'cperl-electric-else)
3710 (if cperl-message-electric-keyword
3711 (message "Precede char by C-q to avoid expansion"))))))
3713 (defun cperl-linefeed ()
3714 "Go to end of line, open a new line and indent appropriately.
3715 If in POD, insert appropriate lines."
3717 (let ((beg (save-excursion (beginning-of-line) (point)))
3718 (end (save-excursion (end-of-line) (point)))
3719 (pos (point)) start over cut res)
3720 (if (and ; Check if we need to split:
3721 ; i.e., on a boundary and inside "{...}"
3722 (save-excursion (cperl-to-comment-or-eol)
3723 (>= (point) pos)) ; Not in a comment
3725 (skip-chars-backward " \t" beg)
3727 (looking-at "[;{]")) ; After { or ; + spaces
3728 (looking-at "[ \t]*}") ; Before }
3729 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
3732 (eq (car (parse-partial-sexp pos end -1)) -1)
3733 ; Leave the level of parens
3734 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
3736 (cperl-after-block-p (point-min))
3739 (setq start (point-marker))
3740 (<= start pos))))) ; Redundant? Are after the
3741 ; start of parens group.
3743 (skip-chars-backward " \t")
3744 (or (memq (preceding-char) (append ";{" nil))
3750 (or (looking-at "{[ \t]*$") ; If there is a statement
3751 ; before, move it to separate line
3755 (cperl-indent-line)))
3756 (forward-line 1) ; We are on the target line
3759 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
3760 ; after, move it to separate line
3763 (search-backward "}" beg)
3764 (skip-chars-backward " \t")
3765 (or (memq (preceding-char) (append ";{" nil))
3770 (forward-line -1) ; We are on the line before target
3772 (newline-and-indent))
3773 (end-of-line) ; else - no splitting
3775 ((and (looking-at "\n[ \t]*{$")
3777 (skip-chars-backward " \t")
3778 (eq (preceding-char) ?\)))) ; Probably if () {} group
3779 ; with an extra newline.
3781 (cperl-indent-line))
3782 ((save-excursion ; In POD header
3783 (forward-paragraph -1)
3784 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
3785 ;; We are after \n now, so look for the rest
3786 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
3788 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
3789 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
3793 (forward-paragraph -1)
3796 (setq cut (buffer-substring (point)
3800 (delete-char (- (save-excursion (end-of-line) (point))
3802 (setq res (expand-abbrev))
3808 (cperl-ensure-newlines (if cut 2 4))
3810 ((get-text-property (point) 'in-pod) ; In POD section
3811 (cperl-ensure-newlines 4)
3813 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
3815 (cperl-indent-line))
3817 (newline-and-indent))))))
3819 (defun cperl-electric-semi (arg)
3820 "Insert character and correct line's indentation."
3822 (if cperl-auto-newline
3823 (cperl-electric-terminator arg)
3824 (self-insert-command (prefix-numeric-value arg))
3825 (if cperl-autoindent-on-semi
3826 (cperl-indent-line))))
3828 (defun cperl-electric-terminator (arg)
3829 "Insert character and correct line's indentation."
3832 (auto (and cperl-auto-newline
3833 (or (not (eq last-command-char ?:))
3834 cperl-auto-newline-after-colon)))
3836 (if (and ;;(not arg)
3838 (not (save-excursion
3840 (skip-chars-forward " \t")
3842 ;; Ignore in comment lines
3843 (= (following-char) ?#)
3844 ;; Colon is special only after a label
3845 ;; So quickly rule out most other uses of colon
3846 ;; and do no indentation for them.
3847 (and (eq last-command-char ?:)
3850 (skip-chars-forward " \t")
3851 (and (< (point) end)
3852 (progn (goto-char (- end 1))
3853 (not (looking-at ":"))))))
3855 (beginning-of-defun)
3856 (let ((pps (parse-partial-sexp (point) end)))
3857 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
3859 (self-insert-command (prefix-numeric-value arg))
3861 (if auto (setq insertpos (point-marker)))
3867 (cperl-indent-line)))
3869 (if insertpos (goto-char (1- (marker-position insertpos)))
3874 (goto-char insertpos)
3875 (self-insert-command (prefix-numeric-value arg)))
3876 (self-insert-command (prefix-numeric-value arg)))))
3878 (defun cperl-electric-backspace (arg)
3879 "Backspace, or remove the whitespace around the point inserted by an electric
3880 key. Will untabivy if `cperl-electric-backspace-untabify' is non-nil."
3882 (if (and cperl-auto-newline
3883 (memq last-command '(cperl-electric-semi
3884 cperl-electric-terminator
3885 cperl-electric-lbrace))
3886 (memq (preceding-char) '(?\ ?\t ?\n)))
3888 (if (eq last-command 'cperl-electric-lbrace)
3889 (skip-chars-forward " \t\n"))
3891 (skip-chars-backward " \t\n")
3892 (delete-region (point) p))
3893 (and (eq last-command 'cperl-electric-else)
3894 ;; We are removing the whitespace *inside* cperl-electric-else
3895 (setq this-command 'cperl-electric-else-really))
3896 (if (and cperl-auto-newline
3897 (eq last-command 'cperl-electric-else-really)
3898 (memq (preceding-char) '(?\ ?\t ?\n)))
3900 (skip-chars-forward " \t\n")
3902 (skip-chars-backward " \t\n")
3903 (delete-region (point) p))
3904 (if cperl-electric-backspace-untabify
3905 (backward-delete-char-untabify arg)
3906 (delete-backward-char arg)))))
3908 (defun cperl-inside-parens-p () ;; NOT USED????
3912 (narrow-to-region (point)
3913 (progn (beginning-of-defun) (point)))
3914 (goto-char (point-max))
3915 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
3918 (defun cperl-indent-command (&optional whole-exp)
3919 "Indent current line as Perl code, or in some cases insert a tab character.
3920 If `cperl-tab-always-indent' is non-nil (the default), always indent current
3921 line. Otherwise, indent the current line only if point is at the left margin
3922 or in the line's indentation; otherwise insert a tab.
3924 A numeric argument, regardless of its value,
3925 means indent rigidly all the lines of the expression starting after point
3926 so that this line becomes properly indented.
3927 The relative indentation among the lines of the expression are preserved."
3929 (cperl-update-syntaxification (point) (point))
3931 ;; If arg, always indent this line as Perl
3932 ;; and shift remaining lines of expression the same amount.
3933 (let ((shift-amt (cperl-indent-line))
3936 (if cperl-tab-always-indent
3937 (beginning-of-line))
3944 (if (and shift-amt (> end beg))
3945 (indent-code-rigidly beg end shift-amt "#")))
3946 (if (and (not cperl-tab-always-indent)
3948 (skip-chars-backward " \t")
3951 (cperl-indent-line))))
3953 (defun cperl-indent-line (&optional parse-data)
3954 "Indent current line as Perl code.
3955 Return the amount the indentation changed by."
3956 (let ((case-fold-search nil)
3957 (pos (- (point-max) (point)))
3958 indent i beg shift-amt)
3959 (setq indent (cperl-calculate-indent parse-data)
3963 (cond ((or (eq indent nil) (eq indent t))
3964 (setq indent (current-indentation) i nil))
3965 ;;((eq indent t) ; Never?
3966 ;; (setq indent (cperl-calculate-indent-within-comment)))
3967 ;;((looking-at "[ \t]*#")
3970 (skip-chars-forward " \t")
3971 (if (listp indent) (setq indent (car indent)))
3972 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
3974 (setq indent (max cperl-min-label-indent
3975 (+ indent cperl-label-offset)))))
3976 ((= (following-char) ?})
3977 (setq indent (- indent cperl-indent-level)))
3978 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
3979 (setq indent (+ indent cperl-close-paren-offset)))
3980 ((= (following-char) ?{)
3981 (setq indent (+ indent cperl-brace-offset))))))
3982 (skip-chars-forward " \t")
3983 (setq shift-amt (and i (- indent (current-column))))
3984 (if (or (not shift-amt)
3986 (if (> (- (point-max) pos) (point))
3987 (goto-char (- (point-max) pos)))
3988 ;;;(delete-region beg (point))
3989 ;;;(indent-to indent)
3990 (cperl-make-indent indent)
3991 ;; If initial point was within line's indentation,
3992 ;; position after the indentation. Else stay at same point in text.
3993 (if (> (- (point-max) pos) (point))
3994 (goto-char (- (point-max) pos))))
3997 (defun cperl-after-label ()
3998 ;; Returns true if the point is after label. Does not do save-excursion.
3999 (and (eq (preceding-char) ?:)
4000 (memq (char-syntax (char-after (- (point) 2)))
4004 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
4006 (defun cperl-get-state (&optional parse-start start-state)
4007 ;; returns list (START STATE DEPTH PRESTART),
4008 ;; START is a good place to start parsing, or equal to
4009 ;; PARSE-START if preset,
4010 ;; STATE is what is returned by `parse-partial-sexp'.
4011 ;; DEPTH is true is we are immediately after end of block
4012 ;; which contains START.
4013 ;; PRESTART is the position basing on which START was found.
4015 (let ((start-point (point)) depth state start prestart)
4016 (if (and parse-start
4017 (<= parse-start start-point))
4018 (goto-char parse-start)
4019 (beginning-of-defun)
4020 (setq start-state nil))
4021 (setq prestart (point))
4023 ;; Try to go out, if sub is not on the outermost level
4024 (while (< (point) start-point)
4025 (setq start (point) parse-start start depth nil
4026 state (parse-partial-sexp start start-point -1))
4027 (if (> (car state) -1) nil
4028 ;; The current line could start like }}}, so the indentation
4029 ;; corresponds to a different level than what we reached
4031 (beginning-of-line 2))) ; Go to the next line.
4032 (if start (goto-char start))) ; Not at the start of file
4033 (setq start (point))
4034 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
4035 (list start state depth prestart))))
4037 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
4039 (defun cperl-beginning-of-property (p prop &optional lim)
4040 "Given that P has a property PROP, find where the property starts.
4041 Will not look before LIM."
4042 ;;; XXXX What to do at point-max???
4043 (or (previous-single-property-change (cperl-1+ p) prop lim)
4045 ;;; (cond ((eq p (point-min))
4047 ;;; ((and lim (<= p lim))
4049 ;;; ((not (get-text-property (1- p) prop))
4051 ;;; (t (or (previous-single-property-change p look-prop lim)
4055 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
4056 "Return appropriate indentation for current line as Perl code.
4057 In usual case returns an integer: the column to indent to.
4058 Returns nil if line starts inside a string, t if in a comment.
4060 Will not correct the indentation for labels, but will correct it for braces
4061 and closing parentheses and brackets."
4062 (cperl-update-syntaxification (point) (point))
4065 (and (memq (get-text-property (point) 'syntax-type)
4066 '(pod here-doc here-doc-delim format))
4067 (not (get-text-property (point) 'indentable)))
4068 ;; before start of POD - whitespace found since do not have 'pod!
4069 (and (looking-at "[ \t]*\n=")
4070 (error "Spaces before POD section!"))
4071 (and (not cperl-indent-left-aligned-comments)
4075 (let* ((indent-point (point))
4076 (char-after-pos (save-excursion
4077 (skip-chars-forward " \t")
4079 (char-after (char-after char-after-pos))
4080 (in-pod (get-text-property (point) 'in-pod))
4081 (pre-indent-point (point))
4082 p prop look-prop is-block delim)
4085 ;; In the verbatim part, probably code example. What to do???
4090 (cperl-backward-to-noncomment nil)
4091 (setq p (max (point-min) (1- (point)))
4092 prop (get-text-property p 'syntax-type)
4093 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
4095 (if (memq prop '(pod here-doc format here-doc-delim))
4097 (goto-char (cperl-beginning-of-property p look-prop))
4099 (setq pre-indent-point (point)))))))
4100 (goto-char pre-indent-point)
4101 (let* ((case-fold-search nil)
4102 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
4103 (start (or (nth 2 parse-data)
4106 (containing-sexp (car (cdr state)))
4109 ;;containing-sexp ;; We are buggy at toplevel :-(
4112 (setcar parse-data pre-indent-point)
4113 (setcar (cdr parse-data) state)
4114 (or (nth 2 parse-data)
4115 (setcar (cddr parse-data) start))
4116 ;; Before this point: end of statement
4117 (setq old-indent (nth 3 parse-data))))
4118 (cond ((get-text-property (point) 'indentable)
4119 ;; indent to "after" the surrounding open
4120 ;; (same offset as `cperl-beautify-regexp-piece'),
4121 ;; skip blanks if we do not close the expression.
4122 (setq delim ; We do not close the expression
4124 (cperl-1+ char-after-pos) 'indentable)
4125 p (1+ (cperl-beginning-of-property
4126 (point) 'indentable))
4127 is-block ; misused for: preceeding line in REx
4128 (save-excursion ; Find preceeding line
4129 (cperl-backward-to-noncomment p)
4132 (progn ; get indent from the first line
4134 (skip-chars-forward " \t")
4135 (if (memq (char-after (point))
4137 nil ; Can't use intentation of this line...
4139 (skip-chars-forward " \t")
4141 prop (parse-partial-sexp p char-after-pos))
4143 (goto-char p) ; beginning of REx etc
4144 (1- (current-column))) ; End the REx, ignore is-block
4146 ;; Indent as the level after closing parens
4147 (goto-char char-after-pos)
4148 (skip-chars-forward " \t)")
4149 (setq char-after-pos (point))
4150 (goto-char is-block)
4151 (skip-chars-forward " \t)")
4152 (setq p (parse-partial-sexp (point) char-after-pos))
4153 (goto-char is-block)
4155 (or cperl-regexp-indent-step cperl-indent-level))
4156 (cond ((eq char-after ?\) )
4157 (- cperl-close-paren-offset)) ; compensate
4158 ((eq char-after ?\| )
4159 (- (or cperl-regexp-indent-step cperl-indent-level)))
4161 (if (eq (following-char) ?\| )
4162 (or cperl-regexp-indent-step cperl-indent-level)
4165 ;; Now we have no preceeding line...
4168 (+ (or cperl-regexp-indent-step cperl-indent-level)
4170 (current-column)))))
4171 ((get-text-property char-after-pos 'REx-part2)
4172 (condition-case nil ; Use indentation of the 1st part
4175 ((or (nth 3 state) (nth 4 state))
4176 ;; return nil or t if should not change this line
4178 ;; XXXX Do we need to special-case this?
4179 ((null containing-sexp)
4180 ;; Line is at top level. May be data or function definition,
4181 ;; or may be function argument declaration.
4182 ;; Indent like the previous top level line
4183 ;; unless that ends in a closeparen without semicolon,
4184 ;; in which case this line is the first argument decl.
4185 (skip-chars-forward " \t")
4188 (- (current-indentation)
4189 (if (nth 2 s-s) cperl-indent-level 0)))
4190 (if (eq char-after ?{) cperl-continued-brace-offset 0)
4192 (cperl-backward-to-noncomment (or old-indent (point-min)))
4193 ;; Look at previous line that's at column 0
4194 ;; to determine whether we are in top-level decls
4195 ;; or function's arg decls. Set basic-indent accordingly.
4196 ;; Now add a little if this is a continuation line.
4198 (eq (point) old-indent) ; old-indent was at comment
4199 (eq (preceding-char) ?\;)
4201 (and (eq (preceding-char) ?\})
4202 (cperl-after-block-and-statement-beg
4203 (point-min))) ; Was start - too close
4204 (memq char-after (append ")]}" nil))
4205 (and (eq (preceding-char) ?\:) ; label
4208 (skip-chars-backward " \t")
4209 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
4210 (get-text-property (point) 'first-format-line))
4213 (not (eq char-after ?\C-j)))
4214 (setcdr (cddr parse-data)
4215 (list pre-indent-point)))
4217 cperl-continued-statement-offset))))
4220 (and (setq delim (= (char-after containing-sexp) ?{))
4221 (save-excursion ; Is it a hash?
4222 (goto-char containing-sexp)
4224 cperl-indent-parens-as-block))
4225 ;; group is an expression, not a block:
4226 ;; indent to just after the surrounding open parens,
4227 ;; skip blanks if we do not close the expression.
4228 (goto-char (1+ containing-sexp))
4229 (or (memq char-after
4230 (append (if delim "}" ")]}") nil))
4231 (looking-at "[ \t]*\\(#\\|$\\)")
4232 (skip-chars-forward " \t"))
4235 (eq char-after ?\}))
4236 ;; Correct indentation of trailing ?\}
4237 (+ cperl-indent-level cperl-close-paren-offset)
4239 ;;; ((and (/= (char-after containing-sexp) ?{)
4240 ;;; (not cperl-indent-parens-as-block))
4241 ;;; ;; line is expression, not statement:
4242 ;;; ;; indent to just after the surrounding open,
4243 ;;; ;; skip blanks if we do not close the expression.
4244 ;;; (goto-char (1+ containing-sexp))
4245 ;;; (or (memq char-after (append ")]}" nil))
4246 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
4247 ;;; (skip-chars-forward " \t"))
4248 ;;; (current-column))
4250 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
4251 ;;; (goto-char containing-sexp)
4252 ;;; (and (not (cperl-block-p))
4253 ;;; (not cperl-indent-parens-as-block)))
4254 ;;; (goto-char (1+ containing-sexp))
4255 ;;; (or (eq char-after ?\})
4256 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
4257 ;;; (skip-chars-forward " \t"))
4258 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
4259 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
4260 ;;; cperl-close-paren-offset)
4263 ;; Statement level. Is it a continuation or a new statement?
4264 ;; Find previous non-comment character.
4265 (goto-char pre-indent-point)
4266 (cperl-backward-to-noncomment containing-sexp)
4267 ;; Back up over label lines, since they don't
4268 ;; affect whether our line is a continuation.
4270 (while;;(or (eq (preceding-char) ?\,)
4271 (and (eq (preceding-char) ?:)
4272 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
4273 (memq (char-syntax (char-after (- (point) 2)))
4276 (if (eq (preceding-char) ?\,)
4277 ;; Will go to beginning of line, essentially.
4278 ;; Will ignore embedded sexpr XXXX.
4279 (cperl-backward-to-start-of-continued-exp containing-sexp))
4281 (cperl-backward-to-noncomment containing-sexp))
4282 ;; Now we get the answer.
4283 (if (not (or (eq (1- (point)) containing-sexp)
4284 (memq (preceding-char)
4285 (append (if is-block " ;{" " ,;{") '(nil)))
4286 (and (eq (preceding-char) ?\})
4287 (cperl-after-block-and-statement-beg
4289 (get-text-property (point) 'first-format-line)))
4290 ;; This line is continuation of preceding line's statement;
4291 ;; indent `cperl-continued-statement-offset' more than the
4292 ;; previous line of the statement.
4294 ;; There might be a label on this line, just
4295 ;; consider it bad style and ignore it.
4297 (cperl-backward-to-start-of-continued-exp containing-sexp)
4298 (+ (if (memq char-after (append "}])" nil))
4300 cperl-continued-statement-offset)
4303 (not (eq char-after ?\})))
4305 ;; Now it is a hash reference
4306 (+ cperl-indent-level cperl-close-paren-offset))
4307 ;; Labels do not take :: ...
4308 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
4309 (if (> (current-indentation) cperl-min-label-indent)
4310 (- (current-indentation) cperl-label-offset)
4311 ;; Do not move `parse-data', this should
4312 ;; be quick anyway (this comment comes
4313 ;; from different location):
4314 (cperl-calculate-indent))
4316 (if (eq char-after ?\{)
4317 cperl-continued-brace-offset 0)))
4318 ;; This line starts a new statement.
4319 ;; Position following last unclosed open.
4320 (goto-char containing-sexp)
4321 ;; Is line first statement after an open-brace?
4323 ;; If no, find that first statement and indent like
4324 ;; it. If the first statement begins with label, do
4325 ;; not believe when the indentation of the label is too
4329 (setq old-indent (current-indentation))
4330 (let ((colon-line-end 0))
4332 (progn (skip-chars-forward " \t\n")
4333 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
4334 ;; Skip over comments and labels following openbrace.
4335 (cond ((= (following-char) ?\#)
4337 ((= (following-char) ?\=)
4339 (or (next-single-property-change (point) 'in-pod)
4340 (point-max)))) ; do not loop if no syntaxification
4343 (save-excursion (end-of-line)
4344 (setq colon-line-end (point)))
4345 (search-forward ":"))))
4346 ;; The first following code counts
4347 ;; if it is before the line we want to indent.
4348 (and (< (point) indent-point)
4349 (if (> colon-line-end (point)) ; After label
4350 (if (> (current-indentation)
4351 cperl-min-label-indent)
4352 (- (current-indentation) cperl-label-offset)
4353 ;; Do not believe: `max' is involved
4354 (+ old-indent cperl-indent-level))
4355 (current-column)))))
4356 ;; If no previous statement,
4357 ;; indent it relative to line brace is on.
4358 ;; For open brace in column zero, don't let statement
4359 ;; start there too. If cperl-indent-level is zero,
4360 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
4361 ;; For open-braces not the first thing in a line,
4362 ;; add in cperl-brace-imaginary-offset.
4364 ;; If first thing on a line: ?????
4365 (+ (if (and (bolp) (zerop cperl-indent-level))
4366 (+ cperl-brace-offset cperl-continued-statement-offset)
4370 (not (eq char-after ?\})))
4372 ;; Now it is a hash reference
4373 (+ cperl-indent-level cperl-close-paren-offset))
4374 ;; Move back over whitespace before the openbrace.
4375 ;; If openbrace is not first nonwhite thing on the line,
4376 ;; add the cperl-brace-imaginary-offset.
4377 (progn (skip-chars-backward " \t")
4378 (if (bolp) 0 cperl-brace-imaginary-offset))
4379 ;; If the openbrace is preceded by a parenthesized exp,
4380 ;; move to the beginning of that;
4381 ;; possibly a different line
4383 (cperl-backward-to-noncomment (point-min))
4384 (if (eq (preceding-char) ?\))
4386 ;; In the case it starts a subroutine, indent with
4387 ;; respect to `sub', not with respect to the
4388 ;; first thing on the line, say in the case of
4389 ;; anonymous sub in a hash.
4391 ;;(skip-chars-backward " \t")
4392 (cperl-backward-to-noncomment (point-min))
4395 (and (get-text-property (point) 'attrib-group)
4397 (cperl-beginning-of-property
4398 (point) 'attrib-group)))
4399 (and (eq (preceding-char) ?b)
4402 (looking-at "sub\\>"))))
4406 (save-excursion (beginning-of-line) (point))
4408 (progn (goto-char (1+ old-indent))
4409 (skip-chars-forward " \t")
4411 ;; Get initial indentation of the line we are on.
4412 ;; If line starts with label, calculate label indentation
4415 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
4416 (if (> (current-indentation) cperl-min-label-indent)
4417 (- (current-indentation) cperl-label-offset)
4418 ;; Do not move `parse-data', this should
4420 (cperl-calculate-indent))
4421 (current-indentation))))))))))))))
4423 (defvar cperl-indent-alist
4427 (toplevel-after-parenth 2)
4428 (toplevel-continued 2)
4430 "Alist of indentation rules for CPerl mode.
4433 number: add this amount of indentation.
4435 Not finished, not used.")
4437 (defun cperl-where-am-i (&optional parse-start start-state)
4439 "Return a list of lists ((TYPE POS)...) of good points before the point.
4440 POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
4442 Not finished, not used."
4444 (let* ((start-point (point)) unused
4445 (s-s (cperl-get-state))
4448 (prestart (nth 3 s-s))
4449 (containing-sexp (car (cdr state)))
4450 (case-fold-search nil)
4451 (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
4452 (cond ((nth 3 state) ; In string
4453 (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
4454 ((nth 4 state) ; In comment
4455 (setq res (cons '(comment) res)))
4456 ((null containing-sexp)
4457 ;; Line is at top level.
4458 ;; Indent like the previous top level line
4459 ;; unless that ends in a closeparen without semicolon,
4460 ;; in which case this line is the first argument decl.
4461 (cperl-backward-to-noncomment (or parse-start (point-min)))
4462 ;;(skip-chars-backward " \t\f\n")
4465 (memq (preceding-char) (append ";}" nil)))
4466 (setq res (cons (list 'toplevel start) res)))
4467 ((eq (preceding-char) ?\) )
4468 (setq res (cons (list 'toplevel-after-parenth start) res)))
4470 (setq res (cons (list 'toplevel-continued start) res)))))
4471 ((/= (char-after containing-sexp) ?{)
4472 ;; line is expression, not statement:
4473 ;; indent to just after the surrounding open.
4474 ;; skip blanks if we do not close the expression.
4475 (setq res (cons (list 'expression-blanks
4477 (goto-char (1+ containing-sexp))
4478 (or (looking-at "[ \t]*\\(#\\|$\\)")
4479 (skip-chars-forward " \t"))
4481 (cons (list 'expression containing-sexp) res))))
4483 ;; Containing-expr starts with \{. Check whether it is a hash.
4484 (goto-char containing-sexp)
4485 (not (cperl-block-p)))
4486 (setq res (cons (list 'expression-blanks
4488 (goto-char (1+ containing-sexp))
4489 (or (looking-at "[ \t]*\\(#\\|$\\)")
4490 (skip-chars-forward " \t"))
4492 (cons (list 'expression containing-sexp) res))))
4495 (setq res (cons (list 'in-block containing-sexp) res))
4496 ;; Is it a continuation or a new statement?
4497 ;; Find previous non-comment character.
4498 (cperl-backward-to-noncomment containing-sexp)
4499 ;; Back up over label lines, since they don't
4500 ;; affect whether our line is a continuation.
4501 ;; Back up comma-delimited lines too ?????
4502 (while (or (eq (preceding-char) ?\,)
4503 (save-excursion (cperl-after-label)))
4504 (if (eq (preceding-char) ?\,)
4505 ;; Will go to beginning of line, essentially
4506 ;; Will ignore embedded sexpr XXXX.
4507 (cperl-backward-to-start-of-continued-exp containing-sexp))
4509 (cperl-backward-to-noncomment containing-sexp))
4510 ;; Now we get the answer.
4511 (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
4512 ;; This line is continuation of preceding line's statement.
4513 (list (list 'statement-continued containing-sexp))
4514 ;; This line starts a new statement.
4515 ;; Position following last unclosed open.
4516 (goto-char containing-sexp)
4517 ;; Is line first statement after an open-brace?
4519 ;; If no, find that first statement and indent like
4520 ;; it. If the first statement begins with label, do
4521 ;; not believe when the indentation of the label is too
4525 (let ((colon-line-end 0))
4526 (while (progn (skip-chars-forward " \t\n" start-point)
4527 (and (< (point) start-point)
4529 "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
4530 ;; Skip over comments and labels following openbrace.
4531 (cond ((= (following-char) ?\#)
4536 (save-excursion (end-of-line)
4537 (setq colon-line-end (point)))
4538 (search-forward ":"))))
4539 ;; Now at the point, after label, or at start
4540 ;; of first statement in the block.
4541 (and (< (point) start-point)
4542 (if (> colon-line-end (point))
4543 ;; Before statement after label
4544 (if (> (current-indentation)
4545 cperl-min-label-indent)
4546 (list (list 'label-in-block (point)))
4547 ;; Do not believe: `max' is involved
4549 (list 'label-in-block-min-indent (point))))
4551 (list 'statement-in-block (point))))))
4552 ;; If no previous statement,
4553 ;; indent it relative to line brace is on.
4554 ;; For open brace in column zero, don't let statement
4555 ;; start there too. If cperl-indent-level is zero,
4556 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
4557 ;; For open-braces not the first thing in a line,
4558 ;; add in cperl-brace-imaginary-offset.
4560 ;; If first thing on a line: ?????
4561 (setq unused ; This is not finished...
4562 (+ (if (and (bolp) (zerop cperl-indent-level))
4563 (+ cperl-brace-offset cperl-continued-statement-offset)
4565 ;; Move back over whitespace before the openbrace.
4566 ;; If openbrace is not first nonwhite thing on the line,
4567 ;; add the cperl-brace-imaginary-offset.
4568 (progn (skip-chars-backward " \t")
4569 (if (bolp) 0 cperl-brace-imaginary-offset))
4570 ;; If the openbrace is preceded by a parenthesized exp,
4571 ;; move to the beginning of that;
4572 ;; possibly a different line
4574 (if (eq (preceding-char) ?\))
4576 ;; Get initial indentation of the line we are on.
4577 ;; If line starts with label, calculate label indentation
4580 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
4581 (if (> (current-indentation) cperl-min-label-indent)
4582 (- (current-indentation) cperl-label-offset)
4583 (cperl-calculate-indent))
4584 (current-indentation)))))))))
4587 (defun cperl-calculate-indent-within-comment ()
4588 "Return the indentation amount for line, assuming that
4589 the current line is to be regarded as part of a block comment."
4590 (let (end star-start)
4593 (skip-chars-forward " \t")
4595 (and (= (following-char) ?#)
4597 (cperl-to-comment-or-eol)
4603 (defun cperl-to-comment-or-eol ()
4604 "Go to position before comment on the current line, or to end of line.
4605 Returns true if comment is found. In POD will not move the point."
4606 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
4607 ;; then looks for literal # or end-of-line.
4608 (let (state stop-in cpoint (lim (progn (end-of-line) (point))) pr e)
4609 (or cperl-font-locking
4610 (cperl-update-syntaxification lim lim))
4612 (if (setq pr (get-text-property (point) 'syntax-type))
4613 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
4614 (if (or (eq pr 'pod)
4615 (if (or (not e) (> e lim)) ; deep inside a group
4616 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
4617 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
4618 ;; Else - need to do it the hard way
4619 (and (and e (<= e lim))
4621 (while (not stop-in)
4622 (setq state (parse-partial-sexp (point) lim nil nil nil t))
4624 ;; If fails (beginning-of-line inside sexp), then contains not-comment
4625 (if (nth 4 state) ; After `#';
4626 ; (nth 2 state) can be
4627 ; beginning of m,s,qq and so
4631 (setq cpoint (point))
4632 (goto-char (nth 2 state))
4634 ((looking-at "\\(s\\|tr\\)\\>")
4635 (or (re-search-forward
4636 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
4639 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
4640 (or (re-search-forward
4641 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
4644 (t ; It was fair comment
4645 (setq stop-in t) ; Finish
4646 (goto-char (1- cpoint)))))
4647 (setq stop-in t) ; Finish
4649 (setq stop-in t))) ; Finish
4652 (defsubst cperl-modify-syntax-type (at how)
4653 (if (< at (point-max))
4655 (put-text-property at (1+ at) 'syntax-table how)
4656 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
4658 (defun cperl-protect-defun-start (s e)
4659 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
4662 (while (re-search-forward "^\\s(" e 'to-end)
4663 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
4665 (defun cperl-commentify (bb e string &optional noface)
4666 (if cperl-use-syntax-table-text-property
4667 (if (eq noface 'n) ; Only immediate
4669 ;; We suppose that e is _after_ the end of construction, as after eol.
4670 (setq string (if string cperl-st-sfence cperl-st-cfence))
4672 ;; one-char string/comment?!
4673 (cperl-modify-syntax-type bb cperl-st-punct)
4674 (cperl-modify-syntax-type bb string)
4675 (cperl-modify-syntax-type (1- e) string))
4676 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
4677 (put-text-property (1+ bb) (1- e)
4678 'syntax-table cperl-string-syntax-table))
4679 (cperl-protect-defun-start bb e))
4682 (not cperl-pod-here-fontify)
4683 (put-text-property bb e 'face (if string 'font-lock-string-face
4684 'font-lock-comment-face)))))
4686 (defvar cperl-starters '(( ?\( . ?\) )
4691 (defun cperl-cached-syntax-table (st)
4692 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
4693 All the entries of the syntax table are \".\", except for a backslash, which
4697 (setcar st (make-syntax-table))
4701 (modify-syntax-entry i "." st)
4703 (modify-syntax-entry ?\\ "\\" st)
4706 (defun cperl-forward-re (lim end is-2arg st-l err-l argument
4707 &optional ostart oend)
4708 "Find the end of a regular expression or a stringish construct (q[] etc).
4709 The point should be before the starting delimiter.
4711 Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
4712 is s/// or tr/// like expression. If END is nil, generates an error
4713 message if needed. If SET-ST is non-nil, will use (or generate) a
4714 cached syntax table in ST-L. If ERR-L is non-nil, will store the
4715 error message in its CAR (unless it already contains some error
4716 message). ARGUMENT should be the name of the construct (used in error
4717 messages). OSTART, OEND may be set in recursive calls when processing
4718 the second argument of 2ARG construct.
4720 Works *before* syntax recognition is done. In IS-2ARG situation may
4721 modify syntax-type text property if the situation is too hard."
4722 (let (b starter ender st i i2 go-forward reset-st set-st)
4723 (skip-chars-forward " \t")
4724 ;; ender means matching-char matcher.
4726 starter (if (eobp) 0 (char-after b))
4727 ender (cdr (assoc starter cperl-starters)))
4728 ;; What if starter == ?\\ ????
4729 (setq st (cperl-cached-syntax-table st-l))
4731 ;; Whether we have an intermediate point
4733 ;; Prepare the syntax table:
4734 (if (not ender) ; m/blah/, s/x//, s/x/y/
4735 (modify-syntax-entry starter "$" st)
4736 (modify-syntax-entry starter (concat "(" (list ender)) st)
4737 (modify-syntax-entry ender (concat ")" (list starter)) st))
4740 ;; We use `$' syntax class to find matching stuff, but $$
4741 ;; is recognized the same as $, so we need to check this manually.
4742 (if (and (eq starter (char-after (cperl-1+ b)))
4744 ;; $ has TeXish matching rules, so $$ equiv $...
4746 (setq reset-st (syntax-table))
4747 (set-syntax-table st)
4749 (if (<= (point) (1+ b))
4750 (error "Unfinished regular expression"))
4751 (set-syntax-table reset-st)
4753 ;; Now the problem is with m;blah;;
4755 (eq (preceding-char)
4756 (char-after (- (point) 2)))
4759 (= 0 (% (skip-chars-backward "\\\\") 2)))
4761 ;; Now we are after the first part.
4762 (and is-2arg ; Have trailing part
4764 (eq (following-char) starter) ; Empty trailing part
4766 (or (eq (char-syntax (following-char)) ?.)
4767 ;; Make trailing letter into punctuation
4768 (cperl-modify-syntax-type (point) cperl-st-punct))
4769 (setq is-2arg nil go-forward t))) ; Ignore the tail
4770 (if is-2arg ; Not number => have second part
4772 (setq i (point) i2 i)
4774 (if (memq (following-char) '(?\ ?\t ?\n ?\f))
4776 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4777 (goto-char (match-end 0))
4778 (skip-chars-forward " \t\n\f"))
4781 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
4782 (if ender (modify-syntax-entry ender "." st))
4784 (setq ender (cperl-forward-re lim end nil st-l err-l
4785 argument starter ender)
4786 ender (nth 2 ender)))))
4787 (error (goto-char lim)
4790 (set-syntax-table reset-st))
4793 "End of `%s%s%c ... %c' string/RE not found: %s"
4795 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
4796 starter (or ender starter) bb)
4797 (or (car err-l) (setcar err-l b)))))
4800 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
4801 (if ender (modify-syntax-entry ender "." st))))
4802 ;; i: have 2 args, after end of the first arg
4803 ;; i2: start of the second arg, if any (before delim iff `ender').
4804 ;; ender: the last arg bounded by parens-like chars, the second one of them
4805 ;; starter: the starting delimiter of the first arg
4806 ;; go-forward: has 2 args, and the second part is empty
4807 (list i i2 ender starter go-forward)))
4809 (defun cperl-forward-group-in-re (&optional st-l)
4810 "Find the end of a group in a REx.
4811 Return the error message (if any). Does not work if delimiter is `)'.
4812 Works before syntax recognition is done."
4813 ;; Works *before* syntax recognition is done
4814 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
4815 (let (st b reset-st)
4818 (setq st (cperl-cached-syntax-table st-l))
4819 (modify-syntax-entry ?\( "()" st)
4820 (modify-syntax-entry ?\) ")(" st)
4821 (setq reset-st (syntax-table))
4822 (set-syntax-table st)
4825 "cperl-forward-group-in-re: error %s" b)))
4826 ;; now restore the initial state
4829 (modify-syntax-entry ?\( "." st)
4830 (modify-syntax-entry ?\) "." st)))
4832 (set-syntax-table reset-st))
4836 (defvar font-lock-string-face)
4837 ;;(defvar font-lock-reference-face)
4838 (defvar font-lock-constant-face)
4839 (defsubst cperl-postpone-fontification (b e type val &optional now)
4840 ;; Do after syntactic fontification?
4841 (if cperl-syntaxify-by-font-lock
4842 (or now (put-text-property b e 'cperl-postpone (cons type val)))
4843 (put-text-property b e type val)))
4845 ;;; Here is how the global structures (those which cannot be
4846 ;;; recognized locally) are marked:
4848 ;; Start-to-end is marked `in-pod' ==> t
4849 ;; Each non-literal part is marked `syntax-type' ==> `pod'
4850 ;; Each literal part is marked `syntax-type' ==> `in-pod'
4852 ;; Start-to-end is marked `here-doc-group' ==> t
4853 ;; The body is marked `syntax-type' ==> `here-doc'
4854 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
4856 ;; First line (to =) marked `first-format-line' ==> t
4857 ;; After-this--to-end is marked `syntax-type' ==> `format'
4858 ;; d) 'Q'uoted string:
4859 ;; part between markers inclusive is marked `syntax-type' ==> `string'
4860 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
4861 ;; e) Attributes of subroutines: `attrib-group' ==> t
4862 ;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
4863 ;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
4865 (defun cperl-unwind-to-safe (before &optional end)
4866 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
4867 (let ((pos (point)) opos)
4868 (while (and pos (progn
4870 (get-text-property (setq pos (point)) 'syntax-type)))
4872 pos (cperl-beginning-of-property pos 'syntax-type))
4873 (if (eq pos (point-min))
4878 (goto-char (cperl-1- pos))
4881 (goto-char (setq pos (cperl-1- pos))))
4883 (goto-char (point-min))))
4885 (and (looking-at "\n*=")
4886 (/= 0 (skip-chars-backward "\n"))
4890 ;; Do the same for end, going small steps
4892 (while (and end (get-text-property end 'syntax-type))
4894 end (next-single-property-change end 'syntax-type nil (point-max)))
4895 (if end (progn (goto-char end)
4896 (or (bolp) (forward-line 1))
4897 (setq end (point)))))
4900 (defvar cperl-nonoverridable-face)
4901 (defvar font-lock-function-name-face)
4902 (defvar font-lock-comment-face)
4904 (defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
4905 "Syntaxically mark (and fontify) attributes of a subroutine.
4906 Should be called with the point before leading colon of an attribute."
4907 ;; Works *before* syntax recognition is done
4908 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
4909 (let (st b p reset-st after-first (start (point)) start1 end1)
4913 "\\(" ; 1=optional? colon
4914 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
4916 (if after-first "?" "")
4917 ;; No space between name and paren allowed...
4918 "\\(\\sw+\\)" ; 3=name
4919 "\\((\\)?")) ; 4=optional paren
4920 (and (match-beginning 1)
4921 (cperl-postpone-fontification
4922 (match-beginning 0) (cperl-1+ (match-beginning 0))
4923 'face font-lock-constant-face))
4924 (setq start1 (match-beginning 3) end1 (match-end 3))
4925 (cperl-postpone-fontification start1 end1
4926 'face font-lock-constant-face)
4927 (goto-char end1) ; end or before `('
4928 (if (match-end 4) ; Have attribute arguments...
4931 (setq st (cperl-cached-syntax-table st-l))
4932 (modify-syntax-entry ?\( "()" st)
4933 (modify-syntax-entry ?\) ")(" st))
4934 (setq reset-st (syntax-table) p (point))
4935 (set-syntax-table st)
4937 (set-syntax-table reset-st)
4939 (cperl-commentify p (point) t))) ; mark as string
4940 (forward-comment (buffer-size))
4941 (setq after-first t))
4943 "L%d: attribute `%s': %s"
4944 (count-lines (point-min) (point)) (buffer-substring start1 end1) b)
4948 (put-text-property start (point)
4949 'attrib-group (if (looking-at "{") t 0))
4951 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
4952 ;; Apparently, we do not need `multiline': faces added now
4953 (put-text-property (+ 3 pos) (cperl-1+ (point))
4954 'syntax-type 'sub-decl))
4955 (and b-fname ; Fontify here: the following condition
4956 (cperl-postpone-fontification ; is too hard to determine by
4957 b-fname e-fname 'face ; a REx, so do it here
4958 (if (looking-at "{")
4959 font-lock-function-name-face
4960 font-lock-variable-name-face)))))
4961 ;; now restore the initial state
4964 (modify-syntax-entry ?\( "." st)
4965 (modify-syntax-entry ?\) "." st)))
4967 (set-syntax-table reset-st))))
4969 (defsubst cperl-look-at-leading-count (is-x-REx e)
4970 (if (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
4971 (1- e) t) ; return nil on failure, no moving
4972 (if (eq ?\{ (preceding-char)) nil
4973 (cperl-postpone-fontification
4974 (1- (point)) (point)
4975 'face font-lock-function-name-face))))
4977 ;;; Debugging this may require (setq max-specpdl-size 2000)...
4978 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
4979 "Scans the buffer for hard-to-parse Perl constructions.
4980 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
4981 the sections using `cperl-pod-head-face', `cperl-pod-face',
4984 (or min (setq min (point-min)
4985 cperl-syntax-state nil
4986 cperl-syntax-done-to min))
4987 (or max (setq max (point-max)))
4988 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
4989 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
4990 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
4991 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
4992 (modified (buffer-modified-p)) overshoot
4993 (after-change-functions nil)
4994 (cperl-font-locking t)
4995 (use-syntax-state (and cperl-syntax-state
4996 (>= min (car cperl-syntax-state))))
4997 (state-point (if use-syntax-state
4998 (car cperl-syntax-state)
5000 (state (if use-syntax-state
5001 (cdr cperl-syntax-state)))
5002 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
5003 (st-l (list nil)) (err-l (list nil))
5004 ;; Somehow font-lock may be not loaded yet...
5005 (font-lock-string-face (if (boundp 'font-lock-string-face)
5006 font-lock-string-face
5007 'font-lock-string-face))
5008 (font-lock-constant-face (if (boundp 'font-lock-constant-face)
5009 font-lock-constant-face
5010 'font-lock-constant-face))
5011 (font-lock-function-name-face
5012 (if (boundp 'font-lock-function-name-face)
5013 font-lock-function-name-face
5014 'font-lock-function-name-face))
5015 (font-lock-comment-face
5016 (if (boundp 'font-lock-comment-face)
5017 font-lock-comment-face
5018 'font-lock-comment-face))
5019 (cperl-nonoverridable-face
5020 (if (boundp 'cperl-nonoverridable-face)
5021 cperl-nonoverridable-face
5022 'cperl-nonoverridable-face))
5023 (stop-point (if ignore-max
5028 "\\(\\`\n?\\|^\n\\)=" ; POD
5030 ;; One extra () before this:
5033 ;; First variant "BLAH" or just ``.
5034 "[ \t]*" ; Yes, whitespace is allowed!
5035 "\\([\"'`]\\)" ; 2 + 1 = 3
5036 "\\([^\"'`\n]*\\)" ; 3 + 1
5039 ;; Second variant: Identifier or \ID (same as 'ID') or empty
5040 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
5041 ;; Do not have <<= or << 30 or <<30 or << $blah.
5042 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
5043 "\\(\\)" ; To preserve count of pars :-( 6 + 1
5046 ;; 1+6 extra () before this:
5047 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
5048 (if cperl-use-syntax-table-text-property
5051 ;; 1+6+2=9 extra () before this:
5052 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
5054 ;; 1+6+2+1=10 extra () before this:
5055 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
5057 ;; 1+6+2+1+1=11 extra () before this
5058 "\\<sub\\>" ; sub with proto/attr
5060 cperl-white-and-comment-rex
5061 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
5063 cperl-maybe-white-and-comment-rex
5064 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
5066 ;; 1+6+2+1+1+6=17 extra () before this:
5067 "\\$\\(['{]\\)" ; $' or ${foo}
5069 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
5070 ;; we do not support intervening comments...):
5071 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
5072 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
5074 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
5075 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
5077 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
5083 (message "Scanning for \"hard\" Perl constructions..."))
5084 ;;(message "find: %s --> %s" min max)
5085 (and cperl-pod-here-fontify
5086 ;; We had evals here, do not know why...
5087 (setq face cperl-pod-face
5088 head-face cperl-pod-head-face
5089 here-face cperl-here-face))
5090 (remove-text-properties min max
5091 '(syntax-type t in-pod t syntax-table t
5101 ;; Need to remove face as well...
5103 (and (eq system-type 'emx)
5105 (let ((case-fold-search t))
5106 (looking-at "extproc[ \t]")) ; Analogue of #!
5107 (cperl-commentify min
5108 (save-excursion (end-of-line) (point))
5112 (re-search-forward search max t))
5113 (setq tmpend nil) ; Valid for most cases
5114 (setq b (match-beginning 0)
5115 state (save-excursion (parse-partial-sexp
5116 state-point b nil nil state))
5119 ;; 1+6+2+1+1+6=17 extra () before this:
5121 ((match-beginning 18) ; $' or ${foo}
5122 (if (eq (preceding-char) ?\') ; $'
5124 (setq b (1- (point))
5125 state (parse-partial-sexp
5126 state-point (1- b) nil nil state)
5128 (if (nth 3 state) ; in string
5129 (cperl-modify-syntax-type (1- b) cperl-st-punct))
5132 (setq bb (match-beginning 0))
5133 (cperl-modify-syntax-type bb cperl-st-punct)))
5134 ;; No processing in strings/comments beyond this point:
5135 ((or (nth 3 state) (nth 4 state))
5136 t) ; Do nothing in comment/string
5137 ((match-beginning 1) ; POD section
5138 ;; "\\(\\`\n?\\|^\n\\)="
5139 (setq b (match-beginning 0)
5140 state (parse-partial-sexp
5141 state-point b nil nil state)
5143 (if (or (nth 3 state) (nth 4 state)
5144 (looking-at "cut\\>"))
5145 (if (or (nth 3 state) (nth 4 state) ignore-max)
5146 nil ; Doing a chunk only
5147 (message "=cut is not preceded by a POD section")
5148 (or (car err-l) (setcar err-l (point))))
5153 tb (match-beginning 0)
5154 b1 nil) ; error condition
5155 ;; We do not search to max, since we may be called from
5156 ;; some hook of fontification, and max is random
5157 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
5160 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
5162 (message "=cut is not preceded by an empty line")
5164 (or (car err-l) (setcar err-l b))))))
5165 (beginning-of-line 2) ; An empty line after =cut is not POD!
5169 (remove-text-properties
5170 max e '(syntax-type t in-pod t syntax-table t
5181 (put-text-property b e 'in-pod t)
5182 (put-text-property b e 'syntax-type 'in-pod)
5184 (while (re-search-forward "\n\n[ \t]" e t)
5185 ;; We start 'pod 1 char earlier to include the preceding line
5187 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5188 (cperl-put-do-not-fontify b (point) t)
5189 ;; mark the non-literal parts as PODs
5190 (if cperl-pod-here-fontify
5191 (cperl-postpone-fontification b (point) 'face face t))
5192 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
5195 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5196 (cperl-put-do-not-fontify (point) e t)
5197 (if cperl-pod-here-fontify
5199 ;; mark the non-literal parts as PODs
5200 (cperl-postpone-fontification (point) e 'face face t)
5203 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
5205 (cperl-postpone-fontification
5206 (match-beginning 1) (match-end 1)
5208 (while (re-search-forward
5210 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
5213 (cperl-postpone-fontification
5214 (match-beginning 1) (match-end 1)
5216 (cperl-commentify bb e nil)
5218 (or (eq e (point-max))
5219 (forward-char -1)))) ; Prepare for immediate POD start.
5221 ;; We can do many here-per-line;
5222 ;; but multiline quote on the same line as <<HERE confuses us...
5223 ;; ;; One extra () before this:
5226 ;; ;; First variant "BLAH" or just ``.
5227 ;; "[ \t]*" ; Yes, whitespace is allowed!
5228 ;; "\\([\"'`]\\)" ; 2 + 1
5229 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
5232 ;; ;; Second variant: Identifier or \ID or empty
5233 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
5234 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
5235 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
5236 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
5238 ((match-beginning 2) ; 1 + 1
5240 tb (match-beginning 0)
5241 c (and ; not HERE-DOC
5244 (or (looking-at "[ \t]*(") ; << function_call()
5245 (save-excursion ; 1 << func_name, or $foo << 10
5249 ;;; XXX What to do: foo <<bar ???
5250 ;;; XXX Need to support print {a} <<B ???
5253 ; $foo << b; $f .= <<B;
5254 ; ($f+1) << b; a($f) . <<B;
5255 ; foo 1, <<B; $x{a} <<b;
5257 ((looking-at "[0-9$({]")
5259 (looking-at "[ \t]*<<")))))
5260 (error nil))) ; func(<<EOF)
5261 (and (not (match-beginning 6)) ; Empty
5263 "[ \t]*[=0-9$@%&(]"))))))
5264 (if c ; Not here-doc
5266 (setq c (match-end 2)) ; 1 + 1
5267 (if (match-beginning 5) ;4 + 1
5268 (setq b1 (match-beginning 5) ; 4 + 1
5269 e1 (match-end 5)) ; 4 + 1
5270 (setq b1 (match-beginning 4) ; 3 + 1
5271 e1 (match-end 4))) ; 3 + 1
5272 (setq tag (buffer-substring b1 e1)
5273 qtag (regexp-quote tag))
5274 (cond (cperl-pod-here-fontify
5275 ;; Highlight the starting delimiter
5276 (cperl-postpone-fontification b1 e1 'face font-lock-constant-face)
5277 (cperl-put-do-not-fontify b1 e1 t)))
5281 (goto-char end-of-here-doc))
5283 ;; We do not search to max, since we may be called from
5284 ;; some hook of fontification, and max is random
5285 (or (and (re-search-forward (concat "^" qtag "$")
5287 (eq (following-char) ?\n))
5288 (progn ; Pretend we matched at the end
5289 (goto-char (point-max))
5290 (re-search-forward "\\'")
5291 (message "End of here-document `%s' not found." tag)
5292 (or (car err-l) (setcar err-l b))))
5293 (if cperl-pod-here-fontify
5295 ;; Highlight the ending delimiter
5296 (cperl-postpone-fontification (match-beginning 0) (match-end 0)
5297 'face font-lock-constant-face)
5298 (cperl-put-do-not-fontify b (match-end 0) t)
5299 ;; Highlight the HERE-DOC
5300 (cperl-postpone-fontification b (match-beginning 0)
5302 (setq e1 (cperl-1+ (match-end 0)))
5303 (put-text-property b (match-beginning 0)
5304 'syntax-type 'here-doc)
5305 (put-text-property (match-beginning 0) e1
5306 'syntax-type 'here-doc-delim)
5307 (put-text-property b e1 'here-doc-group t)
5308 ;; This makes insertion at the start of HERE-DOC update
5309 ;; the whole construct:
5310 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
5311 (cperl-commentify b e1 nil)
5312 (cperl-put-do-not-fontify b (match-end 0) t)
5313 ;; Cache the syntax info...
5314 (setq cperl-syntax-state (cons state-point state))
5315 ;; ... and process the rest of the line...
5317 (elt ; non-inter ignore-max
5318 (cperl-find-pods-heres c i t end t e1) 1))
5319 (if (and overshoot (> overshoot (point)))
5320 (goto-char overshoot)
5321 (setq overshoot e1))
5325 ((match-beginning 8)
5326 ;; 1+6=7 extra () before this:
5327 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
5329 name (if (match-beginning 8) ; 7 + 1
5330 (buffer-substring (match-beginning 8) ; 7 + 1
5331 (match-end 8)) ; 7 + 1
5333 tb (match-beginning 0))
5335 (put-text-property (save-excursion
5338 b 'first-format-line 't)
5339 (if cperl-pod-here-fontify
5340 (while (and (eq (forward-line) 0)
5341 (not (looking-at "^[.;]$")))
5343 ((looking-at "^#")) ; Skip comments
5344 ((and argument ; Skip argument multi-lines
5345 (looking-at "^[ \t]*{"))
5347 (setq argument nil))
5348 (argument ; Skip argument lines
5349 (setq argument nil))
5352 (setq argument (looking-at "^[^\n]*[@^]"))
5354 ;; Highlight the format line
5355 (cperl-postpone-fontification b1 (point)
5356 'face font-lock-string-face)
5357 (cperl-commentify b1 (point) nil)
5358 (cperl-put-do-not-fontify b1 (point) t))))
5359 ;; We do not search to max, since we may be called from
5360 ;; some hook of fontification, and max is random
5361 (re-search-forward "^[.;]$" stop-point 'toend))
5363 (if (looking-at "^\\.$") ; ";" is not supported yet
5365 ;; Highlight the ending delimiter
5366 (cperl-postpone-fontification (point) (+ (point) 2)
5367 'face font-lock-string-face)
5368 (cperl-commentify (point) (+ (point) 2) nil)
5369 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
5370 (message "End of format `%s' not found." name)
5371 (or (car err-l) (setcar err-l b)))
5375 (put-text-property b (point) 'syntax-type 'format))
5376 ;; qq-like String or Regexp:
5377 ((or (match-beginning 10) (match-beginning 11))
5378 ;; 1+6+2=9 extra () before this:
5379 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
5381 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
5382 (setq b1 (if (match-beginning 10) 10 11)
5383 argument (buffer-substring
5384 (match-beginning b1) (match-end b1))
5385 b (point) ; end of qq etc
5387 c (char-after (match-beginning b1))
5388 bb (char-after (1- (match-beginning b1))) ; tmp holder
5389 ;; bb == "Not a stringy"
5390 bb (if (eq b1 10) ; user variables/whatever
5391 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
5392 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
5393 ((eq bb ?\:) ; $opt::s
5395 (- (match-beginning b1) 2))
5397 ((eq bb ?\>) ; $foo->s
5399 (- (match-beginning b1) 2))
5402 (not (eq (char-after ; &&m/blah/
5403 (- (match-beginning b1) 2))
5406 ;; <file> or <$file>
5408 ;; Do not stringify <FH>, <$fh> :
5411 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
5412 tb (match-beginning 0))
5413 (goto-char (match-beginning b1))
5414 (cperl-backward-to-noncomment (point-min))
5416 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
5421 ;; What is below: regexp-p?
5423 (or (memq (preceding-char)
5424 (append (if (memq c '(?\? ?\<))
5427 "~{(=|&+-*!,;:[") nil))
5428 (and (eq (preceding-char) ?\})
5429 (cperl-after-block-p (point-min)))
5430 (and (eq (char-syntax (preceding-char)) ?w)
5433 ;;; After these keywords `/' starts a RE. One should add all the
5434 ;;; functions/builtins which expect an argument, but ...
5435 (if (eq (preceding-char) ?-)
5437 (looking-at "[a-zA-Z]\\>")
5439 (not (memq (preceding-char)
5442 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
5443 (and (eq (preceding-char) ?.)
5444 (eq (char-after (- (point) 2)) ?.))
5446 ;; m|blah| ? foo : bar;
5449 cperl-use-syntax-table-text-property
5453 (looking-at "\\s|"))))))
5456 ;; Check for $a -> y
5457 (setq b1 (preceding-char)
5460 (eq (char-after (- go 2)) ?-))
5466 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
5467 (goto-char (match-end 0))
5468 (skip-chars-forward " \t\n\f"))
5469 (cond ((and (eq (following-char) ?\})
5471 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
5473 (skip-chars-backward " \t\n\f")
5474 (if (memq (preceding-char) (append "$@%&*" nil))
5480 (looking-at ; $foo -> {s}
5481 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
5482 (and ; $foo[12] -> {s}
5483 (memq (following-char) '(?\{ ?\[))
5486 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
5489 ((and (eq (following-char) ?=)
5490 (eq (char-after (1+ (point))) ?\>))
5491 ;; Check for { foo => 1, s => 2 }
5492 ;; Apparently s=> is never a substitution...
5494 ((and (eq (following-char) ?:)
5495 (eq b1 ?\{) ; Check for $ { s::bar }
5496 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
5499 (skip-chars-backward " \t\n\f")
5500 (memq (preceding-char)
5501 (append "$@%&*" nil))))
5507 ;; Skip whitespace and comments...
5508 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
5509 (goto-char (match-end 0))
5510 (skip-chars-forward " \t\n\f"))
5512 (put-text-property b (point) 'syntax-type 'prestring))
5513 ;; qtag means two-arg matcher, may be reset to
5514 ;; 2 or 3 later if some special quoting is needed.
5515 ;; e1 means matching-char matcher.
5516 (setq b (point) ; before the first delimiter
5518 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
5519 ;; We do not search to max, since we may be called from
5520 ;; some hook of fontification, and max is random
5521 i (cperl-forward-re stop-point end
5523 st-l err-l argument)
5524 ;; If `go', then it is considered as 1-arg, `b1' is nil
5525 ;; as in s/foo//x; the point is before final "slash"
5526 b1 (nth 1 i) ; start of the second part
5527 tag (nth 2 i) ; ender-char, true if second part
5528 ; is with matching chars []
5529 go (nth 4 i) ; There is a 1-char part after the end
5530 i (car i) ; intermediate point
5532 ;; Before end of the second part if non-matching: ///
5533 tail (if (and i (not tag))
5535 e (if i i e1) ; end of the first part
5536 qtag nil ; need to preserve backslashitis
5537 is-x-REx nil) ; REx has //x modifier
5538 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
5539 ;; Commenting \\ is dangerous, what about ( ?
5541 (eq (char-after i) ?\\)
5543 (and (if go (looking-at ".\\sw*x")
5544 (looking-at "\\sw*x")) ; qr//x
5547 ;; Considered as 1arg form
5549 (cperl-commentify b (point) t)
5550 (put-text-property b (point) 'syntax-type 'string)
5552 ;; ignore other text properties:
5553 (string-match "^qw$" argument))
5554 (put-text-property b (point) 'indentable t))
5556 (setq e1 (cperl-1+ e1))
5559 (cperl-commentify b i t)
5560 (if (looking-at "\\sw*e") ; s///e
5562 ;; Cache the syntax info...
5563 (setq cperl-syntax-state (cons state-point state))
5566 (car (cperl-find-pods-heres b1 (1- (point)) t end))
5568 (goto-char (1+ max)))
5569 (if (and tag (eq (preceding-char) ?\>))
5571 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
5572 (cperl-modify-syntax-type i cperl-st-bra)))
5573 (put-text-property b i 'syntax-type 'string)
5575 (put-text-property b i 'indentable t)))
5576 (cperl-commentify b1 (point) t)
5577 (put-text-property b (point) 'syntax-type 'string)
5579 (put-text-property b i 'indentable t))
5581 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
5583 ;; Now: tail: if the second part is non-matching without ///e
5584 (if (eq (char-syntax (following-char)) ?w)
5586 (forward-word 1) ; skip modifiers s///s
5587 (if tail (cperl-commentify tail (point) t))
5588 (cperl-postpone-fontification
5589 e1 (point) 'face 'cperl-nonoverridable-face)))
5590 ;; Check whether it is m// which means "previous match"
5591 ;; and highlight differently
5593 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
5594 (or (not (= (length argument) 0))
5598 ;; split // *is* using zero-pattern
5604 (not (looking-at "split\\>")))
5606 (cperl-postpone-fontification
5607 b e 'face font-lock-function-name-face)
5608 (if (or i2 ; Has 2 args
5609 (and cperl-fontify-m-as-s
5611 (string-match "^\\(m\\|qr\\)$" argument)
5612 (and (eq 0 (length argument))
5613 (not (eq ?\< (char-after b)))))))
5615 (cperl-postpone-fontification
5616 b (cperl-1+ b) 'face font-lock-constant-face)
5617 (cperl-postpone-fontification
5618 (1- e) e 'face font-lock-constant-face)))
5619 (if (and is-REx cperl-regexp-scan)
5620 ;; Process RExen: embedded comments, charclasses and ]
5624 (cperl-look-at-leading-count is-x-REx e)
5628 (if (eq (char-after b) ?\#)
5629 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
5630 "\\((\\?#\\)\\|\\(#\\)")
5631 ;; keep the same count: add a fake group
5632 (if (eq (char-after b) ?\#)
5633 "\\((\\?\\\\#\\)\\(\\)"
5634 "\\((\\?#\\)\\(\\)"))
5639 "\\|" ; 5=builtin 0-length, 6
5640 ;; XXXX: what if u is delim?
5644 "[*?+]" ; Do not need \?? !
5650 "\\\\[luLUEQbBAzZG]"
5656 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
5658 "\\?([0-9]+)" ; (?(1)foo|bar)
5662 "\\?" ; (?(?=foo)bar|baz)
5667 "\\\\\\(.\\)" ; 7=\SYMBOL
5668 ;; XXXX Will not be able to use it in s)))
5669 (if (eq (char-after b) ?\) ) ""
5672 (if (eq (char-after b) ?? ) ; 8 = (?{
5673 "\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
5674 "\\((\\?\\(\\?\\)?{\\)"))))) ; 8 = opt ?
5676 (and (< (point) (1- e))
5677 (re-search-forward hairy-RE (1- e) 'to-end))
5678 (goto-char (match-beginning 0))
5679 (setq REx-subgr-start (point)
5683 nil ; Not needed now, when we skip \SYMBOL
5684 (/= (1+ b) (point)) ; \ may be delim
5685 (eq (preceding-char) ?\\)
5686 (= (% (skip-chars-backward "\\\\") 2)
5687 (if (and (eq (char-after b) ?\#)
5688 (eq (following-char) ?\#))
5691 ;; Not a subgr, avoid loop:
5692 (progn (setq was-subgr nil)
5695 ((match-beginning 5) ; 0-length builtins
5696 (setq was-subgr nil) ; We do stuff here
5697 (goto-char (match-end 5))
5700 (cperl-postpone-fontification
5701 (match-beginning 5) (point)
5702 'face font-lock-variable-name-face)
5703 (if (and (memq (string-to-char (match-string 5))
5705 (not (string-match "(\?[-imsx]+)"
5707 (cperl-look-at-leading-count is-x-REx e)))
5708 ((match-beginning 7) ; \SYMBOL
5712 ;; 0-len special-alnums in other branch =>
5713 ;; Generic: \non-alnum (1), \alnum NO
5714 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
5715 ;; How many chars to not highlight
5716 (setq was-subgr (if (eq (char-after b)
5730 (cperl-postpone-fontification
5731 (- (point) 2) (- (point) was-subgr)
5732 'face font-lock-variable-name-face)))
5733 (setq was-subgr nil)) ; We do stuff here
5734 ((match-beginning 3) ; [charclass]
5735 ;; Mismatch for /$patterns->[1]/
5737 (setq qtag 0) ; leaders
5738 (if (eq (char-after b) ?^ )
5739 (and (eq (following-char) ?\\ )
5740 (eq (char-after (cperl-1+ (point)))
5743 (and (eq (following-char) ?^ )
5745 (setq argument b ; continue?
5746 tag nil ; list of POSIX classes
5748 (if (eq (char-after b) ?\] )
5749 (and (eq (following-char) ?\\ )
5750 (eq (char-after (cperl-1+ (point)))
5752 (setq qtag (1+ qtag))
5754 (and (eq (following-char) ?\] )
5756 ;; Apparently, I can't put \] into a charclass
5757 ;; in m]]: m][\\\]\]] produces [\\]]
5758 ;;; POSIX? [:word:] [:^word:] only inside []
5759 ;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
5763 (if (eq (char-after b) ?\] )
5764 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
5765 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
5767 ;; Is this ] the end of POSIX class?
5770 (search-backward "[" argument t)
5771 (< REx-subgr-start (point))
5773 (and ; Should work with delim = \
5774 (eq (preceding-char) ?\\ )
5775 (= (% (skip-chars-backward
5779 ((eq (char-after b) ?\] )
5780 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
5781 ((eq (char-after b) ?\: )
5782 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
5783 ((eq (char-after b) ?^ )
5784 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
5785 ((eq (char-syntax (char-after b))
5788 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
5789 (char-to-string (char-after b))
5791 (t "\\\\*\\[:\\^?\\sw*:]")))
5792 (setq argument (point))))
5793 (setq tag (cons (cons argument (point))
5795 argument (point)) ; continue
5796 (setq argument nil)))
5798 (message "Couldn't find end of charclass in a REx, pos=%s"
5800 (if (and cperl-use-syntax-table-text-property
5801 (> (- (point) 2) REx-subgr-start))
5803 (1+ REx-subgr-start) (1- (point))
5804 'syntax-table cperl-st-punct))
5805 (cperl-postpone-fontification
5806 REx-subgr-start qtag
5807 'face font-lock-variable-name-face)
5808 (cperl-postpone-fontification
5809 (if (eq (char-after b) ?\] )
5812 (point) 'face font-lock-variable-name-face)
5814 (cperl-postpone-fontification
5815 (car (car tag)) (cdr (car tag))
5816 'face font-lock-type-face)
5817 (setq tag (cdr tag)))
5818 (setq was-subgr nil)) ; did facing already
5820 ((and (match-beginning 2) ; #-comment
5821 (/= (match-beginning 2) (match-end 2)))
5822 (beginning-of-line 2)
5824 (goto-char (1- e))))
5825 ((match-beginning 4) ; character "]"
5826 (setq was-subgr nil) ; We do stuff here
5827 (goto-char (match-end 0))
5828 (if cperl-use-syntax-table-text-property
5830 (1- (point)) (point)
5831 'syntax-table cperl-st-punct))
5832 (cperl-postpone-fontification
5833 (1- (point)) (point)
5834 'face font-lock-function-name-face))
5835 ((match-beginning 8) ; (?{})
5836 (setq was-subgr (point)
5840 (cperl-forward-group-in-re st-l))
5842 (setq qtag "no matching `)' found"))
5844 (not (eq (char-after (- (point) 2))
5846 (setq qtag "Can't find })")))
5850 (cperl-postpone-fontification
5851 (1- tag) (1- (point))
5852 'face font-lock-variable-name-face)
5853 (if cperl-use-syntax-table-text-property
5856 (1- (point)) (point)
5857 'syntax-table cperl-st-cfence)
5859 was-subgr (1+ was-subgr)
5860 'syntax-table cperl-st-cfence))))
5861 (setq was-subgr nil))
5863 ;; Inside "(" and "\" arn't special in any way
5864 ;; Works also if the outside delimiters are ().
5865 (or ;;(if (eq (char-after b) ?\) )
5866 ;;(re-search-forward
5867 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
5869 (search-forward ")" (1- e) 'toend)
5872 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
5873 REx-subgr-start)))))
5878 (setq REx-subgr-end (point))
5880 REx-subgr-start REx-subgr-end nil)
5881 (cperl-postpone-fontification
5882 REx-subgr-start REx-subgr-end
5883 'face font-lock-comment-face))))))
5884 (if (and is-REx is-x-REx)
5885 (put-text-property (1+ b) (1- e)
5886 'syntax-subtype 'x-REx)))
5889 (cperl-postpone-fontification
5890 (1- e1) e1 'face font-lock-constant-face)
5891 (if (assoc (char-after b) cperl-starters)
5893 (cperl-postpone-fontification
5894 b1 (1+ b1) 'face font-lock-constant-face)
5895 (put-text-property b1 (1+ b1)
5899 ((match-beginning 17) ; sub with prototype or attribute
5900 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
5901 ;;"\\<sub\\>\\(" ;12
5902 ;; cperl-white-and-comment-rex ;13
5903 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
5904 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
5905 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
5906 (setq b1 (match-beginning 14) e1 (match-end 14))
5907 (if (memq (char-after (1- b))
5908 '(?\$ ?\@ ?\% ?\& ?\*))
5911 (if (eq (char-after (match-beginning 17)) ?\( )
5913 (cperl-commentify ; Prototypes; mark as string
5914 (match-beginning 17) (match-end 17) t)
5915 (goto-char (match-end 0))
5916 ;; Now look for attributes after prototype:
5917 (forward-comment (buffer-size))
5918 (and (looking-at ":[^:]")
5919 (cperl-find-sub-attrs st-l b1 e1 b)))
5920 ;; treat attributes without prototype
5921 (goto-char (match-beginning 17))
5922 (cperl-find-sub-attrs st-l b1 e1 b))))
5923 ;; 1+6+2+1+1+6+1=18 extra () before this:
5924 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
5925 ((match-beginning 19) ; old $abc'efg syntax
5926 (setq bb (match-end 0))
5927 ;;;(if (nth 3 state) nil ; in string
5928 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
5930 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
5931 ;; "__\\(END\\|DATA\\)__"
5932 ((match-beginning 20) ; __END__, __DATA__
5933 (setq bb (match-end 0))
5934 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
5935 (cperl-commentify b bb nil)
5937 ;; "\\\\\\(['`\"($]\\)"
5938 ((match-beginning 21)
5939 ;; Trailing backslash; make non-quoting outside string/comment
5940 (setq bb (match-end 0))
5942 (skip-chars-backward "\\\\")
5943 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
5944 (cperl-modify-syntax-type b cperl-st-punct)
5946 (t (error "Error in regexp of the sniffer")))
5947 (if (> (point) stop-point)
5950 (message "Garbage after __END__/__DATA__ ignored")
5951 (message "Unbalanced syntax found while scanning")
5952 (or (car err-l) (setcar err-l b)))
5953 (goto-char stop-point))))
5954 (setq cperl-syntax-state (cons state-point state)
5955 ;; Do not mark syntax as done past tmpend???
5956 cperl-syntax-done-to (or tmpend (max (point) max)))
5957 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
5959 (if (car err-l) (goto-char (car err-l))
5961 (message "Scanning for \"hard\" Perl constructions... done"))))
5962 (and (buffer-modified-p)
5964 (set-buffer-modified-p nil))
5965 (set-syntax-table cperl-mode-syntax-table))
5966 (list (car err-l) overshoot)))
5968 (defun cperl-find-pods-heres-region (min max)
5970 (cperl-find-pods-heres min max))
5972 (defun cperl-backward-to-noncomment (lim)
5973 ;; Stops at lim or after non-whitespace that is not in comment
5974 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
5976 (while (and (not stop) (> (point) (or lim (point-min))))
5977 (skip-chars-backward " \t\n\f" lim)
5980 (if (memq (setq pr (get-text-property (point) 'syntax-type))
5981 '(pod here-doc here-doc-delim))
5982 (cperl-unwind-to-safe nil)
5983 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
5984 (not (memq pr '(string prestring))))
5985 (progn (cperl-to-comment-or-eol) (bolp))
5987 (skip-chars-backward " \t")
5988 (if (< p (point)) (goto-char p))
5991 ;; Used only in `cperl-calculate-indent'...
5992 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
5993 ;; Positions is before ?\{. Checks whether it starts a block.
5994 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
5995 (cperl-backward-to-noncomment (point-min))
5996 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
5997 ; Label may be mixed up with `$blah :'
5998 (save-excursion (cperl-after-label))
5999 (get-text-property (cperl-1- (point)) 'attrib-group)
6000 (and (memq (char-syntax (preceding-char)) '(?w ?_))
6003 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
6004 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
6005 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
6006 ;; sub bless::foo {}
6008 (cperl-backward-to-noncomment (point-min))
6009 (and (eq (preceding-char) ?b)
6012 (looking-at "sub[ \t\n\f#]")))))))))
6014 ;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
6015 ;;; No save-excursion; condition-case ... In (cperl-block-p) the block
6016 ;;; may be a part of an in-statement construct, such as
6017 ;;; ${something()}, print {FH} $data.
6018 ;;; Moreover, one takes positive approach (looks for else,grep etc)
6019 ;;; another negative (looks for bless,tr etc)
6020 (defun cperl-after-block-p (lim &optional pre-block)
6021 "Return true if the preceeding } (if PRE-BLOCK, following {) delimits a block.
6022 Would not look before LIM. Assumes that LIM is a good place to begin a
6023 statement. The kind of block we treat here is one after which a new
6024 statement would start; thus the block in ${func()} does not count."
6028 (or pre-block (forward-sexp -1))
6029 (cperl-backward-to-noncomment lim)
6030 (or (eq (point) lim)
6031 ;; if () {} // sub f () {} // sub f :a(') {}
6032 (eq (preceding-char) ?\) )
6034 (save-excursion (cperl-after-label))
6036 (get-text-property (cperl-1- (point)) 'attrib-group)
6037 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
6040 ;; else {} but not else::func {}
6041 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
6042 (not (looking-at "\\(\\sw\\|_\\)+::")))
6045 (cperl-backward-to-noncomment lim)
6046 (and (eq (preceding-char) ?b)
6049 (looking-at "sub[ \t\n\f#]"))))))
6050 ;; What preceeds is not word... XXXX Last statement in sub???
6051 (cperl-after-expr-p lim))))
6054 (defun cperl-after-expr-p (&optional lim chars test)
6055 "Return true if the position is good for start of expression.
6056 TEST is the expression to evaluate at the found position. If absent,
6057 CHARS is a string that contains good characters to have before us (however,
6058 `}' is treated \"smartly\" if it is not in the list)."
6059 (let ((lim (or lim (point-min)))
6061 (cperl-update-syntaxification (point) (point))
6063 (while (and (not stop) (> (point) lim))
6064 (skip-chars-backward " \t\n\f" lim)
6067 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
6068 ;; '(pod here-doc here-doc-delim))
6069 (if (get-text-property (point) 'here-doc-group)
6072 (cperl-beginning-of-property (point) 'here-doc-group))
6073 (beginning-of-line 0)))
6074 (if (get-text-property (point) 'in-pod)
6077 (cperl-beginning-of-property (point) 'in-pod))
6078 (beginning-of-line 0)))
6079 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
6080 ;; Else: last iteration, or a label
6081 (cperl-to-comment-or-eol) ; Will not move past "." after a format
6082 (skip-chars-backward " \t")
6083 (if (< p (point)) (goto-char p))
6085 (if (and (eq (preceding-char) ?:)
6088 (skip-chars-backward " \t\n\f" lim)
6089 (memq (char-syntax (preceding-char)) '(?w ?_))))
6090 (forward-sexp -1) ; Possibly label. Skip it
6093 (or (bobp) ; ???? Needed
6095 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
6097 (if test (eval test)
6098 (or (memq (preceding-char) (append (or chars "{;") nil))
6099 (and (eq (preceding-char) ?\})
6100 (cperl-after-block-p lim))
6101 (and (eq (following-char) ?.) ; in format: see comment above
6102 (eq (get-text-property (point) 'syntax-type)
6105 (defun cperl-backward-to-start-of-continued-exp (lim)
6106 (if (memq (preceding-char) (append ")]}\"'`" nil))
6109 (if (<= (point) lim)
6110 (goto-char (1+ lim)))
6111 (skip-chars-forward " \t"))
6113 (defun cperl-after-block-and-statement-beg (lim)
6114 ;; We assume that we are after ?\}
6116 (cperl-after-block-p lim)
6119 (cperl-backward-to-noncomment (point-min))
6122 (not (= (char-syntax (preceding-char)) ?w))
6127 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
6130 (defvar innerloop-done nil)
6131 (defvar last-depth nil)
6133 (defun cperl-indent-exp ()
6134 "Simple variant of indentation of continued-sexp.
6136 Will not indent comment if it starts at `comment-indent' or looks like
6137 continuation of the comment on the previous line.
6139 If `cperl-indent-region-fix-constructs', will improve spacing on
6140 conditional/loop constructs."
6143 (let ((tmp-end (progn (end-of-line) (point))) top done)
6148 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
6150 (setq top (point))) ; Get the outermost parenths in line
6152 (while (< (point) tmp-end)
6153 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
6154 (or (eolp) (forward-sexp 1)))
6155 (if (> (point) tmp-end)
6158 (setq tmp-end (point)))
6161 (setq tmp-end (point-marker)))
6162 (if cperl-indent-region-fix-constructs
6163 (cperl-fix-line-spacing tmp-end))
6164 (cperl-indent-region (point) tmp-end))))
6166 (defun cperl-fix-line-spacing (&optional end parse-data)
6167 "Improve whitespace in a conditional/loop construct.
6168 Returns some position at the last line."
6171 (setq end (point-max)))
6172 (let ((ee (save-excursion (end-of-line) (point)))
6173 (cperl-indent-region-fix-constructs
6174 (or cperl-indent-region-fix-constructs 1))
6175 p pp ml have-brace ret)
6182 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
6183 (setq have-brace (save-excursion (search-forward "}" ee t)))))
6184 nil ; Do not need to do anything
6188 (if (and cperl-merge-trailing-else
6190 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
6192 (search-forward "}")
6194 (skip-chars-forward " \t\n")
6195 (delete-region p (point))
6196 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6197 (beginning-of-line)))
6200 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
6202 (search-forward "}")
6203 (delete-horizontal-space)
6204 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6205 (beginning-of-line)))
6209 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
6212 (delete-horizontal-space)
6213 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6214 (beginning-of-line)))
6218 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
6221 (delete-horizontal-space)
6222 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6223 (beginning-of-line)))
6225 ;; foreach my $var (
6227 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
6230 (delete-horizontal-space)
6232 (make-string cperl-indent-region-fix-constructs ?\ ))
6233 (beginning-of-line)))
6235 ;; } foreach my $var () {
6237 "[ \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]*{")
6239 (setq ml (match-beginning 8))
6240 (re-search-forward "[({]")
6243 (if (eq (following-char) ?\( )
6247 ;; after `else' or nothing
6248 (if ml ; after `else'
6249 (skip-chars-backward " \t\n")
6250 (beginning-of-line))
6252 ;; Now after the sexp before the brace
6253 ;; Multiline expr should be special
6254 (setq ml (and pp (save-excursion (goto-char p)
6255 (search-forward "\n" pp t))))
6256 (if (and (or (not pp) (< pp end))
6257 (looking-at "[ \t\n]*{"))
6260 ((bolp) ; Were before `{', no if/else/etc
6262 ((looking-at "\\(\t*\\| [ \t]+\\){")
6263 (delete-horizontal-space)
6265 cperl-extra-newline-before-brace-multiline
6266 cperl-extra-newline-before-brace)
6268 (delete-horizontal-space)
6271 (if (cperl-indent-line parse-data)
6273 (cperl-fix-line-spacing end parse-data)
6274 (setq ret (point)))))
6276 (make-string cperl-indent-region-fix-constructs ?\ ))))
6277 ((and (looking-at "[ \t]*\n")
6279 cperl-extra-newline-before-brace-multiline
6280 cperl-extra-newline-before-brace)))
6282 (skip-chars-forward " \t\n")
6283 (delete-region pp (point))
6285 (make-string cperl-indent-region-fix-constructs ?\ ))))
6286 ;; Now we are before `{'
6287 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
6289 (skip-chars-forward " \t\n")
6294 (setq ml (search-forward "\n" p t))
6295 (if (or cperl-break-one-line-blocks-when-indent ml)
6296 ;; not good: multi-line BLOCK
6299 (delete-horizontal-space)
6302 (if (cperl-indent-line parse-data)
6303 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
6305 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
6306 ;; Now check whether there is a hanging `}'
6310 cperl-fix-hanging-brace-when-indent
6312 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
6316 (if (and (<= (point) pp)
6317 (eq (preceding-char) ?\} )
6318 (cperl-after-block-and-statement-beg (point-min)))
6325 (skip-chars-backward " \t")
6327 ;; `}' was the first thing on the line, insert NL *after* it.
6329 (cperl-indent-line parse-data)
6330 (search-forward "}")
6331 (delete-horizontal-space)
6333 (delete-horizontal-space)
6334 (or (eq (preceding-char) ?\;)
6336 (and (eq (preceding-char) ?\} )
6337 (cperl-after-block-p (point-min)))
6341 (if (cperl-indent-line parse-data)
6342 (setq ret (cperl-fix-line-spacing end parse-data)))
6343 (beginning-of-line)))))
6346 (defvar cperl-update-start) ; Do not need to make them local
6347 (defvar cperl-update-end)
6348 (defun cperl-delay-update-hook (beg end old-len)
6349 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
6350 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
6352 (defun cperl-indent-region (start end)
6353 "Simple variant of indentation of region in CPerl mode.
6354 Should be slow. Will not indent comment if it starts at `comment-indent'
6355 or looks like continuation of the comment on the previous line.
6356 Indents all the lines whose first character is between START and END
6359 If `cperl-indent-region-fix-constructs', will improve spacing on
6360 conditional/loop constructs."
6362 (cperl-update-syntaxification end end)
6364 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
6365 (let ((indent-info (if cperl-emacs-can-parse
6366 (list nil nil nil) ; Cannot use '(), since will modify
6368 (pm 0) (imenu-scanning-message "Indenting... (%3d%%)")
6369 after-change-functions ; Speed it up!
6370 st comm old-comm-indent new-comm-indent p pp i empty)
6371 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
6373 (setq old-comm-indent (and (cperl-to-comment-or-eol)
6375 new-comm-indent old-comm-indent)
6377 (setq end (set-marker (make-marker) end)) ; indentation changes pos
6378 (or (bolp) (beginning-of-line 2))
6379 (or (fboundp 'imenu-progress-message)
6380 (message "Indenting... For feedback load `imenu'..."))
6381 (while (and (<= (point) end) (not (eobp))) ; bol to check start
6382 (and (fboundp 'imenu-progress-message)
6383 (imenu-progress-message
6384 pm (/ (* 100 (- (point) start)) (- end start -1))))
6387 (setq empty (looking-at "[ \t]*\n"))
6388 (and (setq comm (looking-at "[ \t]*#"))
6389 (or (eq (current-indentation) (or old-comm-indent
6391 (setq old-comm-indent nil))))
6392 (if (and old-comm-indent
6394 (= (current-indentation) old-comm-indent)
6395 (not (eq (get-text-property (point) 'syntax-type) 'pod))
6396 (not (eq (get-text-property (point) 'syntax-table)
6398 (let ((comment-column new-comm-indent))
6399 (indent-for-comment)))
6401 (setq i (cperl-indent-line indent-info))
6405 (if cperl-indent-region-fix-constructs
6406 (goto-char (cperl-fix-line-spacing end indent-info)))
6407 (if (setq old-comm-indent
6408 (and (cperl-to-comment-or-eol)
6409 (not (memq (get-text-property (point)
6412 (not (eq (get-text-property (point)
6416 (progn (indent-for-comment)
6417 (skip-chars-backward " \t")
6418 (skip-chars-backward "#")
6419 (setq new-comm-indent (current-column))))))))
6420 (beginning-of-line 2))
6421 (if (fboundp 'imenu-progress-message)
6422 (imenu-progress-message pm 100)
6424 ;; Now run the update hooks
6425 (and after-change-functions
6428 (goto-char cperl-update-end)
6431 (goto-char cperl-update-start)
6433 (delete-char -1))))))
6435 ;; Stolen from lisp-mode with a lot of improvements
6437 (defun cperl-fill-paragraph (&optional justify iteration)
6438 "Like \\[fill-paragraph], but handle CPerl comments.
6439 If any of the current line is a comment, fill the comment or the
6440 block of it that point is in, preserving the comment's initial
6441 indentation and initial hashes. Behaves usually outside of comment."
6443 (let (;; Non-nil if the current line contains a comment.
6445 fill-paragraph-function ; do not recurse
6446 ;; If has-comment, the appropriate fill-prefix for the comment.
6448 ;; Line that contains code and comment (or nil)
6450 c spaces len dc (comment-column comment-column))
6451 ;; Figure out what kind of comment we are looking at.
6456 ;; A line with nothing but a comment on it?
6457 ((looking-at "[ \t]*#[# \t]*")
6459 comment-fill-prefix (buffer-substring (match-beginning 0)
6462 ;; A line with some code, followed by a comment? Remember that the
6463 ;; semi which starts the comment shouldn't be part of a string or
6465 ((cperl-to-comment-or-eol)
6466 (setq has-comment t)
6467 (looking-at "#+[ \t]*")
6468 (setq start (point) c (current-column)
6470 (concat (make-string (current-column) ?\ )
6471 (buffer-substring (match-beginning 0) (match-end 0)))
6472 spaces (progn (skip-chars-backward " \t")
6473 (buffer-substring (point) start))
6474 dc (- c (current-column)) len (- start (point))
6475 start (point-marker))
6477 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
6478 (if (not has-comment)
6479 (fill-paragraph justify) ; Do the usual thing outside of comment
6480 ;; Narrow to include only the comment, and then fill the region.
6483 ;; Find the first line we should include in the region to fill.
6484 (if start (progn (beginning-of-line) (point))
6486 (while (and (zerop (forward-line -1))
6487 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
6488 ;; We may have gone to far. Go forward again.
6489 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
6492 ;; Find the beginning of the first line past the region to fill.
6494 (while (progn (forward-line 1)
6495 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
6497 ;; Remove existing hashes
6498 (goto-char (point-min))
6499 (while (progn (forward-line 1) (< (point) (point-max)))
6500 (skip-chars-forward " \t")
6501 (if (looking-at "#+")
6503 (if (and (eq (point) (match-beginning 0))
6504 (not (eq (point) (match-end 0)))) nil
6506 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
6507 (delete-char (- (match-end 0) (match-beginning 0))))))
6509 ;; Lines with only hashes on them can be paragraph boundaries.
6510 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
6511 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
6512 (fill-prefix comment-fill-prefix))
6513 (fill-paragraph justify)))
6518 (progn (delete-char dc) (insert spaces)))
6519 (if (or (= (current-column) c) iteration) nil
6520 (setq comment-column c)
6521 (indent-for-comment)
6522 ;; Repeat once more, flagging as iteration
6523 (cperl-fill-paragraph justify t))))))
6526 (defun cperl-do-auto-fill ()
6527 ;; Break out if the line is short enough
6528 (if (> (save-excursion
6532 (let ((c (save-excursion (beginning-of-line)
6533 (cperl-to-comment-or-eol) (point)))
6534 (s (memq (following-char) '(?\ ?\t))) marker)
6535 (if (>= c (point)) nil
6536 (setq marker (point-marker))
6537 (cperl-fill-paragraph)
6539 ;; Is not enough, sometimes marker is a start of line
6540 (if (bolp) (progn (re-search-forward "#+[ \t]*")
6541 (goto-char (match-end 0))))
6542 ;; Following space could have gone:
6543 (if (or (not s) (memq (following-char) '(?\ ?\t))) nil
6546 ;; Previous space could have gone:
6547 (or (memq (preceding-char) '(?\ ?\t)) (insert " "))))))
6549 (defun cperl-imenu-addback (lst &optional isback name)
6550 ;; We suppose that the lst is a DAG, unless the first element only
6551 ;; loops back, and ISBACK is set. Thus this function cannot be
6552 ;; applied twice without ISBACK set.
6553 (cond ((not cperl-imenu-addback) lst)
6556 (setq name "+++BACK+++"))
6557 (mapcar (lambda (elt)
6558 (if (and (listp elt) (listp (cdr elt)))
6560 ;; In the other order it goes up
6561 ;; one level only ;-(
6562 (setcdr elt (cons (cons name lst)
6564 (cperl-imenu-addback (cdr elt) t name))))
6565 (if isback (cdr lst) lst))
6568 (defun cperl-imenu--create-perl-index (&optional regexp)
6570 (require 'imenu) ; May be called from TAGS creator
6571 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
6572 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
6573 (index-meth-alist '()) meth
6574 packages ends-ranges p marker is-proto
6575 (prev-pos 0) is-pack index index1 name (end-range 0) package)
6576 (goto-char (point-min))
6578 (message "Scanning Perl for index")
6579 (imenu-progress-message prev-pos 0))
6580 (cperl-update-syntaxification (point-max) (point-max))
6581 ;; Search for the function
6582 (progn ;;save-match-data
6583 (while (re-search-forward
6584 (or regexp cperl-imenu--function-name-regexp-perl)
6587 (imenu-progress-message prev-pos))
6588 ;; 2=package-group, 5=package-name 8=sub-name
6590 ((and ; Skip some noise if building tags
6591 (match-beginning 5) ; package name
6592 ;;(eq (char-after (match-beginning 2)) ?p) ; package
6593 (not (save-match-data
6594 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
6597 (or (match-beginning 2)
6598 (match-beginning 8)) ; package or sub
6599 ;; Skip if quoted (will not skip multi-line ''-strings :-():
6600 (null (get-text-property (match-beginning 1) 'syntax-table))
6601 (null (get-text-property (match-beginning 1) 'syntax-type))
6602 (null (get-text-property (match-beginning 1) 'in-pod)))
6603 (setq is-pack (match-beginning 2))
6604 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
6605 ;; (goto-char (match-end 0))) ; Messes what follows
6608 (while (and ends-ranges (>= p (car ends-ranges)))
6609 ;; delete obsolete entries
6610 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
6611 (setq package (or (car packages) "")
6612 end-range (or (car ends-ranges) 0))
6613 (if is-pack ; doing "package"
6615 (if (match-beginning 5) ; named package
6616 (setq name (buffer-substring (match-beginning 5)
6619 (set-text-properties 0 (length name) nil name)
6621 package (concat name "::")
6622 name (concat "package " name))
6623 ;; Support nameless packages
6624 (setq name "package;" package ""))
6627 (parse-partial-sexp (point) (point-max) -1) (point))
6628 ends-ranges (cons end-range ends-ranges)
6629 packages (cons package packages)))
6631 (or (eq (following-char) ?\;)
6632 (eq 0 (get-text-property (point) 'attrib-group)))))
6633 ;; Skip this function name if it is a prototype declaration.
6634 (if (and is-proto (not is-pack)) nil
6637 (buffer-substring (match-beginning 8) (match-end 8)))
6638 (set-text-properties 0 (length name) nil name))
6639 (setq marker (make-marker))
6640 (set-marker marker (match-end (if is-pack 2 8)))
6642 ((string-match "[:']" name)
6644 ((> p end-range) nil)
6646 (setq name (concat package name) meth t)))
6647 (setq index (cons name marker))
6649 (push index index-pack-alist)
6650 (push index index-alist))
6651 (if meth (push index index-meth-alist))
6652 (push index index-unsorted-alist)))
6653 ((match-beginning 16) ; POD section
6654 (setq name (buffer-substring (match-beginning 17) (match-end 17))
6655 marker (make-marker))
6656 (set-marker marker (match-beginning 17))
6657 (set-text-properties 0 (length name) nil name)
6658 (setq name (concat (make-string
6659 (* 3 (- (char-after (match-beginning 16)) ?1))
6662 index (cons name marker))
6663 (setq index1 (cons (concat "=" name) (cdr index)))
6664 (push index index-pod-alist)
6665 (push index1 index-unsorted-alist)))))
6667 (imenu-progress-message prev-pos 100))
6669 (if (default-value 'imenu-sort-function)
6670 (sort index-alist (default-value 'imenu-sort-function))
6671 (nreverse index-alist)))
6672 (and index-pod-alist
6673 (push (cons "+POD headers+..."
6674 (nreverse index-pod-alist))
6676 (and (or index-pack-alist index-meth-alist)
6677 (let ((lst index-pack-alist) hier-list pack elt group name)
6678 ;; Remove "package ", reverse and uniquify.
6680 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
6681 (if (assoc name hier-list) nil
6682 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
6683 (setq lst index-meth-alist)
6685 (setq elt (car lst) lst (cdr lst))
6686 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
6687 (setq pack (substring (car elt) 0 (match-beginning 0)))
6688 (if (setq group (assoc pack hier-list))
6689 (if (listp (cdr group))
6690 ;; Have some functions already
6692 (cons (cons (substring
6694 (+ 2 (match-beginning 0)))
6697 (setcdr group (list (cons (substring
6699 (+ 2 (match-beginning 0)))
6703 (list (cons (substring
6705 (+ 2 (match-beginning 0)))
6708 (push (cons "+Hierarchy+..."
6711 (and index-pack-alist
6712 (push (cons "+Packages+..."
6713 (nreverse index-pack-alist))
6715 (and (or index-pack-alist index-pod-alist
6716 (default-value 'imenu-sort-function))
6717 index-unsorted-alist
6718 (push (cons "+Unsorted List+..."
6719 (nreverse index-unsorted-alist))
6721 (cperl-imenu-addback index-alist)))
6724 ;; Suggested by Mark A. Hershberger
6725 (defun cperl-outline-level ()
6726 (looking-at outline-regexp)
6727 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
6728 ;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
6729 ((match-beginning 2) 0) ; package
6730 ((match-beginning 8) 1) ; sub
6731 ((match-beginning 16)
6732 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
6733 (t 5))) ; should not happen
6736 (defvar cperl-compilation-error-regexp-alist
6737 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
6738 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
6740 "Alist that specifies how to match errors in perl output.")
6742 (if (fboundp 'eval-after-load)
6745 '(setq perl-compilation-error-regexp-alist
6746 cperl-compilation-error-regexp-alist)))
6749 (defun cperl-windowed-init ()
6750 "Initialization under windowed version."
6751 (if (or (featurep 'ps-print) cperl-faces-init)
6752 ;; Need to init anyway:
6753 (or cperl-faces-init (cperl-init-faces))
6754 (add-hook 'font-lock-mode-hook
6757 (if (memq major-mode '(perl-mode cperl-mode))
6759 (or cperl-faces-init (cperl-init-faces)))))))
6760 (if (fboundp 'eval-after-load)
6763 '(or cperl-faces-init (cperl-init-faces))))))
6765 (defun cperl-load-font-lock-keywords ()
6766 (or cperl-faces-init (cperl-init-faces))
6767 perl-font-lock-keywords)
6769 (defun cperl-load-font-lock-keywords-1 ()
6770 (or cperl-faces-init (cperl-init-faces))
6771 perl-font-lock-keywords-1)
6773 (defun cperl-load-font-lock-keywords-2 ()
6774 (or cperl-faces-init (cperl-init-faces))
6775 perl-font-lock-keywords-2)
6777 (defvar perl-font-lock-keywords-1 nil
6778 "Additional expressions to highlight in Perl mode. Minimal set.")
6779 (defvar perl-font-lock-keywords nil
6780 "Additional expressions to highlight in Perl mode. Default set.")
6781 (defvar perl-font-lock-keywords-2 nil
6782 "Additional expressions to highlight in Perl mode. Maximal set.")
6784 (defvar font-lock-background-mode)
6785 (defvar font-lock-display-type)
6786 (defun cperl-init-faces-weak ()
6787 ;; Allow `cperl-find-pods-heres' to run.
6788 (or (boundp 'font-lock-constant-face)
6789 (cperl-force-face font-lock-constant-face
6790 "Face for constant and label names")
6791 ;;(setq font-lock-constant-face 'font-lock-constant-face)
6794 (defun cperl-init-faces ()
6795 (condition-case errs
6797 (require 'font-lock)
6798 (and (fboundp 'font-lock-fontify-anchored-keywords)
6799 (featurep 'font-lock-extra)
6800 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
6801 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
6802 (if (fboundp 'font-lock-fontify-anchored-keywords)
6803 (setq font-lock-anchored t))
6805 t-font-lock-keywords
6807 (list "[ \t]+$" 0 cperl-invalid-face t)
6810 "\\(^\\|[^$@%&\\]\\)\\<\\("
6813 '("if" "until" "while" "elsif" "else" "unless" "for"
6814 "foreach" "continue" "exit" "die" "last" "goto" "next"
6815 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
6816 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
6817 "\\|") ; Flow control
6818 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
6819 ; In what follows we use `type' style
6820 ; for overwritable builtins
6823 "\\(^\\|[^$@%&\\]\\)\\<\\("
6824 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
6825 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
6826 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
6827 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
6828 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
6829 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
6830 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
6831 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
6832 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
6833 ;; "gethostbyname" "gethostent" "getlogin"
6834 ;; "getnetbyaddr" "getnetbyname" "getnetent"
6835 ;; "getpeername" "getpgrp" "getppid" "getpriority"
6836 ;; "getprotobyname" "getprotobynumber" "getprotoent"
6837 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
6838 ;; "getservbyport" "getservent" "getsockname"
6839 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
6840 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
6841 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
6842 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
6843 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
6844 ;; "quotemeta" "rand" "read" "readdir" "readline"
6845 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
6846 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
6847 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
6848 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
6849 ;; "setpriority" "setprotoent" "setpwent" "setservent"
6850 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
6851 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
6852 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
6853 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
6854 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
6855 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
6856 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
6857 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
6858 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
6859 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
6860 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
6861 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
6862 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
6863 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
6864 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
6865 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
6866 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
6867 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
6868 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
6869 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
6870 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
6871 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
6872 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
6873 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
6874 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
6875 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
6876 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
6877 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
6878 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
6879 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
6880 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
6881 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
6882 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
6883 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
6884 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
6885 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
6886 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
6887 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
6888 "\\)\\>") 2 'font-lock-type-face)
6889 ;; In what follows we use `other' style
6890 ;; for nonoverwritable builtins
6891 ;; Somehow 's', 'm' are not auto-generated???
6894 "\\(^\\|[^$@%&\\]\\)\\<\\("
6895 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
6896 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
6897 ;; "eval" "exists" "for" "foreach" "format" "goto"
6898 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
6899 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
6900 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
6901 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
6902 ;; "undef" "unless" "unshift" "untie" "until" "use"
6904 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
6905 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
6906 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
6907 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
6908 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
6909 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
6910 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
6911 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
6912 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
6913 "\\|[sm]" ; Added manually
6914 "\\)\\>") 2 'cperl-nonoverridable-face)
6915 ;; (mapconcat 'identity
6916 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
6917 ;; "#include" "#define" "#undef")
6919 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
6920 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
6921 ;; This highlights declarations and definitions differenty.
6922 ;; We do not try to highlight in the case of attributes:
6923 ;; it is already done by `cperl-find-pods-heres'
6924 (list (concat "\\<sub"
6925 cperl-white-and-comment-rex ; whitespace/comments
6926 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
6928 cperl-maybe-white-and-comment-rex ;whitespace/comments?
6929 "([^()]*)\\)?" ; prototype
6930 cperl-maybe-white-and-comment-rex ; whitespace/comments?
6932 2 (if cperl-font-lock-multiline
6933 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
6934 'font-lock-function-name-face
6935 'font-lock-variable-name-face)
6936 ;; need to manually set 'multiline' for older font-locks
6938 (if (< 1 (count-lines (match-beginning 0)
6941 (+ 3 (match-beginning 0)) (match-end 0)
6942 'syntax-type 'multiline))
6943 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
6944 'font-lock-function-name-face
6945 'font-lock-variable-name-face))))
6946 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
6947 2 font-lock-function-name-face)
6948 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
6949 1 font-lock-function-name-face)
6950 (cond ((featurep 'font-lock-extra)
6951 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
6952 (2 font-lock-string-face t)
6953 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
6955 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
6956 (2 font-lock-string-face t)
6957 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
6959 (1 font-lock-string-face t))))
6960 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
6961 2 font-lock-string-face t)))
6962 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
6963 font-lock-string-face t)
6964 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
6965 font-lock-constant-face) ; labels
6966 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
6967 2 font-lock-constant-face)
6968 ;; Uncomment to get perl-mode-like vars
6969 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
6970 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
6971 ;;; (2 (cons font-lock-variable-name-face '(underline))))
6972 (cond ((featurep 'font-lock-extra)
6973 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
6974 (3 font-lock-variable-name-face)
6976 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
6977 (1 font-lock-variable-name-face)
6978 (2 '(restart 2 nil) nil t)))
6979 nil t))) ; local variables, multiple
6981 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
6982 (` ((, (concat "\\<\\(my\\|local\\|our\\)"
6983 cperl-maybe-white-and-comment-rex
6985 cperl-maybe-white-and-comment-rex
6986 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)"))
6987 (5 (, (if cperl-font-lock-multiline
6988 'font-lock-variable-name-face
6989 '(progn (setq cperl-font-lock-multiline-start
6990 (match-beginning 0))
6991 'font-lock-variable-name-face))))
6993 cperl-maybe-white-and-comment-rex
6995 cperl-maybe-white-and-comment-rex
6996 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)"))
6997 ;; Bug in font-lock: limit is used not only to limit
6998 ;; searches, but to set the "extend window for
6999 ;; facification" property. Thus we need to minimize.
7000 (, (if cperl-font-lock-multiline
7001 '(if (match-beginning 3)
7003 (goto-char (match-beginning 3))
7009 (error nil)))) ; typeahead
7010 (1- (point))) ; report limit
7011 (forward-char -2)) ; disable continued expr
7012 '(if (match-beginning 3)
7013 (point-max) ; No limit for continuation
7014 (forward-char -2)))) ; disable continued expr
7015 (, (if cperl-font-lock-multiline
7018 ;; "my" may be already fontified (POD),
7019 ;; so cperl-font-lock-multiline-start is nil
7020 (if (or (not cperl-font-lock-multiline-start)
7022 cperl-font-lock-multiline-start
7026 (1+ cperl-font-lock-multiline-start) (point)
7027 'syntax-type 'multiline))
7028 (setq cperl-font-lock-multiline-start nil))))
7029 (3 font-lock-variable-name-face)))))
7030 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
7031 3 font-lock-variable-name-face)))
7032 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
7033 4 font-lock-variable-name-face)))
7035 t-font-lock-keywords-1
7036 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
7037 ;; not yet as of XEmacs 19.12, works with 21.1.11
7039 (not cperl-xemacs-p)
7040 (string< "21.1.9" emacs-version)
7041 (and (string< "21.1.10" emacs-version)
7042 (string< emacs-version "21.1.2")))
7044 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
7045 (if (eq (char-after (match-beginning 2)) ?%)
7048 t) ; arrays and hashes
7049 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
7051 (if (= (- (match-end 2) (match-beginning 2)) 1)
7052 (if (eq (char-after (match-beginning 3)) ?{)
7054 cperl-array-face) ; arrays and hashes
7055 font-lock-variable-name-face) ; Just to put something
7057 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
7058 ;;; Too much noise from \s* @s[ and friends
7059 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
7060 ;;(3 font-lock-function-name-face t t)
7062 ;; (if (cperl-slash-is-regexp)
7063 ;; font-lock-function-name-face 'default) nil t))
7065 (if cperl-highlight-variables-indiscriminately
7066 (setq t-font-lock-keywords-1
7067 (append t-font-lock-keywords-1
7068 (list '("[$*]{?\\(\\sw+\\)" 1
7069 font-lock-variable-name-face)))))
7070 (setq perl-font-lock-keywords-1
7071 (if cperl-syntaxify-by-font-lock
7072 (cons 'cperl-fontify-update
7073 t-font-lock-keywords)
7074 t-font-lock-keywords)
7075 perl-font-lock-keywords perl-font-lock-keywords-1
7076 perl-font-lock-keywords-2 (append
7077 perl-font-lock-keywords-1
7078 t-font-lock-keywords-1)))
7079 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
7080 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
7081 (eval ; Avoid a warning
7082 '(font-lock-require-faces
7084 ;; Color-light Color-dark Gray-light Gray-dark Mono
7085 (list 'font-lock-comment-face
7086 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
7091 (list 'font-lock-string-face
7092 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
7097 (list 'font-lock-function-name-face
7099 "Blue" "LightSkyBlue" "Gray50" "LightGray"
7100 (cdr (assq 'background-color ; if mono
7101 (frame-parameters))))
7104 (cdr (assq 'foreground-color ; if mono
7105 (frame-parameters))))
7109 (list 'font-lock-variable-name-face
7110 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
7115 (list 'font-lock-type-face
7116 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
7121 (list 'font-lock-constant-face
7122 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
7127 (list 'cperl-nonoverridable-face
7128 ["chartreuse3" ("orchid1" "orange")
7134 (list 'cperl-array-face
7135 ["blue" "yellow" nil "Gray80"]
7136 ["lightyellow2" ("navy" "os2blue" "darkgreen")
7141 (list 'cperl-hash-face
7142 ["red" "red" nil "Gray80"]
7143 ["lightyellow2" ("navy" "os2blue" "darkgreen")
7148 ;; Do it the dull way, without choose-color
7149 (defvar cperl-guessed-background nil
7150 "Display characteristics as guessed by cperl.")
7151 ;; (or (fboundp 'x-color-defined-p)
7152 ;; (defalias 'x-color-defined-p
7153 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
7154 ;; ;; XEmacs >= 19.12
7155 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
7157 ;; (t 'x-valid-color-name-p))))
7158 (cperl-force-face font-lock-constant-face
7159 "Face for constant and label names")
7160 (cperl-force-face font-lock-variable-name-face
7161 "Face for variable names")
7162 (cperl-force-face font-lock-type-face
7163 "Face for data types")
7164 (cperl-force-face cperl-nonoverridable-face
7165 "Face for data types from another group")
7166 (cperl-force-face font-lock-comment-face
7167 "Face for comments")
7168 (cperl-force-face font-lock-function-name-face
7169 "Face for function names")
7170 (cperl-force-face cperl-hash-face
7172 (cperl-force-face cperl-array-face
7174 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
7175 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
7176 ;;(or (boundp 'font-lock-type-face)
7177 ;; (defconst font-lock-type-face
7178 ;; 'font-lock-type-face
7179 ;; "Face to use for data types."))
7180 ;;(or (boundp 'cperl-nonoverridable-face)
7181 ;; (defconst cperl-nonoverridable-face
7182 ;; 'cperl-nonoverridable-face
7183 ;; "Face to use for data types from another group."))
7184 ;;(if (not cperl-xemacs-p) nil
7185 ;; (or (boundp 'font-lock-comment-face)
7186 ;; (defconst font-lock-comment-face
7187 ;; 'font-lock-comment-face
7188 ;; "Face to use for comments."))
7189 ;; (or (boundp 'font-lock-keyword-face)
7190 ;; (defconst font-lock-keyword-face
7191 ;; 'font-lock-keyword-face
7192 ;; "Face to use for keywords."))
7193 ;; (or (boundp 'font-lock-function-name-face)
7194 ;; (defconst font-lock-function-name-face
7195 ;; 'font-lock-function-name-face
7196 ;; "Face to use for function names.")))
7198 (not (cperl-is-face 'cperl-array-face))
7199 (cperl-is-face 'font-lock-emphasized-face))
7200 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
7202 (not (cperl-is-face 'cperl-hash-face))
7203 (cperl-is-face 'font-lock-other-emphasized-face))
7204 (copy-face 'font-lock-other-emphasized-face
7207 (not (cperl-is-face 'cperl-nonoverridable-face))
7208 (cperl-is-face 'font-lock-other-type-face))
7209 (copy-face 'font-lock-other-type-face
7210 'cperl-nonoverridable-face))
7211 ;;(or (boundp 'cperl-hash-face)
7212 ;; (defconst cperl-hash-face
7214 ;; "Face to use for hashes."))
7215 ;;(or (boundp 'cperl-array-face)
7216 ;; (defconst cperl-array-face
7217 ;; 'cperl-array-face
7218 ;; "Face to use for arrays."))
7219 ;; Here we try to guess background
7221 (if (boundp 'font-lock-background-mode)
7222 font-lock-background-mode
7224 (face-list (and (fboundp 'face-list) (face-list))))
7225 ;;;; (fset 'cperl-is-face
7226 ;;;; (cond ((fboundp 'find-face)
7227 ;;;; (symbol-function 'find-face))
7229 ;;;; (function (lambda (face) (member face face-list))))
7231 ;;;; (function (lambda (face) (boundp face))))))
7232 (defvar cperl-guessed-background
7233 (if (and (boundp 'font-lock-display-type)
7234 (eq font-lock-display-type 'grayscale))
7237 "Background as guessed by CPerl mode")
7238 (and (not (cperl-is-face 'font-lock-constant-face))
7239 (cperl-is-face 'font-lock-reference-face)
7240 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
7241 (if (cperl-is-face 'font-lock-type-face) nil
7242 (copy-face 'default 'font-lock-type-face)
7244 ((eq background 'light)
7245 (set-face-foreground 'font-lock-type-face
7246 (if (x-color-defined-p "seagreen")
7249 ((eq background 'dark)
7250 (set-face-foreground 'font-lock-type-face
7251 (if (x-color-defined-p "os2pink")
7255 (set-face-background 'font-lock-type-face "gray90"))))
7256 (if (cperl-is-face 'cperl-nonoverridable-face)
7258 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
7260 ((eq background 'light)
7261 (set-face-foreground 'cperl-nonoverridable-face
7262 (if (x-color-defined-p "chartreuse3")
7265 ((eq background 'dark)
7266 (set-face-foreground 'cperl-nonoverridable-face
7267 (if (x-color-defined-p "orchid1")
7270 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
7271 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
7273 ;;; ((eq background 'light)
7274 ;;; (set-face-background 'font-lock-other-emphasized-face
7275 ;;; (if (x-color-defined-p "lightyellow2")
7277 ;;; (if (x-color-defined-p "lightyellow")
7279 ;;; "light yellow"))))
7280 ;;; ((eq background 'dark)
7281 ;;; (set-face-background 'font-lock-other-emphasized-face
7282 ;;; (if (x-color-defined-p "navy")
7284 ;;; (if (x-color-defined-p "darkgreen")
7286 ;;; "dark green"))))
7287 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
7288 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
7289 ;;; (copy-face 'bold 'font-lock-emphasized-face)
7291 ;;; ((eq background 'light)
7292 ;;; (set-face-background 'font-lock-emphasized-face
7293 ;;; (if (x-color-defined-p "lightyellow2")
7295 ;;; "lightyellow")))
7296 ;;; ((eq background 'dark)
7297 ;;; (set-face-background 'font-lock-emphasized-face
7298 ;;; (if (x-color-defined-p "navy")
7300 ;;; (if (x-color-defined-p "darkgreen")
7302 ;;; "dark green"))))
7303 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
7304 (if (cperl-is-face 'font-lock-variable-name-face) nil
7305 (copy-face 'italic 'font-lock-variable-name-face))
7306 (if (cperl-is-face 'font-lock-constant-face) nil
7307 (copy-face 'italic 'font-lock-constant-face))))
7308 (setq cperl-faces-init t))
7309 (error (message "cperl-init-faces (ignored): %s" errs))))
7312 (defun cperl-ps-print-init ()
7313 "Initialization of `ps-print' components for faces used in CPerl."
7314 (eval-after-load "ps-print"
7315 '(setq ps-bold-faces
7316 ;; font-lock-variable-name-face
7317 ;; font-lock-constant-face
7318 (append '(cperl-array-face
7322 ;; font-lock-constant-face
7323 (append '(cperl-nonoverridable-face
7327 ;; font-lock-type-face
7328 (append '(cperl-array-face
7331 cperl-nonoverridable-face)
7332 ps-underlined-faces))))
7334 (defvar ps-print-face-extension-alist)
7336 (defun cperl-ps-print (&optional file)
7337 "Pretty-print in CPerl style.
7338 If optional argument FILE is an empty string, prints to printer, otherwise
7339 to the file FILE. If FILE is nil, prompts for a file name.
7341 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
7344 (setq file (read-from-minibuffer
7345 "Print to file (if empty - to printer): "
7346 (concat (buffer-file-name) ".ps")
7347 nil nil 'file-name-history)))
7348 (or (> (length file) 0)
7350 (require 'ps-print) ; To get ps-print-face-extension-alist
7351 (let ((ps-print-color-p t)
7352 (ps-print-face-extension-alist ps-print-face-extension-alist))
7353 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
7354 (ps-print-buffer-with-faces file)))
7356 ;;; (defun cperl-ps-print-init ()
7357 ;;; "Initialization of `ps-print' components for faces used in CPerl."
7358 ;;; ;; Guard against old versions
7359 ;;; (defvar ps-underlined-faces nil)
7360 ;;; (defvar ps-bold-faces nil)
7361 ;;; (defvar ps-italic-faces nil)
7362 ;;; (setq ps-bold-faces
7363 ;;; (append '(font-lock-emphasized-face
7364 ;;; cperl-array-face
7365 ;;; font-lock-keyword-face
7366 ;;; font-lock-variable-name-face
7367 ;;; font-lock-constant-face
7368 ;;; font-lock-reference-face
7369 ;;; font-lock-other-emphasized-face
7370 ;;; cperl-hash-face)
7372 ;;; (setq ps-italic-faces
7373 ;;; (append '(cperl-nonoverridable-face
7374 ;;; font-lock-constant-face
7375 ;;; font-lock-reference-face
7376 ;;; font-lock-other-emphasized-face
7377 ;;; cperl-hash-face)
7378 ;;; ps-italic-faces))
7379 ;;; (setq ps-underlined-faces
7380 ;;; (append '(font-lock-emphasized-face
7381 ;;; cperl-array-face
7382 ;;; font-lock-other-emphasized-face
7384 ;;; cperl-nonoverridable-face font-lock-type-face)
7385 ;;; ps-underlined-faces))
7386 ;;; (cons 'font-lock-type-face ps-underlined-faces))
7389 (if (cperl-enable-font-lock) (cperl-windowed-init))
7391 (defconst cperl-styles-entries
7392 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
7393 cperl-label-offset cperl-extra-newline-before-brace
7394 cperl-merge-trailing-else
7395 cperl-continued-statement-offset))
7397 (defconst cperl-style-alist
7398 '(("CPerl" ; =GNU without extra-newline-before-brace
7399 (cperl-indent-level . 2)
7400 (cperl-brace-offset . 0)
7401 (cperl-continued-brace-offset . 0)
7402 (cperl-label-offset . -2)
7403 (cperl-extra-newline-before-brace . nil)
7404 (cperl-merge-trailing-else . t)
7405 (cperl-continued-statement-offset . 2))
7406 ("PerlStyle" ; CPerl with 4 as indent
7407 (cperl-indent-level . 4)
7408 (cperl-brace-offset . 0)
7409 (cperl-continued-brace-offset . 0)
7410 (cperl-label-offset . -4)
7411 (cperl-extra-newline-before-brace . nil)
7412 (cperl-merge-trailing-else . t)
7413 (cperl-continued-statement-offset . 4))
7415 (cperl-indent-level . 2)
7416 (cperl-brace-offset . 0)
7417 (cperl-continued-brace-offset . 0)
7418 (cperl-label-offset . -2)
7419 (cperl-extra-newline-before-brace . t)
7420 (cperl-merge-trailing-else . nil)
7421 (cperl-continued-statement-offset . 2))
7423 (cperl-indent-level . 5)
7424 (cperl-brace-offset . 0)
7425 (cperl-continued-brace-offset . -5)
7426 (cperl-label-offset . -5)
7427 ;;(cperl-extra-newline-before-brace . nil) ; ???
7428 (cperl-merge-trailing-else . nil)
7429 (cperl-continued-statement-offset . 5))
7431 (cperl-indent-level . 4)
7432 (cperl-brace-offset . 0)
7433 (cperl-continued-brace-offset . -4)
7434 (cperl-label-offset . -4)
7435 ;;(cperl-extra-newline-before-brace . nil) ; ???
7436 (cperl-continued-statement-offset . 4))
7438 (cperl-indent-level . 4)
7439 (cperl-brace-offset . 0)
7440 (cperl-continued-brace-offset . -4)
7441 (cperl-label-offset . -4)
7442 (cperl-continued-statement-offset . 4)
7443 (cperl-merge-trailing-else . nil)
7444 (cperl-extra-newline-before-brace . t))
7447 (cperl-indent-level . 4)
7448 (cperl-brace-offset . 0)
7449 (cperl-continued-brace-offset . 0)
7450 (cperl-label-offset . -4)
7451 ;;(cperl-extra-newline-before-brace . nil) ; ???
7452 (cperl-continued-statement-offset . 4)))
7453 "(Experimental) list of variables to set to get a particular indentation style.
7454 Should be used via `cperl-set-style' or via Perl menu.")
7456 (defun cperl-set-style (style)
7457 "Set CPerl mode variables to use one of several different indentation styles.
7458 The arguments are a string representing the desired style.
7459 The list of styles is in `cperl-style-alist', available styles
7460 are GNU, K&R, BSD, C++ and Whitesmith.
7462 The current value of style is memorized (unless there is a memorized
7463 data already), may be restored by `cperl-set-style-back'.
7465 Chosing \"Current\" style will not change style, so this may be used for
7466 side-effect of memorizing only."
7468 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
7469 cperl-style-alist)))
7470 (list (completing-read "Enter style: " list nil 'insist))))
7472 (setq cperl-old-style
7475 (cons name (eval name))))
7476 cperl-styles-entries)))
7477 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
7479 (setq setting (car style) style (cdr style))
7480 (set (car setting) (cdr setting)))))
7482 (defun cperl-set-style-back ()
7483 "Restore a style memorised by `cperl-set-style'."
7485 (or cperl-old-style (error "The style was not changed"))
7487 (while cperl-old-style
7488 (setq setting (car cperl-old-style)
7489 cperl-old-style (cdr cperl-old-style))
7490 (set (car setting) (cdr setting)))))
7492 (defun cperl-check-syntax ()
7494 (require 'mode-compile)
7495 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
7496 (eval '(mode-compile)))) ; Avoid a warning
7498 (defun cperl-info-buffer (type)
7499 ;; Returns buffer with documentation. Creates if missing.
7500 ;; If TYPE, this vars buffer.
7501 ;; Special care is taken to not stomp over an existing info buffer
7502 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
7503 (info (get-buffer bname))
7504 (oldbuf (get-buffer "*info*")))
7506 (save-window-excursion
7511 (rename-buffer "*info-perl-tmp*")))
7512 (save-window-excursion
7514 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
7515 (set-buffer "*info*")
7516 (rename-buffer bname)
7518 (set-buffer "*info-perl-tmp*")
7519 (rename-buffer "*info*")
7520 (set-buffer bname)))
7521 (make-local-variable 'window-min-height)
7522 (setq window-min-height 2)
7523 (current-buffer)))))
7525 (defun cperl-word-at-point (&optional p)
7526 "Return the word at point or at P."
7528 (if p (goto-char p))
7529 (or (cperl-word-at-point-hard)
7532 (funcall (or (and (boundp 'find-tag-default-function)
7533 find-tag-default-function)
7534 (get major-mode 'find-tag-default-function)
7535 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
7536 ;; automatically used within `find-tag-default':
7537 'find-tag-default))))))
7539 (defun cperl-info-on-command (command)
7540 "Show documentation for Perl command COMMAND in other window.
7541 If perl-info buffer is shown in some frame, uses this frame.
7542 Customized by setting variables `cperl-shrink-wrap-info-frame',
7543 `cperl-max-help-size'."
7545 (let* ((default (cperl-word-at-point))
7547 (format "Find doc for Perl function (default %s): "
7549 (list (if (equal read "")
7553 (let ((buffer (current-buffer))
7554 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
7555 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
7556 max-height char-height buf-list)
7557 (if (string-match "^-[a-zA-Z]$" command)
7558 (setq cmd-desc "^-X[ \t\n]"))
7559 (setq isvar (string-match "^[$@%]" command)
7560 buf (cperl-info-buffer isvar)
7561 iniwin (selected-window)
7562 fr1 (window-frame iniwin))
7564 (goto-char (point-min))
7566 (progn (re-search-forward "^-X[ \t\n]")
7568 (if (re-search-forward cmd-desc nil t)
7570 ;; Go back to beginning of the group (ex, for qq)
7571 (if (re-search-backward "^[ \t\n\f]")
7576 buf-list (list buf "*info-perl-var*" "*info-perl*"))
7577 (while (and (not win) buf-list)
7578 (setq win (get-buffer-window (car buf-list) t))
7579 (setq buf-list (cdr buf-list)))
7581 (eq (window-buffer win) buf)
7582 (set-window-buffer win buf))
7583 (and win (setq fr2 (window-frame win)))
7584 (if (or (not fr2) (eq fr1 fr2))
7586 (special-display-popup-frame buf) ; Make it visible
7587 (select-window win))
7588 (goto-char pos) ; Needed (?!).
7590 (setq iniheight (window-height)
7591 frheight (frame-height)
7592 not-loner (< iniheight (1- frheight))) ; Are not alone
7593 (cond ((if not-loner cperl-max-help-size
7594 cperl-shrink-wrap-info-frame)
7600 (if (re-search-forward
7601 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
7602 (match-beginning 0) (point-max)))))
7605 (/ (* (- frheight 3) cperl-max-help-size) 100)
7606 (setq char-height (frame-char-height))
7607 ;; Non-functioning under OS/2:
7608 (if (eq char-height 1) (setq char-height 18))
7609 ;; Title, menubar, + 2 for slack
7610 (- (/ (x-display-pixel-height) char-height) 4)))
7611 (if (> height max-height) (setq height max-height))
7612 ;;(message "was %s doing %s" iniheight height)
7614 (enlarge-window (- height iniheight))
7615 (set-frame-height (window-frame win) (1+ height)))))
7616 (set-window-start (selected-window) pos))
7617 (message "No entry for %s found." command))
7618 ;;(pop-to-buffer buffer)
7619 (select-window iniwin)))
7621 (defun cperl-info-on-current-command ()
7622 "Show documentation for Perl command at point in other window."
7624 (cperl-info-on-command (cperl-word-at-point)))
7626 (defun cperl-imenu-info-imenu-search ()
7627 (if (looking-at "^-X[ \t\n]") nil
7629 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
7632 (defun cperl-imenu-info-imenu-name ()
7634 (match-beginning 1) (match-end 1)))
7636 (defun cperl-imenu-on-info ()
7637 "Shows imenu for Perl Info Buffer.
7638 Opens Perl Info buffer if needed."
7640 (let* ((buffer (current-buffer))
7641 imenu-create-index-function
7642 imenu-prev-index-position-function
7643 imenu-extract-index-name-function
7644 (index-item (save-restriction
7645 (save-window-excursion
7646 (set-buffer (cperl-info-buffer nil))
7647 (setq imenu-create-index-function
7648 'imenu-default-create-index-function
7649 imenu-prev-index-position-function
7650 'cperl-imenu-info-imenu-search
7651 imenu-extract-index-name-function
7652 'cperl-imenu-info-imenu-name)
7653 (imenu-choose-buffer-index)))))
7657 (pop-to-buffer "*info-perl*")
7659 ((markerp (cdr index-item))
7660 (goto-char (marker-position (cdr index-item))))
7662 (goto-char (cdr index-item))))
7663 (set-window-start (selected-window) (point))
7664 (pop-to-buffer buffer)))))
7666 (defun cperl-lineup (beg end &optional step minshift)
7667 "Lineup construction in a region.
7668 Beginning of region should be at the start of a construction.
7669 All first occurrences of this construction in the lines that are
7670 partially contained in the region are lined up at the same column.
7672 MINSHIFT is the minimal amount of space to insert before the construction.
7673 STEP is the tabwidth to position constructions.
7674 If STEP is nil, `cperl-lineup-step' will be used
7675 \(or `cperl-indent-level', if `cperl-lineup-step' is `nil').
7676 Will not move the position at the start to the left."
7678 (let (search col tcol seen b)
7682 (setq end (point-marker))
7684 (skip-chars-forward " \t\f")
7685 (setq beg (point-marker))
7686 (indent-region beg end nil)
7688 (setq col (current-column))
7689 (if (looking-at "[a-zA-Z0-9_]")
7690 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
7694 (buffer-substring (match-beginning 0)
7695 (match-end 0))) "\\>"))
7696 (error "Cannot line up in a middle of the word"))
7697 (if (looking-at "$")
7698 (error "Cannot line up end of line"))
7699 (setq search (regexp-quote (char-to-string (following-char)))))
7700 (setq step (or step cperl-lineup-step cperl-indent-level))
7701 (or minshift (setq minshift 1))
7703 (beginning-of-line 2)
7704 (and (< (point) end)
7705 (re-search-forward search end t)
7706 (goto-char (match-beginning 0))))
7707 (setq tcol (current-column) seen t)
7708 (if (> tcol col) (setq col tcol)))
7710 (error "The construction to line up occurred only once"))
7712 (setq col (+ col minshift))
7713 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
7716 (cperl-make-indent col)
7717 (beginning-of-line 2)
7718 (and (< (point) end)
7719 (re-search-forward search end t)
7720 (goto-char (match-beginning 0)))))))) ; No body
7722 (defun cperl-etags (&optional add all files) ;; NOT USED???
7723 "Run etags with appropriate options for Perl files.
7724 If optional argument ALL is `recursive', will process Perl files
7725 in subdirectories too."
7728 (args '("-l" "none" "-r"
7729 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
7730 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
7732 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
7734 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
7736 (if add (setq args (cons "-a" args)))
7737 (or files (setq files (list buffer-file-name)))
7739 ((eq all 'recursive)
7740 ;;(error "Not implemented: recursive")
7741 (setq args (append (list "-e"
7742 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
7744 find(\\&wanted, '.');
7749 ;;(error "Not implemented: all")
7750 (setq args (append (list "-e"
7751 "push @ARGV, <*.PL *.pl *.pm>;
7756 (setq args (append args files))))
7757 (setq res (apply 'call-process cmd nil nil nil args))
7759 (message "etags returned \"%s\"" res))))
7761 (defun cperl-toggle-auto-newline ()
7762 "Toggle the state of `cperl-auto-newline'."
7764 (setq cperl-auto-newline (not cperl-auto-newline))
7765 (message "Newlines will %sbe auto-inserted now."
7766 (if cperl-auto-newline "" "not ")))
7768 (defun cperl-toggle-abbrev ()
7769 "Toggle the state of automatic keyword expansion in CPerl mode."
7771 (abbrev-mode (if abbrev-mode 0 1))
7772 (message "Perl control structure will %sbe auto-inserted now."
7773 (if abbrev-mode "" "not ")))
7776 (defun cperl-toggle-electric ()
7777 "Toggle the state of parentheses doubling in CPerl mode."
7779 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
7780 (message "Parentheses will %sbe auto-doubled now."
7781 (if (cperl-val 'cperl-electric-parens) "" "not ")))
7783 (defun cperl-toggle-autohelp ()
7784 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
7785 Delay of auto-help controlled by `cperl-lazy-help-time'."
7787 (if (fboundp 'run-with-idle-timer)
7789 (if cperl-lazy-installed
7790 (cperl-lazy-unstall)
7791 (cperl-lazy-install))
7792 (message "Perl help messages will %sbe automatically shown now."
7793 (if cperl-lazy-installed "" "not ")))
7794 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
7796 (defun cperl-toggle-construct-fix ()
7797 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
7799 (setq cperl-indent-region-fix-constructs
7800 (if cperl-indent-region-fix-constructs
7803 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
7804 (if cperl-indent-region-fix-constructs "" "not ")))
7806 (defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
7807 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
7808 Nonpositive numeric argument disables debugging messages. The message
7809 summarizes which regions it was decided to rescan for syntactic constructs.
7811 The message looks like this:
7813 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
7815 Numbers are character positions in the buffer. REQ provides the range to
7816 rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
7817 for correct operation it should start and end outside any special syntactic
7818 construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
7822 (setq arg (if (eq cperl-syntaxify-by-font-lock
7823 (if backtrace 'backtrace 'message)) 0 1)))
7824 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
7825 (setq cperl-syntaxify-by-font-lock arg)
7826 (message "Debugging messages of syntax unwind %sabled."
7827 (if (eq arg t) "dis" "en")))
7829 ;;;; Tags file creation.
7831 (defvar cperl-tmp-buffer " *cperl-tmp*")
7833 (defun cperl-setup-tmp-buf ()
7834 (set-buffer (get-buffer-create cperl-tmp-buffer))
7835 (set-syntax-table cperl-mode-syntax-table)
7836 (buffer-disable-undo)
7838 (if cperl-use-syntax-table-text-property-for-tags
7840 (make-local-variable 'parse-sexp-lookup-properties)
7841 ;; Do not introduce variable if not needed, we check it!
7842 (set 'parse-sexp-lookup-properties t))))
7844 (defun cperl-xsub-scan ()
7847 (let ((index-alist '())
7848 (prev-pos 0) index index1 name package prefix)
7849 (goto-char (point-min))
7851 (message "Scanning XSUB for index")
7852 (imenu-progress-message prev-pos 0))
7853 ;; Search for the function
7854 (progn ;;save-match-data
7855 (while (re-search-forward
7856 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
7859 (imenu-progress-message prev-pos))
7861 ((match-beginning 2) ; SECTION
7862 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
7863 (goto-char (match-beginning 0))
7864 (skip-chars-forward " \t")
7866 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
7867 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
7869 ((not package) nil) ; C language section
7870 ((match-beginning 3) ; XSUB
7871 (goto-char (1+ (match-beginning 3)))
7872 (setq index (imenu-example--name-and-position))
7873 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
7874 (if (and prefix (string-match (concat "^" prefix) name))
7875 (setq name (substring name (length prefix))))
7876 (cond ((string-match "::" name) nil)
7878 (setq index1 (cons (concat package "::" name) (cdr index)))
7879 (push index1 index-alist)))
7881 (push index index-alist))
7883 ;; (beginning-of-line)
7884 (setq index (imenu-example--name-and-position))
7885 (setcar index (concat package "::BOOT:"))
7886 (push index index-alist)))))
7888 (imenu-progress-message prev-pos 100))
7891 (defvar cperl-unreadable-ok nil)
7893 (defun cperl-find-tags (ifile xs topdir)
7894 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
7895 (cperl-pod-here-fontify nil) f file)
7897 (if b (set-buffer b)
7898 (cperl-setup-tmp-buf))
7901 (setq file (car (insert-file-contents ifile)))
7902 (error (if cperl-unreadable-ok nil
7904 (format "File %s unreadable. Continue? " ifile))
7905 (setq cperl-unreadable-ok t)
7906 (error "Aborting: unreadable file %s" ifile)))))
7908 (message "Unreadable file %s" ifile)
7909 (message "Scanning file %s ..." file)
7910 (if (and cperl-use-syntax-table-text-property-for-tags
7912 (condition-case err ; after __END__ may have garbage
7913 (cperl-find-pods-heres nil nil noninteractive)
7914 (error (message "While scanning for syntax: %s" err))))
7916 (setq lst (cperl-xsub-scan))
7917 (setq ind (cperl-imenu--create-perl-index))
7918 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
7923 (cond ((string-match "^[_a-zA-Z]" (car elt))
7924 (goto-char (cdr elt))
7925 (beginning-of-line) ; pos should be of the start of the line
7928 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
7929 (buffer-substring (progn
7930 (goto-char (cdr elt))
7931 ;; After name now...
7932 (or (eolp) (forward-char 1))
7940 (setq elt (car lst) lst (cdr lst))
7945 (if (string-match "^package " (car elt))
7946 (substring (car elt) 8)
7949 (number-to-string (elt elt 2)) ; Line
7951 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
7953 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
7954 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
7956 ;; Need to insert the name without package as well
7957 (setq lst (cons (cons (substring (elt elt 3)
7965 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7966 (set-text-properties 0 (length rel) nil rel)
7967 (and (equal topdir (substring rel 0 (length topdir)))
7968 (setq rel (substring file (length topdir))))
7969 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
7970 (setq ret (buffer-substring 1 (point-max)))
7973 (message "Scanning file %s finished" file))
7976 (defun cperl-add-tags-recurse-noxs ()
7977 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
7979 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7980 -f cperl-add-tags-recurse-noxs
7982 (cperl-write-tags nil nil t t nil t))
7984 (defun cperl-add-tags-recurse-noxs-fullpath ()
7985 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
7986 Writes down fullpath, so TAGS is relocatable (but if the build directory
7987 is relocated, the file TAGS inside it breaks). Use as
7988 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7989 -f cperl-add-tags-recurse-noxs-fullpath
7991 (cperl-write-tags nil nil t t nil t ""))
7993 (defun cperl-add-tags-recurse ()
7994 "Add to TAGS file data for Perl files in the current directory and kids.
7996 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
7997 -f cperl-add-tags-recurse
7999 (cperl-write-tags nil nil t t))
8001 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
8002 ;; If INBUFFER, do not select buffer, and do not save
8003 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
8006 (setq file (if dir default-directory (buffer-file-name)))
8007 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
8009 (setq topdir default-directory))
8010 (let ((tags-file-name "TAGS")
8011 (case-fold-search (eq system-type 'emx))
8014 (cond (inbuffer nil) ; Already there
8015 ((file-exists-p tags-file-name)
8017 (visit-tags-table-buffer)
8018 (visit-tags-table-buffer tags-file-name)))
8019 (t (set-buffer (find-file-noselect tags-file-name))))
8022 (cond ((eq erase 'ignore))
8025 (setq erase 'ignore)))
8028 (directory-files file t
8029 (if recurse nil cperl-scan-files-regexp)
8032 (if cperl-unreadable-ok nil
8034 (format "Directory %s unreadable. Continue? " file))
8035 (setq cperl-unreadable-ok t
8036 tm nil) ; Return empty list
8037 (error "Aborting: unreadable directory %s" file)))))))
8041 ((string-match cperl-noscan-files-regexp file)
8043 ((not (file-directory-p file))
8044 (if (string-match cperl-scan-files-regexp file)
8045 (cperl-write-tags file erase recurse nil t noxs topdir)))
8047 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
8050 (setq xs (string-match "\\.xs$" file))
8051 (if (not (and xs noxs))
8053 (cond ((eq erase 'ignore) (goto-char (point-max)))
8054 (erase (erase-buffer))
8058 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
8059 (set-text-properties 0 (length rel) nil rel)
8060 (and (equal topdir (substring rel 0 (length topdir)))
8061 (setq rel (substring file (length topdir))))
8062 (if (search-forward (concat "\f\n" rel ",") nil t)
8064 (search-backward "\f\n")
8065 (delete-region (point)
8068 (if (search-forward "\f\n"
8072 (goto-char (point-max)))))
8073 (insert (cperl-find-tags file xs topdir))))))
8074 (if inbuffer nil ; Delegate to the caller
8075 (save-buffer 0) ; No backup
8076 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
8077 (initialize-new-tags-table))))))
8079 (defvar cperl-tags-hier-regexp-list
8086 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
8088 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
8091 (defvar cperl-hierarchy '(() ())
8092 "Global hierarchy of classes.")
8094 (defun cperl-tags-hier-fill ()
8095 ;; Suppose we are in a tag table cooked by cperl.
8097 (let (type pack name pos line chunk ord cons1 file str info fileind)
8098 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
8099 (setq pos (match-beginning 0)
8100 pack (match-beginning 2))
8102 (if (looking-at (concat
8111 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
8112 name (buffer-substring (match-beginning 2) (match-end 2))
8113 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
8114 line (buffer-substring (match-beginning 3) (match-end 3))
8117 fileind (format "%s:%s" file line)
8118 ;; Moves to beginning of the next line:
8119 info (cperl-etags-snarf-tag file line))
8122 ;; Make new member of hierarchy name ==> file ==> pos if needed
8123 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
8125 (setcdr cons1 (cons (cons fileind (vector file info))
8127 ;; First occurrence of the name, start alist
8128 (setq cons1 (cons name (list (cons fileind (vector file info)))))
8130 (setcar (cdr cperl-hierarchy)
8131 (cons cons1 (nth 1 cperl-hierarchy)))
8132 (setcar cperl-hierarchy
8133 (cons cons1 (car cperl-hierarchy)))))))
8136 (defun cperl-tags-hier-init (&optional update)
8137 "Show hierarchical menu of classes and methods.
8138 Finds info about classes by a scan of loaded TAGS files.
8139 Supposes that the TAGS files contain fully qualified function names.
8140 One may build such TAGS files from CPerl mode menu."
8144 (if (or update (null (nth 2 cperl-hierarchy)))
8145 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
8148 (setcdr elt (cdr (nth 1 elt)))))))
8149 pack name cons1 to l1 l2 l3 l4 b)
8150 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
8151 (setq cperl-hierarchy (list l1 l2 l3))
8152 (if cperl-xemacs-p ; Not checked
8155 ;; Does this work in XEmacs?
8156 (call-interactively 'visit-tags-table))
8157 (message "Updating list of classes...")
8158 (set-buffer (get-file-buffer tags-file-name))
8159 (cperl-tags-hier-fill))
8161 (call-interactively 'visit-tags-table))
8165 (message "Updating list of classes... %s" tagsfile)
8166 (set-buffer (get-file-buffer tagsfile))
8167 (cperl-tags-hier-fill)))
8169 (message "Updating list of classes... postprocessing..."))
8170 (mapcar remover (car cperl-hierarchy))
8171 (mapcar remover (nth 1 cperl-hierarchy))
8172 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
8173 (cons "Methods: " (car cperl-hierarchy))))
8174 (cperl-tags-treeify to 1)
8175 (setcar (nthcdr 2 cperl-hierarchy)
8176 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
8177 (message "Updating list of classes: done, requesting display...")
8178 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
8180 (or (nth 2 cperl-hierarchy)
8181 (error "No items found"))
8183 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
8184 (if (if (fboundp 'display-popup-menus-p)
8185 (let ((f 'display-popup-menus-p))
8188 (x-popup-menu t (nth 2 cperl-hierarchy))
8190 (tmm-prompt (nth 2 cperl-hierarchy))))
8191 (if (and update (listp update))
8192 (progn (while (cdr update) (setq update (cdr update)))
8193 (setq update (car update)))) ; Get the last from the list
8194 (if (vectorp update)
8196 (find-file (elt update 0))
8197 (cperl-etags-goto-tag-location (elt update 1))))
8198 (if (eq update -999) (cperl-tags-hier-init t)))
8200 (defun cperl-tags-treeify (to level)
8201 ;; cadr of `to' is read-write. On start it is a cons
8202 (let* ((regexp (concat "^\\(" (mapconcat
8204 (make-list level "[_a-zA-Z0-9]+")
8207 (packages (cdr (nth 1 to)))
8208 (methods (cdr (nth 2 to)))
8209 l1 head tail cons1 cons2 ord writeto packs recurse
8210 root-packages root-functions ms many_ms same_name ps
8214 (cond ((and (string-match regexp (car elt))
8215 (or (eq ord 1) (match-end 2)))
8216 (setq head (substring (car elt) 0 (match-end 1))
8217 tail (if (match-end 2) (substring (car elt)
8220 (if (setq cons1 (assoc head writeto)) nil
8221 ;; Need to init new head
8222 (setcdr writeto (cons (list head (list "Packages: ")
8225 (setq cons1 (nth 1 writeto)))
8226 (setq cons2 (nth ord cons1)) ; Either packs or meths
8227 (setcdr cons2 (cons elt (cdr cons2))))
8229 (setq root-functions (cons elt root-functions)))
8231 (setq root-packages (cons elt root-packages))))))))
8232 (setcdr to l1) ; Init to dynamic space
8235 (mapcar move-deeper packages)
8237 (mapcar move-deeper methods)
8239 (mapcar (function (lambda (elt)
8240 (cperl-tags-treeify elt (1+ level))))
8242 ;;Now clean up leaders with one child only
8243 (mapcar (function (lambda (elt)
8244 (if (not (and (listp (cdr elt))
8245 (eq (length elt) 2))) nil
8246 (setcar elt (car (nth 1 elt)))
8247 (setcdr elt (cdr (nth 1 elt))))))
8249 ;; Sort the roots of subtrees
8250 (if (default-value 'imenu-sort-function)
8252 (sort (cdr to) (default-value 'imenu-sort-function))))
8253 ;; Now add back functions removed from display
8254 (mapcar (function (lambda (elt)
8255 (setcdr to (cons elt (cdr to)))))
8256 (if (default-value 'imenu-sort-function)
8258 (sort root-functions (default-value 'imenu-sort-function)))
8260 ;; Now add back packages removed from display
8261 (mapcar (function (lambda (elt)
8262 (setcdr to (cons (cons (concat "package " (car elt))
8265 (if (default-value 'imenu-sort-function)
8267 (sort root-packages (default-value 'imenu-sort-function)))
8271 ;;; '(keymap "Name1"
8275 ;;; ("Tail1" "x") ("Tail2" "y"))))
8277 (defun cperl-list-fold (list name limit)
8278 (let (list1 list2 elt1 (num 0))
8279 (if (<= (length list) limit) list
8280 (setq list1 nil list2 nil)
8285 (if (<= num imenu-max-items)
8286 (setq list2 (cons elt1 list2))
8287 (setq list1 (cons (cons name
8292 (nreverse (cons (cons name
8296 (defun cperl-menu-to-keymap (menu &optional name)
8302 (cond ((listp (cdr elt))
8303 (setq list (cperl-list-fold
8304 (cdr elt) (car elt) imenu-max-items))
8307 (cperl-menu-to-keymap list))))
8309 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
8310 (cperl-list-fold menu "Root" imenu-max-items)))))
8313 (defvar cperl-bad-style-regexp
8314 (mapconcat 'identity
8315 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
8316 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
8318 "Finds places such that insertion of a whitespace may help a lot.")
8320 (defvar cperl-not-bad-style-regexp
8323 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
8324 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
8325 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
8326 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
8327 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
8334 "\\\\[&$@*\\\\]" ; \&func
8337 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
8340 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
8341 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
8342 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
8346 "If matches at the start of match found by `my-bad-c-style-regexp',
8347 insertion of a whitespace will not help.")
8351 (defun cperl-find-bad-style ()
8352 "Find places in the buffer where insertion of a whitespace may help.
8353 Prompts user for insertion of spaces.
8354 Currently it is tuned to C and Perl syntax."
8356 (let (found-bad (p (point)))
8357 (setq last-nonmenu-event 13) ; To disable popup
8358 (goto-char (point-min))
8359 (map-y-or-n-p "Insert space here? "
8360 (lambda (arg) (insert " "))
8361 'cperl-next-bad-style
8362 '("location" "locations" "insert a space into")
8363 '((?\C-r (lambda (arg)
8364 (let ((buffer-quit-function
8365 'exit-recursive-edit))
8366 (message "Exit with Esc Esc")
8368 t)) ; Consider acted upon
8369 "edit, exit with Esc Esc")
8371 (let ((buffer-quit-function
8372 'exit-recursive-edit))
8373 (message "Exit with Esc Esc")
8375 t)) ; Consider acted upon
8376 "edit, exit with Esc Esc"))
8378 (if found-bad (goto-char found-bad)
8380 (message "No appropriate place found"))))
8382 (defun cperl-next-bad-style ()
8383 (let (p (not-found t) (point (point)) found)
8384 (while (and not-found
8385 (re-search-forward cperl-bad-style-regexp nil 'to-end))
8387 (goto-char (match-beginning 0))
8389 (looking-at cperl-not-bad-style-regexp)
8390 ;; Check for a < -b and friends
8391 (and (eq (following-char) ?\-)
8393 (skip-chars-backward " \t\n")
8394 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
8395 ;; Now check for syntax type
8397 (setq found (point))
8398 (beginning-of-defun)
8399 (let ((pps (parse-partial-sexp (point) found)))
8400 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
8401 (goto-char (match-end 0))
8409 (defvar cperl-have-help-regexp
8413 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
8414 "[$@]\\^[a-zA-Z]" ; Special variable
8415 "[$@][^ \n\t]" ; Special variable
8416 "-[a-zA-Z]" ; File test
8417 "\\\\[a-zA-Z0]" ; Special chars
8418 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
8419 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
8420 "[a-zA-Z_0-9:]+" ; symbol or number
8427 "Matches places in the buffer we can find help for.")
8429 (defvar cperl-message-on-help-error t)
8430 (defvar cperl-help-from-timer nil)
8432 (defun cperl-word-at-point-hard ()
8433 ;; Does not save-excursion
8434 ;; Get to the something meaningful
8435 (or (eobp) (eolp) (forward-char 1))
8436 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
8437 (save-excursion (beginning-of-line) (point))
8440 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
8441 ;; (skip-chars-backward " \n\t\r({[]});,")
8442 ;; (or (bobp) (backward-char 1))))
8445 ((looking-at "[a-zA-Z0-9_:]") ; symbol
8446 (skip-chars-backward "a-zA-Z0-9_:")
8448 ((and (eq (preceding-char) ?^) ; $^I
8449 (eq (char-after (- (point) 2)) ?\$))
8451 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
8453 ((and (eq (preceding-char) ?\=)
8454 (eq (current-column) 1))
8455 (forward-char -1))) ; =head1
8456 (if (and (eq (preceding-char) ?\<)
8457 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
8459 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
8461 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
8463 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
8464 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
8466 ((and (eq (preceding-char) ?\$)
8467 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
8469 ((and (eq (following-char) ?\>)
8470 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
8473 (and (eq (preceding-char) ?\<)
8474 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
8475 (search-backward "<"))))
8476 ((and (eq (following-char) ?\$)
8477 (eq (preceding-char) ?\<)
8478 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
8480 (if (looking-at cperl-have-help-regexp)
8481 (buffer-substring (match-beginning 0) (match-end 0))))
8483 (defun cperl-get-help ()
8484 "Get one-line docs on the symbol at the point.
8485 The data for these docs is a little bit obsolete and may be in fact longer
8486 than a line. Your contribution to update/shorten it is appreciated."
8488 (save-match-data ; May be called "inside" query-replace
8490 (let ((word (cperl-word-at-point-hard)))
8492 (if (and cperl-help-from-timer ; Bail out if not in mainland
8493 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
8494 (or (memq (get-text-property (point) 'face)
8495 '(font-lock-comment-face font-lock-string-face))
8496 (memq (get-text-property (point) 'syntax-type)
8497 '(pod here-doc format))))
8499 (cperl-describe-perl-symbol word))
8500 (if cperl-message-on-help-error
8501 (message "Nothing found for %s..."
8502 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
8504 ;;; Stolen from perl-descr.el by Johan Vromans:
8506 (defvar cperl-doc-buffer " *perl-doc*"
8507 "Where the documentation can be found.")
8509 (defun cperl-describe-perl-symbol (val)
8510 "Display the documentation of symbol at point, a Perl operator."
8511 (let ((enable-recursive-minibuffers t)
8514 ((string-match "^[&*][a-zA-Z_]" val)
8515 (setq val (concat (substring val 0 1) "NAME")))
8516 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
8517 (setq val (concat "@" (substring val 1 (match-end 1)))))
8518 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
8519 (setq val (concat "%" (substring val 1 (match-end 1)))))
8520 ((and (string= val "x") (string-match "^x=" val))
8522 ((string-match "^\\$[\C-a-\C-z]" val)
8523 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
8524 ((string-match "^CORE::" val)
8525 (setq val "CORE::"))
8526 ((string-match "^SUPER::" val)
8527 (setq val "SUPER::"))
8528 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
8529 (setq val "<NAME>")))
8530 (setq regexp (concat "^"
8531 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
8533 "\\([ \t([/]\\|$\\)"))
8535 ;; get the buffer with the documentation text
8536 (cperl-switch-to-doc-buffer)
8538 ;; lookup in the doc
8539 (goto-char (point-min))
8540 (let ((case-fold-search nil))
8542 (if (re-search-forward regexp (point-max) t)
8544 (beginning-of-line 1)
8545 (let ((lnstart (point)))
8547 (message "%s" (buffer-substring lnstart (point)))))
8548 (if cperl-message-on-help-error
8549 (message "No definition for %s" val)))))))
8551 (defvar cperl-short-docs 'please-ignore-this-line
8552 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
8553 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
8554 ... Range (list context); flip/flop [no flop when flip] (scalar context).
8555 ! ... Logical negation.
8556 ... != ... Numeric inequality.
8557 ... !~ ... Search pattern, substitution, or translation (negated).
8558 $! In numeric context: errno. In a string context: error string.
8559 $\" The separator which joins elements of arrays interpolated in strings.
8560 $# The output format for printed numbers. Default is %.15g or close.
8561 $$ Process number of this script. Changes in the fork()ed child process.
8562 $% The current page number of the currently selected output channel.
8564 The following variables are always local to the current block:
8566 $1 Match of the 1st set of parentheses in the last match (auto-local).
8567 $2 Match of the 2nd set of parentheses in the last match (auto-local).
8568 $3 Match of the 3rd set of parentheses in the last match (auto-local).
8569 $4 Match of the 4th set of parentheses in the last match (auto-local).
8570 $5 Match of the 5th set of parentheses in the last match (auto-local).
8571 $6 Match of the 6th set of parentheses in the last match (auto-local).
8572 $7 Match of the 7th set of parentheses in the last match (auto-local).
8573 $8 Match of the 8th set of parentheses in the last match (auto-local).
8574 $9 Match of the 9th set of parentheses in the last match (auto-local).
8575 $& The string matched by the last pattern match (auto-local).
8576 $' The string after what was matched by the last match (auto-local).
8577 $` The string before what was matched by the last match (auto-local).
8579 $( The real gid of this process.
8580 $) The effective gid of this process.
8581 $* Deprecated: Set to 1 to do multiline matching within a string.
8582 $+ The last bracket matched by the last search pattern.
8583 $, The output field separator for the print operator.
8584 $- The number of lines left on the page.
8585 $. The current input line number of the last filehandle that was read.
8586 $/ The input record separator, newline by default.
8587 $0 Name of the file containing the current perl script (read/write).
8588 $: String may be broken after these characters to fill ^-lines in a format.
8589 $; Subscript separator for multi-dim array emulation. Default \"\\034\".
8590 $< The real uid of this process.
8591 $= The page length of the current output channel. Default is 60 lines.
8592 $> The effective uid of this process.
8593 $? The status returned by the last ``, pipe close or `system'.
8594 $@ The perl error message from the last eval or do @var{EXPR} command.
8595 $ARGV The name of the current file used with <> .
8596 $[ Deprecated: The index of the first element/char in an array/string.
8597 $\\ The output record separator for the print operator.
8598 $] The perl version string as displayed with perl -v.
8599 $^ The name of the current top-of-page format.
8600 $^A The current value of the write() accumulator for format() lines.
8601 $^D The value of the perl debug (-D) flags.
8602 $^E Information about the last system error other than that provided by $!.
8603 $^F The highest system file descriptor, ordinarily 2.
8604 $^H The current set of syntax checks enabled by `use strict'.
8605 $^I The value of the in-place edit extension (perl -i option).
8606 $^L What formats output to perform a formfeed. Default is \f.
8607 $^M A buffer for emergency memory allocation when running out of memory.
8608 $^O The operating system name under which this copy of Perl was built.
8609 $^P Internal debugging flag.
8610 $^T The time the script was started. Used by -A/-M/-C file tests.
8611 $^W True if warnings are requested (perl -w flag).
8612 $^X The name under which perl was invoked (argv[0] in C-speech).
8613 $_ The default input and pattern-searching space.
8614 $| Auto-flush after write/print on current output channel? Default 0.
8615 $~ The name of the current report format.
8616 ... % ... Modulo division.
8617 ... %= ... Modulo division assignment.
8618 %ENV Contains the current environment.
8619 %INC List of files that have been require-d or do-ne.
8620 %SIG Used to set signal handlers for various signals.
8621 ... & ... Bitwise and.
8622 ... && ... Logical and.
8623 ... &&= ... Logical and assignment.
8624 ... &= ... Bitwise and assignment.
8625 ... * ... Multiplication.
8626 ... ** ... Exponentiation.
8627 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
8628 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
8629 ... + ... Addition. +EXPR Makes EXPR into scalar context.
8630 ++ Auto-increment (magical on strings). ++EXPR EXPR++
8631 ... += ... Addition assignment.
8633 ... - ... Subtraction.
8634 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
8635 ... -= ... Subtraction assignment.
8636 -A Access time in days since script started.
8637 -B File is a non-text (binary) file.
8638 -C Inode change time in days since script started.
8639 -M Age in days since script started.
8640 -O File is owned by real uid.
8641 -R File is readable by real uid.
8642 -S File is a socket .
8643 -T File is a text file.
8644 -W File is writable by real uid.
8645 -X File is executable by real uid.
8646 -b File is a block special file.
8647 -c File is a character special file.
8648 -d File is a directory.
8650 -f File is a plain file.
8651 -g File has setgid bit set.
8652 -k File has sticky bit set.
8653 -l File is a symbolic link.
8654 -o File is owned by effective uid.
8655 -p File is a named pipe (FIFO).
8656 -r File is readable by effective uid.
8657 -s File has non-zero size.
8658 -t Tests if filehandle (STDIN by default) is opened to a tty.
8659 -u File has setuid bit set.
8660 -w File is writable by effective uid.
8661 -x File is executable by effective uid.
8662 -z File has zero size.
8663 . Concatenate strings.
8664 .. Range (list context); flip/flop (scalar context) operator.
8665 .= Concatenate assignment strings
8666 ... / ... Division. /PATTERN/ioxsmg Pattern match
8667 ... /= ... Division assignment.
8668 /PATTERN/ioxsmg Pattern match.
8669 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
8670 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
8671 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
8672 <> Reads line from union of files in @ARGV (= command line) and STDIN.
8673 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
8674 ... <= ... Numeric less than or equal to.
8675 ... <=> ... Numeric compare.
8676 ... = ... Assignment.
8677 ... == ... Numeric equality.
8678 ... =~ ... Search pattern, substitution, or translation
8679 ... > ... Numeric greater than.
8680 ... >= ... Numeric greater than or equal to.
8681 ... >> ... Bitwise shift right.
8682 ... >>= ... Bitwise shift right assignment.
8683 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
8684 ?PATTERN? One-time pattern match.
8685 @ARGV Command line arguments (not including the command name - see $0).
8686 @INC List of places to look for perl scripts during do/include/use.
8687 @_ Parameter array for subroutines; result of split() unless in list context.
8688 \\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
8689 \\0 Octal char, e.g. \\033.
8690 \\E Case modification terminator. See \\Q, \\L, and \\U.
8691 \\L Lowercase until \\E . See also \l, lc.
8692 \\U Upcase until \\E . See also \u, uc.
8693 \\Q Quote metacharacters until \\E . See also quotemeta.
8694 \\a Alarm character (octal 007).
8695 \\b Backspace character (octal 010).
8696 \\c Control character, e.g. \\c[ .
8697 \\e Escape character (octal 033).
8698 \\f Formfeed character (octal 014).
8699 \\l Lowercase the next character. See also \\L and \\u, lcfirst.
8700 \\n Newline character (octal 012 on most systems).
8701 \\r Return character (octal 015 on most systems).
8702 \\t Tab character (octal 011).
8703 \\u Upcase the next character. See also \\U and \\l, ucfirst.
8704 \\x Hex character, e.g. \\x1b.
8705 ... ^ ... Bitwise exclusive or.
8706 __END__ Ends program source.
8707 __DATA__ Ends program source.
8708 __FILE__ Current (source) filename.
8709 __LINE__ Current line in current source.
8710 __PACKAGE__ Current package.
8711 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
8712 ARGVOUT Output filehandle with -i flag.
8713 BEGIN { ... } Immediately executed (during compilation) piece of code.
8714 END { ... } Pseudo-subroutine executed after the script finishes.
8715 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
8716 INIT { ... } Pseudo-subroutine executed before the script starts running.
8717 DATA Input filehandle for what follows after __END__ or __DATA__.
8718 accept(NEWSOCKET,GENERICSOCKET)
8731 ... cmp ... String compare.
8732 connect(SOCKET,NAME)
8733 continue of { block } continue { block }. Is executed after `next' or at end.
8735 crypt(PLAINTEXT,SALT)
8737 dbmopen(%HASH,DBNAME,MODE)
8741 do { ... }|SUBR while|until EXPR executes at least once
8742 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
8752 ... eq ... String equality.
8753 eval(EXPR) or eval { BLOCK }
8757 fcntl(FILEHANDLE,FUNCTION,SCALAR)
8759 flock(FILEHANDLE,OPERATION)
8760 for (EXPR;EXPR;EXPR) { ... }
8761 foreach [VAR] (@ARRAY) { ... }
8763 ... ge ... String greater than or equal.
8768 gethostbyaddr(ADDR,ADDRTYPE)
8772 getnetbyaddr(ADDR,ADDRTYPE)
8778 getpriority(WHICH,WHO)
8779 getprotobyname(NAME)
8780 getprotobynumber(NUMBER)
8785 getservbyname(NAME,PROTO)
8786 getservbyport(PORT,PROTO)
8789 getsockopt(SOCKET,LEVEL,OPTNAME)
8792 ... gt ... String greater than.
8794 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
8795 index(STR,SUBSTR[,OFFSET])
8797 ioctl(FILEHANDLE,FUNCTION,SCALAR)
8802 ... le ... String less than or equal.
8804 link(OLDFILE,NEWFILE)
8805 listen(SOCKET,QUEUESIZE)
8809 lstat(EXPR|FILEHANDLE|VAR)
8810 ... lt ... String less than.
8812 mkdir(FILENAME,MODE)
8815 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
8816 msgsnd(ID,MSG,FLAGS)
8817 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
8818 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
8819 ... ne ... String inequality.
8822 open(FILEHANDLE[,EXPR])
8823 opendir(DIRHANDLE,EXPR)
8824 ord(EXPR) ASCII value of the first char of the string.
8826 package NAME Introduces package context.
8827 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
8829 print [FILEHANDLE] [(LIST)]
8830 printf [FILEHANDLE] (FORMAT,LIST)
8832 q/STRING/ Synonym for 'STRING'
8833 qq/STRING/ Synonym for \"STRING\"
8834 qx/STRING/ Synonym for `STRING`
8836 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
8839 recv(SOCKET,SCALAR,LEN,FLAGS)
8841 rename(OLDNAME,NEWNAME)
8842 require [FILENAME | PERL_VERSION]
8846 rewinddir(DIRHANDLE)
8847 rindex(STR,SUBSTR[,OFFSET])
8849 s/PATTERN/REPLACEMENT/gieoxsm
8851 seek(FILEHANDLE,POSITION,WHENCE)
8852 seekdir(DIRHANDLE,POS)
8853 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
8854 semctl(ID,SEMNUM,CMD,ARG)
8855 semget(KEY,NSEMS,SIZE,FLAGS)
8857 send(SOCKET,MSG,FLAGS[,TO])
8859 sethostent(STAYOPEN)
8862 setpriority(WHICH,WHO,PRIORITY)
8863 setprotoent(STAYOPEN)
8865 setservent(STAYOPEN)
8866 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
8869 shmget(KEY,SIZE,FLAGS)
8870 shmread(ID,VAR,POS,SIZE)
8871 shmwrite(ID,STRING,POS,SIZE)
8872 shutdown(SOCKET,HOW)
8875 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
8876 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
8877 sort [SUBROUTINE] (LIST)
8878 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
8879 split[(/PATTERN/[,EXPR[,LIMIT]])]
8880 sprintf(FORMAT,LIST)
8883 stat(EXPR|FILEHANDLE|VAR)
8885 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
8886 substr(EXPR,OFFSET[,LEN])
8887 symlink(OLDFILE,NEWFILE)
8889 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
8891 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
8896 tr/SEARCHLIST/REPLACEMENTLIST/cds
8897 truncate(FILE|EXPR,LENGTH)
8900 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
8902 unpack(TEMPLATE,EXPR)
8904 until (EXPR) { ... } EXPR until EXPR
8907 vec(EXPR,OFFSET,BITS)
8910 wantarray Returns true if the sub/eval is called in list context.
8912 while (EXPR) { ... } EXPR while EXPR
8913 write[(EXPR|FILEHANDLE)]
8914 ... x ... Repeat string or array.
8915 x= ... Repetition assignment.
8916 y/SEARCHLIST/REPLACEMENTLIST/
8917 ... | ... Bitwise or.
8918 ... || ... Logical or.
8919 ~ ... Unary bitwise complement.
8920 #! OS interpreter indicator. If contains `perl', used for options, and -x.
8921 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
8922 CORE:: Prefix to access builtin function if imported sub obscures it.
8923 SUPER:: Prefix to lookup for a method in @ISA classes.
8924 DESTROY Shorthand for `sub DESTROY {...}'.
8925 ... EQ ... Obsolete synonym of `eq'.
8926 ... GE ... Obsolete synonym of `ge'.
8927 ... GT ... Obsolete synonym of `gt'.
8928 ... LE ... Obsolete synonym of `le'.
8929 ... LT ... Obsolete synonym of `lt'.
8930 ... NE ... Obsolete synonym of `ne'.
8931 abs [ EXPR ] absolute value
8932 ... and ... Low-precedence synonym for &&.
8933 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
8934 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
8935 chr Converts a number to char with the same ordinal.
8936 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
8937 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
8938 exists $HASH{KEY} True if the key exists.
8939 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
8940 formline PICTURE, LIST Backdoor into \"format\" processing.
8941 glob EXPR Synonym of <EXPR>.
8942 lc [ EXPR ] Returns lowercased EXPR.
8943 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
8944 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
8945 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
8946 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
8947 not ... Low-precedence synonym for ! - negation.
8948 ... or ... Low-precedence synonym for ||.
8949 pos STRING Set/Get end-position of the last match over this string, see \\G.
8950 quotemeta [ EXPR ] Quote regexp metacharacters.
8951 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
8952 readline FH Synonym of <FH>.
8953 readpipe CMD Synonym of `CMD`.
8954 ref [ EXPR ] Type of EXPR when dereferenced.
8955 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
8956 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
8957 tied Returns internal object for a tied data.
8958 uc [ EXPR ] Returns upcased EXPR.
8959 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
8960 untie VAR Unlink an object from a simple Perl variable.
8961 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
8962 ... xor ... Low-precedence synonym for exclusive or.
8963 prototype \&SUB Returns prototype of the function given a reference.
8964 =head1 Top-level heading.
8965 =head2 Second-level heading.
8966 =head3 Third-level heading (is there such?).
8967 =over [ NUMBER ] Start list.
8968 =item [ TITLE ] Start new item in the list.
8970 =cut Switch from POD to Perl.
8971 =pod Switch from Perl to POD.
8974 (defun cperl-switch-to-doc-buffer ()
8975 "Go to the perl documentation buffer and insert the documentation."
8977 (let ((buf (get-buffer-create cperl-doc-buffer)))
8979 (switch-to-buffer-other-window buf)
8981 (if (= (buffer-size) 0)
8983 (insert (documentation-property 'cperl-short-docs
8984 'variable-documentation))
8985 (setq buffer-read-only t)))))
8987 (defun cperl-beautify-regexp-piece (b e embed level)
8988 ;; b is before the starting delimiter, e before the ending
8989 ;; e should be a marker, may be changed, but remains "correct".
8990 ;; EMBED is nil iff we process the whole REx.
8991 ;; The REx is guaranteed to have //x
8992 ;; LEVEL shows how many levels deep to go
8993 ;; position at enter and at leave is not defined
8994 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8998 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
9002 ((looking-at "(\\?[^a-zA-Z]")
9004 ((looking-at "(\\?") ; (?i)
9008 (setq c (if embed (current-indentation) (1- (current-column)))
9009 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
9010 (or (looking-at "[ \t]*[\n#]")
9015 (if (re-search-forward "[^ \t]" e t)
9016 (progn ; Something before the ending delimiter
9018 (delete-horizontal-space)
9020 (cperl-make-indent c)
9021 (set-marker e (point))))
9024 (while (< (point) (marker-position e))
9028 (skip-chars-forward " \t")
9029 (delete-region s (point))
9030 (cperl-make-indent c1)
9034 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
9035 "\\|" ; Embedded variable
9036 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
9039 "\\|" ; simple-code simple-code*?
9040 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
9044 "\\((\\(\\?\\)?\\)" ; 7 8
9047 (goto-char (match-end 0))
9049 (cond ((match-beginning 1) ; Alphanum word + junk
9051 ((or (match-beginning 3) ; $ab[12]
9052 (and (match-beginning 5) ; X* X+ X{2,3}
9053 (eq (preceding-char) ?\{)))
9056 ((and ; [], already syntaxified
9059 cperl-use-syntax-table-text-property)
9062 (or (eq (preceding-char) ?\])
9063 (error "[]-group not terminated"))
9065 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
9066 ((match-beginning 6) ; []
9068 (if (looking-at "\\^?\\]")
9069 (goto-char (match-end 0)))
9070 ;; XXXX POSIX classes?!
9071 (while (and (not pos)
9072 (re-search-forward "\\[:\\|\\]" e t))
9073 (if (eq (preceding-char) ?:)
9074 (or (re-search-forward ":\\]" e t)
9075 (error "[:POSIX:]-group in []-group not terminated"))
9077 (or (eq (preceding-char) ?\])
9078 (error "[]-group not terminated"))
9080 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
9081 ((match-beginning 7) ; ()
9082 (goto-char (match-beginning 0))
9083 (setq pos (current-column))
9086 (delete-horizontal-space)
9088 (cperl-make-indent c1)))
9091 ;; (or (forward-sexp 1)
9094 ;; (error "()-group not terminated")))
9095 (set-marker m (1- (point)))
9096 (set-marker m1 (point))
9098 (if (progn ; indent rigidly if multiline
9099 ;; In fact does not make a lot of sense, since
9100 ;; the starting position can be already lost due
9101 ;; to insertion of "\n" and " "
9103 (search-forward "\n" m1 t))
9104 (indent-rigidly (point) m1 (- c1 pos)))
9105 (setq level (1- level))
9107 ((not (match-beginning 8))
9108 (cperl-beautify-regexp-piece tmp m t level))
9109 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
9111 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
9112 (goto-char (+ 2 tmp))
9114 (cperl-beautify-regexp-piece (point) m t level))
9115 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
9116 (goto-char (+ 3 tmp))
9117 (cperl-beautify-regexp-piece (point) m t level))
9119 (cperl-beautify-regexp-piece tmp m t level))))
9121 (cond ((looking-at "[*+?]\\??")
9122 (goto-char (match-end 0)))
9123 ((eq (following-char) ?\{)
9125 (if (eq (following-char) ?\?)
9127 (skip-chars-forward " \t")
9129 (if (looking-at "[#\n]")
9131 (or (eolp) (indent-for-comment))
9132 (beginning-of-line 2))
9133 (delete-horizontal-space)
9137 ((match-beginning 9) ; |
9141 (if (re-search-forward "[^ \t]" tmp t)
9144 (delete-horizontal-space)
9147 (delete-region (point) tmp))
9148 (cperl-make-indent c)
9150 (skip-chars-forward " \t")
9152 (if (looking-at "[#\n]")
9153 (beginning-of-line 2)
9154 (delete-horizontal-space)
9158 (or (looking-at "[ \t\n]")
9161 (skip-chars-forward " \t"))
9162 (or (looking-at "[#\n]")
9163 (error "Unknown code `%s' in a regexp"
9164 (buffer-substring (point) (1+ (point)))))
9165 (and inline (end-of-line 2)))
9166 ;; Special-case the last line of group
9167 (if (and (>= (point) (marker-position e))
9168 (/= (current-indentation) c))
9171 (cperl-make-indent c)))))
9173 (defun cperl-make-regexp-x ()
9174 ;; Returns position of the start
9175 ;; XXX this is called too often! Need to cache the result!
9177 (or cperl-use-syntax-table-text-property
9178 (error "I need to have a regexp marked!"))
9180 (if (looking-at "\\s|")
9182 (if (looking-at "\\([smy]\\|qr\\)\\s|")
9184 (re-search-backward "\\s|"))) ; Assume it is scanned already.
9186 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
9187 (sub-p (eq (preceding-char) ?s)) s)
9189 (set-marker e (1- (point)))
9190 (setq delim (preceding-char))
9191 (if (and sub-p (eq delim (char-after (- (point) 2))))
9192 (error "Possible s/blah// - do not know how to deal with"))
9193 (if sub-p (forward-sexp 1))
9194 (if (looking-at "\\sw*x")
9197 ;; Protect fragile " ", "#"
9200 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
9206 (defun cperl-beautify-regexp (&optional deep)
9207 "Do it. (Experimental, may change semantics, recheck the result.)
9208 We suppose that the regexp is scanned already."
9210 (setq deep (if deep (prefix-numeric-value deep) -1))
9212 (goto-char (cperl-make-regexp-x))
9213 (let ((b (point)) (e (make-marker)))
9215 (set-marker e (1- (point)))
9216 (cperl-beautify-regexp-piece b e nil deep))))
9218 (defun cperl-regext-to-level-start ()
9219 "Goto start of an enclosing group in regexp.
9220 We suppose that the regexp is scanned already."
9222 (let ((limit (cperl-make-regexp-x)) done)
9224 (or (eq (following-char) ?\()
9225 (search-backward "(" (1+ limit) t)
9226 (error "Cannot find `(' which starts a group"))
9229 (skip-chars-backward "\\")
9230 (looking-at "\\(\\\\\\\\\\)*(")))
9231 (or done (forward-char -1)))))
9233 (defun cperl-contract-level ()
9234 "Find an enclosing group in regexp and contract it.
9235 \(Experimental, may change semantics, recheck the result.)
9236 We suppose that the regexp is scanned already."
9238 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
9239 (cperl-regext-to-level-start)
9240 (let ((b (point)) (e (make-marker)) c)
9242 (set-marker e (1- (point)))
9244 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
9246 ((match-beginning 1) ; #-comment
9247 (or c (setq c (current-indentation)))
9248 (beginning-of-line 2) ; Skip
9249 (cperl-make-indent c))
9252 (just-one-space))))))
9254 (defun cperl-contract-levels ()
9255 "Find an enclosing group in regexp and contract all the kids.
9256 \(Experimental, may change semantics, recheck the result.)
9257 We suppose that the regexp is scanned already."
9261 (cperl-regext-to-level-start)
9262 (error ; We are outside outermost group
9263 (goto-char (cperl-make-regexp-x))))
9264 (let ((b (point)) (e (make-marker)) s c)
9266 (set-marker e (1- (point)))
9268 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
9270 ((match-beginning 1) ; Skip
9273 (cperl-contract-level)))))))
9275 (defun cperl-beautify-level (&optional deep)
9276 "Find an enclosing group in regexp and beautify it.
9277 \(Experimental, may change semantics, recheck the result.)
9278 We suppose that the regexp is scanned already."
9280 (setq deep (if deep (prefix-numeric-value deep) -1))
9282 (cperl-regext-to-level-start)
9283 (let ((b (point)) (e (make-marker)))
9285 (set-marker e (1- (point)))
9286 (cperl-beautify-regexp-piece b e nil deep))))
9288 (defun cperl-invert-if-unless ()
9289 "Change `if (A) {B}' into `B if A;' etc if possible."
9291 (or (looking-at "\\<")
9293 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
9294 (let ((pos1 (point))
9295 pos2 pos3 pos4 pos5 s1 s2 state p pos45
9296 (s0 (buffer-substring (match-beginning 0) (match-end 0))))
9301 (if (eq (following-char) ?\( )
9308 ;; XXXX In fact may be `A if (B); {C}' ...
9309 (if (and (eq (following-char) ?\{ )
9311 (cperl-backward-to-noncomment pos3)
9312 (eq (preceding-char) ?\) )))
9313 (if (condition-case nil
9318 (looking-at "\\<els\\(e\\|if\\)\\>"))
9321 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" s0)
9322 (goto-char (1- pos5))
9323 (cperl-backward-to-noncomment pos4)
9324 (if (eq (preceding-char) ?\;)
9326 (setq pos45 (point))
9328 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
9329 (setq p (match-beginning 0)
9330 s1 (buffer-substring p (match-end 0))
9331 state (parse-partial-sexp pos4 p))
9335 (error "`%s' inside `%s' BLOCK" s1 s0))
9336 (goto-char (match-end 0)))
9338 (goto-char (1+ pos4))
9339 (skip-chars-forward " \t\n")
9340 (setq s2 (buffer-substring (point) pos45))
9342 (or (looking-at ";?[ \t\n]*}")
9344 (skip-chars-forward "; \t\n")
9345 (setq s2 (concat s2 "\n" (buffer-substring (point) (1- pos5))))))
9348 (goto-char (1- pos3))
9349 (cperl-backward-to-noncomment pos2)
9350 (or (looking-at "[ \t\n]*)")
9351 (goto-char (1- pos3)))
9353 (goto-char (1+ pos2))
9354 (skip-chars-forward " \t\n")
9355 (setq s1 (buffer-substring (point) p))
9356 (delete-region pos4 pos5)
9357 (delete-region pos2 pos3)
9364 (delete-horizontal-space)
9366 (delete-horizontal-space)
9369 (cperl-indent-line))
9370 (error "`%s' (EXPR) not with an {BLOCK}" s0)))
9371 (error "`%s' not with an (EXPR)" s0)))
9372 (error "Not at `if', `unless', `while', `until', `for' or `foreach'")))
9374 ;;; By Anthony Foiani <afoiani@uswest.com>
9375 ;;; Getting help on modules in C-h f ?
9376 ;;; This is a modified version of `man'.
9377 ;;; Need to teach it how to lookup functions
9379 (defun cperl-perldoc (word)
9380 "Run `perldoc' on WORD."
9382 (list (let* ((default-entry (cperl-word-at-point))
9384 (format "perldoc entry%s: "
9385 (if (string= default-entry "")
9387 (format " (default %s)" default-entry))))))
9388 (if (string= input "")
9389 (if (string= default-entry "")
9390 (error "No perldoc args given")
9394 (let* ((case-fold-search nil)
9396 (string-match "^[a-z]+$" word)
9397 (string-match (concat "^" word "\\>")
9398 (documentation-property
9400 'variable-documentation))))
9401 (manual-program (if is-func "perldoc -f" "perldoc")))
9404 (let ((Manual-program "perldoc")
9405 (Manual-switches (if is-func (list "-f"))))
9406 (manual-entry word)))
9408 (Man-getpage-in-background word)))))
9411 (defun cperl-perldoc-at-point ()
9412 "Run a `perldoc' on the word around point."
9414 (cperl-perldoc (cperl-word-at-point)))
9416 (defcustom pod2man-program "pod2man"
9417 "*File name for `pod2man'."
9421 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
9422 (defun cperl-pod-to-manpage ()
9423 "Create a virtual manpage in Emacs from the Perl Online Documentation."
9426 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
9427 (bufname (concat "Man " buffer-file-name))
9428 (buffer (generate-new-buffer bufname)))
9431 (let ((process-environment (copy-sequence process-environment)))
9432 ;; Prevent any attempt to use display terminal fanciness.
9433 (setenv "TERM" "dumb")
9434 (set-process-sentinel
9435 (start-process pod2man-program buffer "sh" "-c"
9436 (format (cperl-pod2man-build-command) pod2man-args))
9437 'Man-bgproc-sentinel)))))
9439 ;;; Updated version by him too
9440 (defun cperl-build-manpage ()
9441 "Create a virtual manpage in Emacs from the POD in the file."
9446 (let ((Manual-program "perldoc"))
9447 (manual-entry buffer-file-name)))
9449 (let* ((manual-program "perldoc"))
9450 (Man-getpage-in-background buffer-file-name)))))
9452 (defun cperl-pod2man-build-command ()
9453 "Builds the entire background manpage and cleaning command."
9454 (let ((command (concat pod2man-program " %s 2>/dev/null"))
9455 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
9456 (while (and flist (car flist))
9457 (let ((pcom (car (car flist)))
9458 (pargs (cdr (car flist))))
9460 (concat command " | " pcom " "
9461 (mapconcat '(lambda (phrase)
9462 (if (not (stringp phrase))
9463 (error "Malformed Man-filter-list"))
9466 (setq flist (cdr flist))))
9469 ;;; Initial version contributed by Trey Belew
9470 (defun cperl-here-doc-spell (&optional beg end)
9471 "Spell-check HERE-documents in the Perl buffer.
9472 If a region is highlighted, restricts to the region."
9474 (cperl-pod-spell t beg end))
9476 (defun cperl-pod-spell (&optional do-heres beg end)
9477 "Spell-check POD documentation.
9478 If invoked with prefix argument, will do HERE-DOCs instead.
9479 If a region is highlighted, restricts to the region."
9483 (if (cperl-mark-active)
9484 (setq beg (min (mark) (point))
9485 end (max (mark) (point)))
9486 (setq beg (point-min)
9488 (cperl-map-pods-heres (function
9491 (setq e (save-excursion
9497 (if do-heres 'here-doc-group 'in-pod)
9500 (defun cperl-map-pods-heres (func &optional prop s end)
9501 "Executes a function over regions of pods or here-documents.
9502 PROP is the text-property to search for; default to `in-pod'. Stop when
9503 function returns nil."
9504 (let (pos posend has-prop (cont t))
9505 (or prop (setq prop 'in-pod))
9506 (or s (setq s (point-min)))
9507 (or end (setq end (point-max)))
9508 (cperl-update-syntaxification end end)
9510 (goto-char (setq pos s))
9511 (while (and cont (< pos end))
9512 (setq has-prop (get-text-property pos prop))
9513 (setq posend (next-single-property-change pos prop nil end))
9515 (setq cont (funcall func pos posend prop)))
9516 (setq pos posend)))))
9518 ;;; Based on code by Masatake YAMATO:
9519 (defun cperl-get-here-doc-region (&optional pos pod)
9520 "Return HERE document region around the point.
9521 Return nil if the point is not in a HERE document region. If POD is non-nil,
9522 will return a POD section if point is in a POD section."
9523 (or pos (setq pos (point)))
9524 (cperl-update-syntaxification pos pos)
9525 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
9527 (eq 'pod (get-text-property pos 'syntax-type))))
9528 (let ((b (cperl-beginning-of-property pos 'syntax-type))
9529 (e (next-single-property-change pos 'syntax-type)))
9530 (cons b (or e (point-max))))))
9532 (defun cperl-narrow-to-here-doc (&optional pos)
9533 "Narrows editing region to the HERE-DOC at POS.
9534 POS defaults to the point."
9536 (or pos (setq pos (point)))
9537 (let ((p (cperl-get-here-doc-region pos)))
9538 (or p (error "Not inside a HERE document"))
9539 (narrow-to-region (car p) (cdr p))
9541 "When you are finished with narrow editing, type C-x n w")))
9543 (defun cperl-select-this-pod-or-here-doc (&optional pos)
9544 "Select the HERE-DOC (or POD section) at POS.
9545 POS defaults to the point."
9547 (let ((p (cperl-get-here-doc-region pos t)))
9551 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
9552 (message "I do not think POS is in POD or a HERE-doc..."))))
9554 (defun cperl-facemenu-add-face-function (face end)
9555 "A callback to process user-initiated font-change requests.
9556 Translates `bold', `italic', and `bold-italic' requests to insertion of
9557 corresponding POD directives, and `underline' to C<> POD directive.
9559 Such requests are usually bound to M-o LETTER."
9560 (or (get-text-property (point) 'in-pod)
9561 (error "Faces can only be set within POD"))
9562 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
9563 (cdr (or (assq face '((bold . "B<")
9565 (bold-italic . "B<I<")
9566 (underline . "C<")))
9567 (error "Face %s not configured for cperl-mode"
9570 (defun cperl-time-fontification (&optional l step lim)
9571 "Times how long it takes to do incremental fontification in a region.
9572 L is the line to start at, STEP is the number of lines to skip when
9573 doing next incremental fontification, LIM is the maximal number of
9574 incremental fontification to perform. Messages are accumulated in
9577 May be used for pinpointing which construct slows down buffer fontification:
9578 start with default arguments, then refine the slowdown regions."
9579 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
9581 (or step (setq step 500))
9582 (or lim (setq lim 40))
9583 (let* ((timems (function (lambda ()
9584 (let ((tt (current-time)))
9585 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
9586 (tt (funcall timems)) (c 0) delta tot)
9589 (setq tot (- (- tt (setq tt (funcall timems)))))
9590 (message "cperl-mode at %s: %s" l tot)
9591 (while (and (< c lim) (not (eobp)))
9595 (cperl-update-syntaxification (point) (point))
9596 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
9597 (message "to %s:%6s,%7s" l delta tot))
9600 (defun cperl-emulate-lazy-lock (&optional window-size)
9601 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
9602 Start fontifying the buffer from the start (or end) using the given
9603 WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
9604 goes backwards; default is -50. This function is not CPerl-specific; it
9605 may be used to debug problems with delayed incremental fontification."
9607 "nSize of window for incremental fontification, negative goes backwards: ")
9608 (or window-size (setq window-size -50))
9609 (let ((pos (if (> window-size 0)
9615 ;; Why needed??? With older font-locks???
9616 (set (make-local-variable 'font-lock-cache-position) (make-marker))
9617 (while (if (> window-size 0)
9619 (> pos (point-min)))
9621 (forward-line window-size)
9623 (font-lock-fontify-region (min p pos) (max p pos))
9627 (defun cperl-lazy-install ()) ; Avoid a warning
9628 (defun cperl-lazy-unstall ()) ; Avoid a warning
9630 (if (fboundp 'run-with-idle-timer)
9632 (defvar cperl-help-shown nil
9633 "Non-nil means that the help was already shown now.")
9635 (defvar cperl-lazy-installed nil
9636 "Non-nil means that the lazy-help handlers are installed now.")
9638 (defun cperl-lazy-install ()
9639 "Switches on Auto-Help on Perl constructs (put in the message area).
9640 Delay of auto-help controlled by `cperl-lazy-help-time'."
9642 (make-variable-buffer-local 'cperl-help-shown)
9643 (if (and (cperl-val 'cperl-lazy-help-time)
9644 (not cperl-lazy-installed))
9646 (add-hook 'post-command-hook 'cperl-lazy-hook)
9647 (run-with-idle-timer
9648 (cperl-val 'cperl-lazy-help-time 1000000 5)
9650 'cperl-get-help-defer)
9651 (setq cperl-lazy-installed t))))
9653 (defun cperl-lazy-unstall ()
9654 "Switches off Auto-Help on Perl constructs (put in the message area).
9655 Delay of auto-help controlled by `cperl-lazy-help-time'."
9657 (remove-hook 'post-command-hook 'cperl-lazy-hook)
9658 (cancel-function-timers 'cperl-get-help-defer)
9659 (setq cperl-lazy-installed nil))
9661 (defun cperl-lazy-hook ()
9662 (setq cperl-help-shown nil))
9664 (defun cperl-get-help-defer ()
9665 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
9666 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
9668 (setq cperl-help-shown t))))
9669 (cperl-lazy-install)))
9672 ;;; Plug for wrong font-lock:
9674 (defun cperl-font-lock-unfontify-region-function (beg end)
9675 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
9676 (inhibit-read-only t) (inhibit-point-motion-hooks t)
9677 before-change-functions after-change-functions
9678 deactivate-mark buffer-file-name buffer-file-truename)
9679 (remove-text-properties beg end '(face nil))
9680 (if (and (not modified) (buffer-modified-p))
9681 (set-buffer-modified-p nil))))
9683 (defun cperl-font-lock-fontify-region-function (beg end loudly)
9684 "Extends the region to safe positions, then calls the default function.
9685 Newer `font-lock's can do it themselves.
9686 We unwind only as far as needed for fontification. Syntaxification may
9687 do extra unwind via `cperl-unwind-to-safe'."
9693 (eq (get-text-property (setq beg (point)) 'syntax-type)
9695 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
9701 (or (bolp) (condition-case nil
9704 (eq (get-text-property (setq end (point)) 'syntax-type)
9706 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
9709 (font-lock-default-fontify-region beg end loudly))
9711 (defvar cperl-d-l nil)
9712 (defun cperl-fontify-syntaxically (end)
9713 ;; Some vars for debugging only
9714 ;; (message "Syntaxifying...")
9715 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
9716 (istate (car cperl-syntax-state))
9717 start from-start edebug-backtrace-buffer)
9718 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
9721 (let ((f 'edebug-backtrace))
9722 (funcall f)))) ; Avoid compile-time warning
9723 (or cperl-syntax-done-to
9724 (setq cperl-syntax-done-to (point-min)
9726 (setq start (if (and cperl-hook-after-change
9728 cperl-syntax-done-to ; Fontify without change; ignore start
9729 ;; Need to forget what is after `start'
9730 (min cperl-syntax-done-to (point))))
9733 (setq start (point))
9734 (and cperl-syntaxify-unwind
9735 (setq end (cperl-unwind-to-safe t end)
9738 (setq cperl-syntax-done-to start) ; In case what follows fails
9739 (cperl-find-pods-heres start end t nil t))
9740 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
9741 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
9742 dbg iend start end idone cperl-syntax-done-to
9743 istate (car cperl-syntax-state))) ; For debugging
9744 nil)) ; Do not iterate
9746 (defun cperl-fontify-update (end)
9747 (let ((pos (point-min)) prop posend)
9748 (setq end (point-max))
9750 (setq prop (get-text-property pos 'cperl-postpone)
9751 posend (next-single-property-change pos 'cperl-postpone nil end))
9752 (and prop (put-text-property pos posend (car prop) (cdr prop)))
9754 nil) ; Do not iterate
9756 (defun cperl-fontify-update-bad (end)
9757 ;; Since fontification happens with different region than syntaxification,
9758 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
9759 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
9761 (setq pos (or (cperl-beginning-of-property
9762 (cperl-1+ pos) 'cperl-postpone)
9765 (setq posend (next-single-property-change pos 'cperl-postpone))
9766 (and prop (put-text-property pos posend (car prop) (cdr prop)))
9768 (setq prop (get-text-property pos 'cperl-postpone))))
9769 nil) ; Do not iterate
9771 ;; Called when any modification is made to buffer text.
9772 (defun cperl-after-change-function (beg end old-len)
9773 ;; We should have been informed about changes by `font-lock'. Since it
9774 ;; does not inform as which calls are defered, do it ourselves
9775 (if cperl-syntax-done-to
9776 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
9778 (defun cperl-update-syntaxification (from to)
9779 (if (and cperl-use-syntax-table-text-property
9780 cperl-syntaxify-by-font-lock
9781 (or (null cperl-syntax-done-to)
9782 (< cperl-syntax-done-to to)))
9786 (cperl-fontify-syntaxically to)))))
9788 (defvar cperl-version
9789 (let ((v "$Revision: 5.16 $"))
9790 (string-match ":\\s *\\([0-9.]+\\)" v)
9791 (substring v (match-beginning 1) (match-end 1)))
9792 "Version of IZ-supported CPerl package this file is based on.")
9794 (provide 'cperl-mode)
9796 ;;; cperl-mode.el ends here