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.19 2006/06/01 11:11:57 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.
1405 ;;; `cperl-find-pods-heres': Highlight capturing parens in REx
1408 ;;; `cperl-find-pods-heres': Highlight '|' for alternation
1409 ;;; Initialize `font-lock-warning-face' if not present
1410 ;;; `cperl-find-pods-heres': Use `font-lock-warning-face' instead of
1411 ;;; `font-lock-function-name-face'
1412 ;;; `cperl-look-at-leading-count': Likewise
1413 ;;; `cperl-find-pods-heres': localize `font-lock-variable-name-face'
1414 ;;; `font-lock-keyword-face' (needed for
1415 ;;; batch processing) etc
1416 ;;; Use `font-lock-builtin-face' for builtin in REx
1417 ;;; Now `font-lock-variable-name-face'
1418 ;;; is used for interpolated variables.
1419 ;;; Use "talking aliases" for faces inside REx
1420 ;;; Highlight parts of REx (except in charclasses)
1421 ;;; according to the syntax and/or semantic
1422 ;;; Syntax-mark a {}-part of (?{}) as "comment"
1423 ;;; (it was the ()-part)
1424 ;;; Better logic to distinguish what is what in REx
1425 ;;; `cperl-tips-faces': Document REx highlighting
1426 ;;; `cperl-praise': Mention REx syntax highlight etc.
1429 ;;; `cperl-find-sub-attrs': Would not always manage to print error message
1430 ;;; `cperl-find-pods-heres': localize `font-lock-constant-face'
1433 ;;; `cperl-find-pods-heres': Misprint in REx for parsing REx
1434 ;;; Very minor optimization
1435 ;;; `my-cperl-REx-modifiers-face' got quoted
1436 ;;; Recognize "print $foo <<END" as HERE-doc.
1437 ;;; Put `REx-interpolated' text attribute if needed
1438 ;;; `cperl-invert-if-unless-modifiers': New function.
1439 ;;; `cperl-backward-to-start-of-expr': Likewise
1440 ;;; `cperl-forward-to-end-of-expr': Likewise
1441 ;;; `cperl-invert-if-unless': Works in "the opposite way" too.
1442 ;;; Cursor position on return is on the switch-word
1443 ;;; Indents comments better
1444 ;;; `REx-interpolated': New text attribute
1445 ;;; `cperl-next-interpolated-REx': New function.
1446 ;;; `cperl-next-interpolated-REx-0': Likewise.
1447 ;;; `cperl-next-interpolated-REx-1': Likewise.
1448 ;;; "\C-c\C-x", "\C-c\C-y", "\C-c\C-v": New keybinding for these functions
1449 ;;; Perl/Regexp menu: 3 new entries for `cperl-next-interpolated-REx'
1450 ;;; `cperl-praise': Mention finded interpolated RExen.
1454 (if (fboundp 'eval-when-compile)
1462 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1463 (defvar cperl-can-font-lock
1465 (and (boundp 'emacs-major-version)
1467 (> emacs-major-version 20)))))
1468 (if cperl-can-font-lock
1469 (require 'font-lock))
1470 (defvar msb-menu-cond)
1471 (defvar gud-perldb-history)
1472 (defvar font-lock-background-mode) ; not in Emacs
1473 (defvar font-lock-display-type) ; ditto
1474 (or (fboundp 'defgroup)
1475 (defmacro defgroup (name val doc &rest arr)
1477 (or (fboundp 'custom-declare-variable)
1478 (defmacro defcustom (name val doc &rest arr)
1479 (` (defvar (, name) (, val) (, doc)))))
1480 (or (and (fboundp 'custom-declare-variable)
1481 (string< "19.31" emacs-version)) ; Checked with 19.30: defface does not work
1482 (defmacro defface (&rest arr)
1484 ;; Avoid warning (tmp definitions)
1485 (or (fboundp 'x-color-defined-p)
1486 (defmacro x-color-defined-p (col)
1487 (cond ((fboundp 'color-defined-p) (` (color-defined-p (, col))))
1489 ((fboundp 'valid-color-name-p) (` (valid-color-name-p (, col))))
1491 ((fboundp 'x-valid-color-name-p) (` (x-valid-color-name-p (, col))))
1492 (t '(error "Cannot implement color-defined-p")))))
1493 (defmacro cperl-is-face (arg) ; Takes quoted arg
1494 (cond ((fboundp 'find-face)
1495 (` (find-face (, arg))))
1496 (;;(and (fboundp 'face-list)
1498 (fboundp 'face-list)
1499 (` (member (, arg) (and (fboundp 'face-list)
1502 (` (boundp (, arg))))))
1503 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
1504 (cond ((fboundp 'make-face)
1505 (` (make-face (quote (, arg)))))
1507 (` (defvar (, arg) (quote (, arg)) (, descr))))))
1508 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
1510 (or (cperl-is-face (quote (, arg)))
1511 (cperl-make-face (, arg) (, descr)))
1512 (or (boundp (quote (, arg))) ; We use unquoted variants too
1513 (defvar (, arg) (quote (, arg)) (, descr))))))
1515 (defmacro cperl-etags-snarf-tag (file line)
1517 (beginning-of-line 2)
1518 (list (, file) (, line)))))
1519 (defmacro cperl-etags-snarf-tag (file line)
1520 (` (etags-snarf-tag))))
1522 (defmacro cperl-etags-goto-tag-location (elt)
1524 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
1525 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
1526 ;; Probably will not work due to some save-excursion???
1527 ;; Or save-file-position?
1528 ;; (message "Did I get to line %s?" (elt (, elt) 1))
1529 (goto-line (string-to-int (elt (, elt) 1)))))
1531 (defmacro cperl-etags-goto-tag-location (elt)
1532 (` (etags-goto-tag-location (, elt)))))))
1534 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1536 (defvar cperl-can-font-lock
1538 (and (boundp 'emacs-major-version)
1540 (> emacs-major-version 20)))))
1544 (error nil)) ; Already fixed by eval-when-compile
1546 (defun cperl-choose-color (&rest list)
1550 (if (or (x-color-defined-p (car list))
1552 (setq answer (car list))))
1553 (setq list (cdr list)))
1558 "Major mode for editing Perl code."
1562 (defgroup cperl-indentation-details nil
1567 (defgroup cperl-affected-by-hairy nil
1568 "Variables affected by `cperl-hairy'."
1572 (defgroup cperl-autoinsert-details nil
1573 "Auto-insert tuneup."
1577 (defgroup cperl-faces nil
1578 "Fontification colors."
1582 (defgroup cperl-speed nil
1583 "Speed vs. validity tuneup."
1587 (defgroup cperl-help-system nil
1588 "Help system tuneup."
1593 (defcustom cperl-extra-newline-before-brace nil
1594 "*Non-nil means that if, elsif, while, until, else, for, foreach
1595 and do constructs look like:
1606 :group 'cperl-autoinsert-details)
1608 (defcustom cperl-extra-newline-before-brace-multiline
1609 cperl-extra-newline-before-brace
1610 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
1611 for constructs with multiline if/unless/while/until/for/foreach condition."
1613 :group 'cperl-autoinsert-details)
1615 (defcustom cperl-indent-level 2
1616 "*Indentation of CPerl statements with respect to containing block."
1618 :group 'cperl-indentation-details)
1620 (defcustom cperl-lineup-step nil
1621 "*`cperl-lineup' will always lineup at multiple of this number.
1622 If nil, the value of `cperl-indent-level' will be used."
1623 :type '(choice (const nil) integer)
1624 :group 'cperl-indentation-details)
1626 (defcustom cperl-brace-imaginary-offset 0
1627 "*Imagined indentation of a Perl open brace that actually follows a statement.
1628 An open brace following other text is treated as if it were this far
1629 to the right of the start of its line."
1631 :group 'cperl-indentation-details)
1633 (defcustom cperl-brace-offset 0
1634 "*Extra indentation for braces, compared with other text in same context."
1636 :group 'cperl-indentation-details)
1637 (defcustom cperl-label-offset -2
1638 "*Offset of CPerl label lines relative to usual indentation."
1640 :group 'cperl-indentation-details)
1641 (defcustom cperl-min-label-indent 1
1642 "*Minimal offset of CPerl label lines."
1644 :group 'cperl-indentation-details)
1645 (defcustom cperl-continued-statement-offset 2
1646 "*Extra indent for lines not starting new statements."
1648 :group 'cperl-indentation-details)
1649 (defcustom cperl-continued-brace-offset 0
1650 "*Extra indent for substatements that start with open-braces.
1651 This is in addition to cperl-continued-statement-offset."
1653 :group 'cperl-indentation-details)
1654 (defcustom cperl-close-paren-offset -1
1655 "*Extra indent for substatements that start with close-parenthesis."
1657 :group 'cperl-indentation-details)
1659 (defcustom cperl-auto-newline nil
1660 "*Non-nil means automatically newline before and after braces,
1661 and after colons and semicolons, inserted in CPerl code. The following
1662 \\[cperl-electric-backspace] will remove the inserted whitespace.
1663 Insertion after colons requires both this variable and
1664 `cperl-auto-newline-after-colon' set."
1666 :group 'cperl-autoinsert-details)
1668 (defcustom cperl-autoindent-on-semi nil
1669 "*Non-nil means automatically indent after insertion of (semi)colon.
1670 Active if `cperl-auto-newline' is false."
1672 :group 'cperl-autoinsert-details)
1674 (defcustom cperl-auto-newline-after-colon nil
1675 "*Non-nil means automatically newline even after colons.
1676 Subject to `cperl-auto-newline' setting."
1678 :group 'cperl-autoinsert-details)
1680 (defcustom cperl-tab-always-indent t
1681 "*Non-nil means TAB in CPerl mode should always reindent the current line,
1682 regardless of where in the line point is when the TAB command is used."
1684 :group 'cperl-indentation-details)
1686 (defcustom cperl-font-lock nil
1687 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
1688 Can be overwritten by `cperl-hairy' if nil."
1689 :type '(choice (const null) boolean)
1690 :group 'cperl-affected-by-hairy)
1692 (defcustom cperl-electric-lbrace-space nil
1693 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
1694 Can be overwritten by `cperl-hairy' if nil."
1695 :type '(choice (const null) boolean)
1696 :group 'cperl-affected-by-hairy)
1698 (defcustom cperl-electric-parens-string "({[]})<"
1699 "*String of parentheses that should be electric in CPerl.
1700 Closing ones are electric only if the region is highlighted."
1702 :group 'cperl-affected-by-hairy)
1704 (defcustom cperl-electric-parens nil
1705 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
1706 Can be overwritten by `cperl-hairy' if nil."
1707 :type '(choice (const null) boolean)
1708 :group 'cperl-affected-by-hairy)
1710 (defvar zmacs-regions) ; Avoid warning
1712 (defcustom cperl-electric-parens-mark
1714 (or (and (boundp 'transient-mark-mode) ; For Emacs
1715 transient-mark-mode)
1716 (and (boundp 'zmacs-regions) ; For XEmacs
1718 "*Not-nil means that electric parens look for active mark.
1719 Default is yes if there is visual feedback on mark."
1721 :group 'cperl-autoinsert-details)
1723 (defcustom cperl-electric-linefeed nil
1724 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
1725 In any case these two mean plain and hairy linefeeds together.
1726 Can be overwritten by `cperl-hairy' if nil."
1727 :type '(choice (const null) boolean)
1728 :group 'cperl-affected-by-hairy)
1730 (defcustom cperl-electric-keywords nil
1731 "*Not-nil (and non-null) means keywords are electric in CPerl.
1732 Can be overwritten by `cperl-hairy' if nil."
1733 :type '(choice (const null) boolean)
1734 :group 'cperl-affected-by-hairy)
1736 (defcustom cperl-electric-backspace-untabify t
1737 "*Not-nil means electric-backspace will untabify in CPerl."
1739 :group 'cperl-autoinsert-details)
1741 (defcustom cperl-hairy nil
1742 "*Not-nil means most of the bells and whistles are enabled in CPerl.
1743 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
1744 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
1745 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
1746 `cperl-lazy-help-time'."
1748 :group 'cperl-affected-by-hairy)
1750 (defcustom cperl-comment-column 32
1751 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
1753 :group 'cperl-indentation-details)
1755 (defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
1756 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
1757 :type '(repeat string)
1760 (defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
1761 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
1762 :type '(repeat string)
1765 ;; This became obsolete...
1766 (defcustom cperl-vc-header-alist '()
1767 "*What to use as `vc-header-alist' in CPerl.
1768 Obsolete, with newer Emacsen use `cperl-vc-rcs-header' or
1769 `cperl-vc-sccs-header' instead. If this list is empty, `vc-header-alist'
1770 will be reconstructed basing on these two variables."
1771 :type '(repeat (list symbol string))
1774 (defcustom cperl-clobber-mode-lists
1777 (boundp 'interpreter-mode-alist)
1778 (assoc "miniperl" interpreter-mode-alist)
1779 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
1780 "*Whether to install us into `interpreter-' and `extension' mode lists."
1784 (defcustom cperl-info-on-command-no-prompt nil
1785 "*Not-nil (and non-null) means not to prompt on C-h f.
1786 The opposite behaviour is always available if prefixed with C-c.
1787 Can be overwritten by `cperl-hairy' if nil."
1788 :type '(choice (const null) boolean)
1789 :group 'cperl-affected-by-hairy)
1791 (defcustom cperl-clobber-lisp-bindings nil
1792 "*Not-nil (and non-null) means not overwrite C-h f.
1793 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
1794 Can be overwritten by `cperl-hairy' if nil."
1795 :type '(choice (const null) boolean)
1796 :group 'cperl-affected-by-hairy)
1798 (defcustom cperl-lazy-help-time nil
1799 "*Not-nil (and non-null) means to show lazy help after given idle time.
1800 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
1801 :type '(choice (const null) (const nil) integer)
1802 :group 'cperl-affected-by-hairy)
1804 (defcustom cperl-pod-face 'font-lock-comment-face
1805 "*The result of evaluation of this expression is used for POD highlighting."
1807 :group 'cperl-faces)
1809 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
1810 "*The result of evaluation of this expression is used for POD highlighting.
1811 Font for POD headers."
1813 :group 'cperl-faces)
1815 (defcustom cperl-here-face 'font-lock-string-face
1816 "*The result of evaluation of this expression is used for here-docs highlighting."
1818 :group 'cperl-faces)
1820 ;;; Some double-evaluation happened with font-locks... Needed with 21.2...
1821 (defvar cperl-singly-quote-face cperl-xemacs-p)
1823 (defcustom cperl-invalid-face ; Does not customize with '' on XEmacs
1824 (if cperl-singly-quote-face
1825 'underline ''underline) ; On older Emacsen was evaluated by `font-lock'
1826 (if cperl-singly-quote-face
1827 "*This face is used for highlighting trailing whitespace."
1828 "*The result of evaluation of this expression highlights trailing whitespace.")
1830 :group 'cperl-faces)
1832 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
1833 "*Not-nil after evaluation means to highlight POD and here-docs sections."
1835 :group 'cperl-faces)
1837 (defcustom cperl-fontify-m-as-s t
1838 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
1840 :group 'cperl-faces)
1842 (defcustom cperl-highlight-variables-indiscriminately nil
1843 "*Non-nil means perform additional highlighting on variables.
1844 Currently only changes how scalar variables are highlighted.
1845 Note that that variable is only read at initialization time for
1846 the variable `perl-font-lock-keywords-2', so changing it after you've
1847 entered CPerl mode the first time will have no effect."
1851 (defcustom cperl-pod-here-scan t
1852 "*Not-nil means look for POD and here-docs sections during startup.
1853 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
1855 :group 'cperl-speed)
1857 (defcustom cperl-regexp-scan t
1858 "*Not-nil means make marking of regular expression more thorough.
1859 Effective only with `cperl-pod-here-scan'."
1861 :group 'cperl-speed)
1863 (defcustom cperl-hook-after-change t
1864 "*Not-nil means install hook to know which regions of buffer are changed.
1865 May significantly speed up delayed fontification. Changes take effect
1868 :group 'cperl-speed)
1870 (defcustom cperl-imenu-addback nil
1871 "*Not-nil means add backreferences to generated `imenu's.
1872 May require patched `imenu' and `imenu-go'. Obsolete."
1874 :group 'cperl-help-system)
1876 (defcustom cperl-max-help-size 66
1877 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
1878 :type '(choice integer (const nil))
1879 :group 'cperl-help-system)
1881 (defcustom cperl-shrink-wrap-info-frame t
1882 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
1884 :group 'cperl-help-system)
1886 (defcustom cperl-info-page "perl"
1887 "*Name of the info page containing perl docs.
1888 Older version of this page was called `perl5', newer `perl'."
1890 :group 'cperl-help-system)
1892 (defcustom cperl-use-syntax-table-text-property
1893 (boundp 'parse-sexp-lookup-properties)
1894 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
1896 :group 'cperl-speed)
1898 (defcustom cperl-use-syntax-table-text-property-for-tags
1899 cperl-use-syntax-table-text-property
1900 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
1902 :group 'cperl-speed)
1904 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
1905 "*Regexp to match files to scan when generating TAGS."
1909 (defcustom cperl-noscan-files-regexp
1910 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
1911 "*Regexp to match files/dirs to skip when generating TAGS."
1915 (defcustom cperl-regexp-indent-step nil
1916 "*Indentation used when beautifying regexps.
1917 If nil, the value of `cperl-indent-level' will be used."
1918 :type '(choice integer (const nil))
1919 :group 'cperl-indentation-details)
1921 (defcustom cperl-indent-left-aligned-comments t
1922 "*Non-nil means that the comment starting in leftmost column should indent."
1924 :group 'cperl-indentation-details)
1926 (defcustom cperl-under-as-char t
1927 "*Non-nil means that the _ (underline) should be treated as word char."
1931 (defcustom cperl-extra-perl-args ""
1932 "*Extra arguments to use when starting Perl.
1933 Currently used with `cperl-check-syntax' only."
1937 (defcustom cperl-message-electric-keyword t
1938 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
1940 :group 'cperl-help-system)
1942 (defcustom cperl-indent-region-fix-constructs 1
1943 "*Amount of space to insert between `}' and `else' or `elsif'
1944 in `cperl-indent-region'. Set to nil to leave as is. Values other
1945 than 1 and nil will probably not work."
1946 :type '(choice (const nil) (const 1))
1947 :group 'cperl-indentation-details)
1949 (defcustom cperl-break-one-line-blocks-when-indent t
1950 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
1951 need to be reformatted into multiline ones when indenting a region."
1953 :group 'cperl-indentation-details)
1955 (defcustom cperl-fix-hanging-brace-when-indent t
1956 "*Non-nil means that BLOCK-end `}' may be put on a separate line
1957 when indenting a region.
1958 Braces followed by else/elsif/while/until are excepted."
1960 :group 'cperl-indentation-details)
1962 (defcustom cperl-merge-trailing-else t
1963 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
1964 may be merged to be on the same line when indenting a region."
1966 :group 'cperl-indentation-details)
1968 (defcustom cperl-indent-parens-as-block nil
1969 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
1970 but for trailing \",\" inside the group, which won't increase indentation.
1971 One should tune up `cperl-close-paren-offset' as well."
1973 :group 'cperl-indentation-details)
1975 (defcustom cperl-syntaxify-by-font-lock
1976 (and cperl-can-font-lock
1977 (boundp 'parse-sexp-lookup-properties))
1978 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
1979 :type '(choice (const message) boolean)
1980 :group 'cperl-speed)
1982 (defcustom cperl-syntaxify-unwind
1984 "*Non-nil means that CPerl unwinds to a start of a long construction
1985 when syntaxifying a chunk of buffer."
1987 :group 'cperl-speed)
1989 (defcustom cperl-syntaxify-for-menu
1991 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
1992 This way enabling/disabling of menu items is more correct."
1994 :group 'cperl-speed)
1996 (defcustom cperl-ps-print-face-properties
1997 '((font-lock-keyword-face nil nil bold shadow)
1998 (font-lock-variable-name-face nil nil bold)
1999 (font-lock-function-name-face nil nil bold italic box)
2000 (font-lock-constant-face nil "LightGray" bold)
2001 (cperl-array-face nil "LightGray" bold underline)
2002 (cperl-hash-face nil "LightGray" bold italic underline)
2003 (font-lock-comment-face nil "LightGray" italic)
2004 (font-lock-string-face nil nil italic underline)
2005 (cperl-nonoverridable-face nil nil italic underline)
2006 (font-lock-type-face nil nil underline)
2007 (font-lock-warning-face nil "LightGray" bold italic box)
2008 (underline nil "LightGray" strikeout))
2009 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
2010 :type '(repeat (cons symbol
2011 (cons (choice (const nil) string)
2012 (cons (choice (const nil) string)
2014 :group 'cperl-faces)
2016 (if cperl-can-font-lock
2018 (defvar cperl-dark-background
2019 (cperl-choose-color "navy" "os2blue" "darkgreen"))
2020 (defvar cperl-dark-foreground
2021 (cperl-choose-color "orchid1" "orange"))
2023 (defface cperl-nonoverridable-face
2024 (` ((((class grayscale) (background light))
2025 (:background "Gray90" :italic t :underline t))
2026 (((class grayscale) (background dark))
2027 (:foreground "Gray80" :italic t :underline t :bold t))
2028 (((class color) (background light))
2029 (:foreground "chartreuse3"))
2030 (((class color) (background dark))
2031 (:foreground (, cperl-dark-foreground)))
2032 (t (:bold t :underline t))))
2033 "Font Lock mode face used to highlight array names."
2034 :group 'cperl-faces)
2036 (defface cperl-array-face
2037 (` ((((class grayscale) (background light))
2038 (:background "Gray90" :bold t))
2039 (((class grayscale) (background dark))
2040 (:foreground "Gray80" :bold t))
2041 (((class color) (background light))
2042 (:foreground "Blue" :background "lightyellow2" :bold t))
2043 (((class color) (background dark))
2044 (:foreground "yellow" :background (, cperl-dark-background) :bold t))
2046 "Font Lock mode face used to highlight array names."
2047 :group 'cperl-faces)
2049 (defface cperl-hash-face
2050 (` ((((class grayscale) (background light))
2051 (:background "Gray90" :bold t :italic t))
2052 (((class grayscale) (background dark))
2053 (:foreground "Gray80" :bold t :italic t))
2054 (((class color) (background light))
2055 (:foreground "Red" :background "lightyellow2" :bold t :italic t))
2056 (((class color) (background dark))
2057 (:foreground "Red" :background (, cperl-dark-background) :bold t :italic t))
2058 (t (:bold t :italic t))))
2059 "Font Lock mode face used to highlight hash names."
2060 :group 'cperl-faces)))
2064 ;;; Short extra-docs.
2066 (defvar cperl-tips 'please-ignore-this-line
2067 "Get maybe newer version of this package from
2068 http://ilyaz.org/software/emacs
2069 Subdirectory `cperl-mode' may contain yet newer development releases and/or
2070 patches to related files.
2072 For best results apply to an older Emacs the patches from
2073 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
2074 \(this upgrades syntax-parsing abilities of RMS Emaxen v19.34 and
2075 v20.2 up to the level of RMS Emacs v20.3 - a must for a good Perl
2076 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
2078 Get support packages choose-color.el (or font-lock-extra.el before
2079 19.30), imenu-go.el from the same place. \(Look for other files there
2080 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
2081 later you should use choose-color.el *instead* of font-lock-extra.el
2082 \(and you will not get smart highlighting in C :-().
2084 Note that to enable Compile choices in the menu you need to install
2087 If your Emacs does not default to `cperl-mode' on Perl files, and you
2088 want it to: put the following into your .emacs file:
2090 (autoload 'perl-mode \"cperl-mode\" \"alternate mode for editing Perl programs\" t)
2094 (defalias 'perl-mode 'cperl-mode)
2097 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
2098 Also, one can generate a newer documentation running `pod2texi' converter
2099 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
2101 If you use imenu-go, run imenu on perl5-info buffer (you can do it
2102 from Perl menu). If many files are related, generate TAGS files from
2103 Tools/Tags submenu in Perl menu.
2105 If some class structure is too complicated, use Tools/Hierarchy-view
2106 from Perl menu, or hierarchic view of imenu. The second one uses the
2107 current buffer only, the first one requires generation of TAGS from
2108 Perl/Tools/Tags menu beforehand.
2110 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
2112 Switch auto-help on/off with Perl/Tools/Auto-help.
2114 Though with contemporary Emaxen CPerl mode should maintain the correct
2115 parsing of Perl even when editing, sometimes it may be lost. Fix this by
2123 In cases of more severe confusion sometimes it is helpful to do
2125 M-x load-l RET cperl-mode RET
2130 \\[load-library] cperl-mode RET
2133 Before reporting (non-)problems look in the problem section of online
2134 micro-docs on what I know about CPerl problems.")
2136 (defvar cperl-problems 'please-ignore-this-line
2137 "Description of problems in CPerl mode.
2138 Some faces will not be shown on some versions of Emacs unless you
2139 install choose-color.el, available from
2140 http://ilyaz.org/software/emacs
2142 `fill-paragraph' on a comment may leave the point behind the
2143 paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
2144 to detect it and bulk out).
2146 See documentation of a variable `cperl-problems-old-emaxen' for the
2147 problems which disappear if you upgrade Emacs to a reasonably new
2148 version (20.3 for RMS Emacs, and those of 2004 for XEmacs).")
2150 (defvar cperl-problems-old-emaxen 'please-ignore-this-line
2151 "Description of problems in CPerl mode specific for older Emacs versions.
2153 Emacs had a _very_ restricted syntax parsing engine until RMS's Emacs
2154 20.1. Most problems below are corrected starting from this version of
2155 Emacs, and all of them should be fixed in RMS's version 20.3. (Or apply
2156 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
2157 this respect (until 2003).
2159 Note that even with newer Emacsen in some very rare cases the details
2160 of interaction of `font-lock' and syntaxification may be not cleaned
2161 up yet. You may get slightly different colors basing on the order of
2162 fontification and syntaxification. Say, the initial faces is correct,
2163 but editing the buffer breaks this.
2165 Even with older Emacsen CPerl mode tries to corrects some Emacs
2166 misunderstandings, however, for efficiency reasons the degree of
2167 correction is different for different operations. The partially
2168 corrected problems are: POD sections, here-documents, regexps. The
2169 operations are: highlighting, indentation, electric keywords, electric
2172 This may be confusing, since the regexp s#//#/#\; may be highlighted
2173 as a comment, but it will be recognized as a regexp by the indentation
2174 code. Or the opposite case, when a POD section is highlighted, but
2175 may break the indentation of the following code (though indentation
2176 should work if the balance of delimiters is not broken by POD).
2178 The main trick (to make $ a \"backslash\") makes constructions like
2179 ${aaa} look like unbalanced braces. The only trick I can think of is
2180 to insert it as $ {aaa} (legal in perl5, not in perl4).
2182 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
2183 as /($|\\s)/. Note that such a transposition is not always possible.
2185 The solution is to upgrade your Emacs or patch an older one. Note
2186 that RMS's 20.2 has some bugs related to `syntax-table' text
2187 properties. Patches are available on the main CPerl download site,
2190 If these bugs cannot be fixed on your machine (say, you have an inferior
2191 environment and cannot recompile), you may still disable all the fancy stuff
2192 via `cperl-use-syntax-table-text-property'.")
2194 (defvar cperl-non-problems 'please-ignore-this-line
2195 "As you know from `problems' section, Perl syntax is too hard for CPerl on
2196 older Emacsen. Here is what you can do if you cannot upgrade, or if
2197 you want to switch off these capabilities on RMS Emacs 20.2 (+patches) or 20.3
2198 or better. Please skip this docs if you run a capable Emacs already.
2200 Most of the time, if you write your own code, you may find an equivalent
2201 \(and almost as readable) expression (what is discussed below is usually
2202 not relevant on newer Emacsen, since they can do it automatically).
2204 Try to help CPerl: add comments with embedded quotes to fix CPerl
2205 misunderstandings about the end of quotation:
2209 You won't need it too often. The reason: $ \"quotes\" the following
2210 character (this saves a life a lot of times in CPerl), thus due to
2211 Emacs parsing rules it does not consider tick (i.e., ' ) after a
2212 dollar as a closing one, but as a usual character. This is usually
2213 correct, but not in the above context.
2215 Even with older Emacsen the indentation code is pretty wise. The only
2216 drawback is that it relied on Emacs parsing to find matching
2217 parentheses. And Emacs *could not* match parentheses in Perl 100%
2220 would not break indentation, but
2226 could confuse CPerl a lot.
2228 If you still get wrong indentation in situation that you think the
2229 code should be able to parse, try:
2231 a) Check what Emacs thinks about balance of your parentheses.
2232 b) Supply the code to me (IZ).
2234 Pods were treated _very_ rudimentally. Here-documents were not
2235 treated at all (except highlighting and inhibiting indentation). Upgrade.
2237 To speed up coloring the following compromises exist:
2238 a) sub in $mypackage::sub may be highlighted.
2239 b) -z in [a-z] may be highlighted.
2240 c) if your regexp contains a keyword (like \"s\"), it may be highlighted.
2243 Imenu in 19.31 is broken. Set `imenu-use-keymap-menu' to t, and remove
2244 `car' before `imenu-choose-buffer-index' in `imenu'.
2245 `imenu-add-to-menubar' in 20.2 is broken.
2246 A lot of things on XEmacs may be broken too, judging by bug reports I
2247 receive. Note that some releases of XEmacs are better than the others
2248 as far as bugs reports I see are concerned.")
2250 (defvar cperl-praise 'please-ignore-this-line
2251 "Advantages of CPerl mode.
2253 0) It uses the newest `syntax-table' property ;-);
2255 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
2256 mode - but the latter number may have improved too in last years) even
2257 with old Emaxen which do not support `syntax-table' property.
2259 When using `syntax-table' property for syntax assist hints, it should
2260 handle 99.995% of lines correct - or somesuch. It automatically
2261 updates syntax assist hints when you edit your script.
2263 2) It is generally believed to be \"the most user-friendly Emacs
2264 package\" whatever it may mean (I doubt that the people who say similar
2265 things tried _all_ the rest of Emacs ;-), but this was not a lonely
2268 3) Everything is customizable, one-by-one or in a big sweep;
2270 4) It has many easily-accessable \"tools\":
2271 a) Can run program, check syntax, start debugger;
2272 b) Can lineup vertically \"middles\" of rows, like `=' in
2275 c) Can insert spaces where this impoves readability (in one
2276 interactive sweep over the buffer);
2277 d) Has support for imenu, including:
2278 1) Separate unordered list of \"interesting places\";
2279 2) Separate TOC of POD sections;
2280 3) Separate list of packages;
2281 4) Hierarchical view of methods in (sub)packages;
2282 5) and functions (by the full name - with package);
2283 e) Has an interface to INFO docs for Perl; The interface is
2284 very flexible, including shrink-wrapping of
2285 documentation buffer/frame;
2286 f) Has a builtin list of one-line explanations for perl constructs.
2287 g) Can show these explanations if you stay long enough at the
2288 corresponding place (or on demand);
2289 h) Has an enhanced fontification (using 3 or 4 additional faces
2290 comparing to font-lock - basically, different
2291 namespaces in Perl have different colors);
2292 i) Can construct TAGS basing on its knowledge of Perl syntax,
2293 the standard menu has 6 different way to generate
2294 TAGS (if \"by directory\", .xs files - with C-language
2295 bindings - are included in the scan);
2296 j) Can build a hierarchical view of classes (via imenu) basing
2297 on generated TAGS file;
2298 k) Has electric parentheses, electric newlines, uses Abbrev
2299 for electric logical constructs
2301 with different styles of expansion (context sensitive
2302 to be not so bothering). Electric parentheses behave
2303 \"as they should\" in a presence of a visible region.
2304 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
2310 n) Highlights (by user-choice) either 3-delimiters constructs
2311 (such as tr/a/b/), or regular expressions and `y/tr';
2312 o) Highlights trailing whitespace;
2313 p) Is able to manipulate Perl Regular Expressions to ease
2314 conversion to a more readable form.
2315 q) Can ispell POD sections and HERE-DOCs.
2316 r) Understands comments and character classes inside regular
2317 expressions; can find matching () and [] in a regular expression.
2318 s) Allows indentation of //x-style regular expressions;
2319 t) Highlights different symbols in regular expressions according
2320 to their function; much less problems with backslashitis;
2321 u) Allows to find regular expressions which contain interpolated parts.
2323 5) The indentation engine was very smart, but most of tricks may be
2324 not needed anymore with the support for `syntax-table' property. Has
2325 progress indicator for indentation (with `imenu' loaded).
2327 6) Indent-region improves inline-comments as well; also corrects
2328 whitespace *inside* the conditional/loop constructs.
2330 7) Fill-paragraph correctly handles multi-line comments;
2332 8) Can switch to different indentation styles by one command, and restore
2333 the settings present before the switch.
2335 9) When doing indentation of control constructs, may correct
2336 line-breaks/spacing between elements of the construct.
2338 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
2339 capable syntax engines).
2341 11) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
2344 (defvar cperl-speed 'please-ignore-this-line
2345 "This is an incomplete compendium of what is available in other parts
2346 of CPerl documentation. (Please inform me if I skept anything.)
2348 There is a perception that CPerl is slower than alternatives. This part
2349 of documentation is designed to overcome this misconception.
2351 *By default* CPerl tries to enable the most comfortable settings.
2352 From most points of view, correctly working package is infinitely more
2353 comfortable than a non-correctly working one, thus by default CPerl
2354 prefers correctness over speed. Below is the guide how to change
2355 settings if your preferences are different.
2357 A) Speed of loading the file. When loading file, CPerl may perform a
2358 scan which indicates places which cannot be parsed by primitive Emacs
2359 syntax-parsing routines, and marks them up so that either
2361 A1) CPerl may work around these deficiencies (for big chunks, mostly
2362 PODs and HERE-documents), or
2363 A2) On capable Emaxen CPerl will use improved syntax-handlings
2364 which reads mark-up hints directly.
2366 The scan in case A2 is much more comprehensive, thus may be slower.
2368 User can disable syntax-engine-helping scan of A2 by setting
2369 `cperl-use-syntax-table-text-property'
2370 variable to nil (if it is set to t).
2372 One can disable the scan altogether (both A1 and A2) by setting
2373 `cperl-pod-here-scan'
2376 B) Speed of editing operations.
2378 One can add a (minor) speedup to editing operations by setting
2379 `cperl-use-syntax-table-text-property'
2380 variable to nil (if it is set to t). This will disable
2381 syntax-engine-helping scan, thus will make many more Perl
2382 constructs be wrongly recognized by CPerl, thus may lead to
2383 wrongly matched parentheses, wrong indentation, etc.
2385 One can unset `cperl-syntaxify-unwind'. This might speed up editing
2386 of, say, long POD sections.")
2388 (defvar cperl-tips-faces 'please-ignore-this-line
2389 "CPerl mode uses following faces for highlighting:
2391 `cperl-array-face' Array names
2392 `cperl-hash-face' Hash names
2393 `font-lock-comment-face' Comments, PODs and whatever is considered
2394 syntaxically to be not code
2395 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
2396 2-arg operators s/y/tr/ or of RExen,
2397 `font-lock-warning-face' Special-cased m// and s//foo/,
2398 `font-lock-function-name-face' _ as a target of a file tests, file tests,
2399 subroutine names at the moment of definition
2400 (except those conflicting with Perl operators),
2401 package names (when recognized), format names
2402 `font-lock-keyword-face' Control flow switch constructs, declarators
2403 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
2404 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
2405 literal parts and the terminator of formats
2406 and whatever is syntaxically considered
2408 `font-lock-type-face' Overridable keywords
2409 `font-lock-variable-name-face' Variable declarations, indirect array and
2410 hash names, POD headers/item names
2411 `cperl-invalid-face' Trailing whitespace
2413 Note that in several situations the highlighting tries to inform about
2414 possible confusion, such as different colors for function names in
2415 declarations depending on what they (do not) override, or special cases
2416 m// and s/// which do not do what one would expect them to do.
2418 Help with best setup of these faces for printout requested (for each of
2419 the faces: please specify bold, italic, underline, shadow and box.)
2421 In regular expressions (except character classes):
2422 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
2423 `font-lock-constant-face': Delimiters
2424 `font-lock-warning-face' Special-cased m// and s//foo/,
2425 Mismatched closing delimiters, parens
2426 we couldn't match, misplaced quantifiers,
2427 unrecognized escape sequences
2428 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
2429 `font-lock-type-face' POSIX classes inside charclasses,
2430 escape sequences with arguments (\x \23 \p \N)
2431 and others match-a-char escape sequences
2432 `font-lock-keyword-face' Capturing parens, and |
2433 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
2434 `font-lock-builtin-face' \"Remaining\" 0-length constructs, executable
2435 parts of a REx, not-capturing parens
2436 `font-lock-variable-name-face' Interpolated constructs, embedded code
2437 `font-lock-comment-face' Embedded comments
2443 ;;; Portability stuff:
2445 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
2446 (` (define-key cperl-mode-map
2448 (` (if cperl-xemacs-p (, xemacs-key) (, emacs-key)))
2452 (defvar cperl-del-back-ch
2453 (car (append (where-is-internal 'delete-backward-char)
2454 (where-is-internal 'backward-delete-char-untabify)))
2455 "Character generated by key bound to `delete-backward-char'.")
2457 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
2458 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
2460 (defun cperl-mark-active () (mark)) ; Avoid undefined warning
2463 ;; "Active regions" are on: use region only if active
2464 ;; "Active regions" are off: use region unconditionally
2465 (defun cperl-use-region-p ()
2466 (if zmacs-regions (mark) t)))
2467 (defun cperl-use-region-p ()
2468 (if transient-mark-mode mark-active t))
2469 (defun cperl-mark-active () mark-active))
2471 (defsubst cperl-enable-font-lock ()
2472 cperl-can-font-lock)
2474 (defun cperl-putback-char (c) ; Emacs 19
2475 (set 'unread-command-events (list c))) ; Avoid undefined warning
2477 (if (boundp 'unread-command-events)
2479 (defun cperl-putback-char (c) ; XEmacs >= 19.12
2480 (setq unread-command-events (list (eval '(character-to-event c))))))
2481 (defun cperl-putback-char (c) ; XEmacs <= 19.11
2482 (set 'unread-command-event (eval '(character-to-event c))))) ; Avoid warnings
2484 (or (fboundp 'uncomment-region)
2485 (defun uncomment-region (beg end)
2487 (comment-region beg end -1)))
2489 (defvar cperl-do-not-fontify
2490 (if (string< emacs-version "19.30")
2493 "Text property which inhibits refontification.")
2495 (defsubst cperl-put-do-not-fontify (from to &optional post)
2496 ;; If POST, do not do it with postponed fontification
2497 (if (and post cperl-syntaxify-by-font-lock)
2499 (put-text-property (max (point-min) (1- from))
2500 to cperl-do-not-fontify t)))
2502 (defcustom cperl-mode-hook nil
2503 "Hook run by CPerl mode."
2507 (defvar cperl-syntax-state nil)
2508 (defvar cperl-syntax-done-to nil)
2509 (defvar cperl-emacs-can-parse (> (length (save-excursion
2510 (parse-partial-sexp (point) (point)))) 9))
2512 ;; Make customization possible "in reverse"
2513 (defsubst cperl-val (symbol &optional default hairy)
2515 ((eq (symbol-value symbol) 'null) default)
2516 (cperl-hairy (or hairy t))
2517 (t (symbol-value symbol))))
2520 (defun cperl-make-indent (column &optional minimum keep)
2521 "Makes indent of the current line the requested amount.
2522 If ANEW, removes the old indentation. Works around a bug in ancient
2524 (let ((prop (get-text-property (point) 'syntax-type)))
2526 (delete-horizontal-space))
2527 (indent-to column minimum)
2528 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
2530 (> (current-column) 0)
2533 (or (get-text-property (point) 'syntax-type)
2534 (and (looking-at "\\=[ \t]")
2535 (put-text-property (point) (match-end 0)
2536 'syntax-type prop)))))))
2538 ;;; Probably it is too late to set these guys already, but it can help later:
2540 (and cperl-clobber-mode-lists
2541 (setq auto-mode-alist
2542 (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
2543 (and (boundp 'interpreter-mode-alist)
2544 (setq interpreter-mode-alist (append interpreter-mode-alist
2545 '(("miniperl" . perl-mode))))))
2546 (if (fboundp 'eval-when-compile)
2552 '(imenu easymenu etags timer man info))
2553 (if (fboundp 'ps-extend-face-list)
2554 (defmacro cperl-ps-extend-face-list (arg)
2555 (` (ps-extend-face-list (, arg))))
2556 (defmacro cperl-ps-extend-face-list (arg)
2557 (` (error "This version of Emacs has no `ps-extend-face-list'"))))
2558 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
2559 ;; macros instead of defsubsts don't work on Emacs, so we do the
2560 ;; expansion manually. Any other suggestions?
2561 (if cperl-can-font-lock
2562 (require 'font-lock))
2565 (defvar cperl-mode-abbrev-table nil
2566 "Abbrev table in use in CPerl mode buffers.")
2568 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
2570 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
2572 (if cperl-mode-map nil
2573 (setq cperl-mode-map (make-sparse-keymap))
2574 (cperl-define-key "{" 'cperl-electric-lbrace)
2575 (cperl-define-key "[" 'cperl-electric-paren)
2576 (cperl-define-key "(" 'cperl-electric-paren)
2577 (cperl-define-key "<" 'cperl-electric-paren)
2578 (cperl-define-key "}" 'cperl-electric-brace)
2579 (cperl-define-key "]" 'cperl-electric-rparen)
2580 (cperl-define-key ")" 'cperl-electric-rparen)
2581 (cperl-define-key ";" 'cperl-electric-semi)
2582 (cperl-define-key ":" 'cperl-electric-terminator)
2583 (cperl-define-key "\C-j" 'newline-and-indent)
2584 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
2585 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
2586 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
2587 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
2588 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
2589 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
2590 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
2591 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
2592 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
2593 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
2594 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
2595 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx)
2596 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0)
2597 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1)
2598 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
2599 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
2600 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
2601 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
2602 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
2604 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
2605 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
2606 (cperl-define-key "\177" 'cperl-electric-backspace)
2607 (cperl-define-key "\t" 'cperl-indent-command)
2608 ;; don't clobber the backspace binding:
2609 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
2610 [(control c) (control h) F])
2611 (if (cperl-val 'cperl-clobber-lisp-bindings)
2613 (cperl-define-key "\C-hf"
2614 ;;(concat (char-to-string help-char) "f") ; does not work
2615 'cperl-info-on-command
2617 (cperl-define-key "\C-hv"
2618 ;;(concat (char-to-string help-char) "v") ; does not work
2621 (cperl-define-key "\C-c\C-hf"
2622 ;;(concat (char-to-string help-char) "f") ; does not work
2623 (key-binding "\C-hf")
2624 [(control c) (control h) f])
2625 (cperl-define-key "\C-c\C-hv"
2626 ;;(concat (char-to-string help-char) "v") ; does not work
2627 (key-binding "\C-hv")
2628 [(control c) (control h) v]))
2629 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
2630 [(control c) (control h) f])
2631 (cperl-define-key "\C-c\C-hv"
2632 ;;(concat (char-to-string help-char) "v") ; does not work
2634 [(control c) (control h) v]))
2635 (if (and cperl-xemacs-p
2636 (<= emacs-minor-version 11) (<= emacs-major-version 19))
2638 ;; substitute-key-definition is usefulness-deenhanced...
2639 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
2640 (cperl-define-key "\e;" 'cperl-indent-for-comment)
2641 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
2642 (or (boundp 'fill-paragraph-function)
2643 (substitute-key-definition
2644 'fill-paragraph 'cperl-fill-paragraph
2645 cperl-mode-map global-map))
2646 (substitute-key-definition
2647 'indent-sexp 'cperl-indent-exp
2648 cperl-mode-map global-map)
2649 (substitute-key-definition
2650 'indent-region 'cperl-indent-region
2651 cperl-mode-map global-map)
2652 (substitute-key-definition
2653 'indent-for-comment 'cperl-indent-for-comment
2654 cperl-mode-map global-map)))
2657 (defvar cperl-lazy-installed)
2658 (defvar cperl-old-style nil)
2663 cperl-menu cperl-mode-map "Menu for CPerl mode"
2665 ["Beginning of function" beginning-of-defun t]
2666 ["End of function" end-of-defun t]
2667 ["Mark function" mark-defun t]
2668 ["Indent expression" cperl-indent-exp t]
2669 ["Fill paragraph/comment" cperl-fill-paragraph t]
2671 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
2672 ["Invert if/unless/while etc" cperl-invert-if-unless t]
2674 ["Beautify" cperl-beautify-regexp
2675 cperl-use-syntax-table-text-property]
2676 ["Beautify one level deep" (cperl-beautify-regexp 1)
2677 cperl-use-syntax-table-text-property]
2678 ["Beautify a group" cperl-beautify-level
2679 cperl-use-syntax-table-text-property]
2680 ["Beautify a group one level deep" (cperl-beautify-level 1)
2681 cperl-use-syntax-table-text-property]
2682 ["Contract a group" cperl-contract-level
2683 cperl-use-syntax-table-text-property]
2684 ["Contract groups" cperl-contract-levels
2685 cperl-use-syntax-table-text-property]
2687 ["Find next interpolated" cperl-next-interpolated-REx
2688 (next-single-property-change (point-min) 'REx-interpolated)]
2689 ["Find next interpolated (no //o)"
2690 cperl-next-interpolated-REx-0
2691 (or (text-property-any (point-min) (point-max) 'REx-interpolated t)
2692 (text-property-any (point-min) (point-max) 'REx-interpolated 1))]
2693 ["Find next interpolated (neither //o nor whole-REx)"
2694 cperl-next-interpolated-REx-1
2695 (text-property-any (point-min) (point-max) 'REx-interpolated t)])
2696 ["Insert spaces if needed to fix style" cperl-find-bad-style t]
2697 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
2699 ["Indent region" cperl-indent-region (cperl-use-region-p)]
2700 ["Comment region" cperl-comment-region (cperl-use-region-p)]
2701 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
2703 ["Run" mode-compile (fboundp 'mode-compile)]
2704 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
2705 (get-buffer "*compilation*"))]
2706 ["Next error" next-error (get-buffer "*compilation*")]
2707 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
2709 ["Debugger" cperl-db t]
2712 ["Imenu" imenu (fboundp 'imenu)]
2713 ["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
2715 ["Ispell PODs" cperl-pod-spell
2716 ;; Better not to update syntaxification here:
2717 ;; debugging syntaxificatio can be broken by this???
2719 (get-text-property (point-min) 'in-pod)
2721 (and cperl-syntaxify-for-menu
2722 (cperl-update-syntaxification (point-max) (point-max)))
2723 (next-single-property-change (point-min) 'in-pod nil (point-max)))
2725 ["Ispell HERE-DOCs" cperl-here-doc-spell
2727 (and cperl-syntaxify-for-menu
2728 (cperl-update-syntaxification (point-max) (point-max)))
2729 (next-single-property-change (point-min) 'here-doc-group nil (point-max)))
2731 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
2732 (eq 'here-doc (progn
2733 (and cperl-syntaxify-for-menu
2734 (cperl-update-syntaxification (point) (point)))
2735 (get-text-property (point) 'syntax-type)))]
2736 ["Select this HERE-DOC or POD section"
2737 cperl-select-this-pod-or-here-doc
2739 (and cperl-syntaxify-for-menu
2740 (cperl-update-syntaxification (point) (point)))
2741 (get-text-property (point) 'syntax-type))
2744 ["CPerl pretty print (exprmntl)" cperl-ps-print
2745 (fboundp 'ps-extend-face-list)]
2747 ["Syntaxify region" cperl-find-pods-heres-region
2748 (cperl-use-region-p)]
2749 ["Profile syntaxification" cperl-time-fontification t]
2750 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
2751 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t]
2752 ["Debug backtrace on syntactic scan (BEWARE!!!)"
2753 (cperl-toggle-set-debug-unwind nil t) t]
2755 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
2756 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
2758 ;;; ["Create tags for current file" cperl-etags t]
2759 ;;; ["Add tags for current file" (cperl-etags t) t]
2760 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
2761 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
2762 ;;; ["Create tags for Perl files in (sub)directories"
2763 ;;; (cperl-etags nil 'recursive) t]
2764 ;;; ["Add tags for Perl files in (sub)directories"
2765 ;;; (cperl-etags t 'recursive) t])
2766 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
2767 ["Create tags for current file" (cperl-write-tags nil t) t]
2768 ["Add tags for current file" (cperl-write-tags) t]
2769 ["Create tags for Perl files in directory"
2770 (cperl-write-tags nil t nil t) t]
2771 ["Add tags for Perl files in directory"
2772 (cperl-write-tags nil nil nil t) t]
2773 ["Create tags for Perl files in (sub)directories"
2774 (cperl-write-tags nil t t t) t]
2775 ["Add tags for Perl files in (sub)directories"
2776 (cperl-write-tags nil nil t t) t]))
2778 ["Define word at point" imenu-go-find-at-position
2779 (fboundp 'imenu-go-find-at-position)]
2780 ["Help on function" cperl-info-on-command t]
2781 ["Help on function at point" cperl-info-on-current-command t]
2782 ["Help on symbol at point" cperl-get-help t]
2783 ["Perldoc" cperl-perldoc t]
2784 ["Perldoc on word at point" cperl-perldoc-at-point t]
2785 ["View manpage of POD in this file" cperl-build-manpage t]
2786 ["Auto-help on" cperl-lazy-install
2787 (and (fboundp 'run-with-idle-timer)
2788 (not cperl-lazy-installed))]
2789 ["Auto-help off" cperl-lazy-unstall
2790 (and (fboundp 'run-with-idle-timer)
2791 cperl-lazy-installed)])
2793 ["Auto newline" cperl-toggle-auto-newline t]
2794 ["Electric parens" cperl-toggle-electric t]
2795 ["Electric keywords" cperl-toggle-abbrev t]
2796 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
2797 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
2798 ["Auto fill" auto-fill-mode t])
2800 ["CPerl" (cperl-set-style "CPerl") t]
2801 ["PerlStyle" (cperl-set-style "PerlStyle") t]
2802 ["GNU" (cperl-set-style "GNU") t]
2803 ["C++" (cperl-set-style "C++") t]
2804 ["FSF" (cperl-set-style "FSF") t]
2805 ["BSD" (cperl-set-style "BSD") t]
2806 ["Whitesmith" (cperl-set-style "Whitesmith") t]
2807 ["Current" (cperl-set-style "Current") t]
2808 ["Memorized" (cperl-set-style-back) cperl-old-style])
2810 ["Tips" (describe-variable 'cperl-tips) t]
2811 ["Problems" (describe-variable 'cperl-problems) t]
2812 ["Non-problems" (describe-variable 'cperl-non-problems) t]
2813 ["Speed" (describe-variable 'cperl-speed) t]
2814 ["Praise" (describe-variable 'cperl-praise) t]
2815 ["Faces" (describe-variable 'cperl-tips-faces) t]
2816 ["CPerl mode" (describe-function 'cperl-mode) t]
2818 (message "The version of master-file for this CPerl is %s"
2819 cperl-version) t]))))
2822 (autoload 'c-macro-expand "cmacexp"
2823 "Display the result of expanding all C macros occurring in the region.
2824 The expansion is entirely correct because it uses the C preprocessor."
2827 ;;; These two must be unwound, otherwise take exponential time
2828 (defconst cperl-maybe-white-and-comment-rex "[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
2829 "Regular expression to match optional whitespace with interpspersed comments.
2830 Should contain exactly one group.")
2832 ;;; This one is tricky to unwind; still very inefficient...
2833 (defconst cperl-white-and-comment-rex "\\([ \t\n]\\|#[^\n]*\n\\)+"
2834 "Regular expression to match whitespace with interpspersed comments.
2835 Should contain exactly one group.")
2838 ;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
2839 ;;; `cperl-outline-regexp', `defun-prompt-regexp'.
2840 ;;; Details of groups in this may be used in several functions; see comments
2841 ;;; near mentioned above variable(s)...
2842 ;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
2843 (defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
2844 "Match the text after `sub' in a subroutine declaration.
2845 If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
2846 of attributes (if present), or end of the name or prototype (whatever is
2848 (concat ; Assume n groups before this...
2849 "\\(" ; n+1=name-group
2850 cperl-white-and-comment-rex ; n+2=pre-name
2851 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
2852 "\\)" ; END n+1=name-group
2854 "\\(" ; n+4=proto-group
2855 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
2856 "\\(([^()]*)\\)" ; n+6=prototype
2857 "\\)?" ; END n+4=proto-group
2858 "\\(" ; n+7=attr-group
2859 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
2860 "\\(" ; n+9=start-attr
2864 cperl-maybe-white-and-comment-rex ; whitespace-comments
2865 "\\(\\sw\\|_\\)+" ; attr-name
2866 ;; attr-arg (1 level of internal parens allowed!)
2867 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
2868 "\\(" ; optional : (XXX allows trailing???)
2869 cperl-maybe-white-and-comment-rex ; whitespace-comments
2874 "\\)?" ; END n+6=proto-group
2877 ;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
2878 ;;; and `cperl-outline-level'.
2879 ;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
2880 (defvar cperl-imenu--function-name-regexp-perl
2883 "\\([ \t]*package" ; 2 = package-group
2884 "\\(" ; 3 = package-name-group
2885 cperl-white-and-comment-rex ; 4 = pre-package-name
2886 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
2889 (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
2890 cperl-maybe-white-and-comment-rex ; 15=pre-block
2892 "=head\\([1-4]\\)[ \t]+" ; 16=level
2893 "\\([^\n]+\\)$" ; 17=text
2896 (defvar cperl-outline-regexp
2897 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
2899 (defvar cperl-mode-syntax-table nil
2900 "Syntax table in use in CPerl mode buffers.")
2902 (defvar cperl-string-syntax-table nil
2903 "Syntax table in use in CPerl mode string-like chunks.")
2905 (defsubst cperl-1- (p)
2906 (max (point-min) (1- p)))
2908 (defsubst cperl-1+ (p)
2909 (min (point-max) (1+ p)))
2911 (if cperl-mode-syntax-table
2913 (setq cperl-mode-syntax-table (make-syntax-table))
2914 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
2915 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
2916 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
2917 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
2918 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
2919 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
2920 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
2921 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
2922 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
2923 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
2924 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
2925 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
2926 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
2927 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
2928 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
2929 (if cperl-under-as-char
2930 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
2931 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
2932 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
2933 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
2934 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
2935 (modify-syntax-entry ?\{ "." cperl-string-syntax-table)
2936 (modify-syntax-entry ?\} "." cperl-string-syntax-table)
2937 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
2941 ;; provide an alias for working with emacs 19. the perl-mode that comes
2942 ;; with it is really bad, and this lets us seamlessly replace it.
2944 (fset 'perl-mode 'cperl-mode)
2945 (defvar cperl-faces-init nil)
2947 (defvar cperl-msb-fixed nil)
2948 (defvar font-lock-syntactic-keywords)
2949 (defvar perl-font-lock-keywords)
2950 (defvar perl-font-lock-keywords-1)
2951 (defvar perl-font-lock-keywords-2)
2952 (defvar outline-level)
2953 (if (fboundp 'defvaralias)
2954 (let ((f 'defvaralias)) ; Some functions deduce stuff from the mode name...
2955 (funcall f 'cperl-font-lock-keywords 'perl-font-lock-keywords)
2956 (funcall f 'cperl-font-lock-keywords-1 'perl-font-lock-keywords-1)
2957 (funcall f 'cperl-font-lock-keywords-2 'perl-font-lock-keywords-2)))
2959 (defvar cperl-use-major-mode 'perl-mode)
2960 (defvar cperl-font-lock-multiline-start nil)
2961 (defvar cperl-font-lock-multiline nil)
2962 (defvar cperl-compilation-error-regexp-alist nil)
2963 (defvar cperl-font-locking nil)
2966 (defun cperl-mode ()
2967 "Major mode for editing Perl code.
2968 Expression and list commands understand all C brackets.
2969 Tab indents for Perl code.
2970 Paragraphs are separated by blank lines only.
2971 Delete converts tabs to spaces as it moves back.
2973 Various characters in Perl almost always come in pairs: {}, (), [],
2974 sometimes <>. When the user types the first, she gets the second as
2975 well, with optional special formatting done on {}. (Disabled by
2976 default.) You can always quote (with \\[quoted-insert]) the left
2977 \"paren\" to avoid the expansion. The processing of < is special,
2978 since most the time you mean \"less\". CPerl mode tries to guess
2979 whether you want to type pair <>, and inserts is if it
2980 appropriate. You can set `cperl-electric-parens-string' to the string that
2981 contains the parenths from the above list you want to be electrical.
2982 Electricity of parenths is controlled by `cperl-electric-parens'.
2983 You may also set `cperl-electric-parens-mark' to have electric parens
2984 look for active mark and \"embrace\" a region if possible.'
2986 CPerl mode provides expansion of the Perl control constructs:
2988 if, else, elsif, unless, while, until, continue, do,
2989 for, foreach, formy and foreachmy.
2991 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
2993 The user types the keyword immediately followed by a space, which
2994 causes the construct to be expanded, and the point is positioned where
2995 she is most likely to want to be. eg. when the user types a space
2996 following \"if\" the following appears in the buffer: if () { or if ()
2997 } { } and the cursor is between the parentheses. The user can then
2998 type some boolean expression within the parens. Having done that,
2999 typing \\[cperl-linefeed] places you - appropriately indented - on a
3000 new line between the braces (if you typed \\[cperl-linefeed] in a POD
3001 directive line, then appropriate number of new lines is inserted).
3003 If CPerl decides that you want to insert \"English\" style construct like
3007 it will not do any expansion. See also help on variable
3008 `cperl-extra-newline-before-brace'. (Note that one can switch the
3009 help message on expansion by setting `cperl-message-electric-keyword'
3012 \\[cperl-linefeed] is a convenience replacement for typing carriage
3013 return. It places you in the next line with proper indentation, or if
3014 you type it inside the inline block of control construct, like
3016 foreach (@lines) {print; print}
3018 and you are on a boundary of a statement inside braces, it will
3019 transform the construct into a multiline and will place you into an
3020 appropriately indented blank line. If you need a usual
3021 `newline-and-indent' behaviour, it is on \\[newline-and-indent],
3022 see documentation on `cperl-electric-linefeed'.
3024 Use \\[cperl-invert-if-unless] to change a construction of the form
3034 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
3035 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
3036 on electric space between $ and {, `cperl-electric-parens-string' is
3037 the string that contains parentheses that should be electric in CPerl
3038 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
3039 setting `cperl-electric-keywords' enables electric expansion of
3040 control structures in CPerl. `cperl-electric-linefeed' governs which
3041 one of two linefeed behavior is preferable. You can enable all these
3042 options simultaneously (recommended mode of use) by setting
3043 `cperl-hairy' to t. In this case you can switch separate options off
3044 by setting them to `null'. Note that one may undo the extra
3045 whitespace inserted by semis and braces in `auto-newline'-mode by
3046 consequent \\[cperl-electric-backspace].
3048 If your site has perl5 documentation in info format, you can use commands
3049 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
3050 These keys run commands `cperl-info-on-current-command' and
3051 `cperl-info-on-command', which one is which is controlled by variable
3052 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
3053 \(in turn affected by `cperl-hairy').
3055 Even if you have no info-format documentation, short one-liner-style
3056 help is available on \\[cperl-get-help], and one can run perldoc or
3059 It is possible to show this help automatically after some idle time.
3060 This is regulated by variable `cperl-lazy-help-time'. Default with
3061 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
3062 secs idle time . It is also possible to switch this on/off from the
3063 menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
3065 Use \\[cperl-lineup] to vertically lineup some construction - put the
3066 beginning of the region at the start of construction, and make region
3067 span the needed amount of lines.
3069 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
3070 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
3071 here-docs sections. With capable Emaxen results of scan are used
3072 for indentation too, otherwise they are used for highlighting only.
3074 Variables controlling indentation style:
3075 `cperl-tab-always-indent'
3076 Non-nil means TAB in CPerl mode should always reindent the current line,
3077 regardless of where in the line point is when the TAB command is used.
3078 `cperl-indent-left-aligned-comments'
3079 Non-nil means that the comment starting in leftmost column should indent.
3080 `cperl-auto-newline'
3081 Non-nil means automatically newline before and after braces,
3082 and after colons and semicolons, inserted in Perl code. The following
3083 \\[cperl-electric-backspace] will remove the inserted whitespace.
3084 Insertion after colons requires both this variable and
3085 `cperl-auto-newline-after-colon' set.
3086 `cperl-auto-newline-after-colon'
3087 Non-nil means automatically newline even after colons.
3088 Subject to `cperl-auto-newline' setting.
3089 `cperl-indent-level'
3090 Indentation of Perl statements within surrounding block.
3091 The surrounding block's indentation is the indentation
3092 of the line on which the open-brace appears.
3093 `cperl-continued-statement-offset'
3094 Extra indentation given to a substatement, such as the
3095 then-clause of an if, or body of a while, or just a statement continuation.
3096 `cperl-continued-brace-offset'
3097 Extra indentation given to a brace that starts a substatement.
3098 This is in addition to `cperl-continued-statement-offset'.
3099 `cperl-brace-offset'
3100 Extra indentation for line if it starts with an open brace.
3101 `cperl-brace-imaginary-offset'
3102 An open brace following other text is treated as if it the line started
3103 this far to the right of the actual line indentation.
3104 `cperl-label-offset'
3105 Extra indentation for line that is a label.
3106 `cperl-min-label-indent'
3107 Minimal indentation for line that is a label.
3109 Settings for K&R and BSD indentation styles are
3110 `cperl-indent-level' 5 8
3111 `cperl-continued-statement-offset' 5 8
3112 `cperl-brace-offset' -5 -8
3113 `cperl-label-offset' -5 -8
3115 CPerl knows several indentation styles, and may bulk set the
3116 corresponding variables. Use \\[cperl-set-style] to do this. Use
3117 \\[cperl-set-style-back] to restore the memorized preexisting values
3118 \(both available from menu).
3120 If `cperl-indent-level' is 0, the statement after opening brace in
3121 column 0 is indented on
3122 `cperl-brace-offset'+`cperl-continued-statement-offset'.
3124 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
3127 DO NOT FORGET to read micro-docs (available from `Perl' menu)
3128 or as help on variables `cperl-tips', `cperl-problems',
3129 `cperl-non-problems', `cperl-praise', `cperl-speed'."
3131 (kill-all-local-variables)
3132 (use-local-map cperl-mode-map)
3133 (if (cperl-val 'cperl-electric-linefeed)
3135 (local-set-key "\C-J" 'cperl-linefeed)
3136 (local-set-key "\C-C\C-J" 'newline-and-indent)))
3138 (cperl-val 'cperl-clobber-lisp-bindings)
3139 (cperl-val 'cperl-info-on-command-no-prompt))
3141 ;; don't clobber the backspace binding:
3142 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
3143 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
3144 [(control c) (control h) f])))
3145 (setq major-mode cperl-use-major-mode)
3146 (setq mode-name "CPerl")
3147 (if (not cperl-mode-abbrev-table)
3148 (let ((prev-a-c abbrevs-changed))
3149 (define-abbrev-table 'cperl-mode-abbrev-table '(
3150 ("if" "if" cperl-electric-keyword 0)
3151 ("elsif" "elsif" cperl-electric-keyword 0)
3152 ("while" "while" cperl-electric-keyword 0)
3153 ("until" "until" cperl-electric-keyword 0)
3154 ("unless" "unless" cperl-electric-keyword 0)
3155 ("else" "else" cperl-electric-else 0)
3156 ("continue" "continue" cperl-electric-else 0)
3157 ("for" "for" cperl-electric-keyword 0)
3158 ("foreach" "foreach" cperl-electric-keyword 0)
3159 ("formy" "formy" cperl-electric-keyword 0)
3160 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
3161 ("do" "do" cperl-electric-keyword 0)
3162 ("=pod" "=pod" cperl-electric-pod 0)
3163 ("=over" "=over" cperl-electric-pod 0)
3164 ("=head1" "=head1" cperl-electric-pod 0)
3165 ("=head2" "=head2" cperl-electric-pod 0)
3166 ("pod" "pod" cperl-electric-pod 0)
3167 ("over" "over" cperl-electric-pod 0)
3168 ("head1" "head1" cperl-electric-pod 0)
3169 ("head2" "head2" cperl-electric-pod 0)))
3170 (setq abbrevs-changed prev-a-c)))
3171 (setq local-abbrev-table cperl-mode-abbrev-table)
3172 (if (cperl-val 'cperl-electric-keywords)
3174 (set-syntax-table cperl-mode-syntax-table)
3175 ;; Until Emacs is multi-threaded, we do not actually need it local:
3176 (make-local-variable 'cperl-font-lock-multiline-start)
3177 (make-local-variable 'cperl-font-locking)
3178 (make-local-variable 'outline-regexp)
3179 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
3180 (setq outline-regexp cperl-outline-regexp)
3181 (make-local-variable 'outline-level)
3182 (setq outline-level 'cperl-outline-level)
3183 (make-local-variable 'paragraph-start)
3184 (setq paragraph-start (concat "^$\\|" page-delimiter))
3185 (make-local-variable 'paragraph-separate)
3186 (setq paragraph-separate paragraph-start)
3187 (make-local-variable 'paragraph-ignore-fill-prefix)
3188 (setq paragraph-ignore-fill-prefix t)
3191 (make-local-variable 'paren-backwards-message)
3192 (set 'paren-backwards-message t)))
3193 (make-local-variable 'indent-line-function)
3194 (setq indent-line-function 'cperl-indent-line)
3195 (make-local-variable 'require-final-newline)
3196 (setq require-final-newline t)
3197 (make-local-variable 'comment-start)
3198 (setq comment-start "# ")
3199 (make-local-variable 'comment-end)
3200 (setq comment-end "")
3201 (make-local-variable 'comment-column)
3202 (setq comment-column cperl-comment-column)
3203 (make-local-variable 'comment-start-skip)
3204 (setq comment-start-skip "#+ *")
3205 (make-local-variable 'defun-prompt-regexp)
3207 ;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
3208 ;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
3209 (setq defun-prompt-regexp
3211 (cperl-after-sub-regexp 'named 'attr-groups)
3212 cperl-maybe-white-and-comment-rex))
3213 (make-local-variable 'comment-indent-function)
3214 (setq comment-indent-function 'cperl-comment-indent)
3215 (and (boundp 'fill-paragraph-function)
3217 (make-local-variable 'fill-paragraph-function)
3218 (set 'fill-paragraph-function 'cperl-fill-paragraph)))
3219 (make-local-variable 'parse-sexp-ignore-comments)
3220 (setq parse-sexp-ignore-comments t)
3221 (make-local-variable 'indent-region-function)
3222 (setq indent-region-function 'cperl-indent-region)
3223 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
3224 (make-local-variable 'imenu-create-index-function)
3225 (setq imenu-create-index-function
3226 (function cperl-imenu--create-perl-index))
3227 (make-local-variable 'imenu-sort-function)
3228 (setq imenu-sort-function nil)
3229 (make-local-variable 'vc-rcs-header)
3230 (set 'vc-rcs-header cperl-vc-rcs-header)
3231 (make-local-variable 'vc-sccs-header)
3232 (set 'vc-sccs-header cperl-vc-sccs-header)
3233 ;; This one is obsolete...
3234 (make-local-variable 'vc-header-alist)
3235 (set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
3236 (` ((SCCS (, (car cperl-vc-sccs-header)))
3237 (RCS (, (car cperl-vc-rcs-header)))))))
3238 (cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
3239 (make-local-variable 'compilation-error-regexp-alist-alist)
3240 (set 'compilation-error-regexp-alist-alist
3241 (cons (cons 'cperl cperl-compilation-error-regexp-alist)
3242 (symbol-value 'compilation-error-regexp-alist-alist)))
3243 (let ((f 'compilation-build-compilation-error-regexp-alist))
3245 ((boundp 'compilation-error-regexp-alist);; xmeacs 19.x
3246 (make-local-variable 'compilation-error-regexp-alist)
3247 (set 'compilation-error-regexp-alist
3248 (cons cperl-compilation-error-regexp-alist
3249 (symbol-value 'compilation-error-regexp-alist)))))
3250 (make-local-variable 'font-lock-defaults)
3251 (setq font-lock-defaults
3253 ((string< emacs-version "19.30")
3254 '(perl-font-lock-keywords-2 nil nil ((?_ . "w"))))
3255 ((string< emacs-version "19.33") ; Which one to use?
3256 '((perl-font-lock-keywords
3257 perl-font-lock-keywords-1
3258 perl-font-lock-keywords-2) nil nil ((?_ . "w"))))
3260 '((cperl-load-font-lock-keywords
3261 cperl-load-font-lock-keywords-1
3262 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
3263 (make-local-variable 'cperl-syntax-state)
3264 (setq cperl-syntax-state nil) ; reset syntaxification cache
3265 (if cperl-use-syntax-table-text-property
3267 (make-local-variable 'parse-sexp-lookup-properties)
3268 ;; Do not introduce variable if not needed, we check it!
3269 (set 'parse-sexp-lookup-properties t)
3270 ;; Fix broken font-lock:
3271 (or (boundp 'font-lock-unfontify-region-function)
3272 (set 'font-lock-unfontify-region-function
3273 'font-lock-default-unfontify-region))
3274 (unless cperl-xemacs-p ; Our: just a plug for wrong font-lock
3275 (make-local-variable 'font-lock-unfontify-region-function)
3276 (set 'font-lock-unfontify-region-function ; not present with old Emacs
3277 'cperl-font-lock-unfontify-region-function))
3278 (make-local-variable 'cperl-syntax-done-to)
3279 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
3280 ;; Another bug: unless font-lock-syntactic-keywords, font-lock
3281 ;; ignores syntax-table text-property. (t) is a hack
3282 ;; to make font-lock think that font-lock-syntactic-keywords
3284 (make-local-variable 'font-lock-syntactic-keywords)
3285 (setq font-lock-syntactic-keywords
3286 (if cperl-syntaxify-by-font-lock
3287 '(t (cperl-fontify-syntaxically))
3289 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
3291 (setq cperl-font-lock-multiline t) ; Not localized...
3292 (set 'font-lock-multiline t)) ; not present with old Emacs; auto-local
3293 (make-local-variable 'font-lock-fontify-region-function)
3294 (set 'font-lock-fontify-region-function ; not present with old Emacs
3295 'cperl-font-lock-fontify-region-function))
3296 (make-local-variable 'font-lock-fontify-region-function)
3297 (set 'font-lock-fontify-region-function ; not present with old Emacs
3298 'cperl-font-lock-fontify-region-function)
3299 (make-local-variable 'cperl-old-style)
3300 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
3301 (set (make-local-variable 'normal-auto-fill-function)
3302 'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
3303 (or (fboundp 'cperl-old-auto-fill-mode)
3305 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
3306 (defun auto-fill-mode (&optional arg)
3308 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
3309 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
3310 (setq auto-fill-function 'cperl-do-auto-fill))))))
3311 (if (cperl-enable-font-lock)
3312 (if (cperl-val 'cperl-font-lock)
3313 (progn (or cperl-faces-init (cperl-init-faces))
3314 (font-lock-mode 1))))
3315 (set (make-local-variable 'facemenu-add-face-function)
3316 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
3317 (and (boundp 'msb-menu-cond)
3318 (not cperl-msb-fixed)
3320 (if (featurep 'easymenu)
3321 (easy-menu-add cperl-menu)) ; A NOP in RMS Emacs.
3322 (run-hooks 'cperl-mode-hook)
3323 (if cperl-hook-after-change
3325 (make-local-hook 'after-change-functions)
3326 (add-hook 'after-change-functions 'cperl-after-change-function nil t)))
3327 ;; After hooks since fontification will break this
3328 (if cperl-pod-here-scan
3329 (or cperl-syntaxify-by-font-lock
3330 (progn (or cperl-faces-init (cperl-init-faces-weak))
3331 (cperl-find-pods-heres)))))
3333 ;; Fix for perldb - make default reasonable
3337 (perldb (read-from-minibuffer "Run perldb (like this): "
3338 (if (consp gud-perldb-history)
3339 (car gud-perldb-history)
3340 (concat "perl " ;;(file-name-nondirectory
3344 (buffer-file-name)))
3346 '(gud-perldb-history . 1))))
3348 (defun cperl-msb-fix ()
3349 ;; Adds perl files to msb menu, supposes that msb is already loaded
3350 (setq cperl-msb-fixed t)
3351 (let* ((l (length msb-menu-cond))
3352 (last (nth (1- l) msb-menu-cond))
3353 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
3354 (handle (1- (nth 1 last))))
3355 (setcdr precdr (list
3357 '(memq major-mode '(cperl-mode perl-mode))
3362 ;; This is used by indent-for-comment
3363 ;; to decide how much to indent a comment in CPerl code
3364 ;; based on its context. Do fallback if comment is found wrong.
3366 (defvar cperl-wrong-comment)
3367 (defvar cperl-st-cfence '(14)) ; Comment-fence
3368 (defvar cperl-st-sfence '(15)) ; String-fence
3369 (defvar cperl-st-punct '(1))
3370 (defvar cperl-st-word '(2))
3371 (defvar cperl-st-bra '(4 . ?\>))
3372 (defvar cperl-st-ket '(5 . ?\<))
3375 (defun cperl-comment-indent ()
3376 (let ((p (point)) (c (current-column)) was phony)
3377 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
3378 ;; Wrong comment found
3380 (setq was (cperl-to-comment-or-eol)
3381 phony (eq (get-text-property (point) 'syntax-table)
3385 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
3386 (if (eq (preceding-char) ?\#)
3391 (skip-chars-backward " \t")
3392 (max (1+ (current-column)) ; Else indent at comment column
3395 (insert comment-start)
3396 (backward-char (length comment-start)))
3397 (setq cperl-wrong-comment t)
3398 (cperl-make-indent comment-column 1 'keep) ; Indent minimum 1
3399 c))))) ; except leave at least one space.
3401 ;;;(defun cperl-comment-indent-fallback ()
3402 ;;; "Is called if the standard comment-search procedure fails.
3403 ;;;Point is at start of real comment."
3404 ;;; (let ((c (current-column)) target cnt prevc)
3405 ;;; (if (= c comment-column) nil
3406 ;;; (setq cnt (skip-chars-backward "[ \t]"))
3407 ;;; (setq target (max (1+ (setq prevc
3408 ;;; (current-column))) ; Else indent at comment column
3409 ;;; comment-column))
3410 ;;; (if (= c comment-column) nil
3411 ;;; (delete-backward-char cnt)
3412 ;;; (while (< prevc target)
3414 ;;; (setq prevc (current-column)))
3415 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
3416 ;;; (while (< prevc target)
3418 ;;; (setq prevc (current-column)))))))
3420 (defun cperl-indent-for-comment ()
3421 "Substitute for `indent-for-comment' in CPerl."
3423 (let (cperl-wrong-comment)
3424 (indent-for-comment)
3425 (if cperl-wrong-comment ; set by `cperl-comment-indent'
3426 (progn (cperl-to-comment-or-eol)
3427 (forward-char (length comment-start))))))
3429 (defun cperl-comment-region (b e arg)
3430 "Comment or uncomment each line in the region in CPerl mode.
3431 See `comment-region'."
3432 (interactive "r\np")
3433 (let ((comment-start "#"))
3434 (comment-region b e arg)))
3436 (defun cperl-uncomment-region (b e arg)
3437 "Uncomment or comment each line in the region in CPerl mode.
3438 See `comment-region'."
3439 (interactive "r\np")
3440 (let ((comment-start "#"))
3441 (comment-region b e (- arg))))
3443 (defvar cperl-brace-recursing nil)
3445 (defun cperl-electric-brace (arg &optional only-before)
3446 "Insert character and correct line's indentation.
3447 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
3448 place (even in empty line), but not after. If after \")\" and the inserted
3449 char is \"{\", insert extra newline before only if
3450 `cperl-extra-newline-before-brace'."
3453 (other-end (if (and cperl-electric-parens-mark
3459 (not cperl-brace-recursing)
3460 (cperl-val 'cperl-electric-parens)
3461 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
3462 ;; Need to insert a matching pair
3465 (setq insertpos (point-marker))
3466 (goto-char other-end)
3467 (setq last-command-char ?\{)
3468 (cperl-electric-lbrace arg insertpos))
3470 ;; Check whether we close something "usual" with `}'
3471 (if (and (eq last-command-char ?\})
3475 (up-list (- (prefix-numeric-value arg)))
3476 ;;(cperl-after-block-p (point-min))
3477 (or (cperl-after-expr-p nil "{;)")
3478 ;; after sub, else, continue
3479 (cperl-after-block-p nil 'pre)))
3481 ;; Just insert the guy
3482 (self-insert-command (prefix-numeric-value arg))
3483 (if (and (not arg) ; No args, end (of empty line or auto)
3485 (or (and (null only-before)
3487 (skip-chars-backward " \t")
3489 (and (eq last-command-char ?\{) ; Do not insert newline
3490 ;; if after ")" and `cperl-extra-newline-before-brace'
3491 ;; is nil, do not insert extra newline.
3492 (not cperl-extra-newline-before-brace)
3494 (skip-chars-backward " \t")
3495 (eq (preceding-char) ?\))))
3496 (if cperl-auto-newline
3497 (progn (cperl-indent-line) (newline) t) nil)))
3499 (self-insert-command (prefix-numeric-value arg))
3501 (if cperl-auto-newline
3502 (setq insertpos (1- (point))))
3503 (if (and cperl-auto-newline (null only-before))
3506 (cperl-indent-line)))
3508 (if insertpos (progn (goto-char insertpos)
3509 (search-forward (make-string
3510 1 last-command-char))
3511 (setq insertpos (1- (point)))))
3515 (goto-char insertpos)
3516 (self-insert-command (prefix-numeric-value arg)))
3517 (self-insert-command (prefix-numeric-value arg)))))))
3519 (defun cperl-electric-lbrace (arg &optional end)
3520 "Insert character, correct line's indentation, correct quoting by space."
3522 (let ((cperl-brace-recursing t)
3523 (cperl-auto-newline cperl-auto-newline)
3525 (if (and cperl-electric-parens-mark
3533 (and (cperl-val 'cperl-electric-lbrace-space)
3534 (eq (preceding-char) ?$)
3536 (skip-chars-backward "$")
3537 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
3539 ;; Check whether we are in comment
3543 (not (looking-at "[ \t]*#")))
3544 (cperl-after-expr-p nil "{;)"))
3546 (setq cperl-auto-newline nil))
3547 (cperl-electric-brace arg)
3548 (and (cperl-val 'cperl-electric-parens)
3549 (eq last-command-char ?{)
3550 (memq last-command-char
3551 (append cperl-electric-parens-string nil))
3552 (or (if other-end (goto-char (marker-position other-end)))
3554 (setq last-command-char ?} pos (point))
3555 (progn (cperl-electric-brace arg t)
3558 (defun cperl-electric-paren (arg)
3559 "Insert an opening parenthesis or a matching pair of parentheses.
3560 See `cperl-electric-parens'."
3562 (let ((beg (save-excursion (beginning-of-line) (point)))
3563 (other-end (if (and cperl-electric-parens-mark
3570 (if (and (cperl-val 'cperl-electric-parens)
3571 (memq last-command-char
3572 (append cperl-electric-parens-string nil))
3573 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
3574 ;;(not (save-excursion (search-backward "#" beg t)))
3575 (if (eq last-command-char ?<)
3577 (and abbrev-mode ; later it is too late, may be after `for'
3579 (cperl-after-expr-p nil "{;(,:="))
3582 (self-insert-command (prefix-numeric-value arg))
3583 (if other-end (goto-char (marker-position other-end)))
3584 (insert (make-string
3585 (prefix-numeric-value arg)
3586 (cdr (assoc last-command-char '((?{ .?})
3590 (forward-char (- (prefix-numeric-value arg))))
3591 (self-insert-command (prefix-numeric-value arg)))))
3593 (defun cperl-electric-rparen (arg)
3594 "Insert a matching pair of parentheses if marking is active.
3595 If not, or if we are not at the end of marking range, would self-insert.
3596 Affected by `cperl-electric-parens'."
3598 (let ((beg (save-excursion (beginning-of-line) (point)))
3599 (other-end (if (and cperl-electric-parens-mark
3600 (cperl-val 'cperl-electric-parens)
3601 (memq last-command-char
3602 (append cperl-electric-parens-string nil))
3609 (cperl-val 'cperl-electric-parens)
3610 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
3611 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
3612 ;;(not (save-excursion (search-backward "#" beg t)))
3615 (self-insert-command (prefix-numeric-value arg))
3617 (if other-end (goto-char other-end))
3618 (insert (make-string
3619 (prefix-numeric-value arg)
3620 (cdr (assoc last-command-char '((?\} . ?\{)
3625 (self-insert-command (prefix-numeric-value arg)))))
3627 (defun cperl-electric-keyword ()
3628 "Insert a construction appropriate after a keyword.
3629 Help message may be switched off by setting `cperl-message-electric-keyword'
3631 (let ((beg (save-excursion (beginning-of-line) (point)))
3632 (dollar (and (eq last-command-char ?$)
3633 (eq this-command 'self-insert-command)))
3634 (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3635 (memq this-command '(self-insert-command newline))))
3637 (and (save-excursion
3641 (setq do (looking-at "do\\>")))
3643 (cperl-after-expr-p nil "{;:"))
3647 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
3649 (save-excursion (or (not (re-search-backward "^=" nil t))
3652 (and cperl-use-syntax-table-text-property
3653 (not (eq (get-text-property (point)
3656 (save-excursion (forward-sexp -1)
3657 (not (memq (following-char) (append "$@%&*" nil))))
3659 (and (eq (preceding-char) ?y)
3660 (progn ; "foreachmy"
3666 (memq this-command '(self-insert-command newline)))))
3667 (and dollar (insert " $"))
3669 ;;(insert " () {\n}")
3671 (cperl-extra-newline-before-brace
3672 (insert (if do "\n" " ()\n"))
3678 (and do (insert " while ();")))
3680 (insert (if do " {\n} while ();" " () {\n}"))))
3681 (or (looking-at "[ \t]\\|$") (insert " "))
3683 (if dollar (progn (search-backward "$")
3687 (search-backward ")")
3688 (if (eq last-command-char ?\()
3689 (progn ; Avoid "if (())"
3690 (delete-backward-char 1)
3691 (delete-backward-char -1))))
3693 (cperl-putback-char cperl-del-back-ch))
3694 (if cperl-message-electric-keyword
3695 (message "Precede char by C-q to avoid expansion"))))))
3697 (defun cperl-ensure-newlines (n &optional pos)
3698 "Make sure there are N newlines after the point."
3699 (or pos (setq pos (point)))
3700 (if (looking-at "\n")
3704 (cperl-ensure-newlines (1- n) pos)
3707 (defun cperl-electric-pod ()
3708 "Insert a POD chunk appropriate after a =POD directive."
3709 (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3710 (memq this-command '(self-insert-command newline))))
3711 head1 notlast name p really-delete over)
3712 (and (save-excursion
3715 (eq (preceding-char) ?=)
3717 (setq head1 (looking-at "head1\\>[ \t]*$"))
3718 (setq over (and (looking-at "over\\>[ \t]*$")
3719 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
3723 (get-text-property (point) 'in-pod)
3724 (cperl-after-expr-p nil "{;:")
3725 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
3726 (not (looking-at "\n*=cut"))
3727 (or (not cperl-use-syntax-table-text-property)
3728 (eq (get-text-property (point) 'syntax-type) 'pod))))))
3731 (setq notlast (re-search-forward "^\n=" nil t)))
3735 (cperl-ensure-newlines 2)
3741 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
3742 nil t)))) ; Only one
3745 (setq name (file-name-sans-extension
3746 (file-name-nondirectory (buffer-file-name)))
3748 (insert " NAME\n\n" name
3749 " - \n\n=head1 SYNOPSIS\n\n\n\n"
3750 "=head1 DESCRIPTION")
3751 (cperl-ensure-newlines 4)
3755 (setq really-delete t))
3760 (insert "\n\n=item \n\n\n\n"
3762 (cperl-ensure-newlines 2)
3766 (setq really-delete t)))
3767 (if (and delete really-delete)
3768 (cperl-putback-char cperl-del-back-ch))))))
3770 (defun cperl-electric-else ()
3771 "Insert a construction appropriate after a keyword.
3772 Help message may be switched off by setting `cperl-message-electric-keyword'
3774 (let ((beg (save-excursion (beginning-of-line) (point))))
3775 (and (save-excursion
3777 (cperl-after-expr-p nil "{;:"))
3781 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
3783 (save-excursion (or (not (re-search-backward "^=" nil t))
3785 (and cperl-use-syntax-table-text-property
3786 (not (eq (get-text-property (point)
3791 ;;(insert " {\n\n}")
3793 (cperl-extra-newline-before-brace
3799 (insert " {\n\n}")))
3800 (or (looking-at "[ \t]\\|$") (insert " "))
3804 (cperl-putback-char cperl-del-back-ch)
3805 (setq this-command 'cperl-electric-else)
3806 (if cperl-message-electric-keyword
3807 (message "Precede char by C-q to avoid expansion"))))))
3809 (defun cperl-linefeed ()
3810 "Go to end of line, open a new line and indent appropriately.
3811 If in POD, insert appropriate lines."
3813 (let ((beg (save-excursion (beginning-of-line) (point)))
3814 (end (save-excursion (end-of-line) (point)))
3815 (pos (point)) start over cut res)
3816 (if (and ; Check if we need to split:
3817 ; i.e., on a boundary and inside "{...}"
3818 (save-excursion (cperl-to-comment-or-eol)
3819 (>= (point) pos)) ; Not in a comment
3821 (skip-chars-backward " \t" beg)
3823 (looking-at "[;{]")) ; After { or ; + spaces
3824 (looking-at "[ \t]*}") ; Before }
3825 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
3828 (eq (car (parse-partial-sexp pos end -1)) -1)
3829 ; Leave the level of parens
3830 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
3832 (cperl-after-block-p (point-min))
3835 (setq start (point-marker))
3836 (<= start pos))))) ; Redundant? Are after the
3837 ; start of parens group.
3839 (skip-chars-backward " \t")
3840 (or (memq (preceding-char) (append ";{" nil))
3846 (or (looking-at "{[ \t]*$") ; If there is a statement
3847 ; before, move it to separate line
3851 (cperl-indent-line)))
3852 (forward-line 1) ; We are on the target line
3855 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
3856 ; after, move it to separate line
3859 (search-backward "}" beg)
3860 (skip-chars-backward " \t")
3861 (or (memq (preceding-char) (append ";{" nil))
3866 (forward-line -1) ; We are on the line before target
3868 (newline-and-indent))
3869 (end-of-line) ; else - no splitting
3871 ((and (looking-at "\n[ \t]*{$")
3873 (skip-chars-backward " \t")
3874 (eq (preceding-char) ?\)))) ; Probably if () {} group
3875 ; with an extra newline.
3877 (cperl-indent-line))
3878 ((save-excursion ; In POD header
3879 (forward-paragraph -1)
3880 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
3881 ;; We are after \n now, so look for the rest
3882 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
3884 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
3885 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
3889 (forward-paragraph -1)
3892 (setq cut (buffer-substring (point)
3896 (delete-char (- (save-excursion (end-of-line) (point))
3898 (setq res (expand-abbrev))
3904 (cperl-ensure-newlines (if cut 2 4))
3906 ((get-text-property (point) 'in-pod) ; In POD section
3907 (cperl-ensure-newlines 4)
3909 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
3911 (cperl-indent-line))
3913 (newline-and-indent))))))
3915 (defun cperl-electric-semi (arg)
3916 "Insert character and correct line's indentation."
3918 (if cperl-auto-newline
3919 (cperl-electric-terminator arg)
3920 (self-insert-command (prefix-numeric-value arg))
3921 (if cperl-autoindent-on-semi
3922 (cperl-indent-line))))
3924 (defun cperl-electric-terminator (arg)
3925 "Insert character and correct line's indentation."
3928 (auto (and cperl-auto-newline
3929 (or (not (eq last-command-char ?:))
3930 cperl-auto-newline-after-colon)))
3932 (if (and ;;(not arg)
3934 (not (save-excursion
3936 (skip-chars-forward " \t")
3938 ;; Ignore in comment lines
3939 (= (following-char) ?#)
3940 ;; Colon is special only after a label
3941 ;; So quickly rule out most other uses of colon
3942 ;; and do no indentation for them.
3943 (and (eq last-command-char ?:)
3946 (skip-chars-forward " \t")
3947 (and (< (point) end)
3948 (progn (goto-char (- end 1))
3949 (not (looking-at ":"))))))
3951 (beginning-of-defun)
3952 (let ((pps (parse-partial-sexp (point) end)))
3953 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
3955 (self-insert-command (prefix-numeric-value arg))
3957 (if auto (setq insertpos (point-marker)))
3963 (cperl-indent-line)))
3965 (if insertpos (goto-char (1- (marker-position insertpos)))
3970 (goto-char insertpos)
3971 (self-insert-command (prefix-numeric-value arg)))
3972 (self-insert-command (prefix-numeric-value arg)))))
3974 (defun cperl-electric-backspace (arg)
3975 "Backspace, or remove the whitespace around the point inserted by an electric
3976 key. Will untabivy if `cperl-electric-backspace-untabify' is non-nil."
3978 (if (and cperl-auto-newline
3979 (memq last-command '(cperl-electric-semi
3980 cperl-electric-terminator
3981 cperl-electric-lbrace))
3982 (memq (preceding-char) '(?\ ?\t ?\n)))
3984 (if (eq last-command 'cperl-electric-lbrace)
3985 (skip-chars-forward " \t\n"))
3987 (skip-chars-backward " \t\n")
3988 (delete-region (point) p))
3989 (and (eq last-command 'cperl-electric-else)
3990 ;; We are removing the whitespace *inside* cperl-electric-else
3991 (setq this-command 'cperl-electric-else-really))
3992 (if (and cperl-auto-newline
3993 (eq last-command 'cperl-electric-else-really)
3994 (memq (preceding-char) '(?\ ?\t ?\n)))
3996 (skip-chars-forward " \t\n")
3998 (skip-chars-backward " \t\n")
3999 (delete-region (point) p))
4000 (if cperl-electric-backspace-untabify
4001 (backward-delete-char-untabify arg)
4002 (delete-backward-char arg)))))
4004 (defun cperl-inside-parens-p () ;; NOT USED????
4008 (narrow-to-region (point)
4009 (progn (beginning-of-defun) (point)))
4010 (goto-char (point-max))
4011 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
4014 (defun cperl-indent-command (&optional whole-exp)
4015 "Indent current line as Perl code, or in some cases insert a tab character.
4016 If `cperl-tab-always-indent' is non-nil (the default), always indent current
4017 line. Otherwise, indent the current line only if point is at the left margin
4018 or in the line's indentation; otherwise insert a tab.
4020 A numeric argument, regardless of its value,
4021 means indent rigidly all the lines of the expression starting after point
4022 so that this line becomes properly indented.
4023 The relative indentation among the lines of the expression are preserved."
4025 (cperl-update-syntaxification (point) (point))
4027 ;; If arg, always indent this line as Perl
4028 ;; and shift remaining lines of expression the same amount.
4029 (let ((shift-amt (cperl-indent-line))
4032 (if cperl-tab-always-indent
4033 (beginning-of-line))
4040 (if (and shift-amt (> end beg))
4041 (indent-code-rigidly beg end shift-amt "#")))
4042 (if (and (not cperl-tab-always-indent)
4044 (skip-chars-backward " \t")
4047 (cperl-indent-line))))
4049 (defun cperl-indent-line (&optional parse-data)
4050 "Indent current line as Perl code.
4051 Return the amount the indentation changed by."
4052 (let ((case-fold-search nil)
4053 (pos (- (point-max) (point)))
4054 indent i beg shift-amt)
4055 (setq indent (cperl-calculate-indent parse-data)
4059 (cond ((or (eq indent nil) (eq indent t))
4060 (setq indent (current-indentation) i nil))
4061 ;;((eq indent t) ; Never?
4062 ;; (setq indent (cperl-calculate-indent-within-comment)))
4063 ;;((looking-at "[ \t]*#")
4066 (skip-chars-forward " \t")
4067 (if (listp indent) (setq indent (car indent)))
4068 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
4070 (setq indent (max cperl-min-label-indent
4071 (+ indent cperl-label-offset)))))
4072 ((= (following-char) ?})
4073 (setq indent (- indent cperl-indent-level)))
4074 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
4075 (setq indent (+ indent cperl-close-paren-offset)))
4076 ((= (following-char) ?{)
4077 (setq indent (+ indent cperl-brace-offset))))))
4078 (skip-chars-forward " \t")
4079 (setq shift-amt (and i (- indent (current-column))))
4080 (if (or (not shift-amt)
4082 (if (> (- (point-max) pos) (point))
4083 (goto-char (- (point-max) pos)))
4084 ;;;(delete-region beg (point))
4085 ;;;(indent-to indent)
4086 (cperl-make-indent indent)
4087 ;; If initial point was within line's indentation,
4088 ;; position after the indentation. Else stay at same point in text.
4089 (if (> (- (point-max) pos) (point))
4090 (goto-char (- (point-max) pos))))
4093 (defun cperl-after-label ()
4094 ;; Returns true if the point is after label. Does not do save-excursion.
4095 (and (eq (preceding-char) ?:)
4096 (memq (char-syntax (char-after (- (point) 2)))
4100 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
4102 (defun cperl-get-state (&optional parse-start start-state)
4103 ;; returns list (START STATE DEPTH PRESTART),
4104 ;; START is a good place to start parsing, or equal to
4105 ;; PARSE-START if preset,
4106 ;; STATE is what is returned by `parse-partial-sexp'.
4107 ;; DEPTH is true is we are immediately after end of block
4108 ;; which contains START.
4109 ;; PRESTART is the position basing on which START was found.
4111 (let ((start-point (point)) depth state start prestart)
4112 (if (and parse-start
4113 (<= parse-start start-point))
4114 (goto-char parse-start)
4115 (beginning-of-defun)
4116 (setq start-state nil))
4117 (setq prestart (point))
4119 ;; Try to go out, if sub is not on the outermost level
4120 (while (< (point) start-point)
4121 (setq start (point) parse-start start depth nil
4122 state (parse-partial-sexp start start-point -1))
4123 (if (> (car state) -1) nil
4124 ;; The current line could start like }}}, so the indentation
4125 ;; corresponds to a different level than what we reached
4127 (beginning-of-line 2))) ; Go to the next line.
4128 (if start (goto-char start))) ; Not at the start of file
4129 (setq start (point))
4130 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
4131 (list start state depth prestart))))
4133 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
4135 (defun cperl-beginning-of-property (p prop &optional lim)
4136 "Given that P has a property PROP, find where the property starts.
4137 Will not look before LIM."
4138 ;;; XXXX What to do at point-max???
4139 (or (previous-single-property-change (cperl-1+ p) prop lim)
4141 ;;; (cond ((eq p (point-min))
4143 ;;; ((and lim (<= p lim))
4145 ;;; ((not (get-text-property (1- p) prop))
4147 ;;; (t (or (previous-single-property-change p look-prop lim)
4151 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
4152 "Return appropriate indentation for current line as Perl code.
4153 In usual case returns an integer: the column to indent to.
4154 Returns nil if line starts inside a string, t if in a comment.
4156 Will not correct the indentation for labels, but will correct it for braces
4157 and closing parentheses and brackets."
4158 (cperl-update-syntaxification (point) (point))
4161 (and (memq (get-text-property (point) 'syntax-type)
4162 '(pod here-doc here-doc-delim format))
4163 (not (get-text-property (point) 'indentable)))
4164 ;; before start of POD - whitespace found since do not have 'pod!
4165 (and (looking-at "[ \t]*\n=")
4166 (error "Spaces before POD section!"))
4167 (and (not cperl-indent-left-aligned-comments)
4171 (let* ((indent-point (point))
4172 (char-after-pos (save-excursion
4173 (skip-chars-forward " \t")
4175 (char-after (char-after char-after-pos))
4176 (in-pod (get-text-property (point) 'in-pod))
4177 (pre-indent-point (point))
4178 p prop look-prop is-block delim)
4181 ;; In the verbatim part, probably code example. What to do???
4186 (cperl-backward-to-noncomment nil)
4187 (setq p (max (point-min) (1- (point)))
4188 prop (get-text-property p 'syntax-type)
4189 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
4191 (if (memq prop '(pod here-doc format here-doc-delim))
4193 (goto-char (cperl-beginning-of-property p look-prop))
4195 (setq pre-indent-point (point)))))))
4196 (goto-char pre-indent-point)
4197 (let* ((case-fold-search nil)
4198 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
4199 (start (or (nth 2 parse-data)
4202 (containing-sexp (car (cdr state)))
4205 ;;containing-sexp ;; We are buggy at toplevel :-(
4208 (setcar parse-data pre-indent-point)
4209 (setcar (cdr parse-data) state)
4210 (or (nth 2 parse-data)
4211 (setcar (cddr parse-data) start))
4212 ;; Before this point: end of statement
4213 (setq old-indent (nth 3 parse-data))))
4214 (cond ((get-text-property (point) 'indentable)
4215 ;; indent to "after" the surrounding open
4216 ;; (same offset as `cperl-beautify-regexp-piece'),
4217 ;; skip blanks if we do not close the expression.
4218 (setq delim ; We do not close the expression
4220 (cperl-1+ char-after-pos) 'indentable)
4221 p (1+ (cperl-beginning-of-property
4222 (point) 'indentable))
4223 is-block ; misused for: preceeding line in REx
4224 (save-excursion ; Find preceeding line
4225 (cperl-backward-to-noncomment p)
4228 (progn ; get indent from the first line
4230 (skip-chars-forward " \t")
4231 (if (memq (char-after (point))
4233 nil ; Can't use intentation of this line...
4235 (skip-chars-forward " \t")
4237 prop (parse-partial-sexp p char-after-pos))
4239 (goto-char p) ; beginning of REx etc
4240 (1- (current-column))) ; End the REx, ignore is-block
4242 ;; Indent as the level after closing parens
4243 (goto-char char-after-pos)
4244 (skip-chars-forward " \t)")
4245 (setq char-after-pos (point))
4246 (goto-char is-block)
4247 (skip-chars-forward " \t)")
4248 (setq p (parse-partial-sexp (point) char-after-pos))
4249 (goto-char is-block)
4251 (or cperl-regexp-indent-step cperl-indent-level))
4252 (cond ((eq char-after ?\) )
4253 (- cperl-close-paren-offset)) ; compensate
4254 ((eq char-after ?\| )
4255 (- (or cperl-regexp-indent-step cperl-indent-level)))
4257 (if (eq (following-char) ?\| )
4258 (or cperl-regexp-indent-step cperl-indent-level)
4261 ;; Now we have no preceeding line...
4264 (+ (or cperl-regexp-indent-step cperl-indent-level)
4266 (current-column)))))
4267 ((get-text-property char-after-pos 'REx-part2)
4268 (condition-case nil ; Use indentation of the 1st part
4271 ((or (nth 3 state) (nth 4 state))
4272 ;; return nil or t if should not change this line
4274 ;; XXXX Do we need to special-case this?
4275 ((null containing-sexp)
4276 ;; Line is at top level. May be data or function definition,
4277 ;; or may be function argument declaration.
4278 ;; Indent like the previous top level line
4279 ;; unless that ends in a closeparen without semicolon,
4280 ;; in which case this line is the first argument decl.
4281 (skip-chars-forward " \t")
4284 (- (current-indentation)
4285 (if (nth 2 s-s) cperl-indent-level 0)))
4286 (if (eq char-after ?{) cperl-continued-brace-offset 0)
4288 (cperl-backward-to-noncomment (or old-indent (point-min)))
4289 ;; Look at previous line that's at column 0
4290 ;; to determine whether we are in top-level decls
4291 ;; or function's arg decls. Set basic-indent accordingly.
4292 ;; Now add a little if this is a continuation line.
4294 (eq (point) old-indent) ; old-indent was at comment
4295 (eq (preceding-char) ?\;)
4297 (and (eq (preceding-char) ?\})
4298 (cperl-after-block-and-statement-beg
4299 (point-min))) ; Was start - too close
4300 (memq char-after (append ")]}" nil))
4301 (and (eq (preceding-char) ?\:) ; label
4304 (skip-chars-backward " \t")
4305 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
4306 (get-text-property (point) 'first-format-line))
4309 (not (eq char-after ?\C-j)))
4310 (setcdr (cddr parse-data)
4311 (list pre-indent-point)))
4313 cperl-continued-statement-offset))))
4316 (and (setq delim (= (char-after containing-sexp) ?{))
4317 (save-excursion ; Is it a hash?
4318 (goto-char containing-sexp)
4320 cperl-indent-parens-as-block))
4321 ;; group is an expression, not a block:
4322 ;; indent to just after the surrounding open parens,
4323 ;; skip blanks if we do not close the expression.
4324 (goto-char (1+ containing-sexp))
4325 (or (memq char-after
4326 (append (if delim "}" ")]}") nil))
4327 (looking-at "[ \t]*\\(#\\|$\\)")
4328 (skip-chars-forward " \t"))
4331 (eq char-after ?\}))
4332 ;; Correct indentation of trailing ?\}
4333 (+ cperl-indent-level cperl-close-paren-offset)
4335 ;;; ((and (/= (char-after containing-sexp) ?{)
4336 ;;; (not cperl-indent-parens-as-block))
4337 ;;; ;; line is expression, not statement:
4338 ;;; ;; indent to just after the surrounding open,
4339 ;;; ;; skip blanks if we do not close the expression.
4340 ;;; (goto-char (1+ containing-sexp))
4341 ;;; (or (memq char-after (append ")]}" nil))
4342 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
4343 ;;; (skip-chars-forward " \t"))
4344 ;;; (current-column))
4346 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
4347 ;;; (goto-char containing-sexp)
4348 ;;; (and (not (cperl-block-p))
4349 ;;; (not cperl-indent-parens-as-block)))
4350 ;;; (goto-char (1+ containing-sexp))
4351 ;;; (or (eq char-after ?\})
4352 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
4353 ;;; (skip-chars-forward " \t"))
4354 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
4355 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
4356 ;;; cperl-close-paren-offset)
4359 ;; Statement level. Is it a continuation or a new statement?
4360 ;; Find previous non-comment character.
4361 (goto-char pre-indent-point)
4362 (cperl-backward-to-noncomment containing-sexp)
4363 ;; Back up over label lines, since they don't
4364 ;; affect whether our line is a continuation.
4366 (while;;(or (eq (preceding-char) ?\,)
4367 (and (eq (preceding-char) ?:)
4368 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
4369 (memq (char-syntax (char-after (- (point) 2)))
4372 (if (eq (preceding-char) ?\,)
4373 ;; Will go to beginning of line, essentially.
4374 ;; Will ignore embedded sexpr XXXX.
4375 (cperl-backward-to-start-of-continued-exp containing-sexp))
4377 (cperl-backward-to-noncomment containing-sexp))
4378 ;; Now we get the answer.
4379 (if (not (or (eq (1- (point)) containing-sexp)
4380 (memq (preceding-char)
4381 (append (if is-block " ;{" " ,;{") '(nil)))
4382 (and (eq (preceding-char) ?\})
4383 (cperl-after-block-and-statement-beg
4385 (get-text-property (point) 'first-format-line)))
4386 ;; This line is continuation of preceding line's statement;
4387 ;; indent `cperl-continued-statement-offset' more than the
4388 ;; previous line of the statement.
4390 ;; There might be a label on this line, just
4391 ;; consider it bad style and ignore it.
4393 (cperl-backward-to-start-of-continued-exp containing-sexp)
4394 (+ (if (memq char-after (append "}])" nil))
4396 cperl-continued-statement-offset)
4399 (not (eq char-after ?\})))
4401 ;; Now it is a hash reference
4402 (+ cperl-indent-level cperl-close-paren-offset))
4403 ;; Labels do not take :: ...
4404 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
4405 (if (> (current-indentation) cperl-min-label-indent)
4406 (- (current-indentation) cperl-label-offset)
4407 ;; Do not move `parse-data', this should
4408 ;; be quick anyway (this comment comes
4409 ;; from different location):
4410 (cperl-calculate-indent))
4412 (if (eq char-after ?\{)
4413 cperl-continued-brace-offset 0)))
4414 ;; This line starts a new statement.
4415 ;; Position following last unclosed open.
4416 (goto-char containing-sexp)
4417 ;; Is line first statement after an open-brace?
4419 ;; If no, find that first statement and indent like
4420 ;; it. If the first statement begins with label, do
4421 ;; not believe when the indentation of the label is too
4425 (setq old-indent (current-indentation))
4426 (let ((colon-line-end 0))
4428 (progn (skip-chars-forward " \t\n")
4429 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
4430 ;; Skip over comments and labels following openbrace.
4431 (cond ((= (following-char) ?\#)
4433 ((= (following-char) ?\=)
4435 (or (next-single-property-change (point) 'in-pod)
4436 (point-max)))) ; do not loop if no syntaxification
4439 (save-excursion (end-of-line)
4440 (setq colon-line-end (point)))
4441 (search-forward ":"))))
4442 ;; The first following code counts
4443 ;; if it is before the line we want to indent.
4444 (and (< (point) indent-point)
4445 (if (> colon-line-end (point)) ; After label
4446 (if (> (current-indentation)
4447 cperl-min-label-indent)
4448 (- (current-indentation) cperl-label-offset)
4449 ;; Do not believe: `max' is involved
4450 (+ old-indent cperl-indent-level))
4451 (current-column)))))
4452 ;; If no previous statement,
4453 ;; indent it relative to line brace is on.
4454 ;; For open brace in column zero, don't let statement
4455 ;; start there too. If cperl-indent-level is zero,
4456 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
4457 ;; For open-braces not the first thing in a line,
4458 ;; add in cperl-brace-imaginary-offset.
4460 ;; If first thing on a line: ?????
4461 (+ (if (and (bolp) (zerop cperl-indent-level))
4462 (+ cperl-brace-offset cperl-continued-statement-offset)
4466 (not (eq char-after ?\})))
4468 ;; Now it is a hash reference
4469 (+ cperl-indent-level cperl-close-paren-offset))
4470 ;; Move back over whitespace before the openbrace.
4471 ;; If openbrace is not first nonwhite thing on the line,
4472 ;; add the cperl-brace-imaginary-offset.
4473 (progn (skip-chars-backward " \t")
4474 (if (bolp) 0 cperl-brace-imaginary-offset))
4475 ;; If the openbrace is preceded by a parenthesized exp,
4476 ;; move to the beginning of that;
4477 ;; possibly a different line
4479 (cperl-backward-to-noncomment (point-min))
4480 (if (eq (preceding-char) ?\))
4482 ;; In the case it starts a subroutine, indent with
4483 ;; respect to `sub', not with respect to the
4484 ;; first thing on the line, say in the case of
4485 ;; anonymous sub in a hash.
4487 ;;(skip-chars-backward " \t")
4488 (cperl-backward-to-noncomment (point-min))
4491 (and (get-text-property (point) 'attrib-group)
4493 (cperl-beginning-of-property
4494 (point) 'attrib-group)))
4495 (and (eq (preceding-char) ?b)
4498 (looking-at "sub\\>"))))
4502 (save-excursion (beginning-of-line) (point))
4504 (progn (goto-char (1+ old-indent))
4505 (skip-chars-forward " \t")
4507 ;; Get initial indentation of the line we are on.
4508 ;; If line starts with label, calculate label indentation
4511 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
4512 (if (> (current-indentation) cperl-min-label-indent)
4513 (- (current-indentation) cperl-label-offset)
4514 ;; Do not move `parse-data', this should
4516 (cperl-calculate-indent))
4517 (current-indentation))))))))))))))
4519 (defvar cperl-indent-alist
4523 (toplevel-after-parenth 2)
4524 (toplevel-continued 2)
4526 "Alist of indentation rules for CPerl mode.
4529 number: add this amount of indentation.
4531 Not finished, not used.")
4533 (defun cperl-where-am-i (&optional parse-start start-state)
4535 "Return a list of lists ((TYPE POS)...) of good points before the point.
4536 POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
4538 Not finished, not used."
4540 (let* ((start-point (point)) unused
4541 (s-s (cperl-get-state))
4544 (prestart (nth 3 s-s))
4545 (containing-sexp (car (cdr state)))
4546 (case-fold-search nil)
4547 (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
4548 (cond ((nth 3 state) ; In string
4549 (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
4550 ((nth 4 state) ; In comment
4551 (setq res (cons '(comment) res)))
4552 ((null containing-sexp)
4553 ;; Line is at top level.
4554 ;; Indent like the previous top level line
4555 ;; unless that ends in a closeparen without semicolon,
4556 ;; in which case this line is the first argument decl.
4557 (cperl-backward-to-noncomment (or parse-start (point-min)))
4558 ;;(skip-chars-backward " \t\f\n")
4561 (memq (preceding-char) (append ";}" nil)))
4562 (setq res (cons (list 'toplevel start) res)))
4563 ((eq (preceding-char) ?\) )
4564 (setq res (cons (list 'toplevel-after-parenth start) res)))
4566 (setq res (cons (list 'toplevel-continued start) res)))))
4567 ((/= (char-after containing-sexp) ?{)
4568 ;; line is expression, not statement:
4569 ;; indent to just after the surrounding open.
4570 ;; skip blanks if we do not close the expression.
4571 (setq res (cons (list 'expression-blanks
4573 (goto-char (1+ containing-sexp))
4574 (or (looking-at "[ \t]*\\(#\\|$\\)")
4575 (skip-chars-forward " \t"))
4577 (cons (list 'expression containing-sexp) res))))
4579 ;; Containing-expr starts with \{. Check whether it is a hash.
4580 (goto-char containing-sexp)
4581 (not (cperl-block-p)))
4582 (setq res (cons (list 'expression-blanks
4584 (goto-char (1+ containing-sexp))
4585 (or (looking-at "[ \t]*\\(#\\|$\\)")
4586 (skip-chars-forward " \t"))
4588 (cons (list 'expression containing-sexp) res))))
4591 (setq res (cons (list 'in-block containing-sexp) res))
4592 ;; Is it a continuation or a new statement?
4593 ;; Find previous non-comment character.
4594 (cperl-backward-to-noncomment containing-sexp)
4595 ;; Back up over label lines, since they don't
4596 ;; affect whether our line is a continuation.
4597 ;; Back up comma-delimited lines too ?????
4598 (while (or (eq (preceding-char) ?\,)
4599 (save-excursion (cperl-after-label)))
4600 (if (eq (preceding-char) ?\,)
4601 ;; Will go to beginning of line, essentially
4602 ;; Will ignore embedded sexpr XXXX.
4603 (cperl-backward-to-start-of-continued-exp containing-sexp))
4605 (cperl-backward-to-noncomment containing-sexp))
4606 ;; Now we get the answer.
4607 (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
4608 ;; This line is continuation of preceding line's statement.
4609 (list (list 'statement-continued containing-sexp))
4610 ;; This line starts a new statement.
4611 ;; Position following last unclosed open.
4612 (goto-char containing-sexp)
4613 ;; Is line first statement after an open-brace?
4615 ;; If no, find that first statement and indent like
4616 ;; it. If the first statement begins with label, do
4617 ;; not believe when the indentation of the label is too
4621 (let ((colon-line-end 0))
4622 (while (progn (skip-chars-forward " \t\n" start-point)
4623 (and (< (point) start-point)
4625 "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
4626 ;; Skip over comments and labels following openbrace.
4627 (cond ((= (following-char) ?\#)
4632 (save-excursion (end-of-line)
4633 (setq colon-line-end (point)))
4634 (search-forward ":"))))
4635 ;; Now at the point, after label, or at start
4636 ;; of first statement in the block.
4637 (and (< (point) start-point)
4638 (if (> colon-line-end (point))
4639 ;; Before statement after label
4640 (if (> (current-indentation)
4641 cperl-min-label-indent)
4642 (list (list 'label-in-block (point)))
4643 ;; Do not believe: `max' is involved
4645 (list 'label-in-block-min-indent (point))))
4647 (list 'statement-in-block (point))))))
4648 ;; If no previous statement,
4649 ;; indent it relative to line brace is on.
4650 ;; For open brace in column zero, don't let statement
4651 ;; start there too. If cperl-indent-level is zero,
4652 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
4653 ;; For open-braces not the first thing in a line,
4654 ;; add in cperl-brace-imaginary-offset.
4656 ;; If first thing on a line: ?????
4657 (setq unused ; This is not finished...
4658 (+ (if (and (bolp) (zerop cperl-indent-level))
4659 (+ cperl-brace-offset cperl-continued-statement-offset)
4661 ;; Move back over whitespace before the openbrace.
4662 ;; If openbrace is not first nonwhite thing on the line,
4663 ;; add the cperl-brace-imaginary-offset.
4664 (progn (skip-chars-backward " \t")
4665 (if (bolp) 0 cperl-brace-imaginary-offset))
4666 ;; If the openbrace is preceded by a parenthesized exp,
4667 ;; move to the beginning of that;
4668 ;; possibly a different line
4670 (if (eq (preceding-char) ?\))
4672 ;; Get initial indentation of the line we are on.
4673 ;; If line starts with label, calculate label indentation
4676 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
4677 (if (> (current-indentation) cperl-min-label-indent)
4678 (- (current-indentation) cperl-label-offset)
4679 (cperl-calculate-indent))
4680 (current-indentation)))))))))
4683 (defun cperl-calculate-indent-within-comment ()
4684 "Return the indentation amount for line, assuming that
4685 the current line is to be regarded as part of a block comment."
4686 (let (end star-start)
4689 (skip-chars-forward " \t")
4691 (and (= (following-char) ?#)
4693 (cperl-to-comment-or-eol)
4699 (defun cperl-to-comment-or-eol ()
4700 "Go to position before comment on the current line, or to end of line.
4701 Returns true if comment is found. In POD will not move the point."
4702 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
4703 ;; then looks for literal # or end-of-line.
4704 (let (state stop-in cpoint (lim (progn (end-of-line) (point))) pr e)
4705 (or cperl-font-locking
4706 (cperl-update-syntaxification lim lim))
4708 (if (setq pr (get-text-property (point) 'syntax-type))
4709 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
4710 (if (or (eq pr 'pod)
4711 (if (or (not e) (> e lim)) ; deep inside a group
4712 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
4713 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
4714 ;; Else - need to do it the hard way
4715 (and (and e (<= e lim))
4717 (while (not stop-in)
4718 (setq state (parse-partial-sexp (point) lim nil nil nil t))
4720 ;; If fails (beginning-of-line inside sexp), then contains not-comment
4721 (if (nth 4 state) ; After `#';
4722 ; (nth 2 state) can be
4723 ; beginning of m,s,qq and so
4727 (setq cpoint (point))
4728 (goto-char (nth 2 state))
4730 ((looking-at "\\(s\\|tr\\)\\>")
4731 (or (re-search-forward
4732 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
4735 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
4736 (or (re-search-forward
4737 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
4740 (t ; It was fair comment
4741 (setq stop-in t) ; Finish
4742 (goto-char (1- cpoint)))))
4743 (setq stop-in t) ; Finish
4745 (setq stop-in t))) ; Finish
4748 (defsubst cperl-modify-syntax-type (at how)
4749 (if (< at (point-max))
4751 (put-text-property at (1+ at) 'syntax-table how)
4752 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
4754 (defun cperl-protect-defun-start (s e)
4755 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
4758 (while (re-search-forward "^\\s(" e 'to-end)
4759 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
4761 (defun cperl-commentify (bb e string &optional noface)
4762 (if cperl-use-syntax-table-text-property
4763 (if (eq noface 'n) ; Only immediate
4765 ;; We suppose that e is _after_ the end of construction, as after eol.
4766 (setq string (if string cperl-st-sfence cperl-st-cfence))
4768 ;; one-char string/comment?!
4769 (cperl-modify-syntax-type bb cperl-st-punct)
4770 (cperl-modify-syntax-type bb string)
4771 (cperl-modify-syntax-type (1- e) string))
4772 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
4773 (put-text-property (1+ bb) (1- e)
4774 'syntax-table cperl-string-syntax-table))
4775 (cperl-protect-defun-start bb e))
4778 (not cperl-pod-here-fontify)
4779 (put-text-property bb e 'face (if string 'font-lock-string-face
4780 'font-lock-comment-face)))))
4782 (defvar cperl-starters '(( ?\( . ?\) )
4787 (defun cperl-cached-syntax-table (st)
4788 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
4789 All the entries of the syntax table are \".\", except for a backslash, which
4793 (setcar st (make-syntax-table))
4797 (modify-syntax-entry i "." st)
4799 (modify-syntax-entry ?\\ "\\" st)
4802 (defun cperl-forward-re (lim end is-2arg st-l err-l argument
4803 &optional ostart oend)
4804 "Find the end of a regular expression or a stringish construct (q[] etc).
4805 The point should be before the starting delimiter.
4807 Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
4808 is s/// or tr/// like expression. If END is nil, generates an error
4809 message if needed. If SET-ST is non-nil, will use (or generate) a
4810 cached syntax table in ST-L. If ERR-L is non-nil, will store the
4811 error message in its CAR (unless it already contains some error
4812 message). ARGUMENT should be the name of the construct (used in error
4813 messages). OSTART, OEND may be set in recursive calls when processing
4814 the second argument of 2ARG construct.
4816 Works *before* syntax recognition is done. In IS-2ARG situation may
4817 modify syntax-type text property if the situation is too hard."
4818 (let (b starter ender st i i2 go-forward reset-st set-st)
4819 (skip-chars-forward " \t")
4820 ;; ender means matching-char matcher.
4822 starter (if (eobp) 0 (char-after b))
4823 ender (cdr (assoc starter cperl-starters)))
4824 ;; What if starter == ?\\ ????
4825 (setq st (cperl-cached-syntax-table st-l))
4827 ;; Whether we have an intermediate point
4829 ;; Prepare the syntax table:
4830 (if (not ender) ; m/blah/, s/x//, s/x/y/
4831 (modify-syntax-entry starter "$" st)
4832 (modify-syntax-entry starter (concat "(" (list ender)) st)
4833 (modify-syntax-entry ender (concat ")" (list starter)) st))
4836 ;; We use `$' syntax class to find matching stuff, but $$
4837 ;; is recognized the same as $, so we need to check this manually.
4838 (if (and (eq starter (char-after (cperl-1+ b)))
4840 ;; $ has TeXish matching rules, so $$ equiv $...
4842 (setq reset-st (syntax-table))
4843 (set-syntax-table st)
4845 (if (<= (point) (1+ b))
4846 (error "Unfinished regular expression"))
4847 (set-syntax-table reset-st)
4849 ;; Now the problem is with m;blah;;
4851 (eq (preceding-char)
4852 (char-after (- (point) 2)))
4855 (= 0 (% (skip-chars-backward "\\\\") 2)))
4857 ;; Now we are after the first part.
4858 (and is-2arg ; Have trailing part
4860 (eq (following-char) starter) ; Empty trailing part
4862 (or (eq (char-syntax (following-char)) ?.)
4863 ;; Make trailing letter into punctuation
4864 (cperl-modify-syntax-type (point) cperl-st-punct))
4865 (setq is-2arg nil go-forward t))) ; Ignore the tail
4866 (if is-2arg ; Not number => have second part
4868 (setq i (point) i2 i)
4870 (if (memq (following-char) '(?\ ?\t ?\n ?\f))
4872 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4873 (goto-char (match-end 0))
4874 (skip-chars-forward " \t\n\f"))
4877 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
4878 (if ender (modify-syntax-entry ender "." st))
4880 (setq ender (cperl-forward-re lim end nil st-l err-l
4881 argument starter ender)
4882 ender (nth 2 ender)))))
4883 (error (goto-char lim)
4886 (set-syntax-table reset-st))
4889 "End of `%s%s%c ... %c' string/RE not found: %s"
4891 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
4892 starter (or ender starter) bb)
4893 (or (car err-l) (setcar err-l b)))))
4896 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
4897 (if ender (modify-syntax-entry ender "." st))))
4898 ;; i: have 2 args, after end of the first arg
4899 ;; i2: start of the second arg, if any (before delim iff `ender').
4900 ;; ender: the last arg bounded by parens-like chars, the second one of them
4901 ;; starter: the starting delimiter of the first arg
4902 ;; go-forward: has 2 args, and the second part is empty
4903 (list i i2 ender starter go-forward)))
4905 (defun cperl-forward-group-in-re (&optional st-l)
4906 "Find the end of a group in a REx.
4907 Return the error message (if any). Does not work if delimiter is `)'.
4908 Works before syntax recognition is done."
4909 ;; Works *before* syntax recognition is done
4910 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
4911 (let (st b reset-st)
4914 (setq st (cperl-cached-syntax-table st-l))
4915 (modify-syntax-entry ?\( "()" st)
4916 (modify-syntax-entry ?\) ")(" st)
4917 (setq reset-st (syntax-table))
4918 (set-syntax-table st)
4921 "cperl-forward-group-in-re: error %s" b)))
4922 ;; now restore the initial state
4925 (modify-syntax-entry ?\( "." st)
4926 (modify-syntax-entry ?\) "." st)))
4928 (set-syntax-table reset-st))
4932 (defvar font-lock-string-face)
4933 ;;(defvar font-lock-reference-face)
4934 (defvar font-lock-constant-face)
4935 (defsubst cperl-postpone-fontification (b e type val &optional now)
4936 ;; Do after syntactic fontification?
4937 (if cperl-syntaxify-by-font-lock
4938 (or now (put-text-property b e 'cperl-postpone (cons type val)))
4939 (put-text-property b e type val)))
4941 ;;; Here is how the global structures (those which cannot be
4942 ;;; recognized locally) are marked:
4944 ;; Start-to-end is marked `in-pod' ==> t
4945 ;; Each non-literal part is marked `syntax-type' ==> `pod'
4946 ;; Each literal part is marked `syntax-type' ==> `in-pod'
4948 ;; Start-to-end is marked `here-doc-group' ==> t
4949 ;; The body is marked `syntax-type' ==> `here-doc'
4950 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
4952 ;; First line (to =) marked `first-format-line' ==> t
4953 ;; After-this--to-end is marked `syntax-type' ==> `format'
4954 ;; d) 'Q'uoted string:
4955 ;; part between markers inclusive is marked `syntax-type' ==> `string'
4956 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
4957 ;; e) Attributes of subroutines: `attrib-group' ==> t
4958 ;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
4959 ;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
4961 ;;; In addition, some parts of RExes may be marked as `REx-interpolated'
4962 ;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
4964 (defun cperl-unwind-to-safe (before &optional end)
4965 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
4966 (let ((pos (point)) opos)
4967 (while (and pos (progn
4969 (get-text-property (setq pos (point)) 'syntax-type)))
4971 pos (cperl-beginning-of-property pos 'syntax-type))
4972 (if (eq pos (point-min))
4977 (goto-char (cperl-1- pos))
4980 (goto-char (setq pos (cperl-1- pos))))
4982 (goto-char (point-min))))
4984 (and (looking-at "\n*=")
4985 (/= 0 (skip-chars-backward "\n"))
4989 ;; Do the same for end, going small steps
4991 (while (and end (get-text-property end 'syntax-type))
4993 end (next-single-property-change end 'syntax-type nil (point-max)))
4994 (if end (progn (goto-char end)
4995 (or (bolp) (forward-line 1))
4996 (setq end (point)))))
4999 ;;; These are needed for byte-compile (at least with v19)
5000 (defvar cperl-nonoverridable-face)
5001 (defvar font-lock-variable-name-face)
5002 (defvar font-lock-function-name-face)
5003 (defvar font-lock-keyword-face)
5004 (defvar font-lock-builtin-face)
5005 (defvar font-lock-type-face)
5006 (defvar font-lock-comment-face)
5007 (defvar font-lock-warning-face)
5009 (defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
5010 "Syntaxically mark (and fontify) attributes of a subroutine.
5011 Should be called with the point before leading colon of an attribute."
5012 ;; Works *before* syntax recognition is done
5013 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
5014 (let (st b p reset-st after-first (start (point)) start1 end1)
5018 "\\(" ; 1=optional? colon
5019 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
5021 (if after-first "?" "")
5022 ;; No space between name and paren allowed...
5023 "\\(\\sw+\\)" ; 3=name
5024 "\\((\\)?")) ; 4=optional paren
5025 (and (match-beginning 1)
5026 (cperl-postpone-fontification
5027 (match-beginning 0) (cperl-1+ (match-beginning 0))
5028 'face font-lock-constant-face))
5029 (setq start1 (match-beginning 3) end1 (match-end 3))
5030 (cperl-postpone-fontification start1 end1
5031 'face font-lock-constant-face)
5032 (goto-char end1) ; end or before `('
5033 (if (match-end 4) ; Have attribute arguments...
5036 (setq st (cperl-cached-syntax-table st-l))
5037 (modify-syntax-entry ?\( "()" st)
5038 (modify-syntax-entry ?\) ")(" st))
5039 (setq reset-st (syntax-table) p (point))
5040 (set-syntax-table st)
5042 (set-syntax-table reset-st)
5044 (cperl-commentify p (point) t))) ; mark as string
5045 (forward-comment (buffer-size))
5046 (setq after-first t))
5048 "L%d: attribute `%s': %s"
5049 (count-lines (point-min) (point))
5050 (and start1 end1 (buffer-substring start1 end1)) b)
5054 (put-text-property start (point)
5055 'attrib-group (if (looking-at "{") t 0))
5057 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
5058 ;; Apparently, we do not need `multiline': faces added now
5059 (put-text-property (+ 3 pos) (cperl-1+ (point))
5060 'syntax-type 'sub-decl))
5061 (and b-fname ; Fontify here: the following condition
5062 (cperl-postpone-fontification ; is too hard to determine by
5063 b-fname e-fname 'face ; a REx, so do it here
5064 (if (looking-at "{")
5065 font-lock-function-name-face
5066 font-lock-variable-name-face)))))
5067 ;; now restore the initial state
5070 (modify-syntax-entry ?\( "." st)
5071 (modify-syntax-entry ?\) "." st)))
5073 (set-syntax-table reset-st))))
5075 (defsubst cperl-look-at-leading-count (is-x-REx e)
5076 (if (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
5077 (1- e) t) ; return nil on failure, no moving
5078 (if (eq ?\{ (preceding-char)) nil
5079 (cperl-postpone-fontification
5080 (1- (point)) (point)
5081 'face font-lock-warning-face))))
5083 ;;; Debugging this may require (setq max-specpdl-size 2000)...
5084 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
5085 "Scans the buffer for hard-to-parse Perl constructions.
5086 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
5087 the sections using `cperl-pod-head-face', `cperl-pod-face',
5090 (or min (setq min (point-min)
5091 cperl-syntax-state nil
5092 cperl-syntax-done-to min))
5093 (or max (setq max (point-max)))
5094 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
5095 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
5096 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
5097 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
5098 (modified (buffer-modified-p)) overshoot is-o-REx
5099 (after-change-functions nil)
5100 (cperl-font-locking t)
5101 (use-syntax-state (and cperl-syntax-state
5102 (>= min (car cperl-syntax-state))))
5103 (state-point (if use-syntax-state
5104 (car cperl-syntax-state)
5106 (state (if use-syntax-state
5107 (cdr cperl-syntax-state)))
5108 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
5109 (st-l (list nil)) (err-l (list nil))
5110 ;; Somehow font-lock may be not loaded yet...
5111 ;; (e.g., when building TAGS via command-line call)
5112 (font-lock-string-face (if (boundp 'font-lock-string-face)
5113 font-lock-string-face
5114 'font-lock-string-face))
5115 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
5116 font-lock-constant-face
5117 'font-lock-constant-face))
5118 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
5119 (if (boundp 'font-lock-function-name-face)
5120 font-lock-function-name-face
5121 'font-lock-function-name-face))
5122 (font-lock-variable-name-face ; interpolated vars and ({})-code
5123 (if (boundp 'font-lock-variable-name-face)
5124 font-lock-variable-name-face
5125 'font-lock-variable-name-face))
5126 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
5127 (if (boundp 'font-lock-function-name-face)
5128 font-lock-function-name-face
5129 'font-lock-function-name-face))
5130 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
5131 (if (boundp 'font-lock-constant-face)
5132 font-lock-constant-face
5133 'font-lock-constant-face))
5134 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
5135 (if (boundp 'font-lock-builtin-face)
5136 font-lock-builtin-face
5137 'font-lock-builtin-face))
5138 (font-lock-comment-face
5139 (if (boundp 'font-lock-comment-face)
5140 font-lock-comment-face
5141 'font-lock-comment-face))
5142 (font-lock-warning-face
5143 (if (boundp 'font-lock-warning-face)
5144 font-lock-warning-face
5145 'font-lock-warning-face))
5146 (my-cperl-REx-ctl-face ; (|)
5147 (if (boundp 'font-lock-keyword-face)
5148 font-lock-keyword-face
5149 'font-lock-keyword-face))
5150 (my-cperl-REx-modifiers-face ; //gims
5151 (if (boundp 'cperl-nonoverridable-face)
5152 cperl-nonoverridable-face
5153 'cperl-nonoverridable-face))
5154 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
5155 (if (boundp 'font-lock-type-face)
5157 'font-lock-type-face))
5158 (stop-point (if ignore-max
5163 "\\(\\`\n?\\|^\n\\)=" ; POD
5165 ;; One extra () before this:
5168 ;; First variant "BLAH" or just ``.
5169 "[ \t]*" ; Yes, whitespace is allowed!
5170 "\\([\"'`]\\)" ; 2 + 1 = 3
5171 "\\([^\"'`\n]*\\)" ; 3 + 1
5174 ;; Second variant: Identifier or \ID (same as 'ID') or empty
5175 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
5176 ;; Do not have <<= or << 30 or <<30 or << $blah.
5177 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
5178 "\\(\\)" ; To preserve count of pars :-( 6 + 1
5181 ;; 1+6 extra () before this:
5182 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
5183 (if cperl-use-syntax-table-text-property
5186 ;; 1+6+2=9 extra () before this:
5187 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
5189 ;; 1+6+2+1=10 extra () before this:
5190 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
5192 ;; 1+6+2+1+1=11 extra () before this
5193 "\\<sub\\>" ; sub with proto/attr
5195 cperl-white-and-comment-rex
5196 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
5198 cperl-maybe-white-and-comment-rex
5199 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
5201 ;; 1+6+2+1+1+6=17 extra () before this:
5202 "\\$\\(['{]\\)" ; $' or ${foo}
5204 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
5205 ;; we do not support intervening comments...):
5206 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
5207 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
5209 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
5210 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
5212 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
5218 (message "Scanning for \"hard\" Perl constructions..."))
5219 ;;(message "find: %s --> %s" min max)
5220 (and cperl-pod-here-fontify
5221 ;; We had evals here, do not know why...
5222 (setq face cperl-pod-face
5223 head-face cperl-pod-head-face
5224 here-face cperl-here-face))
5225 (remove-text-properties min max
5226 '(syntax-type t in-pod t syntax-table t
5237 ;; Need to remove face as well...
5239 (and (eq system-type 'emx)
5241 (let ((case-fold-search t))
5242 (looking-at "extproc[ \t]")) ; Analogue of #!
5243 (cperl-commentify min
5244 (save-excursion (end-of-line) (point))
5248 (re-search-forward search max t))
5249 (setq tmpend nil) ; Valid for most cases
5250 (setq b (match-beginning 0)
5251 state (save-excursion (parse-partial-sexp
5252 state-point b nil nil state))
5255 ;; 1+6+2+1+1+6=17 extra () before this:
5257 ((match-beginning 18) ; $' or ${foo}
5258 (if (eq (preceding-char) ?\') ; $'
5260 (setq b (1- (point))
5261 state (parse-partial-sexp
5262 state-point (1- b) nil nil state)
5264 (if (nth 3 state) ; in string
5265 (cperl-modify-syntax-type (1- b) cperl-st-punct))
5268 (setq bb (match-beginning 0))
5269 (cperl-modify-syntax-type bb cperl-st-punct)))
5270 ;; No processing in strings/comments beyond this point:
5271 ((or (nth 3 state) (nth 4 state))
5272 t) ; Do nothing in comment/string
5273 ((match-beginning 1) ; POD section
5274 ;; "\\(\\`\n?\\|^\n\\)="
5275 (setq b (match-beginning 0)
5276 state (parse-partial-sexp
5277 state-point b nil nil state)
5279 (if (or (nth 3 state) (nth 4 state)
5280 (looking-at "cut\\>"))
5281 (if (or (nth 3 state) (nth 4 state) ignore-max)
5282 nil ; Doing a chunk only
5283 (message "=cut is not preceded by a POD section")
5284 (or (car err-l) (setcar err-l (point))))
5289 tb (match-beginning 0)
5290 b1 nil) ; error condition
5291 ;; We do not search to max, since we may be called from
5292 ;; some hook of fontification, and max is random
5293 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
5296 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
5298 (message "=cut is not preceded by an empty line")
5300 (or (car err-l) (setcar err-l b))))))
5301 (beginning-of-line 2) ; An empty line after =cut is not POD!
5305 (remove-text-properties
5306 max e '(syntax-type t in-pod t syntax-table t
5318 (put-text-property b e 'in-pod t)
5319 (put-text-property b e 'syntax-type 'in-pod)
5321 (while (re-search-forward "\n\n[ \t]" e t)
5322 ;; We start 'pod 1 char earlier to include the preceding line
5324 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5325 (cperl-put-do-not-fontify b (point) t)
5326 ;; mark the non-literal parts as PODs
5327 (if cperl-pod-here-fontify
5328 (cperl-postpone-fontification b (point) 'face face t))
5329 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
5332 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5333 (cperl-put-do-not-fontify (point) e t)
5334 (if cperl-pod-here-fontify
5336 ;; mark the non-literal parts as PODs
5337 (cperl-postpone-fontification (point) e 'face face t)
5340 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
5342 (cperl-postpone-fontification
5343 (match-beginning 1) (match-end 1)
5345 (while (re-search-forward
5347 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
5350 (cperl-postpone-fontification
5351 (match-beginning 1) (match-end 1)
5353 (cperl-commentify bb e nil)
5355 (or (eq e (point-max))
5356 (forward-char -1)))) ; Prepare for immediate POD start.
5358 ;; We can do many here-per-line;
5359 ;; but multiline quote on the same line as <<HERE confuses us...
5360 ;; ;; One extra () before this:
5363 ;; ;; First variant "BLAH" or just ``.
5364 ;; "[ \t]*" ; Yes, whitespace is allowed!
5365 ;; "\\([\"'`]\\)" ; 2 + 1
5366 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
5369 ;; ;; Second variant: Identifier or \ID or empty
5370 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
5371 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
5372 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
5373 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
5375 ((match-beginning 2) ; 1 + 1
5377 tb (match-beginning 0)
5378 c (and ; not HERE-DOC
5381 (or (looking-at "[ \t]*(") ; << function_call()
5382 (save-excursion ; 1 << func_name, or $foo << 10
5386 ;;; XXX What to do: foo <<bar ???
5387 ;;; XXX Need to support print {a} <<B ???
5390 ; $foo << b; $f .= <<B;
5391 ; ($f+1) << b; a($f) . <<B;
5392 ; foo 1, <<B; $x{a} <<b;
5394 ((looking-at "[0-9$({]")
5397 (looking-at "[ \t]*<<")
5403 (looking-at "print\\>")))
5405 (error nil))) ; func(<<EOF)
5406 (and (not (match-beginning 6)) ; Empty
5408 "[ \t]*[=0-9$@%&(]"))))))
5409 (if c ; Not here-doc
5411 (setq c (match-end 2)) ; 1 + 1
5412 (if (match-beginning 5) ;4 + 1
5413 (setq b1 (match-beginning 5) ; 4 + 1
5414 e1 (match-end 5)) ; 4 + 1
5415 (setq b1 (match-beginning 4) ; 3 + 1
5416 e1 (match-end 4))) ; 3 + 1
5417 (setq tag (buffer-substring b1 e1)
5418 qtag (regexp-quote tag))
5419 (cond (cperl-pod-here-fontify
5420 ;; Highlight the starting delimiter
5421 (cperl-postpone-fontification
5422 b1 e1 'face my-cperl-delimiters-face)
5423 (cperl-put-do-not-fontify b1 e1 t)))
5427 (goto-char end-of-here-doc))
5429 ;; We do not search to max, since we may be called from
5430 ;; some hook of fontification, and max is random
5431 (or (and (re-search-forward (concat "^" qtag "$")
5433 (eq (following-char) ?\n))
5434 (progn ; Pretend we matched at the end
5435 (goto-char (point-max))
5436 (re-search-forward "\\'")
5437 (message "End of here-document `%s' not found." tag)
5438 (or (car err-l) (setcar err-l b))))
5439 (if cperl-pod-here-fontify
5441 ;; Highlight the ending delimiter
5442 (cperl-postpone-fontification
5443 (match-beginning 0) (match-end 0)
5444 'face my-cperl-delimiters-face)
5445 (cperl-put-do-not-fontify b (match-end 0) t)
5446 ;; Highlight the HERE-DOC
5447 (cperl-postpone-fontification b (match-beginning 0)
5449 (setq e1 (cperl-1+ (match-end 0)))
5450 (put-text-property b (match-beginning 0)
5451 'syntax-type 'here-doc)
5452 (put-text-property (match-beginning 0) e1
5453 'syntax-type 'here-doc-delim)
5454 (put-text-property b e1 'here-doc-group t)
5455 ;; This makes insertion at the start of HERE-DOC update
5456 ;; the whole construct:
5457 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
5458 (cperl-commentify b e1 nil)
5459 (cperl-put-do-not-fontify b (match-end 0) t)
5460 ;; Cache the syntax info...
5461 (setq cperl-syntax-state (cons state-point state))
5462 ;; ... and process the rest of the line...
5464 (elt ; non-inter ignore-max
5465 (cperl-find-pods-heres c i t end t e1) 1))
5466 (if (and overshoot (> overshoot (point)))
5467 (goto-char overshoot)
5468 (setq overshoot e1))
5472 ((match-beginning 8)
5473 ;; 1+6=7 extra () before this:
5474 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
5476 name (if (match-beginning 8) ; 7 + 1
5477 (buffer-substring (match-beginning 8) ; 7 + 1
5478 (match-end 8)) ; 7 + 1
5480 tb (match-beginning 0))
5482 (put-text-property (save-excursion
5485 b 'first-format-line 't)
5486 (if cperl-pod-here-fontify
5487 (while (and (eq (forward-line) 0)
5488 (not (looking-at "^[.;]$")))
5490 ((looking-at "^#")) ; Skip comments
5491 ((and argument ; Skip argument multi-lines
5492 (looking-at "^[ \t]*{"))
5494 (setq argument nil))
5495 (argument ; Skip argument lines
5496 (setq argument nil))
5499 (setq argument (looking-at "^[^\n]*[@^]"))
5501 ;; Highlight the format line
5502 (cperl-postpone-fontification b1 (point)
5503 'face font-lock-string-face)
5504 (cperl-commentify b1 (point) nil)
5505 (cperl-put-do-not-fontify b1 (point) t))))
5506 ;; We do not search to max, since we may be called from
5507 ;; some hook of fontification, and max is random
5508 (re-search-forward "^[.;]$" stop-point 'toend))
5510 (if (looking-at "^\\.$") ; ";" is not supported yet
5512 ;; Highlight the ending delimiter
5513 (cperl-postpone-fontification (point) (+ (point) 2)
5514 'face font-lock-string-face)
5515 (cperl-commentify (point) (+ (point) 2) nil)
5516 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
5517 (message "End of format `%s' not found." name)
5518 (or (car err-l) (setcar err-l b)))
5522 (put-text-property b (point) 'syntax-type 'format))
5523 ;; qq-like String or Regexp:
5524 ((or (match-beginning 10) (match-beginning 11))
5525 ;; 1+6+2=9 extra () before this:
5526 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
5528 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
5529 (setq b1 (if (match-beginning 10) 10 11)
5530 argument (buffer-substring
5531 (match-beginning b1) (match-end b1))
5532 b (point) ; end of qq etc
5534 c (char-after (match-beginning b1))
5535 bb (char-after (1- (match-beginning b1))) ; tmp holder
5536 ;; bb == "Not a stringy"
5537 bb (if (eq b1 10) ; user variables/whatever
5538 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
5539 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
5540 ((eq bb ?\:) ; $opt::s
5542 (- (match-beginning b1) 2))
5544 ((eq bb ?\>) ; $foo->s
5546 (- (match-beginning b1) 2))
5549 (not (eq (char-after ; &&m/blah/
5550 (- (match-beginning b1) 2))
5553 ;; <file> or <$file>
5555 ;; Do not stringify <FH>, <$fh> :
5558 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
5559 tb (match-beginning 0))
5560 (goto-char (match-beginning b1))
5561 (cperl-backward-to-noncomment (point-min))
5563 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
5568 ;; What is below: regexp-p?
5570 (or (memq (preceding-char)
5571 (append (if (memq c '(?\? ?\<))
5574 "~{(=|&+-*!,;:[") nil))
5575 (and (eq (preceding-char) ?\})
5576 (cperl-after-block-p (point-min)))
5577 (and (eq (char-syntax (preceding-char)) ?w)
5580 ;;; After these keywords `/' starts a RE. One should add all the
5581 ;;; functions/builtins which expect an argument, but ...
5582 (if (eq (preceding-char) ?-)
5584 (looking-at "[a-zA-Z]\\>")
5586 (not (memq (preceding-char)
5589 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
5590 (and (eq (preceding-char) ?.)
5591 (eq (char-after (- (point) 2)) ?.))
5593 ;; m|blah| ? foo : bar;
5596 cperl-use-syntax-table-text-property
5600 (looking-at "\\s|"))))))
5603 ;; Check for $a -> y
5604 (setq b1 (preceding-char)
5607 (eq (char-after (- go 2)) ?-))
5613 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
5614 (goto-char (match-end 0))
5615 (skip-chars-forward " \t\n\f"))
5616 (cond ((and (eq (following-char) ?\})
5618 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
5620 (skip-chars-backward " \t\n\f")
5621 (if (memq (preceding-char) (append "$@%&*" nil))
5627 (looking-at ; $foo -> {s}
5628 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
5629 (and ; $foo[12] -> {s}
5630 (memq (following-char) '(?\{ ?\[))
5633 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
5636 ((and (eq (following-char) ?=)
5637 (eq (char-after (1+ (point))) ?\>))
5638 ;; Check for { foo => 1, s => 2 }
5639 ;; Apparently s=> is never a substitution...
5641 ((and (eq (following-char) ?:)
5642 (eq b1 ?\{) ; Check for $ { s::bar }
5643 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
5646 (skip-chars-backward " \t\n\f")
5647 (memq (preceding-char)
5648 (append "$@%&*" nil))))
5654 ;; Skip whitespace and comments...
5655 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
5656 (goto-char (match-end 0))
5657 (skip-chars-forward " \t\n\f"))
5659 (put-text-property b (point) 'syntax-type 'prestring))
5660 ;; qtag means two-arg matcher, may be reset to
5661 ;; 2 or 3 later if some special quoting is needed.
5662 ;; e1 means matching-char matcher.
5663 (setq b (point) ; before the first delimiter
5665 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
5666 ;; We do not search to max, since we may be called from
5667 ;; some hook of fontification, and max is random
5668 i (cperl-forward-re stop-point end
5670 st-l err-l argument)
5671 ;; If `go', then it is considered as 1-arg, `b1' is nil
5672 ;; as in s/foo//x; the point is before final "slash"
5673 b1 (nth 1 i) ; start of the second part
5674 tag (nth 2 i) ; ender-char, true if second part
5675 ; is with matching chars []
5676 go (nth 4 i) ; There is a 1-char part after the end
5677 i (car i) ; intermediate point
5679 ;; Before end of the second part if non-matching: ///
5680 tail (if (and i (not tag))
5682 e (if i i e1) ; end of the first part
5683 qtag nil ; need to preserve backslashitis
5684 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
5685 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
5686 ;; Commenting \\ is dangerous, what about ( ?
5688 (eq (char-after i) ?\\)
5690 (and (if go (looking-at ".\\sw*x")
5691 (looking-at "\\sw*x")) ; qr//x
5693 (and (if go (looking-at ".\\sw*o")
5694 (looking-at "\\sw*o")) ; //o
5697 ;; Considered as 1arg form
5699 (cperl-commentify b (point) t)
5700 (put-text-property b (point) 'syntax-type 'string)
5702 ;; ignore other text properties:
5703 (string-match "^qw$" argument))
5704 (put-text-property b (point) 'indentable t))
5706 (setq e1 (cperl-1+ e1))
5709 (cperl-commentify b i t)
5710 (if (looking-at "\\sw*e") ; s///e
5712 ;; Cache the syntax info...
5713 (setq cperl-syntax-state (cons state-point state))
5716 (car (cperl-find-pods-heres b1 (1- (point)) t end))
5718 (goto-char (1+ max)))
5719 (if (and tag (eq (preceding-char) ?\>))
5721 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
5722 (cperl-modify-syntax-type i cperl-st-bra)))
5723 (put-text-property b i 'syntax-type 'string)
5725 (put-text-property b i 'indentable t)))
5726 (cperl-commentify b1 (point) t)
5727 (put-text-property b (point) 'syntax-type 'string)
5729 (put-text-property b i 'indentable t))
5731 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
5733 ;; Now: tail: if the second part is non-matching without ///e
5734 (if (eq (char-syntax (following-char)) ?w)
5736 (forward-word 1) ; skip modifiers s///s
5737 (if tail (cperl-commentify tail (point) t))
5738 (cperl-postpone-fontification
5739 e1 (point) 'face my-cperl-REx-modifiers-face)))
5740 ;; Check whether it is m// which means "previous match"
5741 ;; and highlight differently
5743 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
5744 (or (not (= (length argument) 0))
5748 ;; split // *is* using zero-pattern
5754 (not (looking-at "split\\>")))
5756 (cperl-postpone-fontification
5757 b e 'face font-lock-warning-face)
5758 (if (or i2 ; Has 2 args
5759 (and cperl-fontify-m-as-s
5761 (string-match "^\\(m\\|qr\\)$" argument)
5762 (and (eq 0 (length argument))
5763 (not (eq ?\< (char-after b)))))))
5765 (cperl-postpone-fontification
5766 b (cperl-1+ b) 'face my-cperl-delimiters-face)
5767 (cperl-postpone-fontification
5768 (1- e) e 'face my-cperl-delimiters-face)))
5769 (if (and is-REx cperl-regexp-scan)
5770 ;; Process RExen: embedded comments, charclasses and ]
5771 ;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
5772 ;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
5773 ;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
5774 ;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
5775 ;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
5776 ;;;m^a[\^b]c^ + m.a[^b]\.c.;
5780 (cperl-look-at-leading-count is-x-REx e)
5784 (if (eq (char-after b) ?\#)
5785 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
5786 "\\((\\?#\\)\\|\\(#\\)")
5787 ;; keep the same count: add a fake group
5788 (if (eq (char-after b) ?\#)
5789 "\\((\\?\\\\#\\)\\(\\)"
5790 "\\((\\?#\\)\\(\\)"))
5796 ;; XXXX Will not be able to use it in s)))
5797 (if (eq (char-after b) ?\) )
5798 "\\())))\\)" ; Will never match
5799 (if (eq (char-after b) ?? )
5800 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
5801 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
5802 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
5803 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
5804 "\\(" ;; XXXX 1-char variables, exc. |()\s
5807 "[_a-zA-Z:][_a-zA-Z0-9:]*"
5809 "{[^{}]*}" ; only one-level allowed
5813 "\\(" ;;8,9:code part of array/hash elt
5819 ;; XXXX: what if u is delim?
5827 "\\\\[luLUEQbBAzZG]"
5830 "\\(" ; 10 group opener follower
5831 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
5833 "\\?[:=!>?{]" ; "?" something
5835 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
5837 "\\?([0-9]+)" ; (?(1)foo|bar)
5845 "\\\\\\(.\\)" ; 12=\SYMBOL
5848 (and (< (point) (1- e))
5849 (re-search-forward hairy-RE (1- e) 'to-end))
5850 (goto-char (match-beginning 0))
5851 (setq REx-subgr-start (point)
5852 was-subgr (following-char))
5854 ((match-beginning 6) ; 0-length builtins, groups
5855 (goto-char (match-end 0))
5856 (if (match-beginning 11)
5857 (goto-char (match-beginning 11)))
5860 (cperl-postpone-fontification
5861 (match-beginning 0) (point)
5864 ((eq was-subgr ?\) )
5869 (if (if (eq (char-after b) ?? )
5870 (looking-at "(\\\\\\?")
5871 (eq (char-after (1+ (point))) ?\?))
5872 my-cperl-REx-0length-face
5873 my-cperl-REx-ctl-face)
5874 font-lock-warning-face))
5875 (error font-lock-warning-face)))
5876 ((eq was-subgr ?\| )
5877 my-cperl-REx-ctl-face)
5878 ((eq was-subgr ?\$ )
5879 (if (> (point) (1+ REx-subgr-start))
5882 (match-beginning 0) (point)
5885 (if (and (eq (match-beginning 0)
5889 font-lock-variable-name-face)
5890 my-cperl-REx-spec-char-face))
5891 ((memq was-subgr (append "^." nil) )
5892 my-cperl-REx-spec-char-face)
5893 ((eq was-subgr ?\( )
5894 (if (not (match-beginning 10))
5895 my-cperl-REx-ctl-face
5896 my-cperl-REx-0length-face))
5897 (t my-cperl-REx-0length-face)))
5898 (if (and (memq was-subgr (append "(|" nil))
5899 (not (string-match "(\\?[-imsx]+)"
5901 (cperl-look-at-leading-count is-x-REx e))
5902 (setq was-subgr nil)) ; We do stuff here
5903 ((match-beginning 12) ; \SYMBOL
5907 ;; How many chars to not highlight:
5908 ;; 0-len special-alnums in other branch =>
5909 ;; Generic: \non-alnum (1), \alnum (1+face)
5910 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
5911 (setq REx-subgr-start (point)
5912 qtag (preceding-char))
5913 (cperl-postpone-fontification
5914 (- (point) 2) (- (point) 1) 'face
5916 (append "ghijkmoqvFHIJKMORTVY" nil))
5917 font-lock-warning-face
5918 my-cperl-REx-0length-face))
5919 (if (and (eq (char-after b) qtag)
5920 (memq qtag (append ".])^$|*?+" nil)))
5922 (if (and cperl-use-syntax-table-text-property
5925 REx-subgr-start (1- (point))
5926 'syntax-table cperl-st-punct))
5927 (cperl-postpone-fontification
5928 (1- (point)) (point) 'face
5929 ; \] can't appear below
5930 (if (memq qtag (append ".]^$" nil))
5931 'my-cperl-REx-spec-char-face
5932 (if (memq qtag (append "*?+" nil))
5933 'my-cperl-REx-0length-face
5934 'my-cperl-REx-ctl-face))))) ; )|
5935 ;; Test for arguments:
5937 ;; This is not pretty: the 5.8.7 logic:
5938 ;; \0numx -> octal (up to total 3 dig)
5939 ;; \DIGIT -> backref unless \0
5940 ;; \DIGITs -> backref if legal
5941 ;; otherwise up to 3 -> octal
5942 ;; Do not try to distinguish, we guess
5943 ((or (and (memq qtag (append "01234567" nil))
5945 "\\=[01234567]?[01234567]?"
5947 (and (memq qtag (append "89" nil))
5949 "\\=[0123456789]*" (1- e) 'to-end))
5952 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
5954 (and (memq qtag (append "pPN" nil))
5955 (re-search-forward "\\={[^{}]+}\\|."
5957 (eq (char-syntax qtag) ?w))
5958 (cperl-postpone-fontification
5959 (1- REx-subgr-start) (point)
5960 'face my-cperl-REx-length1-face))))
5961 (setq was-subgr nil)) ; We do stuff here
5962 ((match-beginning 3) ; [charclass]
5964 (if (eq (char-after b) ?^ )
5965 (and (eq (following-char) ?\\ )
5966 (eq (char-after (cperl-1+ (point)))
5969 (and (eq (following-char) ?^ )
5971 (setq argument b ; continue?
5972 tag nil ; list of POSIX classes
5974 (if (eq (char-after b) ?\] )
5975 (and (eq (following-char) ?\\ )
5976 (eq (char-after (cperl-1+ (point)))
5978 (setq qtag (1+ qtag))
5980 (and (eq (following-char) ?\] )
5982 ;; Apparently, I can't put \] into a charclass
5983 ;; in m]]: m][\\\]\]] produces [\\]]
5984 ;;; POSIX? [:word:] [:^word:] only inside []
5985 ;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
5989 (if (eq (char-after b) ?\] )
5990 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
5991 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
5993 ;; Is this ] an end of POSIX class?
5996 (search-backward "[" argument t)
5997 (< REx-subgr-start (point))
5999 (and ; Should work with delim = \
6000 (eq (preceding-char) ?\\ )
6001 (= (% (skip-chars-backward
6005 ((eq (char-after b) ?\] )
6006 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
6007 ((eq (char-after b) ?\: )
6008 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
6009 ((eq (char-after b) ?^ )
6010 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
6011 ((eq (char-syntax (char-after b))
6014 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
6015 (char-to-string (char-after b))
6017 (t "\\\\*\\[:\\^?\\sw*:]")))
6018 (setq argument (point))))
6019 (setq tag (cons (cons argument (point))
6021 argument (point)) ; continue
6022 (setq argument nil)))
6024 (message "Couldn't find end of charclass in a REx, pos=%s"
6026 (if (and cperl-use-syntax-table-text-property
6027 (> (- (point) 2) REx-subgr-start))
6029 (1+ REx-subgr-start) (1- (point))
6030 'syntax-table cperl-st-punct))
6031 (cperl-postpone-fontification
6032 REx-subgr-start qtag
6033 'face my-cperl-REx-spec-char-face)
6034 (cperl-postpone-fontification
6035 (1- (point)) (point) 'face
6036 my-cperl-REx-spec-char-face)
6037 (if (eq (char-after b) ?\] )
6038 (cperl-postpone-fontification
6039 (- (point) 2) (1- (point))
6040 'face my-cperl-REx-0length-face))
6042 (cperl-postpone-fontification
6043 (car (car tag)) (cdr (car tag))
6044 'face my-cperl-REx-length1-face)
6045 (setq tag (cdr tag)))
6046 (setq was-subgr nil)) ; did facing already
6048 ((and (match-beginning 2) ; #-comment
6049 (/= (match-beginning 2) (match-end 2)))
6050 (beginning-of-line 2)
6052 (goto-char (1- e))))
6053 ((match-beginning 4) ; character "]"
6054 (setq was-subgr nil) ; We do stuff here
6055 (goto-char (match-end 0))
6056 (if cperl-use-syntax-table-text-property
6058 (1- (point)) (point)
6059 'syntax-table cperl-st-punct))
6060 (cperl-postpone-fontification
6061 (1- (point)) (point)
6062 'face font-lock-warning-face))
6063 ((match-beginning 5) ; before (?{}) (??{})
6064 (setq tag (match-end 0))
6066 (cperl-forward-group-in-re st-l))
6068 (setq qtag "no matching `)' found"))
6069 (and (not (eq (char-after (- (point) 2))
6071 (setq qtag "Can't find })")))
6075 (cperl-postpone-fontification
6076 (1- tag) (1- (point))
6077 'face font-lock-variable-name-face)
6078 (cperl-postpone-fontification
6079 REx-subgr-start (1- tag)
6080 'face my-cperl-REx-spec-char-face)
6081 (cperl-postpone-fontification
6082 (1- (point)) (point)
6083 'face my-cperl-REx-spec-char-face)
6084 (if cperl-use-syntax-table-text-property
6087 (- (point) 2) (1- (point))
6088 'syntax-table cperl-st-cfence)
6090 (+ REx-subgr-start 2)
6091 (+ REx-subgr-start 3)
6092 'syntax-table cperl-st-cfence))))
6093 (setq was-subgr nil))
6095 ;; Inside "(" and "\" arn't special in any way
6096 ;; Works also if the outside delimiters are ().
6097 (or;;(if (eq (char-after b) ?\) )
6098 ;;(re-search-forward
6099 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
6101 (search-forward ")" (1- e) 'toend)
6104 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
6110 (setq REx-subgr-end (point))
6112 REx-subgr-start REx-subgr-end nil)
6113 (cperl-postpone-fontification
6114 REx-subgr-start REx-subgr-end
6115 'face font-lock-comment-face))))))
6116 (if (and is-REx is-x-REx)
6117 (put-text-property (1+ b) (1- e)
6118 'syntax-subtype 'x-REx)))
6121 (cperl-postpone-fontification
6122 (1- e1) e1 'face my-cperl-delimiters-face)
6123 (if (assoc (char-after b) cperl-starters)
6125 (cperl-postpone-fontification
6126 b1 (1+ b1) 'face my-cperl-delimiters-face)
6127 (put-text-property b1 (1+ b1)
6131 ((match-beginning 17) ; sub with prototype or attribute
6132 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
6133 ;;"\\<sub\\>\\(" ;12
6134 ;; cperl-white-and-comment-rex ;13
6135 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
6136 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
6137 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
6138 (setq b1 (match-beginning 14) e1 (match-end 14))
6139 (if (memq (char-after (1- b))
6140 '(?\$ ?\@ ?\% ?\& ?\*))
6143 (if (eq (char-after (match-beginning 17)) ?\( )
6145 (cperl-commentify ; Prototypes; mark as string
6146 (match-beginning 17) (match-end 17) t)
6147 (goto-char (match-end 0))
6148 ;; Now look for attributes after prototype:
6149 (forward-comment (buffer-size))
6150 (and (looking-at ":[^:]")
6151 (cperl-find-sub-attrs st-l b1 e1 b)))
6152 ;; treat attributes without prototype
6153 (goto-char (match-beginning 17))
6154 (cperl-find-sub-attrs st-l b1 e1 b))))
6155 ;; 1+6+2+1+1+6+1=18 extra () before this:
6156 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
6157 ((match-beginning 19) ; old $abc'efg syntax
6158 (setq bb (match-end 0))
6159 ;;;(if (nth 3 state) nil ; in string
6160 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
6162 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
6163 ;; "__\\(END\\|DATA\\)__"
6164 ((match-beginning 20) ; __END__, __DATA__
6165 (setq bb (match-end 0))
6166 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
6167 (cperl-commentify b bb nil)
6169 ;; "\\\\\\(['`\"($]\\)"
6170 ((match-beginning 21)
6171 ;; Trailing backslash; make non-quoting outside string/comment
6172 (setq bb (match-end 0))
6174 (skip-chars-backward "\\\\")
6175 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
6176 (cperl-modify-syntax-type b cperl-st-punct)
6178 (t (error "Error in regexp of the sniffer")))
6179 (if (> (point) stop-point)
6182 (message "Garbage after __END__/__DATA__ ignored")
6183 (message "Unbalanced syntax found while scanning")
6184 (or (car err-l) (setcar err-l b)))
6185 (goto-char stop-point))))
6186 (setq cperl-syntax-state (cons state-point state)
6187 ;; Do not mark syntax as done past tmpend???
6188 cperl-syntax-done-to (or tmpend (max (point) max)))
6189 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
6191 (if (car err-l) (goto-char (car err-l))
6193 (message "Scanning for \"hard\" Perl constructions... done"))))
6194 (and (buffer-modified-p)
6196 (set-buffer-modified-p nil))
6197 (set-syntax-table cperl-mode-syntax-table))
6198 (list (car err-l) overshoot)))
6200 (defun cperl-find-pods-heres-region (min max)
6202 (cperl-find-pods-heres min max))
6204 (defun cperl-backward-to-noncomment (lim)
6205 ;; Stops at lim or after non-whitespace that is not in comment
6206 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
6208 (while (and (not stop) (> (point) (or lim (point-min))))
6209 (skip-chars-backward " \t\n\f" lim)
6212 (if (memq (setq pr (get-text-property (point) 'syntax-type))
6213 '(pod here-doc here-doc-delim))
6214 (cperl-unwind-to-safe nil)
6215 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
6216 (not (memq pr '(string prestring))))
6217 (progn (cperl-to-comment-or-eol) (bolp))
6219 (skip-chars-backward " \t")
6220 (if (< p (point)) (goto-char p))
6223 ;; Used only in `cperl-calculate-indent'...
6224 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
6225 ;; Positions is before ?\{. Checks whether it starts a block.
6226 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
6227 (cperl-backward-to-noncomment (point-min))
6228 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
6229 ; Label may be mixed up with `$blah :'
6230 (save-excursion (cperl-after-label))
6231 (get-text-property (cperl-1- (point)) 'attrib-group)
6232 (and (memq (char-syntax (preceding-char)) '(?w ?_))
6235 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
6236 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
6237 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
6238 ;; sub bless::foo {}
6240 (cperl-backward-to-noncomment (point-min))
6241 (and (eq (preceding-char) ?b)
6244 (looking-at "sub[ \t\n\f#]")))))))))
6246 ;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
6247 ;;; No save-excursion; condition-case ... In (cperl-block-p) the block
6248 ;;; may be a part of an in-statement construct, such as
6249 ;;; ${something()}, print {FH} $data.
6250 ;;; Moreover, one takes positive approach (looks for else,grep etc)
6251 ;;; another negative (looks for bless,tr etc)
6252 (defun cperl-after-block-p (lim &optional pre-block)
6253 "Return true if the preceeding } (if PRE-BLOCK, following {) delimits a block.
6254 Would not look before LIM. Assumes that LIM is a good place to begin a
6255 statement. The kind of block we treat here is one after which a new
6256 statement would start; thus the block in ${func()} does not count."
6260 (or pre-block (forward-sexp -1))
6261 (cperl-backward-to-noncomment lim)
6262 (or (eq (point) lim)
6263 ;; if () {} // sub f () {} // sub f :a(') {}
6264 (eq (preceding-char) ?\) )
6266 (save-excursion (cperl-after-label))
6268 (get-text-property (cperl-1- (point)) 'attrib-group)
6269 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
6272 ;; else {} but not else::func {}
6273 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
6274 (not (looking-at "\\(\\sw\\|_\\)+::")))
6277 (cperl-backward-to-noncomment lim)
6278 (and (eq (preceding-char) ?b)
6281 (looking-at "sub[ \t\n\f#]"))))))
6282 ;; What preceeds is not word... XXXX Last statement in sub???
6283 (cperl-after-expr-p lim))))
6286 (defun cperl-after-expr-p (&optional lim chars test)
6287 "Return true if the position is good for start of expression.
6288 TEST is the expression to evaluate at the found position. If absent,
6289 CHARS is a string that contains good characters to have before us (however,
6290 `}' is treated \"smartly\" if it is not in the list)."
6291 (let ((lim (or lim (point-min)))
6293 (cperl-update-syntaxification (point) (point))
6295 (while (and (not stop) (> (point) lim))
6296 (skip-chars-backward " \t\n\f" lim)
6299 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
6300 ;; '(pod here-doc here-doc-delim))
6301 (if (get-text-property (point) 'here-doc-group)
6304 (cperl-beginning-of-property (point) 'here-doc-group))
6305 (beginning-of-line 0)))
6306 (if (get-text-property (point) 'in-pod)
6309 (cperl-beginning-of-property (point) 'in-pod))
6310 (beginning-of-line 0)))
6311 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
6312 ;; Else: last iteration, or a label
6313 (cperl-to-comment-or-eol) ; Will not move past "." after a format
6314 (skip-chars-backward " \t")
6315 (if (< p (point)) (goto-char p))
6317 (if (and (eq (preceding-char) ?:)
6320 (skip-chars-backward " \t\n\f" lim)
6321 (memq (char-syntax (preceding-char)) '(?w ?_))))
6322 (forward-sexp -1) ; Possibly label. Skip it
6325 (or (bobp) ; ???? Needed
6327 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
6329 (if test (eval test)
6330 (or (memq (preceding-char) (append (or chars "{;") nil))
6331 (and (eq (preceding-char) ?\})
6332 (cperl-after-block-p lim))
6333 (and (eq (following-char) ?.) ; in format: see comment above
6334 (eq (get-text-property (point) 'syntax-type)
6337 (defun cperl-backward-to-start-of-expr (&optional lim)
6340 (while (and (or (not lim)
6342 (not (cperl-after-expr-p lim)))
6346 (defun cperl-at-end-of-expr (&optional lim)
6349 ;; If nothing interesting after, same as (forward-sexp -1); otherwise
6350 ;; fails, or at a start of following sexp:
6355 (cperl-after-expr-p lim))))
6358 (defun cperl-forward-to-end-of-expr (&optional lim)
6362 (while (and (< (point) (or lim (point-max)))
6363 (not (cperl-at-end-of-expr)))
6367 (defun cperl-backward-to-start-of-continued-exp (lim)
6368 (if (memq (preceding-char) (append ")]}\"'`" nil))
6371 (if (<= (point) lim)
6372 (goto-char (1+ lim)))
6373 (skip-chars-forward " \t"))
6375 (defun cperl-after-block-and-statement-beg (lim)
6376 ;; We assume that we are after ?\}
6378 (cperl-after-block-p lim)
6381 (cperl-backward-to-noncomment (point-min))
6384 (not (= (char-syntax (preceding-char)) ?w))
6389 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
6392 (defvar innerloop-done nil)
6393 (defvar last-depth nil)
6395 (defun cperl-indent-exp ()
6396 "Simple variant of indentation of continued-sexp.
6398 Will not indent comment if it starts at `comment-indent' or looks like
6399 continuation of the comment on the previous line.
6401 If `cperl-indent-region-fix-constructs', will improve spacing on
6402 conditional/loop constructs."
6405 (let ((tmp-end (progn (end-of-line) (point))) top done)
6410 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
6412 (setq top (point))) ; Get the outermost parenths in line
6414 (while (< (point) tmp-end)
6415 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
6416 (or (eolp) (forward-sexp 1)))
6417 (if (> (point) tmp-end)
6420 (setq tmp-end (point)))
6423 (setq tmp-end (point-marker)))
6424 (if cperl-indent-region-fix-constructs
6425 (cperl-fix-line-spacing tmp-end))
6426 (cperl-indent-region (point) tmp-end))))
6428 (defun cperl-fix-line-spacing (&optional end parse-data)
6429 "Improve whitespace in a conditional/loop construct.
6430 Returns some position at the last line."
6433 (setq end (point-max)))
6434 (let ((ee (save-excursion (end-of-line) (point)))
6435 (cperl-indent-region-fix-constructs
6436 (or cperl-indent-region-fix-constructs 1))
6437 p pp ml have-brace ret)
6444 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
6445 (setq have-brace (save-excursion (search-forward "}" ee t)))))
6446 nil ; Do not need to do anything
6450 (if (and cperl-merge-trailing-else
6452 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
6454 (search-forward "}")
6456 (skip-chars-forward " \t\n")
6457 (delete-region p (point))
6458 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6459 (beginning-of-line)))
6462 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
6464 (search-forward "}")
6465 (delete-horizontal-space)
6466 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6467 (beginning-of-line)))
6471 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
6474 (delete-horizontal-space)
6475 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6476 (beginning-of-line)))
6480 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
6483 (delete-horizontal-space)
6484 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6485 (beginning-of-line)))
6487 ;; foreach my $var (
6489 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
6492 (delete-horizontal-space)
6494 (make-string cperl-indent-region-fix-constructs ?\ ))
6495 (beginning-of-line)))
6497 ;; } foreach my $var () {
6499 "[ \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]*{")
6501 (setq ml (match-beginning 8))
6502 (re-search-forward "[({]")
6505 (if (eq (following-char) ?\( )
6509 ;; after `else' or nothing
6510 (if ml ; after `else'
6511 (skip-chars-backward " \t\n")
6512 (beginning-of-line))
6514 ;; Now after the sexp before the brace
6515 ;; Multiline expr should be special
6516 (setq ml (and pp (save-excursion (goto-char p)
6517 (search-forward "\n" pp t))))
6518 (if (and (or (not pp) (< pp end))
6519 (looking-at "[ \t\n]*{"))
6522 ((bolp) ; Were before `{', no if/else/etc
6524 ((looking-at "\\(\t*\\| [ \t]+\\){")
6525 (delete-horizontal-space)
6527 cperl-extra-newline-before-brace-multiline
6528 cperl-extra-newline-before-brace)
6530 (delete-horizontal-space)
6533 (if (cperl-indent-line parse-data)
6535 (cperl-fix-line-spacing end parse-data)
6536 (setq ret (point)))))
6538 (make-string cperl-indent-region-fix-constructs ?\ ))))
6539 ((and (looking-at "[ \t]*\n")
6541 cperl-extra-newline-before-brace-multiline
6542 cperl-extra-newline-before-brace)))
6544 (skip-chars-forward " \t\n")
6545 (delete-region pp (point))
6547 (make-string cperl-indent-region-fix-constructs ?\ ))))
6548 ;; Now we are before `{'
6549 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
6551 (skip-chars-forward " \t\n")
6556 (setq ml (search-forward "\n" p t))
6557 (if (or cperl-break-one-line-blocks-when-indent ml)
6558 ;; not good: multi-line BLOCK
6561 (delete-horizontal-space)
6564 (if (cperl-indent-line parse-data)
6565 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
6567 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
6568 ;; Now check whether there is a hanging `}'
6572 cperl-fix-hanging-brace-when-indent
6574 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
6578 (if (and (<= (point) pp)
6579 (eq (preceding-char) ?\} )
6580 (cperl-after-block-and-statement-beg (point-min)))
6587 (skip-chars-backward " \t")
6589 ;; `}' was the first thing on the line, insert NL *after* it.
6591 (cperl-indent-line parse-data)
6592 (search-forward "}")
6593 (delete-horizontal-space)
6595 (delete-horizontal-space)
6596 (or (eq (preceding-char) ?\;)
6598 (and (eq (preceding-char) ?\} )
6599 (cperl-after-block-p (point-min)))
6603 (if (cperl-indent-line parse-data)
6604 (setq ret (cperl-fix-line-spacing end parse-data)))
6605 (beginning-of-line)))))
6608 (defvar cperl-update-start) ; Do not need to make them local
6609 (defvar cperl-update-end)
6610 (defun cperl-delay-update-hook (beg end old-len)
6611 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
6612 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
6614 (defun cperl-indent-region (start end)
6615 "Simple variant of indentation of region in CPerl mode.
6616 Should be slow. Will not indent comment if it starts at `comment-indent'
6617 or looks like continuation of the comment on the previous line.
6618 Indents all the lines whose first character is between START and END
6621 If `cperl-indent-region-fix-constructs', will improve spacing on
6622 conditional/loop constructs."
6624 (cperl-update-syntaxification end end)
6626 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
6627 (let ((indent-info (if cperl-emacs-can-parse
6628 (list nil nil nil) ; Cannot use '(), since will modify
6630 (pm 0) (imenu-scanning-message "Indenting... (%3d%%)")
6631 after-change-functions ; Speed it up!
6632 st comm old-comm-indent new-comm-indent p pp i empty)
6633 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
6635 (setq old-comm-indent (and (cperl-to-comment-or-eol)
6637 new-comm-indent old-comm-indent)
6639 (setq end (set-marker (make-marker) end)) ; indentation changes pos
6640 (or (bolp) (beginning-of-line 2))
6641 (or (fboundp 'imenu-progress-message)
6642 (message "Indenting... For feedback load `imenu'..."))
6643 (while (and (<= (point) end) (not (eobp))) ; bol to check start
6644 (and (fboundp 'imenu-progress-message)
6645 (imenu-progress-message
6646 pm (/ (* 100 (- (point) start)) (- end start -1))))
6649 (setq empty (looking-at "[ \t]*\n"))
6650 (and (setq comm (looking-at "[ \t]*#"))
6651 (or (eq (current-indentation) (or old-comm-indent
6653 (setq old-comm-indent nil))))
6654 (if (and old-comm-indent
6656 (= (current-indentation) old-comm-indent)
6657 (not (eq (get-text-property (point) 'syntax-type) 'pod))
6658 (not (eq (get-text-property (point) 'syntax-table)
6660 (let ((comment-column new-comm-indent))
6661 (indent-for-comment)))
6663 (setq i (cperl-indent-line indent-info))
6667 (if cperl-indent-region-fix-constructs
6668 (goto-char (cperl-fix-line-spacing end indent-info)))
6669 (if (setq old-comm-indent
6670 (and (cperl-to-comment-or-eol)
6671 (not (memq (get-text-property (point)
6674 (not (eq (get-text-property (point)
6678 (progn (indent-for-comment)
6679 (skip-chars-backward " \t")
6680 (skip-chars-backward "#")
6681 (setq new-comm-indent (current-column))))))))
6682 (beginning-of-line 2))
6683 (if (fboundp 'imenu-progress-message)
6684 (imenu-progress-message pm 100)
6686 ;; Now run the update hooks
6687 (and after-change-functions
6690 (goto-char cperl-update-end)
6693 (goto-char cperl-update-start)
6695 (delete-char -1))))))
6697 ;; Stolen from lisp-mode with a lot of improvements
6699 (defun cperl-fill-paragraph (&optional justify iteration)
6700 "Like \\[fill-paragraph], but handle CPerl comments.
6701 If any of the current line is a comment, fill the comment or the
6702 block of it that point is in, preserving the comment's initial
6703 indentation and initial hashes. Behaves usually outside of comment."
6705 (let (;; Non-nil if the current line contains a comment.
6707 fill-paragraph-function ; do not recurse
6708 ;; If has-comment, the appropriate fill-prefix for the comment.
6710 ;; Line that contains code and comment (or nil)
6712 c spaces len dc (comment-column comment-column))
6713 ;; Figure out what kind of comment we are looking at.
6718 ;; A line with nothing but a comment on it?
6719 ((looking-at "[ \t]*#[# \t]*")
6721 comment-fill-prefix (buffer-substring (match-beginning 0)
6724 ;; A line with some code, followed by a comment? Remember that the
6725 ;; semi which starts the comment shouldn't be part of a string or
6727 ((cperl-to-comment-or-eol)
6728 (setq has-comment t)
6729 (looking-at "#+[ \t]*")
6730 (setq start (point) c (current-column)
6732 (concat (make-string (current-column) ?\ )
6733 (buffer-substring (match-beginning 0) (match-end 0)))
6734 spaces (progn (skip-chars-backward " \t")
6735 (buffer-substring (point) start))
6736 dc (- c (current-column)) len (- start (point))
6737 start (point-marker))
6739 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
6740 (if (not has-comment)
6741 (fill-paragraph justify) ; Do the usual thing outside of comment
6742 ;; Narrow to include only the comment, and then fill the region.
6745 ;; Find the first line we should include in the region to fill.
6746 (if start (progn (beginning-of-line) (point))
6748 (while (and (zerop (forward-line -1))
6749 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
6750 ;; We may have gone to far. Go forward again.
6751 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
6754 ;; Find the beginning of the first line past the region to fill.
6756 (while (progn (forward-line 1)
6757 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
6759 ;; Remove existing hashes
6760 (goto-char (point-min))
6761 (while (progn (forward-line 1) (< (point) (point-max)))
6762 (skip-chars-forward " \t")
6763 (if (looking-at "#+")
6765 (if (and (eq (point) (match-beginning 0))
6766 (not (eq (point) (match-end 0)))) nil
6768 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
6769 (delete-char (- (match-end 0) (match-beginning 0))))))
6771 ;; Lines with only hashes on them can be paragraph boundaries.
6772 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
6773 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
6774 (fill-prefix comment-fill-prefix))
6775 (fill-paragraph justify)))
6780 (progn (delete-char dc) (insert spaces)))
6781 (if (or (= (current-column) c) iteration) nil
6782 (setq comment-column c)
6783 (indent-for-comment)
6784 ;; Repeat once more, flagging as iteration
6785 (cperl-fill-paragraph justify t))))))
6788 (defun cperl-do-auto-fill ()
6789 ;; Break out if the line is short enough
6790 (if (> (save-excursion
6794 (let ((c (save-excursion (beginning-of-line)
6795 (cperl-to-comment-or-eol) (point)))
6796 (s (memq (following-char) '(?\ ?\t))) marker)
6797 (if (>= c (point)) nil
6798 (setq marker (point-marker))
6799 (cperl-fill-paragraph)
6801 ;; Is not enough, sometimes marker is a start of line
6802 (if (bolp) (progn (re-search-forward "#+[ \t]*")
6803 (goto-char (match-end 0))))
6804 ;; Following space could have gone:
6805 (if (or (not s) (memq (following-char) '(?\ ?\t))) nil
6808 ;; Previous space could have gone:
6809 (or (memq (preceding-char) '(?\ ?\t)) (insert " "))))))
6811 (defun cperl-imenu-addback (lst &optional isback name)
6812 ;; We suppose that the lst is a DAG, unless the first element only
6813 ;; loops back, and ISBACK is set. Thus this function cannot be
6814 ;; applied twice without ISBACK set.
6815 (cond ((not cperl-imenu-addback) lst)
6818 (setq name "+++BACK+++"))
6819 (mapcar (lambda (elt)
6820 (if (and (listp elt) (listp (cdr elt)))
6822 ;; In the other order it goes up
6823 ;; one level only ;-(
6824 (setcdr elt (cons (cons name lst)
6826 (cperl-imenu-addback (cdr elt) t name))))
6827 (if isback (cdr lst) lst))
6830 (defun cperl-imenu--create-perl-index (&optional regexp)
6832 (require 'imenu) ; May be called from TAGS creator
6833 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
6834 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
6835 (index-meth-alist '()) meth
6836 packages ends-ranges p marker is-proto
6837 (prev-pos 0) is-pack index index1 name (end-range 0) package)
6838 (goto-char (point-min))
6840 (message "Scanning Perl for index")
6841 (imenu-progress-message prev-pos 0))
6842 (cperl-update-syntaxification (point-max) (point-max))
6843 ;; Search for the function
6844 (progn ;;save-match-data
6845 (while (re-search-forward
6846 (or regexp cperl-imenu--function-name-regexp-perl)
6849 (imenu-progress-message prev-pos))
6850 ;; 2=package-group, 5=package-name 8=sub-name
6852 ((and ; Skip some noise if building tags
6853 (match-beginning 5) ; package name
6854 ;;(eq (char-after (match-beginning 2)) ?p) ; package
6855 (not (save-match-data
6856 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
6859 (or (match-beginning 2)
6860 (match-beginning 8)) ; package or sub
6861 ;; Skip if quoted (will not skip multi-line ''-strings :-():
6862 (null (get-text-property (match-beginning 1) 'syntax-table))
6863 (null (get-text-property (match-beginning 1) 'syntax-type))
6864 (null (get-text-property (match-beginning 1) 'in-pod)))
6865 (setq is-pack (match-beginning 2))
6866 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
6867 ;; (goto-char (match-end 0))) ; Messes what follows
6870 (while (and ends-ranges (>= p (car ends-ranges)))
6871 ;; delete obsolete entries
6872 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
6873 (setq package (or (car packages) "")
6874 end-range (or (car ends-ranges) 0))
6875 (if is-pack ; doing "package"
6877 (if (match-beginning 5) ; named package
6878 (setq name (buffer-substring (match-beginning 5)
6881 (set-text-properties 0 (length name) nil name)
6883 package (concat name "::")
6884 name (concat "package " name))
6885 ;; Support nameless packages
6886 (setq name "package;" package ""))
6889 (parse-partial-sexp (point) (point-max) -1) (point))
6890 ends-ranges (cons end-range ends-ranges)
6891 packages (cons package packages)))
6893 (or (eq (following-char) ?\;)
6894 (eq 0 (get-text-property (point) 'attrib-group)))))
6895 ;; Skip this function name if it is a prototype declaration.
6896 (if (and is-proto (not is-pack)) nil
6899 (buffer-substring (match-beginning 8) (match-end 8)))
6900 (set-text-properties 0 (length name) nil name))
6901 (setq marker (make-marker))
6902 (set-marker marker (match-end (if is-pack 2 8)))
6904 ((string-match "[:']" name)
6906 ((> p end-range) nil)
6908 (setq name (concat package name) meth t)))
6909 (setq index (cons name marker))
6911 (push index index-pack-alist)
6912 (push index index-alist))
6913 (if meth (push index index-meth-alist))
6914 (push index index-unsorted-alist)))
6915 ((match-beginning 16) ; POD section
6916 (setq name (buffer-substring (match-beginning 17) (match-end 17))
6917 marker (make-marker))
6918 (set-marker marker (match-beginning 17))
6919 (set-text-properties 0 (length name) nil name)
6920 (setq name (concat (make-string
6921 (* 3 (- (char-after (match-beginning 16)) ?1))
6924 index (cons name marker))
6925 (setq index1 (cons (concat "=" name) (cdr index)))
6926 (push index index-pod-alist)
6927 (push index1 index-unsorted-alist)))))
6929 (imenu-progress-message prev-pos 100))
6931 (if (default-value 'imenu-sort-function)
6932 (sort index-alist (default-value 'imenu-sort-function))
6933 (nreverse index-alist)))
6934 (and index-pod-alist
6935 (push (cons "+POD headers+..."
6936 (nreverse index-pod-alist))
6938 (and (or index-pack-alist index-meth-alist)
6939 (let ((lst index-pack-alist) hier-list pack elt group name)
6940 ;; Remove "package ", reverse and uniquify.
6942 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
6943 (if (assoc name hier-list) nil
6944 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
6945 (setq lst index-meth-alist)
6947 (setq elt (car lst) lst (cdr lst))
6948 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
6949 (setq pack (substring (car elt) 0 (match-beginning 0)))
6950 (if (setq group (assoc pack hier-list))
6951 (if (listp (cdr group))
6952 ;; Have some functions already
6954 (cons (cons (substring
6956 (+ 2 (match-beginning 0)))
6959 (setcdr group (list (cons (substring
6961 (+ 2 (match-beginning 0)))
6965 (list (cons (substring
6967 (+ 2 (match-beginning 0)))
6970 (push (cons "+Hierarchy+..."
6973 (and index-pack-alist
6974 (push (cons "+Packages+..."
6975 (nreverse index-pack-alist))
6977 (and (or index-pack-alist index-pod-alist
6978 (default-value 'imenu-sort-function))
6979 index-unsorted-alist
6980 (push (cons "+Unsorted List+..."
6981 (nreverse index-unsorted-alist))
6983 (cperl-imenu-addback index-alist)))
6986 ;; Suggested by Mark A. Hershberger
6987 (defun cperl-outline-level ()
6988 (looking-at outline-regexp)
6989 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
6990 ;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
6991 ((match-beginning 2) 0) ; package
6992 ((match-beginning 8) 1) ; sub
6993 ((match-beginning 16)
6994 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
6995 (t 5))) ; should not happen
6998 (defvar cperl-compilation-error-regexp-alist
6999 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
7000 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
7002 "Alist that specifies how to match errors in perl output.")
7004 (if (fboundp 'eval-after-load)
7007 '(setq perl-compilation-error-regexp-alist
7008 cperl-compilation-error-regexp-alist)))
7011 (defun cperl-windowed-init ()
7012 "Initialization under windowed version."
7013 (if (or (featurep 'ps-print) cperl-faces-init)
7014 ;; Need to init anyway:
7015 (or cperl-faces-init (cperl-init-faces))
7016 (add-hook 'font-lock-mode-hook
7019 (if (memq major-mode '(perl-mode cperl-mode))
7021 (or cperl-faces-init (cperl-init-faces)))))))
7022 (if (fboundp 'eval-after-load)
7025 '(or cperl-faces-init (cperl-init-faces))))))
7027 (defun cperl-load-font-lock-keywords ()
7028 (or cperl-faces-init (cperl-init-faces))
7029 perl-font-lock-keywords)
7031 (defun cperl-load-font-lock-keywords-1 ()
7032 (or cperl-faces-init (cperl-init-faces))
7033 perl-font-lock-keywords-1)
7035 (defun cperl-load-font-lock-keywords-2 ()
7036 (or cperl-faces-init (cperl-init-faces))
7037 perl-font-lock-keywords-2)
7039 (defvar perl-font-lock-keywords-1 nil
7040 "Additional expressions to highlight in Perl mode. Minimal set.")
7041 (defvar perl-font-lock-keywords nil
7042 "Additional expressions to highlight in Perl mode. Default set.")
7043 (defvar perl-font-lock-keywords-2 nil
7044 "Additional expressions to highlight in Perl mode. Maximal set.")
7046 (defvar font-lock-background-mode)
7047 (defvar font-lock-display-type)
7048 (defun cperl-init-faces-weak ()
7049 ;; Allow `cperl-find-pods-heres' to run.
7050 (or (boundp 'font-lock-constant-face)
7051 (cperl-force-face font-lock-constant-face
7052 "Face for constant and label names"))
7053 (or (boundp 'font-lock-warning-face)
7054 (cperl-force-face font-lock-warning-face
7055 "Face for things which should stand out"))
7056 ;;(setq font-lock-constant-face 'font-lock-constant-face)
7059 (defun cperl-init-faces ()
7060 (condition-case errs
7062 (require 'font-lock)
7063 (and (fboundp 'font-lock-fontify-anchored-keywords)
7064 (featurep 'font-lock-extra)
7065 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
7066 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
7067 (if (fboundp 'font-lock-fontify-anchored-keywords)
7068 (setq font-lock-anchored t))
7070 t-font-lock-keywords
7072 (list "[ \t]+$" 0 cperl-invalid-face t)
7075 "\\(^\\|[^$@%&\\]\\)\\<\\("
7078 '("if" "until" "while" "elsif" "else" "unless" "for"
7079 "foreach" "continue" "exit" "die" "last" "goto" "next"
7080 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
7081 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
7082 "\\|") ; Flow control
7083 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
7084 ; In what follows we use `type' style
7085 ; for overwritable builtins
7088 "\\(^\\|[^$@%&\\]\\)\\<\\("
7089 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
7090 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
7091 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
7092 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
7093 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
7094 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
7095 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
7096 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
7097 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
7098 ;; "gethostbyname" "gethostent" "getlogin"
7099 ;; "getnetbyaddr" "getnetbyname" "getnetent"
7100 ;; "getpeername" "getpgrp" "getppid" "getpriority"
7101 ;; "getprotobyname" "getprotobynumber" "getprotoent"
7102 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
7103 ;; "getservbyport" "getservent" "getsockname"
7104 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
7105 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
7106 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
7107 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
7108 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
7109 ;; "quotemeta" "rand" "read" "readdir" "readline"
7110 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
7111 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
7112 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
7113 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
7114 ;; "setpriority" "setprotoent" "setpwent" "setservent"
7115 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
7116 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
7117 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
7118 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
7119 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
7120 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
7121 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
7122 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
7123 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
7124 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
7125 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
7126 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
7127 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
7128 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
7129 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
7130 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
7131 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
7132 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
7133 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
7134 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
7135 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
7136 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
7137 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
7138 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
7139 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
7140 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
7141 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
7142 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
7143 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
7144 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
7145 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
7146 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
7147 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
7148 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
7149 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
7150 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
7151 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
7152 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
7153 "\\)\\>") 2 'font-lock-type-face)
7154 ;; In what follows we use `other' style
7155 ;; for nonoverwritable builtins
7156 ;; Somehow 's', 'm' are not auto-generated???
7159 "\\(^\\|[^$@%&\\]\\)\\<\\("
7160 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
7161 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
7162 ;; "eval" "exists" "for" "foreach" "format" "goto"
7163 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
7164 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
7165 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
7166 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
7167 ;; "undef" "unless" "unshift" "untie" "until" "use"
7169 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
7170 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
7171 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
7172 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
7173 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
7174 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
7175 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
7176 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
7177 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
7178 "\\|[sm]" ; Added manually
7179 "\\)\\>") 2 'cperl-nonoverridable-face)
7180 ;; (mapconcat 'identity
7181 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
7182 ;; "#include" "#define" "#undef")
7184 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
7185 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
7186 ;; This highlights declarations and definitions differenty.
7187 ;; We do not try to highlight in the case of attributes:
7188 ;; it is already done by `cperl-find-pods-heres'
7189 (list (concat "\\<sub"
7190 cperl-white-and-comment-rex ; whitespace/comments
7191 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
7193 cperl-maybe-white-and-comment-rex ;whitespace/comments?
7194 "([^()]*)\\)?" ; prototype
7195 cperl-maybe-white-and-comment-rex ; whitespace/comments?
7197 2 (if cperl-font-lock-multiline
7198 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
7199 'font-lock-function-name-face
7200 'font-lock-variable-name-face)
7201 ;; need to manually set 'multiline' for older font-locks
7203 (if (< 1 (count-lines (match-beginning 0)
7206 (+ 3 (match-beginning 0)) (match-end 0)
7207 'syntax-type 'multiline))
7208 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
7209 'font-lock-function-name-face
7210 'font-lock-variable-name-face))))
7211 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
7212 2 font-lock-function-name-face)
7213 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
7214 1 font-lock-function-name-face)
7215 (cond ((featurep 'font-lock-extra)
7216 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
7217 (2 font-lock-string-face t)
7218 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
7220 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
7221 (2 font-lock-string-face t)
7222 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
7224 (1 font-lock-string-face t))))
7225 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
7226 2 font-lock-string-face t)))
7227 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
7228 font-lock-string-face t)
7229 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
7230 font-lock-constant-face) ; labels
7231 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
7232 2 font-lock-constant-face)
7233 ;; Uncomment to get perl-mode-like vars
7234 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
7235 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
7236 ;;; (2 (cons font-lock-variable-name-face '(underline))))
7237 (cond ((featurep 'font-lock-extra)
7238 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
7239 (3 font-lock-variable-name-face)
7241 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
7242 (1 font-lock-variable-name-face)
7243 (2 '(restart 2 nil) nil t)))
7244 nil t))) ; local variables, multiple
7246 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
7247 (` ((, (concat "\\<\\(my\\|local\\|our\\)"
7248 cperl-maybe-white-and-comment-rex
7250 cperl-maybe-white-and-comment-rex
7251 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)"))
7252 (5 (, (if cperl-font-lock-multiline
7253 'font-lock-variable-name-face
7254 '(progn (setq cperl-font-lock-multiline-start
7255 (match-beginning 0))
7256 'font-lock-variable-name-face))))
7258 cperl-maybe-white-and-comment-rex
7260 cperl-maybe-white-and-comment-rex
7261 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)"))
7262 ;; Bug in font-lock: limit is used not only to limit
7263 ;; searches, but to set the "extend window for
7264 ;; facification" property. Thus we need to minimize.
7265 (, (if cperl-font-lock-multiline
7266 '(if (match-beginning 3)
7268 (goto-char (match-beginning 3))
7274 (error nil)))) ; typeahead
7275 (1- (point))) ; report limit
7276 (forward-char -2)) ; disable continued expr
7277 '(if (match-beginning 3)
7278 (point-max) ; No limit for continuation
7279 (forward-char -2)))) ; disable continued expr
7280 (, (if cperl-font-lock-multiline
7283 ;; "my" may be already fontified (POD),
7284 ;; so cperl-font-lock-multiline-start is nil
7285 (if (or (not cperl-font-lock-multiline-start)
7287 cperl-font-lock-multiline-start
7291 (1+ cperl-font-lock-multiline-start) (point)
7292 'syntax-type 'multiline))
7293 (setq cperl-font-lock-multiline-start nil))))
7294 (3 font-lock-variable-name-face)))))
7295 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
7296 3 font-lock-variable-name-face)))
7297 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
7298 4 font-lock-variable-name-face)))
7300 t-font-lock-keywords-1
7301 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
7302 ;; not yet as of XEmacs 19.12, works with 21.1.11
7304 (not cperl-xemacs-p)
7305 (string< "21.1.9" emacs-version)
7306 (and (string< "21.1.10" emacs-version)
7307 (string< emacs-version "21.1.2")))
7309 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
7310 (if (eq (char-after (match-beginning 2)) ?%)
7313 t) ; arrays and hashes
7314 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
7316 (if (= (- (match-end 2) (match-beginning 2)) 1)
7317 (if (eq (char-after (match-beginning 3)) ?{)
7319 cperl-array-face) ; arrays and hashes
7320 font-lock-variable-name-face) ; Just to put something
7322 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
7323 ;;; Too much noise from \s* @s[ and friends
7324 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
7325 ;;(3 font-lock-function-name-face t t)
7327 ;; (if (cperl-slash-is-regexp)
7328 ;; font-lock-function-name-face 'default) nil t))
7330 (if cperl-highlight-variables-indiscriminately
7331 (setq t-font-lock-keywords-1
7332 (append t-font-lock-keywords-1
7333 (list '("[$*]{?\\(\\sw+\\)" 1
7334 font-lock-variable-name-face)))))
7335 (setq perl-font-lock-keywords-1
7336 (if cperl-syntaxify-by-font-lock
7337 (cons 'cperl-fontify-update
7338 t-font-lock-keywords)
7339 t-font-lock-keywords)
7340 perl-font-lock-keywords perl-font-lock-keywords-1
7341 perl-font-lock-keywords-2 (append
7342 perl-font-lock-keywords-1
7343 t-font-lock-keywords-1)))
7344 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
7345 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
7346 (eval ; Avoid a warning
7347 '(font-lock-require-faces
7349 ;; Color-light Color-dark Gray-light Gray-dark Mono
7350 (list 'font-lock-comment-face
7351 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
7356 (list 'font-lock-string-face
7357 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
7362 (list 'font-lock-function-name-face
7364 "Blue" "LightSkyBlue" "Gray50" "LightGray"
7365 (cdr (assq 'background-color ; if mono
7366 (frame-parameters))))
7369 (cdr (assq 'foreground-color ; if mono
7370 (frame-parameters))))
7374 (list 'font-lock-variable-name-face
7375 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
7380 (list 'font-lock-type-face
7381 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
7386 (list 'font-lock-warning-face
7387 ["Pink" "Red" "Gray50" "LightGray"]
7394 (list 'font-lock-constant-face
7395 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
7400 (list 'cperl-nonoverridable-face
7401 ["chartreuse3" ("orchid1" "orange")
7407 (list 'cperl-array-face
7408 ["blue" "yellow" nil "Gray80"]
7409 ["lightyellow2" ("navy" "os2blue" "darkgreen")
7414 (list 'cperl-hash-face
7415 ["red" "red" nil "Gray80"]
7416 ["lightyellow2" ("navy" "os2blue" "darkgreen")
7421 ;; Do it the dull way, without choose-color
7422 (defvar cperl-guessed-background nil
7423 "Display characteristics as guessed by cperl.")
7424 ;; (or (fboundp 'x-color-defined-p)
7425 ;; (defalias 'x-color-defined-p
7426 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
7427 ;; ;; XEmacs >= 19.12
7428 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
7430 ;; (t 'x-valid-color-name-p))))
7431 (cperl-force-face font-lock-constant-face
7432 "Face for constant and label names")
7433 (cperl-force-face font-lock-variable-name-face
7434 "Face for variable names")
7435 (cperl-force-face font-lock-type-face
7436 "Face for data types")
7437 (cperl-force-face cperl-nonoverridable-face
7438 "Face for data types from another group")
7439 (cperl-force-face font-lock-warning-face
7440 "Face for things which should stand out")
7441 (cperl-force-face font-lock-comment-face
7442 "Face for comments")
7443 (cperl-force-face font-lock-function-name-face
7444 "Face for function names")
7445 (cperl-force-face cperl-hash-face
7447 (cperl-force-face cperl-array-face
7449 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
7450 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
7451 ;;(or (boundp 'font-lock-type-face)
7452 ;; (defconst font-lock-type-face
7453 ;; 'font-lock-type-face
7454 ;; "Face to use for data types."))
7455 ;;(or (boundp 'cperl-nonoverridable-face)
7456 ;; (defconst cperl-nonoverridable-face
7457 ;; 'cperl-nonoverridable-face
7458 ;; "Face to use for data types from another group."))
7459 ;;(if (not cperl-xemacs-p) nil
7460 ;; (or (boundp 'font-lock-comment-face)
7461 ;; (defconst font-lock-comment-face
7462 ;; 'font-lock-comment-face
7463 ;; "Face to use for comments."))
7464 ;; (or (boundp 'font-lock-keyword-face)
7465 ;; (defconst font-lock-keyword-face
7466 ;; 'font-lock-keyword-face
7467 ;; "Face to use for keywords."))
7468 ;; (or (boundp 'font-lock-function-name-face)
7469 ;; (defconst font-lock-function-name-face
7470 ;; 'font-lock-function-name-face
7471 ;; "Face to use for function names.")))
7473 (not (cperl-is-face 'cperl-array-face))
7474 (cperl-is-face 'font-lock-emphasized-face))
7475 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
7477 (not (cperl-is-face 'cperl-hash-face))
7478 (cperl-is-face 'font-lock-other-emphasized-face))
7479 (copy-face 'font-lock-other-emphasized-face
7482 (not (cperl-is-face 'cperl-nonoverridable-face))
7483 (cperl-is-face 'font-lock-other-type-face))
7484 (copy-face 'font-lock-other-type-face
7485 'cperl-nonoverridable-face))
7486 ;;(or (boundp 'cperl-hash-face)
7487 ;; (defconst cperl-hash-face
7489 ;; "Face to use for hashes."))
7490 ;;(or (boundp 'cperl-array-face)
7491 ;; (defconst cperl-array-face
7492 ;; 'cperl-array-face
7493 ;; "Face to use for arrays."))
7494 ;; Here we try to guess background
7496 (if (boundp 'font-lock-background-mode)
7497 font-lock-background-mode
7499 (face-list (and (fboundp 'face-list) (face-list))))
7500 ;;;; (fset 'cperl-is-face
7501 ;;;; (cond ((fboundp 'find-face)
7502 ;;;; (symbol-function 'find-face))
7504 ;;;; (function (lambda (face) (member face face-list))))
7506 ;;;; (function (lambda (face) (boundp face))))))
7507 (defvar cperl-guessed-background
7508 (if (and (boundp 'font-lock-display-type)
7509 (eq font-lock-display-type 'grayscale))
7512 "Background as guessed by CPerl mode")
7513 (and (not (cperl-is-face 'font-lock-constant-face))
7514 (cperl-is-face 'font-lock-reference-face)
7515 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
7516 (if (cperl-is-face 'font-lock-type-face) nil
7517 (copy-face 'default 'font-lock-type-face)
7519 ((eq background 'light)
7520 (set-face-foreground 'font-lock-type-face
7521 (if (x-color-defined-p "seagreen")
7524 ((eq background 'dark)
7525 (set-face-foreground 'font-lock-type-face
7526 (if (x-color-defined-p "os2pink")
7530 (set-face-background 'font-lock-type-face "gray90"))))
7531 (if (cperl-is-face 'cperl-nonoverridable-face)
7533 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
7535 ((eq background 'light)
7536 (set-face-foreground 'cperl-nonoverridable-face
7537 (if (x-color-defined-p "chartreuse3")
7540 ((eq background 'dark)
7541 (set-face-foreground 'cperl-nonoverridable-face
7542 (if (x-color-defined-p "orchid1")
7545 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
7546 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
7548 ;;; ((eq background 'light)
7549 ;;; (set-face-background 'font-lock-other-emphasized-face
7550 ;;; (if (x-color-defined-p "lightyellow2")
7552 ;;; (if (x-color-defined-p "lightyellow")
7554 ;;; "light yellow"))))
7555 ;;; ((eq background 'dark)
7556 ;;; (set-face-background 'font-lock-other-emphasized-face
7557 ;;; (if (x-color-defined-p "navy")
7559 ;;; (if (x-color-defined-p "darkgreen")
7561 ;;; "dark green"))))
7562 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
7563 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
7564 ;;; (copy-face 'bold 'font-lock-emphasized-face)
7566 ;;; ((eq background 'light)
7567 ;;; (set-face-background 'font-lock-emphasized-face
7568 ;;; (if (x-color-defined-p "lightyellow2")
7570 ;;; "lightyellow")))
7571 ;;; ((eq background 'dark)
7572 ;;; (set-face-background 'font-lock-emphasized-face
7573 ;;; (if (x-color-defined-p "navy")
7575 ;;; (if (x-color-defined-p "darkgreen")
7577 ;;; "dark green"))))
7578 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
7579 (if (cperl-is-face 'font-lock-variable-name-face) nil
7580 (copy-face 'italic 'font-lock-variable-name-face))
7581 (if (cperl-is-face 'font-lock-constant-face) nil
7582 (copy-face 'italic 'font-lock-constant-face))))
7583 (setq cperl-faces-init t))
7584 (error (message "cperl-init-faces (ignored): %s" errs))))
7587 (defun cperl-ps-print-init ()
7588 "Initialization of `ps-print' components for faces used in CPerl."
7589 (eval-after-load "ps-print"
7590 '(setq ps-bold-faces
7591 ;; font-lock-variable-name-face
7592 ;; font-lock-constant-face
7593 (append '(cperl-array-face
7597 ;; font-lock-constant-face
7598 (append '(cperl-nonoverridable-face
7602 ;; font-lock-type-face
7603 (append '(cperl-array-face
7606 cperl-nonoverridable-face)
7607 ps-underlined-faces))))
7609 (defvar ps-print-face-extension-alist)
7611 (defun cperl-ps-print (&optional file)
7612 "Pretty-print in CPerl style.
7613 If optional argument FILE is an empty string, prints to printer, otherwise
7614 to the file FILE. If FILE is nil, prompts for a file name.
7616 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
7619 (setq file (read-from-minibuffer
7620 "Print to file (if empty - to printer): "
7621 (concat (buffer-file-name) ".ps")
7622 nil nil 'file-name-history)))
7623 (or (> (length file) 0)
7625 (require 'ps-print) ; To get ps-print-face-extension-alist
7626 (let ((ps-print-color-p t)
7627 (ps-print-face-extension-alist ps-print-face-extension-alist))
7628 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
7629 (ps-print-buffer-with-faces file)))
7631 ;;; (defun cperl-ps-print-init ()
7632 ;;; "Initialization of `ps-print' components for faces used in CPerl."
7633 ;;; ;; Guard against old versions
7634 ;;; (defvar ps-underlined-faces nil)
7635 ;;; (defvar ps-bold-faces nil)
7636 ;;; (defvar ps-italic-faces nil)
7637 ;;; (setq ps-bold-faces
7638 ;;; (append '(font-lock-emphasized-face
7639 ;;; cperl-array-face
7640 ;;; font-lock-keyword-face
7641 ;;; font-lock-variable-name-face
7642 ;;; font-lock-constant-face
7643 ;;; font-lock-reference-face
7644 ;;; font-lock-other-emphasized-face
7645 ;;; cperl-hash-face)
7647 ;;; (setq ps-italic-faces
7648 ;;; (append '(cperl-nonoverridable-face
7649 ;;; font-lock-constant-face
7650 ;;; font-lock-reference-face
7651 ;;; font-lock-other-emphasized-face
7652 ;;; cperl-hash-face)
7653 ;;; ps-italic-faces))
7654 ;;; (setq ps-underlined-faces
7655 ;;; (append '(font-lock-emphasized-face
7656 ;;; cperl-array-face
7657 ;;; font-lock-other-emphasized-face
7659 ;;; cperl-nonoverridable-face font-lock-type-face)
7660 ;;; ps-underlined-faces))
7661 ;;; (cons 'font-lock-type-face ps-underlined-faces))
7664 (if (cperl-enable-font-lock) (cperl-windowed-init))
7666 (defconst cperl-styles-entries
7667 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
7668 cperl-label-offset cperl-extra-newline-before-brace
7669 cperl-merge-trailing-else
7670 cperl-continued-statement-offset))
7672 (defconst cperl-style-alist
7673 '(("CPerl" ; =GNU without extra-newline-before-brace
7674 (cperl-indent-level . 2)
7675 (cperl-brace-offset . 0)
7676 (cperl-continued-brace-offset . 0)
7677 (cperl-label-offset . -2)
7678 (cperl-extra-newline-before-brace . nil)
7679 (cperl-merge-trailing-else . t)
7680 (cperl-continued-statement-offset . 2))
7681 ("PerlStyle" ; CPerl with 4 as indent
7682 (cperl-indent-level . 4)
7683 (cperl-brace-offset . 0)
7684 (cperl-continued-brace-offset . 0)
7685 (cperl-label-offset . -4)
7686 (cperl-extra-newline-before-brace . nil)
7687 (cperl-merge-trailing-else . t)
7688 (cperl-continued-statement-offset . 4))
7690 (cperl-indent-level . 2)
7691 (cperl-brace-offset . 0)
7692 (cperl-continued-brace-offset . 0)
7693 (cperl-label-offset . -2)
7694 (cperl-extra-newline-before-brace . t)
7695 (cperl-merge-trailing-else . nil)
7696 (cperl-continued-statement-offset . 2))
7698 (cperl-indent-level . 5)
7699 (cperl-brace-offset . 0)
7700 (cperl-continued-brace-offset . -5)
7701 (cperl-label-offset . -5)
7702 ;;(cperl-extra-newline-before-brace . nil) ; ???
7703 (cperl-merge-trailing-else . nil)
7704 (cperl-continued-statement-offset . 5))
7706 (cperl-indent-level . 4)
7707 (cperl-brace-offset . 0)
7708 (cperl-continued-brace-offset . -4)
7709 (cperl-label-offset . -4)
7710 ;;(cperl-extra-newline-before-brace . nil) ; ???
7711 (cperl-continued-statement-offset . 4))
7713 (cperl-indent-level . 4)
7714 (cperl-brace-offset . 0)
7715 (cperl-continued-brace-offset . -4)
7716 (cperl-label-offset . -4)
7717 (cperl-continued-statement-offset . 4)
7718 (cperl-merge-trailing-else . nil)
7719 (cperl-extra-newline-before-brace . t))
7722 (cperl-indent-level . 4)
7723 (cperl-brace-offset . 0)
7724 (cperl-continued-brace-offset . 0)
7725 (cperl-label-offset . -4)
7726 ;;(cperl-extra-newline-before-brace . nil) ; ???
7727 (cperl-continued-statement-offset . 4)))
7728 "(Experimental) list of variables to set to get a particular indentation style.
7729 Should be used via `cperl-set-style' or via Perl menu.")
7731 (defun cperl-set-style (style)
7732 "Set CPerl mode variables to use one of several different indentation styles.
7733 The arguments are a string representing the desired style.
7734 The list of styles is in `cperl-style-alist', available styles
7735 are GNU, K&R, BSD, C++ and Whitesmith.
7737 The current value of style is memorized (unless there is a memorized
7738 data already), may be restored by `cperl-set-style-back'.
7740 Chosing \"Current\" style will not change style, so this may be used for
7741 side-effect of memorizing only."
7743 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
7744 cperl-style-alist)))
7745 (list (completing-read "Enter style: " list nil 'insist))))
7747 (setq cperl-old-style
7750 (cons name (eval name))))
7751 cperl-styles-entries)))
7752 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
7754 (setq setting (car style) style (cdr style))
7755 (set (car setting) (cdr setting)))))
7757 (defun cperl-set-style-back ()
7758 "Restore a style memorised by `cperl-set-style'."
7760 (or cperl-old-style (error "The style was not changed"))
7762 (while cperl-old-style
7763 (setq setting (car cperl-old-style)
7764 cperl-old-style (cdr cperl-old-style))
7765 (set (car setting) (cdr setting)))))
7767 (defun cperl-check-syntax ()
7769 (require 'mode-compile)
7770 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
7771 (eval '(mode-compile)))) ; Avoid a warning
7773 (defun cperl-info-buffer (type)
7774 ;; Returns buffer with documentation. Creates if missing.
7775 ;; If TYPE, this vars buffer.
7776 ;; Special care is taken to not stomp over an existing info buffer
7777 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
7778 (info (get-buffer bname))
7779 (oldbuf (get-buffer "*info*")))
7781 (save-window-excursion
7786 (rename-buffer "*info-perl-tmp*")))
7787 (save-window-excursion
7789 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
7790 (set-buffer "*info*")
7791 (rename-buffer bname)
7793 (set-buffer "*info-perl-tmp*")
7794 (rename-buffer "*info*")
7795 (set-buffer bname)))
7796 (make-local-variable 'window-min-height)
7797 (setq window-min-height 2)
7798 (current-buffer)))))
7800 (defun cperl-word-at-point (&optional p)
7801 "Return the word at point or at P."
7803 (if p (goto-char p))
7804 (or (cperl-word-at-point-hard)
7807 (funcall (or (and (boundp 'find-tag-default-function)
7808 find-tag-default-function)
7809 (get major-mode 'find-tag-default-function)
7810 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
7811 ;; automatically used within `find-tag-default':
7812 'find-tag-default))))))
7814 (defun cperl-info-on-command (command)
7815 "Show documentation for Perl command COMMAND in other window.
7816 If perl-info buffer is shown in some frame, uses this frame.
7817 Customized by setting variables `cperl-shrink-wrap-info-frame',
7818 `cperl-max-help-size'."
7820 (let* ((default (cperl-word-at-point))
7822 (format "Find doc for Perl function (default %s): "
7824 (list (if (equal read "")
7828 (let ((buffer (current-buffer))
7829 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
7830 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
7831 max-height char-height buf-list)
7832 (if (string-match "^-[a-zA-Z]$" command)
7833 (setq cmd-desc "^-X[ \t\n]"))
7834 (setq isvar (string-match "^[$@%]" command)
7835 buf (cperl-info-buffer isvar)
7836 iniwin (selected-window)
7837 fr1 (window-frame iniwin))
7839 (goto-char (point-min))
7841 (progn (re-search-forward "^-X[ \t\n]")
7843 (if (re-search-forward cmd-desc nil t)
7845 ;; Go back to beginning of the group (ex, for qq)
7846 (if (re-search-backward "^[ \t\n\f]")
7851 buf-list (list buf "*info-perl-var*" "*info-perl*"))
7852 (while (and (not win) buf-list)
7853 (setq win (get-buffer-window (car buf-list) t))
7854 (setq buf-list (cdr buf-list)))
7856 (eq (window-buffer win) buf)
7857 (set-window-buffer win buf))
7858 (and win (setq fr2 (window-frame win)))
7859 (if (or (not fr2) (eq fr1 fr2))
7861 (special-display-popup-frame buf) ; Make it visible
7862 (select-window win))
7863 (goto-char pos) ; Needed (?!).
7865 (setq iniheight (window-height)
7866 frheight (frame-height)
7867 not-loner (< iniheight (1- frheight))) ; Are not alone
7868 (cond ((if not-loner cperl-max-help-size
7869 cperl-shrink-wrap-info-frame)
7875 (if (re-search-forward
7876 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
7877 (match-beginning 0) (point-max)))))
7880 (/ (* (- frheight 3) cperl-max-help-size) 100)
7881 (setq char-height (frame-char-height))
7882 ;; Non-functioning under OS/2:
7883 (if (eq char-height 1) (setq char-height 18))
7884 ;; Title, menubar, + 2 for slack
7885 (- (/ (x-display-pixel-height) char-height) 4)))
7886 (if (> height max-height) (setq height max-height))
7887 ;;(message "was %s doing %s" iniheight height)
7889 (enlarge-window (- height iniheight))
7890 (set-frame-height (window-frame win) (1+ height)))))
7891 (set-window-start (selected-window) pos))
7892 (message "No entry for %s found." command))
7893 ;;(pop-to-buffer buffer)
7894 (select-window iniwin)))
7896 (defun cperl-info-on-current-command ()
7897 "Show documentation for Perl command at point in other window."
7899 (cperl-info-on-command (cperl-word-at-point)))
7901 (defun cperl-imenu-info-imenu-search ()
7902 (if (looking-at "^-X[ \t\n]") nil
7904 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
7907 (defun cperl-imenu-info-imenu-name ()
7909 (match-beginning 1) (match-end 1)))
7911 (defun cperl-imenu-on-info ()
7912 "Shows imenu for Perl Info Buffer.
7913 Opens Perl Info buffer if needed."
7915 (let* ((buffer (current-buffer))
7916 imenu-create-index-function
7917 imenu-prev-index-position-function
7918 imenu-extract-index-name-function
7919 (index-item (save-restriction
7920 (save-window-excursion
7921 (set-buffer (cperl-info-buffer nil))
7922 (setq imenu-create-index-function
7923 'imenu-default-create-index-function
7924 imenu-prev-index-position-function
7925 'cperl-imenu-info-imenu-search
7926 imenu-extract-index-name-function
7927 'cperl-imenu-info-imenu-name)
7928 (imenu-choose-buffer-index)))))
7932 (pop-to-buffer "*info-perl*")
7934 ((markerp (cdr index-item))
7935 (goto-char (marker-position (cdr index-item))))
7937 (goto-char (cdr index-item))))
7938 (set-window-start (selected-window) (point))
7939 (pop-to-buffer buffer)))))
7941 (defun cperl-lineup (beg end &optional step minshift)
7942 "Lineup construction in a region.
7943 Beginning of region should be at the start of a construction.
7944 All first occurrences of this construction in the lines that are
7945 partially contained in the region are lined up at the same column.
7947 MINSHIFT is the minimal amount of space to insert before the construction.
7948 STEP is the tabwidth to position constructions.
7949 If STEP is nil, `cperl-lineup-step' will be used
7950 \(or `cperl-indent-level', if `cperl-lineup-step' is `nil').
7951 Will not move the position at the start to the left."
7953 (let (search col tcol seen b)
7957 (setq end (point-marker))
7959 (skip-chars-forward " \t\f")
7960 (setq beg (point-marker))
7961 (indent-region beg end nil)
7963 (setq col (current-column))
7964 (if (looking-at "[a-zA-Z0-9_]")
7965 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
7969 (buffer-substring (match-beginning 0)
7970 (match-end 0))) "\\>"))
7971 (error "Cannot line up in a middle of the word"))
7972 (if (looking-at "$")
7973 (error "Cannot line up end of line"))
7974 (setq search (regexp-quote (char-to-string (following-char)))))
7975 (setq step (or step cperl-lineup-step cperl-indent-level))
7976 (or minshift (setq minshift 1))
7978 (beginning-of-line 2)
7979 (and (< (point) end)
7980 (re-search-forward search end t)
7981 (goto-char (match-beginning 0))))
7982 (setq tcol (current-column) seen t)
7983 (if (> tcol col) (setq col tcol)))
7985 (error "The construction to line up occurred only once"))
7987 (setq col (+ col minshift))
7988 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
7991 (cperl-make-indent col)
7992 (beginning-of-line 2)
7993 (and (< (point) end)
7994 (re-search-forward search end t)
7995 (goto-char (match-beginning 0)))))))) ; No body
7997 (defun cperl-etags (&optional add all files) ;; NOT USED???
7998 "Run etags with appropriate options for Perl files.
7999 If optional argument ALL is `recursive', will process Perl files
8000 in subdirectories too."
8003 (args '("-l" "none" "-r"
8004 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
8005 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
8007 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
8009 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
8011 (if add (setq args (cons "-a" args)))
8012 (or files (setq files (list buffer-file-name)))
8014 ((eq all 'recursive)
8015 ;;(error "Not implemented: recursive")
8016 (setq args (append (list "-e"
8017 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
8019 find(\\&wanted, '.');
8024 ;;(error "Not implemented: all")
8025 (setq args (append (list "-e"
8026 "push @ARGV, <*.PL *.pl *.pm>;
8031 (setq args (append args files))))
8032 (setq res (apply 'call-process cmd nil nil nil args))
8034 (message "etags returned \"%s\"" res))))
8036 (defun cperl-toggle-auto-newline ()
8037 "Toggle the state of `cperl-auto-newline'."
8039 (setq cperl-auto-newline (not cperl-auto-newline))
8040 (message "Newlines will %sbe auto-inserted now."
8041 (if cperl-auto-newline "" "not ")))
8043 (defun cperl-toggle-abbrev ()
8044 "Toggle the state of automatic keyword expansion in CPerl mode."
8046 (abbrev-mode (if abbrev-mode 0 1))
8047 (message "Perl control structure will %sbe auto-inserted now."
8048 (if abbrev-mode "" "not ")))
8051 (defun cperl-toggle-electric ()
8052 "Toggle the state of parentheses doubling in CPerl mode."
8054 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
8055 (message "Parentheses will %sbe auto-doubled now."
8056 (if (cperl-val 'cperl-electric-parens) "" "not ")))
8058 (defun cperl-toggle-autohelp ()
8059 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
8060 Delay of auto-help controlled by `cperl-lazy-help-time'."
8062 (if (fboundp 'run-with-idle-timer)
8064 (if cperl-lazy-installed
8065 (cperl-lazy-unstall)
8066 (cperl-lazy-install))
8067 (message "Perl help messages will %sbe automatically shown now."
8068 (if cperl-lazy-installed "" "not ")))
8069 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
8071 (defun cperl-toggle-construct-fix ()
8072 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
8074 (setq cperl-indent-region-fix-constructs
8075 (if cperl-indent-region-fix-constructs
8078 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
8079 (if cperl-indent-region-fix-constructs "" "not ")))
8081 (defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
8082 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
8083 Nonpositive numeric argument disables debugging messages. The message
8084 summarizes which regions it was decided to rescan for syntactic constructs.
8086 The message looks like this:
8088 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
8090 Numbers are character positions in the buffer. REQ provides the range to
8091 rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
8092 for correct operation it should start and end outside any special syntactic
8093 construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
8097 (setq arg (if (eq cperl-syntaxify-by-font-lock
8098 (if backtrace 'backtrace 'message)) 0 1)))
8099 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
8100 (setq cperl-syntaxify-by-font-lock arg)
8101 (message "Debugging messages of syntax unwind %sabled."
8102 (if (eq arg t) "dis" "en")))
8104 ;;;; Tags file creation.
8106 (defvar cperl-tmp-buffer " *cperl-tmp*")
8108 (defun cperl-setup-tmp-buf ()
8109 (set-buffer (get-buffer-create cperl-tmp-buffer))
8110 (set-syntax-table cperl-mode-syntax-table)
8111 (buffer-disable-undo)
8113 (if cperl-use-syntax-table-text-property-for-tags
8115 (make-local-variable 'parse-sexp-lookup-properties)
8116 ;; Do not introduce variable if not needed, we check it!
8117 (set 'parse-sexp-lookup-properties t))))
8119 (defun cperl-xsub-scan ()
8122 (let ((index-alist '())
8123 (prev-pos 0) index index1 name package prefix)
8124 (goto-char (point-min))
8126 (message "Scanning XSUB for index")
8127 (imenu-progress-message prev-pos 0))
8128 ;; Search for the function
8129 (progn ;;save-match-data
8130 (while (re-search-forward
8131 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
8134 (imenu-progress-message prev-pos))
8136 ((match-beginning 2) ; SECTION
8137 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
8138 (goto-char (match-beginning 0))
8139 (skip-chars-forward " \t")
8141 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
8142 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
8144 ((not package) nil) ; C language section
8145 ((match-beginning 3) ; XSUB
8146 (goto-char (1+ (match-beginning 3)))
8147 (setq index (imenu-example--name-and-position))
8148 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
8149 (if (and prefix (string-match (concat "^" prefix) name))
8150 (setq name (substring name (length prefix))))
8151 (cond ((string-match "::" name) nil)
8153 (setq index1 (cons (concat package "::" name) (cdr index)))
8154 (push index1 index-alist)))
8156 (push index index-alist))
8158 ;; (beginning-of-line)
8159 (setq index (imenu-example--name-and-position))
8160 (setcar index (concat package "::BOOT:"))
8161 (push index index-alist)))))
8163 (imenu-progress-message prev-pos 100))
8166 (defvar cperl-unreadable-ok nil)
8168 (defun cperl-find-tags (ifile xs topdir)
8169 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
8170 (cperl-pod-here-fontify nil) f file)
8172 (if b (set-buffer b)
8173 (cperl-setup-tmp-buf))
8176 (setq file (car (insert-file-contents ifile)))
8177 (error (if cperl-unreadable-ok nil
8179 (format "File %s unreadable. Continue? " ifile))
8180 (setq cperl-unreadable-ok t)
8181 (error "Aborting: unreadable file %s" ifile)))))
8183 (message "Unreadable file %s" ifile)
8184 (message "Scanning file %s ..." file)
8185 (if (and cperl-use-syntax-table-text-property-for-tags
8187 (condition-case err ; after __END__ may have garbage
8188 (cperl-find-pods-heres nil nil noninteractive)
8189 (error (message "While scanning for syntax: %s" err))))
8191 (setq lst (cperl-xsub-scan))
8192 (setq ind (cperl-imenu--create-perl-index))
8193 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
8198 (cond ((string-match "^[_a-zA-Z]" (car elt))
8199 (goto-char (cdr elt))
8200 (beginning-of-line) ; pos should be of the start of the line
8203 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
8204 (buffer-substring (progn
8205 (goto-char (cdr elt))
8206 ;; After name now...
8207 (or (eolp) (forward-char 1))
8215 (setq elt (car lst) lst (cdr lst))
8220 (if (string-match "^package " (car elt))
8221 (substring (car elt) 8)
8224 (number-to-string (elt elt 2)) ; Line
8226 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
8228 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
8229 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
8231 ;; Need to insert the name without package as well
8232 (setq lst (cons (cons (substring (elt elt 3)
8240 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
8241 (set-text-properties 0 (length rel) nil rel)
8242 (and (equal topdir (substring rel 0 (length topdir)))
8243 (setq rel (substring file (length topdir))))
8244 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
8245 (setq ret (buffer-substring 1 (point-max)))
8248 (message "Scanning file %s finished" file))
8251 (defun cperl-add-tags-recurse-noxs ()
8252 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
8254 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
8255 -f cperl-add-tags-recurse-noxs
8257 (cperl-write-tags nil nil t t nil t))
8259 (defun cperl-add-tags-recurse-noxs-fullpath ()
8260 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
8261 Writes down fullpath, so TAGS is relocatable (but if the build directory
8262 is relocated, the file TAGS inside it breaks). Use as
8263 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
8264 -f cperl-add-tags-recurse-noxs-fullpath
8266 (cperl-write-tags nil nil t t nil t ""))
8268 (defun cperl-add-tags-recurse ()
8269 "Add to TAGS file data for Perl files in the current directory and kids.
8271 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
8272 -f cperl-add-tags-recurse
8274 (cperl-write-tags nil nil t t))
8276 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
8277 ;; If INBUFFER, do not select buffer, and do not save
8278 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
8281 (setq file (if dir default-directory (buffer-file-name)))
8282 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
8284 (setq topdir default-directory))
8285 (let ((tags-file-name "TAGS")
8286 (case-fold-search (eq system-type 'emx))
8289 (cond (inbuffer nil) ; Already there
8290 ((file-exists-p tags-file-name)
8292 (visit-tags-table-buffer)
8293 (visit-tags-table-buffer tags-file-name)))
8294 (t (set-buffer (find-file-noselect tags-file-name))))
8297 (cond ((eq erase 'ignore))
8300 (setq erase 'ignore)))
8303 (directory-files file t
8304 (if recurse nil cperl-scan-files-regexp)
8307 (if cperl-unreadable-ok nil
8309 (format "Directory %s unreadable. Continue? " file))
8310 (setq cperl-unreadable-ok t
8311 tm nil) ; Return empty list
8312 (error "Aborting: unreadable directory %s" file)))))))
8316 ((string-match cperl-noscan-files-regexp file)
8318 ((not (file-directory-p file))
8319 (if (string-match cperl-scan-files-regexp file)
8320 (cperl-write-tags file erase recurse nil t noxs topdir)))
8322 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
8325 (setq xs (string-match "\\.xs$" file))
8326 (if (not (and xs noxs))
8328 (cond ((eq erase 'ignore) (goto-char (point-max)))
8329 (erase (erase-buffer))
8333 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
8334 (set-text-properties 0 (length rel) nil rel)
8335 (and (equal topdir (substring rel 0 (length topdir)))
8336 (setq rel (substring file (length topdir))))
8337 (if (search-forward (concat "\f\n" rel ",") nil t)
8339 (search-backward "\f\n")
8340 (delete-region (point)
8343 (if (search-forward "\f\n"
8347 (goto-char (point-max)))))
8348 (insert (cperl-find-tags file xs topdir))))))
8349 (if inbuffer nil ; Delegate to the caller
8350 (save-buffer 0) ; No backup
8351 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
8352 (initialize-new-tags-table))))))
8354 (defvar cperl-tags-hier-regexp-list
8361 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
8363 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
8366 (defvar cperl-hierarchy '(() ())
8367 "Global hierarchy of classes.")
8369 (defun cperl-tags-hier-fill ()
8370 ;; Suppose we are in a tag table cooked by cperl.
8372 (let (type pack name pos line chunk ord cons1 file str info fileind)
8373 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
8374 (setq pos (match-beginning 0)
8375 pack (match-beginning 2))
8377 (if (looking-at (concat
8386 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
8387 name (buffer-substring (match-beginning 2) (match-end 2))
8388 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
8389 line (buffer-substring (match-beginning 3) (match-end 3))
8392 fileind (format "%s:%s" file line)
8393 ;; Moves to beginning of the next line:
8394 info (cperl-etags-snarf-tag file line))
8397 ;; Make new member of hierarchy name ==> file ==> pos if needed
8398 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
8400 (setcdr cons1 (cons (cons fileind (vector file info))
8402 ;; First occurrence of the name, start alist
8403 (setq cons1 (cons name (list (cons fileind (vector file info)))))
8405 (setcar (cdr cperl-hierarchy)
8406 (cons cons1 (nth 1 cperl-hierarchy)))
8407 (setcar cperl-hierarchy
8408 (cons cons1 (car cperl-hierarchy)))))))
8411 (defun cperl-tags-hier-init (&optional update)
8412 "Show hierarchical menu of classes and methods.
8413 Finds info about classes by a scan of loaded TAGS files.
8414 Supposes that the TAGS files contain fully qualified function names.
8415 One may build such TAGS files from CPerl mode menu."
8419 (if (or update (null (nth 2 cperl-hierarchy)))
8420 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
8423 (setcdr elt (cdr (nth 1 elt)))))))
8424 pack name cons1 to l1 l2 l3 l4 b)
8425 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
8426 (setq cperl-hierarchy (list l1 l2 l3))
8427 (if cperl-xemacs-p ; Not checked
8430 ;; Does this work in XEmacs?
8431 (call-interactively 'visit-tags-table))
8432 (message "Updating list of classes...")
8433 (set-buffer (get-file-buffer tags-file-name))
8434 (cperl-tags-hier-fill))
8436 (call-interactively 'visit-tags-table))
8440 (message "Updating list of classes... %s" tagsfile)
8441 (set-buffer (get-file-buffer tagsfile))
8442 (cperl-tags-hier-fill)))
8444 (message "Updating list of classes... postprocessing..."))
8445 (mapcar remover (car cperl-hierarchy))
8446 (mapcar remover (nth 1 cperl-hierarchy))
8447 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
8448 (cons "Methods: " (car cperl-hierarchy))))
8449 (cperl-tags-treeify to 1)
8450 (setcar (nthcdr 2 cperl-hierarchy)
8451 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
8452 (message "Updating list of classes: done, requesting display...")
8453 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
8455 (or (nth 2 cperl-hierarchy)
8456 (error "No items found"))
8458 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
8459 (if (if (fboundp 'display-popup-menus-p)
8460 (let ((f 'display-popup-menus-p))
8463 (x-popup-menu t (nth 2 cperl-hierarchy))
8465 (tmm-prompt (nth 2 cperl-hierarchy))))
8466 (if (and update (listp update))
8467 (progn (while (cdr update) (setq update (cdr update)))
8468 (setq update (car update)))) ; Get the last from the list
8469 (if (vectorp update)
8471 (find-file (elt update 0))
8472 (cperl-etags-goto-tag-location (elt update 1))))
8473 (if (eq update -999) (cperl-tags-hier-init t)))
8475 (defun cperl-tags-treeify (to level)
8476 ;; cadr of `to' is read-write. On start it is a cons
8477 (let* ((regexp (concat "^\\(" (mapconcat
8479 (make-list level "[_a-zA-Z0-9]+")
8482 (packages (cdr (nth 1 to)))
8483 (methods (cdr (nth 2 to)))
8484 l1 head tail cons1 cons2 ord writeto packs recurse
8485 root-packages root-functions ms many_ms same_name ps
8489 (cond ((and (string-match regexp (car elt))
8490 (or (eq ord 1) (match-end 2)))
8491 (setq head (substring (car elt) 0 (match-end 1))
8492 tail (if (match-end 2) (substring (car elt)
8495 (if (setq cons1 (assoc head writeto)) nil
8496 ;; Need to init new head
8497 (setcdr writeto (cons (list head (list "Packages: ")
8500 (setq cons1 (nth 1 writeto)))
8501 (setq cons2 (nth ord cons1)) ; Either packs or meths
8502 (setcdr cons2 (cons elt (cdr cons2))))
8504 (setq root-functions (cons elt root-functions)))
8506 (setq root-packages (cons elt root-packages))))))))
8507 (setcdr to l1) ; Init to dynamic space
8510 (mapcar move-deeper packages)
8512 (mapcar move-deeper methods)
8514 (mapcar (function (lambda (elt)
8515 (cperl-tags-treeify elt (1+ level))))
8517 ;;Now clean up leaders with one child only
8518 (mapcar (function (lambda (elt)
8519 (if (not (and (listp (cdr elt))
8520 (eq (length elt) 2))) nil
8521 (setcar elt (car (nth 1 elt)))
8522 (setcdr elt (cdr (nth 1 elt))))))
8524 ;; Sort the roots of subtrees
8525 (if (default-value 'imenu-sort-function)
8527 (sort (cdr to) (default-value 'imenu-sort-function))))
8528 ;; Now add back functions removed from display
8529 (mapcar (function (lambda (elt)
8530 (setcdr to (cons elt (cdr to)))))
8531 (if (default-value 'imenu-sort-function)
8533 (sort root-functions (default-value 'imenu-sort-function)))
8535 ;; Now add back packages removed from display
8536 (mapcar (function (lambda (elt)
8537 (setcdr to (cons (cons (concat "package " (car elt))
8540 (if (default-value 'imenu-sort-function)
8542 (sort root-packages (default-value 'imenu-sort-function)))
8546 ;;; '(keymap "Name1"
8550 ;;; ("Tail1" "x") ("Tail2" "y"))))
8552 (defun cperl-list-fold (list name limit)
8553 (let (list1 list2 elt1 (num 0))
8554 (if (<= (length list) limit) list
8555 (setq list1 nil list2 nil)
8560 (if (<= num imenu-max-items)
8561 (setq list2 (cons elt1 list2))
8562 (setq list1 (cons (cons name
8567 (nreverse (cons (cons name
8571 (defun cperl-menu-to-keymap (menu &optional name)
8577 (cond ((listp (cdr elt))
8578 (setq list (cperl-list-fold
8579 (cdr elt) (car elt) imenu-max-items))
8582 (cperl-menu-to-keymap list))))
8584 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
8585 (cperl-list-fold menu "Root" imenu-max-items)))))
8588 (defvar cperl-bad-style-regexp
8589 (mapconcat 'identity
8590 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
8591 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
8593 "Finds places such that insertion of a whitespace may help a lot.")
8595 (defvar cperl-not-bad-style-regexp
8598 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
8599 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
8600 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
8601 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
8602 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
8609 "\\\\[&$@*\\\\]" ; \&func
8612 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
8615 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
8616 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
8617 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
8621 "If matches at the start of match found by `my-bad-c-style-regexp',
8622 insertion of a whitespace will not help.")
8626 (defun cperl-find-bad-style ()
8627 "Find places in the buffer where insertion of a whitespace may help.
8628 Prompts user for insertion of spaces.
8629 Currently it is tuned to C and Perl syntax."
8631 (let (found-bad (p (point)))
8632 (setq last-nonmenu-event 13) ; To disable popup
8633 (goto-char (point-min))
8634 (map-y-or-n-p "Insert space here? "
8635 (lambda (arg) (insert " "))
8636 'cperl-next-bad-style
8637 '("location" "locations" "insert a space into")
8638 '((?\C-r (lambda (arg)
8639 (let ((buffer-quit-function
8640 'exit-recursive-edit))
8641 (message "Exit with Esc Esc")
8643 t)) ; Consider acted upon
8644 "edit, exit with Esc Esc")
8646 (let ((buffer-quit-function
8647 'exit-recursive-edit))
8648 (message "Exit with Esc Esc")
8650 t)) ; Consider acted upon
8651 "edit, exit with Esc Esc"))
8653 (if found-bad (goto-char found-bad)
8655 (message "No appropriate place found"))))
8657 (defun cperl-next-bad-style ()
8658 (let (p (not-found t) (point (point)) found)
8659 (while (and not-found
8660 (re-search-forward cperl-bad-style-regexp nil 'to-end))
8662 (goto-char (match-beginning 0))
8664 (looking-at cperl-not-bad-style-regexp)
8665 ;; Check for a < -b and friends
8666 (and (eq (following-char) ?\-)
8668 (skip-chars-backward " \t\n")
8669 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
8670 ;; Now check for syntax type
8672 (setq found (point))
8673 (beginning-of-defun)
8674 (let ((pps (parse-partial-sexp (point) found)))
8675 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
8676 (goto-char (match-end 0))
8684 (defvar cperl-have-help-regexp
8688 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
8689 "[$@]\\^[a-zA-Z]" ; Special variable
8690 "[$@][^ \n\t]" ; Special variable
8691 "-[a-zA-Z]" ; File test
8692 "\\\\[a-zA-Z0]" ; Special chars
8693 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
8694 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
8695 "[a-zA-Z_0-9:]+" ; symbol or number
8702 "Matches places in the buffer we can find help for.")
8704 (defvar cperl-message-on-help-error t)
8705 (defvar cperl-help-from-timer nil)
8707 (defun cperl-word-at-point-hard ()
8708 ;; Does not save-excursion
8709 ;; Get to the something meaningful
8710 (or (eobp) (eolp) (forward-char 1))
8711 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
8712 (save-excursion (beginning-of-line) (point))
8715 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
8716 ;; (skip-chars-backward " \n\t\r({[]});,")
8717 ;; (or (bobp) (backward-char 1))))
8720 ((looking-at "[a-zA-Z0-9_:]") ; symbol
8721 (skip-chars-backward "a-zA-Z0-9_:")
8723 ((and (eq (preceding-char) ?^) ; $^I
8724 (eq (char-after (- (point) 2)) ?\$))
8726 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
8728 ((and (eq (preceding-char) ?\=)
8729 (eq (current-column) 1))
8730 (forward-char -1))) ; =head1
8731 (if (and (eq (preceding-char) ?\<)
8732 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
8734 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
8736 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
8738 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
8739 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
8741 ((and (eq (preceding-char) ?\$)
8742 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
8744 ((and (eq (following-char) ?\>)
8745 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
8748 (and (eq (preceding-char) ?\<)
8749 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
8750 (search-backward "<"))))
8751 ((and (eq (following-char) ?\$)
8752 (eq (preceding-char) ?\<)
8753 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
8755 (if (looking-at cperl-have-help-regexp)
8756 (buffer-substring (match-beginning 0) (match-end 0))))
8758 (defun cperl-get-help ()
8759 "Get one-line docs on the symbol at the point.
8760 The data for these docs is a little bit obsolete and may be in fact longer
8761 than a line. Your contribution to update/shorten it is appreciated."
8763 (save-match-data ; May be called "inside" query-replace
8765 (let ((word (cperl-word-at-point-hard)))
8767 (if (and cperl-help-from-timer ; Bail out if not in mainland
8768 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
8769 (or (memq (get-text-property (point) 'face)
8770 '(font-lock-comment-face font-lock-string-face))
8771 (memq (get-text-property (point) 'syntax-type)
8772 '(pod here-doc format))))
8774 (cperl-describe-perl-symbol word))
8775 (if cperl-message-on-help-error
8776 (message "Nothing found for %s..."
8777 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
8779 ;;; Stolen from perl-descr.el by Johan Vromans:
8781 (defvar cperl-doc-buffer " *perl-doc*"
8782 "Where the documentation can be found.")
8784 (defun cperl-describe-perl-symbol (val)
8785 "Display the documentation of symbol at point, a Perl operator."
8786 (let ((enable-recursive-minibuffers t)
8789 ((string-match "^[&*][a-zA-Z_]" val)
8790 (setq val (concat (substring val 0 1) "NAME")))
8791 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
8792 (setq val (concat "@" (substring val 1 (match-end 1)))))
8793 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
8794 (setq val (concat "%" (substring val 1 (match-end 1)))))
8795 ((and (string= val "x") (string-match "^x=" val))
8797 ((string-match "^\\$[\C-a-\C-z]" val)
8798 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
8799 ((string-match "^CORE::" val)
8800 (setq val "CORE::"))
8801 ((string-match "^SUPER::" val)
8802 (setq val "SUPER::"))
8803 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
8804 (setq val "<NAME>")))
8805 (setq regexp (concat "^"
8806 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
8808 "\\([ \t([/]\\|$\\)"))
8810 ;; get the buffer with the documentation text
8811 (cperl-switch-to-doc-buffer)
8813 ;; lookup in the doc
8814 (goto-char (point-min))
8815 (let ((case-fold-search nil))
8817 (if (re-search-forward regexp (point-max) t)
8819 (beginning-of-line 1)
8820 (let ((lnstart (point)))
8822 (message "%s" (buffer-substring lnstart (point)))))
8823 (if cperl-message-on-help-error
8824 (message "No definition for %s" val)))))))
8826 (defvar cperl-short-docs 'please-ignore-this-line
8827 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
8830 (defun cperl-switch-to-doc-buffer ()
8831 "Go to the perl documentation buffer and insert the documentation."
8833 (let ((buf (get-buffer-create cperl-doc-buffer)))
8835 (switch-to-buffer-other-window buf)
8837 (if (= (buffer-size) 0)
8839 (insert (documentation-property 'cperl-short-docs
8840 'variable-documentation))
8841 (setq buffer-read-only t)))))
8843 (defun cperl-beautify-regexp-piece (b e embed level)
8844 ;; b is before the starting delimiter, e before the ending
8845 ;; e should be a marker, may be changed, but remains "correct".
8846 ;; EMBED is nil iff we process the whole REx.
8847 ;; The REx is guaranteed to have //x
8848 ;; LEVEL shows how many levels deep to go
8849 ;; position at enter and at leave is not defined
8850 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
8854 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
8858 ((looking-at "(\\?[^a-zA-Z]")
8860 ((looking-at "(\\?") ; (?i)
8864 (setq c (if embed (current-indentation) (1- (current-column)))
8865 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
8866 (or (looking-at "[ \t]*[\n#]")
8871 (if (re-search-forward "[^ \t]" e t)
8872 (progn ; Something before the ending delimiter
8874 (delete-horizontal-space)
8876 (cperl-make-indent c)
8877 (set-marker e (point))))
8880 (while (< (point) (marker-position e))
8884 (skip-chars-forward " \t")
8885 (delete-region s (point))
8886 (cperl-make-indent c1)
8890 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
8891 "\\|" ; Embedded variable
8892 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
8895 "\\|" ; simple-code simple-code*?
8896 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
8900 "\\((\\(\\?\\)?\\)" ; 7 8
8903 (goto-char (match-end 0))
8905 (cond ((match-beginning 1) ; Alphanum word + junk
8907 ((or (match-beginning 3) ; $ab[12]
8908 (and (match-beginning 5) ; X* X+ X{2,3}
8909 (eq (preceding-char) ?\{)))
8912 ((and ; [], already syntaxified
8915 cperl-use-syntax-table-text-property)
8918 (or (eq (preceding-char) ?\])
8919 (error "[]-group not terminated"))
8921 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8922 ((match-beginning 6) ; []
8924 (if (looking-at "\\^?\\]")
8925 (goto-char (match-end 0)))
8926 ;; XXXX POSIX classes?!
8927 (while (and (not pos)
8928 (re-search-forward "\\[:\\|\\]" e t))
8929 (if (eq (preceding-char) ?:)
8930 (or (re-search-forward ":\\]" e t)
8931 (error "[:POSIX:]-group in []-group not terminated"))
8933 (or (eq (preceding-char) ?\])
8934 (error "[]-group not terminated"))
8936 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
8937 ((match-beginning 7) ; ()
8938 (goto-char (match-beginning 0))
8939 (setq pos (current-column))
8942 (delete-horizontal-space)
8944 (cperl-make-indent c1)))
8947 ;; (or (forward-sexp 1)
8950 ;; (error "()-group not terminated")))
8951 (set-marker m (1- (point)))
8952 (set-marker m1 (point))
8954 (if (progn ; indent rigidly if multiline
8955 ;; In fact does not make a lot of sense, since
8956 ;; the starting position can be already lost due
8957 ;; to insertion of "\n" and " "
8959 (search-forward "\n" m1 t))
8960 (indent-rigidly (point) m1 (- c1 pos)))
8961 (setq level (1- level))
8963 ((not (match-beginning 8))
8964 (cperl-beautify-regexp-piece tmp m t level))
8965 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8967 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8968 (goto-char (+ 2 tmp))
8970 (cperl-beautify-regexp-piece (point) m t level))
8971 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8972 (goto-char (+ 3 tmp))
8973 (cperl-beautify-regexp-piece (point) m t level))
8975 (cperl-beautify-regexp-piece tmp m t level))))
8977 (cond ((looking-at "[*+?]\\??")
8978 (goto-char (match-end 0)))
8979 ((eq (following-char) ?\{)
8981 (if (eq (following-char) ?\?)
8983 (skip-chars-forward " \t")
8985 (if (looking-at "[#\n]")
8987 (or (eolp) (indent-for-comment))
8988 (beginning-of-line 2))
8989 (delete-horizontal-space)
8993 ((match-beginning 9) ; |
8997 (if (re-search-forward "[^ \t]" tmp t)
9000 (delete-horizontal-space)
9003 (delete-region (point) tmp))
9004 (cperl-make-indent c)
9006 (skip-chars-forward " \t")
9008 (if (looking-at "[#\n]")
9009 (beginning-of-line 2)
9010 (delete-horizontal-space)
9014 (or (looking-at "[ \t\n]")
9017 (skip-chars-forward " \t"))
9018 (or (looking-at "[#\n]")
9019 (error "Unknown code `%s' in a regexp"
9020 (buffer-substring (point) (1+ (point)))))
9021 (and inline (end-of-line 2)))
9022 ;; Special-case the last line of group
9023 (if (and (>= (point) (marker-position e))
9024 (/= (current-indentation) c))
9027 (cperl-make-indent c)))))
9029 (defun cperl-make-regexp-x ()
9030 ;; Returns position of the start
9031 ;; XXX this is called too often! Need to cache the result!
9033 (or cperl-use-syntax-table-text-property
9034 (error "I need to have a regexp marked!"))
9036 (if (looking-at "\\s|")
9038 (if (looking-at "\\([smy]\\|qr\\)\\s|")
9040 (re-search-backward "\\s|"))) ; Assume it is scanned already.
9042 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
9043 (sub-p (eq (preceding-char) ?s)) s)
9045 (set-marker e (1- (point)))
9046 (setq delim (preceding-char))
9047 (if (and sub-p (eq delim (char-after (- (point) 2))))
9048 (error "Possible s/blah// - do not know how to deal with"))
9049 (if sub-p (forward-sexp 1))
9050 (if (looking-at "\\sw*x")
9053 ;; Protect fragile " ", "#"
9056 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
9062 (defun cperl-beautify-regexp (&optional deep)
9063 "Do it. (Experimental, may change semantics, recheck the result.)
9064 We suppose that the regexp is scanned already."
9066 (setq deep (if deep (prefix-numeric-value deep) -1))
9068 (goto-char (cperl-make-regexp-x))
9069 (let ((b (point)) (e (make-marker)))
9071 (set-marker e (1- (point)))
9072 (cperl-beautify-regexp-piece b e nil deep))))
9074 (defun cperl-regext-to-level-start ()
9075 "Goto start of an enclosing group in regexp.
9076 We suppose that the regexp is scanned already."
9078 (let ((limit (cperl-make-regexp-x)) done)
9080 (or (eq (following-char) ?\()
9081 (search-backward "(" (1+ limit) t)
9082 (error "Cannot find `(' which starts a group"))
9085 (skip-chars-backward "\\")
9086 (looking-at "\\(\\\\\\\\\\)*(")))
9087 (or done (forward-char -1)))))
9089 (defun cperl-contract-level ()
9090 "Find an enclosing group in regexp and contract it.
9091 \(Experimental, may change semantics, recheck the result.)
9092 We suppose that the regexp is scanned already."
9094 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
9095 (cperl-regext-to-level-start)
9096 (let ((b (point)) (e (make-marker)) c)
9098 (set-marker e (1- (point)))
9100 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
9102 ((match-beginning 1) ; #-comment
9103 (or c (setq c (current-indentation)))
9104 (beginning-of-line 2) ; Skip
9105 (cperl-make-indent c))
9108 (just-one-space))))))
9110 (defun cperl-contract-levels ()
9111 "Find an enclosing group in regexp and contract all the kids.
9112 \(Experimental, may change semantics, recheck the result.)
9113 We suppose that the regexp is scanned already."
9117 (cperl-regext-to-level-start)
9118 (error ; We are outside outermost group
9119 (goto-char (cperl-make-regexp-x))))
9120 (let ((b (point)) (e (make-marker)) s c)
9122 (set-marker e (1- (point)))
9124 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
9126 ((match-beginning 1) ; Skip
9129 (cperl-contract-level)))))))
9131 (defun cperl-beautify-level (&optional deep)
9132 "Find an enclosing group in regexp and beautify it.
9133 \(Experimental, may change semantics, recheck the result.)
9134 We suppose that the regexp is scanned already."
9136 (setq deep (if deep (prefix-numeric-value deep) -1))
9138 (cperl-regext-to-level-start)
9139 (let ((b (point)) (e (make-marker)))
9141 (set-marker e (1- (point)))
9142 (cperl-beautify-regexp-piece b e nil deep))))
9144 (defun cperl-invert-if-unless-modifiers ()
9145 "Change `B if A;' into `if (A) {B}' etc if possible.
9148 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
9149 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
9150 (and (= (char-syntax (preceding-char)) ?w)
9152 (setq pre-if (point))
9153 (cperl-backward-to-start-of-expr)
9154 (setq pre-B (point))
9155 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
9156 (cperl-forward-to-end-of-expr)
9157 (setq post-A (point))
9159 (or (looking-at w-rex)
9160 ;; Find the position
9161 (progn (goto-char post-A)
9163 (not (looking-at w-rex))
9166 (setq pre-if (point))))
9167 (or (looking-at w-rex)
9168 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
9169 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
9170 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
9171 ;; First, simple part: find code boundaries
9173 (setq post-if (point))
9176 (setq post-B (point))
9177 (cperl-backward-to-start-of-expr)
9178 (setq pre-B (point))
9179 (setq B (buffer-substring pre-B post-B))
9183 (setq pre-A (point))
9184 (cperl-forward-to-end-of-expr)
9185 (setq post-A (point))
9186 (setq A (buffer-substring pre-A post-A))
9187 ;; Now modify (from end, to not break the stuff)
9188 (skip-chars-forward " \t;")
9189 (delete-region pre-A (point)) ; we move to pre-A
9190 (insert "\n" B ";\n}")
9191 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
9192 (delete-region pre-if post-if)
9193 (delete-region pre-B post-B)
9195 (insert if-string " (" A ") {")
9196 (setq post-B (point))
9197 (if (looking-at "[ \t]+$")
9198 (delete-horizontal-space)
9199 (if (looking-at "[ \t]*#")
9200 (cperl-indent-for-comment)
9203 (if (looking-at "[ \t]*$")
9204 (progn ; delete line
9205 (delete-horizontal-space)
9206 (delete-region (point) (1+ (point)))))
9208 (goto-char (1- post-B))
9213 (defun cperl-invert-if-unless ()
9214 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
9215 If the cursor is not on the leading keyword of the BLOCK flavor of
9216 construct, will assume it is the STATEMENT flavor, so will try to find
9217 the appropriate statement modifier."
9219 (and (= (char-syntax (preceding-char)) ?w)
9221 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
9222 (let ((pre-if (point))
9223 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
9224 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
9226 (setq post-A (point))
9228 (setq pre-A (point))
9229 (setq is-block (and (eq (following-char) ?\( )
9235 (eq (following-char) ?\{ ))
9241 (setq post-B (point))
9243 (setq pre-B (point))
9244 (if (and (eq (following-char) ?\{ )
9246 (cperl-backward-to-noncomment post-A)
9247 (eq (preceding-char) ?\) )))
9248 (if (condition-case nil
9253 (looking-at "\\<els\\(e\\|if\\)\\>"))
9256 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
9257 (goto-char (1- post-B))
9258 (cperl-backward-to-noncomment pre-B)
9259 (if (eq (preceding-char) ?\;)
9261 (setq end-B-code (point))
9263 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
9264 (setq p (match-beginning 0)
9265 A (buffer-substring p (match-end 0))
9266 state (parse-partial-sexp pre-B p))
9270 (error "`%s' inside `%s' BLOCK" A if-string))
9271 (goto-char (match-end 0)))
9273 (goto-char (1+ pre-B))
9274 (skip-chars-forward " \t\n")
9275 (setq B (buffer-substring (point) end-B-code))
9276 (goto-char end-B-code)
9277 (or (looking-at ";?[ \t\n]*}")
9279 (skip-chars-forward "; \t\n")
9281 (buffer-substring (point) (1- post-B)))))
9284 (goto-char (1- post-A))
9285 (cperl-backward-to-noncomment pre-A)
9286 (or (looking-at "[ \t\n]*)")
9287 (goto-char (1- post-A)))
9289 (goto-char (1+ pre-A))
9290 (skip-chars-forward " \t\n")
9291 (setq A (buffer-substring (point) p))
9292 (delete-region pre-B post-B)
9293 (delete-region pre-A post-A)
9296 (and B-comment (insert B-comment " "))
9299 (setq pre-A (point))
9301 (delete-horizontal-space)
9302 (setq post-B (point))
9303 (if (looking-at "#")
9304 (indent-for-comment))
9307 (delete-horizontal-space)
9311 (setq pre-A (set-marker (make-marker) pre-A))
9312 (while (<= (point) (marker-position pre-A))
9315 (goto-char (marker-position pre-A))
9319 (indent-for-comment)
9320 (goto-char (marker-position pre-A)))))
9321 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
9322 ;; (error "`%s' not with an (EXPR)" if-string)
9324 (cperl-invert-if-unless-modifiers)))
9325 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
9326 (cperl-invert-if-unless-modifiers)))
9328 ;;; By Anthony Foiani <afoiani@uswest.com>
9329 ;;; Getting help on modules in C-h f ?
9330 ;;; This is a modified version of `man'.
9331 ;;; Need to teach it how to lookup functions
9333 (defun cperl-perldoc (word)
9334 "Run `perldoc' on WORD."
9336 (list (let* ((default-entry (cperl-word-at-point))
9338 (format "perldoc entry%s: "
9339 (if (string= default-entry "")
9341 (format " (default %s)" default-entry))))))
9342 (if (string= input "")
9343 (if (string= default-entry "")
9344 (error "No perldoc args given")
9348 (let* ((case-fold-search nil)
9350 (string-match "^[a-z]+$" word)
9351 (string-match (concat "^" word "\\>")
9352 (documentation-property
9354 'variable-documentation))))
9355 (manual-program (if is-func "perldoc -f" "perldoc")))
9358 (let ((Manual-program "perldoc")
9359 (Manual-switches (if is-func (list "-f"))))
9360 (manual-entry word)))
9362 (Man-getpage-in-background word)))))
9365 (defun cperl-perldoc-at-point ()
9366 "Run a `perldoc' on the word around point."
9368 (cperl-perldoc (cperl-word-at-point)))
9370 (defcustom pod2man-program "pod2man"
9371 "*File name for `pod2man'."
9375 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
9376 (defun cperl-pod-to-manpage ()
9377 "Create a virtual manpage in Emacs from the Perl Online Documentation."
9380 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
9381 (bufname (concat "Man " buffer-file-name))
9382 (buffer (generate-new-buffer bufname)))
9385 (let ((process-environment (copy-sequence process-environment)))
9386 ;; Prevent any attempt to use display terminal fanciness.
9387 (setenv "TERM" "dumb")
9388 (set-process-sentinel
9389 (start-process pod2man-program buffer "sh" "-c"
9390 (format (cperl-pod2man-build-command) pod2man-args))
9391 'Man-bgproc-sentinel)))))
9393 ;;; Updated version by him too
9394 (defun cperl-build-manpage ()
9395 "Create a virtual manpage in Emacs from the POD in the file."
9400 (let ((Manual-program "perldoc"))
9401 (manual-entry buffer-file-name)))
9403 (let* ((manual-program "perldoc"))
9404 (Man-getpage-in-background buffer-file-name)))))
9406 (defun cperl-pod2man-build-command ()
9407 "Builds the entire background manpage and cleaning command."
9408 (let ((command (concat pod2man-program " %s 2>/dev/null"))
9409 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
9410 (while (and flist (car flist))
9411 (let ((pcom (car (car flist)))
9412 (pargs (cdr (car flist))))
9414 (concat command " | " pcom " "
9415 (mapconcat '(lambda (phrase)
9416 (if (not (stringp phrase))
9417 (error "Malformed Man-filter-list"))
9420 (setq flist (cdr flist))))
9424 (defun cperl-next-interpolated-REx-1 ()
9425 "Move point to next REx which has interpolated parts without //o.
9426 Skips RExes consisting of one interpolated variable.
9428 Note that skipped RExen are not performance hits."
9430 (cperl-next-interpolated-REx 1))
9432 (defun cperl-next-interpolated-REx-0 ()
9433 "Move point to next REx which has interpolated parts without //o."
9435 (cperl-next-interpolated-REx 0))
9437 (defun cperl-next-interpolated-REx (&optional skip beg limit)
9438 "Move point to next REx which has interpolated parts.
9439 SKIP is a list of possible types to skip, BEG and LIMIT are the starting
9440 point and the limit of search (default to point and end of buffer).
9442 SKIP may be a number, then it behaves as list of numbers up to SKIP; this
9443 semantic may be used as a numeric argument.
9445 Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
9446 a result of qr//, this is not a performance hit), t for the rest."
9448 (if (numberp skip) (setq skip (list 0 skip)))
9449 (or beg (setq beg (point)))
9450 (or limit (setq limit (point-max))) ; needed for n-s-p-c
9452 (and (eq (get-text-property beg 'syntax-type) 'string)
9453 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
9454 (cperl-map-pods-heres
9455 (function (lambda (s e p)
9456 (if (memq (get-text-property s 'REx-interpolated) skip)
9460 'REx-interpolated beg limit)
9461 (if pp (goto-char pp)
9462 (message "No more interpolated REx"))))
9464 ;;; Initial version contributed by Trey Belew
9465 (defun cperl-here-doc-spell (&optional beg end)
9466 "Spell-check HERE-documents in the Perl buffer.
9467 If a region is highlighted, restricts to the region."
9469 (cperl-pod-spell t beg end))
9471 (defun cperl-pod-spell (&optional do-heres beg end)
9472 "Spell-check POD documentation.
9473 If invoked with prefix argument, will do HERE-DOCs instead.
9474 If a region is highlighted, restricts to the region."
9478 (if (cperl-mark-active)
9479 (setq beg (min (mark) (point))
9480 end (max (mark) (point)))
9481 (setq beg (point-min)
9483 (cperl-map-pods-heres (function
9486 (setq e (save-excursion
9492 (if do-heres 'here-doc-group 'in-pod)
9495 (defun cperl-map-pods-heres (func &optional prop s end)
9496 "Executes a function over regions of pods or here-documents.
9497 PROP is the text-property to search for; default to `in-pod'. Stop when
9498 function returns nil."
9499 (let (pos posend has-prop (cont t))
9500 (or prop (setq prop 'in-pod))
9501 (or s (setq s (point-min)))
9502 (or end (setq end (point-max)))
9503 (cperl-update-syntaxification end end)
9505 (goto-char (setq pos s))
9506 (while (and cont (< pos end))
9507 (setq has-prop (get-text-property pos prop))
9508 (setq posend (next-single-property-change pos prop nil end))
9510 (setq cont (funcall func pos posend prop)))
9511 (setq pos posend)))))
9513 ;;; Based on code by Masatake YAMATO:
9514 (defun cperl-get-here-doc-region (&optional pos pod)
9515 "Return HERE document region around the point.
9516 Return nil if the point is not in a HERE document region. If POD is non-nil,
9517 will return a POD section if point is in a POD section."
9518 (or pos (setq pos (point)))
9519 (cperl-update-syntaxification pos pos)
9520 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
9522 (eq 'pod (get-text-property pos 'syntax-type))))
9523 (let ((b (cperl-beginning-of-property pos 'syntax-type))
9524 (e (next-single-property-change pos 'syntax-type)))
9525 (cons b (or e (point-max))))))
9527 (defun cperl-narrow-to-here-doc (&optional pos)
9528 "Narrows editing region to the HERE-DOC at POS.
9529 POS defaults to the point."
9531 (or pos (setq pos (point)))
9532 (let ((p (cperl-get-here-doc-region pos)))
9533 (or p (error "Not inside a HERE document"))
9534 (narrow-to-region (car p) (cdr p))
9536 "When you are finished with narrow editing, type C-x n w")))
9538 (defun cperl-select-this-pod-or-here-doc (&optional pos)
9539 "Select the HERE-DOC (or POD section) at POS.
9540 POS defaults to the point."
9542 (let ((p (cperl-get-here-doc-region pos t)))
9546 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
9547 (message "I do not think POS is in POD or a HERE-doc..."))))
9549 (defun cperl-facemenu-add-face-function (face end)
9550 "A callback to process user-initiated font-change requests.
9551 Translates `bold', `italic', and `bold-italic' requests to insertion of
9552 corresponding POD directives, and `underline' to C<> POD directive.
9554 Such requests are usually bound to M-o LETTER."
9555 (or (get-text-property (point) 'in-pod)
9556 (error "Faces can only be set within POD"))
9557 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
9558 (cdr (or (assq face '((bold . "B<")
9560 (bold-italic . "B<I<")
9561 (underline . "C<")))
9562 (error "Face %s not configured for cperl-mode"
9565 (defun cperl-time-fontification (&optional l step lim)
9566 "Times how long it takes to do incremental fontification in a region.
9567 L is the line to start at, STEP is the number of lines to skip when
9568 doing next incremental fontification, LIM is the maximal number of
9569 incremental fontification to perform. Messages are accumulated in
9572 May be used for pinpointing which construct slows down buffer fontification:
9573 start with default arguments, then refine the slowdown regions."
9574 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
9576 (or step (setq step 500))
9577 (or lim (setq lim 40))
9578 (let* ((timems (function (lambda ()
9579 (let ((tt (current-time)))
9580 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
9581 (tt (funcall timems)) (c 0) delta tot)
9584 (setq tot (- (- tt (setq tt (funcall timems)))))
9585 (message "cperl-mode at %s: %s" l tot)
9586 (while (and (< c lim) (not (eobp)))
9590 (cperl-update-syntaxification (point) (point))
9591 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
9592 (message "to %s:%6s,%7s" l delta tot))
9595 (defun cperl-emulate-lazy-lock (&optional window-size)
9596 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
9597 Start fontifying the buffer from the start (or end) using the given
9598 WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
9599 goes backwards; default is -50. This function is not CPerl-specific; it
9600 may be used to debug problems with delayed incremental fontification."
9602 "nSize of window for incremental fontification, negative goes backwards: ")
9603 (or window-size (setq window-size -50))
9604 (let ((pos (if (> window-size 0)
9610 ;; Why needed??? With older font-locks???
9611 (set (make-local-variable 'font-lock-cache-position) (make-marker))
9612 (while (if (> window-size 0)
9614 (> pos (point-min)))
9616 (forward-line window-size)
9618 (font-lock-fontify-region (min p pos) (max p pos))
9622 (defun cperl-lazy-install ()) ; Avoid a warning
9623 (defun cperl-lazy-unstall ()) ; Avoid a warning
9625 (if (fboundp 'run-with-idle-timer)
9627 (defvar cperl-help-shown nil
9628 "Non-nil means that the help was already shown now.")
9630 (defvar cperl-lazy-installed nil
9631 "Non-nil means that the lazy-help handlers are installed now.")
9633 (defun cperl-lazy-install ()
9634 "Switches on Auto-Help on Perl constructs (put in the message area).
9635 Delay of auto-help controlled by `cperl-lazy-help-time'."
9637 (make-variable-buffer-local 'cperl-help-shown)
9638 (if (and (cperl-val 'cperl-lazy-help-time)
9639 (not cperl-lazy-installed))
9641 (add-hook 'post-command-hook 'cperl-lazy-hook)
9642 (run-with-idle-timer
9643 (cperl-val 'cperl-lazy-help-time 1000000 5)
9645 'cperl-get-help-defer)
9646 (setq cperl-lazy-installed t))))
9648 (defun cperl-lazy-unstall ()
9649 "Switches off Auto-Help on Perl constructs (put in the message area).
9650 Delay of auto-help controlled by `cperl-lazy-help-time'."
9652 (remove-hook 'post-command-hook 'cperl-lazy-hook)
9653 (cancel-function-timers 'cperl-get-help-defer)
9654 (setq cperl-lazy-installed nil))
9656 (defun cperl-lazy-hook ()
9657 (setq cperl-help-shown nil))
9659 (defun cperl-get-help-defer ()
9660 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
9661 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
9663 (setq cperl-help-shown t))))
9664 (cperl-lazy-install)))
9667 ;;; Plug for wrong font-lock:
9669 (defun cperl-font-lock-unfontify-region-function (beg end)
9670 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
9671 (inhibit-read-only t) (inhibit-point-motion-hooks t)
9672 before-change-functions after-change-functions
9673 deactivate-mark buffer-file-name buffer-file-truename)
9674 (remove-text-properties beg end '(face nil))
9675 (if (and (not modified) (buffer-modified-p))
9676 (set-buffer-modified-p nil))))
9678 (defun cperl-font-lock-fontify-region-function (beg end loudly)
9679 "Extends the region to safe positions, then calls the default function.
9680 Newer `font-lock's can do it themselves.
9681 We unwind only as far as needed for fontification. Syntaxification may
9682 do extra unwind via `cperl-unwind-to-safe'."
9688 (eq (get-text-property (setq beg (point)) 'syntax-type)
9690 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
9696 (or (bolp) (condition-case nil
9699 (eq (get-text-property (setq end (point)) 'syntax-type)
9701 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
9704 (font-lock-default-fontify-region beg end loudly))
9706 (defvar cperl-d-l nil)
9707 (defun cperl-fontify-syntaxically (end)
9708 ;; Some vars for debugging only
9709 ;; (message "Syntaxifying...")
9710 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
9711 (istate (car cperl-syntax-state))
9712 start from-start edebug-backtrace-buffer)
9713 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
9716 (let ((f 'edebug-backtrace))
9717 (funcall f)))) ; Avoid compile-time warning
9718 (or cperl-syntax-done-to
9719 (setq cperl-syntax-done-to (point-min)
9721 (setq start (if (and cperl-hook-after-change
9723 cperl-syntax-done-to ; Fontify without change; ignore start
9724 ;; Need to forget what is after `start'
9725 (min cperl-syntax-done-to (point))))
9728 (setq start (point))
9729 (and cperl-syntaxify-unwind
9730 (setq end (cperl-unwind-to-safe t end)
9733 (setq cperl-syntax-done-to start) ; In case what follows fails
9734 (cperl-find-pods-heres start end t nil t))
9735 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
9736 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
9737 dbg iend start end idone cperl-syntax-done-to
9738 istate (car cperl-syntax-state))) ; For debugging
9739 nil)) ; Do not iterate
9741 (defun cperl-fontify-update (end)
9742 (let ((pos (point-min)) prop posend)
9743 (setq end (point-max))
9745 (setq prop (get-text-property pos 'cperl-postpone)
9746 posend (next-single-property-change pos 'cperl-postpone nil end))
9747 (and prop (put-text-property pos posend (car prop) (cdr prop)))
9749 nil) ; Do not iterate
9751 (defun cperl-fontify-update-bad (end)
9752 ;; Since fontification happens with different region than syntaxification,
9753 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
9754 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
9756 (setq pos (or (cperl-beginning-of-property
9757 (cperl-1+ pos) 'cperl-postpone)
9760 (setq posend (next-single-property-change pos 'cperl-postpone))
9761 (and prop (put-text-property pos posend (car prop) (cdr prop)))
9763 (setq prop (get-text-property pos 'cperl-postpone))))
9764 nil) ; Do not iterate
9766 ;; Called when any modification is made to buffer text.
9767 (defun cperl-after-change-function (beg end old-len)
9768 ;; We should have been informed about changes by `font-lock'. Since it
9769 ;; does not inform as which calls are defered, do it ourselves
9770 (if cperl-syntax-done-to
9771 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
9773 (defun cperl-update-syntaxification (from to)
9774 (if (and cperl-use-syntax-table-text-property
9775 cperl-syntaxify-by-font-lock
9776 (or (null cperl-syntax-done-to)
9777 (< cperl-syntax-done-to to)))
9781 (cperl-fontify-syntaxically to)))))
9783 (defvar cperl-version
9784 (let ((v "$Revision: 5.19 $"))
9785 (string-match ":\\s *\\([0-9.]+\\)" v)
9786 (substring v (match-beginning 1) (match-end 1)))
9787 "Version of IZ-supported CPerl package this file is based on.")
9789 (provide 'cperl-mode)
9791 ;;; cperl-mode.el ends here