This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[patch] more fullpath TAGS patches (emacs/cperl-mode.el + emacs/ptags)
[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 ;;;; After 4.37:
1138 ;;;  `cperl-add-tags-recurse-noxs-fullpath'
1139 ;;;    added (for -batch mode);
1140
1141 ;;; Code:
1142
1143 \f
1144 (if (fboundp 'eval-when-compile)
1145     (eval-when-compile
1146       (condition-case nil
1147           (require 'custom)
1148         (error nil))
1149       (condition-case nil
1150           (require 'man)
1151         (error nil))
1152       (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1153       (defvar cperl-can-font-lock
1154         (or cperl-xemacs-p
1155             (and (boundp 'emacs-major-version)
1156                  (or window-system
1157                      (> emacs-major-version 20)))))
1158       (if cperl-can-font-lock
1159           (require 'font-lock))
1160       (defvar msb-menu-cond)
1161       (defvar gud-perldb-history)
1162       (defvar font-lock-background-mode) ; not in Emacs
1163       (defvar font-lock-display-type)   ; ditto
1164       (or (fboundp 'defgroup)
1165           (defmacro defgroup (name val doc &rest arr)
1166             nil))
1167       (or (fboundp 'custom-declare-variable)
1168           (defmacro defcustom (name val doc &rest arr)
1169             (` (defvar (, name) (, val) (, doc)))))
1170       (or (and (fboundp 'custom-declare-variable)
1171                (string< "19.31" emacs-version)) ;  Checked with 19.30: defface does not work
1172           (defmacro defface (&rest arr)
1173             nil))
1174       ;; Avoid warning (tmp definitions)
1175       (or (fboundp 'x-color-defined-p)
1176           (defmacro x-color-defined-p (col)
1177             (cond ((fboundp 'color-defined-p) (` (color-defined-p (, col))))
1178                   ;; XEmacs >= 19.12
1179                   ((fboundp 'valid-color-name-p) (` (valid-color-name-p (, col))))
1180                   ;; XEmacs 19.11
1181                   ((fboundp 'x-valid-color-name-p) (` (x-valid-color-name-p (, col))))
1182                   (t '(error "Cannot implement color-defined-p")))))
1183       (defmacro cperl-is-face (arg)     ; Takes quoted arg
1184         (cond ((fboundp 'find-face)
1185                (` (find-face (, arg))))
1186               (;;(and (fboundp 'face-list)
1187                ;;       (face-list))
1188                (fboundp 'face-list)
1189                (` (member (, arg) (and (fboundp 'face-list)
1190                                        (face-list)))))
1191               (t
1192                (` (boundp (, arg))))))
1193       (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
1194         (cond ((fboundp 'make-face)
1195                (` (make-face (quote (, arg)))))
1196               (t
1197                (` (defvar (, arg) (quote (, arg)) (, descr))))))
1198       (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
1199         (` (progn
1200              (or (cperl-is-face (quote (, arg)))
1201                  (cperl-make-face (, arg) (, descr)))
1202              (or (boundp (quote (, arg))) ; We use unquoted variants too
1203                  (defvar (, arg) (quote (, arg)) (, descr))))))
1204       (if cperl-xemacs-p
1205           (defmacro cperl-etags-snarf-tag (file line)
1206             (` (progn
1207                  (beginning-of-line 2)
1208                  (list (, file) (, line)))))
1209         (defmacro cperl-etags-snarf-tag (file line)
1210           (` (etags-snarf-tag))))
1211       (if cperl-xemacs-p
1212           (defmacro cperl-etags-goto-tag-location (elt)
1213             (`;;(progn
1214              ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
1215              ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
1216              ;; Probably will not work due to some save-excursion???
1217              ;; Or save-file-position?
1218              ;; (message "Did I get to line %s?" (elt (, elt) 1))
1219              (goto-line (string-to-int (elt (, elt) 1)))))
1220         ;;)
1221         (defmacro cperl-etags-goto-tag-location (elt)
1222           (` (etags-goto-tag-location (, elt)))))))
1223
1224 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1225
1226 (defvar cperl-can-font-lock
1227   (or cperl-xemacs-p
1228       (and (boundp 'emacs-major-version)
1229            (or window-system
1230                (> emacs-major-version 20)))))
1231
1232 (condition-case nil
1233     (require 'custom)
1234   (error nil))                          ; Already fixed by eval-when-compile
1235
1236 (defun cperl-choose-color (&rest list)
1237   (let (answer)
1238     (while list
1239       (or answer
1240           (if (or (x-color-defined-p (car list))
1241                   (null (cdr list)))
1242               (setq answer (car list))))
1243       (setq list (cdr list)))
1244     answer))
1245
1246 \f
1247 (defgroup cperl nil
1248   "Major mode for editing Perl code."
1249   :prefix "cperl-"
1250   :group 'languages)
1251
1252 (defgroup cperl-indentation-details nil
1253   "Indentation."
1254   :prefix "cperl-"
1255   :group 'cperl)
1256
1257 (defgroup cperl-affected-by-hairy nil
1258   "Variables affected by `cperl-hairy'."
1259   :prefix "cperl-"
1260   :group 'cperl)
1261
1262 (defgroup cperl-autoinsert-details nil
1263   "Auto-insert tuneup."
1264   :prefix "cperl-"
1265   :group 'cperl)
1266
1267 (defgroup cperl-faces nil
1268   "Fontification colors."
1269   :prefix "cperl-"
1270   :group 'cperl)
1271
1272 (defgroup cperl-speed nil
1273   "Speed vs. validity tuneup."
1274   :prefix "cperl-"
1275   :group 'cperl)
1276
1277 (defgroup cperl-help-system nil
1278   "Help system tuneup."
1279   :prefix "cperl-"
1280   :group 'cperl)
1281
1282 \f
1283 (defcustom cperl-extra-newline-before-brace nil
1284   "*Non-nil means that if, elsif, while, until, else, for, foreach
1285 and do constructs look like:
1286
1287         if ()
1288         {
1289         }
1290
1291 instead of:
1292
1293         if () {
1294         }"
1295   :type 'boolean
1296   :group 'cperl-autoinsert-details)
1297
1298 (defcustom cperl-extra-newline-before-brace-multiline
1299   cperl-extra-newline-before-brace
1300   "*Non-nil means the same as `cperl-extra-newline-before-brace', but
1301 for constructs with multiline if/unless/while/until/for/foreach condition."
1302   :type 'boolean
1303   :group 'cperl-autoinsert-details)
1304
1305 (defcustom cperl-indent-level 2
1306   "*Indentation of CPerl statements with respect to containing block."
1307   :type 'integer
1308   :group 'cperl-indentation-details)
1309
1310 (defcustom cperl-lineup-step nil
1311   "*`cperl-lineup' will always lineup at multiple of this number.
1312 If nil, the value of `cperl-indent-level' will be used."
1313   :type '(choice (const nil) integer)
1314   :group 'cperl-indentation-details)
1315
1316 (defcustom cperl-brace-imaginary-offset 0
1317   "*Imagined indentation of a Perl open brace that actually follows a statement.
1318 An open brace following other text is treated as if it were this far
1319 to the right of the start of its line."
1320   :type 'integer
1321   :group 'cperl-indentation-details)
1322
1323 (defcustom cperl-brace-offset 0
1324   "*Extra indentation for braces, compared with other text in same context."
1325   :type 'integer
1326   :group 'cperl-indentation-details)
1327 (defcustom cperl-label-offset -2
1328   "*Offset of CPerl label lines relative to usual indentation."
1329   :type 'integer
1330   :group 'cperl-indentation-details)
1331 (defcustom cperl-min-label-indent 1
1332   "*Minimal offset of CPerl label lines."
1333   :type 'integer
1334   :group 'cperl-indentation-details)
1335 (defcustom cperl-continued-statement-offset 2
1336   "*Extra indent for lines not starting new statements."
1337   :type 'integer
1338   :group 'cperl-indentation-details)
1339 (defcustom cperl-continued-brace-offset 0
1340   "*Extra indent for substatements that start with open-braces.
1341 This is in addition to cperl-continued-statement-offset."
1342   :type 'integer
1343   :group 'cperl-indentation-details)
1344 (defcustom cperl-close-paren-offset -1
1345   "*Extra indent for substatements that start with close-parenthesis."
1346   :type 'integer
1347   :group 'cperl-indentation-details)
1348
1349 (defcustom cperl-auto-newline nil
1350   "*Non-nil means automatically newline before and after braces,
1351 and after colons and semicolons, inserted in CPerl code.  The following
1352 \\[cperl-electric-backspace] will remove the inserted whitespace.
1353 Insertion after colons requires both this variable and
1354 `cperl-auto-newline-after-colon' set."
1355   :type 'boolean
1356   :group 'cperl-autoinsert-details)
1357
1358 (defcustom cperl-autoindent-on-semi nil
1359   "*Non-nil means automatically indent after insertion of (semi)colon.
1360 Active if `cperl-auto-newline' is false."
1361   :type 'boolean
1362   :group 'cperl-autoinsert-details)
1363
1364 (defcustom cperl-auto-newline-after-colon nil
1365   "*Non-nil means automatically newline even after colons.
1366 Subject to `cperl-auto-newline' setting."
1367   :type 'boolean
1368   :group 'cperl-autoinsert-details)
1369
1370 (defcustom cperl-tab-always-indent t
1371   "*Non-nil means TAB in CPerl mode should always reindent the current line,
1372 regardless of where in the line point is when the TAB command is used."
1373   :type 'boolean
1374   :group 'cperl-indentation-details)
1375
1376 (defcustom cperl-font-lock nil
1377   "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
1378 Can be overwritten by `cperl-hairy' if nil."
1379   :type '(choice (const null) boolean)
1380   :group 'cperl-affected-by-hairy)
1381
1382 (defcustom cperl-electric-lbrace-space nil
1383   "*Non-nil (and non-null) means { after $ should be preceded by ` '.
1384 Can be overwritten by `cperl-hairy' if nil."
1385   :type '(choice (const null) boolean)
1386   :group 'cperl-affected-by-hairy)
1387
1388 (defcustom cperl-electric-parens-string "({[]})<"
1389   "*String of parentheses that should be electric in CPerl.
1390 Closing ones are electric only if the region is highlighted."
1391   :type 'string
1392   :group 'cperl-affected-by-hairy)
1393
1394 (defcustom cperl-electric-parens nil
1395   "*Non-nil (and non-null) means parentheses should be electric in CPerl.
1396 Can be overwritten by `cperl-hairy' if nil."
1397   :type '(choice (const null) boolean)
1398   :group 'cperl-affected-by-hairy)
1399
1400 (defvar zmacs-regions)                  ; Avoid warning
1401
1402 (defcustom cperl-electric-parens-mark
1403   (and window-system
1404        (or (and (boundp 'transient-mark-mode) ; For Emacs
1405                 transient-mark-mode)
1406            (and (boundp 'zmacs-regions) ; For XEmacs
1407                 zmacs-regions)))
1408   "*Not-nil means that electric parens look for active mark.
1409 Default is yes if there is visual feedback on mark."
1410   :type 'boolean
1411   :group 'cperl-autoinsert-details)
1412
1413 (defcustom cperl-electric-linefeed nil
1414   "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
1415 In any case these two mean plain and hairy linefeeds together.
1416 Can be overwritten by `cperl-hairy' if nil."
1417   :type '(choice (const null) boolean)
1418   :group 'cperl-affected-by-hairy)
1419
1420 (defcustom cperl-electric-keywords nil
1421   "*Not-nil (and non-null) means keywords are electric in CPerl.
1422 Can be overwritten by `cperl-hairy' if nil."
1423   :type '(choice (const null) boolean)
1424   :group 'cperl-affected-by-hairy)
1425
1426 (defcustom cperl-electric-backspace-untabify t
1427   "*Not-nil means electric-backspace will untabify in CPerl."
1428   :type 'boolean
1429   :group 'cperl-autoinsert-details)
1430
1431 (defcustom cperl-hairy nil
1432   "*Not-nil means most of the bells and whistles are enabled in CPerl.
1433 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
1434 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
1435 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
1436 `cperl-lazy-help-time'."
1437   :type 'boolean
1438   :group 'cperl-affected-by-hairy)
1439
1440 (defcustom cperl-comment-column 32
1441   "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
1442   :type 'integer
1443   :group 'cperl-indentation-details)
1444
1445 (defcustom cperl-vc-header-alist '((SCCS "($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
1446                                    (RCS "($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/) ;"))
1447   "*What to use as `vc-header-alist' in CPerl."
1448   :type '(repeat (list symbol string))
1449   :group 'cperl)
1450
1451 (defcustom cperl-clobber-mode-lists
1452   (not
1453    (and
1454     (boundp 'interpreter-mode-alist)
1455     (assoc "miniperl" interpreter-mode-alist)
1456     (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
1457   "*Whether to install us into `interpreter-' and `extension' mode lists."
1458   :type 'boolean
1459   :group 'cperl)
1460
1461 (defcustom cperl-info-on-command-no-prompt nil
1462   "*Not-nil (and non-null) means not to prompt on C-h f.
1463 The opposite behaviour is always available if prefixed with C-c.
1464 Can be overwritten by `cperl-hairy' if nil."
1465   :type '(choice (const null) boolean)
1466   :group 'cperl-affected-by-hairy)
1467
1468 (defcustom cperl-clobber-lisp-bindings nil
1469   "*Not-nil (and non-null) means not overwrite C-h f.
1470 The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
1471 Can be overwritten by `cperl-hairy' if nil."
1472   :type '(choice (const null) boolean)
1473   :group 'cperl-affected-by-hairy)
1474
1475 (defcustom cperl-lazy-help-time nil
1476   "*Not-nil (and non-null) means to show lazy help after given idle time.
1477 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
1478   :type '(choice (const null) (const nil) integer)
1479   :group 'cperl-affected-by-hairy)
1480
1481 (defcustom cperl-pod-face 'font-lock-comment-face
1482   "*The result of evaluation of this expression is used for POD highlighting."
1483   :type 'face
1484   :group 'cperl-faces)
1485
1486 (defcustom cperl-pod-head-face 'font-lock-variable-name-face
1487   "*The result of evaluation of this expression is used for POD highlighting.
1488 Font for POD headers."
1489   :type 'face
1490   :group 'cperl-faces)
1491
1492 (defcustom cperl-here-face 'font-lock-string-face
1493   "*The result of evaluation of this expression is used for here-docs highlighting."
1494   :type 'face
1495   :group 'cperl-faces)
1496
1497 (defcustom cperl-invalid-face ''underline ; later evaluated by `font-lock'
1498   "*The result of evaluation of this expression highlights trailing whitespace."
1499   :type 'face
1500   :group 'cperl-faces)
1501
1502 (defcustom cperl-pod-here-fontify '(featurep 'font-lock)
1503   "*Not-nil after evaluation means to highlight POD and here-docs sections."
1504   :type 'boolean
1505   :group 'cperl-faces)
1506
1507 (defcustom cperl-fontify-m-as-s t
1508   "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
1509   :type 'boolean
1510   :group 'cperl-faces)
1511
1512 (defcustom cperl-highlight-variables-indiscriminately nil
1513   "*Non-nil means perform additional highlighting on variables.
1514 Currently only changes how scalar variables are highlighted.
1515 Note that that variable is only read at initialization time for
1516 the variable `perl-font-lock-keywords-2', so changing it after you've
1517 entered CPerl mode the first time will have no effect."
1518   :type 'boolean
1519   :group 'cperl)
1520
1521 (defcustom cperl-pod-here-scan t
1522   "*Not-nil means look for POD and here-docs sections during startup.
1523 You can always make lookup from menu or using \\[cperl-find-pods-heres]."
1524   :type 'boolean
1525   :group 'cperl-speed)
1526
1527 (defcustom cperl-regexp-scan t
1528   "*Not-nil means make marking of regular expression more thorough.
1529 Effective only with `cperl-pod-here-scan'.  Not implemented yet."
1530   :type 'boolean
1531   :group 'cperl-speed)
1532
1533 (defcustom cperl-imenu-addback nil
1534   "*Not-nil means add backreferences to generated `imenu's.
1535 May require patched `imenu' and `imenu-go'.  Obsolete."
1536   :type 'boolean
1537   :group 'cperl-help-system)
1538
1539 (defcustom cperl-max-help-size 66
1540   "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
1541   :type '(choice integer (const nil))
1542   :group 'cperl-help-system)
1543
1544 (defcustom cperl-shrink-wrap-info-frame t
1545   "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
1546   :type 'boolean
1547   :group 'cperl-help-system)
1548
1549 (defcustom cperl-info-page "perl"
1550   "*Name of the info page containing perl docs.
1551 Older version of this page was called `perl5', newer `perl'."
1552   :type 'string
1553   :group 'cperl-help-system)
1554
1555 (defcustom cperl-use-syntax-table-text-property
1556   (boundp 'parse-sexp-lookup-properties)
1557   "*Non-nil means CPerl sets up and uses `syntax-table' text property."
1558   :type 'boolean
1559   :group 'cperl-speed)
1560
1561 (defcustom cperl-use-syntax-table-text-property-for-tags
1562   cperl-use-syntax-table-text-property
1563   "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
1564   :type 'boolean
1565   :group 'cperl-speed)
1566
1567 (defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
1568   "*Regexp to match files to scan when generating TAGS."
1569   :type 'regexp
1570   :group 'cperl)
1571
1572 (defcustom cperl-noscan-files-regexp
1573   "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
1574   "*Regexp to match files/dirs to skip when generating TAGS."
1575   :type 'regexp
1576   :group 'cperl)
1577
1578 (defcustom cperl-regexp-indent-step nil
1579   "*Indentation used when beautifying regexps.
1580 If nil, the value of `cperl-indent-level' will be used."
1581   :type '(choice integer (const nil))
1582   :group 'cperl-indentation-details)
1583
1584 (defcustom cperl-indent-left-aligned-comments t
1585   "*Non-nil means that the comment starting in leftmost column should indent."
1586   :type 'boolean
1587   :group 'cperl-indentation-details)
1588
1589 (defcustom cperl-under-as-char t
1590   "*Non-nil means that the _ (underline) should be treated as word char."
1591   :type 'boolean
1592   :group 'cperl)
1593
1594 (defcustom cperl-extra-perl-args ""
1595   "*Extra arguments to use when starting Perl.
1596 Currently used with `cperl-check-syntax' only."
1597   :type 'string
1598   :group 'cperl)
1599
1600 (defcustom cperl-message-electric-keyword t
1601   "*Non-nil means that the `cperl-electric-keyword' prints a help message."
1602   :type 'boolean
1603   :group 'cperl-help-system)
1604
1605 (defcustom cperl-indent-region-fix-constructs 1
1606   "*Amount of space to insert between `}' and `else' or `elsif'
1607 in `cperl-indent-region'.  Set to nil to leave as is.  Values other
1608 than 1 and nil will probably not work."
1609   :type '(choice (const nil) (const 1))
1610   :group 'cperl-indentation-details)
1611
1612 (defcustom cperl-break-one-line-blocks-when-indent t
1613   "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
1614 need to be reformatted into multiline ones when indenting a region."
1615   :type 'boolean
1616   :group 'cperl-indentation-details)
1617
1618 (defcustom cperl-fix-hanging-brace-when-indent t
1619   "*Non-nil means that BLOCK-end `}' may be put on a separate line
1620 when indenting a region.
1621 Braces followed by else/elsif/while/until are excepted."
1622   :type 'boolean
1623   :group 'cperl-indentation-details)
1624
1625 (defcustom cperl-merge-trailing-else t
1626   "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
1627 may be merged to be on the same line when indenting a region."
1628   :type 'boolean
1629   :group 'cperl-indentation-details)
1630
1631 (defcustom cperl-indent-parens-as-block nil
1632   "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
1633 but for trailing \",\" inside the group, which won't increase indentation.
1634 One should tune up `cperl-close-paren-offset' as well."
1635   :type 'boolean
1636   :group 'cperl-indentation-details)
1637
1638 (defcustom cperl-syntaxify-by-font-lock
1639   (and cperl-can-font-lock
1640        (boundp 'parse-sexp-lookup-properties))
1641   "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
1642   :type '(choice (const message) boolean)
1643   :group 'cperl-speed)
1644
1645 (defcustom cperl-syntaxify-unwind
1646   t
1647   "*Non-nil means that CPerl unwinds to a start of a long construction
1648 when syntaxifying a chunk of buffer."
1649   :type 'boolean
1650   :group 'cperl-speed)
1651
1652 (defcustom cperl-ps-print-face-properties
1653   '((font-lock-keyword-face             nil nil         bold shadow)
1654     (font-lock-variable-name-face       nil nil         bold)
1655     (font-lock-function-name-face       nil nil         bold italic box)
1656     (font-lock-constant-face            nil "LightGray" bold)
1657     (cperl-array-face                   nil "LightGray" bold underline)
1658     (cperl-hash-face                    nil "LightGray" bold italic underline)
1659     (font-lock-comment-face             nil "LightGray" italic)
1660     (font-lock-string-face              nil nil         italic underline)
1661     (cperl-nonoverridable-face          nil nil         italic underline)
1662     (font-lock-type-face                nil nil         underline)
1663     (underline                          nil "LightGray" strikeout))
1664   "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
1665   :type '(repeat (cons symbol
1666                        (cons (choice (const nil) string)
1667                              (cons (choice (const nil) string)
1668                                    (repeat symbol)))))
1669   :group 'cperl-faces)
1670
1671 (if cperl-can-font-lock
1672     (progn
1673       (defvar cperl-dark-background
1674         (cperl-choose-color "navy" "os2blue" "darkgreen"))
1675       (defvar cperl-dark-foreground
1676         (cperl-choose-color "orchid1" "orange"))
1677
1678       (defface cperl-nonoverridable-face
1679         (` ((((class grayscale) (background light))
1680              (:background "Gray90" :italic t :underline t))
1681             (((class grayscale) (background dark))
1682              (:foreground "Gray80" :italic t :underline t :bold t))
1683             (((class color) (background light))
1684              (:foreground "chartreuse3"))
1685             (((class color) (background dark))
1686              (:foreground (, cperl-dark-foreground)))
1687             (t (:bold t :underline t))))
1688         "Font Lock mode face used to highlight array names."
1689         :group 'cperl-faces)
1690
1691       (defface cperl-array-face
1692         (` ((((class grayscale) (background light))
1693              (:background "Gray90" :bold t))
1694             (((class grayscale) (background dark))
1695              (:foreground "Gray80" :bold t))
1696             (((class color) (background light))
1697              (:foreground "Blue" :background "lightyellow2" :bold t))
1698             (((class color) (background dark))
1699              (:foreground "yellow" :background (, cperl-dark-background) :bold t))
1700             (t (:bold t))))
1701         "Font Lock mode face used to highlight array names."
1702         :group 'cperl-faces)
1703
1704       (defface cperl-hash-face
1705         (` ((((class grayscale) (background light))
1706              (:background "Gray90" :bold t :italic t))
1707             (((class grayscale) (background dark))
1708              (:foreground "Gray80" :bold t :italic t))
1709             (((class color) (background light))
1710              (:foreground "Red" :background "lightyellow2" :bold t :italic t))
1711             (((class color) (background dark))
1712              (:foreground "Red" :background (, cperl-dark-background) :bold t :italic t))
1713             (t (:bold t :italic t))))
1714         "Font Lock mode face used to highlight hash names."
1715         :group 'cperl-faces)))
1716
1717 \f
1718
1719 ;;; Short extra-docs.
1720
1721 (defvar cperl-tips 'please-ignore-this-line
1722   "Get maybe newer version of this package from
1723   ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
1724 and/or
1725   ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
1726 Subdirectory `cperl-mode' may contain yet newer development releases and/or
1727 patches to related files.
1728
1729 For best results apply to an older Emacs the patches from
1730   ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
1731 \(this upgrades syntax-parsing abilities of RMS Emaxen v19.34 and 
1732 v20.2 up to the level of RMS Emacs v20.3 - a must for a good Perl
1733 mode.)  As of beginning of 2003, XEmacs may provide a similar ability.
1734
1735 Get support packages choose-color.el (or font-lock-extra.el before
1736 19.30), imenu-go.el from the same place.  \(Look for other files there
1737 too... ;-).  Get a patch for imenu.el in 19.29.  Note that for 19.30 and
1738 later you should use choose-color.el *instead* of font-lock-extra.el
1739 \(and you will not get smart highlighting in C :-().
1740
1741 Note that to enable Compile choices in the menu you need to install
1742 mode-compile.el.
1743
1744 If your Emacs does not default to `cperl-mode' on Perl files, and you
1745 want it to: put the following into your .emacs file:
1746
1747   (autoload 'perl-mode \"cperl-mode\" \"alternate mode for editing Perl programs\" t)
1748
1749 or
1750
1751   (defalias 'perl-mode 'cperl-mode)
1752
1753 Get perl5-info from
1754   $CPAN/doc/manual/info/perl-info.tar.gz
1755 older version was on
1756   http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
1757
1758 If you use imenu-go, run imenu on perl5-info buffer (you can do it
1759 from Perl menu).  If many files are related, generate TAGS files from
1760 Tools/Tags submenu in Perl menu.
1761
1762 If some class structure is too complicated, use Tools/Hierarchy-view
1763 from Perl menu, or hierarchic view of imenu.  The second one uses the
1764 current buffer only, the first one requires generation of TAGS from
1765 Perl/Tools/Tags menu beforehand.
1766
1767 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
1768
1769 Switch auto-help on/off with Perl/Tools/Auto-help.
1770
1771 Though with contemporary Emaxen CPerl mode should maintain the correct
1772 parsing of Perl even when editing, sometimes it may be lost.  Fix this by
1773
1774   M-x norm RET
1775
1776 or
1777
1778   \\[normal-mode]
1779
1780 In cases of more severe confusion sometimes it is helpful to do
1781
1782   M-x load-l RET cperl-mode RET
1783   M-x norm RET
1784
1785 or
1786
1787   \\[load-library] cperl-mode RET
1788   \\[normal-mode]
1789
1790 Before reporting (non-)problems look in the problem section of online
1791 micro-docs on what I know about CPerl problems.")
1792
1793 (defvar cperl-problems 'please-ignore-this-line
1794   "Description of problems in CPerl mode.
1795 Some faces will not be shown on some versions of Emacs unless you
1796 install choose-color.el, available from
1797    ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
1798
1799 `fill-paragraph' on a comment may leave the point behind the
1800 paragraph.  Parsing of lines with several <<EOF is not implemented
1801 yet.
1802
1803 Emacs had a _very_ restricted syntax parsing engine until RMS's Emacs
1804 20.1.  Most problems below are corrected starting from this version of
1805 Emacs, and all of them should be fixed in RMS's version 20.3.  (Or apply
1806 patches to Emacs 19.33/34 - see tips.)  XEmacs was very backward in
1807 this respect (until 2003).
1808
1809 Note that even with newer Emacsen in some very rare cases the details
1810 of interaction of `font-lock' and syntaxification may be not cleaned
1811 up yet.  You may get slightly different colors basing on the order of
1812 fontification and syntaxification.  Say, the initial faces is correct,
1813 but editing the buffer breaks this.
1814
1815 Even with older Emacsen CPerl mode tries to corrects some Emacs
1816 misunderstandings, however, for efficiency reasons the degree of
1817 correction is different for different operations.  The partially
1818 corrected problems are: POD sections, here-documents, regexps.  The
1819 operations are: highlighting, indentation, electric keywords, electric
1820 braces.
1821
1822 This may be confusing, since the regexp s#//#/#\; may be highlighted
1823 as a comment, but it will be recognized as a regexp by the indentation
1824 code.  Or the opposite case, when a POD section is highlighted, but
1825 may break the indentation of the following code (though indentation
1826 should work if the balance of delimiters is not broken by POD).
1827
1828 The main trick (to make $ a \"backslash\") makes constructions like
1829 ${aaa} look like unbalanced braces.  The only trick I can think of is
1830 to insert it as $ {aaa} (legal in perl5, not in perl4).
1831
1832 Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
1833 as /($|\\s)/.  Note that such a transposition is not always possible.
1834
1835 The solution is to upgrade your Emacs or patch an older one.  Note
1836 that RMS's 20.2 has some bugs related to `syntax-table' text
1837 properties.  Patches are available on the main CPerl download site,
1838 and on CPAN.
1839
1840 If these bugs cannot be fixed on your machine (say, you have an inferior
1841 environment and cannot recompile), you may still disable all the fancy stuff
1842 via `cperl-use-syntax-table-text-property'.")
1843
1844 (defvar cperl-non-problems 'please-ignore-this-line
1845 "As you know from `problems' section, Perl syntax is too hard for CPerl on 
1846 older Emacsen.  Here is what you can do if you cannot upgrade, or if
1847 you want to switch off these capabilities on RMS Emacs 20.2 (+patches) or 20.3
1848 or better.  Please skip this docs if you run a capable Emacs already.
1849
1850 Most of the time, if you write your own code, you may find an equivalent
1851 \(and almost as readable) expression (what is discussed below is usually
1852 not relevant on newer Emacsen, since they can do it automatically).
1853
1854 Try to help CPerl: add comments with embedded quotes to fix CPerl
1855 misunderstandings about the end of quotation:
1856
1857 $a='500$';      # ';
1858
1859 You won't need it too often.  The reason: $ \"quotes\" the following
1860 character (this saves a life a lot of times in CPerl), thus due to
1861 Emacs parsing rules it does not consider tick (i.e., ' ) after a
1862 dollar as a closing one, but as a usual character.  This is usually
1863 correct, but not in the above context.
1864
1865 Even with older Emacsen the indentation code is pretty wise.  The only
1866 drawback is that it relied on Emacs parsing to find matching
1867 parentheses.  And Emacs *could not* match parentheses in Perl 100%
1868 correctly.  So
1869         1 if s#//#/#;
1870 would not break indentation, but
1871         1 if ( s#//#/# );
1872 would.  Upgrade.
1873
1874 By similar reasons
1875         s\"abc\"def\";
1876 could confuse CPerl a lot.
1877
1878 If you still get wrong indentation in situation that you think the
1879 code should be able to parse, try:
1880
1881 a) Check what Emacs thinks about balance of your parentheses.
1882 b) Supply the code to me (IZ).
1883
1884 Pods were treated _very_ rudimentally.  Here-documents were not
1885 treated at all (except highlighting and inhibiting indentation).  Upgrade.
1886
1887 To speed up coloring the following compromises exist:
1888    a) sub in $mypackage::sub may be highlighted.
1889    b) -z in [a-z] may be highlighted.
1890    c) if your regexp contains a keyword (like \"s\"), it may be highlighted.
1891
1892
1893 Imenu in 19.31 is broken.  Set `imenu-use-keymap-menu' to t, and remove
1894 `car' before `imenu-choose-buffer-index' in `imenu'.
1895 `imenu-add-to-menubar' in 20.2 is broken.  
1896 A lot of things on XEmacs may be broken too, judging by bug reports I
1897 receive.  Note that some releases of XEmacs are better than the others
1898 as far as bugs reports I see are concerned.")
1899
1900 (defvar cperl-praise 'please-ignore-this-line
1901   "Advantages of CPerl mode.
1902
1903 0) It uses the newest `syntax-table' property ;-);
1904
1905 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
1906 mode - but the latter number may have improved too in last years) even
1907 with old Emaxen which do not support `syntax-table' property.
1908
1909 When using `syntax-table' property for syntax assist hints, it should
1910 handle 99.995% of lines correct - or somesuch.  It automatically
1911 updates syntax assist hints when you edit your script.
1912
1913 2) It is generally believed to be \"the most user-friendly Emacs
1914 package\" whatever it may mean (I doubt that the people who say similar
1915 things tried _all_ the rest of Emacs ;-), but this was not a lonely
1916 voice);
1917
1918 3) Everything is customizable, one-by-one or in a big sweep;
1919
1920 4) It has many easily-accessable \"tools\":
1921         a) Can run program, check syntax, start debugger;
1922         b) Can lineup vertically \"middles\" of rows, like `=' in
1923                 a  = b;
1924                 cc = d;
1925         c) Can insert spaces where this impoves readability (in one
1926                 interactive sweep over the buffer);
1927         d) Has support for imenu, including:
1928                 1) Separate unordered list of \"interesting places\";
1929                 2) Separate TOC of POD sections;
1930                 3) Separate list of packages;
1931                 4) Hierarchical view of methods in (sub)packages;
1932                 5) and functions (by the full name - with package);
1933         e) Has an interface to INFO docs for Perl; The interface is
1934                 very flexible, including shrink-wrapping of
1935                 documentation buffer/frame;
1936         f) Has a builtin list of one-line explanations for perl constructs.
1937         g) Can show these explanations if you stay long enough at the
1938                 corresponding place (or on demand);
1939         h) Has an enhanced fontification (using 3 or 4 additional faces
1940                 comparing to font-lock - basically, different
1941                 namespaces in Perl have different colors);
1942         i) Can construct TAGS basing on its knowledge of Perl syntax,
1943                 the standard menu has 6 different way to generate
1944                 TAGS (if \"by directory\", .xs files - with C-language
1945                 bindings - are included in the scan);
1946         j) Can build a hierarchical view of classes (via imenu) basing
1947                 on generated TAGS file;
1948         k) Has electric parentheses, electric newlines, uses Abbrev
1949                 for electric logical constructs
1950                         while () {}
1951                 with different styles of expansion (context sensitive
1952                 to be not so bothering).  Electric parentheses behave
1953                 \"as they should\" in a presence of a visible region.
1954         l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
1955         m) Can convert from
1956                 if (A) { B }
1957            to
1958                 B if A;
1959
1960         n) Highlights (by user-choice) either 3-delimiters constructs
1961            (such as tr/a/b/), or regular expressions and `y/tr';
1962         o) Highlights trailing whitespace;
1963         p) Is able to manipulate Perl Regular Expressions to ease
1964            conversion to a more readable form.
1965
1966 5) The indentation engine was very smart, but most of tricks may be
1967 not needed anymore with the support for `syntax-table' property.  Has
1968 progress indicator for indentation (with `imenu' loaded).
1969
1970 6) Indent-region improves inline-comments as well; also corrects
1971 whitespace *inside* the conditional/loop constructs.
1972
1973 7) Fill-paragraph correctly handles multi-line comments;
1974
1975 8) Can switch to different indentation styles by one command, and restore
1976 the settings present before the switch.
1977
1978 9) When doing indentation of control constructs, may correct
1979 line-breaks/spacing between elements of the construct.
1980
1981 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
1982 capable syntax engines).")
1983
1984 (defvar cperl-speed 'please-ignore-this-line
1985   "This is an incomplete compendium of what is available in other parts
1986 of CPerl documentation.  (Please inform me if I skept anything.)
1987
1988 There is a perception that CPerl is slower than alternatives.  This part
1989 of documentation is designed to overcome this misconception.
1990
1991 *By default* CPerl tries to enable the most comfortable settings.
1992 From most points of view, correctly working package is infinitely more
1993 comfortable than a non-correctly working one, thus by default CPerl
1994 prefers correctness over speed.  Below is the guide how to change
1995 settings if your preferences are different.
1996
1997 A)  Speed of loading the file.  When loading file, CPerl may perform a
1998 scan which indicates places which cannot be parsed by primitive Emacs
1999 syntax-parsing routines, and marks them up so that either
2000
2001     A1) CPerl may work around these deficiencies (for big chunks, mostly
2002         PODs and HERE-documents), or
2003     A2) On capable Emaxen CPerl will use improved syntax-handlings
2004         which reads mark-up hints directly.
2005
2006     The scan in case A2 is much more comprehensive, thus may be slower.
2007
2008     User can disable syntax-engine-helping scan of A2 by setting
2009        `cperl-use-syntax-table-text-property'
2010     variable to nil (if it is set to t).
2011
2012     One can disable the scan altogether (both A1 and A2) by setting
2013        `cperl-pod-here-scan'
2014     to nil.
2015
2016 B) Speed of editing operations.
2017
2018     One can add a (minor) speedup to editing operations by setting
2019        `cperl-use-syntax-table-text-property'
2020     variable to nil (if it is set to t).  This will disable
2021     syntax-engine-helping scan, thus will make many more Perl
2022     constructs be wrongly recognized by CPerl, thus may lead to
2023     wrongly matched parentheses, wrong indentation, etc.
2024
2025     One can unset `cperl-syntaxify-unwind'.  This might speed up editing
2026     of, say, long POD sections.")
2027
2028 (defvar cperl-tips-faces 'please-ignore-this-line
2029   "CPerl mode uses following faces for highlighting:
2030
2031   `cperl-array-face'            Array names
2032   `cperl-hash-face'             Hash names
2033   `font-lock-comment-face'      Comments, PODs and whatever is considered
2034                                 syntaxically to be not code
2035   `font-lock-constant-face'     HERE-doc delimiters, labels, delimiters of
2036                                 2-arg operators s/y/tr/ or of RExen,
2037   `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
2038                                 a target of a file tests, file tests,
2039                                 subroutine names at the moment of definition
2040                                 (except those conflicting with Perl operators),
2041                                 package names (when recognized), format names
2042   `font-lock-keyword-face'      Control flow switch constructs, declarators
2043   `cperl-nonoverridable-face'   Non-overridable keywords, modifiers of RExen
2044   `font-lock-string-face'       Strings, qw() constructs, RExen, POD sections,
2045                                 literal parts and the terminator of formats
2046                                 and whatever is syntaxically considered
2047                                 as string literals
2048   `font-lock-type-face'         Overridable keywords
2049   `font-lock-variable-name-face' Variable declarations, indirect array and
2050                                 hash names, POD headers/item names
2051   `cperl-invalid-face'          Trailing whitespace
2052
2053 Note that in several situations the highlighting tries to inform about
2054 possible confusion, such as different colors for function names in
2055 declarations depending on what they (do not) override, or special cases
2056 m// and s/// which do not do what one would expect them to do.
2057
2058 Help with best setup of these faces for printout requested (for each of
2059 the faces: please specify bold, italic, underline, shadow and box.)
2060
2061 \(Not finished.)")
2062
2063 \f
2064
2065 ;;; Portability stuff:
2066
2067 (defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
2068   (` (define-key cperl-mode-map
2069        (, (if xemacs-key
2070               (` (if cperl-xemacs-p (, xemacs-key) (, emacs-key)))
2071             emacs-key))
2072        (, definition))))
2073
2074 (defvar cperl-del-back-ch
2075   (car (append (where-is-internal 'delete-backward-char)
2076                (where-is-internal 'backward-delete-char-untabify)))
2077   "Character generated by key bound to `delete-backward-char'.")
2078
2079 (and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
2080      (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
2081
2082 (defun cperl-mark-active () (mark))     ; Avoid undefined warning
2083 (if cperl-xemacs-p
2084     (progn
2085       ;; "Active regions" are on: use region only if active
2086       ;; "Active regions" are off: use region unconditionally
2087       (defun cperl-use-region-p ()
2088         (if zmacs-regions (mark) t)))
2089   (defun cperl-use-region-p ()
2090     (if transient-mark-mode mark-active t))
2091   (defun cperl-mark-active () mark-active))
2092
2093 (defsubst cperl-enable-font-lock ()
2094   cperl-can-font-lock)
2095
2096 (defun cperl-putback-char (c)           ; Emacs 19
2097   (set 'unread-command-events (list c))) ; Avoid undefined warning
2098
2099 (if (boundp 'unread-command-events)
2100     (if cperl-xemacs-p
2101         (defun cperl-putback-char (c)   ; XEmacs >= 19.12
2102           (setq unread-command-events (list (eval '(character-to-event c))))))
2103   (defun cperl-putback-char (c)         ; XEmacs <= 19.11
2104     (set 'unread-command-event (eval '(character-to-event c))))) ; Avoid warnings
2105
2106 (or (fboundp 'uncomment-region)
2107     (defun uncomment-region (beg end)
2108       (interactive "r")
2109       (comment-region beg end -1)))
2110
2111 (defvar cperl-do-not-fontify
2112   (if (string< emacs-version "19.30")
2113       'fontified
2114     'lazy-lock)
2115   "Text property which inhibits refontification.")
2116
2117 (defsubst cperl-put-do-not-fontify (from to &optional post)
2118   ;; If POST, do not do it with postponed fontification
2119   (if (and post cperl-syntaxify-by-font-lock)
2120       nil
2121     (put-text-property (max (point-min) (1- from))
2122                        to cperl-do-not-fontify t)))
2123
2124 (defcustom cperl-mode-hook nil
2125   "Hook run by CPerl mode."
2126   :type 'hook
2127   :group 'cperl)
2128
2129 (defvar cperl-syntax-state nil)
2130 (defvar cperl-syntax-done-to nil)
2131 (defvar cperl-emacs-can-parse (> (length (save-excursion
2132                                            (parse-partial-sexp (point) (point)))) 9))
2133 \f
2134 ;; Make customization possible "in reverse"
2135 (defsubst cperl-val (symbol &optional default hairy)
2136   (cond
2137    ((eq (symbol-value symbol) 'null) default)
2138    (cperl-hairy (or hairy t))
2139    (t (symbol-value symbol))))
2140 \f
2141 ;;; Probably it is too late to set these guys already, but it can help later:
2142
2143 (and cperl-clobber-mode-lists
2144      (setq auto-mode-alist
2145       (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode))  auto-mode-alist ))
2146      (and (boundp 'interpreter-mode-alist)
2147           (setq interpreter-mode-alist (append interpreter-mode-alist
2148                                                '(("miniperl" . perl-mode))))))
2149 (if (fboundp 'eval-when-compile)
2150     (eval-when-compile
2151       (mapcar (lambda (p)
2152                 (condition-case nil
2153                     (require p)
2154                   (error nil)))
2155               '(imenu easymenu etags timer man info))
2156       (if (fboundp 'ps-extend-face-list)
2157           (defmacro cperl-ps-extend-face-list (arg)
2158             (` (ps-extend-face-list (, arg))))
2159         (defmacro cperl-ps-extend-face-list (arg)
2160           (` (error "This version of Emacs has no `ps-extend-face-list'"))))
2161       ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
2162       ;; macros instead of defsubsts don't work on Emacs, so we do the
2163       ;; expansion manually.  Any other suggestions?
2164       (if cperl-can-font-lock
2165           (require 'font-lock))
2166       (require 'cl)))
2167
2168 (defvar cperl-mode-abbrev-table nil
2169   "Abbrev table in use in CPerl mode buffers.")
2170
2171 (add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
2172
2173 (defvar cperl-mode-map () "Keymap used in CPerl mode.")
2174
2175 (if cperl-mode-map nil
2176   (setq cperl-mode-map (make-sparse-keymap))
2177   (cperl-define-key "{" 'cperl-electric-lbrace)
2178   (cperl-define-key "[" 'cperl-electric-paren)
2179   (cperl-define-key "(" 'cperl-electric-paren)
2180   (cperl-define-key "<" 'cperl-electric-paren)
2181   (cperl-define-key "}" 'cperl-electric-brace)
2182   (cperl-define-key "]" 'cperl-electric-rparen)
2183   (cperl-define-key ")" 'cperl-electric-rparen)
2184   (cperl-define-key ";" 'cperl-electric-semi)
2185   (cperl-define-key ":" 'cperl-electric-terminator)
2186   (cperl-define-key "\C-j" 'newline-and-indent)
2187   (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
2188   (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
2189   (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
2190   (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
2191   (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
2192   (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
2193   (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
2194   (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
2195   (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
2196   (cperl-define-key [?\C-\M-\|] 'cperl-lineup
2197                     [(control meta |)])
2198   ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
2199   ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
2200   (cperl-define-key "\177" 'cperl-electric-backspace)
2201   (cperl-define-key "\t" 'cperl-indent-command)
2202   ;; don't clobber the backspace binding:
2203   (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
2204                     [(control c) (control h) F])
2205   (if (cperl-val 'cperl-clobber-lisp-bindings)
2206       (progn
2207         (cperl-define-key "\C-hf"
2208                           ;;(concat (char-to-string help-char) "f") ; does not work
2209                           'cperl-info-on-command
2210                           [(control h) f])
2211         (cperl-define-key "\C-hv"
2212                           ;;(concat (char-to-string help-char) "v") ; does not work
2213                           'cperl-get-help
2214                           [(control h) v])
2215         (cperl-define-key "\C-c\C-hf"
2216                           ;;(concat (char-to-string help-char) "f") ; does not work
2217                           (key-binding "\C-hf")
2218                           [(control c) (control h) f])
2219         (cperl-define-key "\C-c\C-hv"
2220                           ;;(concat (char-to-string help-char) "v") ; does not work
2221                           (key-binding "\C-hv")
2222                           [(control c) (control h) v]))
2223     (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
2224                       [(control c) (control h) f])
2225     (cperl-define-key "\C-c\C-hv"
2226                       ;;(concat (char-to-string help-char) "v") ; does not work
2227                       'cperl-get-help
2228                       [(control c) (control h) v]))
2229   (if (and cperl-xemacs-p
2230            (<= emacs-minor-version 11) (<= emacs-major-version 19))
2231       (progn
2232         ;; substitute-key-definition is usefulness-deenhanced...
2233         (cperl-define-key "\M-q" 'cperl-fill-paragraph)
2234         (cperl-define-key "\e;" 'cperl-indent-for-comment)
2235         (cperl-define-key "\e\C-\\" 'cperl-indent-region))
2236     (substitute-key-definition
2237      'indent-sexp 'cperl-indent-exp
2238      cperl-mode-map global-map)
2239     (substitute-key-definition
2240      'fill-paragraph 'cperl-fill-paragraph
2241      cperl-mode-map global-map)
2242     (substitute-key-definition
2243      'indent-region 'cperl-indent-region
2244      cperl-mode-map global-map)
2245     (substitute-key-definition
2246      'indent-for-comment 'cperl-indent-for-comment
2247      cperl-mode-map global-map)))
2248
2249 (defvar cperl-menu)
2250 (defvar cperl-lazy-installed)
2251 (defvar cperl-old-style nil)
2252 (condition-case nil
2253     (progn
2254       (require 'easymenu)
2255       (easy-menu-define
2256        cperl-menu cperl-mode-map "Menu for CPerl mode"
2257        '("Perl"
2258          ["Beginning of function" beginning-of-defun t]
2259          ["End of function" end-of-defun t]
2260          ["Mark function" mark-defun t]
2261          ["Indent expression" cperl-indent-exp t]
2262          ["Fill paragraph/comment" cperl-fill-paragraph t]
2263          "----"
2264          ["Line up a construction" cperl-lineup (cperl-use-region-p)]
2265          ["Invert if/unless/while etc" cperl-invert-if-unless t]
2266          ("Regexp"
2267           ["Beautify" cperl-beautify-regexp
2268            cperl-use-syntax-table-text-property]
2269           ["Beautify one level deep" (cperl-beautify-regexp 1)
2270            cperl-use-syntax-table-text-property]
2271           ["Beautify a group" cperl-beautify-level
2272            cperl-use-syntax-table-text-property]
2273           ["Beautify a group one level deep" (cperl-beautify-level 1)
2274            cperl-use-syntax-table-text-property]
2275           ["Contract a group" cperl-contract-level
2276            cperl-use-syntax-table-text-property]
2277           ["Contract groups" cperl-contract-levels
2278            cperl-use-syntax-table-text-property])
2279          ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
2280          "----"
2281          ["Indent region" cperl-indent-region (cperl-use-region-p)]
2282          ["Comment region" cperl-comment-region (cperl-use-region-p)]
2283          ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
2284          "----"
2285          ["Run" mode-compile (fboundp 'mode-compile)]
2286          ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
2287                                         (get-buffer "*compilation*"))]
2288          ["Next error" next-error (get-buffer "*compilation*")]
2289          ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
2290          "----"
2291          ["Debugger" cperl-db t]
2292          "----"
2293          ("Tools"
2294           ["Imenu" imenu (fboundp 'imenu)]
2295           ["Insert spaces if needed" cperl-find-bad-style t]
2296           ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
2297           ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
2298           ["CPerl pretty print (exprmntl)" cperl-ps-print 
2299            (fboundp 'ps-extend-face-list)]
2300           ["Imenu on info" cperl-imenu-on-info (featurep 'imenu)]
2301           ("Tags"
2302 ;;;          ["Create tags for current file" cperl-etags t]
2303 ;;;          ["Add tags for current file" (cperl-etags t) t]
2304 ;;;          ["Create tags for Perl files in directory" (cperl-etags nil t) t]
2305 ;;;          ["Add tags for Perl files in directory" (cperl-etags t t) t]
2306 ;;;          ["Create tags for Perl files in (sub)directories"
2307 ;;;           (cperl-etags nil 'recursive) t]
2308 ;;;          ["Add tags for Perl files in (sub)directories"
2309 ;;;           (cperl-etags t 'recursive) t])
2310 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
2311            ["Create tags for current file" (cperl-write-tags nil t) t]
2312            ["Add tags for current file" (cperl-write-tags) t]
2313            ["Create tags for Perl files in directory"
2314             (cperl-write-tags nil t nil t) t]
2315            ["Add tags for Perl files in directory"
2316             (cperl-write-tags nil nil nil t) t]
2317            ["Create tags for Perl files in (sub)directories"
2318             (cperl-write-tags nil t t t) t]
2319            ["Add tags for Perl files in (sub)directories"
2320             (cperl-write-tags nil nil t t) t]))
2321          ("Perl docs"
2322           ["Define word at point" imenu-go-find-at-position 
2323            (fboundp 'imenu-go-find-at-position)]
2324           ["Help on function" cperl-info-on-command t]
2325           ["Help on function at point" cperl-info-on-current-command t]
2326           ["Help on symbol at point" cperl-get-help t]
2327           ["Perldoc" cperl-perldoc t]
2328           ["Perldoc on word at point" cperl-perldoc-at-point t]
2329           ["View manpage of POD in this file" cperl-build-manpage t]
2330           ["Auto-help on" cperl-lazy-install 
2331            (and (fboundp 'run-with-idle-timer)
2332                 (not cperl-lazy-installed))]
2333           ["Auto-help off" cperl-lazy-unstall
2334            (and (fboundp 'run-with-idle-timer)
2335                 cperl-lazy-installed)])
2336          ("Toggle..."
2337           ["Auto newline" cperl-toggle-auto-newline t]
2338           ["Electric parens" cperl-toggle-electric t]
2339           ["Electric keywords" cperl-toggle-abbrev t]
2340           ["Fix whitespace on indent" cperl-toggle-construct-fix t]
2341           ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
2342           ["Auto fill" auto-fill-mode t]) 
2343          ("Indent styles..."
2344           ["CPerl" (cperl-set-style "CPerl") t]
2345           ["PerlStyle" (cperl-set-style "PerlStyle") t]
2346           ["GNU" (cperl-set-style "GNU") t]
2347           ["C++" (cperl-set-style "C++") t]
2348           ["FSF" (cperl-set-style "FSF") t]
2349           ["BSD" (cperl-set-style "BSD") t]
2350           ["Whitesmith" (cperl-set-style "Whitesmith") t]
2351           ["Current" (cperl-set-style "Current") t]
2352           ["Memorized" (cperl-set-style-back) cperl-old-style])
2353          ("Micro-docs"
2354           ["Tips" (describe-variable 'cperl-tips) t]
2355           ["Problems" (describe-variable 'cperl-problems) t]
2356           ["Non-problems" (describe-variable 'cperl-non-problems) t]
2357           ["Speed" (describe-variable 'cperl-speed) t]
2358           ["Praise" (describe-variable 'cperl-praise) t]
2359           ["Faces" (describe-variable 'cperl-tips-faces) t]
2360           ["CPerl mode" (describe-function 'cperl-mode) t]
2361           ["CPerl version" 
2362            (message "The version of master-file for this CPerl is %s" 
2363                     cperl-version) t]))))
2364   (error nil))
2365
2366 (autoload 'c-macro-expand "cmacexp"
2367   "Display the result of expanding all C macros occurring in the region.
2368 The expansion is entirely correct because it uses the C preprocessor."
2369   t)
2370
2371 (defvar cperl-imenu--function-name-regexp-perl
2372   (concat
2373    "^\\("
2374         "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
2375    "\\|"
2376         "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
2377    "\\)"))
2378
2379 (defvar cperl-outline-regexp
2380   (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
2381
2382 (defvar cperl-mode-syntax-table nil
2383   "Syntax table in use in CPerl mode buffers.")
2384
2385 (defvar cperl-string-syntax-table nil
2386   "Syntax table in use in CPerl mode string-like chunks.")
2387
2388 (if cperl-mode-syntax-table
2389     ()
2390   (setq cperl-mode-syntax-table (make-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 ?< "." 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   (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
2403   (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
2404   (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
2405   (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
2406   (if cperl-under-as-char
2407       (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
2408   (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
2409   (modify-syntax-entry ?| "." cperl-mode-syntax-table)
2410   (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
2411   (modify-syntax-entry ?$ "." cperl-string-syntax-table)
2412   (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
2413
2414
2415 \f
2416 ;; provide an alias for working with emacs 19.  the perl-mode that comes
2417 ;; with it is really bad, and this lets us seamlessly replace it.
2418 ;;;###autoload
2419 (fset 'perl-mode 'cperl-mode)
2420 (defvar cperl-faces-init nil)
2421 ;; Fix for msb.el
2422 (defvar cperl-msb-fixed nil)
2423 (defvar font-lock-syntactic-keywords)
2424 (defvar perl-font-lock-keywords)
2425 (defvar perl-font-lock-keywords-1)
2426 (defvar perl-font-lock-keywords-2)
2427 (defvar outline-level)
2428 (if (fboundp 'defvaralias)
2429     (let ((f 'defvaralias)) ; Some functions deduce stuff from the mode name...
2430       (funcall f 'cperl-font-lock-keywords   'perl-font-lock-keywords)
2431       (funcall f 'cperl-font-lock-keywords-1 'perl-font-lock-keywords-1)
2432       (funcall f 'cperl-font-lock-keywords-2 'perl-font-lock-keywords-2)))
2433
2434 (defvar cperl-use-major-mode 'perl-mode)
2435
2436 ;;;###autoload
2437 (defun cperl-mode ()
2438   "Major mode for editing Perl code.
2439 Expression and list commands understand all C brackets.
2440 Tab indents for Perl code.
2441 Paragraphs are separated by blank lines only.
2442 Delete converts tabs to spaces as it moves back.
2443
2444 Various characters in Perl almost always come in pairs: {}, (), [],
2445 sometimes <>.  When the user types the first, she gets the second as
2446 well, with optional special formatting done on {}.  (Disabled by
2447 default.)  You can always quote (with \\[quoted-insert]) the left
2448 \"paren\" to avoid the expansion.  The processing of < is special,
2449 since most the time you mean \"less\".  CPerl mode tries to guess
2450 whether you want to type pair <>, and inserts is if it
2451 appropriate.  You can set `cperl-electric-parens-string' to the string that
2452 contains the parenths from the above list you want to be electrical.
2453 Electricity of parenths is controlled by `cperl-electric-parens'.
2454 You may also set `cperl-electric-parens-mark' to have electric parens
2455 look for active mark and \"embrace\" a region if possible.'
2456
2457 CPerl mode provides expansion of the Perl control constructs:
2458
2459    if, else, elsif, unless, while, until, continue, do,
2460    for, foreach, formy and foreachmy.
2461
2462 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
2463
2464 The user types the keyword immediately followed by a space, which
2465 causes the construct to be expanded, and the point is positioned where
2466 she is most likely to want to be.  eg. when the user types a space
2467 following \"if\" the following appears in the buffer: if () { or if ()
2468 } { } and the cursor is between the parentheses.  The user can then
2469 type some boolean expression within the parens.  Having done that,
2470 typing \\[cperl-linefeed] places you - appropriately indented - on a
2471 new line between the braces (if you typed \\[cperl-linefeed] in a POD
2472 directive line, then appropriate number of new lines is inserted).
2473
2474 If CPerl decides that you want to insert \"English\" style construct like
2475
2476             bite if angry;
2477
2478 it will not do any expansion.  See also help on variable
2479 `cperl-extra-newline-before-brace'.  (Note that one can switch the
2480 help message on expansion by setting `cperl-message-electric-keyword'
2481 to nil.)
2482
2483 \\[cperl-linefeed] is a convenience replacement for typing carriage
2484 return.  It places you in the next line with proper indentation, or if
2485 you type it inside the inline block of control construct, like
2486
2487             foreach (@lines) {print; print}
2488
2489 and you are on a boundary of a statement inside braces, it will
2490 transform the construct into a multiline and will place you into an
2491 appropriately indented blank line.  If you need a usual
2492 `newline-and-indent' behaviour, it is on \\[newline-and-indent],
2493 see documentation on `cperl-electric-linefeed'.
2494
2495 Use \\[cperl-invert-if-unless] to change a construction of the form
2496
2497             if (A) { B }
2498
2499 into
2500
2501             B if A;
2502
2503 \\{cperl-mode-map}
2504
2505 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
2506 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
2507 on electric space between $ and {, `cperl-electric-parens-string' is
2508 the string that contains parentheses that should be electric in CPerl
2509 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
2510 setting `cperl-electric-keywords' enables electric expansion of
2511 control structures in CPerl.  `cperl-electric-linefeed' governs which
2512 one of two linefeed behavior is preferable.  You can enable all these
2513 options simultaneously (recommended mode of use) by setting
2514 `cperl-hairy' to t.  In this case you can switch separate options off
2515 by setting them to `null'.  Note that one may undo the extra
2516 whitespace inserted by semis and braces in `auto-newline'-mode by
2517 consequent \\[cperl-electric-backspace].
2518
2519 If your site has perl5 documentation in info format, you can use commands
2520 \\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
2521 These keys run commands `cperl-info-on-current-command' and
2522 `cperl-info-on-command', which one is which is controlled by variable
2523 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
2524 \(in turn affected by `cperl-hairy').
2525
2526 Even if you have no info-format documentation, short one-liner-style
2527 help is available on \\[cperl-get-help], and one can run perldoc or
2528 man via menu.
2529
2530 It is possible to show this help automatically after some idle time.
2531 This is regulated by variable `cperl-lazy-help-time'.  Default with
2532 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
2533 secs idle time .  It is also possible to switch this on/off from the
2534 menu, or via \\[cperl-toggle-autohelp].  Requires `run-with-idle-timer'.
2535
2536 Use \\[cperl-lineup] to vertically lineup some construction - put the
2537 beginning of the region at the start of construction, and make region
2538 span the needed amount of lines.
2539
2540 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
2541 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
2542 here-docs sections.  With capable Emaxen results of scan are used
2543 for indentation too, otherwise they are used for highlighting only.
2544
2545 Variables controlling indentation style:
2546  `cperl-tab-always-indent'
2547     Non-nil means TAB in CPerl mode should always reindent the current line,
2548     regardless of where in the line point is when the TAB command is used.
2549  `cperl-indent-left-aligned-comments'
2550     Non-nil means that the comment starting in leftmost column should indent.
2551  `cperl-auto-newline'
2552     Non-nil means automatically newline before and after braces,
2553     and after colons and semicolons, inserted in Perl code.  The following
2554     \\[cperl-electric-backspace] will remove the inserted whitespace.
2555     Insertion after colons requires both this variable and
2556     `cperl-auto-newline-after-colon' set.
2557  `cperl-auto-newline-after-colon'
2558     Non-nil means automatically newline even after colons.
2559     Subject to `cperl-auto-newline' setting.
2560  `cperl-indent-level'
2561     Indentation of Perl statements within surrounding block.
2562     The surrounding block's indentation is the indentation
2563     of the line on which the open-brace appears.
2564  `cperl-continued-statement-offset'
2565     Extra indentation given to a substatement, such as the
2566     then-clause of an if, or body of a while, or just a statement continuation.
2567  `cperl-continued-brace-offset'
2568     Extra indentation given to a brace that starts a substatement.
2569     This is in addition to `cperl-continued-statement-offset'.
2570  `cperl-brace-offset'
2571     Extra indentation for line if it starts with an open brace.
2572  `cperl-brace-imaginary-offset'
2573     An open brace following other text is treated as if it the line started
2574     this far to the right of the actual line indentation.
2575  `cperl-label-offset'
2576     Extra indentation for line that is a label.
2577  `cperl-min-label-indent'
2578     Minimal indentation for line that is a label.
2579
2580 Settings for K&R and BSD indentation styles are
2581   `cperl-indent-level'                5    8
2582   `cperl-continued-statement-offset'  5    8
2583   `cperl-brace-offset'               -5   -8
2584   `cperl-label-offset'               -5   -8
2585
2586 CPerl knows several indentation styles, and may bulk set the
2587 corresponding variables.  Use \\[cperl-set-style] to do this.  Use
2588 \\[cperl-set-style-back] to restore the memorized preexisting values
2589 \(both available from menu).
2590
2591 If `cperl-indent-level' is 0, the statement after opening brace in
2592 column 0 is indented on
2593 `cperl-brace-offset'+`cperl-continued-statement-offset'.
2594
2595 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
2596 with no args.
2597
2598 DO NOT FORGET to read micro-docs (available from `Perl' menu)
2599 or as help on variables `cperl-tips', `cperl-problems',
2600 `cperl-non-problems', `cperl-praise', `cperl-speed'."
2601   (interactive)
2602   (kill-all-local-variables)
2603   (use-local-map cperl-mode-map)
2604   (if (cperl-val 'cperl-electric-linefeed)
2605       (progn
2606         (local-set-key "\C-J" 'cperl-linefeed)
2607         (local-set-key "\C-C\C-J" 'newline-and-indent)))
2608   (if (and
2609        (cperl-val 'cperl-clobber-lisp-bindings)
2610        (cperl-val 'cperl-info-on-command-no-prompt))
2611       (progn
2612         ;; don't clobber the backspace binding:
2613         (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
2614         (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
2615                           [(control c) (control h) f])))
2616   (setq major-mode cperl-use-major-mode)
2617   (setq mode-name "CPerl")
2618   (if (not cperl-mode-abbrev-table)
2619       (let ((prev-a-c abbrevs-changed))
2620         (define-abbrev-table 'cperl-mode-abbrev-table '(
2621                 ("if" "if" cperl-electric-keyword 0)
2622                 ("elsif" "elsif" cperl-electric-keyword 0)
2623                 ("while" "while" cperl-electric-keyword 0)
2624                 ("until" "until" cperl-electric-keyword 0)
2625                 ("unless" "unless" cperl-electric-keyword 0)
2626                 ("else" "else" cperl-electric-else 0)
2627                 ("continue" "continue" cperl-electric-else 0)
2628                 ("for" "for" cperl-electric-keyword 0)
2629                 ("foreach" "foreach" cperl-electric-keyword 0)
2630                 ("formy" "formy" cperl-electric-keyword 0)
2631                 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
2632                 ("do" "do" cperl-electric-keyword 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                 ("pod" "pod" cperl-electric-pod 0)
2638                 ("over" "over" cperl-electric-pod 0)
2639                 ("head1" "head1" cperl-electric-pod 0)
2640                 ("head2" "head2" cperl-electric-pod 0)))
2641         (setq abbrevs-changed prev-a-c)))
2642   (setq local-abbrev-table cperl-mode-abbrev-table)
2643   (abbrev-mode (if (cperl-val 'cperl-electric-keywords) 1 0))
2644   (set-syntax-table cperl-mode-syntax-table)
2645   (make-local-variable 'outline-regexp)
2646   ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
2647   (setq outline-regexp cperl-outline-regexp)
2648   (make-local-variable 'outline-level)
2649   (setq outline-level 'cperl-outline-level)
2650   (make-local-variable 'paragraph-start)
2651   (setq paragraph-start (concat "^$\\|" page-delimiter))
2652   (make-local-variable 'paragraph-separate)
2653   (setq paragraph-separate paragraph-start)
2654   (make-local-variable 'paragraph-ignore-fill-prefix)
2655   (setq paragraph-ignore-fill-prefix t)
2656   (make-local-variable 'indent-line-function)
2657   (setq indent-line-function 'cperl-indent-line)
2658   (make-local-variable 'require-final-newline)
2659   (setq require-final-newline t)
2660   (make-local-variable 'comment-start)
2661   (setq comment-start "# ")
2662   (make-local-variable 'comment-end)
2663   (setq comment-end "")
2664   (make-local-variable 'comment-column)
2665   (setq comment-column cperl-comment-column)
2666   (make-local-variable 'comment-start-skip)
2667   (setq comment-start-skip "#+ *")
2668   (make-local-variable 'defun-prompt-regexp)
2669   (setq defun-prompt-regexp "^[ \t]*sub[ \t]+\\([^ \t\n{(;]+\\)\\([ \t]*([^()]*)[ \t]*\\)?[ \t]*")
2670   (make-local-variable 'comment-indent-function)
2671   (setq comment-indent-function 'cperl-comment-indent)
2672   (make-local-variable 'parse-sexp-ignore-comments)
2673   (setq parse-sexp-ignore-comments t)
2674   (make-local-variable 'indent-region-function)
2675   (setq indent-region-function 'cperl-indent-region)
2676   ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
2677   (make-local-variable 'imenu-create-index-function)
2678   (setq imenu-create-index-function
2679         (function cperl-imenu--create-perl-index))
2680   (make-local-variable 'imenu-sort-function)
2681   (setq imenu-sort-function nil)
2682   (make-local-variable 'vc-header-alist)
2683   (set 'vc-header-alist cperl-vc-header-alist) ; Avoid warning
2684   (make-local-variable 'font-lock-defaults)
2685   (setq font-lock-defaults
2686         (cond
2687          ((string< emacs-version "19.30")
2688           '(perl-font-lock-keywords-2))
2689          ((string< emacs-version "19.33") ; Which one to use?
2690           '((perl-font-lock-keywords
2691              perl-font-lock-keywords-1
2692              perl-font-lock-keywords-2)))
2693          (t
2694           '((cperl-load-font-lock-keywords
2695              cperl-load-font-lock-keywords-1
2696              cperl-load-font-lock-keywords-2)))))
2697   (make-local-variable 'cperl-syntax-state)
2698   (if cperl-use-syntax-table-text-property
2699       (progn
2700         (make-local-variable 'parse-sexp-lookup-properties)
2701         ;; Do not introduce variable if not needed, we check it!
2702         (set 'parse-sexp-lookup-properties t)
2703         ;; Fix broken font-lock:
2704         (or (boundp 'font-lock-unfontify-region-function)
2705             (set 'font-lock-unfontify-region-function
2706                  'font-lock-default-unfontify-region))
2707         (make-local-variable 'font-lock-unfontify-region-function)
2708         (set 'font-lock-unfontify-region-function ; not present with old Emacs
2709               'cperl-font-lock-unfontify-region-function)
2710         (make-local-variable 'cperl-syntax-done-to)
2711         ;; Another bug: unless font-lock-syntactic-keywords, font-lock
2712         ;;  ignores syntax-table text-property.  (t) is a hack
2713         ;;  to make font-lock think that font-lock-syntactic-keywords
2714         ;;  are defined
2715         (make-local-variable 'font-lock-syntactic-keywords)
2716         (setq font-lock-syntactic-keywords
2717               (if cperl-syntaxify-by-font-lock
2718                   '(t (cperl-fontify-syntaxically))
2719                 '(t)))))
2720   (make-local-variable 'cperl-old-style)
2721   (if (boundp 'normal-auto-fill-function) ; 19.33 and later
2722       (set (make-local-variable 'normal-auto-fill-function)
2723            'cperl-do-auto-fill)       ; RMS has it as #'cperl-do-auto-fill ???
2724     (or (fboundp 'cperl-old-auto-fill-mode)
2725         (progn
2726           (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
2727           (defun auto-fill-mode (&optional arg)
2728             (interactive "P")
2729             (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
2730             (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
2731                  (setq auto-fill-function 'cperl-do-auto-fill))))))
2732   (if (cperl-enable-font-lock)
2733       (if (cperl-val 'cperl-font-lock)
2734           (progn (or cperl-faces-init (cperl-init-faces))
2735                  (font-lock-mode 1))))
2736   (and (boundp 'msb-menu-cond)
2737        (not cperl-msb-fixed)
2738        (cperl-msb-fix))
2739   (if (featurep 'easymenu)
2740       (easy-menu-add cperl-menu))       ; A NOP in RMS Emacs.
2741   (run-hooks 'cperl-mode-hook)
2742   ;; After hooks since fontification will break this
2743   (if cperl-pod-here-scan
2744       (or cperl-syntaxify-by-font-lock
2745        (progn (or cperl-faces-init (cperl-init-faces-weak))
2746               (cperl-find-pods-heres)))))
2747 \f
2748 ;; Fix for perldb - make default reasonable
2749 (defun cperl-db ()
2750   (interactive)
2751   (require 'gud)
2752   (perldb (read-from-minibuffer "Run perldb (like this): "
2753                                 (if (consp gud-perldb-history)
2754                                     (car gud-perldb-history)
2755                                   (concat "perl " ;;(file-name-nondirectory
2756                                           ;; I have problems
2757                                           ;; in OS/2
2758                                           ;; otherwise
2759                                           (buffer-file-name)))
2760                                 nil nil
2761                                 '(gud-perldb-history . 1))))
2762 \f
2763 (defun cperl-msb-fix ()
2764   ;; Adds perl files to msb menu, supposes that msb is already loaded
2765   (setq cperl-msb-fixed t)
2766   (let* ((l (length msb-menu-cond))
2767          (last (nth (1- l) msb-menu-cond))
2768          (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
2769          (handle (1- (nth 1 last))))
2770     (setcdr precdr (list
2771                     (list
2772                      '(memq major-mode '(cperl-mode perl-mode))
2773                      handle
2774                      "Perl Files (%d)")
2775                     last))))
2776 \f
2777 ;; This is used by indent-for-comment
2778 ;; to decide how much to indent a comment in CPerl code
2779 ;; based on its context.  Do fallback if comment is found wrong.
2780
2781 (defvar cperl-wrong-comment)
2782 (defvar cperl-st-cfence '(14))          ; Comment-fence
2783 (defvar cperl-st-sfence '(15))          ; String-fence
2784 (defvar cperl-st-punct '(1))
2785 (defvar cperl-st-word '(2))
2786 (defvar cperl-st-bra '(4 . ?\>))
2787 (defvar cperl-st-ket '(5 . ?\<))
2788
2789
2790 (defun cperl-comment-indent ()
2791   (let ((p (point)) (c (current-column)) was phony)
2792     (if (looking-at "^#") 0             ; Existing comment at bol stays there.
2793       ;; Wrong comment found
2794       (save-excursion
2795         (setq was (cperl-to-comment-or-eol)
2796               phony (eq (get-text-property (point) 'syntax-table)
2797                         cperl-st-cfence))
2798         (if phony
2799             (progn
2800               (re-search-forward "#\\|$") ; Hmm, what about embedded #?
2801               (if (eq (preceding-char) ?\#)
2802                   (forward-char -1))
2803               (setq was nil)))
2804         (if (= (point) p)
2805             (progn
2806               (skip-chars-backward " \t")
2807               (max (1+ (current-column)) ; Else indent at comment column
2808                    comment-column))
2809           (if was nil
2810             (insert comment-start)
2811             (backward-char (length comment-start)))
2812           (setq cperl-wrong-comment t)
2813           (indent-to comment-column 1)  ; Indent minimum 1
2814           c)))))                        ; except leave at least one space.
2815
2816 ;;;(defun cperl-comment-indent-fallback ()
2817 ;;;  "Is called if the standard comment-search procedure fails.
2818 ;;;Point is at start of real comment."
2819 ;;;  (let ((c (current-column)) target cnt prevc)
2820 ;;;    (if (= c comment-column) nil
2821 ;;;      (setq cnt (skip-chars-backward "[ \t]"))
2822 ;;;      (setq target (max (1+ (setq prevc
2823 ;;;                          (current-column))) ; Else indent at comment column
2824 ;;;                comment-column))
2825 ;;;      (if (= c comment-column) nil
2826 ;;;     (delete-backward-char cnt)
2827 ;;;     (while (< prevc target)
2828 ;;;       (insert "\t")
2829 ;;;       (setq prevc (current-column)))
2830 ;;;     (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
2831 ;;;     (while (< prevc target)
2832 ;;;       (insert " ")
2833 ;;;       (setq prevc (current-column)))))))
2834
2835 (defun cperl-indent-for-comment ()
2836   "Substitute for `indent-for-comment' in CPerl."
2837   (interactive)
2838   (let (cperl-wrong-comment)
2839     (indent-for-comment)
2840     (if cperl-wrong-comment
2841         (progn (cperl-to-comment-or-eol)
2842                (forward-char (length comment-start))))))
2843
2844 (defun cperl-comment-region (b e arg)
2845   "Comment or uncomment each line in the region in CPerl mode.
2846 See `comment-region'."
2847   (interactive "r\np")
2848   (let ((comment-start "#"))
2849     (comment-region b e arg)))
2850
2851 (defun cperl-uncomment-region (b e arg)
2852   "Uncomment or comment each line in the region in CPerl mode.
2853 See `comment-region'."
2854   (interactive "r\np")
2855   (let ((comment-start "#"))
2856     (comment-region b e (- arg))))
2857
2858 (defvar cperl-brace-recursing nil)
2859
2860 (defun cperl-electric-brace (arg &optional only-before)
2861   "Insert character and correct line's indentation.
2862 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2863 place (even in empty line), but not after.  If after \")\" and the inserted
2864 char is \"{\", insert extra newline before only if
2865 `cperl-extra-newline-before-brace'."
2866   (interactive "P")
2867   (let (insertpos
2868         (other-end (if (and cperl-electric-parens-mark
2869                             (cperl-mark-active)
2870                             (< (mark) (point)))
2871                        (mark)
2872                      nil)))
2873     (if (and other-end
2874              (not cperl-brace-recursing)
2875              (cperl-val 'cperl-electric-parens)
2876              (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
2877         ;; Need to insert a matching pair
2878         (progn
2879           (save-excursion
2880             (setq insertpos (point-marker))
2881             (goto-char other-end)
2882             (setq last-command-char ?\{)
2883             (cperl-electric-lbrace arg insertpos))
2884           (forward-char 1))
2885       ;; Check whether we close something "usual" with `}'
2886       (if (and (eq last-command-char ?\})
2887                (not
2888                 (condition-case nil
2889                     (save-excursion
2890                       (up-list (- (prefix-numeric-value arg)))
2891                       ;;(cperl-after-block-p (point-min))
2892                       (or (cperl-after-expr-p nil "{;)")
2893                           ;; after sub, else, continue
2894                           (cperl-after-block-p nil 'pre)))
2895                   (error nil))))
2896           ;; Just insert the guy
2897           (self-insert-command (prefix-numeric-value arg))
2898         (if (and (not arg)              ; No args, end (of empty line or auto)
2899                  (eolp)
2900                  (or (and (null only-before)
2901                           (save-excursion
2902                             (skip-chars-backward " \t")
2903                             (bolp)))
2904                      (and (eq last-command-char ?\{) ; Do not insert newline
2905                           ;; if after ")" and `cperl-extra-newline-before-brace'
2906                           ;; is nil, do not insert extra newline.
2907                           (not cperl-extra-newline-before-brace)
2908                           (save-excursion
2909                             (skip-chars-backward " \t")
2910                             (eq (preceding-char) ?\))))
2911                      (if cperl-auto-newline
2912                          (progn (cperl-indent-line) (newline) t) nil)))
2913             (progn
2914               (self-insert-command (prefix-numeric-value arg))
2915               (cperl-indent-line)
2916               (if cperl-auto-newline
2917                   (setq insertpos (1- (point))))
2918               (if (and cperl-auto-newline (null only-before))
2919                   (progn
2920                     (newline)
2921                     (cperl-indent-line)))
2922               (save-excursion
2923                 (if insertpos (progn (goto-char insertpos)
2924                                      (search-forward (make-string
2925                                                       1 last-command-char))
2926                                      (setq insertpos (1- (point)))))
2927                 (delete-char -1))))
2928         (if insertpos
2929             (save-excursion
2930               (goto-char insertpos)
2931               (self-insert-command (prefix-numeric-value arg)))
2932           (self-insert-command (prefix-numeric-value arg)))))))
2933
2934 (defun cperl-electric-lbrace (arg &optional end)
2935   "Insert character, correct line's indentation, correct quoting by space."
2936   (interactive "P")
2937   (let ((cperl-brace-recursing t)
2938         (cperl-auto-newline cperl-auto-newline)
2939         (other-end (or end
2940                        (if (and cperl-electric-parens-mark
2941                                 (cperl-mark-active)
2942                                 (> (mark) (point)))
2943                            (save-excursion
2944                              (goto-char (mark))
2945                              (point-marker))
2946                          nil)))
2947         pos after)
2948     (and (cperl-val 'cperl-electric-lbrace-space)
2949          (eq (preceding-char) ?$)
2950          (save-excursion
2951            (skip-chars-backward "$")
2952            (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
2953          (insert ?\ ))
2954     ;; Check whether we are in comment
2955     (if (and
2956          (save-excursion
2957            (beginning-of-line)
2958            (not (looking-at "[ \t]*#")))
2959          (cperl-after-expr-p nil "{;)"))
2960         nil
2961       (setq cperl-auto-newline nil))
2962     (cperl-electric-brace arg)
2963     (and (cperl-val 'cperl-electric-parens)
2964          (eq last-command-char ?{)
2965          (memq last-command-char
2966                (append cperl-electric-parens-string nil))
2967          (or (if other-end (goto-char (marker-position other-end)))
2968              t)
2969          (setq last-command-char ?} pos (point))
2970          (progn (cperl-electric-brace arg t)
2971                 (goto-char pos)))))
2972
2973 (defun cperl-electric-paren (arg)
2974   "Insert an opening parenthesis or a matching pair of parentheses.
2975 See `cperl-electric-parens'."
2976   (interactive "P")
2977   (let ((beg (save-excursion (beginning-of-line) (point)))
2978         (other-end (if (and cperl-electric-parens-mark
2979                             (cperl-mark-active)
2980                             (> (mark) (point)))
2981                        (save-excursion
2982                          (goto-char (mark))
2983                          (point-marker))
2984                      nil)))
2985     (if (and (cperl-val 'cperl-electric-parens)
2986              (memq last-command-char
2987                    (append cperl-electric-parens-string nil))
2988              (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
2989              ;;(not (save-excursion (search-backward "#" beg t)))
2990              (if (eq last-command-char ?<)
2991                  (progn
2992                    (and abbrev-mode ; later it is too late, may be after `for'
2993                         (expand-abbrev))
2994                    (cperl-after-expr-p nil "{;(,:="))
2995                1))
2996         (progn
2997           (self-insert-command (prefix-numeric-value arg))
2998           (if other-end (goto-char (marker-position other-end)))
2999           (insert (make-string
3000                    (prefix-numeric-value arg)
3001                    (cdr (assoc last-command-char '((?{ .?})
3002                                                    (?[ . ?])
3003                                                    (?( . ?))
3004                                                    (?< . ?>))))))
3005           (forward-char (- (prefix-numeric-value arg))))
3006       (self-insert-command (prefix-numeric-value arg)))))
3007
3008 (defun cperl-electric-rparen (arg)
3009   "Insert a matching pair of parentheses if marking is active.
3010 If not, or if we are not at the end of marking range, would self-insert.
3011 Affected by `cperl-electric-parens'."
3012   (interactive "P")
3013   (let ((beg (save-excursion (beginning-of-line) (point)))
3014         (other-end (if (and cperl-electric-parens-mark
3015                             (cperl-val 'cperl-electric-parens)
3016                             (memq last-command-char
3017                                   (append cperl-electric-parens-string nil))
3018                             (cperl-mark-active)
3019                             (< (mark) (point)))
3020                        (mark)
3021                      nil))
3022         p)
3023     (if (and other-end
3024              (cperl-val 'cperl-electric-parens)
3025              (memq last-command-char '( ?\) ?\] ?\} ?\> ))
3026              (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
3027              ;;(not (save-excursion (search-backward "#" beg t)))
3028              )
3029         (progn
3030           (self-insert-command (prefix-numeric-value arg))
3031           (setq p (point))
3032           (if other-end (goto-char other-end))
3033           (insert (make-string
3034                    (prefix-numeric-value arg)
3035                    (cdr (assoc last-command-char '((?\} . ?\{)
3036                                                    (?\] . ?\[)
3037                                                    (?\) . ?\()
3038                                                    (?\> . ?\<))))))
3039           (goto-char (1+ p)))
3040       (self-insert-command (prefix-numeric-value arg)))))
3041
3042 (defun cperl-electric-keyword ()
3043   "Insert a construction appropriate after a keyword.
3044 Help message may be switched off by setting `cperl-message-electric-keyword'
3045 to nil."
3046   (let ((beg (save-excursion (beginning-of-line) (point)))
3047         (dollar (and (eq last-command-char ?$)
3048                      (eq this-command 'self-insert-command)))
3049         (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3050                      (memq this-command '(self-insert-command newline))))
3051         my do)
3052     (and (save-excursion
3053            (condition-case nil
3054                (progn
3055                  (backward-sexp 1)
3056                  (setq do (looking-at "do\\>")))
3057              (error nil))
3058            (cperl-after-expr-p nil "{;:"))
3059          (save-excursion
3060            (not
3061             (re-search-backward
3062              "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
3063              beg t)))
3064          (save-excursion (or (not (re-search-backward "^=" nil t))
3065                              (or
3066                               (looking-at "=cut")
3067                               (and cperl-use-syntax-table-text-property
3068                                    (not (eq (get-text-property (point)
3069                                                                'syntax-type)
3070                                             'pod))))))
3071          (save-excursion (forward-sexp -1) 
3072                          (not (memq (following-char) (append "$@%&*" nil))))
3073          (progn
3074            (and (eq (preceding-char) ?y)
3075                 (progn                  ; "foreachmy"
3076                   (forward-char -2)
3077                   (insert " ")
3078                   (forward-char 2)
3079                   (setq my t dollar t
3080                         delete
3081                         (memq this-command '(self-insert-command newline)))))
3082            (and dollar (insert " $"))
3083            (cperl-indent-line)
3084            ;;(insert " () {\n}")
3085            (cond
3086             (cperl-extra-newline-before-brace
3087              (insert (if do "\n" " ()\n"))
3088              (insert "{")
3089              (cperl-indent-line)
3090              (insert "\n")
3091              (cperl-indent-line)
3092              (insert "\n}")
3093              (and do (insert " while ();")))
3094             (t
3095              (insert (if do " {\n} while ();" " () {\n}"))))
3096            (or (looking-at "[ \t]\\|$") (insert " "))
3097            (cperl-indent-line)
3098            (if dollar (progn (search-backward "$")
3099                              (if my
3100                                  (forward-char 1)
3101                                (delete-char 1)))
3102              (search-backward ")")
3103              (if (eq last-command-char ?\()
3104                  (progn                 ; Avoid "if (())"
3105                    (delete-backward-char 1)
3106                    (delete-backward-char -1))))
3107            (if delete
3108                (cperl-putback-char cperl-del-back-ch))
3109            (if cperl-message-electric-keyword
3110                (message "Precede char by C-q to avoid expansion"))))))
3111
3112 (defun cperl-ensure-newlines (n &optional pos)
3113   "Make sure there are N newlines after the point."
3114   (or pos (setq pos (point)))
3115   (if (looking-at "\n")
3116       (forward-char 1)
3117     (insert "\n"))
3118   (if (> n 1)
3119       (cperl-ensure-newlines (1- n) pos)
3120     (goto-char pos)))
3121
3122 (defun cperl-electric-pod ()
3123   "Insert a POD chunk appropriate after a =POD directive."
3124   (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3125                      (memq this-command '(self-insert-command newline))))
3126         head1 notlast name p really-delete over)
3127     (and (save-excursion
3128            (forward-word -1)
3129            (and
3130             (eq (preceding-char) ?=)
3131             (progn
3132               (setq head1 (looking-at "head1\\>[ \t]*$"))
3133               (setq over (and (looking-at "over\\>[ \t]*$")
3134                               (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
3135               (forward-char -1)
3136               (bolp))
3137             (or
3138              (get-text-property (point) 'in-pod)
3139              (cperl-after-expr-p nil "{;:")
3140              (and (re-search-backward
3141                    ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
3142                    "\\(\\`\n?\\|^\n\\)=\\sw+"
3143                    (point-min) t)
3144                   (not (or
3145                         (looking-at "=cut")
3146                         (and cperl-use-syntax-table-text-property
3147                              (not (eq (get-text-property (point) 'syntax-type)
3148                                       'pod)))))))))
3149          (progn
3150            (save-excursion
3151              (setq notlast (re-search-forward "^\n=" nil t)))
3152            (or notlast
3153                (progn
3154                  (insert "\n\n=cut")
3155                  (cperl-ensure-newlines 2)
3156                  (forward-word -2)
3157                  (if (and head1
3158                           (not
3159                            (save-excursion
3160                              (forward-char -1)
3161                              (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
3162                                                  nil t)))) ; Only one
3163                      (progn
3164                        (forward-word 1)
3165                        (setq name (file-name-sans-extension
3166                                    (file-name-nondirectory (buffer-file-name)))
3167                              p (point))
3168                        (insert " NAME\n\n" name
3169                                " - \n\n=head1 SYNOPSIS\n\n\n\n"
3170                                "=head1 DESCRIPTION")
3171                        (cperl-ensure-newlines 4)
3172                        (goto-char p)
3173                        (forward-word 2)
3174                        (end-of-line)
3175                        (setq really-delete t))
3176                    (forward-word 1))))
3177            (if over
3178                (progn
3179                  (setq p (point))
3180                  (insert "\n\n=item \n\n\n\n"
3181                          "=back")
3182                  (cperl-ensure-newlines 2)
3183                  (goto-char p)
3184                  (forward-word 1)
3185                  (end-of-line)
3186                  (setq really-delete t)))
3187            (if (and delete really-delete)
3188                (cperl-putback-char cperl-del-back-ch))))))
3189
3190 (defun cperl-electric-else ()
3191   "Insert a construction appropriate after a keyword.
3192 Help message may be switched off by setting `cperl-message-electric-keyword'
3193 to nil."
3194   (let ((beg (save-excursion (beginning-of-line) (point))))
3195     (and (save-excursion
3196            (backward-sexp 1)
3197            (cperl-after-expr-p nil "{;:"))
3198          (save-excursion
3199            (not
3200             (re-search-backward
3201              "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
3202              beg t)))
3203          (save-excursion (or (not (re-search-backward "^=" nil t))
3204                              (looking-at "=cut")
3205                              (and cperl-use-syntax-table-text-property
3206                                   (not (eq (get-text-property (point)
3207                                                               'syntax-type)
3208                                            'pod)))))
3209          (progn
3210            (cperl-indent-line)
3211            ;;(insert " {\n\n}")
3212            (cond
3213             (cperl-extra-newline-before-brace
3214              (insert "\n")
3215              (insert "{")
3216              (cperl-indent-line)
3217              (insert "\n\n}"))
3218             (t
3219              (insert " {\n\n}")))
3220            (or (looking-at "[ \t]\\|$") (insert " "))
3221            (cperl-indent-line)
3222            (forward-line -1)
3223            (cperl-indent-line)
3224            (cperl-putback-char cperl-del-back-ch)
3225            (setq this-command 'cperl-electric-else)
3226            (if cperl-message-electric-keyword
3227                (message "Precede char by C-q to avoid expansion"))))))
3228
3229 (defun cperl-linefeed ()
3230   "Go to end of line, open a new line and indent appropriately.
3231 If in POD, insert appropriate lines."
3232   (interactive)
3233   (let ((beg (save-excursion (beginning-of-line) (point)))
3234         (end (save-excursion (end-of-line) (point)))
3235         (pos (point)) start over cut res)
3236     (if (and                            ; Check if we need to split:
3237                                         ; i.e., on a boundary and inside "{...}"
3238          (save-excursion (cperl-to-comment-or-eol)
3239                          (>= (point) pos)) ; Not in a comment
3240          (or (save-excursion
3241                (skip-chars-backward " \t" beg)
3242                (forward-char -1)
3243                (looking-at "[;{]"))     ; After { or ; + spaces
3244              (looking-at "[ \t]*}")     ; Before }
3245              (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
3246          (save-excursion
3247            (and
3248             (eq (car (parse-partial-sexp pos end -1)) -1)
3249                                         ; Leave the level of parens
3250             (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
3251                                         ; Are at end
3252             (cperl-after-block-p (point-min))
3253             (progn
3254               (backward-sexp 1)
3255               (setq start (point-marker))
3256               (<= start pos)))))        ; Redundant?  Are after the
3257                                         ; start of parens group.
3258         (progn
3259           (skip-chars-backward " \t")
3260           (or (memq (preceding-char) (append ";{" nil))
3261               (insert ";"))
3262           (insert "\n")
3263           (forward-line -1)
3264           (cperl-indent-line)
3265           (goto-char start)
3266           (or (looking-at "{[ \t]*$")   ; If there is a statement
3267                                         ; before, move it to separate line
3268               (progn
3269                 (forward-char 1)
3270                 (insert "\n")
3271                 (cperl-indent-line)))
3272           (forward-line 1)              ; We are on the target line
3273           (cperl-indent-line)
3274           (beginning-of-line)
3275           (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
3276                                         ; after, move it to separate line
3277               (progn
3278                 (end-of-line)
3279                 (search-backward "}" beg)
3280                 (skip-chars-backward " \t")
3281                 (or (memq (preceding-char) (append ";{" nil))
3282                     (insert ";"))
3283                 (insert "\n")
3284                 (cperl-indent-line)
3285                 (forward-line -1)))
3286           (forward-line -1)             ; We are on the line before target
3287           (end-of-line)
3288           (newline-and-indent))
3289       (end-of-line)                     ; else - no splitting
3290       (cond
3291        ((and (looking-at "\n[ \t]*{$")
3292              (save-excursion
3293                (skip-chars-backward " \t")
3294                (eq (preceding-char) ?\)))) ; Probably if () {} group
3295                                         ; with an extra newline.
3296         (forward-line 2)
3297         (cperl-indent-line))
3298        ((save-excursion                 ; In POD header
3299           (forward-paragraph -1)
3300           ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
3301           ;; We are after \n now, so look for the rest
3302           (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
3303               (progn
3304                 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
3305                 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
3306                 t)))
3307         (if (and over
3308                  (progn
3309                    (forward-paragraph -1)
3310                    (forward-word 1)
3311                    (setq pos (point))
3312                    (setq cut (buffer-substring (point)
3313                                                (save-excursion
3314                                                  (end-of-line)
3315                                                  (point))))
3316                    (delete-char (- (save-excursion (end-of-line) (point))
3317                                    (point)))
3318                    (setq res (expand-abbrev))
3319                    (save-excursion
3320                      (goto-char pos)
3321                      (insert cut))
3322                    res))
3323             nil
3324           (cperl-ensure-newlines (if cut 2 4))
3325           (forward-line 2)))
3326        ((get-text-property (point) 'in-pod) ; In POD section
3327         (cperl-ensure-newlines 4)
3328         (forward-line 2))
3329        ((looking-at "\n[ \t]*$")        ; Next line is empty - use it.
3330         (forward-line 1)
3331         (cperl-indent-line))
3332        (t
3333         (newline-and-indent))))))
3334
3335 (defun cperl-electric-semi (arg)
3336   "Insert character and correct line's indentation."
3337   (interactive "P")
3338   (if cperl-auto-newline
3339       (cperl-electric-terminator arg)
3340     (self-insert-command (prefix-numeric-value arg))
3341     (if cperl-autoindent-on-semi
3342         (cperl-indent-line))))
3343
3344 (defun cperl-electric-terminator (arg)
3345   "Insert character and correct line's indentation."
3346   (interactive "P")
3347   (let ((end (point))
3348         (auto (and cperl-auto-newline
3349                    (or (not (eq last-command-char ?:))
3350                        cperl-auto-newline-after-colon)))
3351         insertpos)
3352     (if (and ;;(not arg)
3353              (eolp)
3354              (not (save-excursion
3355                     (beginning-of-line)
3356                     (skip-chars-forward " \t")
3357                     (or
3358                      ;; Ignore in comment lines
3359                      (= (following-char) ?#)
3360                      ;; Colon is special only after a label
3361                      ;; So quickly rule out most other uses of colon
3362                      ;; and do no indentation for them.
3363                      (and (eq last-command-char ?:)
3364                           (save-excursion
3365                             (forward-word 1)
3366                             (skip-chars-forward " \t")
3367                             (and (< (point) end)
3368                                  (progn (goto-char (- end 1))
3369                                         (not (looking-at ":"))))))
3370                      (progn
3371                        (beginning-of-defun)
3372                        (let ((pps (parse-partial-sexp (point) end)))
3373                          (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
3374         (progn
3375           (self-insert-command (prefix-numeric-value arg))
3376           ;;(forward-char -1)
3377           (if auto (setq insertpos (point-marker)))
3378           ;;(forward-char 1)
3379           (cperl-indent-line)
3380           (if auto
3381               (progn
3382                 (newline)
3383                 (cperl-indent-line)))
3384           (save-excursion
3385             (if insertpos (goto-char (1- (marker-position insertpos)))
3386               (forward-char -1))
3387             (delete-char 1))))
3388     (if insertpos
3389         (save-excursion
3390           (goto-char insertpos)
3391           (self-insert-command (prefix-numeric-value arg)))
3392       (self-insert-command (prefix-numeric-value arg)))))
3393
3394 (defun cperl-electric-backspace (arg)
3395   "Backspace, or remove the whitespace around the point inserted by an electric
3396 key.  Will untabivy if `cperl-electric-backspace-untabify' is non-nil."
3397   (interactive "p")
3398   (if (and cperl-auto-newline
3399            (memq last-command '(cperl-electric-semi
3400                                 cperl-electric-terminator
3401                                 cperl-electric-lbrace))
3402            (memq (preceding-char) '(?\  ?\t ?\n)))
3403       (let (p)
3404         (if (eq last-command 'cperl-electric-lbrace)
3405             (skip-chars-forward " \t\n"))
3406         (setq p (point))
3407         (skip-chars-backward " \t\n")
3408         (delete-region (point) p))
3409     (and (eq last-command 'cperl-electric-else)
3410          ;; We are removing the whitespace *inside* cperl-electric-else
3411          (setq this-command 'cperl-electric-else-really))
3412     (if (and cperl-auto-newline
3413              (eq last-command 'cperl-electric-else-really)
3414              (memq (preceding-char) '(?\  ?\t ?\n)))
3415         (let (p)
3416           (skip-chars-forward " \t\n")
3417           (setq p (point))
3418           (skip-chars-backward " \t\n")
3419           (delete-region (point) p))
3420       (if cperl-electric-backspace-untabify
3421           (backward-delete-char-untabify arg)
3422         (delete-backward-char arg)))))
3423
3424 (defun cperl-inside-parens-p ()
3425   (condition-case ()
3426       (save-excursion
3427         (save-restriction
3428           (narrow-to-region (point)
3429                             (progn (beginning-of-defun) (point)))
3430           (goto-char (point-max))
3431           (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
3432     (error nil)))
3433 \f
3434 (defun cperl-indent-command (&optional whole-exp)
3435   "Indent current line as Perl code, or in some cases insert a tab character.
3436 If `cperl-tab-always-indent' is non-nil (the default), always indent current
3437 line.  Otherwise, indent the current line only if point is at the left margin
3438 or in the line's indentation; otherwise insert a tab.
3439
3440 A numeric argument, regardless of its value,
3441 means indent rigidly all the lines of the expression starting after point
3442 so that this line becomes properly indented.
3443 The relative indentation among the lines of the expression are preserved."
3444   (interactive "P")
3445   (cperl-update-syntaxification (point) (point))
3446   (if whole-exp
3447       ;; If arg, always indent this line as Perl
3448       ;; and shift remaining lines of expression the same amount.
3449       (let ((shift-amt (cperl-indent-line))
3450             beg end)
3451         (save-excursion
3452           (if cperl-tab-always-indent
3453               (beginning-of-line))
3454           (setq beg (point))
3455           (forward-sexp 1)
3456           (setq end (point))
3457           (goto-char beg)
3458           (forward-line 1)
3459           (setq beg (point)))
3460         (if (and shift-amt (> end beg))
3461             (indent-code-rigidly beg end shift-amt "#")))
3462     (if (and (not cperl-tab-always-indent)
3463              (save-excursion
3464                (skip-chars-backward " \t")
3465                (not (bolp))))
3466         (insert-tab)
3467       (cperl-indent-line))))
3468
3469 (defun cperl-indent-line (&optional parse-data)
3470   "Indent current line as Perl code.
3471 Return the amount the indentation changed by."
3472   (let ((case-fold-search nil)
3473         (pos (- (point-max) (point)))
3474         indent i beg shift-amt)
3475     (setq indent (cperl-calculate-indent parse-data)
3476           i indent)
3477     (beginning-of-line)
3478     (setq beg (point))
3479     (cond ((or (eq indent nil) (eq indent t))
3480            (setq indent (current-indentation) i nil))
3481           ;;((eq indent t)    ; Never?
3482           ;; (setq indent (cperl-calculate-indent-within-comment)))
3483           ;;((looking-at "[ \t]*#")
3484           ;; (setq indent 0))
3485           (t
3486            (skip-chars-forward " \t")
3487            (if (listp indent) (setq indent (car indent)))
3488            (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
3489                   (and (> indent 0)
3490                        (setq indent (max cperl-min-label-indent
3491                                          (+ indent cperl-label-offset)))))
3492                  ((= (following-char) ?})
3493                   (setq indent (- indent cperl-indent-level)))
3494                  ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
3495                   (setq indent (+ indent cperl-close-paren-offset)))
3496                  ((= (following-char) ?{)
3497                   (setq indent (+ indent cperl-brace-offset))))))
3498     (skip-chars-forward " \t")
3499     (setq shift-amt (and i (- indent (current-column))))
3500     (if (or (not shift-amt)
3501             (zerop shift-amt))
3502         (if (> (- (point-max) pos) (point))
3503             (goto-char (- (point-max) pos)))
3504       (delete-region beg (point))
3505       (indent-to indent)
3506       ;; If initial point was within line's indentation,
3507       ;; position after the indentation.  Else stay at same point in text.
3508       (if (> (- (point-max) pos) (point))
3509           (goto-char (- (point-max) pos))))
3510     shift-amt))
3511
3512 (defun cperl-after-label ()
3513   ;; Returns true if the point is after label.  Does not do save-excursion.
3514   (and (eq (preceding-char) ?:)
3515        (memq (char-syntax (char-after (- (point) 2)))
3516              '(?w ?_))
3517        (progn
3518          (backward-sexp)
3519          (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
3520
3521 (defun cperl-get-state (&optional parse-start start-state)
3522   ;; returns list (START STATE DEPTH PRESTART),
3523   ;; START is a good place to start parsing, or equal to
3524   ;; PARSE-START if preset,
3525   ;; STATE is what is returned by `parse-partial-sexp'.
3526   ;; DEPTH is true is we are immediately after end of block
3527   ;; which contains START.
3528   ;; PRESTART is the position basing on which START was found.
3529   (save-excursion
3530     (let ((start-point (point)) depth state start prestart)
3531       (if (and parse-start
3532                (<= parse-start start-point))
3533           (goto-char parse-start)
3534         (beginning-of-defun)
3535         (setq start-state nil))
3536       (setq prestart (point))
3537       (if start-state nil
3538         ;; Try to go out, if sub is not on the outermost level
3539         (while (< (point) start-point)
3540           (setq start (point) parse-start start depth nil
3541                 state (parse-partial-sexp start start-point -1))
3542           (if (> (car state) -1) nil
3543             ;; The current line could start like }}}, so the indentation
3544             ;; corresponds to a different level than what we reached
3545             (setq depth t)
3546             (beginning-of-line 2)))     ; Go to the next line.
3547         (if start (goto-char start)))   ; Not at the start of file
3548       (setq start (point))
3549       (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
3550       (list start state depth prestart))))
3551
3552 (defun cperl-block-p ()            ; Do not C-M-q !  One string contains ";" !
3553   ;; Positions is before ?\{.  Checks whether it starts a block.
3554   ;; No save-excursion!
3555   (cperl-backward-to-noncomment (point-min))
3556   (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label!  \C-@ at bobp
3557                                         ; Label may be mixed up with `$blah :'
3558       (save-excursion (cperl-after-label))
3559       (and (memq (char-syntax (preceding-char)) '(?w ?_))
3560            (progn
3561              (backward-sexp)
3562              ;; Need take into account `bless', `return', `tr',...
3563              (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
3564                       (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
3565                  (progn
3566                    (skip-chars-backward " \t\n\f")
3567                    (and (memq (char-syntax (preceding-char)) '(?w ?_))
3568                         (progn
3569                           (backward-sexp)
3570                           (looking-at
3571                            "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
3572
3573 (defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
3574
3575 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3576   "Return appropriate indentation for current line as Perl code.
3577 In usual case returns an integer: the column to indent to.
3578 Returns nil if line starts inside a string, t if in a comment.
3579
3580 Will not correct the indentation for labels, but will correct it for braces
3581 and closing parentheses and brackets."
3582   (cperl-update-syntaxification (point) (point))
3583   (save-excursion
3584     (if (or
3585          (and (memq (get-text-property (point) 'syntax-type)
3586                     '(pod here-doc here-doc-delim format))
3587               (not (get-text-property (point) 'indentable)))
3588          ;; before start of POD - whitespace found since do not have 'pod!
3589          (and (looking-at "[ \t]*\n=")
3590               (error "Spaces before POD section!"))
3591          (and (not cperl-indent-left-aligned-comments)
3592               (looking-at "^#")))
3593         nil
3594       (beginning-of-line)
3595       (let ((indent-point (point))
3596             (char-after (save-excursion
3597                           (skip-chars-forward " \t")
3598                           (following-char)))
3599             (in-pod (get-text-property (point) 'in-pod))
3600             (pre-indent-point (point))
3601             p prop look-prop is-block delim)
3602         (cond
3603          (in-pod
3604           ;; In the verbatim part, probably code example.  What to do???
3605           )
3606          (t
3607           (save-excursion
3608             ;; Not in POD
3609             (cperl-backward-to-noncomment nil)
3610             (setq p (max (point-min) (1- (point)))
3611                   prop (get-text-property p 'syntax-type)
3612                   look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
3613                                 'syntax-type))
3614             (if (memq prop '(pod here-doc format here-doc-delim))
3615                 (progn
3616                   (goto-char (or (previous-single-property-change p look-prop)
3617                                  (point-min)))
3618                   (beginning-of-line)
3619                   (setq pre-indent-point (point)))))))
3620         (goto-char pre-indent-point)
3621         (let* ((case-fold-search nil)
3622                (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
3623                (start (or (nth 2 parse-data)
3624                           (nth 0 s-s)))
3625                (state (nth 1 s-s))
3626                (containing-sexp (car (cdr state)))
3627                old-indent)
3628           (if (and
3629                ;;containing-sexp                ;; We are buggy at toplevel :-(
3630                parse-data)
3631               (progn
3632                 (setcar parse-data pre-indent-point)
3633                 (setcar (cdr parse-data) state)
3634                 (or (nth 2 parse-data)
3635                     (setcar (cddr parse-data) start))
3636                 ;; Before this point: end of statement
3637                 (setq old-indent (nth 3 parse-data))))
3638           (cond ((get-text-property (point) 'indentable)
3639                  ;; indent to just after the surrounding open,
3640                  ;; skip blanks if we do not close the expression.
3641                  (goto-char (1+ (previous-single-property-change (point) 'indentable)))
3642                  (or (memq char-after (append ")]}" nil))
3643                      (looking-at "[ \t]*\\(#\\|$\\)")
3644                      (skip-chars-forward " \t"))
3645                  (current-column))
3646                 ((or (nth 3 state) (nth 4 state))
3647                  ;; return nil or t if should not change this line
3648                  (nth 4 state))
3649                 ;; XXXX Do we need to special-case this?
3650                 ((null containing-sexp)
3651                  ;; Line is at top level.  May be data or function definition,
3652                  ;; or may be function argument declaration.
3653                  ;; Indent like the previous top level line
3654                  ;; unless that ends in a closeparen without semicolon,
3655                  ;; in which case this line is the first argument decl.
3656                  (skip-chars-forward " \t")
3657                  (+ (save-excursion
3658                       (goto-char start)
3659                       (- (current-indentation)
3660                          (if (nth 2 s-s) cperl-indent-level 0)))
3661                     (if (= char-after ?{) cperl-continued-brace-offset 0)
3662                     (progn
3663                       (cperl-backward-to-noncomment (or old-indent (point-min)))
3664                       ;; Look at previous line that's at column 0
3665                       ;; to determine whether we are in top-level decls
3666                       ;; or function's arg decls.  Set basic-indent accordingly.
3667                       ;; Now add a little if this is a continuation line.
3668                       (if (or (bobp)
3669                               (eq (point) old-indent) ; old-indent was at comment
3670                               (eq (preceding-char) ?\;)
3671                               ;;  Had ?\) too
3672                               (and (eq (preceding-char) ?\})
3673                                    (cperl-after-block-and-statement-beg
3674                                     (point-min))) ; Was start - too close
3675                               (memq char-after (append ")]}" nil))
3676                               (and (eq (preceding-char) ?\:) ; label
3677                                    (progn
3678                                      (forward-sexp -1)
3679                                      (skip-chars-backward " \t")
3680                                      (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
3681                               (get-text-property (point) 'first-format-line))
3682                           (progn
3683                             (if (and parse-data
3684                                      (not (eq char-after ?\C-j)))
3685                                 (setcdr (cddr parse-data)
3686                                         (list pre-indent-point)))
3687                             0)
3688                         cperl-continued-statement-offset))))
3689                 ((not
3690                   (or (setq is-block
3691                             (and (setq delim (= (char-after containing-sexp) ?{))
3692                                  (save-excursion ; Is it a hash?
3693                                    (goto-char containing-sexp)
3694                                    (cperl-block-p))))
3695                       cperl-indent-parens-as-block))
3696                  ;; group is an expression, not a block:
3697                  ;; indent to just after the surrounding open parens,
3698                  ;; skip blanks if we do not close the expression.
3699                  (goto-char (1+ containing-sexp))
3700                  (or (memq char-after
3701                            (append (if delim "}" ")]}") nil))
3702                      (looking-at "[ \t]*\\(#\\|$\\)")
3703                      (skip-chars-forward " \t"))
3704                  (+ (current-column)
3705                     (if (and delim
3706                              (eq char-after ?\}))
3707                         ;; Correct indentation of trailing ?\}
3708                         (+ cperl-indent-level cperl-close-paren-offset)
3709                       0)))
3710 ;;;           ((and (/= (char-after containing-sexp) ?{)
3711 ;;;                 (not cperl-indent-parens-as-block))
3712 ;;;            ;; line is expression, not statement:
3713 ;;;            ;; indent to just after the surrounding open,
3714 ;;;            ;; skip blanks if we do not close the expression.
3715 ;;;            (goto-char (1+ containing-sexp))
3716 ;;;            (or (memq char-after (append ")]}" nil))
3717 ;;;                (looking-at "[ \t]*\\(#\\|$\\)")
3718 ;;;                (skip-chars-forward " \t"))
3719 ;;;            (current-column))
3720 ;;;           ((progn
3721 ;;;              ;; Containing-expr starts with \{.  Check whether it is a hash.
3722 ;;;              (goto-char containing-sexp)
3723 ;;;              (and (not (cperl-block-p))
3724 ;;;                   (not cperl-indent-parens-as-block)))
3725 ;;;            (goto-char (1+ containing-sexp))
3726 ;;;            (or (eq char-after ?\})
3727 ;;;                (looking-at "[ \t]*\\(#\\|$\\)")
3728 ;;;                (skip-chars-forward " \t"))
3729 ;;;            (+ (current-column)      ; Correct indentation of trailing ?\}
3730 ;;;               (if (eq char-after ?\}) (+ cperl-indent-level
3731 ;;;                                          cperl-close-paren-offset)
3732 ;;;                 0)))
3733                 (t
3734                  ;; Statement level.  Is it a continuation or a new statement?
3735                  ;; Find previous non-comment character.
3736                  (goto-char pre-indent-point)
3737                  (cperl-backward-to-noncomment containing-sexp)
3738                  ;; Back up over label lines, since they don't
3739                  ;; affect whether our line is a continuation.
3740                  ;; (Had \, too)
3741                  (while ;;(or (eq (preceding-char) ?\,)
3742                      (and (eq (preceding-char) ?:)
3743                           (or ;;(eq (char-after (- (point) 2)) ?\') ; ????
3744                            (memq (char-syntax (char-after (- (point) 2)))
3745                                  '(?w ?_))))
3746                    ;;)
3747                    (if (eq (preceding-char) ?\,)
3748                        ;; Will go to beginning of line, essentially.
3749                        ;; Will ignore embedded sexpr XXXX.
3750                        (cperl-backward-to-start-of-continued-exp containing-sexp))
3751                    (beginning-of-line)
3752                    (cperl-backward-to-noncomment containing-sexp))
3753                  ;; Now we get the answer.
3754                  (if (not (or (eq (1- (point)) containing-sexp)
3755                               (memq (preceding-char)
3756                                     (append (if is-block " ;{" " ,;{") '(nil)))
3757                               (and (eq (preceding-char) ?\})
3758                                    (cperl-after-block-and-statement-beg
3759                                     containing-sexp))
3760                               (get-text-property (point) 'first-format-line)))
3761                      ;; This line is continuation of preceding line's statement;
3762                      ;; indent  `cperl-continued-statement-offset'  more than the
3763                      ;; previous line of the statement.
3764                      ;;
3765                      ;; There might be a label on this line, just
3766                      ;; consider it bad style and ignore it.
3767                      (progn
3768                        (cperl-backward-to-start-of-continued-exp containing-sexp)
3769                        (+ (if (memq char-after (append "}])" nil))
3770                               0         ; Closing parenth
3771                             cperl-continued-statement-offset)
3772                           (if (or is-block
3773                                   (not delim)
3774                                   (not (eq char-after ?\})))
3775                               0
3776                             ;; Now it is a hash reference
3777                             (+ cperl-indent-level cperl-close-paren-offset))
3778                           (if (looking-at "\\w+[ \t]*:")
3779                               (if (> (current-indentation) cperl-min-label-indent)
3780                                   (- (current-indentation) cperl-label-offset)
3781                                 ;; Do not move `parse-data', this should
3782                                 ;; be quick anyway (this comment comes
3783                                 ;; from different location):
3784                                 (cperl-calculate-indent))
3785                             (current-column))
3786                           (if (eq char-after ?\{)
3787                               cperl-continued-brace-offset 0)))
3788                    ;; This line starts a new statement.
3789                    ;; Position following last unclosed open.
3790                    (goto-char containing-sexp)
3791                    ;; Is line first statement after an open-brace?
3792                    (or
3793                     ;; If no, find that first statement and indent like
3794                     ;; it.  If the first statement begins with label, do
3795                     ;; not believe when the indentation of the label is too
3796                     ;; small.
3797                     (save-excursion
3798                       (forward-char 1)
3799                       (setq old-indent (current-indentation))
3800                       (let ((colon-line-end 0))
3801                         (while
3802                             (progn (skip-chars-forward " \t\n")
3803                                    (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]\\|=[a-zA-Z]"))
3804                           ;; Skip over comments and labels following openbrace.
3805                           (cond ((= (following-char) ?\#)
3806                                  (forward-line 1))
3807                                 ((= (following-char) ?\=)
3808                                  (goto-char
3809                                   (or (next-single-property-change (point) 'in-pod)
3810                                       (point-max)))) ; do not loop if no syntaxification
3811                                 ;; label:
3812                                 (t
3813                                  (save-excursion (end-of-line)
3814                                                  (setq colon-line-end (point)))
3815                                  (search-forward ":"))))
3816                         ;; The first following code counts
3817                         ;; if it is before the line we want to indent.
3818                         (and (< (point) indent-point)
3819                              (if (> colon-line-end (point)) ; After label
3820                                  (if (> (current-indentation)
3821                                         cperl-min-label-indent)
3822                                      (- (current-indentation) cperl-label-offset)
3823                                    ;; Do not believe: `max' is involved
3824                                    (+ old-indent cperl-indent-level))
3825                                (current-column)))))
3826                     ;; If no previous statement,
3827                     ;; indent it relative to line brace is on.
3828                     ;; For open brace in column zero, don't let statement
3829                     ;; start there too.  If cperl-indent-level is zero,
3830                     ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3831                     ;; For open-braces not the first thing in a line,
3832                     ;; add in cperl-brace-imaginary-offset.
3833
3834                     ;; If first thing on a line:  ?????
3835                     (+ (if (and (bolp) (zerop cperl-indent-level))
3836                            (+ cperl-brace-offset cperl-continued-statement-offset)
3837                          cperl-indent-level)
3838                        (if (or is-block
3839                                (not delim)
3840                                (not (eq char-after ?\})))
3841                            0
3842                          ;; Now it is a hash reference
3843                          (+ cperl-indent-level cperl-close-paren-offset))
3844                        ;; Move back over whitespace before the openbrace.
3845                        ;; If openbrace is not first nonwhite thing on the line,
3846                        ;; add the cperl-brace-imaginary-offset.
3847                        (progn (skip-chars-backward " \t")
3848                               (if (bolp) 0 cperl-brace-imaginary-offset))
3849                        ;; If the openbrace is preceded by a parenthesized exp,
3850                        ;; move to the beginning of that;
3851                        ;; possibly a different line
3852                        (progn
3853                          (if (eq (preceding-char) ?\))
3854                              (forward-sexp -1))
3855                          ;; In the case it starts a subroutine, indent with
3856                          ;; respect to `sub', not with respect to the
3857                          ;; first thing on the line, say in the case of
3858                          ;; anonymous sub in a hash.
3859                          ;;
3860                          (skip-chars-backward " \t")
3861                          (if (and (eq (preceding-char) ?b)
3862                                   (progn
3863                                     (forward-sexp -1)
3864                                     (looking-at "sub\\>"))
3865                                   (setq old-indent
3866                                         (nth 1
3867                                              (parse-partial-sexp
3868                                               (save-excursion (beginning-of-line) (point))
3869                                               (point)))))
3870                              (progn (goto-char (1+ old-indent))
3871                                     (skip-chars-forward " \t")
3872                                     (current-column))
3873                            ;; Get initial indentation of the line we are on.
3874                            ;; If line starts with label, calculate label indentation
3875                            (if (save-excursion
3876                                  (beginning-of-line)
3877                                  (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
3878                                (if (> (current-indentation) cperl-min-label-indent)
3879                                    (- (current-indentation) cperl-label-offset)
3880                                  ;; Do not move `parse-data', this should
3881                                  ;; be quick anyway:
3882                                  (cperl-calculate-indent))
3883                              (current-indentation))))))))))))))
3884
3885 (defvar cperl-indent-alist
3886   '((string nil)
3887     (comment nil)
3888     (toplevel 0)
3889     (toplevel-after-parenth 2)
3890     (toplevel-continued 2)
3891     (expression 1))
3892   "Alist of indentation rules for CPerl mode.
3893 The values mean:
3894   nil: do not indent;
3895   number: add this amount of indentation.
3896
3897 Not finished, not used.")
3898
3899 (defun cperl-where-am-i (&optional parse-start start-state)
3900   ;; Unfinished
3901   "Return a list of lists ((TYPE POS)...) of good points before the point.
3902 POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
3903
3904 Not finished, not used."
3905   (save-excursion
3906     (let* ((start-point (point))
3907            (s-s (cperl-get-state))
3908            (start (nth 0 s-s))
3909            (state (nth 1 s-s))
3910            (prestart (nth 3 s-s))
3911            (containing-sexp (car (cdr state)))
3912            (case-fold-search nil)
3913            (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
3914       (cond ((nth 3 state)              ; In string
3915              (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
3916             ((nth 4 state)              ; In comment
3917              (setq res (cons '(comment) res)))
3918             ((null containing-sexp)
3919              ;; Line is at top level.
3920              ;; Indent like the previous top level line
3921              ;; unless that ends in a closeparen without semicolon,
3922              ;; in which case this line is the first argument decl.
3923              (cperl-backward-to-noncomment (or parse-start (point-min)))
3924              ;;(skip-chars-backward " \t\f\n")
3925              (cond
3926               ((or (bobp)
3927                    (memq (preceding-char) (append ";}" nil)))
3928                (setq res (cons (list 'toplevel start) res)))
3929               ((eq (preceding-char) ?\) )
3930                (setq res (cons (list 'toplevel-after-parenth start) res)))
3931               (t
3932                (setq res (cons (list 'toplevel-continued start) res)))))
3933             ((/= (char-after containing-sexp) ?{)
3934              ;; line is expression, not statement:
3935              ;; indent to just after the surrounding open.
3936              ;; skip blanks if we do not close the expression.
3937              (setq res (cons (list 'expression-blanks
3938                                    (progn
3939                                      (goto-char (1+ containing-sexp))
3940                                      (or (looking-at "[ \t]*\\(#\\|$\\)")
3941                                          (skip-chars-forward " \t"))
3942                                      (point)))
3943                              (cons (list 'expression containing-sexp) res))))
3944             ((progn
3945                ;; Containing-expr starts with \{.  Check whether it is a hash.
3946                (goto-char containing-sexp)
3947                (not (cperl-block-p)))
3948              (setq res (cons (list 'expression-blanks
3949                                    (progn
3950                                      (goto-char (1+ containing-sexp))
3951                                      (or (looking-at "[ \t]*\\(#\\|$\\)")
3952                                          (skip-chars-forward " \t"))
3953                                      (point)))
3954                              (cons (list 'expression containing-sexp) res))))
3955             (t
3956              ;; Statement level.
3957              (setq res (cons (list 'in-block containing-sexp) res))
3958              ;; Is it a continuation or a new statement?
3959              ;; Find previous non-comment character.
3960              (cperl-backward-to-noncomment containing-sexp)
3961              ;; Back up over label lines, since they don't
3962              ;; affect whether our line is a continuation.
3963              ;; Back up comma-delimited lines too ?????
3964              (while (or (eq (preceding-char) ?\,)
3965                         (save-excursion (cperl-after-label)))
3966                (if (eq (preceding-char) ?\,)
3967                    ;; Will go to beginning of line, essentially
3968                    ;; Will ignore embedded sexpr XXXX.
3969                    (cperl-backward-to-start-of-continued-exp containing-sexp))
3970                (beginning-of-line)
3971                (cperl-backward-to-noncomment containing-sexp))
3972              ;; Now we get the answer.
3973              (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
3974                  ;; This line is continuation of preceding line's statement.
3975                  (list (list 'statement-continued containing-sexp))
3976                ;; This line starts a new statement.
3977                ;; Position following last unclosed open.
3978                (goto-char containing-sexp)
3979                ;; Is line first statement after an open-brace?
3980                (or
3981                 ;; If no, find that first statement and indent like
3982                 ;; it.  If the first statement begins with label, do
3983                 ;; not believe when the indentation of the label is too
3984                 ;; small.
3985                 (save-excursion
3986                   (forward-char 1)
3987                   (let ((colon-line-end 0))
3988                     (while (progn (skip-chars-forward " \t\n" start-point)
3989                                   (and (< (point) start-point)
3990                                        (looking-at
3991                                         "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
3992                       ;; Skip over comments and labels following openbrace.
3993                       (cond ((= (following-char) ?\#)
3994                              ;;(forward-line 1)
3995                              (end-of-line))
3996                             ;; label:
3997                             (t
3998                              (save-excursion (end-of-line)
3999                                              (setq colon-line-end (point)))
4000                              (search-forward ":"))))
4001                     ;; Now at the point, after label, or at start
4002                     ;; of first statement in the block.
4003                     (and (< (point) start-point)
4004                          (if (> colon-line-end (point))
4005                              ;; Before statement after label
4006                              (if (> (current-indentation)
4007                                     cperl-min-label-indent)
4008                                  (list (list 'label-in-block (point)))
4009                                ;; Do not believe: `max' is involved
4010                                (list
4011                                 (list 'label-in-block-min-indent (point))))
4012                            ;; Before statement
4013                            (list 'statement-in-block (point))))))
4014                 ;; If no previous statement,
4015                 ;; indent it relative to line brace is on.
4016                 ;; For open brace in column zero, don't let statement
4017                 ;; start there too.  If cperl-indent-level is zero,
4018                 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
4019                 ;; For open-braces not the first thing in a line,
4020                 ;; add in cperl-brace-imaginary-offset.
4021
4022                 ;; If first thing on a line:  ?????
4023                 (+ (if (and (bolp) (zerop cperl-indent-level))
4024                        (+ cperl-brace-offset cperl-continued-statement-offset)
4025                      cperl-indent-level)
4026                    ;; Move back over whitespace before the openbrace.
4027                    ;; If openbrace is not first nonwhite thing on the line,
4028                    ;; add the cperl-brace-imaginary-offset.
4029                    (progn (skip-chars-backward " \t")
4030                           (if (bolp) 0 cperl-brace-imaginary-offset))
4031                    ;; If the openbrace is preceded by a parenthesized exp,
4032                    ;; move to the beginning of that;
4033                    ;; possibly a different line
4034                    (progn
4035                      (if (eq (preceding-char) ?\))
4036                          (forward-sexp -1))
4037                      ;; Get initial indentation of the line we are on.
4038                      ;; If line starts with label, calculate label indentation
4039                      (if (save-excursion
4040                            (beginning-of-line)
4041                            (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
4042                          (if (> (current-indentation) cperl-min-label-indent)
4043                              (- (current-indentation) cperl-label-offset)
4044                            (cperl-calculate-indent))
4045                        (current-indentation))))))))
4046       res)))
4047
4048 (defun cperl-calculate-indent-within-comment ()
4049   "Return the indentation amount for line, assuming that
4050 the current line is to be regarded as part of a block comment."
4051   (let (end star-start)
4052     (save-excursion
4053       (beginning-of-line)
4054       (skip-chars-forward " \t")
4055       (setq end (point))
4056       (and (= (following-char) ?#)
4057            (forward-line -1)
4058            (cperl-to-comment-or-eol)