This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
4bf1eabd1ff9f2b8bfd7ef287d2b72161a7d2a59
[perl5.git] / emacs / cperl-mode.el
1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
2
3 ;; Copyright (C) 1985, 86, 87, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2003
4 ;;     Free Software Foundation, Inc.
5
6 ;; Author: Ilya Zakharevich and Bob Olson
7 ;; Maintainer: Ilya Zakharevich <cperl@ilyaz.org>
8 ;; Keywords: languages, Perl
9
10 ;; This file is part of GNU Emacs.
11
12 ;;; This code started from the following message of long time ago
13 ;;; (IZ), but Bob does not maintain this mode any more:
14
15 ;;; From: olson@mcs.anl.gov (Bob Olson)
16 ;;; Newsgroups: comp.lang.perl
17 ;;; Subject: cperl-mode: Another perl mode for Gnuemacs
18 ;;; Date: 14 Aug 91 15:20:01 GMT
19
20 ;; Copyright (C) Ilya Zakharevich and Bob Olson
21
22 ;; This file may be distributed
23 ;; either under the same terms as GNU Emacs, or under the same terms
24 ;; as Perl. You should have received a copy of Perl Artistic license
25 ;; along with the Perl distribution.
26
27 ;; GNU Emacs is free software; you can redistribute it and/or modify
28 ;; it under the terms of the GNU General Public License as published by
29 ;; the Free Software Foundation; either version 2, or (at your option)
30 ;; any later version.
31
32 ;; GNU Emacs is distributed in the hope that it will be useful,
33 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
34 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
35 ;; GNU General Public License for more details.
36
37 ;; You should have received a copy of the GNU General Public License
38 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
39 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
40 ;; Boston, MA 02111-1307, USA.
41
42 ;;; Corrections made by Ilya Zakharevich cperl@ilyaz.org
43 ;;; XEmacs changes by Peter Arius arius@informatik.uni-erlangen.de
44
45 ;;; Commentary:
46
47 ;; $Id: cperl-mode.el,v 5.0 2003/02/17 01:33:20 vera Exp vera $
48
49 ;;; If your Emacs does not default to `cperl-mode' on Perl files:
50 ;;; To use this mode put the following into
51 ;;; your .emacs file:
52
53 ;; (autoload 'perl-mode "cperl-mode" "alternate mode for editing Perl programs" t)
54
55 ;; You can either fine-tune the bells and whistles of this mode or
56 ;; bulk enable them by putting
57
58 ;; (setq cperl-hairy t)
59
60 ;; in your .emacs file.  (Emacs rulers do not consider it politically
61 ;; correct to make whistles enabled by default.)
62
63 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu)   <<<<<<
64 ;; or as help on variables `cperl-tips', `cperl-problems',         <<<<<<
65 ;; `cperl-non-problems', `cperl-praise', `cperl-speed'.            <<<<<<
66
67 ;; Additional useful commands to put into your .emacs file (before
68 ;; RMS Emacs 20.3):
69
70 ;; (setq auto-mode-alist
71 ;;      (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode))  auto-mode-alist ))
72 ;; (setq interpreter-mode-alist (append interpreter-mode-alist
73 ;;                                      '(("miniperl" . perl-mode))))
74
75 ;; The mode information (on C-h m) provides some customization help.
76 ;; If you use font-lock feature of this mode, it is advisable to use
77 ;; either lazy-lock-mode or fast-lock-mode.  I prefer lazy-lock.
78
79 ;; Faces used now: three faces for first-class and second-class keywords
80 ;; and control flow words, one for each: comments, string, labels,
81 ;; functions definitions and packages, arrays, hashes, and variable
82 ;; definitions.  If you do not see all these faces, your font-lock does
83 ;; not define them, so you need to define them manually.
84 ;; Maybe you have an obsolete font-lock from 19.28 or earlier.  Upgrade.
85
86 ;; If you have a grayscale monitor, and do not have the variable
87 ;; font-lock-display-type bound to 'grayscale, insert
88
89 ;; (setq font-lock-display-type 'grayscale)
90
91 ;; into your .emacs file (this is relevant before RMS Emacs 20).
92
93 ;; This mode supports font-lock, imenu and mode-compile.  In the
94 ;; hairy version font-lock is on, but you should activate imenu
95 ;; yourself (note that mode-compile is not standard yet).  Well, you
96 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
97 ;; to bind it like that:
98
99 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
100
101 ;;; Font lock bugs as of v4.32:
102
103 ;; The following kinds of Perl code erroneously start strings:
104 ;; \$`  \$'  \$"
105 ;; $opt::s  $opt_s  $opt{s}  (s => ...)  /\s+.../
106 ;; likewise with m, tr, y, q, qX instead of s
107
108 ;;; In fact the version of font-lock that this version supports can be
109 ;;; much newer than the version you actually have. This means that a
110 ;;; lot of faces can be set up, but are not visible on your screen
111 ;;; since the coloring rules for this faces are not defined.
112
113 ;;; Updates: ========================================
114
115 ;;; Made less hairy by default: parentheses not electric,
116 ;;; linefeed not magic. Bug with abbrev-mode corrected.
117
118 ;;;; After 1.4:
119 ;;;  Better indentation:
120 ;;;  subs inside braces should work now,
121 ;;;  Toplevel braces obey customization.
122 ;;;  indent-for-comment knows about bad cases, cperl-indent-for-comment
123 ;;;  moves cursor to a correct place.
124 ;;;  cperl-indent-exp written from the scratch! Slow... (quadratic!) :-(
125 ;;;        (50 secs on DB::DB (sub of 430 lines), 486/66)
126 ;;;  Minor documentation fixes.
127 ;;;  Imenu understands packages as prefixes (including nested).
128 ;;;  Hairy options can be switched off one-by-one by setting to null.
129 ;;;  Names of functions and variables changed to conform to `cperl-' style.
130
131 ;;;; After 1.5:
132 ;;;  Some bugs with indentation of labels (and embedded subs) corrected.
133 ;;;  `cperl-indent-region' done (slow :-()).
134 ;;;  `cperl-fill-paragraph' done.
135 ;;;  Better package support for `imenu'.
136 ;;;  Progress indicator for indentation (with `imenu' loaded).
137 ;;;  `Cperl-set' was busted, now setting the individual hairy option
138 ;;;     should be better.
139
140 ;;;; After 1.6:
141 ;;; `cperl-set-style' done.
142 ;;; `cperl-check-syntax' done.
143 ;;; Menu done.
144 ;;; New config variables `cperl-close-paren-offset' and `cperl-comment-column'.
145 ;;; Bugs with `cperl-auto-newline' corrected.
146 ;;; `cperl-electric-lbrace' can work with `cperl-auto-newline' in situation
147 ;;; like $hash{.
148
149 ;;;; 1.7 XEmacs (arius@informatik.uni-erlangen.de):
150 ;;; - use `next-command-event', if `next-command-events' does not exist
151 ;;; - use `find-face' as def. of `is-face'
152 ;;; - corrected def. of `x-color-defined-p'
153 ;;; - added const defs for font-lock-comment-face,
154 ;;;   font-lock-keyword-face and font-lock-function-name-face
155 ;;; - added def. of font-lock-variable-name-face
156 ;;; - added (require 'easymenu) inside an `eval-when-compile'
157 ;;; - replaced 4-argument `substitute-key-definition' with ordinary
158 ;;;   `define-key's
159 ;;; - replaced `mark-active' in menu definition by `cperl-use-region-p'.
160 ;;; Todo (at least):
161 ;;; - use emacs-vers.el (http://www.cs.utah.edu/~eeide/emacs/emacs-vers.el.gz)
162 ;;;   for portable code?
163 ;;; - should `cperl-mode' do a
164 ;;;     (if (featurep 'easymenu) (easy-menu-add cperl-menu))
165 ;;;   or should this be left to the user's `cperl-mode-hook'?
166
167 ;;; Some bugs introduced by the above fix corrected (IZ ;-).
168 ;;; Some bugs under XEmacs introduced by the correction corrected.
169
170 ;;; Some more can remain since there are two many different variants.
171 ;;; Please feedback!
172
173 ;;; We do not support fontification of arrays and hashes under
174 ;;; obsolete font-lock any more. Upgrade.
175
176 ;;;; after 1.8 Minor bug with parentheses.
177 ;;;; after 1.9 Improvements from Joe Marzot.
178 ;;;; after 1.10
179 ;;;  Does not need easymenu to compile under XEmacs.
180 ;;;  `vc-insert-headers' should work better.
181 ;;;  Should work with 19.29 and 19.12.
182 ;;;  Small improvements to fontification.
183 ;;;  Expansion of keywords does not depend on C-? being backspace.
184
185 ;;; after 1.10+
186 ;;; 19.29 and 19.12 supported.
187 ;;; `cperl-font-lock-enhanced' deprecated. Use font-lock-extra.el.
188 ;;; Support for font-lock-extra.el.
189
190 ;;;; After 1.11:
191 ;;; Tools submenu.
192 ;;; Support for perl5-info.
193 ;;; `imenu-go-find-at-position' in Tools requires imenu-go.el (see hints above)
194 ;;; Imenu entries do not work with stock imenu.el. Patch sent to maintainers.
195 ;;; Fontifies `require a if b;', __DATA__.
196 ;;; Arglist for auto-fill-mode was incorrect.
197
198 ;;;; After 1.12:
199 ;;; `cperl-lineup-step' and `cperl-lineup' added: lineup constructions
200 ;;; vertically.
201 ;;; `cperl-do-auto-fill' updated for 19.29 style.
202 ;;; `cperl-info-on-command' now has a default.
203 ;;; Workaround for broken C-h on XEmacs.
204 ;;; VC strings escaped.
205 ;;; C-h f now may prompt for function name instead of going on,
206 ;;; controlled by `cperl-info-on-command-no-prompt'.
207
208 ;;;; After 1.13:
209 ;;; Msb buffer list includes perl files
210 ;;; Indent-for-comment uses indent-to
211 ;;; Can write tag files using etags.
212
213 ;;;; After 1.14:
214 ;;; Recognizes (tries to ;-) {...} which are not blocks during indentation.
215 ;;; `cperl-close-paren-offset' affects ?\] too (and ?\} if not block)
216 ;;; Bug with auto-filling comments started with "##" corrected.
217
218 ;;;; Very slow now: on DB::DB 0.91, 486/66:
219
220 ;;;Function Name                             Call Count  Elapsed Time  Average Time
221 ;;;========================================  ==========  ============  ============
222 ;;;cperl-block-p                             469         3.7799999999  0.0080597014
223 ;;;cperl-get-state                           505         163.39000000  0.3235445544
224 ;;;cperl-comment-indent                      12          0.0299999999  0.0024999999
225 ;;;cperl-backward-to-noncomment              939         4.4599999999  0.0047497337
226 ;;;cperl-calculate-indent                    505         172.22000000  0.3410297029
227 ;;;cperl-indent-line                         505         172.88000000  0.3423366336
228 ;;;cperl-use-region-p                        40          0.0299999999  0.0007499999
229 ;;;cperl-indent-exp                          1           177.97000000  177.97000000
230 ;;;cperl-to-comment-or-eol                   1453        3.9800000000  0.0027391603
231 ;;;cperl-backward-to-start-of-continued-exp  9           0.0300000000  0.0033333333
232 ;;;cperl-indent-region                       1           177.94000000  177.94000000
233
234 ;;;; After 1.15:
235 ;;; Takes into account white space after opening parentheses during indent.
236 ;;; May highlight pods and here-documents: see `cperl-pod-here-scan',
237 ;;; `cperl-pod-here-fontify', `cperl-pod-face'. Does not use this info
238 ;;; for indentation so far.
239 ;;; Fontification updated to 19.30 style.
240 ;;; The change 19.29->30 did not add all the required functionality,
241 ;;;     but broke "font-lock-extra.el". Get "choose-color.el" from
242 ;;;       ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
243
244 ;;;; After 1.16:
245 ;;;       else # comment
246 ;;;    recognized as a start of a block.
247 ;;;  Two different font-lock-levels provided.
248 ;;;  `cperl-pod-head-face' introduced. Used for highlighting.
249 ;;;  `imenu' marks pods, +Packages moved to the head.
250
251 ;;;; After 1.17:
252 ;;;  Scan for pods highlights here-docs too.
253 ;;;  Note that the tag of here-doc may be rehighlighted later by lazy-lock.
254 ;;;  Only one here-doc-tag per line is supported, and one in comment
255 ;;;  or a string may break fontification.
256 ;;;  POD headers were supposed to fill one line only.
257
258 ;;;; After 1.18:
259 ;;;  `font-lock-keywords' were set in 19.30 style _always_. Current scheme
260 ;;;    may  break under XEmacs.
261 ;;;  `cperl-calculate-indent' dis suppose that `parse-start' was defined.
262 ;;;  `fontified' tag is added to fontified text as well as `lazy-lock' (for
263 ;;;    compatibility with older lazy-lock.el) (older one overfontifies
264 ;;;    something nevertheless :-().
265 ;;;  Will not indent something inside pod and here-documents.
266 ;;;  Fontifies the package name after import/no/bootstrap.
267 ;;;  Added new entry to menu with meta-info about the mode.
268
269 ;;;; After 1.19:
270 ;;;  Prefontification works much better with 19.29. Should be checked
271 ;;;   with 19.30 as well.
272 ;;;  Some misprints in docs corrected.
273 ;;;  Now $a{-text} and -text => "blah" are fontified as strings too.
274 ;;;  Now the pod search is much stricter, so it can help you to find
275 ;;;    pod sections which are broken because of whitespace before =blah
276 ;;;    - just observe the fontification.
277
278 ;;;; After 1.20
279 ;;;  Anonymous subs are indented with respect to the level of
280 ;;;    indentation of `sub' now.
281 ;;;  {} is recognized as hash after `bless' and `return'.
282 ;;;  Anonymous subs are split by `cperl-linefeed' as well.
283 ;;;  Electric parens embrace a region if present.
284 ;;;  To make `cperl-auto-newline' useful,
285 ;;;    `cperl-auto-newline-after-colon' is introduced.
286 ;;;  `cperl-electric-parens' is now t or nul. The old meaning is moved to
287 ;;;  `cperl-electric-parens-string'.
288 ;;;  `cperl-toggle-auto-newline' introduced, put on C-c C-a.
289 ;;;  `cperl-toggle-abbrev' introduced, put on C-c C-k.
290 ;;;  `cperl-toggle-electric' introduced, put on C-c C-e.
291 ;;;  Beginning-of-defun-regexp was not anchored.
292
293 ;;;; After 1.21
294 ;;;  Auto-newline grants `cperl-extra-newline-before-brace' if "{" is typed
295 ;;;    after ")".
296 ;;;  {} is recognized as expression after `tr' and friends.
297
298 ;;;; After 1.22
299 ;;;  Entry Hierarchy added to imenu. Very primitive so far.
300 ;;;  One needs newer `imenu-go'.el. A patch to `imenu' is needed as well.
301 ;;;  Writes its own TAGS files.
302 ;;;  Class viewer based on TAGS files. Does not trace @ISA so far.
303 ;;;  19.31: Problems with scan for PODs corrected.
304 ;;;  First POD header correctly fontified.
305 ;;;  I needed (setq imenu-use-keymap-menu t) to get good imenu in 19.31.
306 ;;;  Apparently it makes a lot of hierarchy code obsolete...
307
308 ;;;; After 1.23
309 ;;;  Tags filler now scans *.xs as well.
310 ;;;  The info from *.xs scan is used by the hierarchy viewer.
311 ;;;  Hierarchy viewer documented.
312 ;;;  Bug in 19.31 imenu documented.
313
314 ;;;; After 1.24
315 ;;;  New location for info-files mentioned,
316 ;;;  Electric-; should work better.
317 ;;;  Minor bugs with POD marking.
318
319 ;;;; After 1.25 (probably not...)
320 ;;;  `cperl-info-page' introduced.
321 ;;;  To make `uncomment-region' working, `comment-region' would
322 ;;;  not insert extra space.
323 ;;;  Here documents delimiters better recognized
324 ;;;  (empty one, and non-alphanums in quotes handled). May be wrong with 1<<14?
325 ;;;  `cperl-db' added, used in menu.
326 ;;;  imenu scan removes text-properties, for better debugging
327 ;;;    - but the bug is in 19.31 imenu.
328 ;;;  formats highlighted by font-lock and prescan, embedded comments
329 ;;;  are not treated.
330 ;;;  POD/friends scan merged in one pass.
331 ;;;  Syntax class is not used for analyzing the code, only char-syntax
332 ;;;  may be checked against _ or'ed with w.
333 ;;;  Syntax class of `:' changed to be _.
334 ;;;  `cperl-find-bad-style' added.
335
336 ;;;; After 1.25
337 ;;;  When search for here-documents, we ignore commented << in simplest cases.
338 ;;;  `cperl-get-help' added, available on C-h v and from menu.
339 ;;;  Auto-help added. Default with `cperl-hairy', switchable on/off
340 ;;;   with startup variable `cperl-lazy-help-time' and from
341 ;;;   menu. Requires `run-with-idle-timer'.
342 ;;;  Highlighting of @abc{@efg} was wrong - interchanged two regexps.
343
344 ;;;; After 1.27
345 ;;;  Indentation: At toplevel after a label - fixed.
346 ;;;  1.27 was put to archives in binary mode ===> DOSish :-(
347
348 ;;;; After 1.28
349 ;;;  Thanks to Martin Buchholz <mrb@Eng.Sun.COM>: misprints in
350 ;;;  comments and docstrings corrected, XEmacs support cleaned up.
351 ;;;  The closing parenths would enclose the region into matching
352 ;;;  parens under the same conditions as the opening ones.
353 ;;;  Minor updates to `cperl-short-docs'.
354 ;;;  Will not consider <<= as start of here-doc.
355
356 ;;;; After 1.29
357 ;;;  Added an extra advice to look into Micro-docs. ;-).
358 ;;;  Enclosing of region when you press a closing parenth is regulated by
359 ;;;  `cperl-electric-parens-string'.
360 ;;;  Minor updates to `cperl-short-docs'.
361 ;;;  `initialize-new-tags-table' called only if present (Does this help
362 ;;;     with generation of tags under XEmacs?).
363 ;;;  When creating/updating tag files, new info is written at the old place,
364 ;;;     or at the end (is this a wanted behaviour? I need this in perl build directory).
365
366 ;;;; After 1.30
367 ;;;  All the keywords from keywords.pl included (maybe with dummy explanation).
368 ;;;  No auto-help inside strings, comment, here-docs, formats, and pods.
369 ;;;  Shrinkwrapping of info, regulated by `cperl-max-help-size',
370 ;;;  `cperl-shrink-wrap-info-frame'.
371 ;;;  Info on variables as well.
372 ;;;  Recognision of HERE-DOCS improved yet more.
373 ;;;  Autonewline works on `}' without warnings.
374 ;;;  Autohelp works again on $_[0].
375
376 ;;;; After 1.31
377 ;;;  perl-descr.el found its author - hi, Johan!
378 ;;;  Some support for correct indent after here-docs and friends (may
379 ;;;  be superseeded by eminent change to Emacs internals).
380 ;;;  Should work with older Emaxen as well ( `-style stuff removed).
381
382 ;;;; After 1.32
383
384 ;;;  Started to add support for `syntax-table' property (should work
385 ;;;  with patched Emaxen), controlled by
386 ;;;  `cperl-use-syntax-table-text-property'. Currently recognized:
387 ;;;    All quote-like operators: m, s, y, tr, qq, qw, qx, q,
388 ;;;    // in most frequent context:
389 ;;;          after block or
390 ;;;                    ~ { ( = | & + - * ! , ;
391 ;;;          or
392 ;;;                    while if unless until and or not xor split grep map
393 ;;;    Here-documents, formats, PODs,
394 ;;;    ${...}
395 ;;;    'abc$'
396 ;;;    sub a ($); sub a ($) {}
397 ;;;  (provide 'cperl-mode) was missing!
398 ;;;  `cperl-after-expr-p' is now much smarter after `}'.
399 ;;;  `cperl-praise' added to mini-docs.
400 ;;;  Utilities try to support subs-with-prototypes.
401
402 ;;;; After 1.32.1
403 ;;;  `cperl-after-expr-p' is now much smarter after "() {}" and "word {}":
404 ;;;     if word is "else, map, grep".
405 ;;;  Updated for new values of syntax-table constants.
406 ;;;  Uses `help-char' (at last!) (disabled, does not work?!)
407 ;;;  A couple of regexps where missing _ in character classes.
408 ;;;  -s could be considered as start of regexp, 1../blah/ was not,
409 ;;;  as was not /blah/ at start of file.
410
411 ;;;; After 1.32.2
412 ;;;  "\C-hv" was wrongly "\C-hf"
413 ;;;  C-hv was not working on `[index()]' because of [] in skip-chars-*.
414 ;;;  `__PACKAGE__' supported.
415 ;;;  Thanks for Greg Badros: `cperl-lazy-unstall' is more complete,
416 ;;;  `cperl-get-help' is made compatible with `query-replace'.
417
418 ;;;; As of Apr 15, development version of 19.34 supports
419 ;;;; `syntax-table' text properties. Try setting
420 ;;;; `cperl-use-syntax-table-text-property'.
421
422 ;;;; After 1.32.3
423 ;;;  We scan for s{}[] as well (in simplest situations).
424 ;;;  We scan for $blah'foo as well.
425 ;;;  The default is to use `syntax-table' text property if Emacs is good enough.
426 ;;;  `cperl-lineup' is put on C-M-| (=C-M-S-\\).
427 ;;;  Start of `cperl-beautify-regexp'.
428
429 ;;;; After 1.32.4
430 ;;; `cperl-tags-hier-init' did not work in text-mode.
431 ;;; `cperl-noscan-files-regexp' had a misprint.
432 ;;; Generation of Class Hierarchy was broken due to a bug in `x-popup-menu'
433 ;;;  in 19.34.
434
435 ;;;; After 1.33:
436 ;;; my,local highlight vars after {} too.
437 ;;; TAGS could not be created before imenu was loaded.
438 ;;; `cperl-indent-left-aligned-comments' created.
439 ;;; Logic of `cperl-indent-exp' changed a little bit, should be more
440 ;;;  robust w.r.t. multiline strings.
441 ;;; Recognition of blah'foo takes into account strings.
442 ;;; Added '.al' to the list of Perl extensions.
443 ;;; Class hierarchy is "mostly" sorted (need to rethink algorthm
444 ;;;  of pruning one-root-branch subtrees to get yet better sorting.)
445 ;;; Regeneration of TAGS was busted.
446 ;;; Can use `syntax-table' property when generating TAGS
447 ;;;  (governed by  `cperl-use-syntax-table-text-property-for-tags').
448
449 ;;;; After 1.35:
450 ;;; Can process several =pod/=cut sections one after another.
451 ;;; Knows of `extproc' when under `emx', indents with `__END__' and `__DATA__'.
452 ;;; `cperl-under-as-char' implemented (XEmacs people like broken behaviour).
453 ;;; Beautifier for regexps fixed.
454 ;;; `cperl-beautify-level', `cperl-contract-level' coded
455 ;;;
456 ;;;; Emacs's 20.2 problems:
457 ;;; `imenu.el' has bugs, `imenu-add-to-menubar' does not work.
458 ;;; Couple of others problems with 20.2 were reported, my ability to check/fix
459 ;;; them is very reduced now.
460
461 ;;;; After 1.36:
462 ;;;  'C-M-|' in XEmacs fixed
463
464 ;;;; After 1.37:
465 ;;;  &&s was not recognized as start of regular expression;
466 ;;;  Will "preprocess" the contents of //e part of s///e too;
467 ;;;  What to do with s# blah # foo #e ?
468 ;;;  Should handle s;blah;foo;; better.
469 ;;;  Now the only known problems with regular expression recognition:
470 ;;;;;;;  s<foo>/bar/    - different delimiters (end ignored)
471 ;;;;;;;  s/foo/\\bar/   - backslash at start of subst (made into one chunk)
472 ;;;;;;;  s/foo//        - empty subst (made into one chunk + '/')
473 ;;;;;;;  s/foo/(bar)/   - start-group at start of subst (internal group will not match backwards)
474
475 ;;;; After 1.38:
476 ;;;  We highlight closing / of s/blah/foo/e;
477 ;;;  This handles s# blah # foo #e too;
478 ;;;  s//blah/, s///, s/blah// works again, and s#blah## too, the algorithm
479 ;;;   is much simpler now;
480 ;;;  Next round of changes: s\\\ works, s<blah>/foo/,
481 ;;;   comments between the first and the second part allowed
482 ;;;  Another problem discovered:
483 ;;;;;;;  s[foo] <blah>e - e part delimited by different <> (will not match)
484 ;;;  `cperl-find-pods-heres' somehow maybe called when string-face is undefined
485 ;;;   - put a stupid workaround for 20.1
486
487 ;;;; After 1.39:
488 ;;;  Could indent here-docs for comments;
489 ;;;  These problems fixed:
490 ;;;;;;;  s/foo/\\bar/   - backslash at start of subst (made into two chunk)
491 ;;;;;;;  s[foo] <blah>e - "e" part delimited by "different" <> (will match)
492 ;;;  Matching brackets honor prefices, may expand abbreviations;
493 ;;;  When expanding abbrevs, will remove last char only after
494 ;;;    self-inserted whitespace;
495 ;;;  More convenient "Refress hard constructs" in menu;
496 ;;;  `cperl-add-tags-recurse', `cperl-add-tags-recurse-noxs'
497 ;;;    added (for -batch mode);
498 ;;;  Better handling of errors when scanning for Perl constructs;
499 ;;;;;;;  Possible "problem" with class hierarchy in Perl distribution
500 ;;;;;;;    directory: ./ext duplicates ./lib;
501 ;;;  Write relative paths for generated TAGS;
502
503 ;;;; After 1.40:
504 ;;;  s  /// may be separated by "\n\f" too;
505 ;;;  `s  #blah' recognized as a comment;
506 ;;;  Would highlight s/abc//s wrong;
507 ;;;  Debugging code in `cperl-electric-keywords' was leaking a message;
508
509 ;;;; After 1.41:
510 ;;;  RMS changes for 20.3 merged
511
512 ;;;; 2.0.1.0: RMS mode (has 3 misprints)
513
514 ;;;; After 2.0:
515 ;;;  RMS whitespace changes for 20.3 merged
516
517 ;;;; After 2.1:
518 ;;;  History updated
519
520 ;;;; After 2.2:
521 ;;;  Merge `c-style-alist' since `c-mode' is no more.  (Somebody who
522 ;;;    uses the styles should check that they work OK!)
523 ;;;  All the variable warnings go away, some undef functions too.
524
525 ;;;; After 2.3:
526 ;;;  Added `cperl-perldoc' (thanks to Anthony Foiani <afoiani@uswest.com>)
527 ;;;  Added `cperl-pod-to-manpage' (thanks to Nick Roberts <Nick.Roberts@src.bae.co.uk>)
528 ;;;  All the function warnings go away.
529
530 ;;;; After 2.4:
531 ;;;  `Perl doc', `Regexp' submenus created (latter to allow short displays).
532 ;;;  `cperl-clobber-lisp-bindings' added.
533 ;;;  $a->y() is not y///.
534 ;;;  `cperl-after-block-p' was missing a `save-excursion' => wrong results.
535 ;;;  `cperl-val' was defined too late.
536 ;;;  `cperl-init-faces' was failing.
537 ;;;  Init faces when loading `ps-print'.
538
539 ;;;; After 2.4:
540 ;;;  `cperl-toggle-autohelp' implemented.
541 ;;;  `while SPACE LESS' was buggy.
542 ;;;  `-text' in `[-text => 1]' was not highlighted.
543 ;;;  `cperl-after-block-p' was FALSE after `sub f {}'.
544
545 ;;;; After 2.5:
546 ;;;  `foreachmy', `formy' expanded too.
547 ;;;  Expand `=pod-directive'.
548 ;;;  `cperl-linefeed' behaves reasonable in POD-directive lines.
549 ;;;  `cperl-electric-keyword' prints a message, governed by
550 ;;;    `cperl-message-electric-keyword'.
551
552 ;;;; After 2.6:
553 ;;;  Typing `}' was not checking for being block or not.
554 ;;;  Beautifying levels in RE: Did not know about lookbehind;
555 ;;;                            finding *which* level was not intuitive;
556 ;;;                            `cperl-beautify-levels' added.
557 ;;;  Allow here-docs contain `=head1' and friends (at least for keywords).
558
559 ;;;; After 2.7:
560 ;;;  Fix for broken `font-lock-unfontify-region-function'.  Should
561 ;;;    preserve `syntax-table' properties even with `lazy-lock'.
562
563 ;;;; After 2.8:
564 ;;;  Some more compile time warnings crept in.
565 ;;;  `cperl-indent-region-fix-else' implemented.
566 ;;;  `cperl-fix-line-spacing' implemented.
567 ;;;  `cperl-invert-if-unless' implemented (C-c C-t and in Menu).
568 ;;;  Upgraded hints to mention 20.2's goods/bads.
569 ;;;  Started to use `cperl-extra-newline-before-brace-multiline',
570 ;;;    `cperl-break-one-line-blocks-when-indent',
571 ;;;    `cperl-fix-hanging-brace-when-indent', `cperl-merge-trailing-else'.
572
573 ;;;; After 2.9:
574 ;;;  Workaround for another `font-lock's `syntax-table' text-property bug.
575 ;;;  `zerop' could be applied to nil.
576 ;;;  At last, may work with `font-lock' without setting `cperl-font-lock'.
577 ;;;    (We expect that starting from 19.33, `font-lock' supports keywords
578 ;;;     being a function - what is a correct version?)
579 ;;;  Rename `cperl-indent-region-fix-else' to
580 ;;;    `cperl-indent-region-fix-constructs'.
581 ;;;  `cperl-fix-line-spacing' could be triggered inside strings, would not
582 ;;;     know what to do with BLOCKs of map/printf/etc.
583 ;;;  `cperl-merge-trailing-else' and `cperl-fix-line-spacing' handle
584 ;;;     `continue' too.
585 ;;;  Indentation after {BLOCK} knows about map/printf/etc.
586 ;;;  Finally: treat after-comma lines as continuation lines.
587
588 ;;;; After 2.10:
589 ;;;  `continue' made electric.
590 ;;;  Electric `do' inserts `do/while'.
591 ;;;  Some extra compile-time warnings crept in.
592 ;;;  `font-lock' of 19.33 could not handle font-lock-keywords being a function
593 ;;;      returning a symbol.
594
595 ;;;; After 2.11:
596 ;;;  Changes to make syntaxification to be autoredone via `font-lock'.
597 ;;;    Switched on by `cperl-syntaxify-by-font-lock', off by default so far.
598
599 ;;;; After 2.12:
600 ;;;  Remove some commented out chunks.
601 ;;;  Styles are slightly updated (a lot of work is needed, especially
602 ;;;    with new `cperl-fix-line-spacing').
603
604 ;;;; After 2.13:
605 ;;;  Old value of style is memorized when choosing a new style, may be
606 ;;;    restored from the same menu.
607 ;;;  Mode-documentation added to micro-docs.
608 ;;;  `cperl-praise' updated.
609 ;;;  `cperl-toggle-construct-fix' added on C-c C-w and menu.
610 ;;;  `auto-fill-mode' added on C-c C-f and menu.
611 ;;;  `PerlStyle' style added.
612 ;;;  Message for termination of scan corrected.
613
614 ;;;; After 2.14:
615
616 ;;;  Did not work with -q
617
618 ;;;; After 2.15:
619
620 ;;;  `cperl-speed' hints added.
621 ;;;  Minor style fixes.
622
623 ;;;; After 2.15:
624 ;;;  Make backspace electric after expansion of `else/continue' too.
625
626 ;;;; After 2.16:
627 ;;;  Starting to merge changes to RMS emacs version.
628
629 ;;;; After 2.17:
630 ;;;  Merged custom stuff and darn `font-lock-constant-face'.
631
632 ;;;; After 2.18:
633 ;;;  Bumped the version to 3.1
634
635 ;;;; After 3.1:
636 ;;;  Fixed customization to honor cperl-hairy.
637 ;;;  Created customization groups.  Sent to RMS to include into 2.3.
638
639 ;;;; After 3.2:
640 ;;;  Interaction of `font-lock-hot-pass' and `cperl-syntaxify-by-font-lock'.
641 ;;;  (`cperl-after-block-and-statement-beg'):
642 ;;;  (`cperl-after-block-p'):
643 ;;;  (`cperl-after-expr-p'):    It is BLOCK if we reach lim when backup sexp.
644 ;;;  (`cperl-indent-region'):   Make a marker for END - text added/removed.
645 ;;;  (`cperl-style-alist', `cperl-styles-entries')
646 ;;;             Include `cperl-merge-trailing-else' where the value is clear.
647
648 ;;;; After 3.3:
649 ;;;  (`cperl-tips'):
650 ;;;  (`cperl-problems'):        Improvements to docs.
651
652 ;;;; After 3.4:
653 ;;;  (`cperl-mode'):            Make lazy syntaxification possible.
654 ;;;  (`cperl-find-pods-heres'): Safe a position in buffer where it is safe to
655 ;;;                             restart syntaxification.
656 ;;;  (`cperl-syntaxify-by-font-lock'): Set to t, should be safe now.
657
658 ;;;; After 3.5:
659 ;;;  (`cperl-syntaxify-by-font-lock'): Better default, customizes to
660 ;;;                             `message' too.
661
662 ;;;; After 3.6:
663 ;;;  (`cperl-find-pods-heres'): changed so that -d ?foo? is a RE.
664 ;;;  (`cperl-array-face'): changed name from `font-lock-emphasized-face'.
665 ;;;  (`cperl-hash-face'): changed name from  `font-lock-other-emphasized-face'.
666 ;;;  Use `defface' to define these two extra faces.
667
668 ;;;; After 3.7:
669 ;;;  Can use linear algorithm for indentation if Emacs supports it:
670 ;;;  indenting DB::DB (800+ lines) improved from 69 sec to 11 sec
671 ;;;  (73 vs 15 with imenu).
672 ;;;  (`cperl-emacs-can-parse'): New state.
673 ;;;  (`cperl-indent-line'):     Corrected to use global state.
674 ;;;  (`cperl-calculate-indent'):        Likewise.
675 ;;;  (`cperl-fix-line-spacing'):        Likewise (not used yet).
676
677 ;;;; After 3.8:
678 ;;;  (`cperl-choose-color'):    Converted to a function (to be compilable in text-mode).
679
680 ;;;; After 3.9:
681 ;;;  (`cperl-dark-background '):        Disable without window-system.
682
683 ;;;; After 3.10:
684 ;;;  Do `defface' only if window-system.
685
686 ;;;; After 3.11:
687 ;;;  (`cperl-fix-line-spacing'):        sped up to bail out early.
688 ;;;  (`cperl-indent-region'):   Disable hooks during the call (how to call them later?).
689
690 ;;;  Now indents 820-line-long function in 6.5 sec (including syntaxification) the first time
691 ;;;  (when buffer has few properties), 7.1 sec the second time.
692
693 ;;;Function Name                              Call Count  Elapsed Time  Average Time
694 ;;;=========================================  ==========  ============  ============
695 ;;;cperl-indent-exp                           1           10.039999999  10.039999999
696 ;;;cperl-indent-region                        1           10.0          10.0
697 ;;;cperl-indent-line                          821         6.2100000000  0.0075639464
698 ;;;cperl-calculate-indent                     821         5.0199999999  0.0061144945
699 ;;;cperl-backward-to-noncomment               2856        2.0500000000  0.0007177871
700 ;;;cperl-fontify-syntaxically                 2           1.78          0.8900000000
701 ;;;cperl-find-pods-heres                      2           1.78          0.8900000000
702 ;;;cperl-update-syntaxification               1           1.78          1.78
703 ;;;cperl-fix-line-spacing                     769         1.4800000000  0.0019245773
704 ;;;cperl-after-block-and-statement-beg        163         1.4100000000  0.0086503067
705 ;;;cperl-block-p                              775         1.1800000000  0.0015225806
706 ;;;cperl-to-comment-or-eol                    3652        1.1200000000  0.0003066812
707 ;;;cperl-after-block-p                        165         1.0500000000  0.0063636363
708 ;;;cperl-commentify                           141         0.22          0.0015602836
709 ;;;cperl-get-state                            813         0.16          0.0001968019
710 ;;;cperl-backward-to-start-of-continued-exp   26          0.12          0.0046153846
711 ;;;cperl-delay-update-hook                    2107        0.0899999999  4.271...e-05
712 ;;;cperl-protect-defun-start                  141         0.0700000000  0.0004964539
713 ;;;cperl-after-label                          407         0.0599999999  0.0001474201
714 ;;;cperl-forward-re                           139         0.0299999999  0.0002158273
715 ;;;cperl-comment-indent                       26          0.0299999999  0.0011538461
716 ;;;cperl-use-region-p                         8           0.0           0.0
717 ;;;cperl-lazy-hook                            15          0.0           0.0
718 ;;;cperl-after-expr-p                         8           0.0           0.0
719 ;;;cperl-font-lock-unfontify-region-function  1           0.0           0.0
720
721 ;;;Function Name                              Call Count  Elapsed Time  Average Time
722 ;;;=========================================  ==========  ============  ============
723 ;;;cperl-fix-line-spacing                     769         1.4500000000  0.0018855656
724 ;;;cperl-indent-line                          13          0.3100000000  0.0238461538
725 ;;;cperl-after-block-and-statement-beg        69          0.2700000000  0.0039130434
726 ;;;cperl-after-block-p                        69          0.2099999999  0.0030434782
727 ;;;cperl-calculate-indent                     13          0.1000000000  0.0076923076
728 ;;;cperl-backward-to-noncomment               177         0.0700000000  0.0003954802
729 ;;;cperl-get-state                            13          0.0           0.0
730 ;;;cperl-to-comment-or-eol                    179         0.0           0.0
731 ;;;cperl-get-help-defer                       1           0.0           0.0
732 ;;;cperl-lazy-hook                            11          0.0           0.0
733 ;;;cperl-after-expr-p                         2           0.0           0.0
734 ;;;cperl-block-p                              13          0.0           0.0
735 ;;;cperl-after-label                          5           0.0           0.0
736
737 ;;;; After 3.12:
738 ;;;  (`cperl-find-pods-heres'): do not warn on `=cut' if doing a chunk only.
739
740 ;;;; After 3.13:
741 ;;;  (`cperl-mode'): load pseudo-faces on `cperl-find-pods-heres' (for 19.30).
742 ;;;  (`x-color-defined-p'): was not compiling on XEmacs
743 ;;;  (`cperl-find-pods-heres'): 1 << 6 was OK, but 1<<6 was considered as HERE
744 ;;;                             <file/glob> made into a string.
745
746 ;;;; After 3.14:
747 ;;;  (`cperl-find-pods-heres'): Postpone addition of faces after syntactic step
748 ;;;                             Recognition of <FH> was wrong.
749 ;;;  (`cperl-clobber-lisp-bindings'): if set, C-c variants are the old ones
750 ;;;  (`cperl-unwind-to-safe'):  New function.
751 ;;;  (`cperl-fontify-syntaxically'): Use `cperl-unwind-to-safe' to start at reasonable position.
752
753 ;;;; After 3.15:
754 ;;;  (`cperl-forward-re'):      Highlight the trailing / in s/foo// as string.
755 ;;;                     Highlight the starting // in s//foo/ as function-name.
756
757 ;;;; After 3.16:
758 ;;;  (`cperl-find-pods-heres'): Highlight `gem' in s///gem as a keyword.
759
760 ;;;; After 4.0:
761 ;;;  (`cperl-find-pods-heres'): `qr' added
762 ;;;  (`cperl-electric-keyword'):        Likewise
763 ;;;  (`cperl-electric-else'):           Likewise
764 ;;;  (`cperl-to-comment-or-eol'):       Likewise
765 ;;;  (`cperl-make-regexp-x'):   Likewise
766 ;;;  (`cperl-init-faces'):      Likewise, and `lock' (as overridable?).
767 ;;;  (`cperl-find-pods-heres'): Knows that split// is null-RE.
768 ;;;                             Highlights separators in 3-parts expressions
769 ;;;                             as labels.
770
771 ;;;; After 4.1:
772 ;;;  (`cperl-find-pods-heres'): <> was considered as a glob
773 ;;;  (`cperl-syntaxify-unwind'): New configuration variable
774 ;;;  (`cperl-fontify-m-as-s'):  New configuration variable
775
776 ;;;; After 4.2:
777 ;;;  (`cperl-find-pods-heres'): of the last line being `=head1' fixed.
778
779 ;;;  Handling of a long construct is still buggy if only the part of
780 ;;;  construct touches the updated region (we unwind to the start of
781 ;;;  long construct, but the end may have residual properties).
782
783 ;;;  (`cperl-unwind-to-safe'):  would not go to beginning of buffer.
784 ;;;  (`cperl-electric-pod'):    check for after-expr was performed
785 ;;;                             inside of POD too.
786
787 ;;;; After 4.3:
788 ;;;  (`cperl-backward-to-noncomment'):  better treatment of PODs and HEREs.
789
790 ;;;  Indent-line works good, but indent-region does not - at toplevel...
791 ;;;  (`cperl-unwind-to-safe'):  Signature changed.
792 ;;;  (`x-color-defined-p'):     was defmacro'ed with a tick.  Remove another def.
793 ;;;  (`cperl-clobber-mode-lists'): New configuration variable.
794 ;;;  (`cperl-array-face'): One of definitions was garbled.
795
796 ;;;; After 4.4:
797 ;;;  (`cperl-not-bad-style-regexp'):    Updated.
798 ;;;  (`cperl-make-regexp-x'):   Misprint in a message.
799 ;;;  (`cperl-find-pods-heres'): $a-1 ? foo : bar; was a regexp.
800 ;;;                             `<< (' was considered a start of POD.
801 ;;;  Init:                      `cperl-is-face' was busted.
802 ;;;  (`cperl-make-face'):       New macros.
803 ;;;  (`cperl-force-face'):      New macros.
804 ;;;  (`cperl-init-faces'):      Corrected to use new macros;
805 ;;;                             `if' for copying `reference-face' to
806 ;;;                             `constant-face' was backward.
807 ;;;  (`font-lock-other-type-face'): Done via `defface' too.
808
809 ;;;; After 4.5:
810 ;;;  (`cperl-init-faces-weak'): use `cperl-force-face'.
811 ;;;  (`cperl-after-block-p'):   After END/BEGIN we are a block.
812 ;;;  (`cperl-mode'):            `font-lock-unfontify-region-function'
813 ;;;                             was set to a wrong function.
814 ;;;  (`cperl-comment-indent'):  Commenting __END__ was not working.
815 ;;;  (`cperl-indent-for-comment'):      Likewise.
816 ;;;                             (Indenting is still misbehaving at toplevel.)
817
818 ;;;; After 4.5:
819 ;;;  (`cperl-unwind-to-safe'):  Signature changed, unwinds end too.
820 ;;;  (`cperl-find-pods-heres'): mark qq[]-etc sections as syntax-type=string
821 ;;;  (`cperl-fontify-syntaxically'): Unwinds start and end to go out of
822 ;;;                                  long strings (not very successful).
823
824 ;;;   >>>>  CPerl should be usable in write mode too now <<<<
825
826 ;;;  (`cperl-syntaxify-by-font-lock'): Better default - off in text-mode.
827 ;;;  (`cperl-tips'):            Updated docs.
828 ;;;  (`cperl-problems'):        Updated docs.
829
830 ;;;; After 4.6:
831 ;;;  (`cperl-calculate-indent'):        Did not consider `,' as continuation mark for statements.
832 ;;;  (`cperl-write-tags'):      Correct for XEmacs's `visit-tags-table-buffer'.
833
834 ;;;; After 4.7:
835 ;;;  (`cperl-calculate-indent'): Avoid parse-data optimization at toplevel.
836 ;;;                              Should indent correctly at toplevel too.
837 ;;;  (`cperl-tags-hier-init'):  Gross hack to pretend we work (are we?).
838 ;;;  (`cperl-find-pods-heres'): Was not processing sub protos after a comment ine.
839 ;;;                             Was treating $a++ <= 5 as a glob.
840
841 ;;;; After 4.8:
842 ;;;  (toplevel):                require custom unprotected => failure on 19.28.
843 ;;;  (`cperl-xemacs-p')         defined when compile too
844 ;;;  (`cperl-tags-hier-init'):  Another try to work around XEmacs problems
845 ;;;                             Better progress messages.
846 ;;;  (`cperl-find-tags'):       Was writing line/pos in a wrong order,
847 ;;;                             pos off by 1 and not at beg-of-line.
848 ;;;  (`cperl-etags-snarf-tag'): New macro
849 ;;;  (`cperl-etags-goto-tag-location'): New macro
850 ;;;  (`cperl-write-tags'):      When removing old TAGS info was not
851 ;;;                             relativizing filename
852
853 ;;;; After 4.9:
854 ;;;  (`cperl-version'):         New variable.  New menu entry
855
856 ;;;; After 4.10:
857 ;;;  (`cperl-tips'):            Updated.
858 ;;;  (`cperl-non-problems'):    Updated.
859 ;;;  random:                    References to future 20.3 removed.
860
861 ;;;; After 4.11:
862 ;;;  (`perl-font-lock-keywords'): Would not highlight `sub foo($$);'.
863 ;;;  Docstrings:                Menu was described as `CPerl' instead of `Perl'
864
865 ;;;; After 4.12:
866 ;;;  (`cperl-toggle-construct-fix'): Was toggling to t instead of 1.
867 ;;;  (`cperl-ps-print-init'):   Associate `cperl-array-face', `cperl-hash-face'
868 ;;;                             remove `font-lock-emphasized-face'.
869 ;;;                             remove `font-lock-other-emphasized-face'.
870 ;;;                             remove `font-lock-reference-face'.
871 ;;;                             remove `font-lock-keyword-face'.
872 ;;;                             Use `eval-after-load'.
873 ;;;  (`cperl-init-faces'):      remove init `font-lock-other-emphasized-face'.
874 ;;;                             remove init `font-lock-emphasized-face'.
875 ;;;                             remove init `font-lock-keyword-face'.
876 ;;;  (`cperl-tips-faces'):      New variable and an entry into Mini-docs.
877 ;;;  (`cperl-indent-region'):   Do not indent whitespace lines
878 ;;;  (`cperl-indent-exp'):      Was not processing else-blocks.
879 ;;;  (`cperl-calculate-indent'): Remove another parse-data optimization
880 ;;;                              at toplevel: would indent correctly.
881 ;;;  (`cperl-get-state'):       NOP line removed.
882
883 ;;;; After 4.13:
884 ;;;  (`cperl-ps-print-init'):   Remove not-CPerl-related faces.
885 ;;;  (`cperl-ps-print'):        New function and menu entry.
886 ;;;  (`cperl-ps-print-face-properties'):        New configuration variable.
887 ;;;  (`cperl-invalid-face'):    New configuration variable.
888 ;;;  (`cperl-nonoverridable-face'):     New face.  Renamed from
889 ;;;                                     `font-lock-other-type-face'.
890 ;;;  (`perl-font-lock-keywords'):       Highlight trailing whitespace
891 ;;;  (`cperl-contract-levels'): Documentation corrected.
892 ;;;  (`cperl-contract-level'):  Likewise.
893
894 ;;;; After 4.14:
895 ;;;  (`cperl-ps-print'): `ps-print-face-extension-alist' was not in old Emaxen,
896 ;;;                             same with `ps-extend-face-list'
897 ;;;  (`cperl-ps-extend-face-list'):     New macro.
898
899 ;;;; After 4.15:
900 ;;;  (`cperl-init-faces'):      Interpolate `cperl-invalid-face'.
901 ;;;  (`cperl-forward-re'):      Emit a meaningful error instead of a cryptic
902 ;;;                             one for uncomplete REx near end-of-buffer.
903 ;;;  (`cperl-find-pods-heres'): Tolerate unfinished REx at end-of-buffer.
904
905 ;;;; After 4.16:
906 ;;;  (`cperl-find-pods-heres'): `unwind-protect' was left commented.
907
908 ;;;; After 4.17:
909 ;;;  (`cperl-invalid-face'):    Change to ''underline.
910
911 ;;;; After 4.18:
912 ;;;  (`cperl-find-pods-heres'): / and ? after : start a REx.
913 ;;;  (`cperl-after-expr-p'):    Skip labels when checking
914 ;;;  (`cperl-calculate-indent'): Correct for labels when calculating
915 ;;;                                     indentation of continuations.
916 ;;;                             Docstring updated.
917
918 ;;;; After 4.19:
919 ;;;  Minor (mostly spelling) corrections from 20.3.3 merged.
920
921 ;;;; After 4.20:
922 ;;;  (`cperl-tips'):            Another workaround added.  Sent to RMS for 20.4.
923
924 ;;;; After 4.21:
925 ;;;  (`cperl-praise'):          Mention linear-time indent.
926 ;;;  (`cperl-find-pods-heres'): @if ? a : b was considered a REx.
927
928 ;;;; After 4.22:
929 ;;;  (`cperl-after-expr-p'):    Make true after __END__.
930 ;;;  (`cperl-electric-pod'):    "SYNOPSIS" was misspelled.
931
932 ;;;; After 4.23:
933 ;;;  (`cperl-beautify-regexp-piece'):   Was not allowing for *? after a class.
934 ;;;                                     Allow for POSIX char-classes.
935 ;;;                                     Remove trailing whitespace when
936 ;;;                                     adding new linebreak.
937 ;;;                                     Add a level counter to stop shallow.
938 ;;;                                     Indents unprocessed groups rigidly.
939 ;;;  (`cperl-beautify-regexp'): Add an optional count argument to go that
940 ;;;                             many levels deep.
941 ;;;  (`cperl-beautify-level'):  Likewise
942 ;;;  Menu:                      Add new entries to Regexp menu to do one level
943 ;;;  (`cperl-contract-level'):  Was entering an infinite loop
944 ;;;  (`cperl-find-pods-heres'): Typo (double quoting).
945 ;;;                             Was detecting < $file > as FH instead of glob.
946 ;;;                             Support for comments in RExen (except
947 ;;;                             for m#\#comment#x), governed by
948 ;;;                             `cperl-regexp-scan'.
949 ;;;  (`cperl-regexp-scan'):     New customization variable.
950 ;;;  (`cperl-forward-re'):      Improve logic of resetting syntax table.
951
952 ;;;; After 4.23 and: After 4.24:
953 ;;;  (`cperl-contract-levels'): Restore position.
954 ;;;  (`cperl-beautify-level'):  Likewise.
955 ;;;  (`cperl-beautify-regexp'): Likewise.
956 ;;;  (`cperl-commentify'):      Rudimental support for length=1 runs
957 ;;;  (`cperl-find-pods-heres'): Process 1-char long REx comments too /a#/x
958 ;;;                             Processes REx-comments in #-delimited RExen.
959 ;;;                             MAJOR BUG CORRECTED: after a misparse
960 ;;;                               a body of a subroutine could be corrupted!!!
961 ;;;                               One might need to reeval the function body
962 ;;;                               to fix things.  (A similar bug was
963 ;;;                               present in `cperl-indent-region' eons ago.)
964 ;;; To reproduce:
965 ;;   (defun foo () (let ((a '(t))) (insert (format "%s" a)) (setcar a 'BUG) t))
966 ;;   (foo)
967 ;;   (foo)
968 ;;; C-x C-e the above three lines (at end-of-line).  First evaluation
969 ;;; of `foo' inserts (t), second one inserts (BUG) ?!
970 ;;;
971 ;;; In CPerl it was triggered by inserting then deleting `/' at start of
972 ;;;      /  a (?# asdf  {[(}asdf )ef,/;
973
974 ;;;; After 4.25:
975 ;;; (`cperl-commentify'):       Was recognizing length=2 "strings" as length=1.
976 ;;; (`imenu-example--create-perl-index'):
977 ;;;                             Was not enforcing syntaxification-to-the-end.
978 ;;; (`cperl-invert-if-unless'): Allow `for', `foreach'.
979 ;;; (`cperl-find-pods-heres'):  Quote `cperl-nonoverridable-face'.
980 ;;;                             Mark qw(), m()x as indentable.
981 ;;; (`cperl-init-faces'):       Highlight `sysopen' too.
982 ;;;                             Highlight $var in `for my $var' too.
983 ;;; (`cperl-invert-if-unless'): Was leaving whitespace at end.
984 ;;; (`cperl-linefeed'):         Was splitting $var{$foo} if point after `{'.
985 ;;; (`cperl-calculate-indent'): Remove old commented out code.
986 ;;;                             Support (primitive) indentation of qw(), m()x.
987
988
989 ;;;; After 4.26:
990 ;;; (`cperl-problems'):         Mention `fill-paragraph' on comment. \"" and
991 ;;;                             q [] with intervening newlines.
992 ;;; (`cperl-autoindent-on-semi'):       New customization variable.
993 ;;; (`cperl-electric-semi'):    Use `cperl-autoindent-on-semi'.
994 ;;; (`cperl-tips'):             Mention how to make CPerl the default mode.
995 ;;; (`cperl-mode'):             Support `outline-minor-mode'
996 ;;;                             (Thanks to Mark A. Hershberger).
997 ;;; (`cperl-outline-level'):    New function.
998 ;;; (`cperl-highlight-variables-indiscriminately'):     New customization var.
999 ;;; (`cperl-init-faces'):       Use `cperl-highlight-variables-indiscriminately'.
1000 ;;;                             (Thanks to Sean Kamath <kamath@pogo.wv.tek.com>).
1001 ;;; (`cperl-after-block-p'):    Support CHECK and INIT.
1002 ;;; (`cperl-init-faces'):       Likewise and "our".
1003 ;;;                             (Thanks to Doug MacEachern <dougm@covalent.net>).
1004 ;;; (`cperl-short-docs'):       Likewise and "our".
1005
1006
1007 ;;;; After 4.27:
1008 ;;; (`cperl-find-pods-heres'):  Recognize \"" as a string.
1009 ;;;                             Mark whitespace and comments between q and []
1010 ;;;                               as `syntax-type' => `prestring'.
1011 ;;;                             Allow whitespace between << and "FOO".
1012 ;;; (`cperl-problems'):         Remove \"" and q [] with intervening newlines.
1013 ;;;                             Mention multiple <<EOF as unsupported.
1014 ;;; (`cperl-highlight-variables-indiscriminately'):     Doc misprint fixed.
1015 ;;; (`cperl-indent-parens-as-block'):   New configuration variable.
1016 ;;; (`cperl-calculate-indent'): Merge cases of indenting non-BLOCK groups.
1017 ;;;                             Use `cperl-indent-parens-as-block'.
1018 ;;; (`cperl-find-pods-heres'):  Test for =cut without empty line instead of
1019 ;;;                             complaining about no =cut.
1020 ;;; (`cperl-electric-pod'):     Change the REx for POD from "\n\n=" to "^\n=".
1021 ;;; (`cperl-find-pods-heres'):  Likewise.
1022 ;;; (`cperl-electric-pod'):     Change `forward-sexp' to `forward-word':
1023 ;;;                             POD could've been marked as comment already.
1024 ;;; (`cperl-unwind-to-safe'):   Unwind before start of POD too.
1025
1026 ;;;; After 4.28:
1027 ;;; (`cperl-forward-re'):       Throw an error at proper moment REx unfinished.
1028
1029 ;;;; After 4.29:
1030 ;;; (`x-color-defined-p'):      Make an extra case to peacify the warning.
1031 ;;; Toplevel:                   `defvar' to peacify the warnings.
1032 ;;; (`cperl-find-pods-heres'):  Could access `font-lock-comment-face' in -nw.
1033 ;;;;                            No -nw-compile time warnings now.
1034 ;;; (`cperl-find-tags'):        TAGS file had too short substring-to-search.
1035 ;;;                             Be less verbose in non-interactive mode
1036 ;;; (`imenu-example--create-perl-index'):       Set index-marker after name
1037 ;;; (`cperl-outline-regexp'):   New variable.
1038 ;;; (`cperl-outline-level'):    Made compatible with `cperl-outline-regexp'.
1039 ;;; (`cperl-mode'):             Made use `cperl-outline-regexp'.
1040
1041 ;;;; After 4.30:
1042 ;;; (`cperl-find-pods-heres'):  =cut the last thing, no blank line, was error.
1043 ;;; (`cperl-outline-level'):    Make start-of-file same level as `package'.
1044
1045 ;;;; After 4.31:
1046 ;;; (`cperl-electric-pod'):     `head1' and `over' electric only if empty.
1047 ;;; (`cperl-unreadable-ok'):    New variable.
1048 ;;; (`cperl-find-tags'):        Use `cperl-unreadable-ok', do not fail
1049 ;;;                             on an unreadable file
1050 ;;; (`cperl-write-tags'):       Use `cperl-unreadable-ok', do not fail
1051 ;;;                             on an unreadable directory
1052
1053 ;;;; After 4.32:
1054 ;;;  Syncronized with v1.60 from Emacs 21.3.
1055 ;;;  Mostly docstring and formatting changes, and:
1056
1057 ;;;  (`cperl-noscan-files-regexp'): Do not scan CVS subdirs
1058 ;;;  (`cperl-problems'):        Note that newer XEmacsen may syntaxify too
1059 ;;;  (`imenu-example--create-perl-index'):
1060 ;;;                             Renamed to `cperl-imenu--create-perl-index'
1061 ;;;  (`cperl-mode'):            Replace `make-variable-buffer-local' by `make-local-variable'
1062 ;;;  (`cperl-setup-tmp-buf'):   Likewise
1063 ;;;  (`cperl-fix-line-spacing'): Fix a misprint of "t" for "\t"
1064 ;;;  (`cperl-next-bad-style'):  Fix misprints in character literals
1065
1066 ;;;; After 4.33:
1067 ;;;  (`cperl-font-lock-keywords'): +etc: Aliased to perl-font-lock-keywords.
1068
1069 ;;;; After 4.34:
1070 ;;;  Further updates of whitespace and spelling w.r.t. RMS version.
1071 ;;;  (`cperl-font-lock-keywords'): +etc: Avoid warnings when aliasing.
1072 ;;;  (`cperl-mode'):            Use `normal-auto-fill-function' if present.
1073 ;;;  (`cperl-use-major-mode'):  New variable
1074 ;;;  (`cperl-can-font-lock'):   New variable; replaces `window-system'
1075 ;;;  (`cperl-tags-hier-init'):  use `display-popup-menus-p' (if present)
1076 ;;;                             to choose `x-popup-menu' vs `tmm-prompt'
1077
1078 ;;;; 4.35 has the following differences from version 1.40+ of RMS Emacs:
1079
1080 ;;; New variables `cperl-use-major-mode', `cperl-can-font-lock';
1081 ;;; `cperl-use-major-mode' is (effectively) 'cperl-mode in RMS.
1082 ;;; `cperl-under-as-char'  is nil in RMS.
1083 ;;; Minor differences in docstrings, and `cperl-non-problems'.
1084 ;;; Backward compatibility addressed: (`); (function (lambda ...)); font-lock;
1085 ;;; (:italic t bold t) vs (:slant italic :weight bold) in faces;
1086 ;;; `normal-auto-fill-function'.
1087 ;;; RMS version has wrong logic in `cperl-calculate-indent': $a = { } is
1088 ;;; wrongly indented if the closing brace is on a separate line.
1089 ;;; Different choice of ordering if's for is-x-REx and (eq (char-after b) ?\#)
1090 ;;; in `cperl-find-pods-heres'. [Cosmetic]
1091
1092 ;;;; After 4.35:
1093 ;;;  (`cperl-find-pods-heres'): If no end of HERE-doc found, mark to the end
1094 ;;;                             of buffer.  This enables recognition of end
1095 ;;;                             of HERE-doc "as one types".
1096 ;;;                             Require "\n" after trailing tag of HERE-doc.
1097 ;;;                             \( made non-quoting outside of string/comment
1098 ;;;                             (gdj-contributed).
1099 ;;;                             Likewise for \$.
1100 ;;;                             Remove `here-doc-group' text property at start
1101 ;;;                             (makes this property reliable).
1102 ;;;                             Text property `first-format-line' ==> t.
1103 ;;;                             Do not recognize $opt_s and $opt::s as s///.
1104 ;;;  (`cperl-perldoc'):         Use case-sensitive search (contributed).
1105 ;;;  (`cperl-fix-line-spacing'): Allow "_" in $vars of foreach etc. when
1106 ;;;                             underscore isn't a word char (gdj-contributed).
1107 ;;;  (`defun-prompt-regexp'):   Allow prototypes.
1108 ;;;  (`cperl-vc-header-alist'): Extract numeric version from the Id.
1109 ;;;  Toplevel:                  Put toggle-autohelp into the mode menu.
1110 ;;;                             Better docs for toggle/set/unset autohelp.
1111 ;;;  (`cperl-electric-backspace-untabify'): New customization variable
1112 ;;;  (`cperl-after-expr-p'):    Works after here-docs, formats, and PODs too
1113 ;;;                             (affects many electric constructs).
1114 ;;;  (`cperl-calculate-indent'): Takes into account `first-format-line' ==>
1115 ;;;                             works after format.
1116 ;;;  (`cperl-short-docs'):      Make it work with ... too.
1117 ;;;                             "array context" ==> "list context"
1118 ;;;  (`cperl-electric-keyword'): make $if (etc: "$@%&*") non-electric
1119 ;;;                             '(' after keyword would insert a doubled paren
1120 ;;;  (`cperl-electric-paren'):  documented affected by `cperl-electric-parens'
1121 ;;;  (`cperl-electric-rparen'): Likewise
1122 ;;;  (`cperl-build-manpage'):   New function by Nick Roberts
1123 ;;;  (`cperl-perldoc'):         Make it work in XEmacs too
1124
1125 ;;;; After 4.36:
1126 ;;;  (`cperl-find-pods-heres'): Recognize s => 1 and {s} (as a key or varname),
1127 ;;;                             { s:: } and { s::bar::baz } as varnames.
1128 ;;;  (`cperl-after-expr-p'):    Updates syntaxification before checks
1129 ;;;  (`cperl-calculate-indent'): Likewise
1130 ;;;                             Fix wrong indent of blocks starting with POD
1131 ;;;  (`cperl-after-block-p'):   Optional argument for checking for a pre-block
1132 ;;;                             Recognize `continue' blocks too.
1133 ;;;  (`cperl-electric-brace'):  use `cperl-after-block-p' for detection;
1134 ;;;                             Now works for else/continue/sub blocks
1135 ;;;  (`cperl-short-docs'):      Minor edits; make messages fit 80-column screen
1136
1137 ;;; Code:
1138
1139 \f
1140 (if (fboundp 'eval-when-compile)
1141     (eval-when-compile
1142       (condition-case nil
1143           (require 'custom)
1144         (error nil))
1145       (condition-case nil
1146           (require 'man)
1147         (error nil))
1148       (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1149       (defvar cperl-can-font-lock
1150         (or cperl-xemacs-p
1151             (and (boundp 'emacs-major-version)
1152                  (or window-system
1153                      (> emacs-major-version 20)))))
1154       (if cperl-can-font-lock
1155           (require 'font-lock))
1156       (defvar msb-menu-cond)
1157       (defvar gud-perldb-history)
1158       (defvar font-lock-background-mode) ; not in Emacs
1159       (defvar font-lock-display-type)   ; ditto
1160       (or (fboundp 'defgroup)
1161           (defmacro defgroup (name val doc &rest arr)
1162             nil))
1163       (or (fboundp 'custom-declare-variable)
1164           (defmacro defcustom (name val doc &rest arr)
1165             (` (defvar (, name) (, val) (, doc)))))
1166       (or (and (fboundp 'custom-declare-variable)
1167                (string< "19.31" emacs-version)) ;  Checked with 19.30: defface does not work
1168           (defmacro defface (&rest arr)
1169             nil))
1170       ;; Avoid warning (tmp definitions)
1171       (or (fboundp 'x-color-defined-p)
1172           (defmacro x-color-defined-p (col)
1173             (cond ((fboundp 'color-defined-p) (` (color-defined-p (, col))))
1174                   ;; XEmacs >= 19.12
1175                   ((fboundp 'valid-color-name-p) (` (valid-color-name-p (, col))))
1176                   ;; XEmacs 19.11
1177                   ((fboundp 'x-valid-color-name-p) (` (x-valid-color-name-p (, col))))
1178                   (t '(error "Cannot implement color-defined-p")))))
1179       (defmacro cperl-is-face (arg)     ; Takes quoted arg
1180         (cond ((fboundp 'find-face)
1181                (` (find-face (, arg))))
1182               (;;(and (fboundp 'face-list)
1183                ;;       (face-list))
1184                (fboundp 'face-list)
1185                (` (member (, arg) (and (fboundp 'face-list)
1186                                        (face-list)))))
1187               (t
1188                (` (boundp (, arg))))))
1189       (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
1190         (cond ((fboundp 'make-face)
1191                (` (make-face (quote (, arg)))))
1192               (t
1193                (` (defvar (, arg) (quote (, arg)) (, descr))))))
1194       (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
1195         (` (progn
1196              (or (cperl-is-face (quote (, arg)))
1197                  (cperl-make-face (, arg) (, descr)))
1198              (or (boundp (quote (, arg))) ; We use unquoted variants too
1199                  (defvar (, arg) (quote (, arg)) (, descr))))))
1200       (if cperl-xemacs-p
1201           (defmacro cperl-etags-snarf-tag (file line)
1202             (` (progn
1203                  (beginning-of-line 2)
1204                  (list (, file) (, line)))))
1205         (defmacro cperl-etags-snarf-tag (file line)
1206           (` (etags-snarf-tag))))
1207       (if cperl-xemacs-p
1208           (defmacro cperl-etags-goto-tag-location (elt)
1209             (`;;(progn
1210              ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
1211              ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
1212              ;; Probably will not work due to some save-excursion???
1213              ;; Or save-file-position?
1214              ;; (message "Did I get to line %s?" (elt (, elt) 1))
1215              (goto-line (string-to-int (elt (, elt) 1)))))
1216         ;;)
1217         (defmacro cperl-etags-goto-tag-location (elt)
1218           (` (etags-goto-tag-location (, elt)))))))
1219
1220 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1221
1222 (defvar cperl-can-font-lock
1223   (or cperl-xemacs-p
1224       (and (boundp 'emacs-major-version)
1225            (or window-system
1226                (> emacs-major-version 20)))))
1227
1228 (condition-case nil
1229     (require 'custom)
1230   (error nil))                          ; Already fixed by eval-when-compile
1231
1232 (defun cperl-choose-color (&rest list)
1233   (let (answer)
1234     (while list
1235       (or answer
1236           (if (or (x-color-defined-p (car list))
1237                   (null (cdr list)))
1238               (setq answer (car list))))
1239       (setq list (cdr list)))
1240     answer))
1241
1242 \f
1243 (defgroup cperl nil
1244   "Major mode for editing Perl code."
1245   :prefix "cperl-"
1246   :group 'languages)
1247
1248 (defgroup cperl-indentation-details nil
1249   "Indentation."
1250   :prefix "cperl-"
1251   :group 'cperl)
1252
1253 (defgroup cperl-affected-by-hairy nil
1254   "Variables affected by `cperl-hairy'."
1255   :prefix "cperl-"
1256   :group 'cperl)
1257
1258 (defgroup cperl-autoinsert-details nil
1259   "Auto-insert tuneup."
1260   :prefix "cperl-"
1261   :group 'cperl)
1262
1263 (defgroup cperl-faces nil
1264   "Fontification colors."
1265   :prefix "cperl-"
1266   :group 'cperl)
1267
1268 (defgroup cperl-speed nil
1269   "Speed vs. validity tuneup."
1270   :prefix "cperl-"
1271   :group 'cperl)
1272
1273 (defgroup cperl-help-system nil
1274   "Help system tuneup."
1275   :prefix "cperl-"
1276   :group 'cperl)
1277
1278 \f
1279 (defcustom cperl-extra-newline-before-brace nil
1280   "*Non-nil means that if, elsif, while, until, else, for, foreach
1281 and do constructs look like:
1282
1283         if ()
1284         {
1285         }
1286
1287 instead of:
1288
1289         if () {
1290         }"
1291   :type 'boolean
1292   :group 'cperl-autoinsert-details)
1293
1294 (defcustom cperl-extra-newline-before-brace-multiline
1295   cperl-extra-newline-before-brace
1296   "*Non-nil means the same as `cperl-extra-newline-before-brace', but
1297 for constructs with multiline if/unless/while/until/for/foreach condition."
1298   :type 'boolean
1299   :group 'cperl-autoinsert-details)
1300
1301 (defcustom cperl-indent-level 2
1302   "*Indentation of CPerl statements with respect to containing block."
1303   :type 'integer
1304   :group 'cperl-indentation-details)
1305
1306 (defcustom cperl-lineup-step nil
1307   "*`cperl-lineup' will always lineup at multiple of this number.
1308 If nil, the value of `cperl-indent-level' will be used."
1309   :type '(choice (const nil) integer)
1310   :group 'cperl-indentation-details)
1311
1312 (defcustom cperl-brace-imaginary-offset 0
1313   "*Imagined indentation of a Perl open brace that actually follows a statement.
1314 An open brace following other text is treated as if it were this far
1315 to the right of the start of its line."
1316   :type 'integer
1317   :group 'cperl-indentation-details)
1318
1319 (defcustom cperl-brace-offset 0
1320   "*Extra indentation for braces, compared with other text in same context."
1321   :type 'integer
1322   :group 'cperl-indentation-details)
1323 (defcustom cperl-label-offset -2
1324   "*Offset of CPerl label lines relative to usual indentation."
1325   :type 'integer
1326   :group 'cperl-indentation-details)
1327 (defcustom cperl-min-label-indent 1
1328   "*Minimal offset of CPerl label lines."
1329   :type 'integer
1330   :group 'cperl-indentation-details)
1331 (defcustom cperl-continued-statement-offset 2
1332   "*Extra indent for lines not starting new statements."
1333   :type 'integer
1334   :group 'cperl-indentation-details)
1335 (defcustom cperl-continued-brace-offset 0
1336   "*Extra indent for substatements that start with open-braces.
1337 This is in addition to cperl-continued-statement-offset."
1338   :type 'integer
1339   :group 'cperl-indentation-details)
1340 (defcustom cperl-close-paren-offset -1
1341   "*Extra indent for substatements that start with close-parenthesis."
1342   :type 'integer
1343   :group 'cperl-indentation-details)
1344
1345 (defcustom cperl-auto-newline nil
1346   "*Non-nil means automatically newline before and after braces,
1347 and after colons and semicolons, inserted in CPerl code.  The following
1348 \\[cperl-electric-backspace] will remove the inserted whitespace.
1349 Insertion after colons requires both this variable and
1350 `cperl-auto-newline-after-colon' set."
1351   :type 'boolean
1352   :group 'cperl-autoinsert-details)
1353
1354 (defcustom cperl-autoindent-on-semi nil
1355   "*Non-nil means automatically indent after insertion of (semi)colon.
1356 Active if `cperl-auto-newline' is false."
1357   :type 'boolean
1358   :group 'cperl-autoinsert-details)
1359
1360 (defcustom cperl-auto-newline-after-colon nil
1361   "*Non-nil means automatically newline even after colons.
1362 Subject to `cperl-auto-newline' setting."
1363   :type 'boolean
1364   :group 'cperl-autoinsert-details)
1365
1366 (defcustom cperl-tab-always-indent t
1367   "*Non-nil means TAB in CPerl mode should always reindent the current line,
1368 regardless of where in the line point is when the TAB command is used."
1369   :type 'boolean
1370   :group 'cperl-indentation-details)
1371
1372 (defcustom cperl-font-lock nil
1373   "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
1374 Can be overwritten by `cperl-hairy' if nil."
1375   :type '(choice (const null) boolean)
1376   :group 'cperl-affected-by-hairy)
1377
1378 (defcustom cperl-electric-lbrace-space nil
1379   "*Non-nil (and non-null) means { after $ should be preceded by ` '.
1380 Can be overwritten by `cperl-hairy' if nil."
1381   :type '(choice (const null) boolean)
1382   :group 'cperl-affected-by-hairy)
1383
1384 (defcustom cperl-electric-parens-string "({[]})<"
1385   "*String of parentheses that should be electric in CPerl.
1386 Closing ones are electric only if the region is highlighted."
1387   :type 'string
1388   :group 'cperl-affected-by-hairy)
1389
1390 (defcustom cperl-electric-parens nil
1391   "*Non-nil (and non-null) means parentheses should be electric in CPerl.
1392 Can be overwritten by `cperl-hairy' if nil."
1393   :type '(choice (const null) boolean)
1394   :group 'cperl-affected-by-hairy)
1395
1396 (defvar zmacs-regions)                  ; Avoid warning
1397
1398 (defcustom cperl-electric-parens-mark
1399   (and window-system
1400        (or (and (boundp 'transient-mark-mode) ; For Emacs
1401                 transient-mark-mode)
1402            (and (boundp 'zmacs-regions) ; For XEmacs
1403                 zmacs-regions)))
1404   "*Not-nil means that electric parens look for active mark.
1405 Default is yes if there is visual feedback on mark."
1406   :type 'boolean
1407   :group 'cperl-autoinsert-details)
1408
1409 (defcustom cperl-electric-linefeed nil
1410   "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
1411 In any case these two mean plain and hairy linefeeds together.
1412 Can be overwritten by `cperl-hairy' if nil."
1413   :type '(choice (const null) boolean)
1414   :group 'cperl-affected-by-hairy)
1415
1416 (defcustom cperl-electric-keywords nil
1417   "*Not-nil (and non-null) means keywords are electric in CPerl.
1418 Can be overwritten by `cperl-hairy' if nil."
1419   :type '(choice (const null) boolean)
1420   :group 'cperl-affected-by-hairy)
1421
1422 (defcustom cperl-electric-backspace-untabify t
1423   "*Not-nil means electric-backspace will untabify in CPerl."
1424   :type 'boolean
1425   :group 'cperl-autoinsert-details)
1426
1427 (defcustom cperl-hairy nil
1428   "*Not-nil means most of the bells and whistles are enabled in CPerl.
1429 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
1430 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
1431 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
1432 `cperl-lazy-help-time'."
1433   :type 'boolean
1434   :group 'cperl-affected-by-hairy)
1435
1436 (defcustom cperl-comment-column 32
1437   "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
1438   :type 'integer
1439   :group 'cperl-indentation-details)
1440
1441 (defcustom cperl-vc-header-alist '((SCCS "($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
1442                                    (RCS "($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/) ;"))
1443   "*What to use as `vc-header-alist' in CPerl."
1444   :type '(repeat (list symbol string))
1445   :group 'cperl)
1446
1447 (defcustom cperl-clobber-mode-lists
1448   (not
1449    (and
1450     (boundp 'interpreter-mode-alist)
1451     (assoc "miniperl" interpreter-mode-alist)
1452     (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
1453   "*Whether to install us into `interpreter-' and `extension' mode lists."
1454   :type 'boolean
1455   :group 'cperl)
1456
1457 (defcustom cperl-info-on-command-no-prompt nil
1458   "*Not-nil (and non-null) means not to prompt on C-h f.
1459 The opposite behaviour is always available if prefixed with C-c.
1460 Can be overwritten by `cperl-hairy' if nil."
1461   :type '(choice (const null) boolean)
1462   :group 'cperl-affected-by-hairy)
1463
1464 (defcustom cperl-clobber-lisp-bindings nil
1465   "*Not-nil (and non-null) means not overwrite C-h f.
1466 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
1467 Can be overwritten by `cperl-hairy' if nil."
1468   :type '(choice (const null) boolean)
1469   :group 'cperl-affected-by-hairy)
1470
1471 (defcustom cperl-lazy-help-time nil
1472   "*Not-nil (and non-null) means to show lazy help after given idle time.
1473 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
1474   :type '(choice (const null) (const nil) integer)
1475   :group 'cperl-affected-by-hairy)
1476
1477 (defcustom cperl-pod-face 'font-lock-comment-face
1478   "*The result of evaluation of this expression is used for POD highlighting."
1479   :type 'face
1480   :group 'cperl-faces)
1481
1482 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
1483   "*The result of evaluation of this expression is used for POD highlighting.
1484 Font for POD headers."
1485   :type 'face
1486   :group 'cperl-faces)
1487
1488 (defcustom cperl-here-face 'font-lock-string-face
1489   "*The result of evaluation of this expression is used for here-docs highlighting."
1490   :type 'face
1491   :group 'cperl-faces)
1492
1493 (defcustom cperl-invalid-face ''underline ; later evaluated by `font-lock'
1494   "*The result of evaluation of this expression highlights trailing whitespace."
1495   :type 'face
1496   :group 'cperl-faces)
1497
1498 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
1499   "*Not-nil after evaluation means to highlight POD and here-docs sections."
1500   :type 'boolean
1501   :group 'cperl-faces)
1502
1503 (defcustom cperl-fontify-m-as-s t
1504   "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
1505   :type 'boolean
1506   :group 'cperl-faces)
1507
1508 (defcustom cperl-highlight-variables-indiscriminately nil
1509   "*Non-nil means perform additional highlighting on variables.
1510 Currently only changes how scalar variables are highlighted.
1511 Note that that variable is only read at initialization time for
1512 the variable `perl-font-lock-keywords-2', so changing it after you've
1513 entered CPerl mode the first time will have no effect."
1514   :type 'boolean
1515   :group 'cperl)
1516
1517 (defcustom cperl-pod-here-scan t
1518   "*Not-nil means look for POD and here-docs sections during startup.
1519 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
1520   :type 'boolean
1521   :group 'cperl-speed)
1522
1523 (defcustom cperl-regexp-scan t
1524   "*Not-nil means make marking of regular expression more thorough.
1525 Effective only with `cperl-pod-here-scan'.  Not implemented yet."
1526   :type 'boolean
1527   :group 'cperl-speed)
1528
1529 (defcustom cperl-imenu-addback nil
1530   "*Not-nil means add backreferences to generated `imenu's.
1531 May require patched `imenu' and `imenu-go'.  Obsolete."
1532   :type 'boolean
1533   :group 'cperl-help-system)
1534
1535 (defcustom cperl-max-help-size 66
1536   "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
1537   :type '(choice integer (const nil))
1538   :group 'cperl-help-system)
1539
1540 (defcustom cperl-shrink-wrap-info-frame t
1541   "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
1542   :type 'boolean
1543   :group 'cperl-help-system)
1544
1545 (defcustom cperl-info-page "perl"
1546   "*Name of the info page containing perl docs.
1547 Older version of this page was called `perl5', newer `perl'."
1548   :type 'string
1549   :group 'cperl-help-system)
1550
1551 (defcustom cperl-use-syntax-table-text-property
1552   (boundp 'parse-sexp-lookup-properties)
1553   "*Non-nil means CPerl sets up and uses `syntax-table' text property."
1554   :type 'boolean
1555   :group 'cperl-speed)
1556
1557 (defcustom cperl-use-syntax-table-text-property-for-tags
1558   cperl-use-syntax-table-text-property
1559   "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
1560   :type 'boolean
1561   :group 'cperl-speed)
1562
1563 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
1564   "*Regexp to match files to scan when generating TAGS."
1565   :type 'regexp
1566   :group 'cperl)
1567
1568 (defcustom cperl-noscan-files-regexp
1569   "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
1570   "*Regexp to match files/dirs to skip when generating TAGS."
1571   :type 'regexp
1572   :group 'cperl)
1573
1574 (defcustom cperl-regexp-indent-step nil
1575   "*Indentation used when beautifying regexps.
1576 If nil, the value of `cperl-indent-level' will be used."
1577   :type '(choice integer (const nil))
1578   :group 'cperl-indentation-details)
1579
1580 (defcustom cperl-indent-left-aligned-comments t
1581   "*Non-nil means that the comment starting in leftmost column should indent."
1582   :type 'boolean
1583   :group 'cperl-indentation-details)
1584
1585 (defcustom cperl-under-as-char t
1586   "*Non-nil means that the _ (underline) should be treated as word char."
1587   :type 'boolean
1588   :group 'cperl)
1589
1590 (defcustom cperl-extra-perl-args ""
1591   "*Extra arguments to use when starting Perl.
1592 Currently used with `cperl-check-syntax' only."
1593   :type 'string
1594   :group 'cperl)
1595
1596 (defcustom cperl-message-electric-keyword t
1597   "*Non-nil means that the `cperl-electric-keyword' prints a help message."
1598   :type 'boolean
1599   :group 'cperl-help-system)
1600
1601 (defcustom cperl-indent-region-fix-constructs 1
1602   "*Amount of space to insert between `}' and `else' or `elsif'
1603 in `cperl-indent-region'.  Set to nil to leave as is.  Values other
1604 than 1 and nil will probably not work."
1605   :type '(choice (const nil) (const 1))
1606   :group 'cperl-indentation-details)
1607
1608 (defcustom cperl-break-one-line-blocks-when-indent t
1609   "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
1610 need to be reformatted into multiline ones when indenting a region."
1611   :type 'boolean
1612   :group 'cperl-indentation-details)
1613
1614 (defcustom cperl-fix-hanging-brace-when-indent t
1615   "*Non-nil means that BLOCK-end `}' may be put on a separate line
1616 when indenting a region.
1617 Braces followed by else/elsif/while/until are excepted."
1618   :type 'boolean
1619   :group 'cperl-indentation-details)
1620
1621 (defcustom cperl-merge-trailing-else t
1622   "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
1623 may be merged to be on the same line when indenting a region."
1624   :type 'boolean
1625   :group 'cperl-indentation-details)
1626
1627 (defcustom cperl-indent-parens-as-block nil
1628   "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
1629 but for trailing \",\" inside the group, which won't increase indentation.
1630 One should tune up `cperl-close-paren-offset' as well."
1631   :type 'boolean
1632   :group 'cperl-indentation-details)
1633
1634 (defcustom cperl-syntaxify-by-font-lock
1635   (and cperl-can-font-lock
1636        (boundp 'parse-sexp-lookup-properties))
1637   "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
1638   :type '(choice (const message) boolean)
1639   :group 'cperl-speed)
1640
1641 (defcustom cperl-syntaxify-unwind
1642   t
1643   "*Non-nil means that CPerl unwinds to a start of a long construction
1644 when syntaxifying a chunk of buffer."
1645   :type 'boolean
1646   :group 'cperl-speed)
1647
1648 (defcustom cperl-ps-print-face-properties
1649   '((font-lock-keyword-face             nil nil         bold shadow)
1650     (font-lock-variable-name-face       nil nil         bold)
1651     (font-lock-function-name-face       nil nil         bold italic box)
1652     (font-lock-constant-face            nil "LightGray" bold)
1653     (cperl-array-face                   nil "LightGray" bold underline)
1654     (cperl-hash-face                    nil "LightGray" bold italic underline)
1655     (font-lock-comment-face             nil "LightGray" italic)
1656     (font-lock-string-face              nil nil         italic underline)
1657     (cperl-nonoverridable-face          nil nil         italic underline)
1658     (font-lock-type-face                nil nil         underline)
1659     (underline                          nil "LightGray" strikeout))
1660   "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
1661   :type '(repeat (cons symbol
1662                        (cons (choice (const nil) string)
1663                              (cons (choice (const nil) string)
1664                                    (repeat symbol)))))
1665   :group 'cperl-faces)
1666
1667 (if cperl-can-font-lock
1668     (progn
1669       (defvar cperl-dark-background
1670         (cperl-choose-color "navy" "os2blue" "darkgreen"))
1671       (defvar cperl-dark-foreground
1672         (cperl-choose-color "orchid1" "orange"))
1673
1674       (defface cperl-nonoverridable-face
1675         (` ((((class grayscale) (background light))
1676              (:background "Gray90" :italic t :underline t))
1677             (((class grayscale) (background dark))
1678              (:foreground "Gray80" :italic t :underline t :bold t))
1679             (((class color) (background light))
1680              (:foreground "chartreuse3"))
1681             (((class color) (background dark))
1682              (:foreground (, cperl-dark-foreground)))
1683             (t (:bold t :underline t))))
1684         "Font Lock mode face used to highlight array names."
1685         :group 'cperl-faces)
1686
1687       (defface cperl-array-face
1688         (` ((((class grayscale) (background light))
1689              (:background "Gray90" :bold t))
1690             (((class grayscale) (background dark))
1691              (:foreground "Gray80" :bold t))
1692             (((class color) (background light))
1693              (:foreground "Blue" :background "lightyellow2" :bold t))
1694             (((class color) (background dark))
1695              (:foreground "yellow" :background (, cperl-dark-background) :bold t))
1696             (t (:bold t))))
1697         "Font Lock mode face used to highlight array names."
1698         :group 'cperl-faces)
1699
1700       (defface cperl-hash-face
1701         (` ((((class grayscale) (background light))
1702              (:background "Gray90" :bold t :italic t))
1703             (((class grayscale) (background dark))
1704              (:foreground "Gray80" :bold t :italic t))
1705             (((class color) (background light))
1706              (:foreground "Red" :background "lightyellow2" :bold t :italic t))
1707             (((class color) (background dark))
1708              (:foreground "Red" :background (, cperl-dark-background) :bold t :italic t))
1709             (t (:bold t :italic t))))
1710         "Font Lock mode face used to highlight hash names."
1711         :group 'cperl-faces)))
1712
1713 \f
1714
1715 ;;; Short extra-docs.
1716
1717 (defvar cperl-tips 'please-ignore-this-line
1718   "Get maybe newer version of this package from
1719   ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
1720 and/or
1721   ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
1722 Subdirectory `cperl-mode' may contain yet newer development releases and/or
1723 patches to related files.
1724
1725 For best results apply to an older Emacs the patches from
1726   ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
1727 \(this upgrades syntax-parsing abilities of RMS Emaxen v19.34 and 
1728 v20.2 up to the level of RMS Emacs v20.3 - a must for a good Perl
1729 mode.)  As of beginning of 2003, XEmacs may provide a similar ability.
1730
1731 Get support packages choose-color.el (or font-lock-extra.el before
1732 19.30), imenu-go.el from the same place.  \(Look for other files there
1733 too... ;-).  Get a patch for imenu.el in 19.29.  Note that for 19.30 and
1734 later you should use choose-color.el *instead* of font-lock-extra.el
1735 \(and you will not get smart highlighting in C :-().
1736
1737 Note that to enable Compile choices in the menu you need to install
1738 mode-compile.el.
1739
1740 If your Emacs does not default to `cperl-mode' on Perl files, and you
1741 want it to: put the following into your .emacs file:
1742
1743   (autoload 'perl-mode \"cperl-mode\" \"alternate mode for editing Perl programs\" t)
1744
1745 or
1746
1747   (defalias 'perl-mode 'cperl-mode)
1748
1749 Get perl5-info from
1750   $CPAN/doc/manual/info/perl-info.tar.gz
1751 older version was on
1752   http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
1753
1754 If you use imenu-go, run imenu on perl5-info buffer (you can do it
1755 from Perl menu).  If many files are related, generate TAGS files from
1756 Tools/Tags submenu in Perl menu.
1757
1758 If some class structure is too complicated, use Tools/Hierarchy-view
1759 from Perl menu, or hierarchic view of imenu.  The second one uses the
1760 current buffer only, the first one requires generation of TAGS from
1761 Perl/Tools/Tags menu beforehand.
1762
1763 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
1764
1765 Switch auto-help on/off with Perl/Tools/Auto-help.
1766
1767 Though with contemporary Emaxen CPerl mode should maintain the correct
1768 parsing of Perl even when editing, sometimes it may be lost.  Fix this by
1769
1770   M-x norm RET
1771
1772 or
1773
1774   \\[normal-mode]
1775
1776 In cases of more severe confusion sometimes it is helpful to do
1777
1778   M-x load-l RET cperl-mode RET
1779   M-x norm RET
1780
1781 or
1782
1783   \\[load-library] cperl-mode RET
1784   \\[normal-mode]
1785
1786 Before reporting (non-)problems look in the problem section of online
1787 micro-docs on what I know about CPerl problems.")
1788
1789 (defvar cperl-problems 'please-ignore-this-line
1790   "Description of problems in CPerl mode.
1791 Some faces will not be shown on some versions of Emacs unless you
1792 install choose-color.el, available from
1793    ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
1794
1795 `fill-paragraph' on a comment may leave the point behind the
1796 paragraph.  Parsing of lines with several <<EOF is not implemented
1797 yet.
1798
1799 Emacs had a _very_ restricted syntax parsing engine until RMS's Emacs
1800 20.1.  Most problems below are corrected starting from this version of
1801 Emacs, and all of them should be fixed in RMS's version 20.3.  (Or apply
1802 patches to Emacs 19.33/34 - see tips.)  XEmacs was very backward in
1803 this respect (until 2003).
1804
1805 Note that even with newer Emacsen in some very rare cases the details
1806 of interaction of `font-lock' and syntaxification may be not cleaned
1807 up yet.  You may get slightly different colors basing on the order of
1808 fontification and syntaxification.  Say, the initial faces is correct,
1809 but editing the buffer breaks this.
1810
1811 Even with older Emacsen CPerl mode tries to corrects some Emacs
1812 misunderstandings, however, for efficiency reasons the degree of
1813 correction is different for different operations.  The partially
1814 corrected problems are: POD sections, here-documents, regexps.  The
1815 operations are: highlighting, indentation, electric keywords, electric
1816 braces.
1817
1818 This may be confusing, since the regexp s#//#/#\; may be highlighted
1819 as a comment, but it will be recognized as a regexp by the indentation
1820 code.  Or the opposite case, when a POD section is highlighted, but
1821 may break the indentation of the following code (though indentation
1822 should work if the balance of delimiters is not broken by POD).
1823
1824 The main trick (to make $ a \"backslash\") makes constructions like
1825 ${aaa} look like unbalanced braces.  The only trick I can think of is
1826 to insert it as $ {aaa} (legal in perl5, not in perl4).
1827
1828 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
1829 as /($|\\s)/.  Note that such a transposition is not always possible.
1830
1831 The solution is to upgrade your Emacs or patch an older one.  Note
1832 that RMS's 20.2 has some bugs related to `syntax-table' text
1833 properties.  Patches are available on the main CPerl download site,
1834 and on CPAN.
1835
1836 If these bugs cannot be fixed on your machine (say, you have an inferior
1837 environment and cannot recompile), you may still disable all the fancy stuff
1838 via `cperl-use-syntax-table-text-property'.")
1839
1840 (defvar cperl-non-problems 'please-ignore-this-line
1841 "As you know from `problems' section, Perl syntax is too hard for CPerl on 
1842 older Emacsen.  Here is what you can do if you cannot upgrade, or if
1843 you want to switch off these capabilities on RMS Emacs 20.2 (+patches) or 20.3
1844 or better.  Please skip this docs if you run a capable Emacs already.
1845
1846 Most of the time, if you write your own code, you may find an equivalent
1847 \(and almost as readable) expression (what is discussed below is usually
1848 not relevant on newer Emacsen, since they can do it automatically).
1849
1850 Try to help CPerl: add comments with embedded quotes to fix CPerl
1851 misunderstandings about the end of quotation:
1852
1853 $a='500$';      # ';
1854
1855 You won't need it too often.  The reason: $ \"quotes\" the following
1856 character (this saves a life a lot of times in CPerl), thus due to
1857 Emacs parsing rules it does not consider tick (i.e., ' ) after a
1858 dollar as a closing one, but as a usual character.  This is usually
1859 correct, but not in the above context.
1860
1861 Even with older Emacsen the indentation code is pretty wise.  The only
1862 drawback is that it relied on Emacs parsing to find matching
1863 parentheses.  And Emacs *could not* match parentheses in Perl 100%
1864 correctly.  So
1865         1 if s#//#/#;
1866 would not break indentation, but
1867         1 if ( s#//#/# );
1868 would.  Upgrade.
1869
1870 By similar reasons
1871         s\"abc\"def\";
1872 could confuse CPerl a lot.
1873
1874 If you still get wrong indentation in situation that you think the
1875 code should be able to parse, try:
1876
1877 a) Check what Emacs thinks about balance of your parentheses.
1878 b) Supply the code to me (IZ).
1879
1880 Pods were treated _very_ rudimentally.  Here-documents were not
1881 treated at all (except highlighting and inhibiting indentation).  Upgrade.
1882
1883 To speed up coloring the following compromises exist:
1884    a) sub in $mypackage::sub may be highlighted.
1885    b) -z in [a-z] may be highlighted.
1886    c) if your regexp contains a keyword (like \"s\"), it may be highlighted.
1887
1888
1889 Imenu in 19.31 is broken.  Set `imenu-use-keymap-menu' to t, and remove
1890 `car' before `imenu-choose-buffer-index' in `imenu'.
1891 `imenu-add-to-menubar' in 20.2 is broken.  
1892 A lot of things on XEmacs may be broken too, judging by bug reports I
1893 receive.  Note that some releases of XEmacs are better than the others
1894 as far as bugs reports I see are concerned.")
1895
1896 (defvar cperl-praise 'please-ignore-this-line
1897   "Advantages of CPerl mode.
1898
1899 0) It uses the newest `syntax-table' property ;-);
1900
1901 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
1902 mode - but the latter number may have improved too in last years) even
1903 with old Emaxen which do not support `syntax-table' property.
1904
1905 When using `syntax-table' property for syntax assist hints, it should
1906 handle 99.995% of lines correct - or somesuch.  It automatically
1907 updates syntax assist hints when you edit your script.
1908
1909 2) It is generally believed to be \"the most user-friendly Emacs
1910 package\" whatever it may mean (I doubt that the people who say similar
1911 things tried _all_ the rest of Emacs ;-), but this was not a lonely
1912 voice);
1913
1914 3) Everything is customizable, one-by-one or in a big sweep;
1915
1916 4) It has many easily-accessable \"tools\":
1917         a) Can run program, check syntax, start debugger;
1918         b) Can lineup vertically \"middles\" of rows, like `=' in
1919                 a  = b;
1920                 cc = d;
1921         c) Can insert spaces where this impoves readability (in one
1922                 interactive sweep over the buffer);
1923         d) Has support for imenu, including:
1924                 1) Separate unordered list of \"interesting places\";
1925                 2) Separate TOC of POD sections;
1926                 3) Separate list of packages;
1927                 4) Hierarchical view of methods in (sub)packages;
1928                 5) and functions (by the full name - with package);
1929         e) Has an interface to INFO docs for Perl; The interface is
1930                 very flexible, including shrink-wrapping of
1931                 documentation buffer/frame;
1932         f) Has a builtin list of one-line explanations for perl constructs.
1933         g) Can show these explanations if you stay long enough at the
1934                 corresponding place (or on demand);
1935         h) Has an enhanced fontification (using 3 or 4 additional faces
1936                 comparing to font-lock - basically, different
1937                 namespaces in Perl have different colors);
1938         i) Can construct TAGS basing on its knowledge of Perl syntax,
1939                 the standard menu has 6 different way to generate
1940                 TAGS (if \"by directory\", .xs files - with C-language
1941                 bindings - are included in the scan);
1942         j) Can build a hierarchical view of classes (via imenu) basing
1943                 on generated TAGS file;
1944         k) Has electric parentheses, electric newlines, uses Abbrev
1945                 for electric logical constructs
1946                         while () {}
1947                 with different styles of expansion (context sensitive
1948                 to be not so bothering).  Electric parentheses behave
1949                 \"as they should\" in a presence of a visible region.
1950         l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
1951         m) Can convert from
1952                 if (A) { B }
1953            to
1954                 B if A;
1955
1956         n) Highlights (by user-choice) either 3-delimiters constructs
1957            (such as tr/a/b/), or regular expressions and `y/tr';
1958         o) Highlights trailing whitespace;
1959         p) Is able to manipulate Perl Regular Expressions to ease
1960            conversion to a more readable form.
1961
1962 5) The indentation engine was very smart, but most of tricks may be
1963 not needed anymore with the support for `syntax-table' property.  Has
1964 progress indicator for indentation (with `imenu' loaded).
1965
1966 6) Indent-region improves inline-comments as well; also corrects
1967 whitespace *inside* the conditional/loop constructs.
1968
1969 7) Fill-paragraph correctly handles multi-line comments;
1970
1971 8) Can switch to different indentation styles by one command, and restore
1972 the settings present before the switch.
1973
1974 9) When doing indentation of control constructs, may correct
1975 line-breaks/spacing between elements of the construct.
1976
1977 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
1978 capable syntax engines).")
1979
1980 (defvar cperl-speed 'please-ignore-this-line
1981   "This is an incomplete compendium of what is available in other parts
1982 of CPerl documentation.  (Please inform me if I skept anything.)
1983
1984 There is a perception that CPerl is slower than alternatives.  This part
1985 of documentation is designed to overcome this misconception.
1986
1987 *By default* CPerl tries to enable the most comfortable settings.
1988 From most points of view, correctly working package is infinitely more
1989 comfortable than a non-correctly working one, thus by default CPerl
1990 prefers correctness over speed.  Below is the guide how to change
1991 settings if your preferences are different.
1992
1993 A)  Speed of loading the file.  When loading file, CPerl may perform a
1994 scan which indicates places which cannot be parsed by primitive Emacs
1995 syntax-parsing routines, and marks them up so that either
1996
1997     A1) CPerl may work around these deficiencies (for big chunks, mostly
1998         PODs and HERE-documents), or
1999     A2) On capable Emaxen CPerl will use improved syntax-handlings
2000         which reads mark-up hints directly.
2001
2002     The scan in case A2 is much more comprehensive, thus may be slower.
2003
2004     User can disable syntax-engine-helping scan of A2 by setting
2005        `cperl-use-syntax-table-text-property'
2006     variable to nil (if it is set to t).
2007
2008     One can disable the scan altogether (both A1 and A2) by setting
2009        `cperl-pod-here-scan'
2010     to nil.
2011
2012 B) Speed of editing operations.
2013
2014     One can add a (minor) speedup to editing operations by setting
2015        `cperl-use-syntax-table-text-property'
2016     variable to nil (if it is set to t).  This will disable
2017     syntax-engine-helping scan, thus will make many more Perl
2018     constructs be wrongly recognized by CPerl, thus may lead to
2019     wrongly matched parentheses, wrong indentation, etc.
2020
2021     One can unset `cperl-syntaxify-unwind'.  This might speed up editing
2022     of, say, long POD sections.")
2023
2024 (defvar cperl-tips-faces 'please-ignore-this-line
2025   "CPerl mode uses following faces for highlighting:
2026
2027   `cperl-array-face'            Array names
2028   `cperl-hash-face'             Hash names
2029   `font-lock-comment-face'      Comments, PODs and whatever is considered
2030                                 syntaxically to be not code
2031   `font-lock-constant-face'     HERE-doc delimiters, labels, delimiters of
2032                                 2-arg operators s/y/tr/ or of RExen,
2033   `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
2034                                 a target of a file tests, file tests,
2035                                 subroutine names at the moment of definition
2036                                 (except those conflicting with Perl operators),
2037                                 package names (when recognized), format names
2038   `font-lock-keyword-face'      Control flow switch constructs, declarators
2039   `cperl-nonoverridable-face'   Non-overridable keywords, modifiers of RExen
2040   `font-lock-string-face'       Strings, qw() constructs, RExen, POD sections,
2041                                 literal parts and the terminator of formats
2042                                 and whatever is syntaxically considered
2043                                 as string literals
2044   `font-lock-type-face'         Overridable keywords
2045   `font-lock-variable-name-face' Variable declarations, indirect array and
2046                                 hash names, POD headers/item names
2047   `cperl-invalid-face'          Trailing whitespace
2048
2049 Note that in several situations the highlighting tries to inform about
2050 possible confusion, such as different colors for function names in
2051 declarations depending on what they (do not) override, or special cases
2052 m// and s/// which do not do what one would expect them to do.
2053
2054 Help with best setup of these faces for printout requested (for each of
2055 the faces: please specify bold, italic, underline, shadow and box.)
2056
2057 \(Not finished.)")
2058
2059 \f
2060
2061 ;;; Portability stuff:
2062
2063 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
2064   (` (define-key cperl-mode-map
2065        (, (if xemacs-key
2066               (` (if cperl-xemacs-p (, xemacs-key) (, emacs-key)))
2067             emacs-key))
2068        (, definition))))
2069
2070 (defvar cperl-del-back-ch
2071   (car (append (where-is-internal 'delete-backward-char)
2072                (where-is-internal 'backward-delete-char-untabify)))
2073   "Character generated by key bound to `delete-backward-char'.")
2074
2075 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
2076      (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
2077
2078 (defun cperl-mark-active () (mark))     ; Avoid undefined warning
2079 (if cperl-xemacs-p
2080     (progn
2081       ;; "Active regions" are on: use region only if active
2082       ;; "Active regions" are off: use region unconditionally
2083       (defun cperl-use-region-p ()
2084         (if zmacs-regions (mark) t)))
2085   (defun cperl-use-region-p ()
2086     (if transient-mark-mode mark-active t))
2087   (defun cperl-mark-active () mark-active))
2088
2089 (defsubst cperl-enable-font-lock ()
2090   cperl-can-font-lock)
2091
2092 (defun cperl-putback-char (c)           ; Emacs 19
2093   (set 'unread-command-events (list c))) ; Avoid undefined warning
2094
2095 (if (boundp 'unread-command-events)
2096     (if cperl-xemacs-p
2097         (defun cperl-putback-char (c)   ; XEmacs >= 19.12
2098           (setq unread-command-events (list (eval '(character-to-event c))))))
2099   (defun cperl-putback-char (c)         ; XEmacs <= 19.11
2100     (set 'unread-command-event (eval '(character-to-event c))))) ; Avoid warnings
2101
2102 (or (fboundp 'uncomment-region)
2103     (defun uncomment-region (beg end)
2104       (interactive "r")
2105       (comment-region beg end -1)))
2106
2107 (defvar cperl-do-not-fontify
2108   (if (string< emacs-version "19.30")
2109       'fontified
2110     'lazy-lock)
2111   "Text property which inhibits refontification.")
2112
2113 (defsubst cperl-put-do-not-fontify (from to &optional post)
2114   ;; If POST, do not do it with postponed fontification
2115   (if (and post cperl-syntaxify-by-font-lock)
2116       nil
2117     (put-text-property (max (point-min) (1- from))
2118                        to cperl-do-not-fontify t)))
2119
2120 (defcustom cperl-mode-hook nil
2121   "Hook run by CPerl mode."
2122   :type 'hook
2123   :group 'cperl)
2124
2125 (defvar cperl-syntax-state nil)
2126 (defvar cperl-syntax-done-to nil)
2127 (defvar cperl-emacs-can-parse (> (length (save-excursion
2128                                            (parse-partial-sexp (point) (point)))) 9))
2129 \f
2130 ;; Make customization possible "in reverse"
2131 (defsubst cperl-val (symbol &optional default hairy)
2132   (cond
2133    ((eq (symbol-value symbol) 'null) default)
2134    (cperl-hairy (or hairy t))
2135    (t (symbol-value symbol))))
2136 \f
2137 ;;; Probably it is too late to set these guys already, but it can help later:
2138
2139 (and cperl-clobber-mode-lists
2140      (setq auto-mode-alist
2141       (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode))  auto-mode-alist ))
2142      (and (boundp 'interpreter-mode-alist)
2143           (setq interpreter-mode-alist (append interpreter-mode-alist
2144                                                '(("miniperl" . perl-mode))))))
2145 (if (fboundp 'eval-when-compile)
2146     (eval-when-compile
2147       (mapcar (lambda (p)
2148                 (condition-case nil
2149                     (require p)
2150                   (error nil)))
2151               '(imenu easymenu etags timer man info))
2152       (if (fboundp 'ps-extend-face-list)
2153           (defmacro cperl-ps-extend-face-list (arg)
2154             (` (ps-extend-face-list (, arg))))
2155         (defmacro cperl-ps-extend-face-list (arg)
2156           (` (error "This version of Emacs has no `ps-extend-face-list'"))))
2157       ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
2158       ;; macros instead of defsubsts don't work on Emacs, so we do the
2159       ;; expansion manually.  Any other suggestions?
2160       (if cperl-can-font-lock
2161           (require 'font-lock))
2162       (require 'cl)))
2163
2164 (defvar cperl-mode-abbrev-table nil
2165   "Abbrev table in use in CPerl mode buffers.")
2166
2167 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
2168
2169 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
2170
2171 (if cperl-mode-map nil
2172   (setq cperl-mode-map (make-sparse-keymap))
2173   (cperl-define-key "{" 'cperl-electric-lbrace)
2174   (cperl-define-key "[" 'cperl-electric-paren)
2175   (cperl-define-key "(" 'cperl-electric-paren)
2176   (cperl-define-key "<" 'cperl-electric-paren)
2177   (cperl-define-key "}" 'cperl-electric-brace)
2178   (cperl-define-key "]" 'cperl-electric-rparen)
2179   (cperl-define-key ")" 'cperl-electric-rparen)
2180   (cperl-define-key ";" 'cperl-electric-semi)
2181   (cperl-define-key ":" 'cperl-electric-terminator)
2182   (cperl-define-key "\C-j" 'newline-and-indent)
2183   (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
2184   (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
2185   (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
2186   (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
2187   (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
2188   (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
2189   (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
2190   (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
2191   (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
2192   (cperl-define-key [?\C-\M-\|] 'cperl-lineup
2193                     [(control meta |)])
2194   ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
2195   ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
2196   (cperl-define-key "\177" 'cperl-electric-backspace)
2197   (cperl-define-key "\t" 'cperl-indent-command)
2198   ;; don't clobber the backspace binding:
2199   (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
2200                     [(control c) (control h) F])
2201   (if (cperl-val 'cperl-clobber-lisp-bindings)
2202       (progn
2203         (cperl-define-key "\C-hf"
2204                           ;;(concat (char-to-string help-char) "f") ; does not work
2205                           'cperl-info-on-command
2206                           [(control h) f])
2207         (cperl-define-key "\C-hv"
2208                           ;;(concat (char-to-string help-char) "v") ; does not work
2209                           'cperl-get-help
2210                           [(control h) v])
2211         (cperl-define-key "\C-c\C-hf"
2212                           ;;(concat (char-to-string help-char) "f") ; does not work
2213                           (key-binding "\C-hf")
2214                           [(control c) (control h) f])
2215         (cperl-define-key "\C-c\C-hv"
2216                           ;;(concat (char-to-string help-char) "v") ; does not work
2217                           (key-binding "\C-hv")
2218                           [(control c) (control h) v]))
2219     (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
2220                       [(control c) (control h) f])
2221     (cperl-define-key "\C-c\C-hv"
2222                       ;;(concat (char-to-string help-char) "v") ; does not work
2223                       'cperl-get-help
2224                       [(control c) (control h) v]))
2225   (if (and cperl-xemacs-p
2226            (<= emacs-minor-version 11) (<= emacs-major-version 19))
2227       (progn
2228         ;; substitute-key-definition is usefulness-deenhanced...
2229         (cperl-define-key "\M-q" 'cperl-fill-paragraph)
2230         (cperl-define-key "\e;" 'cperl-indent-for-comment)
2231         (cperl-define-key "\e\C-\\" 'cperl-indent-region))
2232     (substitute-key-definition
2233      'indent-sexp 'cperl-indent-exp
2234      cperl-mode-map global-map)
2235     (substitute-key-definition
2236      'fill-paragraph 'cperl-fill-paragraph
2237      cperl-mode-map global-map)
2238     (substitute-key-definition
2239      'indent-region 'cperl-indent-region
2240      cperl-mode-map global-map)
2241     (substitute-key-definition
2242      'indent-for-comment 'cperl-indent-for-comment
2243      cperl-mode-map global-map)))
2244
2245 (defvar cperl-menu)
2246 (defvar cperl-lazy-installed)
2247 (defvar cperl-old-style nil)
2248 (condition-case nil
2249     (progn
2250       (require 'easymenu)
2251       (easy-menu-define
2252        cperl-menu cperl-mode-map "Menu for CPerl mode"
2253        '("Perl"
2254          ["Beginning of function" beginning-of-defun t]
2255          ["End of function" end-of-defun t]
2256          ["Mark function" mark-defun t]
2257          ["Indent expression" cperl-indent-exp t]
2258          ["Fill paragraph/comment" cperl-fill-paragraph t]
2259          "----"
2260          ["Line up a construction" cperl-lineup (cperl-use-region-p)]
2261          ["Invert if/unless/while etc" cperl-invert-if-unless t]
2262          ("Regexp"
2263           ["Beautify" cperl-beautify-regexp
2264            cperl-use-syntax-table-text-property]
2265           ["Beautify one level deep" (cperl-beautify-regexp 1)
2266            cperl-use-syntax-table-text-property]
2267           ["Beautify a group" cperl-beautify-level
2268            cperl-use-syntax-table-text-property]
2269           ["Beautify a group one level deep" (cperl-beautify-level 1)
2270            cperl-use-syntax-table-text-property]
2271           ["Contract a group" cperl-contract-level
2272            cperl-use-syntax-table-text-property]
2273           ["Contract groups" cperl-contract-levels
2274            cperl-use-syntax-table-text-property])
2275          ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
2276          "----"
2277          ["Indent region" cperl-indent-region (cperl-use-region-p)]
2278          ["Comment region" cperl-comment-region (cperl-use-region-p)]
2279          ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
2280          "----"
2281          ["Run" mode-compile (fboundp 'mode-compile)]
2282          ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
2283                                         (get-buffer "*compilation*"))]
2284          ["Next error" next-error (get-buffer "*compilation*")]
2285          ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
2286          "----"
2287          ["Debugger" cperl-db t]
2288          "----"
2289          ("Tools"
2290           ["Imenu" imenu (fboundp 'imenu)]
2291           ["Insert spaces if needed" cperl-find-bad-style t]
2292           ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
2293           ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
2294           ["CPerl pretty print (exprmntl)" cperl-ps-print 
2295            (fboundp 'ps-extend-face-list)]
2296           ["Imenu on info" cperl-imenu-on-info (featurep 'imenu)]
2297           ("Tags"
2298 ;;;          ["Create tags for current file" cperl-etags t]
2299 ;;;          ["Add tags for current file" (cperl-etags t) t]
2300 ;;;          ["Create tags for Perl files in directory" (cperl-etags nil t) t]
2301 ;;;          ["Add tags for Perl files in directory" (cperl-etags t t) t]
2302 ;;;          ["Create tags for Perl files in (sub)directories"
2303 ;;;           (cperl-etags nil 'recursive) t]
2304 ;;;          ["Add tags for Perl files in (sub)directories"
2305 ;;;           (cperl-etags t 'recursive) t])
2306 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
2307            ["Create tags for current file" (cperl-write-tags nil t) t]
2308            ["Add tags for current file" (cperl-write-tags) t]
2309            ["Create tags for Perl files in directory"
2310             (cperl-write-tags nil t nil t) t]
2311            ["Add tags for Perl files in directory"
2312             (cperl-write-tags nil nil nil t) t]
2313            ["Create tags for Perl files in (sub)directories"
2314             (cperl-write-tags nil t t t) t]
2315            ["Add tags for Perl files in (sub)directories"
2316             (cperl-write-tags nil nil t t) t]))
2317          ("Perl docs"
2318           ["Define word at point" imenu-go-find-at-position 
2319            (fboundp 'imenu-go-find-at-position)]
2320           ["Help on function" cperl-info-on-command t]
2321           ["Help on function at point" cperl-info-on-current-command t]
2322           ["Help on symbol at point" cperl-get-help t]
2323           ["Perldoc" cperl-perldoc t]
2324           ["Perldoc on word at point" cperl-perldoc-at-point t]
2325           ["View manpage of POD in this file" cperl-build-manpage t]
2326           ["Auto-help on" cperl-lazy-install 
2327            (and (fboundp 'run-with-idle-timer)
2328                 (not cperl-lazy-installed))]
2329           ["Auto-help off" cperl-lazy-unstall
2330            (and (fboundp 'run-with-idle-timer)
2331                 cperl-lazy-installed)])
2332          ("Toggle..."
2333           ["Auto newline" cperl-toggle-auto-newline t]
2334           ["Electric parens" cperl-toggle-electric t]
2335           ["Electric keywords" cperl-toggle-abbrev t]
2336           ["Fix whitespace on indent" cperl-toggle-construct-fix t]
2337           ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
2338           ["Auto fill" auto-fill-mode t]) 
2339          ("Indent styles..."
2340           ["CPerl" (cperl-set-style "CPerl") t]
2341           ["PerlStyle" (cperl-set-style "PerlStyle") t]
2342           ["GNU" (cperl-set-style "GNU") t]
2343           ["C++" (cperl-set-style "C++") t]
2344           ["FSF" (cperl-set-style "FSF") t]
2345           ["BSD" (cperl-set-style "BSD") t]
2346           ["Whitesmith" (cperl-set-style "Whitesmith") t]
2347           ["Current" (cperl-set-style "Current") t]
2348           ["Memorized" (cperl-set-style-back) cperl-old-style])
2349          ("Micro-docs"
2350           ["Tips" (describe-variable 'cperl-tips) t]
2351           ["Problems" (describe-variable 'cperl-problems) t]
2352           ["Non-problems" (describe-variable 'cperl-non-problems) t]
2353           ["Speed" (describe-variable 'cperl-speed) t]
2354           ["Praise" (describe-variable 'cperl-praise) t]
2355           ["Faces" (describe-variable 'cperl-tips-faces) t]
2356           ["CPerl mode" (describe-function 'cperl-mode) t]
2357           ["CPerl version" 
2358            (message "The version of master-file for this CPerl is %s" 
2359                     cperl-version) t]))))
2360   (error nil))
2361
2362 (autoload 'c-macro-expand "cmacexp"
2363   "Display the result of expanding all C macros occurring in the region.
2364 The expansion is entirely correct because it uses the C preprocessor."
2365   t)
2366
2367 (defvar cperl-imenu--function-name-regexp-perl
2368   (concat
2369    "^\\("
2370         "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
2371    "\\|"
2372         "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
2373    "\\)"))
2374
2375 (defvar cperl-outline-regexp
2376   (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
2377
2378 (defvar cperl-mode-syntax-table nil
2379   "Syntax table in use in CPerl mode buffers.")
2380
2381 (defvar cperl-string-syntax-table nil
2382   "Syntax table in use in CPerl mode string-like chunks.")
2383
2384 (if cperl-mode-syntax-table
2385     ()
2386   (setq cperl-mode-syntax-table (make-syntax-table))
2387   (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
2388   (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
2389   (modify-syntax-entry ?* "." cperl-mode-syntax-table)
2390   (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
2391   (modify-syntax-entry ?- "." cperl-mode-syntax-table)
2392   (modify-syntax-entry ?= "." cperl-mode-syntax-table)
2393   (modify-syntax-entry ?% "." cperl-mode-syntax-table)
2394   (modify-syntax-entry ?< "." cperl-mode-syntax-table)
2395   (modify-syntax-entry ?> "." cperl-mode-syntax-table)
2396   (modify-syntax-entry ?& "." cperl-mode-syntax-table)
2397   (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
2398   (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
2399   (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
2400   (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
2401   (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
2402   (if cperl-under-as-char
2403       (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
2404   (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
2405   (modify-syntax-entry ?| "." cperl-mode-syntax-table)
2406   (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
2407   (modify-syntax-entry ?$ "." cperl-string-syntax-table)
2408   (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
2409
2410
2411 \f
2412 ;; provide an alias for working with emacs 19.  the perl-mode that comes
2413 ;; with it is really bad, and this lets us seamlessly replace it.
2414 ;;;###autoload
2415 (fset 'perl-mode 'cperl-mode)
2416 (defvar cperl-faces-init nil)
2417 ;; Fix for msb.el
2418 (defvar cperl-msb-fixed nil)
2419 (defvar font-lock-syntactic-keywords)
2420 (defvar perl-font-lock-keywords)
2421 (defvar perl-font-lock-keywords-1)
2422 (defvar perl-font-lock-keywords-2)
2423 (defvar outline-level)
2424 (if (fboundp 'defvaralias)
2425     (let ((f 'defvaralias)) ; Some functions deduce stuff from the mode name...
2426       (funcall f 'cperl-font-lock-keywords   'perl-font-lock-keywords)
2427       (funcall f 'cperl-font-lock-keywords-1 'perl-font-lock-keywords-1)
2428       (funcall f 'cperl-font-lock-keywords-2 'perl-font-lock-keywords-2)))
2429
2430 (defvar cperl-use-major-mode 'perl-mode)
2431
2432 ;;;###autoload
2433 (defun cperl-mode ()
2434   "Major mode for editing Perl code.
2435 Expression and list commands understand all C brackets.
2436 Tab indents for Perl code.
2437 Paragraphs are separated by blank lines only.
2438 Delete converts tabs to spaces as it moves back.
2439
2440 Various characters in Perl almost always come in pairs: {}, (), [],
2441 sometimes <>.  When the user types the first, she gets the second as
2442 well, with optional special formatting done on {}.  (Disabled by
2443 default.)  You can always quote (with \\[quoted-insert]) the left
2444 \"paren\" to avoid the expansion.  The processing of < is special,
2445 since most the time you mean \"less\".  CPerl mode tries to guess
2446 whether you want to type pair <>, and inserts is if it
2447 appropriate.  You can set `cperl-electric-parens-string' to the string that
2448 contains the parenths from the above list you want to be electrical.
2449 Electricity of parenths is controlled by `cperl-electric-parens'.
2450 You may also set `cperl-electric-parens-mark' to have electric parens
2451 look for active mark and \"embrace\" a region if possible.'
2452
2453 CPerl mode provides expansion of the Perl control constructs:
2454
2455    if, else, elsif, unless, while, until, continue, do,
2456    for, foreach, formy and foreachmy.
2457
2458 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
2459
2460 The user types the keyword immediately followed by a space, which
2461 causes the construct to be expanded, and the point is positioned where
2462 she is most likely to want to be.  eg. when the user types a space
2463 following \"if\" the following appears in the buffer: if () { or if ()
2464 } { } and the cursor is between the parentheses.  The user can then
2465 type some boolean expression within the parens.  Having done that,
2466 typing \\[cperl-linefeed] places you - appropriately indented - on a
2467 new line between the braces (if you typed \\[cperl-linefeed] in a POD
2468 directive line, then appropriate number of new lines is inserted).
2469
2470 If CPerl decides that you want to insert \"English\" style construct like
2471
2472             bite if angry;
2473
2474 it will not do any expansion.  See also help on variable
2475 `cperl-extra-newline-before-brace'.  (Note that one can switch the
2476 help message on expansion by setting `cperl-message-electric-keyword'
2477 to nil.)
2478
2479 \\[cperl-linefeed] is a convenience replacement for typing carriage
2480 return.  It places you in the next line with proper indentation, or if
2481 you type it inside the inline block of control construct, like
2482
2483             foreach (@lines) {print; print}
2484
2485 and you are on a boundary of a statement inside braces, it will
2486 transform the construct into a multiline and will place you into an
2487 appropriately indented blank line.  If you need a usual
2488 `newline-and-indent' behaviour, it is on \\[newline-and-indent],
2489 see documentation on `cperl-electric-linefeed'.
2490
2491 Use \\[cperl-invert-if-unless] to change a construction of the form
2492
2493             if (A) { B }
2494
2495 into
2496
2497             B if A;
2498
2499 \\{cperl-mode-map}
2500
2501 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
2502 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
2503 on electric space between $ and {, `cperl-electric-parens-string' is
2504 the string that contains parentheses that should be electric in CPerl
2505 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
2506 setting `cperl-electric-keywords' enables electric expansion of
2507 control structures in CPerl.  `cperl-electric-linefeed' governs which
2508 one of two linefeed behavior is preferable.  You can enable all these
2509 options simultaneously (recommended mode of use) by setting
2510 `cperl-hairy' to t.  In this case you can switch separate options off
2511 by setting them to `null'.  Note that one may undo the extra
2512 whitespace inserted by semis and braces in `auto-newline'-mode by
2513 consequent \\[cperl-electric-backspace].
2514
2515 If your site has perl5 documentation in info format, you can use commands
2516 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
2517 These keys run commands `cperl-info-on-current-command' and
2518 `cperl-info-on-command', which one is which is controlled by variable
2519 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
2520 \(in turn affected by `cperl-hairy').
2521
2522 Even if you have no info-format documentation, short one-liner-style
2523 help is available on \\[cperl-get-help], and one can run perldoc or
2524 man via menu.
2525
2526 It is possible to show this help automatically after some idle time.
2527 This is regulated by variable `cperl-lazy-help-time'.  Default with
2528 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
2529 secs idle time .  It is also possible to switch this on/off from the
2530 menu, or via \\[cperl-toggle-autohelp].  Requires `run-with-idle-timer'.
2531
2532 Use \\[cperl-lineup] to vertically lineup some construction - put the
2533 beginning of the region at the start of construction, and make region
2534 span the needed amount of lines.
2535
2536 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
2537 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
2538 here-docs sections.  With capable Emaxen results of scan are used
2539 for indentation too, otherwise they are used for highlighting only.
2540
2541 Variables controlling indentation style:
2542  `cperl-tab-always-indent'
2543     Non-nil means TAB in CPerl mode should always reindent the current line,
2544     regardless of where in the line point is when the TAB command is used.
2545  `cperl-indent-left-aligned-comments'
2546     Non-nil means that the comment starting in leftmost column should indent.
2547  `cperl-auto-newline'
2548     Non-nil means automatically newline before and after braces,
2549     and after colons and semicolons, inserted in Perl code.  The following
2550     \\[cperl-electric-backspace] will remove the inserted whitespace.
2551     Insertion after colons requires both this variable and
2552     `cperl-auto-newline-after-colon' set.
2553  `cperl-auto-newline-after-colon'
2554     Non-nil means automatically newline even after colons.
2555     Subject to `cperl-auto-newline' setting.
2556  `cperl-indent-level'
2557     Indentation of Perl statements within surrounding block.
2558     The surrounding block's indentation is the indentation
2559     of the line on which the open-brace appears.
2560  `cperl-continued-statement-offset'
2561     Extra indentation given to a substatement, such as the
2562     then-clause of an if, or body of a while, or just a statement continuation.
2563  `cperl-continued-brace-offset'
2564     Extra indentation given to a brace that starts a substatement.
2565     This is in addition to `cperl-continued-statement-offset'.
2566  `cperl-brace-offset'
2567     Extra indentation for line if it starts with an open brace.
2568  `cperl-brace-imaginary-offset'
2569     An open brace following other text is treated as if it the line started
2570     this far to the right of the actual line indentation.
2571  `cperl-label-offset'
2572     Extra indentation for line that is a label.
2573  `cperl-min-label-indent'
2574     Minimal indentation for line that is a label.
2575
2576 Settings for K&R and BSD indentation styles are
2577   `cperl-indent-level'                5    8
2578   `cperl-continued-statement-offset'  5    8
2579   `cperl-brace-offset'               -5   -8
2580   `cperl-label-offset'               -5   -8
2581
2582 CPerl knows several indentation styles, and may bulk set the
2583 corresponding variables.  Use \\[cperl-set-style] to do this.  Use
2584 \\[cperl-set-style-back] to restore the memorized preexisting values
2585 \(both available from menu).
2586
2587 If `cperl-indent-level' is 0, the statement after opening brace in
2588 column 0 is indented on
2589 `cperl-brace-offset'+`cperl-continued-statement-offset'.
2590
2591 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
2592 with no args.
2593
2594 DO NOT FORGET to read micro-docs (available from `Perl' menu)
2595 or as help on variables `cperl-tips', `cperl-problems',
2596 `cperl-non-problems', `cperl-praise', `cperl-speed'."
2597   (interactive)
2598   (kill-all-local-variables)
2599   (use-local-map cperl-mode-map)
2600   (if (cperl-val 'cperl-electric-linefeed)
2601       (progn
2602         (local-set-key "\C-J" 'cperl-linefeed)
2603         (local-set-key "\C-C\C-J" 'newline-and-indent)))
2604   (if (and
2605        (cperl-val 'cperl-clobber-lisp-bindings)
2606        (cperl-val 'cperl-info-on-command-no-prompt))
2607       (progn
2608         ;; don't clobber the backspace binding:
2609         (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
2610         (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
2611                           [(control c) (control h) f])))
2612   (setq major-mode cperl-use-major-mode)
2613   (setq mode-name "CPerl")
2614   (if (not cperl-mode-abbrev-table)
2615       (let ((prev-a-c abbrevs-changed))
2616         (define-abbrev-table 'cperl-mode-abbrev-table '(
2617                 ("if" "if" cperl-electric-keyword 0)
2618                 ("elsif" "elsif" cperl-electric-keyword 0)
2619                 ("while" "while" cperl-electric-keyword 0)
2620                 ("until" "until" cperl-electric-keyword 0)
2621                 ("unless" "unless" cperl-electric-keyword 0)
2622                 ("else" "else" cperl-electric-else 0)
2623                 ("continue" "continue" cperl-electric-else 0)
2624                 ("for" "for" cperl-electric-keyword 0)
2625                 ("foreach" "foreach" cperl-electric-keyword 0)
2626                 ("formy" "formy" cperl-electric-keyword 0)
2627                 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
2628                 ("do" "do" cperl-electric-keyword 0)
2629                 ("=pod" "=pod" cperl-electric-pod 0)
2630                 ("=over" "=over" cperl-electric-pod 0)
2631                 ("=head1" "=head1" cperl-electric-pod 0)
2632                 ("=head2" "=head2" cperl-electric-pod 0)
2633                 ("pod" "pod" cperl-electric-pod 0)
2634                 ("over" "over" cperl-electric-pod 0)
2635                 ("head1" "head1" cperl-electric-pod 0)
2636                 ("head2" "head2" cperl-electric-pod 0)))
2637         (setq abbrevs-changed prev-a-c)))
2638   (setq local-abbrev-table cperl-mode-abbrev-table)
2639   (abbrev-mode (if (cperl-val 'cperl-electric-keywords) 1 0))
2640   (set-syntax-table cperl-mode-syntax-table)
2641   (make-local-variable 'outline-regexp)
2642   ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
2643   (setq outline-regexp cperl-outline-regexp)
2644   (make-local-variable 'outline-level)
2645   (setq outline-level 'cperl-outline-level)
2646   (make-local-variable 'paragraph-start)
2647   (setq paragraph-start (concat "^$\\|" page-delimiter))
2648   (make-local-variable 'paragraph-separate)
2649   (setq paragraph-separate paragraph-start)
2650   (make-local-variable 'paragraph-ignore-fill-prefix)
2651   (setq paragraph-ignore-fill-prefix t)
2652   (make-local-variable 'indent-line-function)
2653   (setq indent-line-function 'cperl-indent-line)
2654   (make-local-variable 'require-final-newline)
2655   (setq require-final-newline t)
2656   (make-local-variable 'comment-start)
2657   (setq comment-start "# ")
2658   (make-local-variable 'comment-end)
2659   (setq comment-end "")
2660   (make-local-variable 'comment-column)
2661   (setq comment-column cperl-comment-column)
2662   (make-local-variable 'comment-start-skip)
2663   (setq comment-start-skip "#+ *")
2664   (make-local-variable 'defun-prompt-regexp)
2665   (setq defun-prompt-regexp "^[ \t]*sub[ \t]+\\([^ \t\n{(;]+\\)\\([ \t]*([^()]*)[ \t]*\\)?[ \t]*")
2666   (make-local-variable 'comment-indent-function)
2667   (setq comment-indent-function 'cperl-comment-indent)
2668   (make-local-variable 'parse-sexp-ignore-comments)
2669   (setq parse-sexp-ignore-comments t)
2670   (make-local-variable 'indent-region-function)
2671   (setq indent-region-function 'cperl-indent-region)
2672   ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
2673   (make-local-variable 'imenu-create-index-function)
2674   (setq imenu-create-index-function
2675         (function cperl-imenu--create-perl-index))
2676   (make-local-variable 'imenu-sort-function)
2677   (setq imenu-sort-function nil)
2678   (make-local-variable 'vc-header-alist)
2679   (set 'vc-header-alist cperl-vc-header-alist) ; Avoid warning
2680   (make-local-variable 'font-lock-defaults)
2681   (setq font-lock-defaults
2682         (cond
2683          ((string< emacs-version "19.30")
2684           '(perl-font-lock-keywords-2))
2685          ((string< emacs-version "19.33") ; Which one to use?
2686           '((perl-font-lock-keywords
2687              perl-font-lock-keywords-1
2688              perl-font-lock-keywords-2)))
2689          (t
2690           '((cperl-load-font-lock-keywords
2691              cperl-load-font-lock-keywords-1
2692              cperl-load-font-lock-keywords-2)))))
2693   (make-local-variable 'cperl-syntax-state)
2694   (if cperl-use-syntax-table-text-property
2695       (progn
2696         (make-local-variable 'parse-sexp-lookup-properties)
2697         ;; Do not introduce variable if not needed, we check it!
2698         (set 'parse-sexp-lookup-properties t)
2699         ;; Fix broken font-lock:
2700         (or (boundp 'font-lock-unfontify-region-function)
2701             (set 'font-lock-unfontify-region-function
2702                  'font-lock-default-unfontify-region))
2703         (make-local-variable 'font-lock-unfontify-region-function)
2704         (set 'font-lock-unfontify-region-function ; not present with old Emacs
2705               'cperl-font-lock-unfontify-region-function)
2706         (make-local-variable 'cperl-syntax-done-to)
2707         ;; Another bug: unless font-lock-syntactic-keywords, font-lock
2708         ;;  ignores syntax-table text-property.  (t) is a hack
2709         ;;  to make font-lock think that font-lock-syntactic-keywords
2710         ;;  are defined
2711         (make-local-variable 'font-lock-syntactic-keywords)
2712         (setq font-lock-syntactic-keywords
2713               (if cperl-syntaxify-by-font-lock
2714                   '(t (cperl-fontify-syntaxically))
2715                 '(t)))))
2716   (make-local-variable 'cperl-old-style)
2717   (if (boundp 'normal-auto-fill-function) ; 19.33 and later
2718       (set (make-local-variable 'normal-auto-fill-function)
2719            'cperl-do-auto-fill)       ; RMS has it as #'cperl-do-auto-fill ???
2720     (or (fboundp 'cperl-old-auto-fill-mode)
2721         (progn
2722           (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
2723           (defun auto-fill-mode (&optional arg)
2724             (interactive "P")
2725             (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
2726             (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
2727                  (setq auto-fill-function 'cperl-do-auto-fill))))))
2728   (if (cperl-enable-font-lock)
2729       (if (cperl-val 'cperl-font-lock)
2730           (progn (or cperl-faces-init (cperl-init-faces))
2731                  (font-lock-mode 1))))
2732   (and (boundp 'msb-menu-cond)
2733        (not cperl-msb-fixed)
2734        (cperl-msb-fix))
2735   (if (featurep 'easymenu)
2736       (easy-menu-add cperl-menu))       ; A NOP in RMS Emacs.
2737   (run-hooks 'cperl-mode-hook)
2738   ;; After hooks since fontification will break this
2739   (if cperl-pod-here-scan
2740       (or cperl-syntaxify-by-font-lock
2741        (progn (or cperl-faces-init (cperl-init-faces-weak))
2742               (cperl-find-pods-heres)))))
2743 \f
2744 ;; Fix for perldb - make default reasonable
2745 (defun cperl-db ()
2746   (interactive)
2747   (require 'gud)
2748   (perldb (read-from-minibuffer "Run perldb (like this): "
2749                                 (if (consp gud-perldb-history)
2750                                     (car gud-perldb-history)
2751                                   (concat "perl " ;;(file-name-nondirectory
2752                                           ;; I have problems
2753                                           ;; in OS/2
2754                                           ;; otherwise
2755                                           (buffer-file-name)))
2756                                 nil nil
2757                                 '(gud-perldb-history . 1))))
2758 \f
2759 (defun cperl-msb-fix ()
2760   ;; Adds perl files to msb menu, supposes that msb is already loaded
2761   (setq cperl-msb-fixed t)
2762   (let* ((l (length msb-menu-cond))
2763          (last (nth (1- l) msb-menu-cond))
2764          (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
2765          (handle (1- (nth 1 last))))
2766     (setcdr precdr (list
2767                     (list
2768                      '(memq major-mode '(cperl-mode perl-mode))
2769                      handle
2770                      "Perl Files (%d)")
2771                     last))))
2772 \f
2773 ;; This is used by indent-for-comment
2774 ;; to decide how much to indent a comment in CPerl code
2775 ;; based on its context.  Do fallback if comment is found wrong.
2776
2777 (defvar cperl-wrong-comment)
2778 (defvar cperl-st-cfence '(14))          ; Comment-fence
2779 (defvar cperl-st-sfence '(15))          ; String-fence
2780 (defvar cperl-st-punct '(1))
2781 (defvar cperl-st-word '(2))
2782 (defvar cperl-st-bra '(4 . ?\>))
2783 (defvar cperl-st-ket '(5 . ?\<))
2784
2785
2786 (defun cperl-comment-indent ()
2787   (let ((p (point)) (c (current-column)) was phony)
2788     (if (looking-at "^#") 0             ; Existing comment at bol stays there.
2789       ;; Wrong comment found
2790       (save-excursion
2791         (setq was (cperl-to-comment-or-eol)
2792               phony (eq (get-text-property (point) 'syntax-table)
2793                         cperl-st-cfence))
2794         (if phony
2795             (progn
2796               (re-search-forward "#\\|$") ; Hmm, what about embedded #?
2797               (if (eq (preceding-char) ?\#)
2798                   (forward-char -1))
2799               (setq was nil)))
2800         (if (= (point) p)
2801             (progn
2802               (skip-chars-backward " \t")
2803               (max (1+ (current-column)) ; Else indent at comment column
2804                    comment-column))
2805           (if was nil
2806             (insert comment-start)
2807             (backward-char (length comment-start)))
2808           (setq cperl-wrong-comment t)
2809           (indent-to comment-column 1)  ; Indent minimum 1
2810           c)))))                        ; except leave at least one space.
2811
2812 ;;;(defun cperl-comment-indent-fallback ()
2813 ;;;  "Is called if the standard comment-search procedure fails.
2814 ;;;Point is at start of real comment."
2815 ;;;  (let ((c (current-column)) target cnt prevc)
2816 ;;;    (if (= c comment-column) nil
2817 ;;;      (setq cnt (skip-chars-backward "[ \t]"))
2818 ;;;      (setq target (max (1+ (setq prevc
2819 ;;;                          (current-column))) ; Else indent at comment column
2820 ;;;                comment-column))
2821 ;;;      (if (= c comment-column) nil
2822 ;;;     (delete-backward-char cnt)
2823 ;;;     (while (< prevc target)
2824 ;;;       (insert "\t")
2825 ;;;       (setq prevc (current-column)))
2826 ;;;     (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
2827 ;;;     (while (< prevc target)
2828 ;;;       (insert " ")
2829 ;;;       (setq prevc (current-column)))))))
2830
2831 (defun cperl-indent-for-comment ()
2832   "Substitute for `indent-for-comment' in CPerl."
2833   (interactive)
2834   (let (cperl-wrong-comment)
2835     (indent-for-comment)
2836     (if cperl-wrong-comment
2837         (progn (cperl-to-comment-or-eol)
2838                (forward-char (length comment-start))))))
2839
2840 (defun cperl-comment-region (b e arg)
2841   "Comment or uncomment each line in the region in CPerl mode.
2842 See `comment-region'."
2843   (interactive "r\np")
2844   (let ((comment-start "#"))
2845     (comment-region b e arg)))
2846
2847 (defun cperl-uncomment-region (b e arg)
2848   "Uncomment or comment each line in the region in CPerl mode.
2849 See `comment-region'."
2850   (interactive "r\np")
2851   (let ((comment-start "#"))
2852     (comment-region b e (- arg))))
2853
2854 (defvar cperl-brace-recursing nil)
2855
2856 (defun cperl-electric-brace (arg &optional only-before)
2857   "Insert character and correct line's indentation.
2858 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2859 place (even in empty line), but not after.  If after \")\" and the inserted
2860 char is \"{\", insert extra newline before only if
2861 `cperl-extra-newline-before-brace'."
2862   (interactive "P")
2863   (let (insertpos
2864         (other-end (if (and cperl-electric-parens-mark
2865                             (cperl-mark-active)
2866                             (< (mark) (point)))
2867                        (mark)
2868                      nil)))
2869     (if (and other-end
2870              (not cperl-brace-recursing)
2871              (cperl-val 'cperl-electric-parens)
2872              (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2873         ;; Need to insert a matching pair
2874         (progn
2875           (save-excursion
2876             (setq insertpos (point-marker))
2877             (goto-char other-end)
2878             (setq last-command-char ?\{)
2879             (cperl-electric-lbrace arg insertpos))
2880           (forward-char 1))
2881       ;; Check whether we close something "usual" with `}'
2882       (if (and (eq last-command-char ?\})
2883                (not
2884                 (condition-case nil
2885                     (save-excursion
2886                       (up-list (- (prefix-numeric-value arg)))
2887                       ;;(cperl-after-block-p (point-min))
2888                       (or (cperl-after-expr-p nil "{;)")
2889                           ;; after sub, else, continue
2890                           (cperl-after-block-p nil 'pre)))
2891                   (error nil))))
2892           ;; Just insert the guy
2893           (self-insert-command (prefix-numeric-value arg))
2894         (if (and (not arg)              ; No args, end (of empty line or auto)
2895                  (eolp)
2896                  (or (and (null only-before)
2897                           (save-excursion
2898                             (skip-chars-backward " \t")
2899                             (bolp)))
2900                      (and (eq last-command-char ?\{) ; Do not insert newline
2901                           ;; if after ")" and `cperl-extra-newline-before-brace'
2902                           ;; is nil, do not insert extra newline.
2903                           (not cperl-extra-newline-before-brace)
2904                           (save-excursion
2905                             (skip-chars-backward " \t")
2906                             (eq (preceding-char) ?\))))
2907                      (if cperl-auto-newline
2908                          (progn (cperl-indent-line) (newline) t) nil)))
2909             (progn
2910               (self-insert-command (prefix-numeric-value arg))
2911               (cperl-indent-line)
2912               (if cperl-auto-newline
2913                   (setq insertpos (1- (point))))
2914               (if (and cperl-auto-newline (null only-before))
2915                   (progn
2916                     (newline)
2917                     (cperl-indent-line)))
2918               (save-excursion
2919                 (if insertpos (progn (goto-char insertpos)
2920                                      (search-forward (make-string
2921                                                       1 last-command-char))
2922                                      (setq insertpos (1- (point)))))
2923                 (delete-char -1))))
2924         (if insertpos
2925             (save-excursion
2926               (goto-char insertpos)
2927               (self-insert-command (prefix-numeric-value arg)))
2928           (self-insert-command (prefix-numeric-value arg)))))))
2929
2930 (defun cperl-electric-lbrace (arg &optional end)
2931   "Insert character, correct line's indentation, correct quoting by space."
2932   (interactive "P")
2933   (let ((cperl-brace-recursing t)
2934         (cperl-auto-newline cperl-auto-newline)
2935         (other-end (or end
2936                        (if (and cperl-electric-parens-mark
2937                                 (cperl-mark-active)
2938                                 (> (mark) (point)))
2939                            (save-excursion
2940                              (goto-char (mark))
2941                              (point-marker))
2942                          nil)))
2943         pos after)
2944     (and (cperl-val 'cperl-electric-lbrace-space)
2945          (eq (preceding-char) ?$)
2946          (save-excursion
2947            (skip-chars-backward "$")
2948            (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
2949          (insert ?\ ))
2950     ;; Check whether we are in comment
2951     (if (and
2952          (save-excursion
2953            (beginning-of-line)
2954            (not (looking-at "[ \t]*#")))
2955          (cperl-after-expr-p nil "{;)"))
2956         nil
2957       (setq cperl-auto-newline nil))
2958     (cperl-electric-brace arg)
2959     (and (cperl-val 'cperl-electric-parens)
2960          (eq last-command-char ?{)
2961          (memq last-command-char
2962                (append cperl-electric-parens-string nil))
2963          (or (if other-end (goto-char (marker-position other-end)))
2964              t)
2965          (setq last-command-char ?} pos (point))
2966          (progn (cperl-electric-brace arg t)
2967                 (goto-char pos)))))
2968
2969 (defun cperl-electric-paren (arg)
2970   "Insert an opening parenthesis or a matching pair of parentheses.
2971 See `cperl-electric-parens'."
2972   (interactive "P")
2973   (let ((beg (save-excursion (beginning-of-line) (point)))
2974         (other-end (if (and cperl-electric-parens-mark
2975                             (cperl-mark-active)
2976                             (> (mark) (point)))
2977                        (save-excursion
2978                          (goto-char (mark))
2979                          (point-marker))
2980                      nil)))
2981     (if (and (cperl-val 'cperl-electric-parens)
2982              (memq last-command-char
2983                    (append cperl-electric-parens-string nil))
2984              (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2985              ;;(not (save-excursion (search-backward "#" beg t)))
2986              (if (eq last-command-char ?<)
2987                  (progn
2988                    (and abbrev-mode ; later it is too late, may be after `for'
2989                         (expand-abbrev))
2990                    (cperl-after-expr-p nil "{;(,:="))
2991                1))
2992         (progn
2993           (self-insert-command (prefix-numeric-value arg))
2994           (if other-end (goto-char (marker-position other-end)))
2995           (insert (make-string
2996                    (prefix-numeric-value arg)
2997                    (cdr (assoc last-command-char '((?{ .?})
2998                                                    (?[ . ?])
2999                                                    (?( . ?))
3000                                                    (?< . ?>))))))
3001           (forward-char (- (prefix-numeric-value arg))))
3002       (self-insert-command (prefix-numeric-value arg)))))
3003
3004 (defun cperl-electric-rparen (arg)
3005   "Insert a matching pair of parentheses if marking is active.
3006 If not, or if we are not at the end of marking range, would self-insert.
3007 Affected by `cperl-electric-parens'."
3008   (interactive "P")
3009   (let ((beg (save-excursion (beginning-of-line) (point)))
3010         (other-end (if (and cperl-electric-parens-mark
3011                             (cperl-val 'cperl-electric-parens)
3012                             (memq last-command-char
3013                                   (append cperl-electric-parens-string nil))
3014                             (cperl-mark-active)
3015                             (< (mark) (point)))
3016                        (mark)
3017                      nil))
3018         p)
3019     (if (and other-end
3020              (cperl-val 'cperl-electric-parens)
3021              (memq last-command-char '( ?\) ?\] ?\} ?\> ))
3022              (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
3023              ;;(not (save-excursion (search-backward "#" beg t)))
3024              )
3025         (progn
3026           (self-insert-command (prefix-numeric-value arg))
3027           (setq p (point))
3028           (if other-end (goto-char other-end))
3029           (insert (make-string
3030                    (prefix-numeric-value arg)
3031                    (cdr (assoc last-command-char '((?\} . ?\{)
3032                                                    (?\] . ?\[)
3033                                                    (?\) . ?\()
3034                                                    (?\> . ?\<))))))
3035           (goto-char (1+ p)))
3036       (self-insert-command (prefix-numeric-value arg)))))
3037
3038 (defun cperl-electric-keyword ()
3039   "Insert a construction appropriate after a keyword.
3040 Help message may be switched off by setting `cperl-message-electric-keyword'
3041 to nil."
3042   (let ((beg (save-excursion (beginning-of-line) (point)))
3043         (dollar (and (eq last-command-char ?$)
3044                      (eq this-command 'self-insert-command)))
3045         (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3046                      (memq this-command '(self-insert-command newline))))
3047         my do)
3048     (and (save-excursion
3049            (condition-case nil
3050                (progn
3051                  (backward-sexp 1)
3052                  (setq do (looking-at "do\\>")))
3053              (error nil))
3054            (cperl-after-expr-p nil "{;:"))
3055          (save-excursion
3056            (not
3057             (re-search-backward
3058              "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
3059              beg t)))
3060          (save-excursion (or (not (re-search-backward "^=" nil t))
3061                              (or
3062                               (looking-at "=cut")
3063                               (and cperl-use-syntax-table-text-property
3064                                    (not (eq (get-text-property (point)
3065                                                                'syntax-type)
3066                                             'pod))))))
3067          (save-excursion (forward-sexp -1) 
3068                          (not (memq (following-char) (append "$@%&*" nil))))
3069          (progn
3070            (and (eq (preceding-char) ?y)
3071                 (progn                  ; "foreachmy"
3072                   (forward-char -2)
3073                   (insert " ")
3074                   (forward-char 2)
3075                   (setq my t dollar t
3076                         delete
3077                         (memq this-command '(self-insert-command newline)))))
3078            (and dollar (insert " $"))
3079            (cperl-indent-line)
3080            ;;(insert " () {\n}")
3081            (cond
3082             (cperl-extra-newline-before-brace
3083              (insert (if do "\n" " ()\n"))
3084              (insert "{")
3085              (cperl-indent-line)
3086              (insert "\n")
3087              (cperl-indent-line)
3088              (insert "\n}")
3089              (and do (insert " while ();")))
3090             (t
3091              (insert (if do " {\n} while ();" " () {\n}"))))
3092            (or (looking-at "[ \t]\\|$") (insert " "))
3093            (cperl-indent-line)
3094            (if dollar (progn (search-backward "$")
3095                              (if my
3096                                  (forward-char 1)
3097                                (delete-char 1)))
3098              (search-backward ")")
3099              (if (eq last-command-char ?\()
3100                  (progn                 ; Avoid "if (())"
3101                    (delete-backward-char 1)
3102                    (delete-backward-char -1))))
3103            (if delete
3104                (cperl-putback-char cperl-del-back-ch))
3105            (if cperl-message-electric-keyword
3106                (message "Precede char by C-q to avoid expansion"))))))
3107
3108 (defun cperl-ensure-newlines (n &optional pos)
3109   "Make sure there are N newlines after the point."
3110   (or pos (setq pos (point)))
3111   (if (looking-at "\n")
3112       (forward-char 1)
3113     (insert "\n"))
3114   (if (> n 1)
3115       (cperl-ensure-newlines (1- n) pos)
3116     (goto-char pos)))
3117
3118 (defun cperl-electric-pod ()
3119   "Insert a POD chunk appropriate after a =POD directive."
3120   (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3121                      (memq this-command '(self-insert-command newline))))
3122         head1 notlast name p really-delete over)
3123     (and (save-excursion
3124            (forward-word -1)
3125            (and
3126             (eq (preceding-char) ?=)
3127             (progn
3128               (setq head1 (looking-at "head1\\>[ \t]*$"))
3129               (setq over (and (looking-at "over\\>[ \t]*$")
3130                               (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
3131               (forward-char -1)
3132               (bolp))
3133             (or
3134              (get-text-property (point) 'in-pod)
3135              (cperl-after-expr-p nil "{;:")
3136              (and (re-search-backward
3137                    ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
3138                    "\\(\\`\n?\\|^\n\\)=\\sw+"
3139                    (point-min) t)
3140                   (not (or
3141                         (looking-at "=cut")
3142                         (and cperl-use-syntax-table-text-property
3143                              (not (eq (get-text-property (point) 'syntax-type)
3144                                       'pod)))))))))
3145          (progn
3146            (save-excursion
3147              (setq notlast (re-search-forward "^\n=" nil t)))
3148            (or notlast
3149                (progn
3150                  (insert "\n\n=cut")
3151                  (cperl-ensure-newlines 2)
3152                  (forward-word -2)
3153                  (if (and head1
3154                           (not
3155                            (save-excursion
3156                              (forward-char -1)
3157                              (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
3158                                                  nil t)))) ; Only one
3159                      (progn
3160                        (forward-word 1)
3161                        (setq name (file-name-sans-extension
3162                                    (file-name-nondirectory (buffer-file-name)))
3163                              p (point))
3164                        (insert " NAME\n\n" name
3165                                " - \n\n=head1 SYNOPSIS\n\n\n\n"
3166                                "=head1 DESCRIPTION")
3167                        (cperl-ensure-newlines 4)
3168                        (goto-char p)
3169                        (forward-word 2)
3170                        (end-of-line)
3171                        (setq really-delete t))
3172                    (forward-word 1))))
3173            (if over
3174                (progn
3175                  (setq p (point))
3176                  (insert "\n\n=item \n\n\n\n"
3177                          "=back")
3178                  (cperl-ensure-newlines 2)
3179                  (goto-char p)
3180                  (forward-word 1)
3181                  (end-of-line)
3182                  (setq really-delete t)))
3183            (if (and delete really-delete)
3184                (cperl-putback-char cperl-del-back-ch))))))
3185
3186 (defun cperl-electric-else ()
3187   "Insert a construction appropriate after a keyword.
3188 Help message may be switched off by setting `cperl-message-electric-keyword'
3189 to nil."
3190   (let ((beg (save-excursion (beginning-of-line) (point))))
3191     (and (save-excursion
3192            (backward-sexp 1)
3193            (cperl-after-expr-p nil "{;:"))
3194          (save-excursion
3195            (not
3196             (re-search-backward
3197              "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
3198              beg t)))
3199          (save-excursion (or (not (re-search-backward "^=" nil t))
3200                              (looking-at "=cut")
3201                              (and cperl-use-syntax-table-text-property
3202                                   (not (eq (get-text-property (point)
3203                                                               'syntax-type)
3204                                            'pod)))))
3205          (progn
3206            (cperl-indent-line)
3207            ;;(insert " {\n\n}")
3208            (cond
3209             (cperl-extra-newline-before-brace
3210              (insert "\n")
3211              (insert "{")
3212              (cperl-indent-line)
3213              (insert "\n\n}"))
3214             (t
3215              (insert " {\n\n}")))
3216            (or (looking-at "[ \t]\\|$") (insert " "))
3217            (cperl-indent-line)
3218            (forward-line -1)
3219            (cperl-indent-line)
3220            (cperl-putback-char cperl-del-back-ch)
3221            (setq this-command 'cperl-electric-else)
3222            (if cperl-message-electric-keyword
3223                (message "Precede char by C-q to avoid expansion"))))))
3224
3225 (defun cperl-linefeed ()
3226   "Go to end of line, open a new line and indent appropriately.
3227 If in POD, insert appropriate lines."
3228   (interactive)
3229   (let ((beg (save-excursion (beginning-of-line) (point)))
3230         (end (save-excursion (end-of-line) (point)))
3231         (pos (point)) start over cut res)
3232     (if (and                            ; Check if we need to split:
3233                                         ; i.e., on a boundary and inside "{...}"
3234          (save-excursion (cperl-to-comment-or-eol)
3235                          (>= (point) pos)) ; Not in a comment
3236          (or (save-excursion
3237                (skip-chars-backward " \t" beg)
3238                (forward-char -1)
3239                (looking-at "[;{]"))     ; After { or ; + spaces
3240              (looking-at "[ \t]*}")     ; Before }
3241              (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
3242          (save-excursion
3243            (and
3244             (eq (car (parse-partial-sexp pos end -1)) -1)
3245                                         ; Leave the level of parens
3246             (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
3247                                         ; Are at end
3248             (cperl-after-block-p (point-min))
3249             (progn
3250               (backward-sexp 1)
3251               (setq start (point-marker))
3252               (<= start pos)))))        ; Redundant?  Are after the
3253                                         ; start of parens group.
3254         (progn
3255           (skip-chars-backward " \t")
3256           (or (memq (preceding-char) (append ";{" nil))
3257               (insert ";"))
3258           (insert "\n")
3259           (forward-line -1)
3260           (cperl-indent-line)
3261           (goto-char start)
3262           (or (looking-at "{[ \t]*$")   ; If there is a statement
3263                                         ; before, move it to separate line
3264               (progn
3265                 (forward-char 1)
3266                 (insert "\n")
3267                 (cperl-indent-line)))
3268           (forward-line 1)              ; We are on the target line
3269           (cperl-indent-line)
3270           (beginning-of-line)
3271           (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
3272                                         ; after, move it to separate line
3273               (progn
3274                 (end-of-line)
3275                 (search-backward "}" beg)
3276                 (skip-chars-backward " \t")
3277                 (or (memq (preceding-char) (append ";{" nil))
3278                     (insert ";"))
3279                 (insert "\n")
3280                 (cperl-indent-line)
3281                 (forward-line -1)))
3282           (forward-line -1)             ; We are on the line before target
3283           (end-of-line)
3284           (newline-and-indent))
3285       (end-of-line)                     ; else - no splitting
3286       (cond
3287        ((and (looking-at "\n[ \t]*{$")
3288              (save-excursion
3289                (skip-chars-backward " \t")
3290                (eq (preceding-char) ?\)))) ; Probably if () {} group
3291                                         ; with an extra newline.
3292         (forward-line 2)
3293         (cperl-indent-line))
3294        ((save-excursion                 ; In POD header
3295           (forward-paragraph -1)
3296           ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
3297           ;; We are after \n now, so look for the rest
3298           (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
3299               (progn
3300                 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
3301                 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
3302                 t)))
3303         (if (and over
3304                  (progn
3305                    (forward-paragraph -1)
3306                    (forward-word 1)
3307                    (setq pos (point))
3308                    (setq cut (buffer-substring (point)
3309                                                (save-excursion
3310                                                  (end-of-line)
3311                                                  (point))))
3312                    (delete-char (- (save-excursion (end-of-line) (point))
3313                                    (point)))
3314                    (setq res (expand-abbrev))
3315                    (save-excursion
3316                      (goto-char pos)
3317                      (insert cut))
3318                    res))
3319             nil
3320           (cperl-ensure-newlines (if cut 2 4))
3321           (forward-line 2)))
3322        ((get-text-property (point) 'in-pod) ; In POD section
3323         (cperl-ensure-newlines 4)
3324         (forward-line 2))
3325        ((looking-at "\n[ \t]*$")        ; Next line is empty - use it.
3326         (forward-line 1)
3327         (cperl-indent-line))
3328        (t
3329         (newline-and-indent))))))
3330
3331 (defun cperl-electric-semi (arg)
3332   "Insert character and correct line's indentation."
3333   (interactive "P")
3334   (if cperl-auto-newline
3335       (cperl-electric-terminator arg)
3336     (self-insert-command (prefix-numeric-value arg))
3337     (if cperl-autoindent-on-semi
3338         (cperl-indent-line))))
3339
3340 (defun cperl-electric-terminator (arg)
3341   "Insert character and correct line's indentation."
3342   (interactive "P")
3343   (let ((end (point))
3344         (auto (and cperl-auto-newline
3345                    (or (not (eq last-command-char ?:))
3346                        cperl-auto-newline-after-colon)))
3347         insertpos)
3348     (if (and ;;(not arg)
3349              (eolp)
3350              (not (save-excursion
3351                     (beginning-of-line)
3352                     (skip-chars-forward " \t")
3353                     (or
3354                      ;; Ignore in comment lines
3355                      (= (following-char) ?#)
3356                      ;; Colon is special only after a label
3357                      ;; So quickly rule out most other uses of colon
3358                      ;; and do no indentation for them.
3359                      (and (eq last-command-char ?:)
3360                           (save-excursion
3361                             (forward-word 1)
3362                             (skip-chars-forward " \t")
3363                             (and (< (point) end)
3364                                  (progn (goto-char (- end 1))
3365                                         (not (looking-at ":"))))))
3366                      (progn
3367                        (beginning-of-defun)
3368                        (let ((pps (parse-partial-sexp (point) end)))
3369                          (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
3370         (progn
3371           (self-insert-command (prefix-numeric-value arg))
3372           ;;(forward-char -1)
3373           (if auto (setq insertpos (point-marker)))
3374           ;;(forward-char 1)
3375           (cperl-indent-line)
3376           (if auto
3377               (progn
3378                 (newline)
3379                 (cperl-indent-line)))
3380           (save-excursion
3381             (if insertpos (goto-char (1- (marker-position insertpos)))
3382               (forward-char -1))
3383             (delete-char 1))))
3384     (if insertpos
3385         (save-excursion
3386           (goto-char insertpos)
3387           (self-insert-command (prefix-numeric-value arg)))
3388       (self-insert-command (prefix-numeric-value arg)))))
3389
3390 (defun cperl-electric-backspace (arg)
3391   "Backspace, or remove the whitespace around the point inserted by an electric
3392 key.  Will untabivy if `cperl-electric-backspace-untabify' is non-nil."
3393   (interactive "p")
3394   (if (and cperl-auto-newline
3395            (memq last-command '(cperl-electric-semi
3396                                 cperl-electric-terminator
3397                                 cperl-electric-lbrace))
3398            (memq (preceding-char) '(?\  ?\t ?\n)))
3399       (let (p)
3400         (if (eq last-command 'cperl-electric-lbrace)
3401             (skip-chars-forward " \t\n"))
3402         (setq p (point))
3403         (skip-chars-backward " \t\n")
3404         (delete-region (point) p))
3405     (and (eq last-command 'cperl-electric-else)
3406          ;; We are removing the whitespace *inside* cperl-electric-else
3407          (setq this-command 'cperl-electric-else-really))
3408     (if (and cperl-auto-newline
3409              (eq last-command 'cperl-electric-else-really)
3410              (memq (preceding-char) '(?\  ?\t ?\n)))
3411         (let (p)
3412           (skip-chars-forward " \t\n")
3413           (setq p (point))
3414           (skip-chars-backward " \t\n")
3415           (delete-region (point) p))
3416       (if cperl-electric-backspace-untabify
3417           (backward-delete-char-untabify arg)
3418         (delete-backward-char arg)))))
3419
3420 (defun cperl-inside-parens-p ()
3421   (condition-case ()
3422       (save-excursion
3423         (save-restriction
3424           (narrow-to-region (point)
3425                             (progn (beginning-of-defun) (point)))
3426           (goto-char (point-max))
3427           (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
3428     (error nil)))
3429 \f
3430 (defun cperl-indent-command (&optional whole-exp)
3431   "Indent current line as Perl code, or in some cases insert a tab character.
3432 If `cperl-tab-always-indent' is non-nil (the default), always indent current
3433 line.  Otherwise, indent the current line only if point is at the left margin
3434 or in the line's indentation; otherwise insert a tab.
3435
3436 A numeric argument, regardless of its value,
3437 means indent rigidly all the lines of the expression starting after point
3438 so that this line becomes properly indented.
3439 The relative indentation among the lines of the expression are preserved."
3440   (interactive "P")
3441   (cperl-update-syntaxification (point) (point))
3442   (if whole-exp
3443       ;; If arg, always indent this line as Perl
3444       ;; and shift remaining lines of expression the same amount.
3445       (let ((shift-amt (cperl-indent-line))
3446             beg end)
3447         (save-excursion
3448           (if cperl-tab-always-indent
3449               (beginning-of-line))
3450           (setq beg (point))
3451           (forward-sexp 1)
3452           (setq end (point))
3453           (goto-char beg)
3454           (forward-line 1)
3455           (setq beg (point)))
3456         (if (and shift-amt (> end beg))
3457             (indent-code-rigidly beg end shift-amt "#")))
3458     (if (and (not cperl-tab-always-indent)
3459              (save-excursion
3460                (skip-chars-backward " \t")
3461                (not (bolp))))
3462         (insert-tab)
3463       (cperl-indent-line))))
3464
3465 (defun cperl-indent-line (&optional parse-data)
3466   "Indent current line as Perl code.
3467 Return the amount the indentation changed by."
3468   (let ((case-fold-search nil)
3469         (pos (- (point-max) (point)))
3470         indent i beg shift-amt)
3471     (setq indent (cperl-calculate-indent parse-data)
3472           i indent)
3473     (beginning-of-line)
3474     (setq beg (point))
3475     (cond ((or (eq indent nil) (eq indent t))
3476            (setq indent (current-indentation) i nil))
3477           ;;((eq indent t)    ; Never?
3478           ;; (setq indent (cperl-calculate-indent-within-comment)))
3479           ;;((looking-at "[ \t]*#")
3480           ;; (setq indent 0))
3481           (t
3482            (skip-chars-forward " \t")
3483            (if (listp indent) (setq indent (car indent)))
3484            (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
3485                   (and (> indent 0)
3486                        (setq indent (max cperl-min-label-indent
3487                                          (+ indent cperl-label-offset)))))
3488                  ((= (following-char) ?})
3489                   (setq indent (- indent cperl-indent-level)))
3490                  ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
3491                   (setq indent (+ indent cperl-close-paren-offset)))
3492                  ((= (following-char) ?{)
3493                   (setq indent (+ indent cperl-brace-offset))))))
3494     (skip-chars-forward " \t")
3495     (setq shift-amt (and i (- indent (current-column))))
3496     (if (or (not shift-amt)
3497             (zerop shift-amt))
3498         (if (> (- (point-max) pos) (point))
3499             (goto-char (- (point-max) pos)))
3500       (delete-region beg (point))
3501       (indent-to indent)
3502       ;; If initial point was within line's indentation,
3503       ;; position after the indentation.  Else stay at same point in text.
3504       (if (> (- (point-max) pos) (point))
3505           (goto-char (- (point-max) pos))))
3506     shift-amt))
3507
3508 (defun cperl-after-label ()
3509   ;; Returns true if the point is after label.  Does not do save-excursion.
3510   (and (eq (preceding-char) ?:)
3511        (memq (char-syntax (char-after (- (point) 2)))
3512              '(?w ?_))
3513        (progn
3514          (backward-sexp)
3515          (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
3516
3517 (defun cperl-get-state (&optional parse-start start-state)
3518   ;; returns list (START STATE DEPTH PRESTART),
3519   ;; START is a good place to start parsing, or equal to
3520   ;; PARSE-START if preset,
3521   ;; STATE is what is returned by `parse-partial-sexp'.
3522   ;; DEPTH is true is we are immediately after end of block
3523   ;; which contains START.
3524   ;; PRESTART is the position basing on which START was found.
3525   (save-excursion
3526     (let ((start-point (point)) depth state start prestart)
3527       (if (and parse-start
3528                (<= parse-start start-point))
3529           (goto-char parse-start)
3530         (beginning-of-defun)
3531         (setq start-state nil))
3532       (setq prestart (point))
3533       (if start-state nil
3534         ;; Try to go out, if sub is not on the outermost level
3535         (while (< (point) start-point)
3536           (setq start (point) parse-start start depth nil
3537                 state (parse-partial-sexp start start-point -1))
3538           (if (> (car state) -1) nil
3539             ;; The current line could start like }}}, so the indentation
3540             ;; corresponds to a different level than what we reached
3541             (setq depth t)
3542             (beginning-of-line 2)))     ; Go to the next line.
3543         (if start (goto-char start)))   ; Not at the start of file
3544       (setq start (point))
3545       (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
3546       (list start state depth prestart))))
3547
3548 (defun cperl-block-p ()            ; Do not C-M-q !  One string contains ";" !
3549   ;; Positions is before ?\{.  Checks whether it starts a block.
3550   ;; No save-excursion!
3551   (cperl-backward-to-noncomment (point-min))
3552   (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label!  \C-@ at bobp
3553                                         ; Label may be mixed up with `$blah :'
3554       (save-excursion (cperl-after-label))
3555       (and (memq (char-syntax (preceding-char)) '(?w ?_))
3556            (progn
3557              (backward-sexp)
3558              ;; Need take into account `bless', `return', `tr',...
3559              (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
3560                       (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
3561                  (progn
3562                    (skip-chars-backward " \t\n\f")
3563                    (and (memq (char-syntax (preceding-char)) '(?w ?_))
3564                         (progn
3565                           (backward-sexp)
3566                           (looking-at
3567                            "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
3568
3569 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
3570
3571 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3572   "Return appropriate indentation for current line as Perl code.
3573 In usual case returns an integer: the column to indent to.
3574 Returns nil if line starts inside a string, t if in a comment.
3575
3576 Will not correct the indentation for labels, but will correct it for braces
3577 and closing parentheses and brackets."
3578   (cperl-update-syntaxification (point) (point))
3579   (save-excursion
3580     (if (or
3581          (and (memq (get-text-property (point) 'syntax-type)
3582                     '(pod here-doc here-doc-delim format))
3583               (not (get-text-property (point) 'indentable)))
3584          ;; before start of POD - whitespace found since do not have 'pod!
3585          (and (looking-at "[ \t]*\n=")
3586               (error "Spaces before POD section!"))
3587          (and (not cperl-indent-left-aligned-comments)
3588               (looking-at "^#")))
3589         nil
3590       (beginning-of-line)
3591       (let ((indent-point (point))
3592             (char-after (save-excursion
3593                           (skip-chars-forward " \t")
3594                           (following-char)))
3595             (in-pod (get-text-property (point) 'in-pod))
3596             (pre-indent-point (point))
3597             p prop look-prop is-block delim)
3598         (cond
3599          (in-pod
3600           ;; In the verbatim part, probably code example.  What to do???
3601           )
3602          (t
3603           (save-excursion
3604             ;; Not in POD
3605             (cperl-backward-to-noncomment nil)
3606             (setq p (max (point-min) (1- (point)))
3607                   prop (get-text-property p 'syntax-type)
3608                   look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
3609                                 'syntax-type))
3610             (if (memq prop '(pod here-doc format here-doc-delim))
3611                 (progn
3612                   (goto-char (or (previous-single-property-change p look-prop)
3613                                  (point-min)))
3614                   (beginning-of-line)
3615                   (setq pre-indent-point (point)))))))
3616         (goto-char pre-indent-point)
3617         (let* ((case-fold-search nil)
3618                (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
3619                (start (or (nth 2 parse-data)
3620                           (nth 0 s-s)))
3621                (state (nth 1 s-s))
3622                (containing-sexp (car (cdr state)))
3623                old-indent)
3624           (if (and
3625                ;;containing-sexp                ;; We are buggy at toplevel :-(
3626                parse-data)
3627               (progn
3628                 (setcar parse-data pre-indent-point)
3629                 (setcar (cdr parse-data) state)
3630                 (or (nth 2 parse-data)
3631                     (setcar (cddr parse-data) start))
3632                 ;; Before this point: end of statement
3633                 (setq old-indent (nth 3 parse-data))))
3634           (cond ((get-text-property (point) 'indentable)
3635                  ;; indent to just after the surrounding open,
3636                  ;; skip blanks if we do not close the expression.
3637                  (goto-char (1+ (previous-single-property-change (point) 'indentable)))
3638                  (or (memq char-after (append ")]}" nil))
3639                      (looking-at "[ \t]*\\(#\\|$\\)")
3640                      (skip-chars-forward " \t"))
3641                  (current-column))
3642                 ((or (nth 3 state) (nth 4 state))
3643                  ;; return nil or t if should not change this line
3644                  (nth 4 state))
3645                 ;; XXXX Do we need to special-case this?
3646                 ((null containing-sexp)
3647                  ;; Line is at top level.  May be data or function definition,
3648                  ;; or may be function argument declaration.
3649                  ;; Indent like the previous top level line
3650                  ;; unless that ends in a closeparen without semicolon,
3651                  ;; in which case this line is the first argument decl.
3652                  (skip-chars-forward " \t")
3653                  (+ (save-excursion
3654                       (goto-char start)
3655                       (- (current-indentation)
3656                          (if (nth 2 s-s) cperl-indent-level 0)))
3657                     (if (= char-after ?{) cperl-continued-brace-offset 0)
3658                     (progn
3659                       (cperl-backward-to-noncomment (or old-indent (point-min)))
3660                       ;; Look at previous line that's at column 0
3661                       ;; to determine whether we are in top-level decls
3662                       ;; or function's arg decls.  Set basic-indent accordingly.
3663                       ;; Now add a little if this is a continuation line.
3664                       (if (or (bobp)
3665                               (eq (point) old-indent) ; old-indent was at comment
3666                               (eq (preceding-char) ?\;)
3667                               ;;  Had ?\) too
3668                               (and (eq (preceding-char) ?\})
3669                                    (cperl-after-block-and-statement-beg
3670                                     (point-min))) ; Was start - too close
3671                               (memq char-after (append ")]}" nil))
3672                               (and (eq (preceding-char) ?\:) ; label
3673                                    (progn
3674                                      (forward-sexp -1)
3675                                      (skip-chars-backward " \t")
3676                                      (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
3677                               (get-text-property (point) 'first-format-line))
3678                           (progn
3679                             (if (and parse-data
3680                                      (not (eq char-after ?\C-j)))
3681                                 (setcdr (cddr parse-data)
3682                                         (list pre-indent-point)))
3683                             0)
3684                         cperl-continued-statement-offset))))
3685                 ((not
3686                   (or (setq is-block
3687                             (and (setq delim (= (char-after containing-sexp) ?{))
3688                                  (save-excursion ; Is it a hash?
3689                                    (goto-char containing-sexp)
3690                                    (cperl-block-p))))
3691                       cperl-indent-parens-as-block))
3692                  ;; group is an expression, not a block:
3693                  ;; indent to just after the surrounding open parens,
3694                  ;; skip blanks if we do not close the expression.
3695                  (goto-char (1+ containing-sexp))
3696                  (or (memq char-after
3697                            (append (if delim "}" ")]}") nil))
3698                      (looking-at "[ \t]*\\(#\\|$\\)")
3699                      (skip-chars-forward " \t"))
3700                  (+ (current-column)
3701                     (if (and delim
3702                              (eq char-after ?\}))
3703                         ;; Correct indentation of trailing ?\}
3704                         (+ cperl-indent-level cperl-close-paren-offset)
3705                       0)))
3706 ;;;           ((and (/= (char-after containing-sexp) ?{)
3707 ;;;                 (not cperl-indent-parens-as-block))
3708 ;;;            ;; line is expression, not statement:
3709 ;;;            ;; indent to just after the surrounding open,
3710 ;;;            ;; skip blanks if we do not close the expression.
3711 ;;;            (goto-char (1+ containing-sexp))
3712 ;;;            (or (memq char-after (append ")]}" nil))
3713 ;;;                (looking-at "[ \t]*\\(#\\|$\\)")
3714 ;;;                (skip-chars-forward " \t"))
3715 ;;;            (current-column))
3716 ;;;           ((progn
3717 ;;;              ;; Containing-expr starts with \{.  Check whether it is a hash.
3718 ;;;              (goto-char containing-sexp)
3719 ;;;              (and (not (cperl-block-p))
3720 ;;;                   (not cperl-indent-parens-as-block)))
3721 ;;;            (goto-char (1+ containing-sexp))
3722 ;;;            (or (eq char-after ?\})
3723 ;;;                (looking-at "[ \t]*\\(#\\|$\\)")
3724 ;;;                (skip-chars-forward " \t"))
3725 ;;;            (+ (current-column)      ; Correct indentation of trailing ?\}
3726 ;;;               (if (eq char-after ?\}) (+ cperl-indent-level
3727 ;;;                                          cperl-close-paren-offset)
3728 ;;;                 0)))
3729                 (t
3730                  ;; Statement level.  Is it a continuation or a new statement?
3731                  ;; Find previous non-comment character.
3732                  (goto-char pre-indent-point)
3733                  (cperl-backward-to-noncomment containing-sexp)
3734                  ;; Back up over label lines, since they don't
3735                  ;; affect whether our line is a continuation.
3736                  ;; (Had \, too)
3737                  (while ;;(or (eq (preceding-char) ?\,)
3738                      (and (eq (preceding-char) ?:)
3739                           (or ;;(eq (char-after (- (point) 2)) ?\') ; ????
3740                            (memq (char-syntax (char-after (- (point) 2)))
3741                                  '(?w ?_))))
3742                    ;;)
3743                    (if (eq (preceding-char) ?\,)
3744                        ;; Will go to beginning of line, essentially.
3745                        ;; Will ignore embedded sexpr XXXX.
3746                        (cperl-backward-to-start-of-continued-exp containing-sexp))
3747                    (beginning-of-line)
3748                    (cperl-backward-to-noncomment containing-sexp))
3749                  ;; Now we get the answer.
3750                  (if (not (or (eq (1- (point)) containing-sexp)
3751                               (memq (preceding-char)
3752                                     (append (if is-block " ;{" " ,;{") '(nil)))
3753                               (and (eq (preceding-char) ?\})
3754                                    (cperl-after-block-and-statement-beg
3755                                     containing-sexp))
3756                               (get-text-property (point) 'first-format-line)))
3757                      ;; This line is continuation of preceding line's statement;
3758                      ;; indent  `cperl-continued-statement-offset'  more than the
3759                      ;; previous line of the statement.
3760                      ;;
3761                      ;; There might be a label on this line, just
3762                      ;; consider it bad style and ignore it.
3763                      (progn
3764                        (cperl-backward-to-start-of-continued-exp containing-sexp)
3765                        (+ (if (memq char-after (append "}])" nil))
3766                               0         ; Closing parenth
3767                             cperl-continued-statement-offset)
3768                           (if (or is-block
3769                                   (not delim)
3770                                   (not (eq char-after ?\})))
3771                               0
3772                             ;; Now it is a hash reference
3773                             (+ cperl-indent-level cperl-close-paren-offset))
3774                           (if (looking-at "\\w+[ \t]*:")
3775                               (if (> (current-indentation) cperl-min-label-indent)
3776                                   (- (current-indentation) cperl-label-offset)
3777                                 ;; Do not move `parse-data', this should
3778                                 ;; be quick anyway (this comment comes
3779                                 ;; from different location):
3780                                 (cperl-calculate-indent))
3781                             (current-column))
3782                           (if (eq char-after ?\{)
3783                               cperl-continued-brace-offset 0)))
3784                    ;; This line starts a new statement.
3785                    ;; Position following last unclosed open.
3786                    (goto-char containing-sexp)
3787                    ;; Is line first statement after an open-brace?
3788                    (or
3789                     ;; If no, find that first statement and indent like
3790                     ;; it.  If the first statement begins with label, do
3791                     ;; not believe when the indentation of the label is too
3792                     ;; small.
3793                     (save-excursion
3794                       (forward-char 1)
3795                       (setq old-indent (current-indentation))
3796                       (let ((colon-line-end 0))
3797                         (while
3798                             (progn (skip-chars-forward " \t\n")
3799                                    (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
3800                           ;; Skip over comments and labels following openbrace.
3801                           (cond ((= (following-char) ?\#)
3802                                  (forward-line 1))
3803                                 ((= (following-char) ?\=)
3804                                  (goto-char
3805                                   (or (next-single-property-change (point) 'in-pod)
3806                                       (point-max)))) ; do not loop if no syntaxification
3807                                 ;; label:
3808                                 (t
3809                                  (save-excursion (end-of-line)
3810                                                  (setq colon-line-end (point)))
3811                                  (search-forward ":"))))
3812                         ;; The first following code counts
3813                         ;; if it is before the line we want to indent.
3814                         (and (< (point) indent-point)
3815                              (if (> colon-line-end (point)) ; After label
3816                                  (if (> (current-indentation)
3817                                         cperl-min-label-indent)
3818                                      (- (current-indentation) cperl-label-offset)
3819                                    ;; Do not believe: `max' is involved
3820                                    (+ old-indent cperl-indent-level))
3821                                (current-column)))))
3822                     ;; If no previous statement,
3823                     ;; indent it relative to line brace is on.
3824                     ;; For open brace in column zero, don't let statement
3825                     ;; start there too.  If cperl-indent-level is zero,
3826                     ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3827                     ;; For open-braces not the first thing in a line,
3828                     ;; add in cperl-brace-imaginary-offset.
3829
3830                     ;; If first thing on a line:  ?????
3831                     (+ (if (and (bolp) (zerop cperl-indent-level))
3832                            (+ cperl-brace-offset cperl-continued-statement-offset)
3833                          cperl-indent-level)
3834                        (if (or is-block
3835                                (not delim)
3836                                (not (eq char-after ?\})))
3837                            0
3838                          ;; Now it is a hash reference
3839                          (+ cperl-indent-level cperl-close-paren-offset))
3840                        ;; Move back over whitespace before the openbrace.
3841                        ;; If openbrace is not first nonwhite thing on the line,
3842                        ;; add the cperl-brace-imaginary-offset.
3843                        (progn (skip-chars-backward " \t")
3844                               (if (bolp) 0 cperl-brace-imaginary-offset))
3845                        ;; If the openbrace is preceded by a parenthesized exp,
3846                        ;; move to the beginning of that;
3847                        ;; possibly a different line
3848                        (progn
3849                          (if (eq (preceding-char) ?\))
3850                              (forward-sexp -1))
3851                          ;; In the case it starts a subroutine, indent with
3852                          ;; respect to `sub', not with respect to the
3853                          ;; first thing on the line, say in the case of
3854                          ;; anonymous sub in a hash.
3855                          ;;
3856                          (skip-chars-backward " \t")
3857                          (if (and (eq (preceding-char) ?b)
3858                                   (progn
3859                                     (forward-sexp -1)
3860                                     (looking-at "sub\\>"))
3861                                   (setq old-indent
3862                                         (nth 1
3863                                              (parse-partial-sexp
3864                                               (save-excursion (beginning-of-line) (point))
3865                                               (point)))))
3866                              (progn (goto-char (1+ old-indent))
3867                                     (skip-chars-forward " \t")
3868                                     (current-column))
3869                            ;; Get initial indentation of the line we are on.
3870                            ;; If line starts with label, calculate label indentation
3871                            (if (save-excursion
3872                                  (beginning-of-line)
3873                                  (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3874                                (if (> (current-indentation) cperl-min-label-indent)
3875                                    (- (current-indentation) cperl-label-offset)
3876                                  ;; Do not move `parse-data', this should
3877                                  ;; be quick anyway:
3878                                  (cperl-calculate-indent))
3879                              (current-indentation))))))))))))))
3880
3881 (defvar cperl-indent-alist
3882   '((string nil)
3883     (comment nil)
3884     (toplevel 0)
3885     (toplevel-after-parenth 2)
3886     (toplevel-continued 2)
3887     (expression 1))
3888   "Alist of indentation rules for CPerl mode.
3889 The values mean:
3890   nil: do not indent;
3891   number: add this amount of indentation.
3892
3893 Not finished, not used.")
3894
3895 (defun cperl-where-am-i (&optional parse-start start-state)
3896   ;; Unfinished
3897   "Return a list of lists ((TYPE POS)...) of good points before the point.
3898 POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
3899
3900 Not finished, not used."
3901   (save-excursion
3902     (let* ((start-point (point))
3903            (s-s (cperl-get-state))
3904            (start (nth 0 s-s))
3905            (state (nth 1 s-s))
3906            (prestart (nth 3 s-s))
3907            (containing-sexp (car (cdr state)))
3908            (case-fold-search nil)
3909            (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
3910       (cond ((nth 3 state)              ; In string
3911              (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
3912             ((nth 4 state)              ; In comment
3913              (setq res (cons '(comment) res)))
3914             ((null containing-sexp)
3915              ;; Line is at top level.
3916              ;; Indent like the previous top level line
3917              ;; unless that ends in a closeparen without semicolon,
3918              ;; in which case this line is the first argument decl.
3919              (cperl-backward-to-noncomment (or parse-start (point-min)))
3920              ;;(skip-chars-backward " \t\f\n")
3921              (cond
3922               ((or (bobp)
3923                    (memq (preceding-char) (append ";}" nil)))
3924                (setq res (cons (list 'toplevel start) res)))
3925               ((eq (preceding-char) ?\) )
3926                (setq res (cons (list 'toplevel-after-parenth start) res)))
3927               (t
3928                (setq res (cons (list 'toplevel-continued start) res)))))
3929             ((/= (char-after containing-sexp) ?{)
3930              ;; line is expression, not statement:
3931              ;; indent to just after the surrounding open.
3932              ;; skip blanks if we do not close the expression.
3933              (setq res (cons (list 'expression-blanks
3934                                    (progn
3935                                      (goto-char (1+ containing-sexp))
3936                                      (or (looking-at "[ \t]*\\(#\\|$\\)")
3937                                          (skip-chars-forward " \t"))
3938                                      (point)))
3939                              (cons (list 'expression containing-sexp) res))))
3940             ((progn
3941                ;; Containing-expr starts with \{.  Check whether it is a hash.
3942                (goto-char containing-sexp)
3943                (not (cperl-block-p)))
3944              (setq res (cons (list 'expression-blanks
3945                                    (progn
3946                                      (goto-char (1+ containing-sexp))
3947                                      (or (looking-at "[ \t]*\\(#\\|$\\)")
3948                                          (skip-chars-forward " \t"))
3949                                      (point)))
3950                              (cons (list 'expression containing-sexp) res))))
3951             (t
3952              ;; Statement level.
3953              (setq res (cons (list 'in-block containing-sexp) res))
3954              ;; Is it a continuation or a new statement?
3955              ;; Find previous non-comment character.
3956              (cperl-backward-to-noncomment containing-sexp)
3957              ;; Back up over label lines, since they don't
3958              ;; affect whether our line is a continuation.
3959              ;; Back up comma-delimited lines too ?????
3960              (while (or (eq (preceding-char) ?\,)
3961                         (save-excursion (cperl-after-label)))
3962                (if (eq (preceding-char) ?\,)
3963                    ;; Will go to beginning of line, essentially
3964                    ;; Will ignore embedded sexpr XXXX.
3965                    (cperl-backward-to-start-of-continued-exp containing-sexp))
3966                (beginning-of-line)
3967                (cperl-backward-to-noncomment containing-sexp))
3968              ;; Now we get the answer.
3969              (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
3970                  ;; This line is continuation of preceding line's statement.
3971                  (list (list 'statement-continued containing-sexp))
3972                ;; This line starts a new statement.
3973                ;; Position following last unclosed open.
3974                (goto-char containing-sexp)
3975                ;; Is line first statement after an open-brace?
3976                (or
3977                 ;; If no, find that first statement and indent like
3978                 ;; it.  If the first statement begins with label, do
3979                 ;; not believe when the indentation of the label is too
3980                 ;; small.
3981                 (save-excursion
3982                   (forward-char 1)
3983                   (let ((colon-line-end 0))
3984                     (while (progn (skip-chars-forward " \t\n" start-point)
3985                                   (and (< (point) start-point)
3986                                        (looking-at
3987                                         "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
3988                       ;; Skip over comments and labels following openbrace.
3989                       (cond ((= (following-char) ?\#)
3990                              ;;(forward-line 1)
3991                              (end-of-line))
3992                             ;; label:
3993                             (t
3994                              (save-excursion (end-of-line)
3995                                              (setq colon-line-end (point)))
3996                              (search-forward ":"))))
3997                     ;; Now at the point, after label, or at start
3998                     ;; of first statement in the block.
3999                     (and (< (point) start-point)
4000                          (if (> colon-line-end (point))
4001                              ;; Before statement after label
4002                              (if (> (current-indentation)
4003                                     cperl-min-label-indent)
4004                                  (list (list 'label-in-block (point)))
4005                                ;; Do not believe: `max' is involved
4006                                (list
4007                                 (list 'label-in-block-min-indent (point))))
4008                            ;; Before statement
4009                            (list 'statement-in-block (point))))))
4010                 ;; If no previous statement,
4011                 ;; indent it relative to line brace is on.
4012                 ;; For open brace in column zero, don't let statement
4013                 ;; start there too.  If cperl-indent-level is zero,
4014                 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
4015                 ;; For open-braces not the first thing in a line,
4016                 ;; add in cperl-brace-imaginary-offset.
4017
4018                 ;; If first thing on a line:  ?????
4019                 (+ (if (and (bolp) (zerop cperl-indent-level))
4020                        (+ cperl-brace-offset cperl-continued-statement-offset)
4021                      cperl-indent-level)
4022                    ;; Move back over whitespace before the openbrace.
4023                    ;; If openbrace is not first nonwhite thing on the line,
4024                    ;; add the cperl-brace-imaginary-offset.
4025                    (progn (skip-chars-backward " \t")
4026                           (if (bolp) 0 cperl-brace-imaginary-offset))
4027                    ;; If the openbrace is preceded by a parenthesized exp,
4028                    ;; move to the beginning of that;
4029                    ;; possibly a different line
4030                    (progn
4031                      (if (eq (preceding-char) ?\))
4032                          (forward-sexp -1))
4033                      ;; Get initial indentation of the line we are on.
4034                      ;; If line starts with label, calculate label indentation
4035                      (if (save-excursion
4036                            (beginning-of-line)
4037                            (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
4038                          (if (> (current-indentation) cperl-min-label-indent)
4039                              (- (current-indentation) cperl-label-offset)
4040                            (cperl-calculate-indent))
4041                        (current-indentation))))))))
4042       res)))
4043
4044 (defun cperl-calculate-indent-within-comment ()