This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add gcc predefined macros to $Config{cppsymbols} on GNU/kFreeBSD.
[perl5.git] / emacs / cperl-mode.el
CommitLineData
6c72d195
IZ
1;;; cperl-mode.el --- Perl code editing commands for Emacs
2
8f95267c
RGS
3;; Copyright (C) 1985, 86, 87, 91, 92, 93, 94, 95, 96, 97, 98, 99,
4;; 2000, 2003, 2005, 2006
6c72d195
IZ
5;; Free Software Foundation, Inc.
6
7;; Author: Ilya Zakharevich and Bob Olson
8f95267c 8;; Maintainer: Ilya Zakharevich <ilyaz@cpan.org>
6c72d195
IZ
9;; Keywords: languages, Perl
10
11;; This file is part of GNU Emacs.
12
13;;; This code started from the following message of long time ago
14;;; (IZ), but Bob does not maintain this mode any more:
4633a7c4
LW
15
16;;; From: olson@mcs.anl.gov (Bob Olson)
17;;; Newsgroups: comp.lang.perl
18;;; Subject: cperl-mode: Another perl mode for Gnuemacs
19;;; Date: 14 Aug 91 15:20:01 GMT
20
6c72d195 21;; Copyright (C) Ilya Zakharevich and Bob Olson
4633a7c4 22
6c72d195 23;; This file may be distributed
499d5216 24;; either under the same terms as GNU Emacs, or under the same terms
55497cff 25;; as Perl. You should have received a copy of Perl Artistic license
499d5216 26;; along with the Perl distribution.
4633a7c4
LW
27
28;; GNU Emacs is free software; you can redistribute it and/or modify
29;; it under the terms of the GNU General Public License as published by
30;; the Free Software Foundation; either version 2, or (at your option)
31;; any later version.
32
33;; GNU Emacs is distributed in the hope that it will be useful,
34;; but WITHOUT ANY WARRANTY; without even the implied warranty of
35;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
36;; GNU General Public License for more details.
37
38;; You should have received a copy of the GNU General Public License
55497cff 39;; along with GNU Emacs; see the file COPYING. If not, write to the
8f95267c
RGS
40;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
41;; Boston, MA 02111-1307, USA.
55497cff 42
8f95267c 43;;; Corrections made by Ilya Zakharevich ilyaz@cpan.org
4633a7c4
LW
44;;; XEmacs changes by Peter Arius arius@informatik.uni-erlangen.de
45
6c72d195 46;;; Commentary:
4633a7c4 47
8f95267c 48;; $Id: cperl-mode.el,v 5.23 2007/02/15 11:34:23 vera Exp vera $
6c72d195 49
7bcea553
IZ
50;;; If your Emacs does not default to `cperl-mode' on Perl files:
51;;; To use this mode put the following into
6c72d195 52;;; your .emacs file:
4633a7c4
LW
53
54;; (autoload 'perl-mode "cperl-mode" "alternate mode for editing Perl programs" t)
55
8cfd7987
JH
56;; You can either fine-tune the bells and whistles of this mode or
57;; bulk enable them by putting
4633a7c4
LW
58
59;; (setq cperl-hairy t)
60
8cfd7987
JH
61;; in your .emacs file. (Emacs rulers do not consider it politically
62;; correct to make whistles enabled by default.)
4633a7c4 63
8cfd7987
JH
64;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
65;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
66;; `cperl-non-problems', `cperl-praise', `cperl-speed'. <<<<<<
5f05dabc 67
8cfd7987
JH
68;; Additional useful commands to put into your .emacs file (before
69;; RMS Emacs 20.3):
4633a7c4
LW
70
71;; (setq auto-mode-alist
05bbd9c3 72;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
4633a7c4
LW
73;; (setq interpreter-mode-alist (append interpreter-mode-alist
74;; '(("miniperl" . perl-mode))))
75
8cfd7987
JH
76;; The mode information (on C-h m) provides some customization help.
77;; If you use font-lock feature of this mode, it is advisable to use
78;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
4633a7c4 79
8cfd7987
JH
80;; Faces used now: three faces for first-class and second-class keywords
81;; and control flow words, one for each: comments, string, labels,
82;; functions definitions and packages, arrays, hashes, and variable
83;; definitions. If you do not see all these faces, your font-lock does
84;; not define them, so you need to define them manually.
85;; Maybe you have an obsolete font-lock from 19.28 or earlier. Upgrade.
4633a7c4 86
8cfd7987
JH
87;; If you have a grayscale monitor, and do not have the variable
88;; font-lock-display-type bound to 'grayscale, insert
4633a7c4 89
8cfd7987 90;; (setq font-lock-display-type 'grayscale)
4633a7c4 91
8cfd7987 92;; into your .emacs file (this is relevant before RMS Emacs 20).
4633a7c4 93
8cfd7987
JH
94;; This mode supports font-lock, imenu and mode-compile. In the
95;; hairy version font-lock is on, but you should activate imenu
96;; yourself (note that mode-compile is not standard yet). Well, you
97;; can use imenu from keyboard anyway (M-x imenu), but it is better
98;; to bind it like that:
4633a7c4
LW
99
100;; (define-key global-map [M-S-down-mouse-3] 'imenu)
101
8cfd7987
JH
102;;; Font lock bugs as of v4.32:
103
104;; The following kinds of Perl code erroneously start strings:
105;; \$` \$' \$"
106;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
107;; likewise with m, tr, y, q, qX instead of s
108
4633a7c4
LW
109;;; In fact the version of font-lock that this version supports can be
110;;; much newer than the version you actually have. This means that a
111;;; lot of faces can be set up, but are not visible on your screen
112;;; since the coloring rules for this faces are not defined.
113
4633a7c4
LW
114;;; Updates: ========================================
115
8cfd7987 116;;; Made less hairy by default: parentheses not electric,
4633a7c4
LW
117;;; linefeed not magic. Bug with abbrev-mode corrected.
118
119;;;; After 1.4:
120;;; Better indentation:
8cfd7987 121;;; subs inside braces should work now,
4633a7c4
LW
122;;; Toplevel braces obey customization.
123;;; indent-for-comment knows about bad cases, cperl-indent-for-comment
124;;; moves cursor to a correct place.
8cfd7987 125;;; cperl-indent-exp written from the scratch! Slow... (quadratic!) :-(
4633a7c4
LW
126;;; (50 secs on DB::DB (sub of 430 lines), 486/66)
127;;; Minor documentation fixes.
128;;; Imenu understands packages as prefixes (including nested).
129;;; Hairy options can be switched off one-by-one by setting to null.
130;;; Names of functions and variables changed to conform to `cperl-' style.
131
132;;;; After 1.5:
133;;; Some bugs with indentation of labels (and embedded subs) corrected.
134;;; `cperl-indent-region' done (slow :-()).
135;;; `cperl-fill-paragraph' done.
136;;; Better package support for `imenu'.
137;;; Progress indicator for indentation (with `imenu' loaded).
8cfd7987 138;;; `Cperl-set' was busted, now setting the individual hairy option
4633a7c4
LW
139;;; should be better.
140
141;;;; After 1.6:
142;;; `cperl-set-style' done.
143;;; `cperl-check-syntax' done.
144;;; Menu done.
145;;; New config variables `cperl-close-paren-offset' and `cperl-comment-column'.
146;;; Bugs with `cperl-auto-newline' corrected.
8cfd7987 147;;; `cperl-electric-lbrace' can work with `cperl-auto-newline' in situation
4633a7c4
LW
148;;; like $hash{.
149
150;;;; 1.7 XEmacs (arius@informatik.uni-erlangen.de):
151;;; - use `next-command-event', if `next-command-events' does not exist
152;;; - use `find-face' as def. of `is-face'
153;;; - corrected def. of `x-color-defined-p'
154;;; - added const defs for font-lock-comment-face,
155;;; font-lock-keyword-face and font-lock-function-name-face
156;;; - added def. of font-lock-variable-name-face
157;;; - added (require 'easymenu) inside an `eval-when-compile'
158;;; - replaced 4-argument `substitute-key-definition' with ordinary
159;;; `define-key's
160;;; - replaced `mark-active' in menu definition by `cperl-use-region-p'.
161;;; Todo (at least):
162;;; - use emacs-vers.el (http://www.cs.utah.edu/~eeide/emacs/emacs-vers.el.gz)
163;;; for portable code?
8cfd7987 164;;; - should `cperl-mode' do a
4633a7c4
LW
165;;; (if (featurep 'easymenu) (easy-menu-add cperl-menu))
166;;; or should this be left to the user's `cperl-mode-hook'?
167
168;;; Some bugs introduced by the above fix corrected (IZ ;-).
169;;; Some bugs under XEmacs introduced by the correction corrected.
170
8cfd7987 171;;; Some more can remain since there are two many different variants.
4633a7c4
LW
172;;; Please feedback!
173
8cfd7987 174;;; We do not support fontification of arrays and hashes under
4633a7c4
LW
175;;; obsolete font-lock any more. Upgrade.
176
177;;;; after 1.8 Minor bug with parentheses.
178;;;; after 1.9 Improvements from Joe Marzot.
179;;;; after 1.10
180;;; Does not need easymenu to compile under XEmacs.
181;;; `vc-insert-headers' should work better.
182;;; Should work with 19.29 and 19.12.
183;;; Small improvements to fontification.
184;;; Expansion of keywords does not depend on C-? being backspace.
185
186;;; after 1.10+
187;;; 19.29 and 19.12 supported.
188;;; `cperl-font-lock-enhanced' deprecated. Use font-lock-extra.el.
189;;; Support for font-lock-extra.el.
190
191;;;; After 1.11:
192;;; Tools submenu.
193;;; Support for perl5-info.
194;;; `imenu-go-find-at-position' in Tools requires imenu-go.el (see hints above)
195;;; Imenu entries do not work with stock imenu.el. Patch sent to maintainers.
196;;; Fontifies `require a if b;', __DATA__.
197;;; Arglist for auto-fill-mode was incorrect.
198
199;;;; After 1.12:
8cfd7987 200;;; `cperl-lineup-step' and `cperl-lineup' added: lineup constructions
4633a7c4
LW
201;;; vertically.
202;;; `cperl-do-auto-fill' updated for 19.29 style.
203;;; `cperl-info-on-command' now has a default.
204;;; Workaround for broken C-h on XEmacs.
205;;; VC strings escaped.
206;;; C-h f now may prompt for function name instead of going on,
207;;; controlled by `cperl-info-on-command-no-prompt'.
208
209;;;; After 1.13:
210;;; Msb buffer list includes perl files
211;;; Indent-for-comment uses indent-to
212;;; Can write tag files using etags.
213
214;;;; After 1.14:
215;;; Recognizes (tries to ;-) {...} which are not blocks during indentation.
216;;; `cperl-close-paren-offset' affects ?\] too (and ?\} if not block)
c07a80fd 217;;; Bug with auto-filling comments started with "##" corrected.
218
219;;;; Very slow now: on DB::DB 0.91, 486/66:
220
221;;;Function Name Call Count Elapsed Time Average Time
222;;;======================================== ========== ============ ============
223;;;cperl-block-p 469 3.7799999999 0.0080597014
224;;;cperl-get-state 505 163.39000000 0.3235445544
225;;;cperl-comment-indent 12 0.0299999999 0.0024999999
226;;;cperl-backward-to-noncomment 939 4.4599999999 0.0047497337
227;;;cperl-calculate-indent 505 172.22000000 0.3410297029
228;;;cperl-indent-line 505 172.88000000 0.3423366336
229;;;cperl-use-region-p 40 0.0299999999 0.0007499999
230;;;cperl-indent-exp 1 177.97000000 177.97000000
231;;;cperl-to-comment-or-eol 1453 3.9800000000 0.0027391603
232;;;cperl-backward-to-start-of-continued-exp 9 0.0300000000 0.0033333333
233;;;cperl-indent-region 1 177.94000000 177.94000000
234
235;;;; After 1.15:
236;;; Takes into account white space after opening parentheses during indent.
237;;; May highlight pods and here-documents: see `cperl-pod-here-scan',
238;;; `cperl-pod-here-fontify', `cperl-pod-face'. Does not use this info
239;;; for indentation so far.
8cfd7987 240;;; Fontification updated to 19.30 style.
c07a80fd 241;;; The change 19.29->30 did not add all the required functionality,
242;;; but broke "font-lock-extra.el". Get "choose-color.el" from
8f95267c 243;;; http://ilyaz.org/software/emacs
c07a80fd 244
245;;;; After 1.16:
246;;; else # comment
247;;; recognized as a start of a block.
248;;; Two different font-lock-levels provided.
249;;; `cperl-pod-head-face' introduced. Used for highlighting.
8cfd7987 250;;; `imenu' marks pods, +Packages moved to the head.
c07a80fd 251
252;;;; After 1.17:
253;;; Scan for pods highlights here-docs too.
254;;; Note that the tag of here-doc may be rehighlighted later by lazy-lock.
255;;; Only one here-doc-tag per line is supported, and one in comment
256;;; or a string may break fontification.
257;;; POD headers were supposed to fill one line only.
258
259;;;; After 1.18:
8cfd7987 260;;; `font-lock-keywords' were set in 19.30 style _always_. Current scheme
c07a80fd 261;;; may break under XEmacs.
262;;; `cperl-calculate-indent' dis suppose that `parse-start' was defined.
263;;; `fontified' tag is added to fontified text as well as `lazy-lock' (for
264;;; compatibility with older lazy-lock.el) (older one overfontifies
265;;; something nevertheless :-().
266;;; Will not indent something inside pod and here-documents.
267;;; Fontifies the package name after import/no/bootstrap.
268;;; Added new entry to menu with meta-info about the mode.
4633a7c4 269
29043b61 270;;;; After 1.19:
271;;; Prefontification works much better with 19.29. Should be checked
272;;; with 19.30 as well.
273;;; Some misprints in docs corrected.
274;;; Now $a{-text} and -text => "blah" are fontified as strings too.
275;;; Now the pod search is much stricter, so it can help you to find
276;;; pod sections which are broken because of whitespace before =blah
277;;; - just observe the fontification.
278
9ea28adb 279;;;; After 1.20
280;;; Anonymous subs are indented with respect to the level of
281;;; indentation of `sub' now.
282;;; {} is recognized as hash after `bless' and `return'.
283;;; Anonymous subs are split by `cperl-linefeed' as well.
284;;; Electric parens embrace a region if present.
285;;; To make `cperl-auto-newline' useful,
286;;; `cperl-auto-newline-after-colon' is introduced.
287;;; `cperl-electric-parens' is now t or nul. The old meaning is moved to
288;;; `cperl-electric-parens-string'.
289;;; `cperl-toggle-auto-newline' introduced, put on C-c C-a.
290;;; `cperl-toggle-abbrev' introduced, put on C-c C-k.
291;;; `cperl-toggle-electric' introduced, put on C-c C-e.
292;;; Beginning-of-defun-regexp was not anchored.
293
294;;;; After 1.21
295;;; Auto-newline grants `cperl-extra-newline-before-brace' if "{" is typed
296;;; after ")".
297;;; {} is recognized as expression after `tr' and friends.
298
299;;;; After 1.22
300;;; Entry Hierarchy added to imenu. Very primitive so far.
301;;; One needs newer `imenu-go'.el. A patch to `imenu' is needed as well.
302;;; Writes its own TAGS files.
303;;; Class viewer based on TAGS files. Does not trace @ISA so far.
304;;; 19.31: Problems with scan for PODs corrected.
305;;; First POD header correctly fontified.
306;;; I needed (setq imenu-use-keymap-menu t) to get good imenu in 19.31.
307;;; Apparently it makes a lot of hierarchy code obsolete...
308
309;;;; After 1.23
310;;; Tags filler now scans *.xs as well.
311;;; The info from *.xs scan is used by the hierarchy viewer.
312;;; Hierarchy viewer documented.
313;;; Bug in 19.31 imenu documented.
314
499d5216
IZ
315;;;; After 1.24
316;;; New location for info-files mentioned,
317;;; Electric-; should work better.
318;;; Minor bugs with POD marking.
319
55497cff 320;;;; After 1.25 (probably not...)
8cfd7987 321;;; `cperl-info-page' introduced.
499d5216
IZ
322;;; To make `uncomment-region' working, `comment-region' would
323;;; not insert extra space.
8cfd7987 324;;; Here documents delimiters better recognized
499d5216
IZ
325;;; (empty one, and non-alphanums in quotes handled). May be wrong with 1<<14?
326;;; `cperl-db' added, used in menu.
327;;; imenu scan removes text-properties, for better debugging
328;;; - but the bug is in 19.31 imenu.
329;;; formats highlighted by font-lock and prescan, embedded comments
330;;; are not treated.
331;;; POD/friends scan merged in one pass.
332;;; Syntax class is not used for analyzing the code, only char-syntax
55497cff 333;;; may be checked against _ or'ed with w.
499d5216
IZ
334;;; Syntax class of `:' changed to be _.
335;;; `cperl-find-bad-style' added.
336
55497cff 337;;;; After 1.25
338;;; When search for here-documents, we ignore commented << in simplest cases.
339;;; `cperl-get-help' added, available on C-h v and from menu.
340;;; Auto-help added. Default with `cperl-hairy', switchable on/off
341;;; with startup variable `cperl-lazy-help-time' and from
342;;; menu. Requires `run-with-idle-timer'.
343;;; Highlighting of @abc{@efg} was wrong - interchanged two regexps.
344
345;;;; After 1.27
346;;; Indentation: At toplevel after a label - fixed.
347;;; 1.27 was put to archives in binary mode ===> DOSish :-(
348
349;;;; After 1.28
350;;; Thanks to Martin Buchholz <mrb@Eng.Sun.COM>: misprints in
351;;; comments and docstrings corrected, XEmacs support cleaned up.
352;;; The closing parenths would enclose the region into matching
353;;; parens under the same conditions as the opening ones.
354;;; Minor updates to `cperl-short-docs'.
355;;; Will not consider <<= as start of here-doc.
356
5f05dabc 357;;;; After 1.29
358;;; Added an extra advice to look into Micro-docs. ;-).
359;;; Enclosing of region when you press a closing parenth is regulated by
360;;; `cperl-electric-parens-string'.
361;;; Minor updates to `cperl-short-docs'.
362;;; `initialize-new-tags-table' called only if present (Does this help
363;;; with generation of tags under XEmacs?).
364;;; When creating/updating tag files, new info is written at the old place,
365;;; or at the end (is this a wanted behaviour? I need this in perl build directory).
366
367;;;; After 1.30
368;;; All the keywords from keywords.pl included (maybe with dummy explanation).
369;;; No auto-help inside strings, comment, here-docs, formats, and pods.
ebcd4dbc
IZ
370;;; Shrinkwrapping of info, regulated by `cperl-max-help-size',
371;;; `cperl-shrink-wrap-info-frame'.
5f05dabc 372;;; Info on variables as well.
373;;; Recognision of HERE-DOCS improved yet more.
374;;; Autonewline works on `}' without warnings.
375;;; Autohelp works again on $_[0].
376
377;;;; After 1.31
378;;; perl-descr.el found its author - hi, Johan!
ebcd4dbc
IZ
379;;; Some support for correct indent after here-docs and friends (may
380;;; be superseeded by eminent change to Emacs internals).
381;;; Should work with older Emaxen as well ( `-style stuff removed).
382
383;;;; After 1.32
384
385;;; Started to add support for `syntax-table' property (should work
386;;; with patched Emaxen), controlled by
387;;; `cperl-use-syntax-table-text-property'. Currently recognized:
388;;; All quote-like operators: m, s, y, tr, qq, qw, qx, q,
8cfd7987 389;;; // in most frequent context:
ebcd4dbc
IZ
390;;; after block or
391;;; ~ { ( = | & + - * ! , ;
8cfd7987 392;;; or
ebcd4dbc 393;;; while if unless until and or not xor split grep map
8cfd7987 394;;; Here-documents, formats, PODs,
ebcd4dbc
IZ
395;;; ${...}
396;;; 'abc$'
397;;; sub a ($); sub a ($) {}
398;;; (provide 'cperl-mode) was missing!
399;;; `cperl-after-expr-p' is now much smarter after `}'.
400;;; `cperl-praise' added to mini-docs.
401;;; Utilities try to support subs-with-prototypes.
402
403;;;; After 1.32.1
404;;; `cperl-after-expr-p' is now much smarter after "() {}" and "word {}":
405;;; if word is "else, map, grep".
406;;; Updated for new values of syntax-table constants.
407;;; Uses `help-char' (at last!) (disabled, does not work?!)
408;;; A couple of regexps where missing _ in character classes.
409;;; -s could be considered as start of regexp, 1../blah/ was not,
410;;; as was not /blah/ at start of file.
411
412;;;; After 1.32.2
413;;; "\C-hv" was wrongly "\C-hf"
414;;; C-hv was not working on `[index()]' because of [] in skip-chars-*.
415;;; `__PACKAGE__' supported.
416;;; Thanks for Greg Badros: `cperl-lazy-unstall' is more complete,
417;;; `cperl-get-help' is made compatible with `query-replace'.
418
419;;;; As of Apr 15, development version of 19.34 supports
420;;;; `syntax-table' text properties. Try setting
421;;;; `cperl-use-syntax-table-text-property'.
422
423;;;; After 1.32.3
05bbd9c3 424;;; We scan for s{}[] as well (in simplest situations).
ebcd4dbc
IZ
425;;; We scan for $blah'foo as well.
426;;; The default is to use `syntax-table' text property if Emacs is good enough.
427;;; `cperl-lineup' is put on C-M-| (=C-M-S-\\).
428;;; Start of `cperl-beautify-regexp'.
429
430;;;; After 1.32.4
431;;; `cperl-tags-hier-init' did not work in text-mode.
432;;; `cperl-noscan-files-regexp' had a misprint.
433;;; Generation of Class Hierarchy was broken due to a bug in `x-popup-menu'
434;;; in 19.34.
5f05dabc 435
05bbd9c3
IZ
436;;;; After 1.33:
437;;; my,local highlight vars after {} too.
438;;; TAGS could not be created before imenu was loaded.
439;;; `cperl-indent-left-aligned-comments' created.
440;;; Logic of `cperl-indent-exp' changed a little bit, should be more
441;;; robust w.r.t. multiline strings.
442;;; Recognition of blah'foo takes into account strings.
443;;; Added '.al' to the list of Perl extensions.
444;;; Class hierarchy is "mostly" sorted (need to rethink algorthm
445;;; of pruning one-root-branch subtrees to get yet better sorting.)
446;;; Regeneration of TAGS was busted.
447;;; Can use `syntax-table' property when generating TAGS
448;;; (governed by `cperl-use-syntax-table-text-property-for-tags').
449
450;;;; After 1.35:
451;;; Can process several =pod/=cut sections one after another.
452;;; Knows of `extproc' when under `emx', indents with `__END__' and `__DATA__'.
453;;; `cperl-under-as-char' implemented (XEmacs people like broken behaviour).
454;;; Beautifier for regexps fixed.
455;;; `cperl-beautify-level', `cperl-contract-level' coded
456;;;
457;;;; Emacs's 20.2 problems:
458;;; `imenu.el' has bugs, `imenu-add-to-menubar' does not work.
459;;; Couple of others problems with 20.2 were reported, my ability to check/fix
460;;; them is very reduced now.
461
462;;;; After 1.36:
463;;; 'C-M-|' in XEmacs fixed
464
465;;;; After 1.37:
466;;; &&s was not recognized as start of regular expression;
467;;; Will "preprocess" the contents of //e part of s///e too;
468;;; What to do with s# blah # foo #e ?
469;;; Should handle s;blah;foo;; better.
470;;; Now the only known problems with regular expression recognition:
471;;;;;;; s<foo>/bar/ - different delimiters (end ignored)
472;;;;;;; s/foo/\\bar/ - backslash at start of subst (made into one chunk)
473;;;;;;; s/foo// - empty subst (made into one chunk + '/')
474;;;;;;; s/foo/(bar)/ - start-group at start of subst (internal group will not match backwards)
475
476;;;; After 1.38:
477;;; We highlight closing / of s/blah/foo/e;
478;;; This handles s# blah # foo #e too;
479;;; s//blah/, s///, s/blah// works again, and s#blah## too, the algorithm
480;;; is much simpler now;
8cfd7987 481;;; Next round of changes: s\\\ works, s<blah>/foo/,
05bbd9c3
IZ
482;;; comments between the first and the second part allowed
483;;; Another problem discovered:
484;;;;;;; s[foo] <blah>e - e part delimited by different <> (will not match)
485;;; `cperl-find-pods-heres' somehow maybe called when string-face is undefined
486;;; - put a stupid workaround for 20.1
487
3ee700d1
IZ
488;;;; After 1.39:
489;;; Could indent here-docs for comments;
490;;; These problems fixed:
491;;;;;;; s/foo/\\bar/ - backslash at start of subst (made into two chunk)
492;;;;;;; s[foo] <blah>e - "e" part delimited by "different" <> (will match)
493;;; Matching brackets honor prefices, may expand abbreviations;
494;;; When expanding abbrevs, will remove last char only after
495;;; self-inserted whitespace;
496;;; More convenient "Refress hard constructs" in menu;
497;;; `cperl-add-tags-recurse', `cperl-add-tags-recurse-noxs'
498;;; added (for -batch mode);
499;;; Better handling of errors when scanning for Perl constructs;
8cfd7987 500;;;;;;; Possible "problem" with class hierarchy in Perl distribution
3ee700d1
IZ
501;;;;;;; directory: ./ext duplicates ./lib;
502;;; Write relative paths for generated TAGS;
503
504;;;; After 1.40:
505;;; s /// may be separated by "\n\f" too;
506;;; `s #blah' recognized as a comment;
507;;; Would highlight s/abc//s wrong;
508;;; Debugging code in `cperl-electric-keywords' was leaking a message;
509
6c72d195 510;;;; After 1.41:
4584684c 511;;; RMS changes for 20.3 merged
6c72d195
IZ
512
513;;;; 2.0.1.0: RMS mode (has 3 misprints)
514
515;;;; After 2.0:
4584684c 516;;; RMS whitespace changes for 20.3 merged
6c72d195
IZ
517
518;;;; After 2.1:
519;;; History updated
520
521;;;; After 2.2:
522;;; Merge `c-style-alist' since `c-mode' is no more. (Somebody who
523;;; uses the styles should check that they work OK!)
524;;; All the variable warnings go away, some undef functions too.
525
526;;;; After 2.3:
527;;; Added `cperl-perldoc' (thanks to Anthony Foiani <afoiani@uswest.com>)
528;;; Added `cperl-pod-to-manpage' (thanks to Nick Roberts <Nick.Roberts@src.bae.co.uk>)
529;;; All the function warnings go away.
530
531;;;; After 2.4:
532;;; `Perl doc', `Regexp' submenus created (latter to allow short displays).
533;;; `cperl-clobber-lisp-bindings' added.
534;;; $a->y() is not y///.
535;;; `cperl-after-block-p' was missing a `save-excursion' => wrong results.
8cfd7987 536;;; `cperl-val' was defined too late.
6c72d195
IZ
537;;; `cperl-init-faces' was failing.
538;;; Init faces when loading `ps-print'.
539
540;;;; After 2.4:
541;;; `cperl-toggle-autohelp' implemented.
542;;; `while SPACE LESS' was buggy.
543;;; `-text' in `[-text => 1]' was not highlighted.
544;;; `cperl-after-block-p' was FALSE after `sub f {}'.
545
546;;;; After 2.5:
547;;; `foreachmy', `formy' expanded too.
548;;; Expand `=pod-directive'.
549;;; `cperl-linefeed' behaves reasonable in POD-directive lines.
550;;; `cperl-electric-keyword' prints a message, governed by
551;;; `cperl-message-electric-keyword'.
552
553;;;; After 2.6:
554;;; Typing `}' was not checking for being block or not.
555;;; Beautifying levels in RE: Did not know about lookbehind;
556;;; finding *which* level was not intuitive;
557;;; `cperl-beautify-levels' added.
558;;; Allow here-docs contain `=head1' and friends (at least for keywords).
559
560;;;; After 2.7:
561;;; Fix for broken `font-lock-unfontify-region-function'. Should
562;;; preserve `syntax-table' properties even with `lazy-lock'.
563
564;;;; After 2.8:
565;;; Some more compile time warnings crept in.
566;;; `cperl-indent-region-fix-else' implemented.
567;;; `cperl-fix-line-spacing' implemented.
568;;; `cperl-invert-if-unless' implemented (C-c C-t and in Menu).
569;;; Upgraded hints to mention 20.2's goods/bads.
570;;; Started to use `cperl-extra-newline-before-brace-multiline',
8cfd7987 571;;; `cperl-break-one-line-blocks-when-indent',
6c72d195
IZ
572;;; `cperl-fix-hanging-brace-when-indent', `cperl-merge-trailing-else'.
573
574;;;; After 2.9:
575;;; Workaround for another `font-lock's `syntax-table' text-property bug.
576;;; `zerop' could be applied to nil.
577;;; At last, may work with `font-lock' without setting `cperl-font-lock'.
578;;; (We expect that starting from 19.33, `font-lock' supports keywords
579;;; being a function - what is a correct version?)
8cfd7987 580;;; Rename `cperl-indent-region-fix-else' to
6c72d195
IZ
581;;; `cperl-indent-region-fix-constructs'.
582;;; `cperl-fix-line-spacing' could be triggered inside strings, would not
583;;; know what to do with BLOCKs of map/printf/etc.
584;;; `cperl-merge-trailing-else' and `cperl-fix-line-spacing' handle
585;;; `continue' too.
586;;; Indentation after {BLOCK} knows about map/printf/etc.
587;;; Finally: treat after-comma lines as continuation lines.
588
589;;;; After 2.10:
590;;; `continue' made electric.
591;;; Electric `do' inserts `do/while'.
592;;; Some extra compile-time warnings crept in.
593;;; `font-lock' of 19.33 could not handle font-lock-keywords being a function
594;;; returning a symbol.
595
596;;;; After 2.11:
597;;; Changes to make syntaxification to be autoredone via `font-lock'.
598;;; Switched on by `cperl-syntaxify-by-font-lock', off by default so far.
599
600;;;; After 2.12:
601;;; Remove some commented out chunks.
8cfd7987 602;;; Styles are slightly updated (a lot of work is needed, especially
6c72d195
IZ
603;;; with new `cperl-fix-line-spacing').
604
605;;;; After 2.13:
8cfd7987 606;;; Old value of style is memorized when choosing a new style, may be
6c72d195
IZ
607;;; restored from the same menu.
608;;; Mode-documentation added to micro-docs.
609;;; `cperl-praise' updated.
610;;; `cperl-toggle-construct-fix' added on C-c C-w and menu.
611;;; `auto-fill-mode' added on C-c C-f and menu.
612;;; `PerlStyle' style added.
613;;; Message for termination of scan corrected.
614
615;;;; After 2.14:
616
617;;; Did not work with -q
618
619;;;; After 2.15:
620
621;;; `cperl-speed' hints added.
622;;; Minor style fixes.
623
624;;;; After 2.15:
625;;; Make backspace electric after expansion of `else/continue' too.
626
627;;;; After 2.16:
628;;; Starting to merge changes to RMS emacs version.
629
630;;;; After 2.17:
631;;; Merged custom stuff and darn `font-lock-constant-face'.
632
633;;;; After 2.18:
634;;; Bumped the version to 3.1
635
636;;;; After 3.1:
637;;; Fixed customization to honor cperl-hairy.
638;;; Created customization groups. Sent to RMS to include into 2.3.
639
640;;;; After 3.2:
641;;; Interaction of `font-lock-hot-pass' and `cperl-syntaxify-by-font-lock'.
642;;; (`cperl-after-block-and-statement-beg'):
643;;; (`cperl-after-block-p'):
644;;; (`cperl-after-expr-p'): It is BLOCK if we reach lim when backup sexp.
645;;; (`cperl-indent-region'): Make a marker for END - text added/removed.
646;;; (`cperl-style-alist', `cperl-styles-entries')
647;;; Include `cperl-merge-trailing-else' where the value is clear.
648
649;;;; After 3.3:
650;;; (`cperl-tips'):
651;;; (`cperl-problems'): Improvements to docs.
652
653;;;; After 3.4:
654;;; (`cperl-mode'): Make lazy syntaxification possible.
8cfd7987 655;;; (`cperl-find-pods-heres'): Safe a position in buffer where it is safe to
6c72d195
IZ
656;;; restart syntaxification.
657;;; (`cperl-syntaxify-by-font-lock'): Set to t, should be safe now.
658
659;;;; After 3.5:
8cfd7987 660;;; (`cperl-syntaxify-by-font-lock'): Better default, customizes to
6c72d195
IZ
661;;; `message' too.
662
663;;;; After 3.6:
664;;; (`cperl-find-pods-heres'): changed so that -d ?foo? is a RE.
665;;; (`cperl-array-face'): changed name from `font-lock-emphasized-face'.
666;;; (`cperl-hash-face'): changed name from `font-lock-other-emphasized-face'.
667;;; Use `defface' to define these two extra faces.
668
669;;;; After 3.7:
670;;; Can use linear algorithm for indentation if Emacs supports it:
671;;; indenting DB::DB (800+ lines) improved from 69 sec to 11 sec
672;;; (73 vs 15 with imenu).
673;;; (`cperl-emacs-can-parse'): New state.
674;;; (`cperl-indent-line'): Corrected to use global state.
675;;; (`cperl-calculate-indent'): Likewise.
676;;; (`cperl-fix-line-spacing'): Likewise (not used yet).
677
678;;;; After 3.8:
679;;; (`cperl-choose-color'): Converted to a function (to be compilable in text-mode).
680
681;;;; After 3.9:
682;;; (`cperl-dark-background '): Disable without window-system.
683
684;;;; After 3.10:
685;;; Do `defface' only if window-system.
686
687;;;; After 3.11:
688;;; (`cperl-fix-line-spacing'): sped up to bail out early.
689;;; (`cperl-indent-region'): Disable hooks during the call (how to call them later?).
690
691;;; Now indents 820-line-long function in 6.5 sec (including syntaxification) the first time
692;;; (when buffer has few properties), 7.1 sec the second time.
693
694;;;Function Name Call Count Elapsed Time Average Time
695;;;========================================= ========== ============ ============
696;;;cperl-indent-exp 1 10.039999999 10.039999999
697;;;cperl-indent-region 1 10.0 10.0
698;;;cperl-indent-line 821 6.2100000000 0.0075639464
699;;;cperl-calculate-indent 821 5.0199999999 0.0061144945
700;;;cperl-backward-to-noncomment 2856 2.0500000000 0.0007177871
701;;;cperl-fontify-syntaxically 2 1.78 0.8900000000
702;;;cperl-find-pods-heres 2 1.78 0.8900000000
703;;;cperl-update-syntaxification 1 1.78 1.78
704;;;cperl-fix-line-spacing 769 1.4800000000 0.0019245773
705;;;cperl-after-block-and-statement-beg 163 1.4100000000 0.0086503067
706;;;cperl-block-p 775 1.1800000000 0.0015225806
707;;;cperl-to-comment-or-eol 3652 1.1200000000 0.0003066812
708;;;cperl-after-block-p 165 1.0500000000 0.0063636363
709;;;cperl-commentify 141 0.22 0.0015602836
710;;;cperl-get-state 813 0.16 0.0001968019
711;;;cperl-backward-to-start-of-continued-exp 26 0.12 0.0046153846
712;;;cperl-delay-update-hook 2107 0.0899999999 4.271...e-05
713;;;cperl-protect-defun-start 141 0.0700000000 0.0004964539
714;;;cperl-after-label 407 0.0599999999 0.0001474201
715;;;cperl-forward-re 139 0.0299999999 0.0002158273
716;;;cperl-comment-indent 26 0.0299999999 0.0011538461
717;;;cperl-use-region-p 8 0.0 0.0
718;;;cperl-lazy-hook 15 0.0 0.0
719;;;cperl-after-expr-p 8 0.0 0.0
720;;;cperl-font-lock-unfontify-region-function 1 0.0 0.0
721
722;;;Function Name Call Count Elapsed Time Average Time
723;;;========================================= ========== ============ ============
724;;;cperl-fix-line-spacing 769 1.4500000000 0.0018855656
725;;;cperl-indent-line 13 0.3100000000 0.0238461538
726;;;cperl-after-block-and-statement-beg 69 0.2700000000 0.0039130434
727;;;cperl-after-block-p 69 0.2099999999 0.0030434782
728;;;cperl-calculate-indent 13 0.1000000000 0.0076923076
729;;;cperl-backward-to-noncomment 177 0.0700000000 0.0003954802
730;;;cperl-get-state 13 0.0 0.0
731;;;cperl-to-comment-or-eol 179 0.0 0.0
732;;;cperl-get-help-defer 1 0.0 0.0
733;;;cperl-lazy-hook 11 0.0 0.0
734;;;cperl-after-expr-p 2 0.0 0.0
735;;;cperl-block-p 13 0.0 0.0
736;;;cperl-after-label 5 0.0 0.0
737
738;;;; After 3.12:
739;;; (`cperl-find-pods-heres'): do not warn on `=cut' if doing a chunk only.
740
741;;;; After 3.13:
742;;; (`cperl-mode'): load pseudo-faces on `cperl-find-pods-heres' (for 19.30).
743;;; (`x-color-defined-p'): was not compiling on XEmacs
744;;; (`cperl-find-pods-heres'): 1 << 6 was OK, but 1<<6 was considered as HERE
745;;; <file/glob> made into a string.
746
20675f5d
IZ
747;;;; After 3.14:
748;;; (`cperl-find-pods-heres'): Postpone addition of faces after syntactic step
749;;; Recognition of <FH> was wrong.
750;;; (`cperl-clobber-lisp-bindings'): if set, C-c variants are the old ones
751;;; (`cperl-unwind-to-safe'): New function.
752;;; (`cperl-fontify-syntaxically'): Use `cperl-unwind-to-safe' to start at reasonable position.
753
754;;;; After 3.15:
755;;; (`cperl-forward-re'): Highlight the trailing / in s/foo// as string.
756;;; Highlight the starting // in s//foo/ as function-name.
757
758;;;; After 3.16:
759;;; (`cperl-find-pods-heres'): Highlight `gem' in s///gem as a keyword.
760
761;;;; After 4.0:
762;;; (`cperl-find-pods-heres'): `qr' added
763;;; (`cperl-electric-keyword'): Likewise
764;;; (`cperl-electric-else'): Likewise
765;;; (`cperl-to-comment-or-eol'): Likewise
766;;; (`cperl-make-regexp-x'): Likewise
767;;; (`cperl-init-faces'): Likewise, and `lock' (as overridable?).
768;;; (`cperl-find-pods-heres'): Knows that split// is null-RE.
769;;; Highlights separators in 3-parts expressions
770;;; as labels.
771
772;;;; After 4.1:
773;;; (`cperl-find-pods-heres'): <> was considered as a glob
774;;; (`cperl-syntaxify-unwind'): New configuration variable
775;;; (`cperl-fontify-m-as-s'): New configuration variable
776
777;;;; After 4.2:
778;;; (`cperl-find-pods-heres'): of the last line being `=head1' fixed.
779
780;;; Handling of a long construct is still buggy if only the part of
781;;; construct touches the updated region (we unwind to the start of
782;;; long construct, but the end may have residual properties).
783
784;;; (`cperl-unwind-to-safe'): would not go to beginning of buffer.
785;;; (`cperl-electric-pod'): check for after-expr was performed
786;;; inside of POD too.
787
788;;;; After 4.3:
789;;; (`cperl-backward-to-noncomment'): better treatment of PODs and HEREs.
790
791;;; Indent-line works good, but indent-region does not - at toplevel...
792;;; (`cperl-unwind-to-safe'): Signature changed.
793;;; (`x-color-defined-p'): was defmacro'ed with a tick. Remove another def.
794;;; (`cperl-clobber-mode-lists'): New configuration variable.
795;;; (`cperl-array-face'): One of definitions was garbled.
796
797;;;; After 4.4:
7bcea553 798;;; (`cperl-not-bad-style-regexp'): Updated.
20675f5d
IZ
799;;; (`cperl-make-regexp-x'): Misprint in a message.
800;;; (`cperl-find-pods-heres'): $a-1 ? foo : bar; was a regexp.
801;;; `<< (' was considered a start of POD.
802;;; Init: `cperl-is-face' was busted.
803;;; (`cperl-make-face'): New macros.
804;;; (`cperl-force-face'): New macros.
805;;; (`cperl-init-faces'): Corrected to use new macros;
806;;; `if' for copying `reference-face' to
807;;; `constant-face' was backward.
808;;; (`font-lock-other-type-face'): Done via `defface' too.
809
4584684c
GS
810;;;; After 4.5:
811;;; (`cperl-init-faces-weak'): use `cperl-force-face'.
812;;; (`cperl-after-block-p'): After END/BEGIN we are a block.
8cfd7987 813;;; (`cperl-mode'): `font-lock-unfontify-region-function'
4584684c
GS
814;;; was set to a wrong function.
815;;; (`cperl-comment-indent'): Commenting __END__ was not working.
816;;; (`cperl-indent-for-comment'): Likewise.
817;;; (Indenting is still misbehaving at toplevel.)
818
819;;;; After 4.5:
820;;; (`cperl-unwind-to-safe'): Signature changed, unwinds end too.
821;;; (`cperl-find-pods-heres'): mark qq[]-etc sections as syntax-type=string
8cfd7987 822;;; (`cperl-fontify-syntaxically'): Unwinds start and end to go out of
4584684c
GS
823;;; long strings (not very successful).
824
825;;; >>>> CPerl should be usable in write mode too now <<<<
826
827;;; (`cperl-syntaxify-by-font-lock'): Better default - off in text-mode.
828;;; (`cperl-tips'): Updated docs.
829;;; (`cperl-problems'): Updated docs.
830
831;;;; After 4.6:
832;;; (`cperl-calculate-indent'): Did not consider `,' as continuation mark for statements.
833;;; (`cperl-write-tags'): Correct for XEmacs's `visit-tags-table-buffer'.
834
835;;;; After 4.7:
836;;; (`cperl-calculate-indent'): Avoid parse-data optimization at toplevel.
837;;; Should indent correctly at toplevel too.
838;;; (`cperl-tags-hier-init'): Gross hack to pretend we work (are we?).
839;;; (`cperl-find-pods-heres'): Was not processing sub protos after a comment ine.
840;;; Was treating $a++ <= 5 as a glob.
841
842;;;; After 4.8:
843;;; (toplevel): require custom unprotected => failure on 19.28.
844;;; (`cperl-xemacs-p') defined when compile too
845;;; (`cperl-tags-hier-init'): Another try to work around XEmacs problems
846;;; Better progress messages.
8cfd7987 847;;; (`cperl-find-tags'): Was writing line/pos in a wrong order,
4584684c
GS
848;;; pos off by 1 and not at beg-of-line.
849;;; (`cperl-etags-snarf-tag'): New macro
850;;; (`cperl-etags-goto-tag-location'): New macro
8cfd7987 851;;; (`cperl-write-tags'): When removing old TAGS info was not
4584684c
GS
852;;; relativizing filename
853
854;;;; After 4.9:
855;;; (`cperl-version'): New variable. New menu entry
856
857;;;; After 4.10:
858;;; (`cperl-tips'): Updated.
859;;; (`cperl-non-problems'): Updated.
860;;; random: References to future 20.3 removed.
861
862;;;; After 4.11:
863;;; (`perl-font-lock-keywords'): Would not highlight `sub foo($$);'.
864;;; Docstrings: Menu was described as `CPerl' instead of `Perl'
865
866;;;; After 4.12:
867;;; (`cperl-toggle-construct-fix'): Was toggling to t instead of 1.
868;;; (`cperl-ps-print-init'): Associate `cperl-array-face', `cperl-hash-face'
869;;; remove `font-lock-emphasized-face'.
870;;; remove `font-lock-other-emphasized-face'.
871;;; remove `font-lock-reference-face'.
872;;; remove `font-lock-keyword-face'.
873;;; Use `eval-after-load'.
874;;; (`cperl-init-faces'): remove init `font-lock-other-emphasized-face'.
875;;; remove init `font-lock-emphasized-face'.
876;;; remove init `font-lock-keyword-face'.
877;;; (`cperl-tips-faces'): New variable and an entry into Mini-docs.
878;;; (`cperl-indent-region'): Do not indent whitespace lines
879;;; (`cperl-indent-exp'): Was not processing else-blocks.
880;;; (`cperl-calculate-indent'): Remove another parse-data optimization
881;;; at toplevel: would indent correctly.
882;;; (`cperl-get-state'): NOP line removed.
883
884;;;; After 4.13:
885;;; (`cperl-ps-print-init'): Remove not-CPerl-related faces.
886;;; (`cperl-ps-print'): New function and menu entry.
887;;; (`cperl-ps-print-face-properties'): New configuration variable.
888;;; (`cperl-invalid-face'): New configuration variable.
889;;; (`cperl-nonoverridable-face'): New face. Renamed from
890;;; `font-lock-other-type-face'.
891;;; (`perl-font-lock-keywords'): Highlight trailing whitespace
892;;; (`cperl-contract-levels'): Documentation corrected.
893;;; (`cperl-contract-level'): Likewise.
894
895;;;; After 4.14:
896;;; (`cperl-ps-print'): `ps-print-face-extension-alist' was not in old Emaxen,
897;;; same with `ps-extend-face-list'
898;;; (`cperl-ps-extend-face-list'): New macro.
899
900;;;; After 4.15:
901;;; (`cperl-init-faces'): Interpolate `cperl-invalid-face'.
902;;; (`cperl-forward-re'): Emit a meaningful error instead of a cryptic
903;;; one for uncomplete REx near end-of-buffer.
904;;; (`cperl-find-pods-heres'): Tolerate unfinished REx at end-of-buffer.
905
906;;;; After 4.16:
907;;; (`cperl-find-pods-heres'): `unwind-protect' was left commented.
908
909;;;; After 4.17:
910;;; (`cperl-invalid-face'): Change to ''underline.
911
912;;;; After 4.18:
913;;; (`cperl-find-pods-heres'): / and ? after : start a REx.
914;;; (`cperl-after-expr-p'): Skip labels when checking
8cfd7987 915;;; (`cperl-calculate-indent'): Correct for labels when calculating
4584684c
GS
916;;; indentation of continuations.
917;;; Docstring updated.
7bcea553
IZ
918
919;;;; After 4.19:
920;;; Minor (mostly spelling) corrections from 20.3.3 merged.
921
922;;;; After 4.20:
923;;; (`cperl-tips'): Another workaround added. Sent to RMS for 20.4.
924
925;;;; After 4.21:
926;;; (`cperl-praise'): Mention linear-time indent.
927;;; (`cperl-find-pods-heres'): @if ? a : b was considered a REx.
928
929;;;; After 4.22:
930;;; (`cperl-after-expr-p'): Make true after __END__.
931;;; (`cperl-electric-pod'): "SYNOPSIS" was misspelled.
932
933;;;; After 4.23:
934;;; (`cperl-beautify-regexp-piece'): Was not allowing for *? after a class.
935;;; Allow for POSIX char-classes.
936;;; Remove trailing whitespace when
937;;; adding new linebreak.
938;;; Add a level counter to stop shallow.
939;;; Indents unprocessed groups rigidly.
940;;; (`cperl-beautify-regexp'): Add an optional count argument to go that
941;;; many levels deep.
942;;; (`cperl-beautify-level'): Likewise
943;;; Menu: Add new entries to Regexp menu to do one level
944;;; (`cperl-contract-level'): Was entering an infinite loop
945;;; (`cperl-find-pods-heres'): Typo (double quoting).
946;;; Was detecting < $file > as FH instead of glob.
947;;; Support for comments in RExen (except
948;;; for m#\#comment#x), governed by
949;;; `cperl-regexp-scan'.
950;;; (`cperl-regexp-scan'): New customization variable.
951;;; (`cperl-forward-re'): Improve logic of resetting syntax table.
952
953;;;; After 4.23 and: After 4.24:
954;;; (`cperl-contract-levels'): Restore position.
955;;; (`cperl-beautify-level'): Likewise.
956;;; (`cperl-beautify-regexp'): Likewise.
957;;; (`cperl-commentify'): Rudimental support for length=1 runs
958;;; (`cperl-find-pods-heres'): Process 1-char long REx comments too /a#/x
959;;; Processes REx-comments in #-delimited RExen.
960;;; MAJOR BUG CORRECTED: after a misparse
961;;; a body of a subroutine could be corrupted!!!
962;;; One might need to reeval the function body
963;;; to fix things. (A similar bug was
964;;; present in `cperl-indent-region' eons ago.)
965;;; To reproduce:
966;; (defun foo () (let ((a '(t))) (insert (format "%s" a)) (setcar a 'BUG) t))
967;; (foo)
968;; (foo)
969;;; C-x C-e the above three lines (at end-of-line). First evaluation
970;;; of `foo' inserts (t), second one inserts (BUG) ?!
971;;;
8cfd7987 972;;; In CPerl it was triggered by inserting then deleting `/' at start of
7bcea553
IZ
973;;; / a (?# asdf {[(}asdf )ef,/;
974
975;;;; After 4.25:
976;;; (`cperl-commentify'): Was recognizing length=2 "strings" as length=1.
977;;; (`imenu-example--create-perl-index'):
978;;; Was not enforcing syntaxification-to-the-end.
979;;; (`cperl-invert-if-unless'): Allow `for', `foreach'.
980;;; (`cperl-find-pods-heres'): Quote `cperl-nonoverridable-face'.
981;;; Mark qw(), m()x as indentable.
982;;; (`cperl-init-faces'): Highlight `sysopen' too.
983;;; Highlight $var in `for my $var' too.
984;;; (`cperl-invert-if-unless'): Was leaving whitespace at end.
985;;; (`cperl-linefeed'): Was splitting $var{$foo} if point after `{'.
986;;; (`cperl-calculate-indent'): Remove old commented out code.
987;;; Support (primitive) indentation of qw(), m()x.
988
989
990;;;; After 4.26:
991;;; (`cperl-problems'): Mention `fill-paragraph' on comment. \"" and
992;;; q [] with intervening newlines.
993;;; (`cperl-autoindent-on-semi'): New customization variable.
994;;; (`cperl-electric-semi'): Use `cperl-autoindent-on-semi'.
995;;; (`cperl-tips'): Mention how to make CPerl the default mode.
996;;; (`cperl-mode'): Support `outline-minor-mode'
997;;; (Thanks to Mark A. Hershberger).
998;;; (`cperl-outline-level'): New function.
999;;; (`cperl-highlight-variables-indiscriminately'): New customization var.
1000;;; (`cperl-init-faces'): Use `cperl-highlight-variables-indiscriminately'.
1001;;; (Thanks to Sean Kamath <kamath@pogo.wv.tek.com>).
1002;;; (`cperl-after-block-p'): Support CHECK and INIT.
1003;;; (`cperl-init-faces'): Likewise and "our".
1004;;; (Thanks to Doug MacEachern <dougm@covalent.net>).
1005;;; (`cperl-short-docs'): Likewise and "our".
1006
1007
1008;;;; After 4.27:
1009;;; (`cperl-find-pods-heres'): Recognize \"" as a string.
1010;;; Mark whitespace and comments between q and []
1011;;; as `syntax-type' => `prestring'.
1012;;; Allow whitespace between << and "FOO".
1013;;; (`cperl-problems'): Remove \"" and q [] with intervening newlines.
1014;;; Mention multiple <<EOF as unsupported.
1015;;; (`cperl-highlight-variables-indiscriminately'): Doc misprint fixed.
1016;;; (`cperl-indent-parens-as-block'): New configuration variable.
1017;;; (`cperl-calculate-indent'): Merge cases of indenting non-BLOCK groups.
1018;;; Use `cperl-indent-parens-as-block'.
1019;;; (`cperl-find-pods-heres'): Test for =cut without empty line instead of
1020;;; complaining about no =cut.
1021;;; (`cperl-electric-pod'): Change the REx for POD from "\n\n=" to "^\n=".
1022;;; (`cperl-find-pods-heres'): Likewise.
1023;;; (`cperl-electric-pod'): Change `forward-sexp' to `forward-word':
1024;;; POD could've been marked as comment already.
1025;;; (`cperl-unwind-to-safe'): Unwind before start of POD too.
1026
1027;;;; After 4.28:
1028;;; (`cperl-forward-re'): Throw an error at proper moment REx unfinished.
1029
1030;;;; After 4.29:
1031;;; (`x-color-defined-p'): Make an extra case to peacify the warning.
1032;;; Toplevel: `defvar' to peacify the warnings.
1033;;; (`cperl-find-pods-heres'): Could access `font-lock-comment-face' in -nw.
1034;;;; No -nw-compile time warnings now.
1035;;; (`cperl-find-tags'): TAGS file had too short substring-to-search.
1036;;; Be less verbose in non-interactive mode
1037;;; (`imenu-example--create-perl-index'): Set index-marker after name
1038;;; (`cperl-outline-regexp'): New variable.
1039;;; (`cperl-outline-level'): Made compatible with `cperl-outline-regexp'.
1040;;; (`cperl-mode'): Made use `cperl-outline-regexp'.
1041
1042;;;; After 4.30:
1043;;; (`cperl-find-pods-heres'): =cut the last thing, no blank line, was error.
1044;;; (`cperl-outline-level'): Make start-of-file same level as `package'.
1045
1046;;;; After 4.31:
1047;;; (`cperl-electric-pod'): `head1' and `over' electric only if empty.
1048;;; (`cperl-unreadable-ok'): New variable.
1049;;; (`cperl-find-tags'): Use `cperl-unreadable-ok', do not fail
1050;;; on an unreadable file
1051;;; (`cperl-write-tags'): Use `cperl-unreadable-ok', do not fail
1052;;; on an unreadable directory
1053
8cfd7987
JH
1054;;;; After 4.32:
1055;;; Syncronized with v1.60 from Emacs 21.3.
1056;;; Mostly docstring and formatting changes, and:
1057
1058;;; (`cperl-noscan-files-regexp'): Do not scan CVS subdirs
1059;;; (`cperl-problems'): Note that newer XEmacsen may syntaxify too
1060;;; (`imenu-example--create-perl-index'):
1061;;; Renamed to `cperl-imenu--create-perl-index'
1062;;; (`cperl-mode'): Replace `make-variable-buffer-local' by `make-local-variable'
1063;;; (`cperl-setup-tmp-buf'): Likewise
1064;;; (`cperl-fix-line-spacing'): Fix a misprint of "t" for "\t"
1065;;; (`cperl-next-bad-style'): Fix misprints in character literals
1066
1067;;;; After 4.33:
1068;;; (`cperl-font-lock-keywords'): +etc: Aliased to perl-font-lock-keywords.
1069
1070;;;; After 4.34:
1071;;; Further updates of whitespace and spelling w.r.t. RMS version.
1072;;; (`cperl-font-lock-keywords'): +etc: Avoid warnings when aliasing.
1073;;; (`cperl-mode'): Use `normal-auto-fill-function' if present.
1074;;; (`cperl-use-major-mode'): New variable
1075;;; (`cperl-can-font-lock'): New variable; replaces `window-system'
1076;;; (`cperl-tags-hier-init'): use `display-popup-menus-p' (if present)
1077;;; to choose `x-popup-menu' vs `tmm-prompt'
1078
1079;;;; 4.35 has the following differences from version 1.40+ of RMS Emacs:
1080
1081;;; New variables `cperl-use-major-mode', `cperl-can-font-lock';
1082;;; `cperl-use-major-mode' is (effectively) 'cperl-mode in RMS.
1083;;; `cperl-under-as-char' is nil in RMS.
1084;;; Minor differences in docstrings, and `cperl-non-problems'.
1085;;; Backward compatibility addressed: (`); (function (lambda ...)); font-lock;
1086;;; (:italic t bold t) vs (:slant italic :weight bold) in faces;
1087;;; `normal-auto-fill-function'.
1088;;; RMS version has wrong logic in `cperl-calculate-indent': $a = { } is
1089;;; wrongly indented if the closing brace is on a separate line.
1090;;; Different choice of ordering if's for is-x-REx and (eq (char-after b) ?\#)
1091;;; in `cperl-find-pods-heres'. [Cosmetic]
1092
1093;;;; After 4.35:
1094;;; (`cperl-find-pods-heres'): If no end of HERE-doc found, mark to the end
1095;;; of buffer. This enables recognition of end
1096;;; of HERE-doc "as one types".
1097;;; Require "\n" after trailing tag of HERE-doc.
1098;;; \( made non-quoting outside of string/comment
1099;;; (gdj-contributed).
1100;;; Likewise for \$.
1101;;; Remove `here-doc-group' text property at start
1102;;; (makes this property reliable).
1103;;; Text property `first-format-line' ==> t.
1104;;; Do not recognize $opt_s and $opt::s as s///.
1105;;; (`cperl-perldoc'): Use case-sensitive search (contributed).
1106;;; (`cperl-fix-line-spacing'): Allow "_" in $vars of foreach etc. when
1107;;; underscore isn't a word char (gdj-contributed).
1108;;; (`defun-prompt-regexp'): Allow prototypes.
1109;;; (`cperl-vc-header-alist'): Extract numeric version from the Id.
1110;;; Toplevel: Put toggle-autohelp into the mode menu.
1111;;; Better docs for toggle/set/unset autohelp.
1112;;; (`cperl-electric-backspace-untabify'): New customization variable
1113;;; (`cperl-after-expr-p'): Works after here-docs, formats, and PODs too
1114;;; (affects many electric constructs).
1115;;; (`cperl-calculate-indent'): Takes into account `first-format-line' ==>
1116;;; works after format.
1117;;; (`cperl-short-docs'): Make it work with ... too.
1118;;; "array context" ==> "list context"
1119;;; (`cperl-electric-keyword'): make $if (etc: "$@%&*") non-electric
1120;;; '(' after keyword would insert a doubled paren
1121;;; (`cperl-electric-paren'): documented affected by `cperl-electric-parens'
1122;;; (`cperl-electric-rparen'): Likewise
1123;;; (`cperl-build-manpage'): New function by Nick Roberts
1124;;; (`cperl-perldoc'): Make it work in XEmacs too
1125
1126;;;; After 4.36:
1127;;; (`cperl-find-pods-heres'): Recognize s => 1 and {s} (as a key or varname),
1128;;; { s:: } and { s::bar::baz } as varnames.
1129;;; (`cperl-after-expr-p'): Updates syntaxification before checks
1130;;; (`cperl-calculate-indent'): Likewise
1131;;; Fix wrong indent of blocks starting with POD
1132;;; (`cperl-after-block-p'): Optional argument for checking for a pre-block
1133;;; Recognize `continue' blocks too.
1134;;; (`cperl-electric-brace'): use `cperl-after-block-p' for detection;
1135;;; Now works for else/continue/sub blocks
1136;;; (`cperl-short-docs'): Minor edits; make messages fit 80-column screen
1137
8f95267c
RGS
1138;;;; After 5.0:
1139;;; `cperl-add-tags-recurse-noxs-fullpath': new function (for -batch mode)
1140
1141;;;; After 5.1:
1142;;;;;; Major edit. Summary of most visible changes:
1143
1144;;;;;; a) Multiple <<HERE per line allowed.
1145;;;;;; b) Handles multiline subroutine declaration headers (with comments).
1146;;;;;; (The exception is `cperl-etags' - but it is not used in the rest
1147;;;;;; of the mode.)
1148;;;;;; c) Fontifies multiline my/our declarations (even with comments,
1149;;;;;; and with legacy `font-lock').
1150;;;;;; d) Major speedup of syntaxification, both immediate and postponed
1151;;;;;; (3.5x to 15x [for different CPUs and versions of Emacs] on the
1152;;;;;; huge real-life document I tested).
1153;;;;;; e) New bindings, edits to imenu.
1154;;;;;; f) "_" is made into word-char during fontification/syntaxification;
1155;;;;;; some attempts to recognize non-word "_" during other operations too.
1156;;;;;; g) Detect bug in Emacs with `looking-at' inside `narrow' and bulk out.
1157;;;;;; h) autoload some more perldoc-related stuff
1158;;;;;; i) Some new convenience features: ISpell POD/HEREDOCs, narrow-to-HEREDOC
1159;;;;;; j) Attempt to incorporate XEmacs edits which reached me
1160
1161;;;; Fine-grained changelog:
1162;;; `cperl-hook-after-change': New configuration variable
1163;;; `cperl-vc-sccs-header': Likewise
1164;;; `cperl-vc-sccs-header': Likewise
1165;;; `cperl-vc-header-alist': Default via two preceding variables
1166;;; `cperl-invalid-face': Remove double quoting under XEmacs
1167;;; (still needed under 21.2)
1168;;; `cperl-tips': Update URLs for resources
1169;;; `cperl-problems': Likewise
1170;;; `cperl-praise': Mention new features
1171;;; New C-c key bindings: for `cperl-find-bad-style',
1172;;; `cperl-pod-spell', `cperl-here-doc-spell', `cperl-narrow-to-here-doc',
1173;;; `cperl-perdoc', `cperl-perldoc-at-point'
1174;;; CPerl Mode menu changes: "Fix style by spaces", "Imenu on Perl Info"
1175;;; moved, new submenu of Tools with Ispell entries and narrowing.
1176;;; `cperl-after-sub-regexp': New defsubst
1177;;; `cperl-imenu--function-name-regexp-perl': Use `cperl-after-sub-regexp',
1178;;; Allows heads up to head4
1179;;; Allow "package;"
1180;;; `defun-prompt-regexp': Use `cperl-after-sub-regexp',
1181;;; `paren-backwards-message': ??? Something for XEmacs???
1182;;; `cperl-mode': Never auto-switch abbrev-mode off
1183;;; Try to allow '_' be non-word char
1184;;; Do not use `font-lock-unfontify-region-function' on XEmacs
1185;;; Reset syntax cache on mode start
1186;;; Support multiline facification (even
1187;;; on legacy `font-lock')
1188;;; `cperl-facemenu-add-face-function': ??? Some contributed code ???
1189;;; `cperl-after-change-function': Since `font-lock' and `lazy-lock'
1190;;; refuse to inform us whether the fontification is due to lazy
1191;;; calling or due to edit to a buffer, install our own hook
1192;;; (controlled by `cperl-hook-after-change')
1193;;; `cperl-electric-pod': =cut may have been recognized as start
1194;;; `cperl-block-p': Moved, updated for attributes
1195;;; `cperl-calculate-indent': Try to allow '_' be non-word char
1196;;; Support subs with attributes
1197;;; `cperl-where-am-i': Queit (?) a warning
1198;;; `cperl-cached-syntax-table' New function
1199;;; `cperl-forward-re': Use `cperl-cached-syntax-table'
1200;;; `cperl-unwind-to-safe': Recognize `syntax-type' property
1201;;; changing in a middle of line
1202;;; `cperl-find-sub-attrs': New function
1203;;; `cperl-find-pods-heres': Allow many <<EOP per line
1204;;; Allow subs with attributes
1205;;; Major speedups (3.5x..15x on a real-life
1206;;; test file nph-proxy.pl)
1207;;; Recognize "extproc " (OS/2)
1208;;; case-folded and only at start
1209;;; /x on s///x with empty replacement was
1210;;; not recognized
1211;;; Better comments
1212;;; `cperl-after-block-p': Remarks on diff with `cperl-block-p'
1213;;; Allow subs with attributes, labels
1214;;; Do not confuse "else::foo" with "else"
1215;;; Minor optimizations...
1216;;; `cperl-after-expr-p': Try to allow '_' be non-word char
1217;;; `cperl-fill-paragraph': Try to detect a major bug in Emacs
1218;;; with `looking-at' inside `narrow' and bulk out if found
1219;;; `cperl-imenu--create-perl-index': Updates for new
1220;;; `cperl-imenu--function-name-regexp-perl'
1221;;; `cperl-outline-level': Likewise
1222;;; `cperl-init-faces': Allow multiline subroutine headers
1223;;; and my/our declarations, and ones with comments
1224;;; Allow subroutine attributes
1225;;; `cperl-imenu-on-info': Better docstring.
1226;;; `cperl-etags' Rudimentary support for attributes
1227;;; Support for packages and "package;"
1228;;; `cperl-add-tags-recurse-noxs': Better (?) docstring
1229;;; `cperl-add-tags-recurse-noxs-fullpath': Likewise
1230;;; `cperl-tags-hier-init': Misprint for `fboundp' fixed
1231;;; `cperl-not-bad-style-regexp': Try to allow '_' be non-word char
1232;;; `cperl-perldoc': Add autoload
1233;;; `cperl-perldoc-at-point': Likewise
1234;;; `cperl-here-doc-spell': New function
1235;;; `cperl-pod-spell': Likewise
1236;;; `cperl-map-pods-heres': Likewise
1237;;; `cperl-get-here-doc-region': Likewise
1238;;; `cperl-font-lock-fontify-region-function': Likewise (backward compatibility
1239;;; for legacy `font-lock')
1240;;; `cperl-font-lock-unfontify-region-function': Fix style
1241;;; `cperl-fontify-syntaxically': Recognize and optimize away
1242;;; deferred calls with no-change. Governed by `cperl-hook-after-change'
1243;;; `cperl-fontify-update': Recognize that syntaxification region
1244;;; can be larger than fontification one.
1245;;; XXXX we leave `cperl-postpone' property, so this is quadratic...
1246;;; `cperl-fontify-update-bad': Temporary placeholder until
1247;;; it is clear how to implement `cperl-fontify-update'.
1248;;; `cperl-time-fontification': New function
1249;;; `attrib-group': New text attribute
1250;;; `multiline': New value: `syntax-type' text attribute
1251
1252;;;; After 5.2:
1253;;; `cperl-emulate-lazy-lock': New function
1254;;; `cperl-fontify-syntaxically': Would skip large regions
1255;;; Add `cperl-time-fontification', `cperl-emulate-lazy-lock' to menu
1256;;; Some globals were declared, but uninitialized
1257
1258;;;; After 5.3, 5.4:
1259;;; `cperl-facemenu-add-face-function': Add docs, fix U<>
1260;;; Copyright message updated.
1261;;; `cperl-init-faces': Work around a bug in `font-lock'. May slow
1262;;; facification down a bit.
1263;;; Misprint for my|our|local for old `font-lock'
1264;;; "our" was not fontified same as "my|local"
1265;;; Highlight variables after "my" etc even in
1266;;; a middle of an expression
1267;;; Do not facify multiple variables after my etc
1268;;; unless parentheses are present
1269
1270;;; After 5.5, 5.6
1271;;; `cperl-fontify-syntaxically': after-change hook could reset
1272;;; `cperl-syntax-done-to' to a middle of line; unwind to BOL.
1273
1274;;; After 5.7:
1275;;; `cperl-init-faces': Allow highlighting of local ($/)
1276;;; `cperl-problems-old-emaxen': New variable (for the purpose of DOCSTRING).
1277;;; `cperl-problems': Remove fixed problems.
1278;;; `cperl-find-pods-heres': Recognize #-comments in m##x too
1279;;; Recognize charclasses (unless delimiter is \).
1280;;; `cperl-fontify-syntaxically': Unwinding to safe was done in wrong order
1281;;; `cperl-regexp-scan': Update docs
1282;;; `cperl-beautify-regexp-piece': use information got from regexp scan
1283
1284;;; After 5.8:
1285;;; Major user visible changes:
1286;;; Recognition and fontification of character classes in RExen.
1287;;; Variable indentation of RExen according to groups
1288;;;
1289;;; `cperl-find-pods-heres': Recognize POSIX classes in REx charclasses
1290;;; Fontify REx charclasses in variable-name face
1291;;; Fontify POSIX charclasses in "type" face
1292;;; Fontify unmatched "]" in function-name face
1293;;; Mark first-char of HERE-doc as `front-sticky'
1294;;; Reset `front-sticky' property when needed
1295;;; `cperl-calculate-indent': Indents //x -RExen accordning to parens level
1296;;; `cperl-to-comment-or-eol': Recognize ends of `syntax-type' constructs
1297;;; `cperl-backward-to-noncomment': Recognize stringy `syntax-type' constructs
1298;;; Support `narrow'ed buffers.
1299;;; `cperl-praise': Remove a reservation
1300;;; `cperl-make-indent': New function
1301;;; `cperl-indent-for-comment': Use `cperl-make-indent'
1302;;; `cperl-indent-line': Likewise
1303;;; `cperl-lineup': Likewise
1304;;; `cperl-beautify-regexp-piece': Likewise
1305;;; `cperl-contract-level': Likewise
1306;;; `cperl-toggle-set-debug-unwind': New function
1307;;; New menu entry for this
1308;;; `fill-paragraph-function': Use when `boundp'
1309;;; `cperl-calculate-indent': Take into account groups when indenting RExen
1310;;; `cperl-to-comment-or-eol': Recognize # which end a string
1311;;; `cperl-modify-syntax-type': Make only syntax-table property non-sticky
1312;;; `cperl-fill-paragraph': Return t: needed for `fill-paragraph-function'
1313;;; `cperl-fontify-syntaxically': More clear debugging message
1314;;; `cperl-pod2man-build-command': XEmacs portability: check `Man-filter-list'
1315;;; `cperl-init-faces': More complicated highlight even on XEmacs (new)
1316;;; Merge cosmetic changes from XEmacs
1317
1318;;; After 5.9:
1319;;; `cperl-1+': Moved to before the first use
1320;;; `cperl-1-': Likewise
1321
1322;;; After 5.10:
1323
1324;;; This code may lock Emacs hard!!! Use on your own risk!
1325
1326;;; `cperl-font-locking': New internal variable
1327;;; `cperl-beginning-of-property': New function
1328;;; `cperl-calculate-indent': Use `cperl-beginning-of-property'
1329;;; instead of `previous-single-property-change'
1330;;; `cperl-unwind-to-safe': Likewise
1331;;; `cperl-after-expr-p': Likewise
1332;;; `cperl-get-here-doc-region': Likewise
1333;;; `cperl-font-lock-fontify-region-function': Likewise
1334;;; `cperl-to-comment-or-eol': Do not call `cperl-update-syntaxification'
1335;;; recursively
1336;;; Bound `next-single-property-change'
1337;;; via `point-max'
1338;;; `cperl-unwind-to-safe': Bound likewise
1339;;; `cperl-font-lock-fontify-region-function': Likewise
1340;;; `cperl-find-pods-heres': Mark as recursive for `cperl-to-comment-or-eol'
1341;;; Initialization of
1342;;; `cperl-font-lock-multiline-start' could be missed if the "main"
1343;;; fontification did not run due to the keyword being already fontified.
1344;;; `cperl-pod-spell': Return t from do-one-chunk function
1345;;; `cperl-map-pods-heres': Stop when the worker returns nil
1346;;; Call `cperl-update-syntaxification'
1347;;; `cperl-get-here-doc-region': Call `cperl-update-syntaxification'
1348;;; `cperl-get-here-doc-delim': Remove unused function
1349
1350;;; After 5.11:
1351
1352;;; The possible lockup of Emacs (introduced in 5.10) fixed
1353
1354;;; `cperl-unwind-to-safe': `cperl-beginning-of-property' won't return nil
1355;;; `cperl-syntaxify-for-menu': New customization variable
1356;;; `cperl-select-this-pod-or-here-doc': New function
1357;;; `cperl-get-here-doc-region': Extra argument
1358;;; Do not adjust pos by 1
1359
1360;;; New menu entries (Perl/Tools): selection of current POD or HERE-DOC section
1361;;; (Debugging CPerl:) backtrace on fontification
1362
1363;;; After 5.12:
1364;;; `cperl-cached-syntax-table': use `car-safe'
1365;;; `cperl-forward-re': Remove spurious argument SET-ST
1366;;; Add documentation
1367;;; `cperl-forward-group-in-re': New function
1368;;; `cperl-find-pods-heres': Find and highlight (?{}) blocks in RExen
1369;;; (XXXX Temporary (?) hack is to syntax-mark them as comment)
1370
1371;;; After 5.13:
1372;;; `cperl-string-syntax-table': Make { and } not-grouping
1373;;; (Sometimes they ARE grouping in RExen, but matching them would only
1374;;; confuse in many situations when they are not)
1375;;; `beginning-of-buffer': Replaced two occurences with goto-char...
1376;;; `cperl-calculate-indent': `char-after' could be nil...
1377;;; `cperl-find-pods-heres': REx can start after "[" too
1378;;; Hightlight (??{}) in RExen too
1379;;; `cperl-maybe-white-and-comment-rex': New constant
1380;;; `cperl-white-and-comment-rex': Likewise
1381;;; XXXX Not very efficient, but hard to make
1382;;; better while keeping 1 group
1383
1384;;; After 5.13:
1385;;; `cperl-find-pods-heres': $foo << identifier() is not a HERE-DOC
1386;;; Likewise for 1 << identifier
1387
1388;;; After 5.14:
1389;;; `cperl-find-pods-heres': Different logic for $foo .= <<EOF etc
1390;;; Error-less condition-case could fail
1391;;; `cperl-font-lock-fontify-region-function': Likewise
1392;;; `cperl-init-faces': Likewise
1393
1394;;; After 5.15:
1395;;; `cperl-find-pods-heres': Support property REx-part2
1396;;; `cperl-calculate-indent': Likewise
1397;;; Don't special-case REx with non-empty 1st line
1398;;; `cperl-find-pods-heres': In RExen, highlight non-literal backslashes
1399;;; Invert highlighting of charclasses:
1400;;; now the envelop is highlighted
1401;;; Highlight many others 0-length builtins
1402;;; `cperl-praise': Mention indenting and highlight in RExen
1403
1404;;; After 5.15:
1405;;; `cperl-find-pods-heres': Highlight capturing parens in REx
1406
1407;;; After 5.16:
1408;;; `cperl-find-pods-heres': Highlight '|' for alternation
1409;;; Initialize `font-lock-warning-face' if not present
1410;;; `cperl-find-pods-heres': Use `font-lock-warning-face' instead of
1411;;; `font-lock-function-name-face'
1412;;; `cperl-look-at-leading-count': Likewise
1413;;; `cperl-find-pods-heres': localize `font-lock-variable-name-face'
1414;;; `font-lock-keyword-face' (needed for
1415;;; batch processing) etc
1416;;; Use `font-lock-builtin-face' for builtin in REx
1417;;; Now `font-lock-variable-name-face'
1418;;; is used for interpolated variables
1419;;; Use "talking aliases" for faces inside REx
1420;;; Highlight parts of REx (except in charclasses)
1421;;; according to the syntax and/or semantic
1422;;; Syntax-mark a {}-part of (?{}) as "comment"
1423;;; (it was the ()-part)
1424;;; Better logic to distinguish what is what in REx
1425;;; `cperl-tips-faces': Document REx highlighting
1426;;; `cperl-praise': Mention REx syntax highlight etc.
1427
1428;;; After 5.17:
1429;;; `cperl-find-sub-attrs': Would not always manage to print error message
1430;;; `cperl-find-pods-heres': localize `font-lock-constant-face'
1431
1432;;; After 5.18:
1433;;; `cperl-find-pods-heres': Misprint in REx for parsing REx
1434;;; Very minor optimization
1435;;; `my-cperl-REx-modifiers-face' got quoted
1436;;; Recognize "print $foo <<END" as HERE-doc
1437;;; Put `REx-interpolated' text attribute if needed
1438;;; `cperl-invert-if-unless-modifiers': New function
1439;;; `cperl-backward-to-start-of-expr': Likewise
1440;;; `cperl-forward-to-end-of-expr': Likewise
1441;;; `cperl-invert-if-unless': Works in "the opposite way" too
1442;;; Cursor position on return is on the switch-word
1443;;; Indents comments better
1444;;; `REx-interpolated': New text attribute
1445;;; `cperl-next-interpolated-REx': New function
1446;;; `cperl-next-interpolated-REx-0': Likewise
1447;;; `cperl-next-interpolated-REx-1': Likewise
1448;;; "\C-c\C-x", "\C-c\C-y", "\C-c\C-v": New keybinding for these functions
1449;;; Perl/Regexp menu: 3 new entries for `cperl-next-interpolated-REx'
1450;;; `cperl-praise': Mention finded interpolated RExen
1451
1452;;; After 5.19:
1453;;; `cperl-init-faces': Highlight %$foo, @$foo too
1454;;; `cperl-short-docs': Better docs for system, exec
1455;;; `cperl-find-pods-heres': Better detect << after print {FH} <<EOF etc.
1456;;; Would not find HERE-doc ended by EOF without NL
1457;;; `cperl-short-docs': Correct not-doubled \-escapes
1458;;; start block: Put some `defvar' for stuff gone from XEmacs
1459
1460;;; After 5.20:
1461;;; initial comment: Extend copyright, fix email address
1462;;; `cperl-indent-comment-at-column-0': New customization variable
1463;;; `cperl-comment-indent': Indentation after $#a would increasy by 1
1464;;; `cperl-mode': Make `defun-prompt-regexp' grok BEGIN/END etc
1465;;; `cperl-find-pods-heres': Mark CODE of s///e as `syntax-type' `multiline'
1466;;; `cperl-at-end-of-expr': Would fail if @BAR=12 follows after ";"
1467;;; `cperl-init-faces': If `cperl-highlight-variables-indiscriminately'
1468;;; highlight $ in $foo too (UNTESTED)
1469;;; `cperl-set-style': Docstring missed some available styles
1470;;; toplevel: Menubar/Perl/Indent-Styles had FSF, now K&R
1471;;; Change "Current" to "Memorize Current"
1472;;; `cperl-indent-wrt-brace': New customization variable; the default is
1473;;; as for pre-5.2 version
1474;;; `cperl-styles-entries': Keep `cperl-extra-newline-before-brace-multiline'
1475;;; `cperl-style-alist': Likewise
1476;;; `cperl-fix-line-spacing': Support `cperl-merge-trailing-else' being nil,
1477;;; and `cperl-extra-newline-before-brace' etc
1478;;; being t
1479;;; `cperl-indent-exp': Plans B and C to find continuation blocks even
1480;;; if `cperl-extra-newline-before-brace' is t
1481
1482;;; After 5.21:
1483;;; Improve some docstrings concerning indentation.
1484;;; `cperl-indent-rules-alist': New variable
1485;;; `cperl-sniff-for-indent': New function name
1486;; (separated from `cperl-calculate-indent')
1487;;; `cperl-calculate-indent': Separated the sniffer and the indenter;
1488;;; uses `cperl-sniff-for-indent' now
1489;;; `cperl-comment-indent': Test for `cperl-indent-comment-at-column-0'
1490;;; was inverted;
1491;;; Support `comment-column' = 0
1492
1493;;; After 5.22:
1494;;; `cperl-where-am-i': Remove function
1495;;; `cperl-backward-to-noncomment': Would go too far when skipping POD/HEREs
1496;;; `cperl-sniff-for-indent': [string] and [comment] were inverted
1497;;; When looking for label, skip s:m:y:tr
1498;;; `cperl-indent-line': Likewise.
1499;;; `cperl-mode': `font-lock-multiline' was assumed auto-local
1500;;; `cperl-windowed-init': Wrong `ps-print' handling
1501;;; (both thanks to Chong Yidong)
1502;;; `cperl-look-at-leading-count': Could fail with unfinished RExen
1503;;; `cperl-find-pods-heres': If the second part of s()[] is missing,
1504;;; could try to highlight delimiters...
6c791c2c 1505
6c72d195 1506;;; Code:
6c72d195
IZ
1507\f
1508(if (fboundp 'eval-when-compile)
1509 (eval-when-compile
1510 (condition-case nil
1511 (require 'custom)
1512 (error nil))
8cfd7987
JH
1513 (condition-case nil
1514 (require 'man)
1515 (error nil))
4584684c 1516 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
8cfd7987
JH
1517 (defvar cperl-can-font-lock
1518 (or cperl-xemacs-p
1519 (and (boundp 'emacs-major-version)
1520 (or window-system
1521 (> emacs-major-version 20)))))
1522 (if cperl-can-font-lock
1523 (require 'font-lock))
1524 (defvar msb-menu-cond)
1525 (defvar gud-perldb-history)
1526 (defvar font-lock-background-mode) ; not in Emacs
1527 (defvar font-lock-display-type) ; ditto
8f95267c
RGS
1528 (defvar paren-backwards-message) ; Not in newer XEmacs?
1529 (defvar vc-rcs-header) ; likewise?
1530 (defvar vc-sccs-header) ; likewise?
6c72d195
IZ
1531 (or (fboundp 'defgroup)
1532 (defmacro defgroup (name val doc &rest arr)
1533 nil))
1534 (or (fboundp 'custom-declare-variable)
1535 (defmacro defcustom (name val doc &rest arr)
1536 (` (defvar (, name) (, val) (, doc)))))
1537 (or (and (fboundp 'custom-declare-variable)
8cfd7987 1538 (string< "19.31" emacs-version)) ; Checked with 19.30: defface does not work
6c72d195
IZ
1539 (defmacro defface (&rest arr)
1540 nil))
8cfd7987 1541 ;; Avoid warning (tmp definitions)
6c72d195 1542 (or (fboundp 'x-color-defined-p)
20675f5d 1543 (defmacro x-color-defined-p (col)
6c72d195
IZ
1544 (cond ((fboundp 'color-defined-p) (` (color-defined-p (, col))))
1545 ;; XEmacs >= 19.12
1546 ((fboundp 'valid-color-name-p) (` (valid-color-name-p (, col))))
1547 ;; XEmacs 19.11
7bcea553
IZ
1548 ((fboundp 'x-valid-color-name-p) (` (x-valid-color-name-p (, col))))
1549 (t '(error "Cannot implement color-defined-p")))))
20675f5d 1550 (defmacro cperl-is-face (arg) ; Takes quoted arg
8cfd7987
JH
1551 (cond ((fboundp 'find-face)
1552 (` (find-face (, arg))))
1553 (;;(and (fboundp 'face-list)
1554 ;; (face-list))
1555 (fboundp 'face-list)
1556 (` (member (, arg) (and (fboundp 'face-list)
1557 (face-list)))))
1558 (t
1559 (` (boundp (, arg))))))
20675f5d
IZ
1560 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
1561 (cond ((fboundp 'make-face)
1562 (` (make-face (quote (, arg)))))
1563 (t
8cfd7987 1564 (` (defvar (, arg) (quote (, arg)) (, descr))))))
20675f5d
IZ
1565 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
1566 (` (progn
1567 (or (cperl-is-face (quote (, arg)))
1568 (cperl-make-face (, arg) (, descr)))
1569 (or (boundp (quote (, arg))) ; We use unquoted variants too
8cfd7987 1570 (defvar (, arg) (quote (, arg)) (, descr))))))
4584684c
GS
1571 (if cperl-xemacs-p
1572 (defmacro cperl-etags-snarf-tag (file line)
1573 (` (progn
1574 (beginning-of-line 2)
1575 (list (, file) (, line)))))
1576 (defmacro cperl-etags-snarf-tag (file line)
1577 (` (etags-snarf-tag))))
1578 (if cperl-xemacs-p
1579 (defmacro cperl-etags-goto-tag-location (elt)
8cfd7987
JH
1580 (`;;(progn
1581 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
1582 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
1583 ;; Probably will not work due to some save-excursion???
1584 ;; Or save-file-position?
1585 ;; (message "Did I get to line %s?" (elt (, elt) 1))
1586 (goto-line (string-to-int (elt (, elt) 1)))))
1587 ;;)
4584684c
GS
1588 (defmacro cperl-etags-goto-tag-location (elt)
1589 (` (etags-goto-tag-location (, elt)))))))
1590
8cfd7987
JH
1591(defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
1592
1593(defvar cperl-can-font-lock
1594 (or cperl-xemacs-p
1595 (and (boundp 'emacs-major-version)
1596 (or window-system
1597 (> emacs-major-version 20)))))
1598
4584684c
GS
1599(condition-case nil
1600 (require 'custom)
1601 (error nil)) ; Already fixed by eval-when-compile
6c72d195 1602
6c72d195
IZ
1603(defun cperl-choose-color (&rest list)
1604 (let (answer)
1605 (while list
1606 (or answer
1607 (if (or (x-color-defined-p (car list))
1608 (null (cdr list)))
1609 (setq answer (car list))))
1610 (setq list (cdr list)))
1611 answer))
1612
ebcd4dbc 1613\f
6c72d195
IZ
1614(defgroup cperl nil
1615 "Major mode for editing Perl code."
1616 :prefix "cperl-"
1617 :group 'languages)
1618
1619(defgroup cperl-indentation-details nil
1620 "Indentation."
1621 :prefix "cperl-"
1622 :group 'cperl)
1623
1624(defgroup cperl-affected-by-hairy nil
1625 "Variables affected by `cperl-hairy'."
1626 :prefix "cperl-"
1627 :group 'cperl)
1628
1629(defgroup cperl-autoinsert-details nil
1630 "Auto-insert tuneup."
1631 :prefix "cperl-"
1632 :group 'cperl)
1633
1634(defgroup cperl-faces nil
1635 "Fontification colors."
1636 :prefix "cperl-"
1637 :group 'cperl)
1638
1639(defgroup cperl-speed nil
1640 "Speed vs. validity tuneup."
1641 :prefix "cperl-"
1642 :group 'cperl)
1643
1644(defgroup cperl-help-system nil
1645 "Help system tuneup."
1646 :prefix "cperl-"
1647 :group 'cperl)
1648
1649\f
1650(defcustom cperl-extra-newline-before-brace nil
4633a7c4
LW
1651 "*Non-nil means that if, elsif, while, until, else, for, foreach
1652and do constructs look like:
1653
1654 if ()
1655 {
1656 }
1657
1658instead of:
1659
1660 if () {
8cfd7987 1661 }"
6c72d195
IZ
1662 :type 'boolean
1663 :group 'cperl-autoinsert-details)
1664
8cfd7987 1665(defcustom cperl-extra-newline-before-brace-multiline
6c72d195
IZ
1666 cperl-extra-newline-before-brace
1667 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
1668for constructs with multiline if/unless/while/until/for/foreach condition."
1669 :type 'boolean
1670 :group 'cperl-autoinsert-details)
1671
1672(defcustom cperl-indent-level 2
1673 "*Indentation of CPerl statements with respect to containing block."
1674 :type 'integer
1675 :group 'cperl-indentation-details)
1676
1677(defcustom cperl-lineup-step nil
4633a7c4 1678 "*`cperl-lineup' will always lineup at multiple of this number.
8cfd7987 1679If nil, the value of `cperl-indent-level' will be used."
6c72d195
IZ
1680 :type '(choice (const nil) integer)
1681 :group 'cperl-indentation-details)
1682
1683(defcustom cperl-brace-imaginary-offset 0
4633a7c4
LW
1684 "*Imagined indentation of a Perl open brace that actually follows a statement.
1685An open brace following other text is treated as if it were this far
6c72d195
IZ
1686to the right of the start of its line."
1687 :type 'integer
1688 :group 'cperl-indentation-details)
1689
1690(defcustom cperl-brace-offset 0
1691 "*Extra indentation for braces, compared with other text in same context."
1692 :type 'integer
1693 :group 'cperl-indentation-details)
1694(defcustom cperl-label-offset -2
1695 "*Offset of CPerl label lines relative to usual indentation."
1696 :type 'integer
1697 :group 'cperl-indentation-details)
1698(defcustom cperl-min-label-indent 1
1699 "*Minimal offset of CPerl label lines."
1700 :type 'integer
1701 :group 'cperl-indentation-details)
1702(defcustom cperl-continued-statement-offset 2
1703 "*Extra indent for lines not starting new statements."
1704 :type 'integer
1705 :group 'cperl-indentation-details)
1706(defcustom cperl-continued-brace-offset 0
4633a7c4 1707 "*Extra indent for substatements that start with open-braces.
6c72d195
IZ
1708This is in addition to cperl-continued-statement-offset."
1709 :type 'integer
1710 :group 'cperl-indentation-details)
1711(defcustom cperl-close-paren-offset -1
1712 "*Extra indent for substatements that start with close-parenthesis."
1713 :type 'integer
1714 :group 'cperl-indentation-details)
1715
8f95267c
RGS
1716(defcustom cperl-indent-wrt-brace t
1717 "*Non-nil means indent statements in if/etc block relative brace, not if/etc.
1718Versions 5.2 ... 5.20 behaved as if this were `nil'."
1719 :type 'boolean
1720 :group 'cperl-indentation-details)
1721
6c72d195 1722(defcustom cperl-auto-newline nil
4633a7c4 1723 "*Non-nil means automatically newline before and after braces,
6c72d195 1724and after colons and semicolons, inserted in CPerl code. The following
9ea28adb 1725\\[cperl-electric-backspace] will remove the inserted whitespace.
8cfd7987 1726Insertion after colons requires both this variable and
6c72d195
IZ
1727`cperl-auto-newline-after-colon' set."
1728 :type 'boolean
1729 :group 'cperl-autoinsert-details)
9ea28adb 1730
7bcea553
IZ
1731(defcustom cperl-autoindent-on-semi nil
1732 "*Non-nil means automatically indent after insertion of (semi)colon.
1733Active if `cperl-auto-newline' is false."
1734 :type 'boolean
1735 :group 'cperl-autoinsert-details)
1736
6c72d195 1737(defcustom cperl-auto-newline-after-colon nil
9ea28adb 1738 "*Non-nil means automatically newline even after colons.
6c72d195
IZ
1739Subject to `cperl-auto-newline' setting."
1740 :type 'boolean
1741 :group 'cperl-autoinsert-details)
4633a7c4 1742
6c72d195 1743(defcustom cperl-tab-always-indent t
4633a7c4 1744 "*Non-nil means TAB in CPerl mode should always reindent the current line,
6c72d195
IZ
1745regardless of where in the line point is when the TAB command is used."
1746 :type 'boolean
1747 :group 'cperl-indentation-details)
4633a7c4 1748
6c72d195 1749(defcustom cperl-font-lock nil
8cfd7987 1750 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
6c72d195
IZ
1751Can be overwritten by `cperl-hairy' if nil."
1752 :type '(choice (const null) boolean)
1753 :group 'cperl-affected-by-hairy)
4633a7c4 1754
6c72d195 1755(defcustom cperl-electric-lbrace-space nil
8cfd7987 1756 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
6c72d195
IZ
1757Can be overwritten by `cperl-hairy' if nil."
1758 :type '(choice (const null) boolean)
1759 :group 'cperl-affected-by-hairy)
4633a7c4 1760
6c72d195 1761(defcustom cperl-electric-parens-string "({[]})<"
05bbd9c3 1762 "*String of parentheses that should be electric in CPerl.
6c72d195
IZ
1763Closing ones are electric only if the region is highlighted."
1764 :type 'string
1765 :group 'cperl-affected-by-hairy)
9ea28adb 1766
6c72d195 1767(defcustom cperl-electric-parens nil
9ea28adb 1768 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
6c72d195
IZ
1769Can be overwritten by `cperl-hairy' if nil."
1770 :type '(choice (const null) boolean)
1771 :group 'cperl-affected-by-hairy)
1772
1773(defvar zmacs-regions) ; Avoid warning
1774
8cfd7987 1775(defcustom cperl-electric-parens-mark
9ea28adb 1776 (and window-system
1777 (or (and (boundp 'transient-mark-mode) ; For Emacs
1778 transient-mark-mode)
1779 (and (boundp 'zmacs-regions) ; For XEmacs
1780 zmacs-regions)))
1781 "*Not-nil means that electric parens look for active mark.
6c72d195
IZ
1782Default is yes if there is visual feedback on mark."
1783 :type 'boolean
1784 :group 'cperl-autoinsert-details)
9ea28adb 1785
6c72d195 1786(defcustom cperl-electric-linefeed nil
4633a7c4
LW
1787 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
1788In any case these two mean plain and hairy linefeeds together.
6c72d195
IZ
1789Can be overwritten by `cperl-hairy' if nil."
1790 :type '(choice (const null) boolean)
1791 :group 'cperl-affected-by-hairy)
4633a7c4 1792
6c72d195 1793(defcustom cperl-electric-keywords nil
4633a7c4 1794 "*Not-nil (and non-null) means keywords are electric in CPerl.
6c72d195
IZ
1795Can be overwritten by `cperl-hairy' if nil."
1796 :type '(choice (const null) boolean)
1797 :group 'cperl-affected-by-hairy)
1798
8cfd7987
JH
1799(defcustom cperl-electric-backspace-untabify t
1800 "*Not-nil means electric-backspace will untabify in CPerl."
1801 :type 'boolean
1802 :group 'cperl-autoinsert-details)
1803
6c72d195
IZ
1804(defcustom cperl-hairy nil
1805 "*Not-nil means most of the bells and whistles are enabled in CPerl.
8cfd7987 1806Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
6c72d195
IZ
1807`cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
1808`cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
1809`cperl-lazy-help-time'."
1810 :type 'boolean
1811 :group 'cperl-affected-by-hairy)
1812
1813(defcustom cperl-comment-column 32
1814 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
1815 :type 'integer
1816 :group 'cperl-indentation-details)
1817
8f95267c
RGS
1818(defcustom cperl-indent-comment-at-column-0 nil
1819 "*Non-nil means that comment started at column 0 should be indentable."
1820 :type 'boolean
1821 :group 'cperl-indentation-details)
1822
1823(defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
1824 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
1825 :type '(repeat string)
1826 :group 'cperl)
1827
1828(defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
1829 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
1830 :type '(repeat string)
1831 :group 'cperl)
1832
1833;; This became obsolete...
1834(defcustom cperl-vc-header-alist '()
1835 "*What to use as `vc-header-alist' in CPerl.
1836Obsolete, with newer Emacsen use `cperl-vc-rcs-header' or
1837`cperl-vc-sccs-header' instead. If this list is empty, `vc-header-alist'
1838will be reconstructed basing on these two variables."
6c72d195
IZ
1839 :type '(repeat (list symbol string))
1840 :group 'cperl)
1841
8cfd7987 1842(defcustom cperl-clobber-mode-lists
20675f5d
IZ
1843 (not
1844 (and
1845 (boundp 'interpreter-mode-alist)
1846 (assoc "miniperl" interpreter-mode-alist)
1847 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
1848 "*Whether to install us into `interpreter-' and `extension' mode lists."
1849 :type 'boolean
1850 :group 'cperl)
1851
6c72d195 1852(defcustom cperl-info-on-command-no-prompt nil
4633a7c4
LW
1853 "*Not-nil (and non-null) means not to prompt on C-h f.
1854The opposite behaviour is always available if prefixed with C-c.
6c72d195
IZ
1855Can be overwritten by `cperl-hairy' if nil."
1856 :type '(choice (const null) boolean)
1857 :group 'cperl-affected-by-hairy)
1858
1859(defcustom cperl-clobber-lisp-bindings nil
1860 "*Not-nil (and non-null) means not overwrite C-h f.
1861The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
1862Can be overwritten by `cperl-hairy' if nil."
1863 :type '(choice (const null) boolean)
1864 :group 'cperl-affected-by-hairy)
1865
1866(defcustom cperl-lazy-help-time nil
1867 "*Not-nil (and non-null) means to show lazy help after given idle time.
1868Can be overwritten by `cperl-hairy' to be 5 sec if nil."
7bcea553 1869 :type '(choice (const null) (const nil) integer)
6c72d195
IZ
1870 :group 'cperl-affected-by-hairy)
1871
1872(defcustom cperl-pod-face 'font-lock-comment-face
8cfd7987 1873 "*The result of evaluation of this expression is used for POD highlighting."
6c72d195
IZ
1874 :type 'face
1875 :group 'cperl-faces)
1876
1877(defcustom cperl-pod-head-face 'font-lock-variable-name-face
8cfd7987 1878 "*The result of evaluation of this expression is used for POD highlighting.
6c72d195
IZ
1879Font for POD headers."
1880 :type 'face
1881 :group 'cperl-faces)
c07a80fd 1882
6c72d195
IZ
1883(defcustom cperl-here-face 'font-lock-string-face
1884 "*The result of evaluation of this expression is used for here-docs highlighting."
1885 :type 'face
1886 :group 'cperl-faces)
c07a80fd 1887
8f95267c
RGS
1888;;; Some double-evaluation happened with font-locks... Needed with 21.2...
1889(defvar cperl-singly-quote-face cperl-xemacs-p)
1890
1891(defcustom cperl-invalid-face ; Does not customize with '' on XEmacs
1892 (if cperl-singly-quote-face
1893 'underline ''underline) ; On older Emacsen was evaluated by `font-lock'
1894 (if cperl-singly-quote-face
1895 "*This face is used for highlighting trailing whitespace."
1896 "*The result of evaluation of this expression highlights trailing whitespace.")
4584684c
GS
1897 :type 'face
1898 :group 'cperl-faces)
1899
6c72d195 1900(defcustom cperl-pod-here-fontify '(featurep 'font-lock)
8cfd7987 1901 "*Not-nil after evaluation means to highlight POD and here-docs sections."
6c72d195
IZ
1902 :type 'boolean
1903 :group 'cperl-faces)
c07a80fd 1904
20675f5d
IZ
1905(defcustom cperl-fontify-m-as-s t
1906 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
1907 :type 'boolean
1908 :group 'cperl-faces)
1909
7bcea553 1910(defcustom cperl-highlight-variables-indiscriminately nil
8cfd7987
JH
1911 "*Non-nil means perform additional highlighting on variables.
1912Currently only changes how scalar variables are highlighted.
7bcea553 1913Note that that variable is only read at initialization time for
8cfd7987
JH
1914the variable `perl-font-lock-keywords-2', so changing it after you've
1915entered CPerl mode the first time will have no effect."
7bcea553
IZ
1916 :type 'boolean
1917 :group 'cperl)
1918
6c72d195 1919(defcustom cperl-pod-here-scan t
8cfd7987 1920 "*Not-nil means look for POD and here-docs sections during startup.
6c72d195
IZ
1921You can always make lookup from menu or using \\[cperl-find-pods-heres]."
1922 :type 'boolean
1923 :group 'cperl-speed)
c07a80fd 1924
7bcea553
IZ
1925(defcustom cperl-regexp-scan t
1926 "*Not-nil means make marking of regular expression more thorough.
8f95267c
RGS
1927Effective only with `cperl-pod-here-scan'."
1928 :type 'boolean
1929 :group 'cperl-speed)
1930
1931(defcustom cperl-hook-after-change t
1932 "*Not-nil means install hook to know which regions of buffer are changed.
1933May significantly speed up delayed fontification. Changes take effect
1934after reload."
7bcea553
IZ
1935 :type 'boolean
1936 :group 'cperl-speed)
1937
6c72d195 1938(defcustom cperl-imenu-addback nil
9ea28adb 1939 "*Not-nil means add backreferences to generated `imenu's.
6c72d195
IZ
1940May require patched `imenu' and `imenu-go'. Obsolete."
1941 :type 'boolean
1942 :group 'cperl-help-system)
9ea28adb 1943
6c72d195
IZ
1944(defcustom cperl-max-help-size 66
1945 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
1946 :type '(choice integer (const nil))
1947 :group 'cperl-help-system)
5f05dabc 1948
6c72d195
IZ
1949(defcustom cperl-shrink-wrap-info-frame t
1950 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
1951 :type 'boolean
1952 :group 'cperl-help-system)
5f05dabc 1953
6c72d195 1954(defcustom cperl-info-page "perl"
ebcd4dbc 1955 "*Name of the info page containing perl docs.
6c72d195
IZ
1956Older version of this page was called `perl5', newer `perl'."
1957 :type 'string
1958 :group 'cperl-help-system)
499d5216 1959
8cfd7987 1960(defcustom cperl-use-syntax-table-text-property
05bbd9c3 1961 (boundp 'parse-sexp-lookup-properties)
6c72d195
IZ
1962 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
1963 :type 'boolean
1964 :group 'cperl-speed)
ebcd4dbc 1965
8cfd7987 1966(defcustom cperl-use-syntax-table-text-property-for-tags
05bbd9c3 1967 cperl-use-syntax-table-text-property
6c72d195
IZ
1968 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
1969 :type 'boolean
1970 :group 'cperl-speed)
1971
1972(defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
1973 "*Regexp to match files to scan when generating TAGS."
1974 :type 'regexp
1975 :group 'cperl)
1976
8cfd7987
JH
1977(defcustom cperl-noscan-files-regexp
1978 "/\\(\\.\\.?\\|SCCS\\|RCS\\|CVS\\|blib\\)$"
6c72d195
IZ
1979 "*Regexp to match files/dirs to skip when generating TAGS."
1980 :type 'regexp
1981 :group 'cperl)
1982
1983(defcustom cperl-regexp-indent-step nil
1984 "*Indentation used when beautifying regexps.
8cfd7987 1985If nil, the value of `cperl-indent-level' will be used."
6c72d195
IZ
1986 :type '(choice integer (const nil))
1987 :group 'cperl-indentation-details)
1988
1989(defcustom cperl-indent-left-aligned-comments t
1990 "*Non-nil means that the comment starting in leftmost column should indent."
1991 :type 'boolean
1992 :group 'cperl-indentation-details)
1993
1994(defcustom cperl-under-as-char t
1995 "*Non-nil means that the _ (underline) should be treated as word char."
1996 :type 'boolean
1997 :group 'cperl)
1998
1999(defcustom cperl-extra-perl-args ""
2000 "*Extra arguments to use when starting Perl.
2001Currently used with `cperl-check-syntax' only."
2002 :type 'string
2003 :group 'cperl)
2004
2005(defcustom cperl-message-electric-keyword t
2006 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
2007 :type 'boolean
2008 :group 'cperl-help-system)
2009
2010(defcustom cperl-indent-region-fix-constructs 1
2011 "*Amount of space to insert between `}' and `else' or `elsif'
2012in `cperl-indent-region'. Set to nil to leave as is. Values other
2013than 1 and nil will probably not work."
2014 :type '(choice (const nil) (const 1))
2015 :group 'cperl-indentation-details)
2016
2017(defcustom cperl-break-one-line-blocks-when-indent t
2018 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
8cfd7987 2019need to be reformatted into multiline ones when indenting a region."
6c72d195
IZ
2020 :type 'boolean
2021 :group 'cperl-indentation-details)
2022
2023(defcustom cperl-fix-hanging-brace-when-indent t
2024 "*Non-nil means that BLOCK-end `}' may be put on a separate line
8cfd7987 2025when indenting a region.
6c72d195
IZ
2026Braces followed by else/elsif/while/until are excepted."
2027 :type 'boolean
2028 :group 'cperl-indentation-details)
2029
2030(defcustom cperl-merge-trailing-else t
8cfd7987 2031 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
6c72d195
IZ
2032may be merged to be on the same line when indenting a region."
2033 :type 'boolean
2034 :group 'cperl-indentation-details)
2035
7bcea553
IZ
2036(defcustom cperl-indent-parens-as-block nil
2037 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
2038but for trailing \",\" inside the group, which won't increase indentation.
2039One should tune up `cperl-close-paren-offset' as well."
2040 :type 'boolean
2041 :group 'cperl-indentation-details)
2042
8cfd7987
JH
2043(defcustom cperl-syntaxify-by-font-lock
2044 (and cperl-can-font-lock
4584684c 2045 (boundp 'parse-sexp-lookup-properties))
7bcea553 2046 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
6c72d195
IZ
2047 :type '(choice (const message) boolean)
2048 :group 'cperl-speed)
05bbd9c3 2049
20675f5d
IZ
2050(defcustom cperl-syntaxify-unwind
2051 t
8cfd7987 2052 "*Non-nil means that CPerl unwinds to a start of a long construction
20675f5d
IZ
2053when syntaxifying a chunk of buffer."
2054 :type 'boolean
2055 :group 'cperl-speed)
2056
8f95267c
RGS
2057(defcustom cperl-syntaxify-for-menu
2058 t
2059 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
2060This way enabling/disabling of menu items is more correct."
2061 :type 'boolean
2062 :group 'cperl-speed)
2063
4584684c
GS
2064(defcustom cperl-ps-print-face-properties
2065 '((font-lock-keyword-face nil nil bold shadow)
2066 (font-lock-variable-name-face nil nil bold)
2067 (font-lock-function-name-face nil nil bold italic box)
2068 (font-lock-constant-face nil "LightGray" bold)
2069 (cperl-array-face nil "LightGray" bold underline)
2070 (cperl-hash-face nil "LightGray" bold italic underline)
2071 (font-lock-comment-face nil "LightGray" italic)
2072 (font-lock-string-face nil nil italic underline)
2073 (cperl-nonoverridable-face nil nil italic underline)
2074 (font-lock-type-face nil nil underline)
8f95267c 2075 (font-lock-warning-face nil "LightGray" bold italic box)
4584684c
GS
2076 (underline nil "LightGray" strikeout))
2077 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
8cfd7987 2078 :type '(repeat (cons symbol
4584684c
GS
2079 (cons (choice (const nil) string)
2080 (cons (choice (const nil) string)
2081 (repeat symbol)))))
2082 :group 'cperl-faces)
2083
8cfd7987 2084(if cperl-can-font-lock
6c72d195 2085 (progn
8cfd7987 2086 (defvar cperl-dark-background
6c72d195 2087 (cperl-choose-color "navy" "os2blue" "darkgreen"))
8cfd7987 2088 (defvar cperl-dark-foreground
20675f5d
IZ
2089 (cperl-choose-color "orchid1" "orange"))
2090
4584684c 2091 (defface cperl-nonoverridable-face
20675f5d
IZ
2092 (` ((((class grayscale) (background light))
2093 (:background "Gray90" :italic t :underline t))
2094 (((class grayscale) (background dark))
2095 (:foreground "Gray80" :italic t :underline t :bold t))
8cfd7987 2096 (((class color) (background light))
20675f5d 2097 (:foreground "chartreuse3"))
8cfd7987 2098 (((class color) (background dark))
20675f5d
IZ
2099 (:foreground (, cperl-dark-foreground)))
2100 (t (:bold t :underline t))))
2101 "Font Lock mode face used to highlight array names."
2102 :group 'cperl-faces)
6c72d195
IZ
2103
2104 (defface cperl-array-face
2105 (` ((((class grayscale) (background light))
2106 (:background "Gray90" :bold t))
2107 (((class grayscale) (background dark))
2108 (:foreground "Gray80" :bold t))
8cfd7987 2109 (((class color) (background light))
6c72d195 2110 (:foreground "Blue" :background "lightyellow2" :bold t))
8cfd7987 2111 (((class color) (background dark))
6c72d195
IZ
2112 (:foreground "yellow" :background (, cperl-dark-background) :bold t))
2113 (t (:bold t))))
2114 "Font Lock mode face used to highlight array names."
2115 :group 'cperl-faces)
2116
2117 (defface cperl-hash-face
2118 (` ((((class grayscale) (background light))
2119 (:background "Gray90" :bold t :italic t))
2120 (((class grayscale) (background dark))
2121 (:foreground "Gray80" :bold t :italic t))
8cfd7987 2122 (((class color) (background light))
6c72d195 2123 (:foreground "Red" :background "lightyellow2" :bold t :italic t))
8cfd7987 2124 (((class color) (background dark))
6c72d195
IZ
2125 (:foreground "Red" :background (, cperl-dark-background) :bold t :italic t))
2126 (t (:bold t :italic t))))
2127 "Font Lock mode face used to highlight hash names."
2128 :group 'cperl-faces)))
05bbd9c3 2129
c07a80fd 2130\f
2131
2132;;; Short extra-docs.
2133
2134(defvar cperl-tips 'please-ignore-this-line
8cfd7987 2135 "Get maybe newer version of this package from
8f95267c 2136 http://ilyaz.org/software/emacs
6c72d195
IZ
2137Subdirectory `cperl-mode' may contain yet newer development releases and/or
2138patches to related files.
c07a80fd 2139
4584684c
GS
2140For best results apply to an older Emacs the patches from
2141 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
8f95267c 2142\(this upgrades syntax-parsing abilities of RMS Emaxen v19.34 and
4584684c 2143v20.2 up to the level of RMS Emacs v20.3 - a must for a good Perl
8cfd7987 2144mode.) As of beginning of 2003, XEmacs may provide a similar ability.
4584684c 2145
9ea28adb 2146Get support packages choose-color.el (or font-lock-extra.el before
214719.30), imenu-go.el from the same place. \(Look for other files there
6c72d195 2148too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
8cfd7987 2149later you should use choose-color.el *instead* of font-lock-extra.el
9ea28adb 2150\(and you will not get smart highlighting in C :-().
c07a80fd 2151
2152Note that to enable Compile choices in the menu you need to install
29043b61 2153mode-compile.el.
c07a80fd 2154
7bcea553
IZ
2155If your Emacs does not default to `cperl-mode' on Perl files, and you
2156want it to: put the following into your .emacs file:
2157
8cfd7987
JH
2158 (autoload 'perl-mode \"cperl-mode\" \"alternate mode for editing Perl programs\" t)
2159
2160or
2161
2162 (defalias 'perl-mode 'cperl-mode)
7bcea553 2163
8cfd7987 2164Get perl5-info from
8f95267c
RGS
2165 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
2166Also, one can generate a newer documentation running `pod2texi' converter
2167 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
c07a80fd 2168
9ea28adb 2169If you use imenu-go, run imenu on perl5-info buffer (you can do it
4584684c
GS
2170from Perl menu). If many files are related, generate TAGS files from
2171Tools/Tags submenu in Perl menu.
9ea28adb 2172
2173If some class structure is too complicated, use Tools/Hierarchy-view
8cfd7987 2174from Perl menu, or hierarchic view of imenu. The second one uses the
499d5216 2175current buffer only, the first one requires generation of TAGS from
4584684c
GS
2176Perl/Tools/Tags menu beforehand.
2177
2178Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
2179
2180Switch auto-help on/off with Perl/Tools/Auto-help.
c07a80fd 2181
4584684c
GS
2182Though with contemporary Emaxen CPerl mode should maintain the correct
2183parsing of Perl even when editing, sometimes it may be lost. Fix this by
499d5216 2184
4584684c 2185 M-x norm RET
55497cff 2186
8cfd7987
JH
2187or
2188
2189 \\[normal-mode]
2190
7bcea553
IZ
2191In cases of more severe confusion sometimes it is helpful to do
2192
2193 M-x load-l RET cperl-mode RET
2194 M-x norm RET
2195
8cfd7987
JH
2196or
2197
2198 \\[load-library] cperl-mode RET
2199 \\[normal-mode]
2200
4584684c
GS
2201Before reporting (non-)problems look in the problem section of online
2202micro-docs on what I know about CPerl problems.")
c07a80fd 2203
2204(defvar cperl-problems 'please-ignore-this-line
8cfd7987
JH
2205 "Description of problems in CPerl mode.
2206Some faces will not be shown on some versions of Emacs unless you
6c72d195 2207install choose-color.el, available from
8f95267c 2208 http://ilyaz.org/software/emacs
6c72d195 2209
7bcea553 2210`fill-paragraph' on a comment may leave the point behind the
8f95267c
RGS
2211paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
2212to detect it and bulk out).
2213
2214See documentation of a variable `cperl-problems-old-emaxen' for the
2215problems which disappear if you upgrade Emacs to a reasonably new
2216version (20.3 for RMS Emacs, and those of 2004 for XEmacs).")
2217
2218(defvar cperl-problems-old-emaxen 'please-ignore-this-line
2219 "Description of problems in CPerl mode specific for older Emacs versions.
7bcea553 2220
6c72d195
IZ
2221Emacs had a _very_ restricted syntax parsing engine until RMS's Emacs
222220.1. Most problems below are corrected starting from this version of
8cfd7987
JH
2223Emacs, and all of them should be fixed in RMS's version 20.3. (Or apply
2224patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
2225this respect (until 2003).
6c72d195 2226
7bcea553
IZ
2227Note that even with newer Emacsen in some very rare cases the details
2228of interaction of `font-lock' and syntaxification may be not cleaned
2229up yet. You may get slightly different colors basing on the order of
2230fontification and syntaxification. Say, the initial faces is correct,
2231but editing the buffer breaks this.
6c72d195
IZ
2232
2233Even with older Emacsen CPerl mode tries to corrects some Emacs
2234misunderstandings, however, for efficiency reasons the degree of
2235correction is different for different operations. The partially
2236corrected problems are: POD sections, here-documents, regexps. The
2237operations are: highlighting, indentation, electric keywords, electric
2238braces.
c07a80fd 2239
2240This may be confusing, since the regexp s#//#/#\; may be highlighted
55497cff 2241as a comment, but it will be recognized as a regexp by the indentation
8cfd7987 2242code. Or the opposite case, when a POD section is highlighted, but
ebcd4dbc
IZ
2243may break the indentation of the following code (though indentation
2244should work if the balance of delimiters is not broken by POD).
c07a80fd 2245
2246The main trick (to make $ a \"backslash\") makes constructions like
6c72d195 2247${aaa} look like unbalanced braces. The only trick I can think of is
8cfd7987 2248to insert it as $ {aaa} (legal in perl5, not in perl4).
c07a80fd 2249
2250Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
6c72d195
IZ
2251as /($|\\s)/. Note that such a transposition is not always possible.
2252
4584684c
GS
2253The solution is to upgrade your Emacs or patch an older one. Note
2254that RMS's 20.2 has some bugs related to `syntax-table' text
2255properties. Patches are available on the main CPerl download site,
2256and on CPAN.
6c72d195
IZ
2257
2258If these bugs cannot be fixed on your machine (say, you have an inferior
2259environment and cannot recompile), you may still disable all the fancy stuff
8cfd7987 2260via `cperl-use-syntax-table-text-property'.")
c07a80fd 2261
2262(defvar cperl-non-problems 'please-ignore-this-line
8f95267c 2263"As you know from `problems' section, Perl syntax is too hard for CPerl on
4584684c
GS
2264older Emacsen. Here is what you can do if you cannot upgrade, or if
2265you want to switch off these capabilities on RMS Emacs 20.2 (+patches) or 20.3
2266or better. Please skip this docs if you run a capable Emacs already.
c07a80fd 2267
6c72d195
IZ
2268Most of the time, if you write your own code, you may find an equivalent
2269\(and almost as readable) expression (what is discussed below is usually
2270not relevant on newer Emacsen, since they can do it automatically).
c07a80fd 2271
ebcd4dbc 2272Try to help CPerl: add comments with embedded quotes to fix CPerl
c07a80fd 2273misunderstandings about the end of quotation:
2274
2275$a='500$'; # ';
2276
6c72d195 2277You won't need it too often. The reason: $ \"quotes\" the following
c07a80fd 2278character (this saves a life a lot of times in CPerl), thus due to
ebcd4dbc 2279Emacs parsing rules it does not consider tick (i.e., ' ) after a
6c72d195
IZ
2280dollar as a closing one, but as a usual character. This is usually
2281correct, but not in the above context.
c07a80fd 2282
6c72d195
IZ
2283Even with older Emacsen the indentation code is pretty wise. The only
2284drawback is that it relied on Emacs parsing to find matching
2285parentheses. And Emacs *could not* match parentheses in Perl 100%
2286correctly. So
c07a80fd 2287 1 if s#//#/#;
6c72d195 2288would not break indentation, but
c07a80fd 2289 1 if ( s#//#/# );
6c72d195 2290would. Upgrade.
c07a80fd 2291
5f05dabc 2292By similar reasons
2293 s\"abc\"def\";
7bcea553 2294could confuse CPerl a lot.
5f05dabc 2295
c07a80fd 2296If you still get wrong indentation in situation that you think the
2297code should be able to parse, try:
2298
2299a) Check what Emacs thinks about balance of your parentheses.
2300b) Supply the code to me (IZ).
2301
6c72d195
IZ
2302Pods were treated _very_ rudimentally. Here-documents were not
2303treated at all (except highlighting and inhibiting indentation). Upgrade.
c07a80fd 2304
2305To speed up coloring the following compromises exist:
2306 a) sub in $mypackage::sub may be highlighted.
2307 b) -z in [a-z] may be highlighted.
2308 c) if your regexp contains a keyword (like \"s\"), it may be highlighted.
9ea28adb 2309
2310
6c72d195 2311Imenu in 19.31 is broken. Set `imenu-use-keymap-menu' to t, and remove
9ea28adb 2312`car' before `imenu-choose-buffer-index' in `imenu'.
8f95267c 2313`imenu-add-to-menubar' in 20.2 is broken.
6c72d195 2314A lot of things on XEmacs may be broken too, judging by bug reports I
7bcea553 2315receive. Note that some releases of XEmacs are better than the others
6c72d195 2316as far as bugs reports I see are concerned.")
c07a80fd 2317
ebcd4dbc 2318(defvar cperl-praise 'please-ignore-this-line
8cfd7987 2319 "Advantages of CPerl mode.
ebcd4dbc
IZ
2320
23210) It uses the newest `syntax-table' property ;-);
2322
23231) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
8cfd7987 2324mode - but the latter number may have improved too in last years) even
4584684c
GS
2325with old Emaxen which do not support `syntax-table' property.
2326
2327When using `syntax-table' property for syntax assist hints, it should
2328handle 99.995% of lines correct - or somesuch. It automatically
2329updates syntax assist hints when you edit your script.
ebcd4dbc 2330
6c72d195 23312) It is generally believed to be \"the most user-friendly Emacs
ebcd4dbc
IZ
2332package\" whatever it may mean (I doubt that the people who say similar
2333things tried _all_ the rest of Emacs ;-), but this was not a lonely
2334voice);
2335
23363) Everything is customizable, one-by-one or in a big sweep;
2337
23384) It has many easily-accessable \"tools\":
2339 a) Can run program, check syntax, start debugger;
2340 b) Can lineup vertically \"middles\" of rows, like `=' in
2341 a = b;
2342 cc = d;
2343 c) Can insert spaces where this impoves readability (in one
2344 interactive sweep over the buffer);
2345 d) Has support for imenu, including:
2346 1) Separate unordered list of \"interesting places\";
2347 2) Separate TOC of POD sections;
2348 3) Separate list of packages;
2349 4) Hierarchical view of methods in (sub)packages;
2350 5) and functions (by the full name - with package);
2351 e) Has an interface to INFO docs for Perl; The interface is
2352 very flexible, including shrink-wrapping of
2353 documentation buffer/frame;
2354 f) Has a builtin list of one-line explanations for perl constructs.
2355 g) Can show these explanations if you stay long enough at the
2356 corresponding place (or on demand);
2357 h) Has an enhanced fontification (using 3 or 4 additional faces
2358 comparing to font-lock - basically, different
2359 namespaces in Perl have different colors);
2360 i) Can construct TAGS basing on its knowledge of Perl syntax,
2361 the standard menu has 6 different way to generate
6c72d195 2362 TAGS (if \"by directory\", .xs files - with C-language
ebcd4dbc
IZ
2363 bindings - are included in the scan);
2364 j) Can build a hierarchical view of classes (via imenu) basing
2365 on generated TAGS file;
2366 k) Has electric parentheses, electric newlines, uses Abbrev
2367 for electric logical constructs
2368 while () {}
2369 with different styles of expansion (context sensitive
6c72d195 2370 to be not so bothering). Electric parentheses behave
ebcd4dbc
IZ
2371 \"as they should\" in a presence of a visible region.
2372 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
6c72d195
IZ
2373 m) Can convert from
2374 if (A) { B }
2375 to
2376 B if A;
ebcd4dbc 2377
20675f5d 2378 n) Highlights (by user-choice) either 3-delimiters constructs
7bcea553
IZ
2379 (such as tr/a/b/), or regular expressions and `y/tr';
2380 o) Highlights trailing whitespace;
2381 p) Is able to manipulate Perl Regular Expressions to ease
2382 conversion to a more readable form.
8f95267c
RGS
2383 q) Can ispell POD sections and HERE-DOCs.
2384 r) Understands comments and character classes inside regular
2385 expressions; can find matching () and [] in a regular expression.
2386 s) Allows indentation of //x-style regular expressions;
2387 t) Highlights different symbols in regular expressions according
2388 to their function; much less problems with backslashitis;
2389 u) Allows to find regular expressions which contain interpolated parts.
20675f5d 2390
ebcd4dbc 23915) The indentation engine was very smart, but most of tricks may be
6c72d195 2392not needed anymore with the support for `syntax-table' property. Has
ebcd4dbc
IZ
2393progress indicator for indentation (with `imenu' loaded).
2394
8cfd7987 23956) Indent-region improves inline-comments as well; also corrects
6c72d195 2396whitespace *inside* the conditional/loop constructs.
ebcd4dbc
IZ
2397
23987) Fill-paragraph correctly handles multi-line comments;
6c72d195
IZ
2399
24008) Can switch to different indentation styles by one command, and restore
2401the settings present before the switch.
2402
8cfd7987 24039) When doing indentation of control constructs, may correct
6c72d195 2404line-breaks/spacing between elements of the construct.
7bcea553
IZ
2405
240610) Uses a linear-time algorith for indentation of regions (on Emaxen with
8f95267c
RGS
2407capable syntax engines).
2408
240911) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
2410")
6c72d195
IZ
2411
2412(defvar cperl-speed 'please-ignore-this-line
2413 "This is an incomplete compendium of what is available in other parts
2414of CPerl documentation. (Please inform me if I skept anything.)
2415
2416There is a perception that CPerl is slower than alternatives. This part
2417of documentation is designed to overcome this misconception.
2418
2419*By default* CPerl tries to enable the most comfortable settings.
2420From most points of view, correctly working package is infinitely more
2421comfortable than a non-correctly working one, thus by default CPerl
2422prefers correctness over speed. Below is the guide how to change
2423settings if your preferences are different.
2424
2425A) Speed of loading the file. When loading file, CPerl may perform a
2426scan which indicates places which cannot be parsed by primitive Emacs
2427syntax-parsing routines, and marks them up so that either
2428
2429 A1) CPerl may work around these deficiencies (for big chunks, mostly
2430 PODs and HERE-documents), or
2431 A2) On capable Emaxen CPerl will use improved syntax-handlings
2432 which reads mark-up hints directly.
2433
2434 The scan in case A2 is much more comprehensive, thus may be slower.
2435
2436 User can disable syntax-engine-helping scan of A2 by setting
2437 `cperl-use-syntax-table-text-property'
2438 variable to nil (if it is set to t).
2439
2440 One can disable the scan altogether (both A1 and A2) by setting
2441 `cperl-pod-here-scan'
2442 to nil.
2443
8cfd7987 2444B) Speed of editing operations.
6c72d195
IZ
2445
2446 One can add a (minor) speedup to editing operations by setting
2447 `cperl-use-syntax-table-text-property'
2448 variable to nil (if it is set to t). This will disable
2449 syntax-engine-helping scan, thus will make many more Perl
2450 constructs be wrongly recognized by CPerl, thus may lead to
2451 wrongly matched parentheses, wrong indentation, etc.
20675f5d
IZ
2452
2453 One can unset `cperl-syntaxify-unwind'. This might speed up editing
8cfd7987 2454 of, say, long POD sections.")
ebcd4dbc 2455
4584684c
GS
2456(defvar cperl-tips-faces 'please-ignore-this-line
2457 "CPerl mode uses following faces for highlighting:
2458
8cfd7987
JH
2459 `cperl-array-face' Array names
2460 `cperl-hash-face' Hash names
2461 `font-lock-comment-face' Comments, PODs and whatever is considered
4584684c 2462 syntaxically to be not code
8cfd7987 2463 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
4584684c 2464 2-arg operators s/y/tr/ or of RExen,
8f95267c
RGS
2465 `font-lock-warning-face' Special-cased m// and s//foo/,
2466 `font-lock-function-name-face' _ as a target of a file tests, file tests,
4584684c
GS
2467 subroutine names at the moment of definition
2468 (except those conflicting with Perl operators),
2469 package names (when recognized), format names
8cfd7987
JH
2470 `font-lock-keyword-face' Control flow switch constructs, declarators
2471 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
2472 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
4584684c
GS
2473 literal parts and the terminator of formats
2474 and whatever is syntaxically considered
2475 as string literals
8cfd7987
JH
2476 `font-lock-type-face' Overridable keywords
2477 `font-lock-variable-name-face' Variable declarations, indirect array and
4584684c 2478 hash names, POD headers/item names
8cfd7987 2479 `cperl-invalid-face' Trailing whitespace
4584684c
GS
2480
2481Note that in several situations the highlighting tries to inform about
2482possible confusion, such as different colors for function names in
2483declarations depending on what they (do not) override, or special cases
2484m// and s/// which do not do what one would expect them to do.
2485
8cfd7987 2486Help with best setup of these faces for printout requested (for each of
4584684c
GS
2487the faces: please specify bold, italic, underline, shadow and box.)
2488
8f95267c
RGS
2489In regular expressions (except character classes):
2490 `font-lock-string-face' \"Normal\" stuff and non-0-length constructs
2491 `font-lock-constant-face': Delimiters
2492 `font-lock-warning-face' Special-cased m// and s//foo/,
2493 Mismatched closing delimiters, parens
2494 we couldn't match, misplaced quantifiers,
2495 unrecognized escape sequences
2496 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
2497 `font-lock-type-face' POSIX classes inside charclasses,
2498 escape sequences with arguments (\x \23 \p \N)
2499 and others match-a-char escape sequences
2500 `font-lock-keyword-face' Capturing parens, and |
2501 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
2502 `font-lock-builtin-face' \"Remaining\" 0-length constructs, executable
2503 parts of a REx, not-capturing parens
2504 `font-lock-variable-name-face' Interpolated constructs, embedded code
2505 `font-lock-comment-face' Embedded comments
2506
2507")
4584684c 2508
4633a7c4
LW
2509\f
2510
2511;;; Portability stuff:
2512
6c72d195 2513(defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
ebcd4dbc
IZ
2514 (` (define-key cperl-mode-map
2515 (, (if xemacs-key
6c72d195
IZ
2516 (` (if cperl-xemacs-p (, xemacs-key) (, emacs-key)))
2517 emacs-key))
ebcd4dbc 2518 (, definition))))
4633a7c4 2519
6c72d195
IZ
2520(defvar cperl-del-back-ch
2521 (car (append (where-is-internal 'delete-backward-char)
2522 (where-is-internal 'backward-delete-char-untabify)))
8cfd7987 2523 "Character generated by key bound to `delete-backward-char'.")
4633a7c4 2524
8cfd7987 2525(and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
6c72d195 2526 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
4633a7c4 2527
6c72d195 2528(defun cperl-mark-active () (mark)) ; Avoid undefined warning
55497cff 2529(if cperl-xemacs-p
9ea28adb 2530 (progn
2531 ;; "Active regions" are on: use region only if active
2532 ;; "Active regions" are off: use region unconditionally
2533 (defun cperl-use-region-p ()
6c72d195 2534 (if zmacs-regions (mark) t)))
4633a7c4 2535 (defun cperl-use-region-p ()
9ea28adb 2536 (if transient-mark-mode mark-active t))
2537 (defun cperl-mark-active () mark-active))
4633a7c4
LW
2538
2539(defsubst cperl-enable-font-lock ()
8cfd7987 2540 cperl-can-font-lock)
4633a7c4 2541
8cfd7987 2542(defun cperl-putback-char (c) ; Emacs 19
6c72d195
IZ
2543 (set 'unread-command-events (list c))) ; Avoid undefined warning
2544
4633a7c4 2545(if (boundp 'unread-command-events)
55497cff 2546 (if cperl-xemacs-p
4633a7c4 2547 (defun cperl-putback-char (c) ; XEmacs >= 19.12
6c72d195 2548 (setq unread-command-events (list (eval '(character-to-event c))))))
4633a7c4 2549 (defun cperl-putback-char (c) ; XEmacs <= 19.11
6c72d195 2550 (set 'unread-command-event (eval '(character-to-event c))))) ; Avoid warnings
4633a7c4
LW
2551
2552(or (fboundp 'uncomment-region)
2553 (defun uncomment-region (beg end)
2554 (interactive "r")
2555 (comment-region beg end -1)))
2556
29043b61 2557(defvar cperl-do-not-fontify
2558 (if (string< emacs-version "19.30")
2559 'fontified
2560 'lazy-lock)
2561 "Text property which inhibits refontification.")
2562
20675f5d
IZ
2563(defsubst cperl-put-do-not-fontify (from to &optional post)
2564 ;; If POST, do not do it with postponed fontification
2565 (if (and post cperl-syntaxify-by-font-lock)
2566 nil
2567 (put-text-property (max (point-min) (1- from))
2568 to cperl-do-not-fontify t)))
9ea28adb 2569
6c72d195 2570(defcustom cperl-mode-hook nil
8cfd7987 2571 "Hook run by CPerl mode."
6c72d195
IZ
2572 :type 'hook
2573 :group 'cperl)
05bbd9c3 2574
6c72d195
IZ
2575(defvar cperl-syntax-state nil)
2576(defvar cperl-syntax-done-to nil)
2577(defvar cperl-emacs-can-parse (> (length (save-excursion
8cfd7987 2578 (parse-partial-sexp (point) (point)))) 9))
6c72d195
IZ
2579\f
2580;; Make customization possible "in reverse"
2581(defsubst cperl-val (symbol &optional default hairy)
2582 (cond
2583 ((eq (symbol-value symbol) 'null) default)
2584 (cperl-hairy (or hairy t))
2585 (t (symbol-value symbol))))
29043b61 2586\f
8f95267c
RGS
2587
2588(defun cperl-make-indent (column &optional minimum keep)
2589 "Makes indent of the current line the requested amount.
2590Unless KEEP, removes the old indentation. Works around a bug in ancient
2591versions of Emacs."
2592 (let ((prop (get-text-property (point) 'syntax-type)))
2593 (or keep
2594 (delete-horizontal-space))
2595 (indent-to column minimum)
2596 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
2597 (and prop
2598 (> (current-column) 0)
2599 (save-excursion
2600 (beginning-of-line)
2601 (or (get-text-property (point) 'syntax-type)
2602 (and (looking-at "\\=[ \t]")
2603 (put-text-property (point) (match-end 0)
2604 'syntax-type prop)))))))
2605
4633a7c4
LW
2606;;; Probably it is too late to set these guys already, but it can help later:
2607
20675f5d
IZ
2608(and cperl-clobber-mode-lists
2609 (setq auto-mode-alist
05bbd9c3 2610 (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
20675f5d
IZ
2611 (and (boundp 'interpreter-mode-alist)
2612 (setq interpreter-mode-alist (append interpreter-mode-alist
2613 '(("miniperl" . perl-mode))))))
4633a7c4
LW
2614(if (fboundp 'eval-when-compile)
2615 (eval-when-compile
8cfd7987
JH
2616 (mapcar (lambda (p)
2617 (condition-case nil
2618 (require p)
2619 (error nil)))
2620 '(imenu easymenu etags timer man info))
7bcea553
IZ
2621 (if (fboundp 'ps-extend-face-list)
2622 (defmacro cperl-ps-extend-face-list (arg)
2623 (` (ps-extend-face-list (, arg))))
2624 (defmacro cperl-ps-extend-face-list (arg)
8cfd7987 2625 (` (error "This version of Emacs has no `ps-extend-face-list'"))))
4633a7c4
LW
2626 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
2627 ;; macros instead of defsubsts don't work on Emacs, so we do the
6c72d195 2628 ;; expansion manually. Any other suggestions?
8cfd7987 2629 (if cperl-can-font-lock
4633a7c4 2630 (require 'font-lock))
6c72d195 2631 (require 'cl)))
4633a7c4
LW
2632
2633(defvar cperl-mode-abbrev-table nil
8cfd7987 2634 "Abbrev table in use in CPerl mode buffers.")
4633a7c4
LW
2635
2636(add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
2637
2638(defvar cperl-mode-map () "Keymap used in CPerl mode.")
2639
2640(if cperl-mode-map nil
2641 (setq cperl-mode-map (make-sparse-keymap))
55497cff 2642 (cperl-define-key "{" 'cperl-electric-lbrace)
2643 (cperl-define-key "[" 'cperl-electric-paren)
2644 (cperl-define-key "(" 'cperl-electric-paren)
2645 (cperl-define-key "<" 'cperl-electric-paren)
2646 (cperl-define-key "}" 'cperl-electric-brace)
2647 (cperl-define-key "]" 'cperl-electric-rparen)
2648 (cperl-define-key ")" 'cperl-electric-rparen)
2649 (cperl-define-key ";" 'cperl-electric-semi)
2650 (cperl-define-key ":" 'cperl-electric-terminator)
2651 (cperl-define-key "\C-j" 'newline-and-indent)
2652 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
6c72d195 2653 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
55497cff 2654 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
2655 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
6c72d195
IZ
2656 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
2657 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
55497cff 2658 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
8f95267c
RGS
2659 (cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
2660 (cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
2661 (cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
2662 (cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
2663 (cperl-define-key "\C-c\C-v" 'cperl-next-interpolated-REx)
2664 (cperl-define-key "\C-c\C-x" 'cperl-next-interpolated-REx-0)
2665 (cperl-define-key "\C-c\C-y" 'cperl-next-interpolated-REx-1)
6c72d195 2666 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
8f95267c
RGS
2667 (cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
2668 (cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
55497cff 2669 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
05bbd9c3
IZ
2670 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
2671 [(control meta |)])
55497cff 2672 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
2673 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
2674 (cperl-define-key "\177" 'cperl-electric-backspace)
2675 (cperl-define-key "\t" 'cperl-indent-command)
2676 ;; don't clobber the backspace binding:
6c72d195
IZ
2677 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
2678 [(control c) (control h) F])
6c72d195
IZ
2679 (if (cperl-val 'cperl-clobber-lisp-bindings)
2680 (progn
2681 (cperl-define-key "\C-hf"
2682 ;;(concat (char-to-string help-char) "f") ; does not work
2683 'cperl-info-on-command
2684 [(control h) f])
2685 (cperl-define-key "\C-hv"
2686 ;;(concat (char-to-string help-char) "v") ; does not work
2687 'cperl-get-help
20675f5d
IZ
2688 [(control h) v])
2689 (cperl-define-key "\C-c\C-hf"
2690 ;;(concat (char-to-string help-char) "f") ; does not work
2691 (key-binding "\C-hf")
2692 [(control c) (control h) f])
2693 (cperl-define-key "\C-c\C-hv"
2694 ;;(concat (char-to-string help-char) "v") ; does not work
2695 (key-binding "\C-hv")
2696 [(control c) (control h) v]))
2697 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
2698 [(control c) (control h) f])
2699 (cperl-define-key "\C-c\C-hv"
2700 ;;(concat (char-to-string help-char) "v") ; does not work
2701 'cperl-get-help
2702 [(control c) (control h) v]))
8cfd7987 2703 (if (and cperl-xemacs-p
4633a7c4
LW
2704 (<= emacs-minor-version 11) (<= emacs-major-version 19))
2705 (progn
2706 ;; substitute-key-definition is usefulness-deenhanced...
8f95267c 2707 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
55497cff 2708 (cperl-define-key "\e;" 'cperl-indent-for-comment)
2709 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
8f95267c
RGS
2710 (or (boundp 'fill-paragraph-function)
2711 (substitute-key-definition
2712 'fill-paragraph 'cperl-fill-paragraph
2713 cperl-mode-map global-map))
4633a7c4
LW
2714 (substitute-key-definition
2715 'indent-sexp 'cperl-indent-exp
2716 cperl-mode-map global-map)
2717 (substitute-key-definition
4633a7c4
LW
2718 'indent-region 'cperl-indent-region
2719 cperl-mode-map global-map)
2720 (substitute-key-definition
2721 'indent-for-comment 'cperl-indent-for-comment
2722 cperl-mode-map global-map)))
2723
05bbd9c3 2724(defvar cperl-menu)
6c72d195
IZ
2725(defvar cperl-lazy-installed)
2726(defvar cperl-old-style nil)
4633a7c4
LW
2727(condition-case nil
2728 (progn
2729 (require 'easymenu)
8cfd7987
JH
2730 (easy-menu-define
2731 cperl-menu cperl-mode-map "Menu for CPerl mode"
2732 '("Perl"
2733 ["Beginning of function" beginning-of-defun t]
2734 ["End of function" end-of-defun t]
2735 ["Mark function" mark-defun t]
2736 ["Indent expression" cperl-indent-exp t]
2737 ["Fill paragraph/comment" cperl-fill-paragraph t]
2738 "----"
2739 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
2740 ["Invert if/unless/while etc" cperl-invert-if-unless t]
2741 ("Regexp"
2742 ["Beautify" cperl-beautify-regexp
2743 cperl-use-syntax-table-text-property]
2744 ["Beautify one level deep" (cperl-beautify-regexp 1)
2745 cperl-use-syntax-table-text-property]
2746 ["Beautify a group" cperl-beautify-level
2747 cperl-use-syntax-table-text-property]
2748 ["Beautify a group one level deep" (cperl-beautify-level 1)
2749 cperl-use-syntax-table-text-property]
2750 ["Contract a group" cperl-contract-level
2751 cperl-use-syntax-table-text-property]
2752 ["Contract groups" cperl-contract-levels
8f95267c
RGS
2753 cperl-use-syntax-table-text-property]
2754 "----"
2755 ["Find next interpolated" cperl-next-interpolated-REx
2756 (next-single-property-change (point-min) 'REx-interpolated)]
2757 ["Find next interpolated (no //o)"
2758 cperl-next-interpolated-REx-0
2759 (or (text-property-any (point-min) (point-max) 'REx-interpolated t)
2760 (text-property-any (point-min) (point-max) 'REx-interpolated 1))]
2761 ["Find next interpolated (neither //o nor whole-REx)"
2762 cperl-next-interpolated-REx-1
2763 (text-property-any (point-min) (point-max) 'REx-interpolated t)])
2764 ["Insert spaces if needed to fix style" cperl-find-bad-style t]
8cfd7987
JH
2765 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
2766 "----"
2767 ["Indent region" cperl-indent-region (cperl-use-region-p)]
2768 ["Comment region" cperl-comment-region (cperl-use-region-p)]
2769 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
2770 "----"
2771 ["Run" mode-compile (fboundp 'mode-compile)]
2772 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
2773 (get-buffer "*compilation*"))]
2774 ["Next error" next-error (get-buffer "*compilation*")]
2775 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
2776 "----"
2777 ["Debugger" cperl-db t]
2778 "----"
2779 ("Tools"
2780 ["Imenu" imenu (fboundp 'imenu)]
8f95267c
RGS
2781 ["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
2782 "----"
2783 ["Ispell PODs" cperl-pod-spell
2784 ;; Better not to update syntaxification here:
2785 ;; debugging syntaxificatio can be broken by this???
2786 (or
2787 (get-text-property (point-min) 'in-pod)
2788 (< (progn
2789 (and cperl-syntaxify-for-menu
2790 (cperl-update-syntaxification (point-max) (point-max)))
2791 (next-single-property-change (point-min) 'in-pod nil (point-max)))
2792 (point-max)))]
2793 ["Ispell HERE-DOCs" cperl-here-doc-spell
2794 (< (progn
2795 (and cperl-syntaxify-for-menu
2796 (cperl-update-syntaxification (point-max) (point-max)))
2797 (next-single-property-change (point-min) 'here-doc-group nil (point-max)))
2798 (point-max))]
2799 ["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
2800 (eq 'here-doc (progn
2801 (and cperl-syntaxify-for-menu
2802 (cperl-update-syntaxification (point) (point)))
2803 (get-text-property (point) 'syntax-type)))]
2804 ["Select this HERE-DOC or POD section"
2805 cperl-select-this-pod-or-here-doc
2806 (memq (progn
2807 (and cperl-syntaxify-for-menu
2808 (cperl-update-syntaxification (point) (point)))
2809 (get-text-property (point) 'syntax-type))
2810 '(here-doc pod))]
2811 "----"
2812 ["CPerl pretty print (exprmntl)" cperl-ps-print
2813 (fboundp 'ps-extend-face-list)]
2814 "----"
2815 ["Syntaxify region" cperl-find-pods-heres-region
2816 (cperl-use-region-p)]
2817 ["Profile syntaxification" cperl-time-fontification t]
2818 ["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
2819 ["Debug unwind for syntactic scan" cperl-toggle-set-debug-unwind t]
2820 ["Debug backtrace on syntactic scan (BEWARE!!!)"
2821 (cperl-toggle-set-debug-unwind nil t) t]
2822 "----"
8cfd7987
JH
2823 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
2824 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
8cfd7987 2825 ("Tags"
9ea28adb 2826;;; ["Create tags for current file" cperl-etags t]
2827;;; ["Add tags for current file" (cperl-etags t) t]
2828;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
2829;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
8cfd7987 2830;;; ["Create tags for Perl files in (sub)directories"
9ea28adb 2831;;; (cperl-etags nil 'recursive) t]
2832;;; ["Add tags for Perl files in (sub)directories"
8cfd7987 2833;;; (cperl-etags t 'recursive) t])
9ea28adb 2834;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
8cfd7987
JH
2835 ["Create tags for current file" (cperl-write-tags nil t) t]
2836 ["Add tags for current file" (cperl-write-tags) t]
2837 ["Create tags for Perl files in directory"
2838 (cperl-write-tags nil t nil t) t]
2839 ["Add tags for Perl files in directory"
2840 (cperl-write-tags nil nil nil t) t]
2841 ["Create tags for Perl files in (sub)directories"
2842 (cperl-write-tags nil t t t) t]
2843 ["Add tags for Perl files in (sub)directories"
2844 (cperl-write-tags nil nil t t) t]))
2845 ("Perl docs"
8f95267c 2846 ["Define word at point" imenu-go-find-at-position
8cfd7987
JH
2847 (fboundp 'imenu-go-find-at-position)]
2848 ["Help on function" cperl-info-on-command t]
2849 ["Help on function at point" cperl-info-on-current-command t]
2850 ["Help on symbol at point" cperl-get-help t]
2851 ["Perldoc" cperl-perldoc t]
2852 ["Perldoc on word at point" cperl-perldoc-at-point t]
2853 ["View manpage of POD in this file" cperl-build-manpage t]
8f95267c 2854 ["Auto-help on" cperl-lazy-install
8cfd7987
JH
2855 (and (fboundp 'run-with-idle-timer)
2856 (not cperl-lazy-installed))]
2857 ["Auto-help off" cperl-lazy-unstall
2858 (and (fboundp 'run-with-idle-timer)
2859 cperl-lazy-installed)])
2860 ("Toggle..."
2861 ["Auto newline" cperl-toggle-auto-newline t]
2862 ["Electric parens" cperl-toggle-electric t]
2863 ["Electric keywords" cperl-toggle-abbrev t]
2864 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
2865 ["Auto-help on Perl constructs" cperl-toggle-autohelp t]
8f95267c 2866 ["Auto fill" auto-fill-mode t])
8cfd7987
JH
2867 ("Indent styles..."
2868 ["CPerl" (cperl-set-style "CPerl") t]
2869 ["PerlStyle" (cperl-set-style "PerlStyle") t]
2870 ["GNU" (cperl-set-style "GNU") t]
2871 ["C++" (cperl-set-style "C++") t]
8f95267c 2872 ["K&R" (cperl-set-style "K&R") t]
8cfd7987
JH
2873 ["BSD" (cperl-set-style "BSD") t]
2874 ["Whitesmith" (cperl-set-style "Whitesmith") t]
8f95267c 2875 ["Memorize Current" (cperl-set-style "Current") t]
8cfd7987
JH
2876 ["Memorized" (cperl-set-style-back) cperl-old-style])
2877 ("Micro-docs"
2878 ["Tips" (describe-variable 'cperl-tips) t]
2879 ["Problems" (describe-variable 'cperl-problems) t]
2880 ["Non-problems" (describe-variable 'cperl-non-problems) t]
2881 ["Speed" (describe-variable 'cperl-speed) t]
2882 ["Praise" (describe-variable 'cperl-praise) t]
2883 ["Faces" (describe-variable 'cperl-tips-faces) t]
2884 ["CPerl mode" (describe-function 'cperl-mode) t]
8f95267c
RGS
2885 ["CPerl version"
2886 (message "The version of master-file for this CPerl is %s"
8cfd7987 2887 cperl-version) t]))))
4633a7c4
LW
2888 (error nil))
2889
2890(autoload 'c-macro-expand "cmacexp"
2891 "Display the result of expanding all C macros occurring in the region.
2892The expansion is entirely correct because it uses the C preprocessor."
2893 t)
2894
8f95267c
RGS
2895;;; These two must be unwound, otherwise take exponential time
2896(defconst cperl-maybe-white-and-comment-rex "[ \t\n]*\\(#[^\n]*\n[ \t\n]*\\)*"
2897"Regular expression to match optional whitespace with interpspersed comments.
2898Should contain exactly one group.")
2899
2900;;; This one is tricky to unwind; still very inefficient...
2901(defconst cperl-white-and-comment-rex "\\([ \t\n]\\|#[^\n]*\n\\)+"
2902"Regular expression to match whitespace with interpspersed comments.
2903Should contain exactly one group.")
2904
2905
2906;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
2907;;; `cperl-outline-regexp', `defun-prompt-regexp'.
2908;;; Details of groups in this may be used in several functions; see comments
2909;;; near mentioned above variable(s)...
2910;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
2911(defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
2912 "Match the text after `sub' in a subroutine declaration.
2913If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
2914of attributes (if present), or end of the name or prototype (whatever is
2915the last)."
2916 (concat ; Assume n groups before this...
2917 "\\(" ; n+1=name-group
2918 cperl-white-and-comment-rex ; n+2=pre-name
2919 "\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
2920 "\\)" ; END n+1=name-group
2921 (if named "" "?")
2922 "\\(" ; n+4=proto-group
2923 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
2924 "\\(([^()]*)\\)" ; n+6=prototype
2925 "\\)?" ; END n+4=proto-group
2926 "\\(" ; n+7=attr-group
2927 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
2928 "\\(" ; n+9=start-attr
2929 ":"
2930 (if attr (concat
2931 "\\("
2932 cperl-maybe-white-and-comment-rex ; whitespace-comments
2933 "\\(\\sw\\|_\\)+" ; attr-name
2934 ;; attr-arg (1 level of internal parens allowed!)
2935 "\\((\\(\\\\.\\|[^\\\\()]\\|([^\\\\()]*)\\)*)\\)?"
2936 "\\(" ; optional : (XXX allows trailing???)
2937 cperl-maybe-white-and-comment-rex ; whitespace-comments
2938 ":\\)?"
2939 "\\)+")
2940 "[^:]")
2941 "\\)"
2942 "\\)?" ; END n+6=proto-group
2943 ))
2944
2945;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
2946;;; and `cperl-outline-level'.
2947;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
8cfd7987
JH
2948(defvar cperl-imenu--function-name-regexp-perl
2949 (concat
8f95267c
RGS
2950 "^\\(" ; 1 = all
2951 "\\([ \t]*package" ; 2 = package-group
2952 "\\(" ; 3 = package-name-group
2953 cperl-white-and-comment-rex ; 4 = pre-package-name
2954 "\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
2955 "\\|"
2956 "[ \t]*sub"
2957 (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
2958 cperl-maybe-white-and-comment-rex ; 15=pre-block
8cfd7987 2959 "\\|"
8f95267c
RGS
2960 "=head\\([1-4]\\)[ \t]+" ; 16=level
2961 "\\([^\n]+\\)$" ; 17=text
8cfd7987
JH
2962 "\\)"))
2963
2964(defvar cperl-outline-regexp
2965 (concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
2966
4633a7c4 2967(defvar cperl-mode-syntax-table nil
8cfd7987 2968 "Syntax table in use in CPerl mode buffers.")
4633a7c4 2969
ebcd4dbc 2970(defvar cperl-string-syntax-table nil
8cfd7987 2971 "Syntax table in use in CPerl mode string-like chunks.")
ebcd4dbc 2972
8f95267c
RGS
2973(defsubst cperl-1- (p)
2974 (max (point-min) (1- p)))
2975
2976(defsubst cperl-1+ (p)
2977 (min (point-max) (1+ p)))
2978
4633a7c4
LW
2979(if cperl-mode-syntax-table
2980 ()
2981 (setq cperl-mode-syntax-table (make-syntax-table))
2982 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
2983 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
2984 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
2985 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
2986 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
2987 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
2988 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
2989 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
2990 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
2991 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
2992 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
2993 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
2994 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
2995 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
2996 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
05bbd9c3
IZ
2997 (if cperl-under-as-char
2998 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
499d5216 2999 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
ebcd4dbc
IZ
3000 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
3001 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
3002 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
8f95267c
RGS
3003 (modify-syntax-entry ?\{ "." cperl-string-syntax-table)
3004 (modify-syntax-entry ?\} "." cperl-string-syntax-table)
8cfd7987 3005 (modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
4633a7c4
LW
3006
3007
3008\f
4633a7c4
LW
3009;; provide an alias for working with emacs 19. the perl-mode that comes
3010;; with it is really bad, and this lets us seamlessly replace it.
6c72d195 3011;;;###autoload
4633a7c4 3012(fset 'perl-mode 'cperl-mode)
6c72d195 3013(defvar cperl-faces-init nil)
05bbd9c3
IZ
3014;; Fix for msb.el
3015(defvar cperl-msb-fixed nil)
6c72d195
IZ
3016(defvar font-lock-syntactic-keywords)
3017(defvar perl-font-lock-keywords)
3018(defvar perl-font-lock-keywords-1)
3019(defvar perl-font-lock-keywords-2)
7bcea553 3020(defvar outline-level)
8cfd7987
JH
3021(if (fboundp 'defvaralias)
3022 (let ((f 'defvaralias)) ; Some functions deduce stuff from the mode name...
3023 (funcall f 'cperl-font-lock-keywords 'perl-font-lock-keywords)
3024 (funcall f 'cperl-font-lock-keywords-1 'perl-font-lock-keywords-1)
3025 (funcall f 'cperl-font-lock-keywords-2 'perl-font-lock-keywords-2)))
3026
3027(defvar cperl-use-major-mode 'perl-mode)
8f95267c
RGS
3028(defvar cperl-font-lock-multiline-start nil)
3029(defvar cperl-font-lock-multiline nil)
3030(defvar cperl-compilation-error-regexp-alist nil)
3031(defvar cperl-font-locking nil)
7bcea553 3032
6c72d195 3033;;;###autoload
4633a7c4
LW
3034(defun cperl-mode ()
3035 "Major mode for editing Perl code.
3036Expression and list commands understand all C brackets.
3037Tab indents for Perl code.
3038Paragraphs are separated by blank lines only.
3039Delete converts tabs to spaces as it moves back.
3040
3041Various characters in Perl almost always come in pairs: {}, (), [],
6c72d195 3042sometimes <>. When the user types the first, she gets the second as
4633a7c4
LW
3043well, with optional special formatting done on {}. (Disabled by
3044default.) You can always quote (with \\[quoted-insert]) the left
6c72d195 3045\"paren\" to avoid the expansion. The processing of < is special,
8cfd7987 3046since most the time you mean \"less\". CPerl mode tries to guess
4633a7c4 3047whether you want to type pair <>, and inserts is if it
6c72d195 3048appropriate. You can set `cperl-electric-parens-string' to the string that
4633a7c4 3049contains the parenths from the above list you want to be electrical.
9ea28adb 3050Electricity of parenths is controlled by `cperl-electric-parens'.
3051You may also set `cperl-electric-parens-mark' to have electric parens
3052look for active mark and \"embrace\" a region if possible.'
4633a7c4
LW
3053
3054CPerl mode provides expansion of the Perl control constructs:
6c72d195 3055
8cfd7987 3056 if, else, elsif, unless, while, until, continue, do,
6c72d195
IZ
3057 for, foreach, formy and foreachmy.
3058
3059and POD directives (Disabled by default, see `cperl-electric-keywords'.)
3060
3061The user types the keyword immediately followed by a space, which
3062causes the construct to be expanded, and the point is positioned where
3063she is most likely to want to be. eg. when the user types a space
3064following \"if\" the following appears in the buffer: if () { or if ()
3065} { } and the cursor is between the parentheses. The user can then
3066type some boolean expression within the parens. Having done that,
3067typing \\[cperl-linefeed] places you - appropriately indented - on a
3068new line between the braces (if you typed \\[cperl-linefeed] in a POD
8cfd7987 3069directive line, then appropriate number of new lines is inserted).
6c72d195
IZ
3070
3071If CPerl decides that you want to insert \"English\" style construct like
3072
4633a7c4 3073 bite if angry;
6c72d195
IZ
3074
3075it will not do any expansion. See also help on variable
3076`cperl-extra-newline-before-brace'. (Note that one can switch the
3077help message on expansion by setting `cperl-message-electric-keyword'
3078to nil.)
4633a7c4 3079
55497cff 3080\\[cperl-linefeed] is a convenience replacement for typing carriage
6c72d195 3081return. It places you in the next line with proper indentation, or if
4633a7c4 3082you type it inside the inline block of control construct, like
6c72d195 3083
4633a7c4 3084 foreach (@lines) {print; print}
6c72d195 3085
4633a7c4
LW
3086and you are on a boundary of a statement inside braces, it will
3087transform the construct into a multiline and will place you into an
8cfd7987
JH
3088appropriately indented blank line. If you need a usual
3089`newline-and-indent' behaviour, it is on \\[newline-and-indent],
4633a7c4
LW
3090see documentation on `cperl-electric-linefeed'.
3091
6c72d195
IZ
3092Use \\[cperl-invert-if-unless] to change a construction of the form
3093
3094 if (A) { B }
3095
3096into
3097
3098 B if A;
3099
4633a7c4
LW
3100\\{cperl-mode-map}
3101
6c72d195
IZ
3102Setting the variable `cperl-font-lock' to t switches on font-lock-mode
3103\(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
3104on electric space between $ and {, `cperl-electric-parens-string' is
3105the string that contains parentheses that should be electric in CPerl
3106\(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
9ea28adb 3107setting `cperl-electric-keywords' enables electric expansion of
6c72d195
IZ
3108control structures in CPerl. `cperl-electric-linefeed' governs which
3109one of two linefeed behavior is preferable. You can enable all these
9ea28adb 3110options simultaneously (recommended mode of use) by setting
6c72d195
IZ
3111`cperl-hairy' to t. In this case you can switch separate options off
3112by setting them to `null'. Note that one may undo the extra
3113whitespace inserted by semis and braces in `auto-newline'-mode by
3114consequent \\[cperl-electric-backspace].
4633a7c4
LW
3115
3116If your site has perl5 documentation in info format, you can use commands
3117\\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
3118These keys run commands `cperl-info-on-current-command' and
3119`cperl-info-on-command', which one is which is controlled by variable
8cfd7987 3120`cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
6c72d195 3121\(in turn affected by `cperl-hairy').
4633a7c4 3122
55497cff 3123Even if you have no info-format documentation, short one-liner-style
6c72d195
IZ
3124help is available on \\[cperl-get-help], and one can run perldoc or
3125man via menu.
55497cff 3126
6c72d195
IZ
3127It is possible to show this help automatically after some idle time.
3128This is regulated by variable `cperl-lazy-help-time'. Default with
3129`cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
3130secs idle time . It is also possible to switch this on/off from the
3131menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
55497cff 3132
ebcd4dbc
IZ
3133Use \\[cperl-lineup] to vertically lineup some construction - put the
3134beginning of the region at the start of construction, and make region
3135span the needed amount of lines.
3136
c07a80fd 3137Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
8cfd7987 3138`cperl-pod-face', `cperl-pod-head-face' control processing of POD and
6c72d195
IZ
3139here-docs sections. With capable Emaxen results of scan are used
3140for indentation too, otherwise they are used for highlighting only.
c07a80fd 3141
4633a7c4
LW
3142Variables controlling indentation style:
3143 `cperl-tab-always-indent'
3144 Non-nil means TAB in CPerl mode should always reindent the current line,
3145 regardless of where in the line point is when the TAB command is used.
6c72d195
IZ
3146 `cperl-indent-left-aligned-comments'
3147 Non-nil means that the comment starting in leftmost column should indent.
4633a7c4
LW
3148 `cperl-auto-newline'
3149 Non-nil means automatically newline before and after braces,
6c72d195 3150 and after colons and semicolons, inserted in Perl code. The following
9ea28adb 3151 \\[cperl-electric-backspace] will remove the inserted whitespace.
8cfd7987
JH
3152 Insertion after colons requires both this variable and
3153 `cperl-auto-newline-after-colon' set.
9ea28adb 3154 `cperl-auto-newline-after-colon'
3155 Non-nil means automatically newline even after colons.
3156 Subject to `cperl-auto-newline' setting.
4633a7c4
LW
3157 `cperl-indent-level'
3158 Indentation of Perl statements within surrounding block.
3159 The surrounding block's indentation is the indentation
3160 of the line on which the open-brace appears.
3161 `cperl-continued-statement-offset'
3162 Extra indentation given to a substatement, such as the
3163 then-clause of an if, or body of a while, or just a statement continuation.
3164 `cperl-continued-brace-offset'
3165 Extra indentation given to a brace that starts a substatement.
3166 This is in addition to `cperl-continued-statement-offset'.
3167 `cperl-brace-offset'
3168 Extra indentation for line if it starts with an open brace.
3169 `cperl-brace-imaginary-offset'
3170 An open brace following other text is treated as if it the line started
3171 this far to the right of the actual line indentation.
3172 `cperl-label-offset'
3173 Extra indentation for line that is a label.
3174 `cperl-min-label-indent'
3175 Minimal indentation for line that is a label.
3176
8f95267c
RGS
3177Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
3178 `cperl-indent-level' 5 4 2 4
3179 `cperl-brace-offset' 0 0 0 0
3180 `cperl-continued-brace-offset' -5 -4 0 0
3181 `cperl-label-offset' -5 -4 -2 -4
3182 `cperl-continued-statement-offset' 5 4 2 4
4633a7c4 3183
6c72d195
IZ
3184CPerl knows several indentation styles, and may bulk set the
3185corresponding variables. Use \\[cperl-set-style] to do this. Use
3186\\[cperl-set-style-back] to restore the memorized preexisting values
8f95267c
RGS
3187\(both available from menu). See examples in `cperl-style-examples'.
3188
3189Part of the indentation style is how different parts of if/elsif/else
3190statements are broken into lines; in CPerl, this is reflected on how
3191templates for these constructs are created (controlled by
3192`cperl-extra-newline-before-brace'), and how reflow-logic should treat \"continuation\" blocks of else/elsif/continue, controlled by the same variable,
3193and by `cperl-extra-newline-before-brace-multiline',
3194`cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
6c72d195
IZ
3195
3196If `cperl-indent-level' is 0, the statement after opening brace in
8cfd7987 3197column 0 is indented on
6c72d195 3198`cperl-brace-offset'+`cperl-continued-statement-offset'.
4633a7c4
LW
3199
3200Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
6c72d195
IZ
3201with no args.
3202
3203DO NOT FORGET to read micro-docs (available from `Perl' menu)
3204or as help on variables `cperl-tips', `cperl-problems',
3205`cperl-non-problems', `cperl-praise', `cperl-speed'."
4633a7c4
LW
3206 (interactive)
3207 (kill-all-local-variables)
4633a7c4
LW
3208 (use-local-map cperl-mode-map)
3209 (if (cperl-val 'cperl-electric-linefeed)
3210 (progn
3211 (local-set-key "\C-J" 'cperl-linefeed)
3212 (local-set-key "\C-C\C-J" 'newline-and-indent)))
6c72d195
IZ
3213 (if (and
3214 (cperl-val 'cperl-clobber-lisp-bindings)
3215 (cperl-val 'cperl-info-on-command-no-prompt))
4633a7c4 3216 (progn
55497cff 3217 ;; don't clobber the backspace binding:
3218 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
3219 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
3220 [(control c) (control h) f])))
8cfd7987 3221 (setq major-mode cperl-use-major-mode)
4633a7c4
LW
3222 (setq mode-name "CPerl")
3223 (if (not cperl-mode-abbrev-table)
3224 (let ((prev-a-c abbrevs-changed))
3225 (define-abbrev-table 'cperl-mode-abbrev-table '(
3226 ("if" "if" cperl-electric-keyword 0)
3227 ("elsif" "elsif" cperl-electric-keyword 0)
3228 ("while" "while" cperl-electric-keyword 0)
3229 ("until" "until" cperl-electric-keyword 0)
3230 ("unless" "unless" cperl-electric-keyword 0)
3231 ("else" "else" cperl-electric-else 0)
6c72d195 3232 ("continue" "continue" cperl-electric-else 0)
4633a7c4
LW
3233 ("for" "for" cperl-electric-keyword 0)
3234 ("foreach" "foreach" cperl-electric-keyword 0)
6c72d195
IZ
3235 ("formy" "formy" cperl-electric-keyword 0)
3236 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
3237 ("do" "do" cperl-electric-keyword 0)
7bcea553
IZ
3238 ("=pod" "=pod" cperl-electric-pod 0)
3239 ("=over" "=over" cperl-electric-pod 0)
3240 ("=head1" "=head1" cperl-electric-pod 0)
3241 ("=head2" "=head2" cperl-electric-pod 0)
6c72d195
IZ
3242 ("pod" "pod" cperl-electric-pod 0)
3243 ("over" "over" cperl-electric-pod 0)
3244 ("head1" "head1" cperl-electric-pod 0)
3245 ("head2" "head2" cperl-electric-pod 0)))
4633a7c4
LW
3246 (setq abbrevs-changed prev-a-c)))
3247 (setq local-abbrev-table cperl-mode-abbrev-table)
8f95267c
RGS
3248 (if (cperl-val 'cperl-electric-keywords)
3249 (abbrev-mode 1))
4633a7c4 3250 (set-syntax-table cperl-mode-syntax-table)
8f95267c
RGS
3251 ;; Until Emacs is multi-threaded, we do not actually need it local:
3252 (make-local-variable 'cperl-font-lock-multiline-start)
3253 (make-local-variable 'cperl-font-locking)
7bcea553
IZ
3254 (make-local-variable 'outline-regexp)
3255 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
3256 (setq outline-regexp cperl-outline-regexp)
3257 (make-local-variable 'outline-level)
3258 (setq outline-level 'cperl-outline-level)
4633a7c4
LW
3259 (make-local-variable 'paragraph-start)
3260 (setq paragraph-start (concat "^$\\|" page-delimiter))
3261 (make-local-variable 'paragraph-separate)
3262 (setq paragraph-separate paragraph-start)
3263 (make-local-variable 'paragraph-ignore-fill-prefix)
3264 (setq paragraph-ignore-fill-prefix t)
8f95267c
RGS
3265 (if cperl-xemacs-p
3266 (progn
3267 (make-local-variable 'paren-backwards-message)
3268 (set 'paren-backwards-message t)))
4633a7c4
LW
3269 (make-local-variable 'indent-line-function)
3270 (setq indent-line-function 'cperl-indent-line)
3271 (make-local-variable 'require-final-newline)
3272 (setq require-final-newline t)
3273 (make-local-variable 'comment-start)
3274 (setq comment-start "# ")
3275 (make-local-variable 'comment-end)
3276 (setq comment-end "")
3277 (make-local-variable 'comment-column)
3278 (setq comment-column cperl-comment-column)
3279 (make-local-variable 'comment-start-skip)
3280 (setq comment-start-skip "#+ *")
3281 (make-local-variable 'defun-prompt-regexp)
8f95267c
RGS
3282;;; "[ \t]*sub"
3283;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
3284;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
3285 (setq defun-prompt-regexp
3286 (concat "[ \t]*\\(sub"
3287 (cperl-after-sub-regexp 'named 'attr-groups)
3288 "\\|" ; per toke.c
3289 "\\(BEGIN\\|CHECK\\|INIT\\|END\\|AUTOLOAD\\|DESTROY\\)"
3290 "\\)"
3291 cperl-maybe-white-and-comment-rex))
4633a7c4
LW
3292 (make-local-variable 'comment-indent-function)
3293 (setq comment-indent-function 'cperl-comment-indent)
8f95267c
RGS
3294 (and (boundp 'fill-paragraph-function)
3295 (progn
3296 (make-local-variable 'fill-paragraph-function)
3297 (set 'fill-paragraph-function 'cperl-fill-paragraph)))
4633a7c4
LW
3298 (make-local-variable 'parse-sexp-ignore-comments)
3299 (setq parse-sexp-ignore-comments t)
3300 (make-local-variable 'indent-region-function)
3301 (setq indent-region-function 'cperl-indent-region)
3302 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
3303 (make-local-variable 'imenu-create-index-function)
3304 (setq imenu-create-index-function
8cfd7987 3305 (function cperl-imenu--create-perl-index))
c07a80fd 3306 (make-local-variable 'imenu-sort-function)
3307 (setq imenu-sort-function nil)
8f95267c
RGS
3308 (make-local-variable 'vc-rcs-header)
3309 (set 'vc-rcs-header cperl-vc-rcs-header)
3310 (make-local-variable 'vc-sccs-header)
3311 (set 'vc-sccs-header cperl-vc-sccs-header)
3312 ;; This one is obsolete...
4633a7c4 3313 (make-local-variable 'vc-header-alist)
8f95267c
RGS
3314 (set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
3315 (` ((SCCS (, (car cperl-vc-sccs-header)))
3316 (RCS (, (car cperl-vc-rcs-header)))))))
3317 (cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
3318 (make-local-variable 'compilation-error-regexp-alist-alist)
3319 (set 'compilation-error-regexp-alist-alist
3320 (cons (cons 'cperl cperl-compilation-error-regexp-alist)
3321 (symbol-value 'compilation-error-regexp-alist-alist)))
3322 (let ((f 'compilation-build-compilation-error-regexp-alist))
3323 (funcall f)))
3324 ((boundp 'compilation-error-regexp-alist);; xmeacs 19.x
3325 (make-local-variable 'compilation-error-regexp-alist)
3326 (set 'compilation-error-regexp-alist
3327 (cons cperl-compilation-error-regexp-alist
3328 (symbol-value 'compilation-error-regexp-alist)))))
c07a80fd 3329 (make-local-variable 'font-lock-defaults)
3330 (setq font-lock-defaults
6c72d195
IZ
3331 (cond
3332 ((string< emacs-version "19.30")
8f95267c 3333 '(perl-font-lock-keywords-2 nil nil ((?_ . "w"))))
6c72d195 3334 ((string< emacs-version "19.33") ; Which one to use?
c07a80fd 3335 '((perl-font-lock-keywords
3336 perl-font-lock-keywords-1
8f95267c 3337 perl-font-lock-keywords-2) nil nil ((?_ . "w"))))
6c72d195
IZ
3338 (t
3339 '((cperl-load-font-lock-keywords
3340 cperl-load-font-lock-keywords-1
8f95267c 3341 cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
6c72d195 3342 (make-local-variable 'cperl-syntax-state)
8f95267c 3343 (setq cperl-syntax-state nil) ; reset syntaxification cache
ebcd4dbc
IZ
3344 (if cperl-use-syntax-table-text-property
3345 (progn
8cfd7987 3346 (make-local-variable 'parse-sexp-lookup-properties)
05bbd9c3 3347 ;; Do not introduce variable if not needed, we check it!
6c72d195
IZ
3348 (set 'parse-sexp-lookup-properties t)
3349 ;; Fix broken font-lock:
3350 (or (boundp 'font-lock-unfontify-region-function)
3351 (set 'font-lock-unfontify-region-function
8cfd7987 3352 'font-lock-default-unfontify-region))
8f95267c
RGS
3353 (unless cperl-xemacs-p ; Our: just a plug for wrong font-lock
3354 (make-local-variable 'font-lock-unfontify-region-function)
3355 (set 'font-lock-unfontify-region-function ; not present with old Emacs
3356 'cperl-font-lock-unfontify-region-function))
8cfd7987 3357 (make-local-variable 'cperl-syntax-done-to)
8f95267c 3358 (setq cperl-syntax-done-to nil) ; reset syntaxification cache
6c72d195
IZ
3359 ;; Another bug: unless font-lock-syntactic-keywords, font-lock
3360 ;; ignores syntax-table text-property. (t) is a hack
3361 ;; to make font-lock think that font-lock-syntactic-keywords
3362 ;; are defined
8cfd7987
JH
3363 (make-local-variable 'font-lock-syntactic-keywords)
3364 (setq font-lock-syntactic-keywords
6c72d195
IZ
3365 (if cperl-syntaxify-by-font-lock
3366 '(t (cperl-fontify-syntaxically))
3367 '(t)))))
8f95267c
RGS
3368 (if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
3369 (progn
3370 (setq cperl-font-lock-multiline t) ; Not localized...
3371 (set (make-local-variable 'font-lock-multiline) t))
3372 (make-local-variable 'font-lock-fontify-region-function)
3373 (set 'font-lock-fontify-region-function ; not present with old Emacs
3374 'cperl-font-lock-fontify-region-function))
3375 (make-local-variable 'font-lock-fontify-region-function)
3376 (set 'font-lock-fontify-region-function ; not present with old Emacs
3377 'cperl-font-lock-fontify-region-function)
6c72d195 3378 (make-local-variable 'cperl-old-style)
8cfd7987
JH
3379 (if (boundp 'normal-auto-fill-function) ; 19.33 and later
3380 (set (make-local-variable 'normal-auto-fill-function)
3381 'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
3382 (or (fboundp 'cperl-old-auto-fill-mode)
3383 (progn
3384 (fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
3385 (defun auto-fill-mode (&optional arg)
3386 (interactive "P")
3387 (eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
3388 (and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
3389 (setq auto-fill-function 'cperl-do-auto-fill))))))
4633a7c4 3390 (if (cperl-enable-font-lock)
8cfd7987 3391 (if (cperl-val 'cperl-font-lock)
c07a80fd 3392 (progn (or cperl-faces-init (cperl-init-faces))
3393 (font-lock-mode 1))))
8f95267c
RGS
3394 (set (make-local-variable 'facemenu-add-face-function)
3395 'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
4633a7c4
LW
3396 (and (boundp 'msb-menu-cond)
3397 (not cperl-msb-fixed)
3398 (cperl-msb-fix))
55497cff 3399 (if (featurep 'easymenu)
6c72d195 3400 (easy-menu-add cperl-menu)) ; A NOP in RMS Emacs.
c07a80fd 3401 (run-hooks 'cperl-mode-hook)
8f95267c
RGS
3402 (if cperl-hook-after-change
3403 (progn
3404 (make-local-hook 'after-change-functions)
3405 (add-hook 'after-change-functions 'cperl-after-change-function nil t)))
c07a80fd 3406 ;; After hooks since fontification will break this
8cfd7987
JH
3407 (if cperl-pod-here-scan
3408 (or cperl-syntaxify-by-font-lock
6c72d195
IZ
3409 (progn (or cperl-faces-init (cperl-init-faces-weak))
3410 (cperl-find-pods-heres)))))
4633a7c4 3411\f
499d5216
IZ
3412;; Fix for perldb - make default reasonable
3413(defun cperl-db ()
3414 (interactive)
3415 (require 'gud)
3416 (perldb (read-from-minibuffer "Run perldb (like this): "
3417 (if (consp gud-perldb-history)
3418 (car gud-perldb-history)
3419 (concat "perl " ;;(file-name-nondirectory
8cfd7987
JH
3420 ;; I have problems
3421 ;; in OS/2
3422 ;; otherwise
3423 (buffer-file-name)))
499d5216
IZ
3424 nil nil
3425 '(gud-perldb-history . 1))))
3426\f
4633a7c4
LW
3427(defun cperl-msb-fix ()
3428 ;; Adds perl files to msb menu, supposes that msb is already loaded
3429 (setq cperl-msb-fixed t)
3430 (let* ((l (length msb-menu-cond))
3431 (last (nth (1- l) msb-menu-cond))
3432 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
3433 (handle (1- (nth 1 last))))
3434 (setcdr precdr (list
3435 (list
8cfd7987 3436 '(memq major-mode '(cperl-mode perl-mode))
4633a7c4
LW
3437 handle
3438 "Perl Files (%d)")
3439 last))))
3440\f
3441;; This is used by indent-for-comment
3442;; to decide how much to indent a comment in CPerl code
6c72d195 3443;; based on its context. Do fallback if comment is found wrong.
4633a7c4
LW
3444
3445(defvar cperl-wrong-comment)
4584684c
GS
3446(defvar cperl-st-cfence '(14)) ; Comment-fence
3447(defvar cperl-st-sfence '(15)) ; String-fence
3448(defvar cperl-st-punct '(1))
3449(defvar cperl-st-word '(2))
3450(defvar cperl-st-bra '(4 . ?\>))
3451(defvar cperl-st-ket '(5 . ?\<))
3452
4633a7c4 3453
8f95267c 3454(defun cperl-comment-indent () ; called at point at supposed comment
4584684c 3455 (let ((p (point)) (c (current-column)) was phony)
8f95267c
RGS
3456 (if (and (not cperl-indent-comment-at-column-0)
3457 (looking-at "^#"))
3458 0 ; Existing comment at bol stays there.
4633a7c4
LW
3459 ;; Wrong comment found
3460 (save-excursion
4584684c
GS
3461 (setq was (cperl-to-comment-or-eol)
3462 phony (eq (get-text-property (point) 'syntax-table)
3463 cperl-st-cfence))
3464 (if phony
8f95267c 3465 (progn ; Too naive???
4584684c
GS
3466 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
3467 (if (eq (preceding-char) ?\#)
3468 (forward-char -1))
3469 (setq was nil)))
8f95267c 3470 (if (= (point) p) ; Our caller found a correct place
4633a7c4
LW
3471 (progn
3472 (skip-chars-backward " \t")
8f95267c
RGS
3473 (setq was (current-column))
3474 (if (eq was 0)
3475 comment-column
3476 (max (1+ was) ; Else indent at comment column
3477 comment-column)))
3478 ;; No, the caller found a random place; we need to edit ourselves
4633a7c4
LW
3479 (if was nil
3480 (insert comment-start)
3481 (backward-char (length comment-start)))
3482 (setq cperl-wrong-comment t)
8f95267c
RGS
3483 (cperl-make-indent comment-column 1) ; Indent min 1
3484 c)))))
4633a7c4
LW
3485
3486;;;(defun cperl-comment-indent-fallback ()
3487;;; "Is called if the standard comment-search procedure fails.
3488;;;Point is at start of real comment."
3489;;; (let ((c (current-column)) target cnt prevc)
3490;;; (if (= c comment-column) nil
3491;;; (setq cnt (skip-chars-backward "[ \t]"))
8cfd7987 3492;;; (setq target (max (1+ (setq prevc
4633a7c4
LW
3493;;; (current-column))) ; Else indent at comment column
3494;;; comment-column))
3495;;; (if (= c comment-column) nil
3496;;; (delete-backward-char cnt)
3497;;; (while (< prevc target)
3498;;; (insert "\t")
3499;;; (setq prevc (current-column)))
3500;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
3501;;; (while (< prevc target)
3502;;; (insert " ")
3503;;; (setq prevc (current-column)))))))
3504
3505(defun cperl-indent-for-comment ()
55497cff 3506 "Substitute for `indent-for-comment' in CPerl."
4633a7c4
LW
3507 (interactive)
3508 (let (cperl-wrong-comment)
3509 (indent-for-comment)
8f95267c 3510 (if cperl-wrong-comment ; set by `cperl-comment-indent'
4633a7c4
LW
3511 (progn (cperl-to-comment-or-eol)
3512 (forward-char (length comment-start))))))
3513
499d5216
IZ
3514(defun cperl-comment-region (b e arg)
3515 "Comment or uncomment each line in the region in CPerl mode.
3516See `comment-region'."
3517 (interactive "r\np")
3518 (let ((comment-start "#"))
3519 (comment-region b e arg)))
3520
3521(defun cperl-uncomment-region (b e arg)
3522 "Uncomment or comment each line in the region in CPerl mode.
3523See `comment-region'."
3524 (interactive "r\np")
3525 (let ((comment-start "#"))
3526 (comment-region b e (- arg))))
3527
55497cff 3528(defvar cperl-brace-recursing nil)
3529
4633a7c4
LW
3530(defun cperl-electric-brace (arg &optional only-before)
3531 "Insert character and correct line's indentation.
3532If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
6c72d195 3533place (even in empty line), but not after. If after \")\" and the inserted
8cfd7987 3534char is \"{\", insert extra newline before only if
9ea28adb 3535`cperl-extra-newline-before-brace'."
4633a7c4 3536 (interactive "P")
55497cff 3537 (let (insertpos
3538 (other-end (if (and cperl-electric-parens-mark
8cfd7987 3539 (cperl-mark-active)
55497cff 3540 (< (mark) (point)))
8cfd7987 3541 (mark)
55497cff 3542 nil)))
3543 (if (and other-end
3544 (not cperl-brace-recursing)
3545 (cperl-val 'cperl-electric-parens)
3546 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
3547 ;; Need to insert a matching pair
4633a7c4 3548 (progn
4633a7c4 3549 (save-excursion
55497cff 3550 (setq insertpos (point-marker))
3551 (goto-char other-end)
3552 (setq last-command-char ?\{)
3553 (cperl-electric-lbrace arg insertpos))
3554 (forward-char 1))
8cfd7987 3555 ;; Check whether we close something "usual" with `}'
6c72d195 3556 (if (and (eq last-command-char ?\})
8cfd7987 3557 (not
6c72d195
IZ
3558 (condition-case nil
3559 (save-excursion
3560 (up-list (- (prefix-numeric-value arg)))
3561 ;;(cperl-after-block-p (point-min))
8cfd7987
JH
3562 (or (cperl-after-expr-p nil "{;)")
3563 ;; after sub, else, continue
3564 (cperl-after-block-p nil 'pre)))
6c72d195
IZ
3565 (error nil))))
3566 ;; Just insert the guy
3567 (self-insert-command (prefix-numeric-value arg))
3568 (if (and (not arg) ; No args, end (of empty line or auto)
3569 (eolp)
3570 (or (and (null only-before)
3571 (save-excursion
3572 (skip-chars-backward " \t")
3573 (bolp)))
3574 (and (eq last-command-char ?\{) ; Do not insert newline
3575 ;; if after ")" and `cperl-extra-newline-before-brace'
3576 ;; is nil, do not insert extra newline.
3577 (not cperl-extra-newline-before-brace)
3578 (save-excursion
3579 (skip-chars-backward " \t")
3580 (eq (preceding-char) ?\))))
8cfd7987 3581 (if cperl-auto-newline
6c72d195
IZ
3582 (progn (cperl-indent-line) (newline) t) nil)))
3583 (progn
3584 (self-insert-command (prefix-numeric-value arg))
3585 (cperl-indent-line)
3586 (if cperl-auto-newline
3587 (setq insertpos (1- (point))))
3588 (if (and cperl-auto-newline (null only-before))
3589 (progn
3590 (newline)
3591 (cperl-indent-line)))
3592 (save-excursion
3593 (if insertpos (progn (goto-char insertpos)
8cfd7987 3594 (search-forward (make-string
6c72d195
IZ
3595 1 last-command-char))
3596 (setq insertpos (1- (point)))))
3597 (delete-char -1))))
3598 (if insertpos
55497cff 3599 (save-excursion
6c72d195
IZ
3600 (goto-char insertpos)
3601 (self-insert-command (prefix-numeric-value arg)))
3602 (self-insert-command (prefix-numeric-value arg)))))))
4633a7c4 3603
55497cff 3604(defun cperl-electric-lbrace (arg &optional end)
4633a7c4
LW
3605 "Insert character, correct line's indentation, correct quoting by space."
3606 (interactive "P")
8cfd7987
JH
3607 (let ((cperl-brace-recursing t)
3608 (cperl-auto-newline cperl-auto-newline)
3609 (other-end (or end
3610 (if (and cperl-electric-parens-mark
3611 (cperl-mark-active)
3612 (> (mark) (point)))
3613 (save-excursion
3614 (goto-char (mark))
3615 (point-marker))
3616 nil)))
3617 pos after)
4633a7c4
LW
3618 (and (cperl-val 'cperl-electric-lbrace-space)
3619 (eq (preceding-char) ?$)
3620 (save-excursion
3621 (skip-chars-backward "$")
3622 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
3ee700d1 3623 (insert ?\ ))
6c72d195 3624 ;; Check whether we are in comment
8cfd7987 3625 (if (and
6c72d195
IZ
3626 (save-excursion
3627 (beginning-of-line)
3628 (not (looking-at "[ \t]*#")))
3629 (cperl-after-expr-p nil "{;)"))
3630 nil
3631 (setq cperl-auto-newline nil))
4633a7c4 3632 (cperl-electric-brace arg)
9ea28adb 3633 (and (cperl-val 'cperl-electric-parens)
3634 (eq last-command-char ?{)
8cfd7987 3635 (memq last-command-char
9ea28adb 3636 (append cperl-electric-parens-string nil))
3637 (or (if other-end (goto-char (marker-position other-end)))
3638 t)
4633a7c4
LW
3639 (setq last-command-char ?} pos (point))
3640 (progn (cperl-electric-brace arg t)
3641 (goto-char pos)))))
3642
3643(defun cperl-electric-paren (arg)
8cfd7987
JH
3644 "Insert an opening parenthesis or a matching pair of parentheses.
3645See `cperl-electric-parens'."
4633a7c4 3646 (interactive "P")
9ea28adb 3647 (let ((beg (save-excursion (beginning-of-line) (point)))
3648 (other-end (if (and cperl-electric-parens-mark
8cfd7987 3649 (cperl-mark-active)
9ea28adb 3650 (> (mark) (point)))
8cfd7987
JH
3651 (save-excursion
3652 (goto-char (mark))
3653 (point-marker))
9ea28adb 3654 nil)))
3655 (if (and (cperl-val 'cperl-electric-parens)
3656 (memq last-command-char
3657 (append cperl-electric-parens-string nil))
4633a7c4
LW
3658 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
3659 ;;(not (save-excursion (search-backward "#" beg t)))
3660 (if (eq last-command-char ?<)
3ee700d1
IZ
3661 (progn
3662 (and abbrev-mode ; later it is too late, may be after `for'
3663 (expand-abbrev))
3664 (cperl-after-expr-p nil "{;(,:="))
4633a7c4
LW
3665 1))
3666 (progn
3ee700d1 3667 (self-insert-command (prefix-numeric-value arg))
9ea28adb 3668 (if other-end (goto-char (marker-position other-end)))
8cfd7987 3669 (insert (make-string
3ee700d1
IZ
3670 (prefix-numeric-value arg)
3671 (cdr (assoc last-command-char '((?{ .?})
3672 (?[ . ?])
3673 (?( . ?))
3674 (?< . ?>))))))
3675 (forward-char (- (prefix-numeric-value arg))))
3676 (self-insert-command (prefix-numeric-value arg)))))
4633a7c4 3677
55497cff 3678(defun cperl-electric-rparen (arg)
3679 "Insert a matching pair of parentheses if marking is active.
8cfd7987
JH
3680If not, or if we are not at the end of marking range, would self-insert.
3681Affected by `cperl-electric-parens'."
55497cff 3682 (interactive "P")
3683 (let ((beg (save-excursion (beginning-of-line) (point)))
3684 (other-end (if (and cperl-electric-parens-mark
5f05dabc 3685 (cperl-val 'cperl-electric-parens)
3686 (memq last-command-char
3687 (append cperl-electric-parens-string nil))
8cfd7987 3688 (cperl-mark-active)
55497cff 3689 (< (mark) (point)))
8cfd7987 3690 (mark)
55497cff 3691 nil))
3692 p)
3693 (if (and other-end
3694 (cperl-val 'cperl-electric-parens)
3695 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
3696 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
3697 ;;(not (save-excursion (search-backward "#" beg t)))
3698 )
3699 (progn
3ee700d1 3700 (self-insert-command (prefix-numeric-value arg))
55497cff 3701 (setq p (point))
3702 (if other-end (goto-char other-end))
3ee700d1
IZ
3703 (insert (make-string
3704 (prefix-numeric-value arg)
3705 (cdr (assoc last-command-char '((?\} . ?\{)
8cfd7987
JH
3706 (?\] . ?\[)
3707 (?\) . ?\()
3708 (?\> . ?\<))))))
55497cff 3709 (goto-char (1+ p)))
3ee700d1 3710 (self-insert-command (prefix-numeric-value arg)))))
55497cff 3711
4633a7c4 3712(defun cperl-electric-keyword ()
6c72d195
IZ
3713 "Insert a construction appropriate after a keyword.
3714Help message may be switched off by setting `cperl-message-electric-keyword'
3715to nil."
8cfd7987 3716 (let ((beg (save-excursion (beginning-of-line) (point)))
3ee700d1
IZ
3717 (dollar (and (eq last-command-char ?$)
3718 (eq this-command 'self-insert-command)))
3719 (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
6c72d195
IZ
3720 (memq this-command '(self-insert-command newline))))
3721 my do)
4633a7c4 3722 (and (save-excursion
6c72d195
IZ
3723 (condition-case nil
3724 (progn
3725 (backward-sexp 1)
3726 (setq do (looking-at "do\\>")))
3727 (error nil))
ebcd4dbc 3728 (cperl-after-expr-p nil "{;:"))
8cfd7987
JH
3729 (save-excursion
3730 (not
4633a7c4 3731 (re-search-backward
20675f5d 3732 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
4633a7c4
LW
3733 beg t)))
3734 (save-excursion (or (not (re-search-backward "^=" nil t))
6c72d195
IZ
3735 (or
3736 (looking-at "=cut")
3737 (and cperl-use-syntax-table-text-property
3738 (not (eq (get-text-property (point)
3739 'syntax-type)
3740 'pod))))))
8f95267c 3741 (save-excursion (forward-sexp -1)
8cfd7987 3742 (not (memq (following-char) (append "$@%&*" nil))))
4633a7c4 3743 (progn
6c72d195
IZ
3744 (and (eq (preceding-char) ?y)
3745 (progn ; "foreachmy"
3746 (forward-char -2)
3747 (insert " ")
3748 (forward-char 2)
8cfd7987
JH
3749 (setq my t dollar t
3750 delete
6c72d195 3751 (memq this-command '(self-insert-command newline)))))
9ea28adb 3752 (and dollar (insert " $"))
4633a7c4
LW
3753 (cperl-indent-line)
3754 ;;(insert " () {\n}")
3755 (cond
3756 (cperl-extra-newline-before-brace
6c72d195 3757 (insert (if do "\n" " ()\n"))
4633a7c4
LW
3758 (insert "{")
3759 (cperl-indent-line)
3760 (insert "\n")
3761 (cperl-indent-line)
6c72d195
IZ
3762 (insert "\n}")
3763 (and do (insert " while ();")))
4633a7c4 3764 (t
8cfd7987 3765 (insert (if do " {\n} while ();" " () {\n}"))))
4633a7c4
LW
3766 (or (looking-at "[ \t]\\|$") (insert " "))
3767 (cperl-indent-line)
9ea28adb 3768 (if dollar (progn (search-backward "$")
8cfd7987 3769 (if my
6c72d195
IZ
3770 (forward-char 1)
3771 (delete-char 1)))
8cfd7987
JH
3772 (search-backward ")")
3773 (if (eq last-command-char ?\()
3774 (progn ; Avoid "if (())"
3775 (delete-backward-char 1)
3776 (delete-backward-char -1))))
3ee700d1 3777 (if delete
6c72d195
IZ
3778 (cperl-putback-char cperl-del-back-ch))
3779 (if cperl-message-electric-keyword
3780 (message "Precede char by C-q to avoid expansion"))))))
3781
3782(defun cperl-ensure-newlines (n &optional pos)
3783 "Make sure there are N newlines after the point."
3784 (or pos (setq pos (point)))
3785 (if (looking-at "\n")
3786 (forward-char 1)
3787 (insert "\n"))
3788 (if (> n 1)
3789 (cperl-ensure-newlines (1- n) pos)
3790 (goto-char pos)))
3791
3792(defun cperl-electric-pod ()
3793 "Insert a POD chunk appropriate after a =POD directive."
3794 (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
3795 (memq this-command '(self-insert-command newline))))
3796 head1 notlast name p really-delete over)
3797 (and (save-excursion
7bcea553 3798 (forward-word -1)
8cfd7987 3799 (and
6c72d195
IZ
3800 (eq (preceding-char) ?=)
3801 (progn
7bcea553
IZ
3802 (setq head1 (looking-at "head1\\>[ \t]*$"))
3803 (setq over (and (looking-at "over\\>[ \t]*$")
3804 (not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
6c72d195
IZ
3805 (forward-char -1)
3806 (bolp))
8cfd7987 3807 (or
20675f5d 3808 (get-text-property (point) 'in-pod)
6c72d195 3809 (cperl-after-expr-p nil "{;:")
8f95267c
RGS
3810 (and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
3811 (not (looking-at "\n*=cut"))
3812 (or (not cperl-use-syntax-table-text-property)
3813 (eq (get-text-property (point) 'syntax-type) 'pod))))))
6c72d195
IZ
3814 (progn
3815 (save-excursion
7bcea553 3816 (setq notlast (re-search-forward "^\n=" nil t)))
6c72d195
IZ
3817 (or notlast
3818 (progn
3819 (insert "\n\n=cut")
3820 (cperl-ensure-newlines 2)
7bcea553 3821 (forward-word -2)
8cfd7987
JH
3822 (if (and head1
3823 (not
6c72d195
IZ
3824 (save-excursion
3825 (forward-char -1)
3826 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
8cfd7987
JH
3827 nil t)))) ; Only one
3828 (progn
7bcea553 3829 (forward-word 1)
6c72d195
IZ
3830 (setq name (file-name-sans-extension
3831 (file-name-nondirectory (buffer-file-name)))
3832 p (point))
8cfd7987 3833 (insert " NAME\n\n" name
7bcea553 3834 " - \n\n=head1 SYNOPSIS\n\n\n\n"
6c72d195
IZ
3835 "=head1 DESCRIPTION")
3836 (cperl-ensure-newlines 4)
3837 (goto-char p)
7bcea553 3838 (forward-word 2)
6c72d195
IZ
3839 (end-of-line)
3840 (setq really-delete t))
7bcea553 3841 (forward-word 1))))
6c72d195
IZ
3842 (if over
3843 (progn
3844 (setq p (point))
3845 (insert "\n\n=item \n\n\n\n"
3846 "=back")
3847 (cperl-ensure-newlines 2)
3848 (goto-char p)
7bcea553 3849 (forward-word 1)
6c72d195
IZ
3850 (end-of-line)
3851 (setq really-delete t)))
3852 (if (and delete really-delete)
3853 (cperl-putback-char cperl-del-back-ch))))))
4633a7c4
LW
3854
3855(defun cperl-electric-else ()
6c72d195
IZ
3856 "Insert a construction appropriate after a keyword.
3857Help message may be switched off by setting `cperl-message-electric-keyword'
3858to nil."
4633a7c4
LW
3859 (let ((beg (save-excursion (beginning-of-line) (point))))
3860 (and (save-excursion
3861 (backward-sexp 1)
ebcd4dbc 3862 (cperl-after-expr-p nil "{;:"))
8cfd7987
JH
3863 (save-excursion
3864 (not
4633a7c4 3865 (re-search-backward
20675f5d 3866 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
4633a7c4
LW
3867 beg t)))
3868 (save-excursion (or (not (re-search-backward "^=" nil t))
6c72d195
IZ
3869 (looking-at "=cut")
3870 (and cperl-use-syntax-table-text-property
3871 (not (eq (get-text-property (point)
3872 'syntax-type)
3873 'pod)))))
4633a7c4
LW
3874 (progn
3875 (cperl-indent-line)
3876 ;;(insert " {\n\n}")
3877 (cond
3878 (cperl-extra-newline-before-brace
3879 (insert "\n")
3880 (insert "{")
3881 (cperl-indent-line)
3882 (insert "\n\n}"))
3883 (t
8cfd7987 3884 (insert " {\n\n}")))
4633a7c4
LW
3885 (or (looking-at "[ \t]\\|$") (insert " "))
3886 (cperl-indent-line)
3887 (forward-line -1)
3888 (cperl-indent-line)
6c72d195
IZ
3889 (cperl-putback-char cperl-del-back-ch)
3890 (setq this-command 'cperl-electric-else)
3891 (if cperl-message-electric-keyword
3892 (message "Precede char by C-q to avoid expansion"))))))
4633a7c4
LW
3893
3894(defun cperl-linefeed ()
6c72d195
IZ
3895 "Go to end of line, open a new line and indent appropriately.
3896If in POD, insert appropriate lines."
4633a7c4
LW
3897 (interactive)
3898 (let ((beg (save-excursion (beginning-of-line) (point)))
3899 (end (save-excursion (end-of-line) (point)))
6c72d195 3900 (pos (point)) start over cut res)
4633a7c4 3901 (if (and ; Check if we need to split:
8cfd7987 3902 ; i.e., on a boundary and inside "{...}"
4633a7c4 3903 (save-excursion (cperl-to-comment-or-eol)
8cfd7987 3904 (>= (point) pos)) ; Not in a comment
4633a7c4
LW
3905 (or (save-excursion
3906 (skip-chars-backward " \t" beg)
3907 (forward-char -1)
499d5216
IZ
3908 (looking-at "[;{]")) ; After { or ; + spaces
3909 (looking-at "[ \t]*}") ; Before }
3910 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
4633a7c4
LW
3911 (save-excursion
3912 (and
8cfd7987 3913 (eq (car (parse-partial-sexp pos end -1)) -1)
499d5216 3914 ; Leave the level of parens
9ea28adb 3915 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
499d5216 3916 ; Are at end
7bcea553 3917 (cperl-after-block-p (point-min))
4633a7c4
LW
3918 (progn
3919 (backward-sexp 1)
3920 (setq start (point-marker))
6c72d195 3921 (<= start pos))))) ; Redundant? Are after the
499d5216 3922 ; start of parens group.
4633a7c4
LW
3923 (progn
3924 (skip-chars-backward " \t")
3925 (or (memq (preceding-char) (append ";{" nil))
3926 (insert ";"))
3927 (insert "\n")
3928 (forward-line -1)
3929 (cperl-indent-line)
4633a7c4
LW
3930 (goto-char start)
3931 (or (looking-at "{[ \t]*$") ; If there is a statement
3932 ; before, move it to separate line
3933 (progn
3934 (forward-char 1)
3935 (insert "\n")
3936 (cperl-indent-line)))
3937 (forward-line 1) ; We are on the target line
3938 (cperl-indent-line)
3939 (beginning-of-line)
9ea28adb 3940 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
8cfd7987 3941 ; after, move it to separate line
4633a7c4
LW
3942 (progn
3943 (end-of-line)
3944 (search-backward "}" beg)
3945 (skip-chars-backward " \t")
3946 (or (memq (preceding-char) (append ";{" nil))
3947 (insert ";"))
3948 (insert "\n")
3949 (cperl-indent-line)
3950 (forward-line -1)))
8cfd7987 3951 (forward-line -1) ; We are on the line before target
4633a7c4
LW
3952 (end-of-line)
3953 (newline-and-indent))
6c72d195 3954 (end-of-line) ; else - no splitting
499d5216
IZ
3955 (cond
3956 ((and (looking-at "\n[ \t]*{$")
3957 (save-excursion
3958 (skip-chars-backward " \t")
3959 (eq (preceding-char) ?\)))) ; Probably if () {} group
8cfd7987 3960 ; with an extra newline.
499d5216
IZ
3961 (forward-line 2)
3962 (cperl-indent-line))
6c72d195
IZ
3963 ((save-excursion ; In POD header
3964 (forward-paragraph -1)
3965 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
3966 ;; We are after \n now, so look for the rest
3967 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
8cfd7987 3968 (progn
6c72d195
IZ
3969 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
3970 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
3971 t)))
3972 (if (and over
3973 (progn
3974 (forward-paragraph -1)
3975 (forward-word 1)
3976 (setq pos (point))
3977 (setq cut (buffer-substring (point)
3978 (save-excursion
3979 (end-of-line)
3980 (point))))
3981 (delete-char (- (save-excursion (end-of-line) (point))
3982 (point)))
3983 (setq res (expand-abbrev))
3984 (save-excursion
3985 (goto-char pos)
3986 (insert cut))
3987 res))
3988 nil
3989 (cperl-ensure-newlines (if cut 2 4))
3990 (forward-line 2)))
3991 ((get-text-property (point) 'in-pod) ; In POD section
3992 (cperl-ensure-newlines 4)
3993 (forward-line 2))
499d5216
IZ
3994 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
3995 (forward-line 1)
3996 (cperl-indent-line))
3997 (t
3998 (newline-and-indent))))))
4633a7c4
LW
3999
4000(defun cperl-electric-semi (arg)
4001 "Insert character and correct line's indentation."
4002 (interactive "P")
4003 (if cperl-auto-newline
4004 (cperl-electric-terminator arg)
7bcea553
IZ
4005 (self-insert-command (prefix-numeric-value arg))
4006 (if cperl-autoindent-on-semi
4007 (cperl-indent-line))))
4633a7c4
LW
4008
4009(defun cperl-electric-terminator (arg)
4010 "Insert character and correct line's indentation."
4011 (interactive "P")
8cfd7987
JH
4012 (let ((end (point))
4013 (auto (and cperl-auto-newline
4014 (or (not (eq last-command-char ?:))
4015 cperl-auto-newline-after-colon)))
4016 insertpos)
4017 (if (and ;;(not arg)
499d5216 4018 (eolp)
4633a7c4
LW
4019 (not (save-excursion
4020 (beginning-of-line)
4021 (skip-chars-forward " \t")
c07a80fd 4022 (or
4023 ;; Ignore in comment lines
4024 (= (following-char) ?#)
4025 ;; Colon is special only after a label
4026 ;; So quickly rule out most other uses of colon
4027 ;; and do no indentation for them.
4028 (and (eq last-command-char ?:)
4029 (save-excursion
4030 (forward-word 1)
4031 (skip-chars-forward " \t")
4032 (and (< (point) end)
4033 (progn (goto-char (- end 1))
4034 (not (looking-at ":"))))))
4035 (progn
4036 (beginning-of-defun)
4037 (let ((pps (parse-partial-sexp (point) end)))
4038 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
4633a7c4 4039 (progn
3ee700d1 4040 (self-insert-command (prefix-numeric-value arg))
499d5216 4041 ;;(forward-char -1)
9ea28adb 4042 (if auto (setq insertpos (point-marker)))
499d5216 4043 ;;(forward-char 1)
4633a7c4 4044 (cperl-indent-line)
9ea28adb 4045 (if auto
4633a7c4
LW
4046 (progn
4047 (newline)
4048 (cperl-indent-line)))
4049 (save-excursion
499d5216 4050 (if insertpos (goto-char (1- (marker-position insertpos)))
9ea28adb 4051 (forward-char -1))
4052 (delete-char 1))))
4633a7c4
LW
4053 (if insertpos
4054 (save-excursion
4055 (goto-char insertpos)
4056 (self-insert-command (prefix-numeric-value arg)))
4057 (self-insert-command (prefix-numeric-value arg)))))
4058
9ea28adb 4059(defun cperl-electric-backspace (arg)
8cfd7987
JH
4060 "Backspace, or remove the whitespace around the point inserted by an electric
4061key. Will untabivy if `cperl-electric-backspace-untabify' is non-nil."
9ea28adb 4062 (interactive "p")
8cfd7987
JH
4063 (if (and cperl-auto-newline
4064 (memq last-command '(cperl-electric-semi
9ea28adb 4065 cperl-electric-terminator
4066 cperl-electric-lbrace))
6c72d195 4067 (memq (preceding-char) '(?\ ?\t ?\n)))
9ea28adb 4068 (let (p)
8cfd7987 4069 (if (eq last-command 'cperl-electric-lbrace)
9ea28adb 4070 (skip-chars-forward " \t\n"))
4071 (setq p (point))
4072 (skip-chars-backward " \t\n")
4073 (delete-region (point) p))
6c72d195
IZ
4074 (and (eq last-command 'cperl-electric-else)
4075 ;; We are removing the whitespace *inside* cperl-electric-else
4076 (setq this-command 'cperl-electric-else-really))
8cfd7987 4077 (if (and cperl-auto-newline
6c72d195
IZ
4078 (eq last-command 'cperl-electric-else-really)
4079 (memq (preceding-char) '(?\ ?\t ?\n)))
4080 (let (p)
4081 (skip-chars-forward " \t\n")
4082 (setq p (point))
4083 (skip-chars-backward " \t\n")
4084 (delete-region (point) p))
8cfd7987
JH
4085 (if cperl-electric-backspace-untabify
4086 (backward-delete-char-untabify arg)
4087 (delete-backward-char arg)))))
9ea28adb 4088
8f95267c 4089(defun cperl-inside-parens-p () ;; NOT USED????
4633a7c4
LW
4090 (condition-case ()
4091 (save-excursion
4092 (save-restriction
4093 (narrow-to-region (point)
4094 (progn (beginning-of-defun) (point)))
4095 (goto-char (point-max))
4096 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
4097 (error nil)))
4098\f
4099(defun cperl-indent-command (&optional whole-exp)
4633a7c4 4100 "Indent current line as Perl code, or in some cases insert a tab character.
8cfd7987 4101If `cperl-tab-always-indent' is non-nil (the default), always indent current
6c72d195 4102line. Otherwise, indent the current line only if point is at the left margin
4633a7c4
LW
4103or in the line's indentation; otherwise insert a tab.
4104
4105A numeric argument, regardless of its value,
4106means indent rigidly all the lines of the expression starting after point
4107so that this line becomes properly indented.
4108The relative indentation among the lines of the expression are preserved."
9ea28adb 4109 (interactive "P")
6c72d195 4110 (cperl-update-syntaxification (point) (point))
4633a7c4
LW
4111 (if whole-exp
4112 ;; If arg, always indent this line as Perl
4113 ;; and shift remaining lines of expression the same amount.
4114 (let ((shift-amt (cperl-indent-line))
4115 beg end)
4116 (save-excursion
4117 (if cperl-tab-always-indent
4118 (beginning-of-line))
4119 (setq beg (point))
4120 (forward-sexp 1)
4121 (setq end (point))
4122 (goto-char beg)
4123 (forward-line 1)
4124 (setq beg (point)))
6c72d195 4125 (if (and shift-amt (> end beg))
4633a7c4
LW
4126 (indent-code-rigidly beg end shift-amt "#")))
4127 (if (and (not cperl-tab-always-indent)
4128 (save-excursion
4129 (skip-chars-backward " \t")
4130 (not (bolp))))
4131 (insert-tab)
4132 (cperl-indent-line))))
4133
6c72d195 4134(defun cperl-indent-line (&optional parse-data)
4633a7c4
LW
4135 "Indent current line as Perl code.
4136Return the amount the indentation changed by."
8cfd7987
JH
4137 (let ((case-fold-search nil)
4138 (pos (- (point-max) (point)))
4139 indent i beg shift-amt)
6c72d195
IZ
4140 (setq indent (cperl-calculate-indent parse-data)
4141 i indent)
4633a7c4
LW
4142 (beginning-of-line)
4143 (setq beg (point))
ebcd4dbc 4144 (cond ((or (eq indent nil) (eq indent t))
6c72d195 4145 (setq indent (current-indentation) i nil))
4633a7c4
LW
4146 ;;((eq indent t) ; Never?
4147 ;; (setq indent (cperl-calculate-indent-within-comment)))
4148 ;;((looking-at "[ \t]*#")
4149 ;; (setq indent 0))
4150 (t
4151 (skip-chars-forward " \t")
4152 (if (listp indent) (setq indent (car indent)))
8f95267c
RGS
4153 (cond ((and (looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
4154 (not (looking-at "[smy]:\\|tr:")))
4633a7c4
LW
4155 (and (> indent 0)
4156 (setq indent (max cperl-min-label-indent
4157 (+ indent cperl-label-offset)))))
4633a7c4
LW
4158 ((= (following-char) ?})
4159 (setq indent (- indent cperl-indent-level)))
4160 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
4161 (setq indent (+ indent cperl-close-paren-offset)))
4162 ((= (following-char) ?{)
4163 (setq indent (+ indent cperl-brace-offset))))))
4164 (skip-chars-forward " \t")
6c72d195
IZ
4165 (setq shift-amt (and i (- indent (current-column))))
4166 (if (or (not shift-amt)
4167 (zerop shift-amt))
4633a7c4
LW
4168 (if (> (- (point-max) pos) (point))
4169 (goto-char (- (point-max) pos)))
8f95267c
RGS
4170 ;;;(delete-region beg (point))
4171 ;;;(indent-to indent)
4172 (cperl-make-indent indent)
4633a7c4
LW
4173 ;; If initial point was within line's indentation,
4174 ;; position after the indentation. Else stay at same point in text.
4175 (if (> (- (point-max) pos) (point))
4176 (goto-char (- (point-max) pos))))
4177 shift-amt))
4178
c07a80fd 4179(defun cperl-after-label ()
6c72d195 4180 ;; Returns true if the point is after label. Does not do save-excursion.
4633a7c4
LW
4181 (and (eq (preceding-char) ?:)
4182 (memq (char-syntax (char-after (- (point) 2)))
4183 '(?w ?_))
4184 (progn
4185 (backward-sexp)
499d5216 4186 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
4633a7c4 4187
c07a80fd 4188(defun cperl-get-state (&optional parse-start start-state)
4584684c
GS
4189 ;; returns list (START STATE DEPTH PRESTART),
4190 ;; START is a good place to start parsing, or equal to
8cfd7987 4191 ;; PARSE-START if preset,
4584684c
GS
4192 ;; STATE is what is returned by `parse-partial-sexp'.
4193 ;; DEPTH is true is we are immediately after end of block
4194 ;; which contains START.
4195 ;; PRESTART is the position basing on which START was found.
4633a7c4 4196 (save-excursion
c07a80fd 4197 (let ((start-point (point)) depth state start prestart)
6c72d195
IZ
4198 (if (and parse-start
4199 (<= parse-start start-point))
4633a7c4 4200 (goto-char parse-start)
6c72d195
IZ
4201 (beginning-of-defun)
4202 (setq start-state nil))
c07a80fd 4203 (setq prestart (point))
4633a7c4 4204 (if start-state nil
c07a80fd 4205 ;; Try to go out, if sub is not on the outermost level
4206 (while (< (point) start-point)
4207 (setq start (point) parse-start start depth nil
4208 state (parse-partial-sexp start start-point -1))
4633a7c4
LW
4209 (if (> (car state) -1) nil
4210 ;; The current line could start like }}}, so the indentation
4211 ;; corresponds to a different level than what we reached
c07a80fd 4212 (setq depth t)
4633a7c4 4213 (beginning-of-line 2))) ; Go to the next line.
c07a80fd 4214 (if start (goto-char start))) ; Not at the start of file
4215 (setq start (point))
c07a80fd 4216 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
4217 (list start state depth prestart))))
4218
ebcd4dbc 4219(defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
4633a7c4 4220
8f95267c
RGS
4221(defun cperl-beginning-of-property (p prop &optional lim)
4222 "Given that P has a property PROP, find where the property starts.
4223Will not look before LIM."
4224 ;;; XXXX What to do at point-max???
4225 (or (previous-single-property-change (cperl-1+ p) prop lim)
4226 (point-min))
4227;;; (cond ((eq p (point-min))
4228;;; p)
4229;;; ((and lim (<= p lim))
4230;;; p)
4231;;; ((not (get-text-property (1- p) prop))
4232;;; p)
4233;;; (t (or (previous-single-property-change p look-prop lim)
4234;;; (point-min))))
4235 )
4236
4237(defun cperl-sniff-for-indent (&optional parse-data) ; was parse-start
4238 ;; Old workhorse for calculation of indentation; the major problem
4239 ;; is that it mixes the sniffer logic to understand what the current line
4240 ;; MEANS with the logic to actually calculate where to indent it.
4241 ;; The latter part should be eventually moved to `cperl-calculate-indent';
4242 ;; actually, this is mostly done now...
8cfd7987 4243 (cperl-update-syntaxification (point) (point))
8f95267c
RGS
4244 (let ((res (get-text-property (point) 'syntax-type)))
4245 (save-excursion
4246 (cond
4247 ((and (memq res '(pod here-doc here-doc-delim format))
4248 (not (get-text-property (point) 'indentable)))
4249 (vector res))
4250 ;; before start of POD - whitespace found since do not have 'pod!
4251 ((looking-at "[ \t]*\n=")
4252 (error "Spaces before POD section!"))
4253 ((and (not cperl-indent-left-aligned-comments)
4254 (looking-at "^#"))
4255 [comment-special:at-beginning-of-line])
4256 ((get-text-property (point) 'in-pod)
4257 [in-pod])
4258 (t
4259 (beginning-of-line)
4260 (let* ((indent-point (point))
4261 (char-after-pos (save-excursion
4262 (skip-chars-forward " \t")
4263 (point)))
4264 (char-after (char-after char-after-pos))
4265 (pre-indent-point (point))
4266 p prop look-prop is-block delim)
4267 (save-excursion ; Know we are not in POD, find appropriate pos before
8cfd7987
JH
4268 (cperl-backward-to-noncomment nil)
4269 (setq p (max (point-min) (1- (point)))
4270 prop (get-text-property p 'syntax-type)
4271 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
4272 'syntax-type))
4273 (if (memq prop '(pod here-doc format here-doc-delim))
4274 (progn
8f95267c 4275 (goto-char (cperl-beginning-of-property p look-prop))
8cfd7987 4276 (beginning-of-line)
8f95267c
RGS
4277 (setq pre-indent-point (point)))))
4278 (goto-char pre-indent-point) ; Orig line skipping preceeding pod/etc
4279 (let* ((case-fold-search nil)
4280 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
4281 (start (or (nth 2 parse-data) ; last complete sexp terminated
4282 (nth 0 s-s))) ; Good place to start parsing
4283 (state (nth 1 s-s))
4284 (containing-sexp (car (cdr state)))
4285 old-indent)
4286 (if (and
4287 ;;containing-sexp ;; We are buggy at toplevel :-(
4288 parse-data)
4289 (progn
4290 (setcar parse-data pre-indent-point)
4291 (setcar (cdr parse-data) state)
4292 (or (nth 2 parse-data)
4293 (setcar (cddr parse-data) start))
4294 ;; Before this point: end of statement
4295 (setq old-indent (nth 3 parse-data))))
4296 (cond ((get-text-property (point) 'indentable)
4297 ;; indent to "after" the surrounding open
4298 ;; (same offset as `cperl-beautify-regexp-piece'),
4299 ;; skip blanks if we do not close the expression.
4300 (setq delim ; We do not close the expression
4301 (get-text-property
4302 (cperl-1+ char-after-pos) 'indentable)
4303 p (1+ (cperl-beginning-of-property
4304 (point) 'indentable))
4305 is-block ; misused for: preceeding line in REx
4306 (save-excursion ; Find preceeding line
4307 (cperl-backward-to-noncomment p)
4308 (beginning-of-line)
4309 (if (<= (point) p)
4310 (progn ; get indent from the first line
4311 (goto-char p)
4312 (skip-chars-forward " \t")
4313 (if (memq (char-after (point))
4314 (append "#\n" nil))
4315 nil ; Can't use intentation of this line...
4316 (point)))
4317 (skip-chars-forward " \t")
4318 (point)))
4319 prop (parse-partial-sexp p char-after-pos))
4320 (cond ((not delim) ; End the REx, ignore is-block
4321 (vector 'indentable 'terminator p is-block))
4322 (is-block ; Indent w.r.t. preceeding line
4323 (vector 'indentable 'cont-line char-after-pos
4324 is-block char-after p))
4325 (t ; No preceeding line...
4326 (vector 'indentable 'first-line p))))
4327 ((get-text-property char-after-pos 'REx-part2)
4328 (vector 'REx-part2 (point)))
4329 ((nth 4 state)
4330 [comment])
4331 ((nth 3 state)
4332 [string])
4333 ;; XXXX Do we need to special-case this?
4334 ((null containing-sexp)
4335 ;; Line is at top level. May be data or function definition,
4336 ;; or may be function argument declaration.
4337 ;; Indent like the previous top level line
4338 ;; unless that ends in a closeparen without semicolon,
4339 ;; in which case this line is the first argument decl.
4340 (skip-chars-forward " \t")
4341 (cperl-backward-to-noncomment (or old-indent (point-min)))
4342 (setq state
4343 (or (bobp)
4344 (eq (point) old-indent) ; old-indent was at comment
4345 (eq (preceding-char) ?\;)
4346 ;; Had ?\) too
4347 (and (eq (preceding-char) ?\})
4348 (cperl-after-block-and-statement-beg
4349 (point-min))) ; Was start - too close
4350 (memq char-after (append ")]}" nil))
4351 (and (eq (preceding-char) ?\:) ; label
8cfd7987
JH
4352 (progn
4353 (forward-sexp -1)
8f95267c
RGS
4354 (skip-chars-backward " \t")
4355 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:")))
4356 (get-text-property (point) 'first-format-line)))
4357
4358 ;; Look at previous line that's at column 0
4359 ;; to determine whether we are in top-level decls
4360 ;; or function's arg decls. Set basic-indent accordingly.
4361 ;; Now add a little if this is a continuation line.
4362 (and state
4363 parse-data
4364 (not (eq char-after ?\C-j))
4365 (setcdr (cddr parse-data)
4366 (list pre-indent-point)))
4367 (vector 'toplevel start char-after state (nth 2 s-s)))
4368 ((not
4369 (or (setq is-block
4370 (and (setq delim (= (char-after containing-sexp) ?{))
4371 (save-excursion ; Is it a hash?
4372 (goto-char containing-sexp)
4373 (cperl-block-p))))
4374 cperl-indent-parens-as-block))
4375 ;; group is an expression, not a block:
4376 ;; indent to just after the surrounding open parens,
4377 ;; skip blanks if we do not close the expression.
4378 (goto-char (1+ containing-sexp))
4379 (or (memq char-after
4380 (append (if delim "}" ")]}") nil))
4381 (looking-at "[ \t]*\\(#\\|$\\)")
4382 (skip-chars-forward " \t"))
4383 (setq old-indent (point)) ; delim=is-brace
4384 (vector 'in-parens char-after (point) delim containing-sexp))
4385 (t
4386 ;; Statement level. Is it a continuation or a new statement?
4387 ;; Find previous non-comment character.
4388 (goto-char pre-indent-point) ; Skip one level of POD/etc
4389 (cperl-backward-to-noncomment containing-sexp)
4390 ;; Back up over label lines, since they don't
4391 ;; affect whether our line is a continuation.
4392 ;; (Had \, too)
4393 (while;;(or (eq (preceding-char) ?\,)
4394 (and (eq (preceding-char) ?:)
4395 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
4396 (memq (char-syntax (char-after (- (point) 2)))
4397 '(?w ?_))))
4398 ;;)
4399 ;; This is always FALSE?
4400 (if (eq (preceding-char) ?\,)
4401 ;; Will go to beginning of line, essentially.
4402 ;; Will ignore embedded sexpr XXXX.
4403 (cperl-backward-to-start-of-continued-exp containing-sexp))
4404 (beginning-of-line)
4405 (cperl-backward-to-noncomment containing-sexp))
4406 ;; Now we get non-label preceeding the indent point
4407 (if (not (or (eq (1- (point)) containing-sexp)
4408 (memq (preceding-char)
4409 (append (if is-block " ;{" " ,;{") '(nil)))
4410 (and (eq (preceding-char) ?\})
4411 (cperl-after-block-and-statement-beg
4412 containing-sexp))
4413 (get-text-property (point) 'first-format-line)))
4414 ;; This line is continuation of preceding line's statement;
4415 ;; indent `cperl-continued-statement-offset' more than the
4416 ;; previous line of the statement.
4417 ;;
4418 ;; There might be a label on this line, just
4419 ;; consider it bad style and ignore it.
4420 (progn
4421 (cperl-backward-to-start-of-continued-exp containing-sexp)
4422 (vector 'continuation (point) char-after is-block delim))
4423 ;; This line starts a new statement.
4424 ;; Position following last unclosed open brace
4425 (goto-char containing-sexp)
4426 ;; Is line first statement after an open-brace?
4427 (or
4428 ;; If no, find that first statement and indent like
4429 ;; it. If the first statement begins with label, do
4430 ;; not believe when the indentation of the label is too
4431 ;; small.
4432 (save-excursion
4433 (forward-char 1)
4434 (let ((colon-line-end 0))
4435 (while
4436 (progn (skip-chars-forward " \t\n")
4437 ;; s: foo : bar :x is NOT label
4438 (and (looking-at "#\\|\\([a-zA-Z0-9_$]+\\):[^:]\\|=[a-zA-Z]")
4439 (not (looking-at "[sym]:\\|tr:"))))
4440 ;; Skip over comments and labels following openbrace.
4441 (cond ((= (following-char) ?\#)
4442 (forward-line 1))
4443 ((= (following-char) ?\=)
4444 (goto-char
4445 (or (next-single-property-change (point) 'in-pod)
4446 (point-max)))) ; do not loop if no syntaxification
4447 ;; label:
4448 (t
4449 (save-excursion (end-of-line)
4450 (setq colon-line-end (point)))
4451 (search-forward ":"))))
4452 ;; We are at beginning of code (NOT label or comment)
4453 ;; First, the following code counts
4454 ;; if it is before the line we want to indent.
4455 (and (< (point) indent-point)
4456 (vector 'have-prev-sibling (point) colon-line-end
4457 containing-sexp))))
4458 (progn
4459 ;; If no previous statement,
4460 ;; indent it relative to line brace is on.
4461
4462 ;; For open-braces not the first thing in a line,
4463 ;; add in cperl-brace-imaginary-offset.
4464
4465 ;; If first thing on a line: ?????
4466 ;; Move back over whitespace before the openbrace.
4467 (setq ; brace first thing on a line
4468 old-indent (progn (skip-chars-backward " \t") (bolp)))
4469 ;; Should we indent w.r.t. earlier than start?
4470 ;; Move to start of control group, possibly on a different line
4471 (or cperl-indent-wrt-brace
4472 (cperl-backward-to-noncomment (point-min)))
4473 ;; If the openbrace is preceded by a parenthesized exp,
4474 ;; move to the beginning of that;
4475 (if (eq (preceding-char) ?\))
4476 (progn
4477 (forward-sexp -1)
4478 (cperl-backward-to-noncomment (point-min))))
4479 ;; In the case it starts a subroutine, indent with
4480 ;; respect to `sub', not with respect to the
4481 ;; first thing on the line, say in the case of
4482 ;; anonymous sub in a hash.
4483 (if (and;; Is it a sub in group starting on this line?
4484 (cond ((get-text-property (point) 'attrib-group)
4485 (goto-char (cperl-beginning-of-property
4486 (point) 'attrib-group)))
4487 ((eq (preceding-char) ?b)
4488 (forward-sexp -1)
4489 (looking-at "sub\\>")))
4490 (setq p (nth 1 ; start of innermost containing list
4491 (parse-partial-sexp
4492 (save-excursion (beginning-of-line)
4493 (point))
4494 (point)))))
4495 (progn
4496 (goto-char (1+ p)) ; enclosing block on the same line
4497 (skip-chars-forward " \t")
4498 (vector 'code-start-in-block containing-sexp char-after
4499 (and delim (not is-block)) ; is a HASH
4500 old-indent ; brace first thing on a line
4501 t (point) ; have something before...
4502 )
4503 ;;(current-column)
4504 )
4505 ;; Get initial indentation of the line we are on.
4506 ;; If line starts with label, calculate label indentation
4507 (vector 'code-start-in-block containing-sexp char-after
4508 (and delim (not is-block)) ; is a HASH
4509 old-indent ; brace first thing on a line
4510 nil (point))))))))))))))) ; nothing interesting before
4511
4512(defvar cperl-indent-rules-alist
4513 '((pod nil) ; via `syntax-type' property
4514 (here-doc nil) ; via `syntax-type' property
4515 (here-doc-delim nil) ; via `syntax-type' property
4516 (format nil) ; via `syntax-type' property
4517 (in-pod nil) ; via `in-pod' property
4518 (comment-special:at-beginning-of-line nil)
4519 (string t)
4520 (comment nil))
4633a7c4
LW
4521 "Alist of indentation rules for CPerl mode.
4522The values mean:
4523 nil: do not indent;
8f95267c 4524 number: add this amount of indentation.")
6c72d195 4525
8f95267c
RGS
4526(defun cperl-calculate-indent (&optional parse-data) ; was parse-start
4527 "Return appropriate indentation for current line as Perl code.
4528In usual case returns an integer: the column to indent to.
4529Returns nil if line starts inside a string, t if in a comment.
6c72d195 4530
8f95267c
RGS
4531Will not correct the indentation for labels, but will correct it for braces
4532and closing parentheses and brackets."
4533 ;; This code is still a broken architecture: in some cases we need to
4534 ;; compensate for some modifications which `cperl-indent-line' will add later
4633a7c4 4535 (save-excursion
8f95267c
RGS
4536 (let ((i (cperl-sniff-for-indent parse-data)) what p)
4537 (cond
4538 ;;((or (null i) (eq i t) (numberp i))
4539 ;; i)
4540 ((vectorp i)
4541 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
4542 (cond
4543 (what (cadr what)) ; Load from table
4544 ;;
4545 ;; Indenters for regular expressions with //x and qw()
4546 ;;
4547 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
4548 (goto-char (elt i 1))
4549 (condition-case nil ; Use indentation of the 1st part
4550 (forward-sexp -1))
4551 (current-column))
4552 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
4553 (cond ;;; [indentable terminator start-pos is-block]
4554 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
4555 (goto-char (elt i 2)) ; After opening parens
4556 (1- (current-column)))
4557 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
4558 (goto-char (elt i 2))
4559 (+ (or cperl-regexp-indent-step cperl-indent-level)
4560 -1
4561 (current-column)))
4562 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
4563 ;; Indent as the level after closing parens
4564 (goto-char (elt i 2)) ; indent line
4565 (skip-chars-forward " \t)") ; Skip closing parens
4566 (setq p (point))
4567 (goto-char (elt i 3)) ; previous line
4568 (skip-chars-forward " \t)") ; Skip closing parens
4569 ;; Number of parens in between:
4570 (setq p (nth 0 (parse-partial-sexp (point) p))
4571 what (elt i 4)) ; First char on current line
4572 (goto-char (elt i 3)) ; previous line
4573 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
4574 (cond ((eq what ?\) )
4575 (- cperl-close-paren-offset)) ; compensate
4576 ((eq what ?\| )
4577 (- (or cperl-regexp-indent-step cperl-indent-level)))
4578 (t 0))
4579 (if (eq (following-char) ?\| )
4580 (or cperl-regexp-indent-step cperl-indent-level)
4581 0)
4582 (current-column)))
4583 (t
4584 (error "Unrecognized value of indent: " i))))
4585 ;;
4586 ;; Indenter for stuff at toplevel
4587 ;;
4588 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
4589 (+ (save-excursion ; To beg-of-defun, or end of last sexp
4590 (goto-char (elt i 1)) ; start = Good place to start parsing
4591 (- (current-indentation) ;
4592 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
4593 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
4594 ;; Look at previous line that's at column 0
4595 ;; to determine whether we are in top-level decls
4596 ;; or function's arg decls. Set basic-indent accordingly.
4597 ;; Now add a little if this is a continuation line.
4598 (if (elt i 3) ; state (XXX What is the semantic???)
4599 0
4600 cperl-continued-statement-offset)))
4601 ;;
4602 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
4603 ;;
4604 ((eq 'in-parens (elt i 0))
4605 ;; in-parens char-after old-indent-point is-brace containing-sexp
4606
4607 ;; group is an expression, not a block:
4608 ;; indent to just after the surrounding open parens,
4609 ;; skip blanks if we do not close the expression.
4610 (+ (progn
4611 (goto-char (elt i 2)) ; old-indent-point
4612 (current-column))
4613 (if (and (elt i 3) ; is-brace
4614 (eq (elt i 1) ?\})) ; char-after
4615 ;; Correct indentation of trailing ?\}
4616 (+ cperl-indent-level cperl-close-paren-offset)
4617 0)))
4618 ;;
4619 ;; Indenter for continuation lines
4620 ;;
4621 ((eq 'continuation (elt i 0))
4622 ;; [continuation statement-start char-after is-block is-brace]
4623 (goto-char (elt i 1)) ; statement-start
4624 (+ (if (memq (elt i 2) (append "}])" nil)) ; char-after
4625 0 ; Closing parenth
4626 cperl-continued-statement-offset)
4627 (if (or (elt i 3) ; is-block
4628 (not (elt i 4)) ; is-brace
4629 (not (eq (elt i 2) ?\}))) ; char-after
4630 0
4631 ;; Now it is a hash reference
4632 (+ cperl-indent-level cperl-close-paren-offset))
4633 ;; Labels do not take :: ...
4634 (if (looking-at "\\(\\w\\|_\\)+[ \t]*:")
4635 (if (> (current-indentation) cperl-min-label-indent)
4636 (- (current-indentation) cperl-label-offset)
4637 ;; Do not move `parse-data', this should
4638 ;; be quick anyway (this comment comes
4639 ;; from different location):
4640 (cperl-calculate-indent))
4641 (current-column))
4642 (if (eq (elt i 2) ?\{) ; char-after
4643 cperl-continued-brace-offset 0)))
4644 ;;
4645 ;; Indenter for lines in a block which are not leading lines
4646 ;;
4647 ((eq 'have-prev-sibling (elt i 0))
4648 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
4649 (goto-char (elt i 1)) ; sibling-beg
4650 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
4651 (if (> (current-indentation)
4652 cperl-min-label-indent)
4653 (- (current-indentation) cperl-label-offset)
4654 ;; Do not believe: `max' was involved in calculation of indent
4655 (+ cperl-indent-level
4656 (save-excursion
4657 (goto-char (elt i 3)) ; block-start
4658 (current-indentation))))
4659 (current-column)))
4660 ;;
4661 ;; Indenter for the first line in a block
4662 ;;
4663 ((eq 'code-start-in-block (elt i 0))
4664 ;;[code-start-in-block before-brace char-after
4665 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
4666 ;; group-starts-before-start-of-sub start-of-control-group]
4667 (goto-char (elt i 1))
4668 ;; For open brace in column zero, don't let statement
4669 ;; start there too. If cperl-indent-level=0,
4670 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
4671 (+ (if (and (bolp) (zerop cperl-indent-level))
4672 (+ cperl-brace-offset cperl-continued-statement-offset)
4673 cperl-indent-level)
4674 (if (and (elt i 3) ; is-a-HASH-ref
4675 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
4676 (+ cperl-indent-level cperl-close-paren-offset)
4677 0)
4678 ;; Unless openbrace is the first nonwhite thing on the line,
4679 ;; add the cperl-brace-imaginary-offset.
4680 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
4681 cperl-brace-imaginary-offset)
4682 (progn
4683 (goto-char (elt i 6)) ; start-of-control-group
4684 (if (elt i 5) ; group-starts-before-start-of-sub
4685 (current-column)
4686 ;; Get initial indentation of the line we are on.
4687 ;; If line starts with label, calculate label indentation
4688 (if (save-excursion
4689 (beginning-of-line)
4690 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
4691 (if (> (current-indentation) cperl-min-label-indent)
4692 (- (current-indentation) cperl-label-offset)
4693 ;; Do not move `parse-data', this should
4694 ;; be quick anyway:
4695 (cperl-calculate-indent))
4696 (current-indentation))))))
4697 (t
4698 (error "Unrecognized value of indent: " i))))
4699 (t
4700 (error (format "Got strange value of indent: " i)))))))
4633a7c4
LW
4701
4702(defun cperl-calculate-indent-within-comment ()
4703 "Return the indentation amount for line, assuming that
4704the current line is to be regarded as part of a block comment."
4705 (let (end star-start)
4706 (save-excursion
4707 (beginning-of-line)
4708 (skip-chars-forward " \t")
4709 (setq end (point))
4710 (and (= (following-char) ?#)
4711 (forward-line -1)
4712 (cperl-to-comment-or-eol)
4713 (setq end (point)))
4714 (goto-char end)
4715 (current-column))))
4716
4717
4718(defun cperl-to-comment-or-eol ()
8cfd7987 4719 "Go to position before comment on the current line, or to end of line.
8f95267c
RGS
4720Returns true if comment is found. In POD will not move the point."
4721 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
4722 ;; then looks for literal # or end-of-line.
4723 (let (state stop-in cpoint (lim (progn (end-of-line) (point))) pr e)
4724 (or cperl-font-locking
4725 (cperl-update-syntaxification lim lim))
8cfd7987 4726 (beginning-of-line)
8f95267c
RGS
4727 (if (setq pr (get-text-property (point) 'syntax-type))
4728 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
4729 (if (or (eq pr 'pod)
4730 (if (or (not e) (> e lim)) ; deep inside a group
4731 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t)))
8cfd7987 4732 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
8f95267c
RGS
4733 ;; Else - need to do it the hard way
4734 (and (and e (<= e lim))
4735 (goto-char e))
8cfd7987
JH
4736 (while (not stop-in)
4737 (setq state (parse-partial-sexp (point) lim nil nil nil t))
4633a7c4 4738 ; stop at comment
8cfd7987
JH
4739 ;; If fails (beginning-of-line inside sexp), then contains not-comment
4740 (if (nth 4 state) ; After `#';
4633a7c4
LW
4741 ; (nth 2 state) can be
4742 ; beginning of m,s,qq and so
4743 ; on
8cfd7987
JH
4744 (if (nth 2 state)
4745 (progn
4746 (setq cpoint (point))
4747 (goto-char (nth 2 state))
4748 (cond
4749 ((looking-at "\\(s\\|tr\\)\\>")
4750 (or (re-search-forward
4751 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
4752 lim 'move)
4753 (setq stop-in t)))
4754 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
4755 (or (re-search-forward
4756 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
4757 lim 'move)
4758 (setq stop-in t)))
4759 (t ; It was fair comment
4760 (setq stop-in t) ; Finish
4761 (goto-char (1- cpoint)))))
4762 (setq stop-in t) ; Finish
4763 (forward-char -1))
8f95267c 4764 (setq stop-in t))) ; Finish
8cfd7987 4765 (nth 4 state))))
4633a7c4 4766
3ee700d1
IZ
4767(defsubst cperl-modify-syntax-type (at how)
4768 (if (< at (point-max))
4769 (progn
4770 (put-text-property at (1+ at) 'syntax-table how)
8f95267c 4771 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
ebcd4dbc
IZ
4772
4773(defun cperl-protect-defun-start (s e)
4774 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
4775 (save-excursion
4776 (goto-char s)
4777 (while (re-search-forward "^\\s(" e 'to-end)
4778 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
4779
20675f5d 4780(defun cperl-commentify (bb e string &optional noface)
8cfd7987 4781 (if cperl-use-syntax-table-text-property
20675f5d
IZ
4782 (if (eq noface 'n) ; Only immediate
4783 nil
ebcd4dbc
IZ
4784 ;; We suppose that e is _after_ the end of construction, as after eol.
4785 (setq string (if string cperl-st-sfence cperl-st-cfence))
7bcea553
IZ
4786 (if (> bb (- e 2))
4787 ;; one-char string/comment?!
4788 (cperl-modify-syntax-type bb cperl-st-punct)
4789 (cperl-modify-syntax-type bb string)
4790 (cperl-modify-syntax-type (1- e) string))
ebcd4dbc 4791 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
8cfd7987 4792 (put-text-property (1+ bb) (1- e)
ebcd4dbc 4793 'syntax-table cperl-string-syntax-table))
20675f5d
IZ
4794 (cperl-protect-defun-start bb e))
4795 ;; Fontify
4796 (or noface
4797 (not cperl-pod-here-fontify)
4798 (put-text-property bb e 'face (if string 'font-lock-string-face
4799 'font-lock-comment-face)))))
7bcea553 4800
20675f5d
IZ
4801(defvar cperl-starters '(( ?\( . ?\) )
4802 ( ?\[ . ?\] )
4803 ( ?\{ . ?\} )
4804 ( ?\< . ?\> )))
ebcd4dbc 4805
8f95267c
RGS
4806(defun cperl-cached-syntax-table (st)
4807 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
4808All the entries of the syntax table are \".\", except for a backslash, which
4809is quoting."
4810 (if (car-safe st)
4811 (car st)
4812 (setcar st (make-syntax-table))
4813 (setq st (car st))
4814 (let ((i 0))
4815 (while (< i 256)
4816 (modify-syntax-entry i "." st)
4817 (setq i (1+ i))))
4818 (modify-syntax-entry ?\\ "\\" st)
4819 st))
4820
4821(defun cperl-forward-re (lim end is-2arg st-l err-l argument
3ee700d1 4822 &optional ostart oend)
8f95267c
RGS
4823"Find the end of a regular expression or a stringish construct (q[] etc).
4824The point should be before the starting delimiter.
4825
4826Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
4827is s/// or tr/// like expression. If END is nil, generates an error
4828message if needed. If SET-ST is non-nil, will use (or generate) a
4829cached syntax table in ST-L. If ERR-L is non-nil, will store the
4830error message in its CAR (unless it already contains some error
4831message). ARGUMENT should be the name of the construct (used in error
4832messages). OSTART, OEND may be set in recursive calls when processing
4833the second argument of 2ARG construct.
4834
4835Works *before* syntax recognition is done. In IS-2ARG situation may
4836modify syntax-type text property if the situation is too hard."
4837 (let (b starter ender st i i2 go-forward reset-st set-st)
05bbd9c3
IZ
4838 (skip-chars-forward " \t")
4839 ;; ender means matching-char matcher.
8cfd7987 4840 (setq b (point)
4584684c 4841 starter (if (eobp) 0 (char-after b))
20675f5d 4842 ender (cdr (assoc starter cperl-starters)))
05bbd9c3 4843 ;; What if starter == ?\\ ????
8f95267c 4844 (setq st (cperl-cached-syntax-table st-l))
05bbd9c3
IZ
4845 (setq set-st t)
4846 ;; Whether we have an intermediate point
4847 (setq i nil)
4848 ;; Prepare the syntax table:
8f95267c
RGS
4849 (if (not ender) ; m/blah/, s/x//, s/x/y/
4850 (modify-syntax-entry starter "$" st)
4851 (modify-syntax-entry starter (concat "(" (list ender)) st)
4852 (modify-syntax-entry ender (concat ")" (list starter)) st))
05bbd9c3
IZ
4853 (condition-case bb
4854 (progn
20675f5d
IZ
4855 ;; We use `$' syntax class to find matching stuff, but $$
4856 ;; is recognized the same as $, so we need to check this manually.
05bbd9c3
IZ
4857 (if (and (eq starter (char-after (cperl-1+ b)))
4858 (not ender))
4859 ;; $ has TeXish matching rules, so $$ equiv $...
4860 (forward-char 2)
7bcea553 4861 (setq reset-st (syntax-table))
05bbd9c3
IZ
4862 (set-syntax-table st)
4863 (forward-sexp 1)
7bcea553
IZ
4864 (if (<= (point) (1+ b))
4865 (error "Unfinished regular expression"))
4866 (set-syntax-table reset-st)
4867 (setq reset-st nil)
05bbd9c3
IZ
4868 ;; Now the problem is with m;blah;;
4869 (and (not ender)
4870 (eq (preceding-char)
4871 (char-after (- (point) 2)))
4872 (save-excursion
4873 (forward-char -2)
4874 (= 0 (% (skip-chars-backward "\\\\") 2)))
4875 (forward-char -1)))
20675f5d 4876 ;; Now we are after the first part.
05bbd9c3
IZ
4877 (and is-2arg ; Have trailing part
4878 (not ender)
4879 (eq (following-char) starter) ; Empty trailing part
3ee700d1
IZ
4880 (progn
4881 (or (eq (char-syntax (following-char)) ?.)
4882 ;; Make trailing letter into punctuation
4883 (cperl-modify-syntax-type (point) cperl-st-punct))
4884 (setq is-2arg nil go-forward t))) ; Ignore the tail
05bbd9c3
IZ
4885 (if is-2arg ; Not number => have second part
4886 (progn
4887 (setq i (point) i2 i)
4888 (if ender
3ee700d1 4889 (if (memq (following-char) '(?\ ?\t ?\n ?\f))
05bbd9c3 4890 (progn
3ee700d1
IZ
4891 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
4892 (goto-char (match-end 0))
4893 (skip-chars-forward " \t\n\f"))
05bbd9c3
IZ
4894 (setq i2 (point))))
4895 (forward-char -1))
4896 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
8cfd7987 4897 (if ender (modify-syntax-entry ender "." st))
05bbd9c3 4898 (setq set-st nil)
8f95267c 4899 (setq ender (cperl-forward-re lim end nil st-l err-l
20675f5d
IZ
4900 argument starter ender)
4901 ender (nth 2 ender)))))
3ee700d1
IZ
4902 (error (goto-char lim)
4903 (setq set-st nil)
7bcea553
IZ
4904 (if reset-st
4905 (set-syntax-table reset-st))
3ee700d1
IZ
4906 (or end
4907 (message
20675f5d 4908 "End of `%s%s%c ... %c' string/RE not found: %s"
3ee700d1
IZ
4909 argument
4910 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
4911 starter (or ender starter) bb)
4912 (or (car err-l) (setcar err-l b)))))
05bbd9c3
IZ
4913 (if set-st
4914 (progn
4915 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
4916 (if ender (modify-syntax-entry ender "." st))))
20675f5d
IZ
4917 ;; i: have 2 args, after end of the first arg
4918 ;; i2: start of the second arg, if any (before delim iff `ender').
4919 ;; ender: the last arg bounded by parens-like chars, the second one of them
4920 ;; starter: the starting delimiter of the first arg
7bcea553 4921 ;; go-forward: has 2 args, and the second part is empty
3ee700d1 4922 (list i i2 ender starter go-forward)))
05bbd9c3 4923
8f95267c
RGS
4924(defun cperl-forward-group-in-re (&optional st-l)
4925 "Find the end of a group in a REx.
4926Return the error message (if any). Does not work if delimiter is `)'.
4927Works before syntax recognition is done."
4928 ;; Works *before* syntax recognition is done
4929 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
4930 (let (st b reset-st)
4931 (condition-case b
4932 (progn
4933 (setq st (cperl-cached-syntax-table st-l))
4934 (modify-syntax-entry ?\( "()" st)
4935 (modify-syntax-entry ?\) ")(" st)
4936 (setq reset-st (syntax-table))
4937 (set-syntax-table st)
4938 (forward-sexp 1))
4939 (error (message
4940 "cperl-forward-group-in-re: error %s" b)))
4941 ;; now restore the initial state
4942 (if st
4943 (progn
4944 (modify-syntax-entry ?\( "." st)
4945 (modify-syntax-entry ?\) "." st)))
4946 (if reset-st
4947 (set-syntax-table reset-st))
4948 b))
4949
4950
6c72d195 4951(defvar font-lock-string-face)
20675f5d 4952;;(defvar font-lock-reference-face)
6c72d195 4953(defvar font-lock-constant-face)
8cfd7987 4954(defsubst cperl-postpone-fontification (b e type val &optional now)
20675f5d
IZ
4955 ;; Do after syntactic fontification?
4956 (if cperl-syntaxify-by-font-lock
4957 (or now (put-text-property b e 'cperl-postpone (cons type val)))
8cfd7987 4958 (put-text-property b e type val)))
20675f5d
IZ
4959
4960;;; Here is how the global structures (those which cannot be
4961;;; recognized locally) are marked:
8cfd7987 4962;; a) PODs:
20675f5d
IZ
4963;; Start-to-end is marked `in-pod' ==> t
4964;; Each non-literal part is marked `syntax-type' ==> `pod'
4965;; Each literal part is marked `syntax-type' ==> `in-pod'
8cfd7987 4966;; b) HEREs:
20675f5d
IZ
4967;; Start-to-end is marked `here-doc-group' ==> t
4968;; The body is marked `syntax-type' ==> `here-doc'
4969;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
8cfd7987
JH
4970;; c) FORMATs:
4971;; First line (to =) marked `first-format-line' ==> t
4972;; After-this--to-end is marked `syntax-type' ==> `format'
4973;; d) 'Q'uoted string:
4584684c 4974;; part between markers inclusive is marked `syntax-type' ==> `string'
7bcea553 4975;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
8f95267c
RGS
4976;; second part of s///e is marked `syntax-type' ==> `multiline'
4977;; e) Attributes of subroutines: `attrib-group' ==> t
4978;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
4979;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
4980
4981;;; In addition, some parts of RExes may be marked as `REx-interpolated'
4982;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
20675f5d 4983
4584684c
GS
4984(defun cperl-unwind-to-safe (before &optional end)
4985 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
4986 (let ((pos (point)) opos)
8f95267c
RGS
4987 (while (and pos (progn
4988 (beginning-of-line)
4989 (get-text-property (setq pos (point)) 'syntax-type)))
4990 (setq opos pos
4991 pos (cperl-beginning-of-property pos 'syntax-type))
4992 (if (eq pos (point-min))
4993 (setq pos nil))
20675f5d
IZ
4994 (if pos
4995 (if before
4996 (progn
4997 (goto-char (cperl-1- pos))
4998 (beginning-of-line)
4999 (setq pos (point)))
5000 (goto-char (setq pos (cperl-1- pos))))
5001 ;; Up to the start
4584684c 5002 (goto-char (point-min))))
7bcea553
IZ
5003 ;; Skip empty lines
5004 (and (looking-at "\n*=")
5005 (/= 0 (skip-chars-backward "\n"))
5006 (forward-char))
5007 (setq pos (point))
4584684c
GS
5008 (if end
5009 ;; Do the same for end, going small steps
8f95267c 5010 (save-excursion
4584684c
GS
5011 (while (and end (get-text-property end 'syntax-type))
5012 (setq pos end
8f95267c
RGS
5013 end (next-single-property-change end 'syntax-type nil (point-max)))
5014 (if end (progn (goto-char end)
5015 (or (bolp) (forward-line 1))
5016 (setq end (point)))))
4584684c 5017 (or end pos)))))
20675f5d 5018
8f95267c 5019;;; These are needed for byte-compile (at least with v19)
7bcea553 5020(defvar cperl-nonoverridable-face)
8f95267c 5021(defvar font-lock-variable-name-face)
7bcea553 5022(defvar font-lock-function-name-face)
8f95267c
RGS
5023(defvar font-lock-keyword-face)
5024(defvar font-lock-builtin-face)
5025(defvar font-lock-type-face)
7bcea553 5026(defvar font-lock-comment-face)
8f95267c 5027(defvar font-lock-warning-face)
7bcea553 5028
8f95267c
RGS
5029(defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
5030 "Syntaxically mark (and fontify) attributes of a subroutine.
5031Should be called with the point before leading colon of an attribute."
5032 ;; Works *before* syntax recognition is done
5033 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
5034 (let (st b p reset-st after-first (start (point)) start1 end1)
5035 (condition-case b
5036 (while (looking-at
5037 (concat
5038 "\\(" ; 1=optional? colon
5039 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
5040 "\\)"
5041 (if after-first "?" "")
5042 ;; No space between name and paren allowed...
5043 "\\(\\sw+\\)" ; 3=name
5044 "\\((\\)?")) ; 4=optional paren
5045 (and (match-beginning 1)
5046 (cperl-postpone-fontification
5047 (match-beginning 0) (cperl-1+ (match-beginning 0))
5048 'face font-lock-constant-face))
5049 (setq start1 (match-beginning 3) end1 (match-end 3))
5050 (cperl-postpone-fontification start1 end1
5051 'face font-lock-constant-face)
5052 (goto-char end1) ; end or before `('
5053 (if (match-end 4) ; Have attribute arguments...
5054 (progn
5055 (if st nil
5056 (setq st (cperl-cached-syntax-table st-l))
5057 (modify-syntax-entry ?\( "()" st)
5058 (modify-syntax-entry ?\) ")(" st))
5059 (setq reset-st (syntax-table) p (point))
5060 (set-syntax-table st)
5061 (forward-sexp 1)
5062 (set-syntax-table reset-st)
5063 (setq reset-st nil)
5064 (cperl-commentify p (point) t))) ; mark as string
5065 (forward-comment (buffer-size))
5066 (setq after-first t))
5067 (error (message
5068 "L%d: attribute `%s': %s"
5069 (count-lines (point-min) (point))
5070 (and start1 end1 (buffer-substring start1 end1)) b)
5071 (setq start nil)))
5072 (and start
5073 (progn
5074 (put-text-property start (point)
5075 'attrib-group (if (looking-at "{") t 0))
5076 (and pos
5077 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
5078 ;; Apparently, we do not need `multiline': faces added now
5079 (put-text-property (+ 3 pos) (cperl-1+ (point))
5080 'syntax-type 'sub-decl))
5081 (and b-fname ; Fontify here: the following condition
5082 (cperl-postpone-fontification ; is too hard to determine by
5083 b-fname e-fname 'face ; a REx, so do it here
5084 (if (looking-at "{")
5085 font-lock-function-name-face
5086 font-lock-variable-name-face)))))
5087 ;; now restore the initial state
5088 (if st
5089 (progn
5090 (modify-syntax-entry ?\( "." st)
5091 (modify-syntax-entry ?\) "." st)))
5092 (if reset-st
5093 (set-syntax-table reset-st))))
5094
5095(defsubst cperl-look-at-leading-count (is-x-REx e)
5096 (if (and
5097 (< (point) e)
5098 (re-search-forward (concat "\\=" (if is-x-REx "[ \t\n]*" "") "[{?+*]")
5099 (1- e) t)) ; return nil on failure, no moving
5100 (if (eq ?\{ (preceding-char)) nil
5101 (cperl-postpone-fontification
5102 (1- (point)) (point)
5103 'face font-lock-warning-face))))
5104
5105;;; Debugging this may require (setq max-specpdl-size 2000)...
5106(defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
05bbd9c3 5107 "Scans the buffer for hard-to-parse Perl constructions.
8cfd7987
JH
5108If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
5109the sections using `cperl-pod-head-face', `cperl-pod-face',
c07a80fd 5110`cperl-here-face'."
5111 (interactive)
8f95267c 5112 (or min (setq min (point-min)
6c72d195
IZ
5113 cperl-syntax-state nil
5114 cperl-syntax-done-to min))
c07a80fd 5115 (or max (setq max (point-max)))
8cfd7987
JH
5116 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
5117 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
8f95267c 5118 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
8cfd7987 5119 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
8f95267c 5120 (modified (buffer-modified-p)) overshoot is-o-REx
8cfd7987 5121 (after-change-functions nil)
8f95267c 5122 (cperl-font-locking t)
8cfd7987
JH
5123 (use-syntax-state (and cperl-syntax-state
5124 (>= min (car cperl-syntax-state))))
5125 (state-point (if use-syntax-state
5126 (car cperl-syntax-state)
5127 (point-min)))
5128 (state (if use-syntax-state
5129 (cdr cperl-syntax-state)))
5130 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
5131 (st-l (list nil)) (err-l (list nil))
5132 ;; Somehow font-lock may be not loaded yet...
8f95267c 5133 ;; (e.g., when building TAGS via command-line call)
8cfd7987
JH
5134 (font-lock-string-face (if (boundp 'font-lock-string-face)
5135 font-lock-string-face
5136 'font-lock-string-face))
8f95267c 5137 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
8cfd7987
JH
5138 font-lock-constant-face
5139 'font-lock-constant-face))
8f95267c
RGS
5140 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
5141 (if (boundp 'font-lock-function-name-face)
5142 font-lock-function-name-face
5143 'font-lock-function-name-face))
5144 (font-lock-variable-name-face ; interpolated vars and ({})-code
5145 (if (boundp 'font-lock-variable-name-face)
5146 font-lock-variable-name-face
5147 'font-lock-variable-name-face))
5148 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
8cfd7987
JH
5149 (if (boundp 'font-lock-function-name-face)
5150 font-lock-function-name-face
5151 'font-lock-function-name-face))
8f95267c
RGS
5152 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
5153 (if (boundp 'font-lock-constant-face)
5154 font-lock-constant-face
5155 'font-lock-constant-face))
5156 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
5157 (if (boundp 'font-lock-builtin-face)
5158 font-lock-builtin-face
5159 'font-lock-builtin-face))
8cfd7987
JH
5160 (font-lock-comment-face
5161 (if (boundp 'font-lock-comment-face)
5162 font-lock-comment-face
5163 'font-lock-comment-face))
8f95267c
RGS
5164 (font-lock-warning-face
5165 (if (boundp 'font-lock-warning-face)
5166 font-lock-warning-face
5167 'font-lock-warning-face))
5168 (my-cperl-REx-ctl-face ; (|)
5169 (if (boundp 'font-lock-keyword-face)
5170 font-lock-keyword-face
5171 'font-lock-keyword-face))
5172 (my-cperl-REx-modifiers-face ; //gims
8cfd7987
JH
5173 (if (boundp 'cperl-nonoverridable-face)
5174 cperl-nonoverridable-face
5175 'cperl-nonoverridable-face))
8f95267c
RGS
5176 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
5177 (if (boundp 'font-lock-type-face)
5178 font-lock-type-face
5179 'font-lock-type-face))
8cfd7987
JH
5180 (stop-point (if ignore-max
5181 (point-max)
5182 max))
5183 (search
5184 (concat
8f95267c 5185 "\\(\\`\n?\\|^\n\\)=" ; POD
8cfd7987
JH
5186 "\\|"
5187 ;; One extra () before this:
8f95267c 5188 "<<" ; HERE-DOC
8cfd7987
JH
5189 "\\(" ; 1 + 1
5190 ;; First variant "BLAH" or just ``.
5191 "[ \t]*" ; Yes, whitespace is allowed!
5192 "\\([\"'`]\\)" ; 2 + 1 = 3
5193 "\\([^\"'`\n]*\\)" ; 3 + 1
5194 "\\3"
5195 "\\|"
5196 ;; Second variant: Identifier or \ID (same as 'ID') or empty
5197 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
5198 ;; Do not have <<= or << 30 or <<30 or << $blah.
5199 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
5200 "\\(\\)" ; To preserve count of pars :-( 6 + 1
5201 "\\)"
5202 "\\|"
5203 ;; 1+6 extra () before this:
8f95267c 5204 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$" ;FRMAT
8cfd7987 5205 (if cperl-use-syntax-table-text-property
6c72d195 5206 (concat
6c72d195 5207 "\\|"
8cfd7987 5208 ;; 1+6+2=9 extra () before this:
8f95267c 5209 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>" ; QUOTED CONSTRUCT
8cfd7987
JH
5210 "\\|"
5211 ;; 1+6+2+1=10 extra () before this:
5212 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
5213 "\\|"
8f95267c
RGS
5214 ;; 1+6+2+1+1=11 extra () before this
5215 "\\<sub\\>" ; sub with proto/attr
5216 "\\("
5217 cperl-white-and-comment-rex
5218 "\\(::[a-zA-Z_:'0-9]*\\|[a-zA-Z_'][a-zA-Z_:'0-9]*\\)\\)?" ; name
5219 "\\("
5220 cperl-maybe-white-and-comment-rex
5221 "\\(([^()]*)\\|:[^:]\\)\\)" ; prototype or attribute start
8cfd7987 5222 "\\|"
8f95267c
RGS
5223 ;; 1+6+2+1+1+6=17 extra () before this:
5224 "\\$\\(['{]\\)" ; $' or ${foo}
8cfd7987 5225 "\\|"
8f95267c
RGS
5226 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
5227 ;; we do not support intervening comments...):
8cfd7987 5228 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
8f95267c 5229 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
8cfd7987 5230 "\\|"
8f95267c
RGS
5231 "__\\(END\\|DATA\\)__" ; __END__ or __DATA__
5232 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
6c72d195 5233 "\\|"
8f95267c 5234 "\\\\\\(['`\"($]\\)") ; BACKWACKED something-hairy
8cfd7987 5235 ""))))
c07a80fd 5236 (unwind-protect
5237 (progn
5238 (save-excursion
3ee700d1
IZ
5239 (or non-inter
5240 (message "Scanning for \"hard\" Perl constructions..."))
8f95267c 5241 ;;(message "find: %s --> %s" min max)
6c72d195 5242 (and cperl-pod-here-fontify
8cfd7987
JH
5243 ;; We had evals here, do not know why...
5244 (setq face cperl-pod-face
5245 head-face cperl-pod-head-face
5246 here-face cperl-here-face))
5247 (remove-text-properties min max
20675f5d 5248 '(syntax-type t in-pod t syntax-table t
8f95267c
RGS
5249 attrib-group t
5250 REx-interpolated t
7bcea553
IZ
5251 cperl-postpone t
5252 syntax-subtype t
5253 rear-nonsticky t
8f95267c 5254 front-sticky t
8cfd7987
JH
5255 here-doc-group t
5256 first-format-line t
8f95267c 5257 REx-part2 t
7bcea553 5258 indentable t))
c07a80fd 5259 ;; Need to remove face as well...
5260 (goto-char min)
6c72d195 5261 (and (eq system-type 'emx)
8f95267c
RGS
5262 (eq (point) 1)
5263 (let ((case-fold-search t))
5264 (looking-at "extproc[ \t]")) ; Analogue of #!
8cfd7987 5265 (cperl-commentify min
6c72d195
IZ
5266 (save-excursion (end-of-line) (point))
5267 nil))
5268 (while (and
5269 (< (point) max)
5270 (re-search-forward search max t))
5271 (setq tmpend nil) ; Valid for most cases
8f95267c
RGS
5272 (setq b (match-beginning 0)
5273 state (save-excursion (parse-partial-sexp
5274 state-point b nil nil state))
5275 state-point b)
8cfd7987 5276 (cond
8f95267c
RGS
5277 ;; 1+6+2+1+1+6=17 extra () before this:
5278 ;; "\\$\\(['{]\\)"
5279 ((match-beginning 18) ; $' or ${foo}
5280 (if (eq (preceding-char) ?\') ; $'
5281 (progn
5282 (setq b (1- (point))
5283 state (parse-partial-sexp
5284 state-point (1- b) nil nil state)
5285 state-point (1- b))
5286 (if (nth 3 state) ; in string
5287 (cperl-modify-syntax-type (1- b) cperl-st-punct))
5288 (goto-char (1+ b)))
5289 ;; else: ${
5290 (setq bb (match-beginning 0))
5291 (cperl-modify-syntax-type bb cperl-st-punct)))
5292 ;; No processing in strings/comments beyond this point:
5293 ((or (nth 3 state) (nth 4 state))
5294 t) ; Do nothing in comment/string
499d5216 5295 ((match-beginning 1) ; POD section
8cfd7987 5296 ;; "\\(\\`\n?\\|^\n\\)="
8f95267c
RGS
5297 (setq b (match-beginning 0)
5298 state (parse-partial-sexp
5299 state-point b nil nil state)
5300 state-point b)
5301 (if (or (nth 3 state) (nth 4 state)
5302 (looking-at "cut\\>"))
5303 (if (or (nth 3 state) (nth 4 state) ignore-max)
6c72d195 5304 nil ; Doing a chunk only
3ee700d1 5305 (message "=cut is not preceded by a POD section")
05bbd9c3 5306 (or (car err-l) (setcar err-l (point))))
c07a80fd 5307 (beginning-of-line)
8cfd7987
JH
5308
5309 (setq b (point)
6c72d195 5310 bb b
20675f5d
IZ
5311 tb (match-beginning 0)
5312 b1 nil) ; error condition
6c72d195
IZ
5313 ;; We do not search to max, since we may be called from
5314 ;; some hook of fontification, and max is random
7bcea553 5315 (or (re-search-forward "^\n=cut\\>" stop-point 'toend)
ebcd4dbc 5316 (progn
7bcea553
IZ
5317 (goto-char b)
5318 (if (re-search-forward "\n=cut\\>" stop-point 'toend)
5319 (progn
5320 (message "=cut is not preceded by an empty line")
5321 (setq b1 t)
5322 (or (car err-l) (setcar err-l b))))))
ebcd4dbc 5323 (beginning-of-line 2) ; An empty line after =cut is not POD!
499d5216 5324 (setq e (point))
7bcea553
IZ
5325 (and (> e max)
5326 (progn
8cfd7987 5327 (remove-text-properties
7bcea553 5328 max e '(syntax-type t in-pod t syntax-table t
8f95267c
RGS
5329 attrib-group t
5330 REx-interpolated t
7bcea553
IZ
5331 cperl-postpone t
5332 syntax-subtype t
8cfd7987 5333 here-doc-group t
7bcea553 5334 rear-nonsticky t
8f95267c 5335 front-sticky t
8cfd7987 5336 first-format-line t
8f95267c 5337 REx-part2 t
7bcea553
IZ
5338 indentable t))
5339 (setq tmpend tb)))
5340 (put-text-property b e 'in-pod t)
5341 (put-text-property b e 'syntax-type 'in-pod)
5342 (goto-char b)
5343 (while (re-search-forward "\n\n[ \t]" e t)
5344 ;; We start 'pod 1 char earlier to include the preceding line
5345 (beginning-of-line)
5346 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5347 (cperl-put-do-not-fontify b (point) t)
5348 ;; mark the non-literal parts as PODs
8cfd7987 5349 (if cperl-pod-here-fontify
7bcea553
IZ
5350 (cperl-postpone-fontification b (point) 'face face t))
5351 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
5352 (beginning-of-line)
5353 (setq b (point)))
5354 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5355 (cperl-put-do-not-fontify (point) e t)
8cfd7987
JH
5356 (if cperl-pod-here-fontify
5357 (progn
7bcea553
IZ
5358 ;; mark the non-literal parts as PODs
5359 (cperl-postpone-fontification (point) e 'face face t)
5360 (goto-char bb)
8cfd7987 5361 (if (looking-at
7bcea553 5362 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
20675f5d 5363 ;; mark the headers
8cfd7987 5364 (cperl-postpone-fontification
20675f5d 5365 (match-beginning 1) (match-end 1)
7bcea553
IZ
5366 'face head-face))
5367 (while (re-search-forward
5368 ;; One paragraph
5369 "^\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
5370 e 'toend)
5371 ;; mark the headers
8cfd7987 5372 (cperl-postpone-fontification
7bcea553
IZ
5373 (match-beginning 1) (match-end 1)
5374 'face head-face))))
5375 (cperl-commentify bb e nil)
5376 (goto-char e)
5377 (or (eq e (point-max))
8cfd7987 5378 (forward-char -1)))) ; Prepare for immediate POD start.
55497cff 5379 ;; Here document
8f95267c
RGS
5380 ;; We can do many here-per-line;
5381 ;; but multiline quote on the same line as <<HERE confuses us...
6c72d195 5382 ;; ;; One extra () before this:
8cfd7987 5383 ;;"<<"
6c72d195
IZ
5384 ;; "\\(" ; 1 + 1
5385 ;; ;; First variant "BLAH" or just ``.
8cfd7987 5386 ;; "[ \t]*" ; Yes, whitespace is allowed!
6c72d195
IZ
5387 ;; "\\([\"'`]\\)" ; 2 + 1
5388 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
5389 ;; "\\3"
5390 ;; "\\|"
5391 ;; ;; Second variant: Identifier or \ID or empty
5392 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
5393 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
5394 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
5395 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
5396 ;; "\\)"
55497cff 5397 ((match-beginning 2) ; 1 + 1
8f95267c 5398 (setq b (point)
6c72d195 5399 tb (match-beginning 0)
8f95267c
RGS
5400 c (and ; not HERE-DOC
5401 (match-beginning 5)
5402 (save-match-data
5403 (or (looking-at "[ \t]*(") ; << function_call()
5404 (save-excursion ; 1 << func_name, or $foo << 10
5405 (condition-case nil
5406 (progn
5407 (goto-char tb)
5408 ;;; XXX What to do: foo <<bar ???
5409 ;;; XXX Need to support print {a} <<B ???
5410 (forward-sexp -1)
5411 (save-match-data
5412 ; $foo << b; $f .= <<B;
5413 ; ($f+1) << b; a($f) . <<B;
5414 ; foo 1, <<B; $x{a} <<b;
5415 (cond
5416 ((looking-at "[0-9$({]")
5417 (forward-sexp 1)
5418 (and
5419 (looking-at "[ \t]*<<")
5420 (condition-case nil
5421 ;; print $foo <<EOF
5422 (progn
5423 (forward-sexp -2)
5424 (not
5425 (looking-at "\\(printf?\\|system\\|exec\\|sort\\)\\>")))
5426 (error t)))))))
5427 (error nil))) ; func(<<EOF)
5428 (and (not (match-beginning 6)) ; Empty
5429 (looking-at
5430 "[ \t]*[=0-9$@%&(]"))))))
6c72d195
IZ
5431 (if c ; Not here-doc
5432 nil ; Skip it.
8f95267c 5433 (setq c (match-end 2)) ; 1 + 1
55497cff 5434 (if (match-beginning 5) ;4 + 1
5435 (setq b1 (match-beginning 5) ; 4 + 1
5436 e1 (match-end 5)) ; 4 + 1
5437 (setq b1 (match-beginning 4) ; 3 + 1
5438 e1 (match-end 4))) ; 3 + 1
5439 (setq tag (buffer-substring b1 e1)
5440 qtag (regexp-quote tag))
8cfd7987 5441 (cond (cperl-pod-here-fontify
20675f5d 5442 ;; Highlight the starting delimiter
8f95267c
RGS
5443 (cperl-postpone-fontification
5444 b1 e1 'face my-cperl-delimiters-face)
20675f5d 5445 (cperl-put-do-not-fontify b1 e1 t)))
55497cff 5446 (forward-line)
8f95267c
RGS
5447 (setq i (point))
5448 (if end-of-here-doc
5449 (goto-char end-of-here-doc))
55497cff 5450 (setq b (point))
6c72d195
IZ
5451 ;; We do not search to max, since we may be called from
5452 ;; some hook of fontification, and max is random
8cfd7987
JH
5453 (or (and (re-search-forward (concat "^" qtag "$")
5454 stop-point 'toend)
8f95267c
RGS
5455 ;;;(eq (following-char) ?\n) ; XXXX WHY???
5456 )
8cfd7987
JH
5457 (progn ; Pretend we matched at the end
5458 (goto-char (point-max))
5459 (re-search-forward "\\'")
5460 (message "End of here-document `%s' not found." tag)
5461 (or (car err-l) (setcar err-l b))))
5462 (if cperl-pod-here-fontify
5463 (progn
5464 ;; Highlight the ending delimiter
8f95267c
RGS
5465 (cperl-postpone-fontification
5466 (match-beginning 0) (match-end 0)
5467 'face my-cperl-delimiters-face)
8cfd7987
JH
5468 (cperl-put-do-not-fontify b (match-end 0) t)
5469 ;; Highlight the HERE-DOC
5470 (cperl-postpone-fontification b (match-beginning 0)
5471 'face here-face)))
5472 (setq e1 (cperl-1+ (match-end 0)))
5473 (put-text-property b (match-beginning 0)
5474 'syntax-type 'here-doc)
5475 (put-text-property (match-beginning 0) e1
5476 'syntax-type 'here-doc-delim)
8f95267c
RGS
5477 (put-text-property b e1 'here-doc-group t)
5478 ;; This makes insertion at the start of HERE-DOC update
5479 ;; the whole construct:
5480 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
8cfd7987
JH
5481 (cperl-commentify b e1 nil)
5482 (cperl-put-do-not-fontify b (match-end 0) t)
8f95267c
RGS
5483 ;; Cache the syntax info...
5484 (setq cperl-syntax-state (cons state-point state))
5485 ;; ... and process the rest of the line...
5486 (setq overshoot
5487 (elt ; non-inter ignore-max
5488 (cperl-find-pods-heres c i t end t e1) 1))
5489 (if (and overshoot (> overshoot (point)))
5490 (goto-char overshoot)
5491 (setq overshoot e1))
8cfd7987
JH
5492 (if (> e1 max)
5493 (setq tmpend tb))))
55497cff 5494 ;; format
ebcd4dbc 5495 ((match-beginning 8)
5f05dabc 5496 ;; 1+6=7 extra () before this:
ebcd4dbc 5497 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
55497cff 5498 (setq b (point)
5f05dabc 5499 name (if (match-beginning 8) ; 7 + 1
5500 (buffer-substring (match-beginning 8) ; 7 + 1
5501 (match-end 8)) ; 7 + 1
6c72d195
IZ
5502 "")
5503 tb (match-beginning 0))
55497cff 5504 (setq argument nil)
8cfd7987
JH
5505 (put-text-property (save-excursion
5506 (beginning-of-line)
5507 (point))
5508 b 'first-format-line 't)
5509 (if cperl-pod-here-fontify
55497cff 5510 (while (and (eq (forward-line) 0)
5511 (not (looking-at "^[.;]$")))
5512 (cond
5513 ((looking-at "^#")) ; Skip comments
5514 ((and argument ; Skip argument multi-lines
8cfd7987 5515 (looking-at "^[ \t]*{"))
55497cff 5516 (forward-sexp 1)
5517 (setq argument nil))
5518 (argument ; Skip argument lines
5519 (setq argument nil))
5520 (t ; Format line
5521 (setq b1 (point))
5522 (setq argument (looking-at "^[^\n]*[@^]"))
5523 (end-of-line)
20675f5d 5524 ;; Highlight the format line
8cfd7987
JH
5525 (cperl-postpone-fontification b1 (point)
5526 'face font-lock-string-face)
ebcd4dbc 5527 (cperl-commentify b1 (point) nil)
20675f5d 5528 (cperl-put-do-not-fontify b1 (point) t))))
6c72d195
IZ
5529 ;; We do not search to max, since we may be called from
5530 ;; some hook of fontification, and max is random
5531 (re-search-forward "^[.;]$" stop-point 'toend))
55497cff 5532 (beginning-of-line)
8cfd7987 5533 (if (looking-at "^\\.$") ; ";" is not supported yet
55497cff 5534 (progn
20675f5d
IZ
5535 ;; Highlight the ending delimiter
5536 (cperl-postpone-fontification (point) (+ (point) 2)
8cfd7987 5537 'face font-lock-string-face)
ebcd4dbc 5538 (cperl-commentify (point) (+ (point) 2) nil)
20675f5d 5539 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
ebcd4dbc 5540 (message "End of format `%s' not found." name)
05bbd9c3 5541 (or (car err-l) (setcar err-l b)))
55497cff 5542 (forward-line)
6c72d195
IZ
5543 (if (> (point) max)
5544 (setq tmpend tb))
5545 (put-text-property b (point) 'syntax-type 'format))
8f95267c 5546 ;; qq-like String or Regexp:
ebcd4dbc
IZ
5547 ((or (match-beginning 10) (match-beginning 11))
5548 ;; 1+6+2=9 extra () before this:
20675f5d 5549 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
05bbd9c3 5550 ;; "\\|"
6c72d195 5551 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
ebcd4dbc
IZ
5552 (setq b1 (if (match-beginning 10) 10 11)
5553 argument (buffer-substring
5554 (match-beginning b1) (match-end b1))
8f95267c 5555 b (point) ; end of qq etc
ebcd4dbc
IZ
5556 i b
5557 c (char-after (match-beginning b1))
8f95267c 5558 bb (char-after (1- (match-beginning b1))) ; tmp holder
4584684c 5559 ;; bb == "Not a stringy"
20675f5d 5560 bb (if (eq b1 10) ; user variables/whatever
8cfd7987
JH
5561 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
5562 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
5563 ((eq bb ?\:) ; $opt::s
5564 (eq (char-after
5565 (- (match-beginning b1) 2))
5566 ?\:))
5567 ((eq bb ?\>) ; $foo->s
5568 (eq (char-after
5569 (- (match-beginning b1) 2))
5570 ?\-))
5571 ((eq bb ?\&)
8f95267c 5572 (not (eq (char-after ; &&m/blah/
8cfd7987
JH
5573 (- (match-beginning b1) 2))
5574 ?\&)))
5575 (t t)))
20675f5d
IZ
5576 ;; <file> or <$file>
5577 (and (eq c ?\<)
7bcea553 5578 ;; Do not stringify <FH>, <$fh> :
20675f5d 5579 (save-match-data
8cfd7987 5580 (looking-at
7bcea553 5581 "\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\)?>"))))
6c72d195
IZ
5582 tb (match-beginning 0))
5583 (goto-char (match-beginning b1))
5584 (cperl-backward-to-noncomment (point-min))
ebcd4dbc 5585 (or bb
6c72d195 5586 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
ebcd4dbc 5587 (setq argument ""
8cfd7987 5588 b1 nil
6c72d195 5589 bb ; Not a regexp?
8f95267c
RGS
5590 (not
5591 ;; What is below: regexp-p?
5592 (and
5593 (or (memq (preceding-char)
5594 (append (if (memq c '(?\? ?\<))
5595 ;; $a++ ? 1 : 2
5596 "~{(=|&*!,;:["
5597 "~{(=|&+-*!,;:[") nil))
5598 (and (eq (preceding-char) ?\})
5599 (cperl-after-block-p (point-min)))
5600 (and (eq (char-syntax (preceding-char)) ?w)
5601 (progn
5602 (forward-sexp -1)
6c72d195
IZ
5603;;; After these keywords `/' starts a RE. One should add all the
5604;;; functions/builtins which expect an argument, but ...
8f95267c
RGS
5605 (if (eq (preceding-char) ?-)
5606 ;; -d ?foo? is a RE
5607 (looking-at "[a-zA-Z]\\>")
5608 (and
5609 (not (memq (preceding-char)
5610 '(?$ ?@ ?& ?%)))
5611 (looking-at
5612 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
5613 (and (eq (preceding-char) ?.)
5614 (eq (char-after (- (point) 2)) ?.))
5615 (bobp))
5616 ;; m|blah| ? foo : bar;
5617 (not
5618 (and (eq c ?\?)
5619 cperl-use-syntax-table-text-property
5620 (not (bobp))
5621 (progn
5622 (forward-char -1)
5623 (looking-at "\\s|"))))))
6c72d195
IZ
5624 b (1- b))
5625 ;; s y tr m
8cfd7987
JH
5626 ;; Check for $a -> y
5627 (setq b1 (preceding-char)
5628 go (point))
5629 (if (and (eq b1 ?>)
5630 (eq (char-after (- go 2)) ?-))
6c72d195
IZ
5631 ;; Not a regexp
5632 (setq bb t))))
8cfd7987
JH
5633 (or bb
5634 (progn
8f95267c 5635 (goto-char b)
8cfd7987
JH
5636 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
5637 (goto-char (match-end 0))
5638 (skip-chars-forward " \t\n\f"))
5639 (cond ((and (eq (following-char) ?\})
5640 (eq b1 ?\{))
5641 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
5642 (goto-char (1- go))
5643 (skip-chars-backward " \t\n\f")
5644 (if (memq (preceding-char) (append "$@%&*" nil))
5645 (setq bb t) ; @{y}
5646 (condition-case nil
5647 (forward-sexp -1)
5648 (error nil)))
5649 (if (or bb
5650 (looking-at ; $foo -> {s}
5651 "[$@]\\$*\\([a-zA-Z0-9_:]+\\|[^{]\\)\\([ \t\n]*->\\)?[ \t\n]*{")
5652 (and ; $foo[12] -> {s}
5653 (memq (following-char) '(?\{ ?\[))
5654 (progn
5655 (forward-sexp 1)
5656 (looking-at "\\([ \t\n]*->\\)?[ \t\n]*{"))))
5657 (setq bb t)
5658 (goto-char b)))
5659 ((and (eq (following-char) ?=)
5660 (eq (char-after (1+ (point))) ?\>))
5661 ;; Check for { foo => 1, s => 2 }
5662 ;; Apparently s=> is never a substitution...
5663 (setq bb t))
5664 ((and (eq (following-char) ?:)
5665 (eq b1 ?\{) ; Check for $ { s::bar }
5666 (looking-at "::[a-zA-Z0-9_:]*[ \t\n\f]*}")
8f95267c 5667 (progn
8cfd7987
JH
5668 (goto-char (1- go))
5669 (skip-chars-backward " \t\n\f")
5670 (memq (preceding-char)
5671 (append "$@%&*" nil))))
8f95267c
RGS
5672 (setq bb t))
5673 ((eobp)
8cfd7987
JH
5674 (setq bb t)))))
5675 (if bb
ebcd4dbc 5676 (goto-char i)
7bcea553 5677 ;; Skip whitespace and comments...
3ee700d1
IZ
5678 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
5679 (goto-char (match-end 0))
5680 (skip-chars-forward " \t\n\f"))
7bcea553
IZ
5681 (if (> (point) b)
5682 (put-text-property b (point) 'syntax-type 'prestring))
05bbd9c3
IZ
5683 ;; qtag means two-arg matcher, may be reset to
5684 ;; 2 or 3 later if some special quoting is needed.
5685 ;; e1 means matching-char matcher.
8f95267c 5686 (setq b (point) ; before the first delimiter
20675f5d
IZ
5687 ;; has 2 args
5688 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
6c72d195
IZ
5689 ;; We do not search to max, since we may be called from
5690 ;; some hook of fontification, and max is random
5691 i (cperl-forward-re stop-point end
20675f5d 5692 i2
8f95267c
RGS
5693 st-l err-l argument)
5694 ;; If `go', then it is considered as 1-arg, `b1' is nil
5695 ;; as in s/foo//x; the point is before final "slash"
20675f5d 5696 b1 (nth 1 i) ; start of the second part
8cfd7987 5697 tag (nth 2 i) ; ender-char, true if second part
20675f5d 5698 ; is with matching chars []
3ee700d1 5699 go (nth 4 i) ; There is a 1-char part after the end
05bbd9c3 5700 i (car i) ; intermediate point
8cfd7987 5701 e1 (point) ; end
20675f5d 5702 ;; Before end of the second part if non-matching: ///
8cfd7987 5703 tail (if (and i (not tag))
20675f5d
IZ
5704 (1- e1))
5705 e (if i i e1) ; end of the first part
7bcea553 5706 qtag nil ; need to preserve backslashitis
8f95267c
RGS
5707 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
5708 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
05bbd9c3
IZ
5709 ;; Commenting \\ is dangerous, what about ( ?
5710 (and i tail
5711 (eq (char-after i) ?\\)
20675f5d 5712 (setq qtag t))
8f95267c
RGS
5713 (and (if go (looking-at ".\\sw*x")
5714 (looking-at "\\sw*x")) ; qr//x
5715 (setq is-x-REx t))
5716 (and (if go (looking-at ".\\sw*o")
5717 (looking-at "\\sw*o")) ; //o
5718 (setq is-o-REx t))
ebcd4dbc 5719 (if (null i)
20675f5d 5720 ;; Considered as 1arg form
3ee700d1
IZ
5721 (progn
5722 (cperl-commentify b (point) t)
4584684c 5723 (put-text-property b (point) 'syntax-type 'string)
7bcea553
IZ
5724 (if (or is-x-REx
5725 ;; ignore other text properties:
5726 (string-match "^qw$" argument))
5727 (put-text-property b (point) 'indentable t))
20675f5d 5728 (and go
4584684c
GS
5729 (setq e1 (cperl-1+ e1))
5730 (or (eobp)
5731 (forward-char 1))))
ebcd4dbc 5732 (cperl-commentify b i t)
05bbd9c3 5733 (if (looking-at "\\sw*e") ; s///e
3ee700d1 5734 (progn
8f95267c
RGS
5735 ;; Cache the syntax info...
5736 (setq cperl-syntax-state (cons state-point state))
3ee700d1
IZ
5737 (and
5738 ;; silent:
8f95267c 5739 (car (cperl-find-pods-heres b1 (1- (point)) t end))
3ee700d1
IZ
5740 ;; Error
5741 (goto-char (1+ max)))
20675f5d 5742 (if (and tag (eq (preceding-char) ?\>))
3ee700d1
IZ
5743 (progn
5744 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
4584684c 5745 (cperl-modify-syntax-type i cperl-st-bra)))
7bcea553 5746 (put-text-property b i 'syntax-type 'string)
8f95267c 5747 (put-text-property i (point) 'syntax-type 'multiline)
7bcea553
IZ
5748 (if is-x-REx
5749 (put-text-property b i 'indentable t)))
20675f5d 5750 (cperl-commentify b1 (point) t)
4584684c 5751 (put-text-property b (point) 'syntax-type 'string)
7bcea553
IZ
5752 (if is-x-REx
5753 (put-text-property b i 'indentable t))
20675f5d 5754 (if qtag
6c72d195 5755 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
05bbd9c3 5756 (setq tail nil)))
20675f5d 5757 ;; Now: tail: if the second part is non-matching without ///e
ebcd4dbc 5758 (if (eq (char-syntax (following-char)) ?w)
05bbd9c3
IZ
5759 (progn
5760 (forward-word 1) ; skip modifiers s///s
20675f5d 5761 (if tail (cperl-commentify tail (point) t))
8cfd7987 5762 (cperl-postpone-fontification
8f95267c 5763 e1 (point) 'face my-cperl-REx-modifiers-face)))
20675f5d
IZ
5764 ;; Check whether it is m// which means "previous match"
5765 ;; and highlight differently
8cfd7987 5766 (setq is-REx
7bcea553
IZ
5767 (and (string-match "^\\([sm]?\\|qr\\)$" argument)
5768 (or (not (= (length argument) 0))
5769 (not (eq c ?\<)))))
8cfd7987 5770 (if (and is-REx
7bcea553 5771 (eq e (+ 2 b))
20675f5d
IZ
5772 ;; split // *is* using zero-pattern
5773 (save-excursion
5774 (condition-case nil
5775 (progn
5776 (goto-char tb)
5777 (forward-sexp -1)
5778 (not (looking-at "split\\>")))
5779 (error t))))
8cfd7987 5780 (cperl-postpone-fontification
8f95267c 5781 b e 'face font-lock-warning-face)
20675f5d
IZ
5782 (if (or i2 ; Has 2 args
5783 (and cperl-fontify-m-as-s
5784 (or
5785 (string-match "^\\(m\\|qr\\)$" argument)
5786 (and (eq 0 (length argument))
5787 (not (eq ?\< (char-after b)))))))
5788 (progn
8cfd7987 5789 (cperl-postpone-fontification
8f95267c 5790 b (cperl-1+ b) 'face my-cperl-delimiters-face)
8cfd7987 5791 (cperl-postpone-fontification
8f95267c 5792 (1- e) e 'face my-cperl-delimiters-face)))
7bcea553 5793 (if (and is-REx cperl-regexp-scan)
8f95267c
RGS
5794 ;; Process RExen: embedded comments, charclasses and ]
5795;;;/\3333\xFg\x{FFF}a\ppp\PPP\qqq\C\99f(?{ foo })(??{ foo })/;
5796;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
5797;;;/(?<=foo)(?<!bar)(x)(?:$ab|\$\/)$|\\\b\x888\776\[\:$/xxx;
5798;;;m?(\?\?{b,a})? + m/(??{aa})(?(?=xx)aa|bb)(?#aac)/;
5799;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
5800;;;m^a[\^b]c^ + m.a[^b]\.c.;
7bcea553
IZ
5801 (save-excursion
5802 (goto-char (1+ b))
8f95267c
RGS
5803 ;; First
5804 (cperl-look-at-leading-count is-x-REx e)
5805 (setq hairy-RE
5806 (concat
5807 (if is-x-REx
5808 (if (eq (char-after b) ?\#)
5809 "\\((\\?\\\\#\\)\\|\\(\\\\#\\)"
5810 "\\((\\?#\\)\\|\\(#\\)")
5811 ;; keep the same count: add a fake group
5812 (if (eq (char-after b) ?\#)
5813 "\\((\\?\\\\#\\)\\(\\)"
5814 "\\((\\?#\\)\\(\\)"))
5815 "\\|"
5816 "\\(\\[\\)" ; 3=[
5817 "\\|"
5818 "\\(]\\)" ; 4=]
5819 "\\|"
5820 ;; XXXX Will not be able to use it in s)))
5821 (if (eq (char-after b) ?\) )
5822 "\\())))\\)" ; Will never match
5823 (if (eq (char-after b) ?? )
5824 ;;"\\((\\\\\\?\\(\\\\\\?\\)?{\\)"
5825 "\\((\\\\\\?\\\\\\?{\\|()\\\\\\?{\\)"
5826 "\\((\\?\\??{\\)")) ; 5= (??{ (?{
5827 "\\|" ; 6= 0-length, 7: name, 8,9:code, 10:group
5828 "\\(" ;; XXXX 1-char variables, exc. |()\s
5829 "[$@]"
5830 "\\("
5831 "[_a-zA-Z:][_a-zA-Z0-9:]*"
5832 "\\|"
5833 "{[^{}]*}" ; only one-level allowed
5834 "\\|"
5835 "[^{(|) \t\r\n\f]"
5836 "\\)"
5837 "\\(" ;;8,9:code part of array/hash elt
5838 "\\(" "->" "\\)?"
5839 "\\[[^][]*\\]"
5840 "\\|"
5841 "{[^{}]*}"
5842 "\\)*"
5843 ;; XXXX: what if u is delim?
5844 "\\|"
5845 "[)^|$.*?+]"
5846 "\\|"
5847 "{[0-9]+}"
5848 "\\|"
5849 "{[0-9]+,[0-9]*}"
5850 "\\|"
5851 "\\\\[luLUEQbBAzZG]"
5852 "\\|"
5853 "(" ; Group opener
5854 "\\(" ; 10 group opener follower
5855 "\\?\\((\\?\\)" ; 11: in (?(?=C)A|B)
5856 "\\|"
5857 "\\?[:=!>?{]" ; "?" something
5858 "\\|"
5859 "\\?[-imsx]+[:)]" ; (?i) (?-s:.)
5860 "\\|"
5861 "\\?([0-9]+)" ; (?(1)foo|bar)
5862 "\\|"
5863 "\\?<[=!]"
5864 ;;;"\\|"
5865 ;;; "\\?"
5866 "\\)?"
5867 "\\)"
5868 "\\|"
5869 "\\\\\\(.\\)" ; 12=\SYMBOL
5870 ))
7bcea553 5871 (while
8f95267c
RGS
5872 (and (< (point) (1- e))
5873 (re-search-forward hairy-RE (1- e) 'to-end))
7bcea553 5874 (goto-char (match-beginning 0))
8f95267c
RGS
5875 (setq REx-subgr-start (point)
5876 was-subgr (following-char))
5877 (cond
5878 ((match-beginning 6) ; 0-length builtins, groups
5879 (goto-char (match-end 0))
5880 (if (match-beginning 11)
5881 (goto-char (match-beginning 11)))
5882 (if (>= (point) e)
5883 (goto-char (1- e)))
5884 (cperl-postpone-fontification
5885 (match-beginning 0) (point)
5886 'face
5887 (cond
5888 ((eq was-subgr ?\) )
5889 (condition-case nil
5890 (save-excursion
5891 (forward-sexp -1)
5892 (if (> (point) b)
5893 (if (if (eq (char-after b) ?? )
5894 (looking-at "(\\\\\\?")
5895 (eq (char-after (1+ (point))) ?\?))
5896 my-cperl-REx-0length-face
5897 my-cperl-REx-ctl-face)
5898 font-lock-warning-face))
5899 (error font-lock-warning-face)))
5900 ((eq was-subgr ?\| )
5901 my-cperl-REx-ctl-face)
5902 ((eq was-subgr ?\$ )
5903 (if (> (point) (1+ REx-subgr-start))
5904 (progn
5905 (put-text-property
5906 (match-beginning 0) (point)
5907 'REx-interpolated
5908 (if is-o-REx 0
5909 (if (and (eq (match-beginning 0)
5910 (1+ b))
5911 (eq (point)
5912 (1- e))) 1 t)))
5913 font-lock-variable-name-face)
5914 my-cperl-REx-spec-char-face))
5915 ((memq was-subgr (append "^." nil) )
5916 my-cperl-REx-spec-char-face)
5917 ((eq was-subgr ?\( )
5918 (if (not (match-beginning 10))
5919 my-cperl-REx-ctl-face
5920 my-cperl-REx-0length-face))
5921 (t my-cperl-REx-0length-face)))
5922 (if (and (memq was-subgr (append "(|" nil))
5923 (not (string-match "(\\?[-imsx]+)"
5924 (match-string 0))))
5925 (cperl-look-at-leading-count is-x-REx e))
5926 (setq was-subgr nil)) ; We do stuff here
5927 ((match-beginning 12) ; \SYMBOL
5928 (forward-char 2)
5929 (if (>= (point) e)
5930 (goto-char (1- e))
5931 ;; How many chars to not highlight:
5932 ;; 0-len special-alnums in other branch =>
5933 ;; Generic: \non-alnum (1), \alnum (1+face)
5934 ;; Is-delim: \non-alnum (1/spec-2) alnum-1 (=what hai)
5935 (setq REx-subgr-start (point)
5936 qtag (preceding-char))
5937 (cperl-postpone-fontification
5938 (- (point) 2) (- (point) 1) 'face
5939 (if (memq qtag
5940 (append "ghijkmoqvFHIJKMORTVY" nil))
5941 font-lock-warning-face
5942 my-cperl-REx-0length-face))
5943 (if (and (eq (char-after b) qtag)
5944 (memq qtag (append ".])^$|*?+" nil)))
5945 (progn
5946 (if (and cperl-use-syntax-table-text-property
5947 (eq qtag ?\) ))
5948 (put-text-property
5949 REx-subgr-start (1- (point))
5950 'syntax-table cperl-st-punct))
5951 (cperl-postpone-fontification
5952 (1- (point)) (point) 'face
5953 ; \] can't appear below
5954 (if (memq qtag (append ".]^$" nil))
5955 'my-cperl-REx-spec-char-face
5956 (if (memq qtag (append "*?+" nil))
5957 'my-cperl-REx-0length-face
5958 'my-cperl-REx-ctl-face))))) ; )|
5959 ;; Test for arguments:
5960 (cond
5961 ;; This is not pretty: the 5.8.7 logic:
5962 ;; \0numx -> octal (up to total 3 dig)
5963 ;; \DIGIT -> backref unless \0
5964 ;; \DIGITs -> backref if legal
5965 ;; otherwise up to 3 -> octal
5966 ;; Do not try to distinguish, we guess
5967 ((or (and (memq qtag (append "01234567" nil))
5968 (re-search-forward
5969 "\\=[01234567]?[01234567]?"
5970 (1- e) 'to-end))
5971 (and (memq qtag (append "89" nil))
5972 (re-search-forward
5973 "\\=[0123456789]*" (1- e) 'to-end))
5974 (and (eq qtag ?x)
5975 (re-search-forward
5976 "\\=[0-9a-fA-F][0-9a-fA-F]?\\|\\={[0-9a-fA-F]+}"
5977 (1- e) 'to-end))
5978 (and (memq qtag (append "pPN" nil))
5979 (re-search-forward "\\={[^{}]+}\\|."
5980 (1- e) 'to-end))
5981 (eq (char-syntax qtag) ?w))
5982 (cperl-postpone-fontification
5983 (1- REx-subgr-start) (point)
5984 'face my-cperl-REx-length1-face))))
5985 (setq was-subgr nil)) ; We do stuff here
5986 ((match-beginning 3) ; [charclass]
5987 (forward-char 1)
5988 (if (eq (char-after b) ?^ )
5989 (and (eq (following-char) ?\\ )
5990 (eq (char-after (cperl-1+ (point)))
5991 ?^ )
5992 (forward-char 2))
5993 (and (eq (following-char) ?^ )
5994 (forward-char 1)))
5995 (setq argument b ; continue?
5996 tag nil ; list of POSIX classes
5997 qtag (point))
5998 (if (eq (char-after b) ?\] )
5999 (and (eq (following-char) ?\\ )
6000 (eq (char-after (cperl-1+ (point)))
6001 ?\] )
6002 (setq qtag (1+ qtag))
6003 (forward-char 2))
6004 (and (eq (following-char) ?\] )
6005 (forward-char 1)))
6006 ;; Apparently, I can't put \] into a charclass
6007 ;; in m]]: m][\\\]\]] produces [\\]]
6008;;; POSIX? [:word:] [:^word:] only inside []
6009;;; "\\=\\(\\\\.\\|[^][\\\\]\\|\\[:\\^?\sw+:]\\|\\[[^:]\\)*]")
6010 (while
6011 (and argument
6012 (re-search-forward
6013 (if (eq (char-after b) ?\] )
6014 "\\=\\(\\\\[^]]\\|[^]\\\\]\\)*\\\\]"
6015 "\\=\\(\\\\.\\|[^]\\\\]\\)*]")
6016 (1- e) 'toend))
6017 ;; Is this ] an end of POSIX class?
6018 (if (save-excursion
6019 (and
6020 (search-backward "[" argument t)
6021 (< REx-subgr-start (point))
6022 (not
6023 (and ; Should work with delim = \
6024 (eq (preceding-char) ?\\ )
6025 (= (% (skip-chars-backward
6026 "\\\\") 2) 0)))
6027 (looking-at
6028 (cond
6029 ((eq (char-after b) ?\] )
6030 "\\\\*\\[:\\^?\\sw+:\\\\\\]")
6031 ((eq (char-after b) ?\: )
6032 "\\\\*\\[\\\\:\\^?\\sw+\\\\:]")
6033 ((eq (char-after b) ?^ )
6034 "\\\\*\\[:\\(\\\\\\^\\)?\\sw+:\]")
6035 ((eq (char-syntax (char-after b))
6036 ?w)
6037 (concat
6038 "\\\\*\\[:\\(\\\\\\^\\)?\\(\\\\"
6039 (char-to-string (char-after b))
6040 "\\|\\sw\\)+:\]"))
6041 (t "\\\\*\\[:\\^?\\sw*:]")))
6042 (setq argument (point))))
6043 (setq tag (cons (cons argument (point))
6044 tag)
6045 argument (point)) ; continue
6046 (setq argument nil)))
6047 (and argument
6048 (message "Couldn't find end of charclass in a REx, pos=%s"
6049 REx-subgr-start))
6050 (if (and cperl-use-syntax-table-text-property
6051 (> (- (point) 2) REx-subgr-start))
6052 (put-text-property
6053 (1+ REx-subgr-start) (1- (point))
6054 'syntax-table cperl-st-punct))
6055 (cperl-postpone-fontification
6056 REx-subgr-start qtag
6057 'face my-cperl-REx-spec-char-face)
6058 (cperl-postpone-fontification
6059 (1- (point)) (point) 'face
6060 my-cperl-REx-spec-char-face)
6061 (if (eq (char-after b) ?\] )
6062 (cperl-postpone-fontification
6063 (- (point) 2) (1- (point))
6064 'face my-cperl-REx-0length-face))
6065 (while tag
6066 (cperl-postpone-fontification
6067 (car (car tag)) (cdr (car tag))
6068 'face my-cperl-REx-length1-face)
6069 (setq tag (cdr tag)))
6070 (setq was-subgr nil)) ; did facing already
6071 ;; Now rare stuff:
6072 ((and (match-beginning 2) ; #-comment
6073 (/= (match-beginning 2) (match-end 2)))
6074 (beginning-of-line 2)
6075 (if (> (point) e)
6076 (goto-char (1- e))))
6077 ((match-beginning 4) ; character "]"
6078 (setq was-subgr nil) ; We do stuff here
6079 (goto-char (match-end 0))
6080 (if cperl-use-syntax-table-text-property
6081 (put-text-property
6082 (1- (point)) (point)
6083 'syntax-table cperl-st-punct))
6084 (cperl-postpone-fontification
6085 (1- (point)) (point)
6086 'face font-lock-warning-face))
6087 ((match-beginning 5) ; before (?{}) (??{})
6088 (setq tag (match-end 0))
6089 (if (or (setq qtag
6090 (cperl-forward-group-in-re st-l))
6091 (and (>= (point) e)
6092 (setq qtag "no matching `)' found"))
6093 (and (not (eq (char-after (- (point) 2))
6094 ?\} ))
6095 (setq qtag "Can't find })")))
8cfd7987 6096 (progn
8f95267c
RGS
6097 (goto-char (1- e))
6098 (message qtag))
6099 (cperl-postpone-fontification
6100 (1- tag) (1- (point))
6101 'face font-lock-variable-name-face)
6102 (cperl-postpone-fontification
6103 REx-subgr-start (1- tag)
6104 'face my-cperl-REx-spec-char-face)
6105 (cperl-postpone-fontification
6106 (1- (point)) (point)
6107 'face my-cperl-REx-spec-char-face)
6108 (if cperl-use-syntax-table-text-property
6109 (progn
6110 (put-text-property
6111 (- (point) 2) (1- (point))
6112 'syntax-table cperl-st-cfence)
6113 (put-text-property
6114 (+ REx-subgr-start 2)
6115 (+ REx-subgr-start 3)
6116 'syntax-table cperl-st-cfence))))
6117 (setq was-subgr nil))
6118 (t ; (?#)-comment
6119 ;; Inside "(" and "\" arn't special in any way
6120 ;; Works also if the outside delimiters are ().
6121 (or;;(if (eq (char-after b) ?\) )
6122 ;;(re-search-forward
6123 ;; "[^\\\\]\\(\\\\\\\\\\)*\\\\)"
6124 ;; (1- e) 'toend)
6125 (search-forward ")" (1- e) 'toend)
6126 ;;)
6127 (message
6128 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
6129 REx-subgr-start))))
7bcea553
IZ
6130 (if (>= (point) e)
6131 (goto-char (1- e)))
8f95267c
RGS
6132 (cond
6133 (was-subgr
6134 (setq REx-subgr-end (point))
6135 (cperl-commentify
6136 REx-subgr-start REx-subgr-end nil)
6137 (cperl-postpone-fontification
6138 REx-subgr-start REx-subgr-end
6139 'face font-lock-comment-face))))))
7bcea553 6140 (if (and is-REx is-x-REx)
8cfd7987 6141 (put-text-property (1+ b) (1- e)
7bcea553 6142 'syntax-subtype 'x-REx)))
8f95267c
RGS
6143 (if (and i2 e1 b1 (> e1 b1))
6144 (progn ; No errors finding the second part...
8cfd7987 6145 (cperl-postpone-fontification
8f95267c 6146 (1- e1) e1 'face my-cperl-delimiters-face)
20675f5d 6147 (if (assoc (char-after b) cperl-starters)
8f95267c
RGS
6148 (progn
6149 (cperl-postpone-fontification
6150 b1 (1+ b1) 'face my-cperl-delimiters-face)
6151 (put-text-property b1 (1+ b1)
6152 'REx-part2 t)))))
6c72d195
IZ
6153 (if (> (point) max)
6154 (setq tmpend tb))))
8f95267c
RGS
6155 ((match-beginning 17) ; sub with prototype or attribute
6156 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
6157 ;;"\\<sub\\>\\(" ;12
6158 ;; cperl-white-and-comment-rex ;13
6159 ;; "\\([a-zA-Z_:'0-9]+\\)\\)?" ; name ;14
6160 ;;"\\(" cperl-maybe-white-and-comment-rex ;15,16
6161 ;; "\\(([^()]*)\\|:[^:]\\)\\)" ; 17:proto or attribute start
6162 (setq b1 (match-beginning 14) e1 (match-end 14))
ebcd4dbc
IZ
6163 (if (memq (char-after (1- b))
6164 '(?\$ ?\@ ?\% ?\& ?\*))
6165 nil
8f95267c
RGS
6166 (goto-char b)
6167 (if (eq (char-after (match-beginning 17)) ?\( )
6168 (progn
6169 (cperl-commentify ; Prototypes; mark as string
6170 (match-beginning 17) (match-end 17) t)
6171 (goto-char (match-end 0))
6172 ;; Now look for attributes after prototype:
6173 (forward-comment (buffer-size))
6174 (and (looking-at ":[^:]")
6175 (cperl-find-sub-attrs st-l b1 e1 b)))
6176 ;; treat attributes without prototype
6177 (goto-char (match-beginning 17))
6178 (cperl-find-sub-attrs st-l b1 e1 b))))
6179 ;; 1+6+2+1+1+6+1=18 extra () before this:
05bbd9c3 6180 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
8f95267c
RGS
6181 ((match-beginning 19) ; old $abc'efg syntax
6182 (setq bb (match-end 0))
6183 ;;;(if (nth 3 state) nil ; in string
6184 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
05bbd9c3 6185 (goto-char bb))
8f95267c 6186 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
05bbd9c3 6187 ;; "__\\(END\\|DATA\\)__"
8f95267c
RGS
6188 ((match-beginning 20) ; __END__, __DATA__
6189 (setq bb (match-end 0))
6190 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
6191 (cperl-commentify b bb nil)
6192 (setq end t))
6193 ;; "\\\\\\(['`\"($]\\)"
6194 ((match-beginning 21)
6195 ;; Trailing backslash; make non-quoting outside string/comment
6196 (setq bb (match-end 0))
7bcea553
IZ
6197 (goto-char b)
6198 (skip-chars-backward "\\\\")
6199 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
8f95267c 6200 (cperl-modify-syntax-type b cperl-st-punct)
7bcea553
IZ
6201 (goto-char bb))
6202 (t (error "Error in regexp of the sniffer")))
6c72d195 6203 (if (> (point) stop-point)
3ee700d1 6204 (progn
8cfd7987 6205 (if end
3ee700d1
IZ
6206 (message "Garbage after __END__/__DATA__ ignored")
6207 (message "Unbalanced syntax found while scanning")
6208 (or (car err-l) (setcar err-l b)))
6c72d195
IZ
6209 (goto-char stop-point))))
6210 (setq cperl-syntax-state (cons state-point state)
8f95267c
RGS
6211 ;; Do not mark syntax as done past tmpend???
6212 cperl-syntax-done-to (or tmpend (max (point) max)))
6213 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
6214 )
05bbd9c3 6215 (if (car err-l) (goto-char (car err-l))
6c72d195
IZ
6216 (or non-inter
6217 (message "Scanning for \"hard\" Perl constructions... done"))))
c07a80fd 6218 (and (buffer-modified-p)
6219 (not modified)
ebcd4dbc 6220 (set-buffer-modified-p nil))
3ee700d1 6221 (set-syntax-table cperl-mode-syntax-table))
8f95267c
RGS
6222 (list (car err-l) overshoot)))
6223
6224(defun cperl-find-pods-heres-region (min max)
6225 (interactive "r")
6226 (cperl-find-pods-heres min max))
c07a80fd 6227
6228(defun cperl-backward-to-noncomment (lim)
6229 ;; Stops at lim or after non-whitespace that is not in comment
8f95267c 6230 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
20675f5d 6231 (let (stop p pr)
8f95267c 6232 (while (and (not stop) (> (point) (or lim (point-min))))
4633a7c4
LW
6233 (skip-chars-backward " \t\n\f" lim)
6234 (setq p (point))
6235 (beginning-of-line)
20675f5d
IZ
6236 (if (memq (setq pr (get-text-property (point) 'syntax-type))
6237 '(pod here-doc here-doc-delim))
8f95267c
RGS
6238 (progn
6239 (cperl-unwind-to-safe nil)
6240 (setq pr (get-text-property (point) 'syntax-type))))
6241 (or (and (looking-at "^[ \t]*\\(#\\|$\\)")
6242 (not (memq pr '(string prestring))))
8cfd7987
JH
6243 (progn (cperl-to-comment-or-eol) (bolp))
6244 (progn
6245 (skip-chars-backward " \t")
6246 (if (< p (point)) (goto-char p))
8f95267c 6247 (setq stop t))))))
4633a7c4 6248
8f95267c
RGS
6249;; Used only in `cperl-calculate-indent'...
6250(defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
6251 ;; Positions is before ?\{. Checks whether it starts a block.
6252 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
6253 (cperl-backward-to-noncomment (point-min))
6254 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
6255 ; Label may be mixed up with `$blah :'
6256 (save-excursion (cperl-after-label))
6257 (get-text-property (cperl-1- (point)) 'attrib-group)
6258 (and (memq (char-syntax (preceding-char)) '(?w ?_))
6259 (progn
6260 (backward-sexp)
6261 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
6262 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
6263 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
6264 ;; sub bless::foo {}
6265 (progn
6266 (cperl-backward-to-noncomment (point-min))
6267 (and (eq (preceding-char) ?b)
6268 (progn
6269 (forward-sexp -1)
6270 (looking-at "sub[ \t\n\f#]")))))))))
6271
6272;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
6273;;; No save-excursion; condition-case ... In (cperl-block-p) the block
6274;;; may be a part of an in-statement construct, such as
6275;;; ${something()}, print {FH} $data.
6276;;; Moreover, one takes positive approach (looks for else,grep etc)
6277;;; another negative (looks for bless,tr etc)
8cfd7987 6278(defun cperl-after-block-p (lim &optional pre-block)
8f95267c
RGS
6279 "Return true if the preceeding } (if PRE-BLOCK, following {) delimits a block.
6280Would not look before LIM. Assumes that LIM is a good place to begin a
6281statement. The kind of block we treat here is one after which a new
6282statement would start; thus the block in ${func()} does not count."
ebcd4dbc
IZ
6283 (save-excursion
6284 (condition-case nil
6285 (progn
8cfd7987 6286 (or pre-block (forward-sexp -1))
ebcd4dbc 6287 (cperl-backward-to-noncomment lim)
6c72d195 6288 (or (eq (point) lim)
8f95267c
RGS
6289 ;; if () {} // sub f () {} // sub f :a(') {}
6290 (eq (preceding-char) ?\) )
6291 ;; label: {}
6292 (save-excursion (cperl-after-label))
6293 ;; sub :attr {}
6294 (get-text-property (cperl-1- (point)) 'attrib-group)
6295 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
6c72d195
IZ
6296 (save-excursion
6297 (forward-sexp -1)
8f95267c
RGS
6298 ;; else {} but not else::func {}
6299 (or (and (looking-at "\\(else\\|continue\\|grep\\|map\\|BEGIN\\|END\\|CHECK\\|INIT\\)\\>")
6300 (not (looking-at "\\(\\sw\\|_\\)+::")))
6c72d195
IZ
6301 ;; sub f {}
6302 (progn
6303 (cperl-backward-to-noncomment lim)
8f95267c 6304 (and (eq (preceding-char) ?b)
6c72d195
IZ
6305 (progn
6306 (forward-sexp -1)
8f95267c
RGS
6307 (looking-at "sub[ \t\n\f#]"))))))
6308 ;; What preceeds is not word... XXXX Last statement in sub???
6c72d195 6309 (cperl-after-expr-p lim))))
ebcd4dbc
IZ
6310 (error nil))))
6311
c07a80fd 6312(defun cperl-after-expr-p (&optional lim chars test)
8cfd7987 6313 "Return true if the position is good for start of expression.
6c72d195 6314TEST is the expression to evaluate at the found position. If absent,
ebcd4dbc
IZ
6315CHARS is a string that contains good characters to have before us (however,
6316`}' is treated \"smartly\" if it is not in the list)."
8cfd7987
JH
6317 (let ((lim (or lim (point-min)))
6318 stop p pr)
6319 (cperl-update-syntaxification (point) (point))
4633a7c4 6320 (save-excursion
ebcd4dbc 6321 (while (and (not stop) (> (point) lim))
4633a7c4
LW
6322 (skip-chars-backward " \t\n\f" lim)
6323 (setq p (point))
6324 (beginning-of-line)
8cfd7987
JH
6325 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
6326 ;; '(pod here-doc here-doc-delim))
6327 (if (get-text-property (point) 'here-doc-group)
6328 (progn
6329 (goto-char
8f95267c 6330 (cperl-beginning-of-property (point) 'here-doc-group))
8cfd7987
JH
6331 (beginning-of-line 0)))
6332 (if (get-text-property (point) 'in-pod)
6333 (progn
6334 (goto-char
8f95267c 6335 (cperl-beginning-of-property (point) 'in-pod))
8cfd7987 6336 (beginning-of-line 0)))
4633a7c4 6337 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
4584684c 6338 ;; Else: last iteration, or a label
8cfd7987 6339 (cperl-to-comment-or-eol) ; Will not move past "." after a format
4633a7c4
LW
6340 (skip-chars-backward " \t")
6341 (if (< p (point)) (goto-char p))
4584684c
GS
6342 (setq p (point))
6343 (if (and (eq (preceding-char) ?:)
6344 (progn
6345 (forward-char -1)
6346 (skip-chars-backward " \t\n\f" lim)
8f95267c 6347 (memq (char-syntax (preceding-char)) '(?w ?_))))
4584684c
GS
6348 (forward-sexp -1) ; Possibly label. Skip it
6349 (goto-char p)
6350 (setq stop t))))
6c72d195
IZ
6351 (or (bobp) ; ???? Needed
6352 (eq (point) lim)
7bcea553 6353 (looking-at "[ \t]*__\\(END\\|DATA\\)__") ; After this anything goes
4633a7c4 6354 (progn
4633a7c4 6355 (if test (eval test)
ebcd4dbc
IZ
6356 (or (memq (preceding-char) (append (or chars "{;") nil))
6357 (and (eq (preceding-char) ?\})
8cfd7987
JH
6358 (cperl-after-block-p lim))
6359 (and (eq (following-char) ?.) ; in format: see comment above
6360 (eq (get-text-property (point) 'syntax-type)
6361 'format)))))))))
4633a7c4 6362
8f95267c
RGS
6363(defun cperl-backward-to-start-of-expr (&optional lim)
6364 (condition-case nil
6365 (progn
6366 (while (and (or (not lim)
6367 (> (point) lim))
6368 (not (cperl-after-expr-p lim)))
6369 (forward-sexp -1)
6370 ;; May be after $, @, $# etc of a variable
6371 (skip-chars-backward "$@%#")))
6372 (error nil)))
6373
6374(defun cperl-at-end-of-expr (&optional lim)
6375 ;; Since the SEXP approach below is very fragile, do some overengineering
6376 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
6377 (condition-case nil
6378 (save-excursion
6379 ;; If nothing interesting after, does as (forward-sexp -1);
6380 ;; otherwise fails, or ends at a start of following sexp.
6381 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
6382 ;; may be stuck after @ or $; just put some stupid workaround now:
6383 (let ((p (point)))
6384 (forward-sexp 1)
6385 (forward-sexp -1)
6386 (while (memq (preceding-char) (append "%&@$*" nil))
6387 (forward-char -1))
6388 (or (< (point) p)
6389 (cperl-after-expr-p lim))))
6390 (error t))))
6391
6392(defun cperl-forward-to-end-of-expr (&optional lim)
6393 (let ((p (point))))
6394 (condition-case nil
6395 (progn
6396 (while (and (< (point) (or lim (point-max)))
6397 (not (cperl-at-end-of-expr)))
6398 (forward-sexp 1)))
6399 (error nil)))
6400
4633a7c4 6401(defun cperl-backward-to-start-of-continued-exp (lim)
c07a80fd 6402 (if (memq (preceding-char) (append ")]}\"'`" nil))
4633a7c4
LW
6403 (forward-sexp -1))
6404 (beginning-of-line)
6405 (if (<= (point) lim)
6406 (goto-char (1+ lim)))
6407 (skip-chars-forward " \t"))
6408
6c72d195
IZ
6409(defun cperl-after-block-and-statement-beg (lim)
6410 ;; We assume that we are after ?\}
8cfd7987 6411 (and
6c72d195
IZ
6412 (cperl-after-block-p lim)
6413 (save-excursion
6414 (forward-sexp -1)
6415 (cperl-backward-to-noncomment (point-min))
6416 (or (bobp)
6417 (eq (point) lim)
6418 (not (= (char-syntax (preceding-char)) ?w))
6419 (progn
6420 (forward-sexp -1)
8cfd7987 6421 (not
6c72d195
IZ
6422 (looking-at
6423 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
6424
4633a7c4
LW
6425\f
6426(defvar innerloop-done nil)
6427(defvar last-depth nil)
6428
6429(defun cperl-indent-exp ()
6430 "Simple variant of indentation of continued-sexp.
4584684c
GS
6431
6432Will not indent comment if it starts at `comment-indent' or looks like
6433continuation of the comment on the previous line.
6c72d195 6434
8cfd7987 6435If `cperl-indent-region-fix-constructs', will improve spacing on
6c72d195 6436conditional/loop constructs."
4633a7c4
LW
6437 (interactive)
6438 (save-excursion
6439 (let ((tmp-end (progn (end-of-line) (point))) top done)
6440 (save-excursion
05bbd9c3 6441 (beginning-of-line)
4633a7c4 6442 (while (null done)
4633a7c4 6443 (setq top (point))
8f95267c
RGS
6444 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
6445 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
4633a7c4
LW
6446 (setq top (point))) ; Get the outermost parenths in line
6447 (goto-char top)
6448 (while (< (point) tmp-end)
6449 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
6450 (or (eolp) (forward-sexp 1)))
8f95267c
RGS
6451 (if (> (point) tmp-end) ; Yes, there an unfinished block
6452 nil
6453 (if (eq ?\) (preceding-char))
6454 (progn ;; Plan B: find by REGEXP block followup this line
6455 (setq top (point))
6456 (condition-case nil
6457 (progn
6458 (forward-sexp -2)
6459 (if (eq (following-char) ?$ ) ; for my $var (list)
6460 (progn
6461 (forward-sexp -1)
6462 (if (looking-at "\\(my\\|local\\|our\\)\\>")
6463 (forward-sexp -1))))
6464 (if (looking-at
6465 (concat "\\(\\elsif\\|if\\|unless\\|while\\|until"
6466 "\\|for\\(each\\)?\\>\\(\\("
6467 cperl-maybe-white-and-comment-rex
6468 "\\(my\\|local\\|our\\)\\)?"
6469 cperl-maybe-white-and-comment-rex
6470 "\\$[_a-zA-Z0-9]+\\)?\\)\\>"))
6471 (progn
6472 (goto-char top)
6473 (forward-sexp 1)
6474 (setq top (point)))))
6475 (error (setq done t)))
6476 (goto-char top))
6477 (if (looking-at ; Try Plan C: continuation block
6478 (concat cperl-maybe-white-and-comment-rex
6479 "\\<\\(else\\|elsif\|continue\\)\\>"))
6480 (progn
6481 (goto-char (match-end 0))
6482 (save-excursion
6483 (end-of-line)
6484 (setq tmp-end (point))))
6485 (setq done t))))
6486 (save-excursion
6487 (end-of-line)
6488 (setq tmp-end (point))))
4633a7c4
LW
6489 (goto-char tmp-end)
6490 (setq tmp-end (point-marker)))
6c72d195
IZ
6491 (if cperl-indent-region-fix-constructs
6492 (cperl-fix-line-spacing tmp-end))
4633a7c4
LW
6493 (cperl-indent-region (point) tmp-end))))
6494
6c72d195 6495(defun cperl-fix-line-spacing (&optional end parse-data)
4584684c
GS
6496 "Improve whitespace in a conditional/loop construct.
6497Returns some position at the last line."
6c72d195
IZ
6498 (interactive)
6499 (or end
6500 (setq end (point-max)))
8cfd7987
JH
6501 (let ((ee (save-excursion (end-of-line) (point)))
6502 (cperl-indent-region-fix-constructs
6503 (or cperl-indent-region-fix-constructs 1))
6504 p pp ml have-brace ret)
6c72d195
IZ
6505 (save-excursion
6506 (beginning-of-line)
4584684c 6507 (setq ret (point))
8cfd7987 6508 ;; }? continue
6c72d195 6509 ;; blah; }
8cfd7987 6510 (if (not
6c72d195
IZ
6511 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
6512 (setq have-brace (save-excursion (search-forward "}" ee t)))))
6513 nil ; Do not need to do anything
8cfd7987
JH
6514 ;; Looking at:
6515 ;; }
6516 ;; else
8f95267c
RGS
6517 (if cperl-merge-trailing-else
6518 (if (looking-at
6519 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
6520 (progn
6521 (search-forward "}")
6522 (setq p (point))
6523 (skip-chars-forward " \t\n")
6524 (delete-region p (point))
6525 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6526 (beginning-of-line)))
6527 (if (looking-at "[ \t]*}[ \t]*\\(els\\(e\\|if\\)\\|continue\\)\\>")
6528 (save-excursion
6529 (search-forward "}")
6530 (delete-horizontal-space)
6531 (insert "\n")
6532 (setq ret (point))
6533 (if (cperl-indent-line parse-data)
6534 (progn
6535 (cperl-fix-line-spacing end parse-data)
6536 (setq ret (point)))))))
8cfd7987
JH
6537 ;; Looking at:
6538 ;; } else
6539 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
6540 (progn
6541 (search-forward "}")
6542 (delete-horizontal-space)
6543 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6544 (beginning-of-line)))
6545 ;; Looking at:
6546 ;; else {
6547 (if (looking-at
6548 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
6549 (progn
6550 (forward-word 1)
6551 (delete-horizontal-space)
6552 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6553 (beginning-of-line)))
6554 ;; Looking at:
6555 ;; foreach my $var
6556 (if (looking-at
6557 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
6558 (progn
6559 (forward-word 2)
6560 (delete-horizontal-space)
6561 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
6562 (beginning-of-line)))
6563 ;; Looking at:
6564 ;; foreach my $var (
6565 (if (looking-at
7bcea553 6566 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
8cfd7987
JH
6567 (progn
6568 (forward-sexp 3)
6569 (delete-horizontal-space)
6570 (insert
6571 (make-string cperl-indent-region-fix-constructs ?\ ))
6572 (beginning-of-line)))
8f95267c
RGS
6573 ;; Looking at (with or without "}" at start, ending after "({"):
6574 ;; } foreach my $var () OR {
8cfd7987
JH
6575 (if (looking-at
6576 "[ \t]*\\(}[ \t]*\\)?\\<\\(\\els\\(e\\|if\\)\\|continue\\|if\\|unless\\|while\\|for\\(each\\)?\\(\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\$[_a-zA-Z0-9]+\\)?\\|until\\)\\>\\([ \t]*(\\|[ \t\n]*{\\)\\|[ \t]*{")
6577 (progn
8f95267c 6578 (setq ml (match-beginning 8)) ; "(" or "{" after control word
8cfd7987
JH
6579 (re-search-forward "[({]")
6580 (forward-char -1)
6581 (setq p (point))
6582 (if (eq (following-char) ?\( )
6583 (progn
6584 (forward-sexp 1)
8f95267c 6585 (setq pp (point))) ; past parenth-group
8cfd7987
JH
6586 ;; after `else' or nothing
6587 (if ml ; after `else'
6588 (skip-chars-backward " \t\n")
6589 (beginning-of-line))
6590 (setq pp nil))
6591 ;; Now after the sexp before the brace
6592 ;; Multiline expr should be special
6593 (setq ml (and pp (save-excursion (goto-char p)
6594 (search-forward "\n" pp t))))
8f95267c 6595 (if (and (or (not pp) (< pp end)) ; Do not go too far...
8cfd7987
JH
6596 (looking-at "[ \t\n]*{"))
6597 (progn
6598 (cond
6599 ((bolp) ; Were before `{', no if/else/etc
6600 nil)
8f95267c 6601 ((looking-at "\\(\t*\\| [ \t]+\\){") ; Not exactly 1 SPACE
8cfd7987
JH
6602 (delete-horizontal-space)
6603 (if (if ml
6604 cperl-extra-newline-before-brace-multiline
6605 cperl-extra-newline-before-brace)
6606 (progn
6607 (delete-horizontal-space)
6608 (insert "\n")
6609 (setq ret (point))
6610 (if (cperl-indent-line parse-data)
6611 (progn
6612 (cperl-fix-line-spacing end parse-data)
6613 (setq ret (point)))))
6614 (insert
6615 (make-string cperl-indent-region-fix-constructs ?\ ))))
6616 ((and (looking-at "[ \t]*\n")
6617 (not (if ml
6618 cperl-extra-newline-before-brace-multiline
6619 cperl-extra-newline-before-brace)))
6620 (setq pp (point))
6621 (skip-chars-forward " \t\n")
6622 (delete-region pp (point))
6c72d195 6623 (insert
8f95267c
RGS
6624 (make-string cperl-indent-region-fix-constructs ?\ )))
6625 ((and (looking-at "[\t ]*{")
6626 (if ml cperl-extra-newline-before-brace-multiline
6627 cperl-extra-newline-before-brace))
6628 (delete-horizontal-space)
6629 (insert "\n")
6630 (setq ret (point))
6631 (if (cperl-indent-line parse-data)
6632 (progn
6633 (cperl-fix-line-spacing end parse-data)
6634 (setq ret (point))))))
8cfd7987
JH
6635 ;; Now we are before `{'
6636 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
6637 (progn
6638 (skip-chars-forward " \t\n")
6639 (setq pp (point))
6640 (forward-sexp 1)
6641 (setq p (point))
6642 (goto-char pp)
6643 (setq ml (search-forward "\n" p t))
6644 (if (or cperl-break-one-line-blocks-when-indent ml)
6645 ;; not good: multi-line BLOCK
6646 (progn
6647 (goto-char (1+ pp))
6648 (delete-horizontal-space)
6649 (insert "\n")
6650 (setq ret (point))
6651 (if (cperl-indent-line parse-data)
6652 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
6653 (beginning-of-line)
6654 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
6655 ;; Now check whether there is a hanging `}'
6656 ;; Looking at:
6657 ;; } blah
6658 (if (and
6659 cperl-fix-hanging-brace-when-indent
6660 have-brace
6661 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
6662 (condition-case nil
6663 (progn
6664 (up-list 1)
6665 (if (and (<= (point) pp)
6666 (eq (preceding-char) ?\} )
6667 (cperl-after-block-and-statement-beg (point-min)))
6668 t
6669 (goto-char p)
6670 nil))
6671 (error nil)))
6672 (progn
6673 (forward-char -1)
6674 (skip-chars-backward " \t")
6675 (if (bolp)
6676 ;; `}' was the first thing on the line, insert NL *after* it.
6677 (progn
6678 (cperl-indent-line parse-data)
6679 (search-forward "}")
6680 (delete-horizontal-space)
6681 (insert "\n"))
6682 (delete-horizontal-space)
6683 (or (eq (preceding-char) ?\;)
6684 (bolp)
6685 (and (eq (preceding-char) ?\} )
6686 (cperl-after-block-p (point-min)))
6687 (insert ";"))
6688 (insert "\n")
6689 (setq ret (point)))
6690 (if (cperl-indent-line parse-data)
6691 (setq ret (cperl-fix-line-spacing end parse-data)))
6692 (beginning-of-line)))))
4584684c 6693 ret))
6c72d195
IZ
6694
6695(defvar cperl-update-start) ; Do not need to make them local
6696(defvar cperl-update-end)
6697(defun cperl-delay-update-hook (beg end old-len)
6698 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
6699 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
6700
4633a7c4
LW
6701(defun cperl-indent-region (start end)
6702 "Simple variant of indentation of region in CPerl mode.
8cfd7987 6703Should be slow. Will not indent comment if it starts at `comment-indent'
4633a7c4 6704or looks like continuation of the comment on the previous line.
8cfd7987
JH
6705Indents all the lines whose first character is between START and END
6706inclusive.
6c72d195 6707
8cfd7987 6708If `cperl-indent-region-fix-constructs', will improve spacing on
6c72d195 6709conditional/loop constructs."
4633a7c4 6710 (interactive "r")
6c72d195 6711 (cperl-update-syntaxification end end)
4633a7c4 6712 (save-excursion
6c72d195 6713 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
8cfd7987
JH
6714 (let ((indent-info (if cperl-emacs-can-parse
6715 (list nil nil nil) ; Cannot use '(), since will modify
6716 nil))
6717 (pm 0) (imenu-scanning-message "Indenting... (%3d%%)")
6718 after-change-functions ; Speed it up!
6719 st comm old-comm-indent new-comm-indent p pp i empty)
6c72d195
IZ
6720 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
6721 (goto-char start)
6722 (setq old-comm-indent (and (cperl-to-comment-or-eol)
6723 (current-column))
6724 new-comm-indent old-comm-indent)
6725 (goto-char start)
6726 (setq end (set-marker (make-marker) end)) ; indentation changes pos
6727 (or (bolp) (beginning-of-line 2))
6728 (or (fboundp 'imenu-progress-message)
6729 (message "Indenting... For feedback load `imenu'..."))
6730 (while (and (<= (point) end) (not (eobp))) ; bol to check start
6731 (and (fboundp 'imenu-progress-message)
8cfd7987 6732 (imenu-progress-message
6c72d195
IZ
6733 pm (/ (* 100 (- (point) start)) (- end start -1))))
6734 (setq st (point))
4584684c
GS
6735 (if (or
6736 (setq empty (looking-at "[ \t]*\n"))
6737 (and (setq comm (looking-at "[ \t]*#"))
8cfd7987 6738 (or (eq (current-indentation) (or old-comm-indent
4584684c
GS
6739 comment-column))
6740 (setq old-comm-indent nil))))
6c72d195 6741 (if (and old-comm-indent
4584684c 6742 (not empty)
6c72d195 6743 (= (current-indentation) old-comm-indent)
4584684c
GS
6744 (not (eq (get-text-property (point) 'syntax-type) 'pod))
6745 (not (eq (get-text-property (point) 'syntax-table)
6746 cperl-st-cfence)))
6c72d195
IZ
6747 (let ((comment-column new-comm-indent))
6748 (indent-for-comment)))
8cfd7987 6749 (progn
6c72d195
IZ
6750 (setq i (cperl-indent-line indent-info))
6751 (or comm
6752 (not i)
6753 (progn
6754 (if cperl-indent-region-fix-constructs
4584684c 6755 (goto-char (cperl-fix-line-spacing end indent-info)))
8cfd7987 6756 (if (setq old-comm-indent
6c72d195 6757 (and (cperl-to-comment-or-eol)
8cfd7987 6758 (not (memq (get-text-property (point)
6c72d195
IZ
6759 'syntax-type)
6760 '(pod here-doc)))
8cfd7987 6761 (not (eq (get-text-property (point)
4584684c
GS
6762 'syntax-table)
6763 cperl-st-cfence))
6c72d195
IZ
6764 (current-column)))
6765 (progn (indent-for-comment)
6766 (skip-chars-backward " \t")
6767 (skip-chars-backward "#")
6768 (setq new-comm-indent (current-column))))))))
6769 (beginning-of-line 2))
4633a7c4 6770 (if (fboundp 'imenu-progress-message)
6c72d195
IZ
6771 (imenu-progress-message pm 100)
6772 (message nil)))
6773 ;; Now run the update hooks
8cfd7987
JH
6774 (and after-change-functions
6775 cperl-update-end
6776 (save-excursion
6777 (goto-char cperl-update-end)
6778 (insert " ")
6779 (delete-char -1)
6780 (goto-char cperl-update-start)
6781 (insert " ")
6782 (delete-char -1))))))
4633a7c4
LW
6783
6784;; Stolen from lisp-mode with a lot of improvements
6785
6786(defun cperl-fill-paragraph (&optional justify iteration)
6787 "Like \\[fill-paragraph], but handle CPerl comments.
6788If any of the current line is a comment, fill the comment or the
6789block of it that point is in, preserving the comment's initial
6c72d195 6790indentation and initial hashes. Behaves usually outside of comment."
4633a7c4 6791 (interactive "P")
8cfd7987 6792 (let (;; Non-nil if the current line contains a comment.
4633a7c4 6793 has-comment
8f95267c 6794 fill-paragraph-function ; do not recurse
4633a7c4
LW
6795 ;; If has-comment, the appropriate fill-prefix for the comment.
6796 comment-fill-prefix
6797 ;; Line that contains code and comment (or nil)
6798 start
6799 c spaces len dc (comment-column comment-column))
6800 ;; Figure out what kind of comment we are looking at.
6801 (save-excursion
6802 (beginning-of-line)
6803 (cond
6804
6805 ;; A line with nothing but a comment on it?
6806 ((looking-at "[ \t]*#[# \t]*")
6807 (setq has-comment t
6808 comment-fill-prefix (buffer-substring (match-beginning 0)
6809 (match-end 0))))
6810
6811 ;; A line with some code, followed by a comment? Remember that the
6812 ;; semi which starts the comment shouldn't be part of a string or
6813 ;; character.
6814 ((cperl-to-comment-or-eol)
6815 (setq has-comment t)
6816 (looking-at "#+[ \t]*")
8cfd7987 6817 (setq start (point) c (current-column)
4633a7c4
LW
6818 comment-fill-prefix
6819 (concat (make-string (current-column) ?\ )
6820 (buffer-substring (match-beginning 0) (match-end 0)))
8cfd7987 6821 spaces (progn (skip-chars-backward " \t")
4633a7c4 6822 (buffer-substring (point) start))
8cfd7987 6823 dc (- c (current-column)) len (- start (point))
4633a7c4
LW
6824 start (point-marker))
6825 (delete-char len)
8f95267c 6826 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
4633a7c4 6827 (if (not has-comment)
8cfd7987 6828 (fill-paragraph justify) ; Do the usual thing outside of comment
4633a7c4
LW
6829 ;; Narrow to include only the comment, and then fill the region.
6830 (save-restriction
6831 (narrow-to-region
6832 ;; Find the first line we should include in the region to fill.
6833 (if start (progn (beginning-of-line) (point))
6834 (save-excursion
6835 (while (and (zerop (forward-line -1))
c07a80fd 6836 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4633a7c4 6837 ;; We may have gone to far. Go forward again.
c07a80fd 6838 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
4633a7c4
LW
6839 (forward-line 1))
6840 (point)))
6841 ;; Find the beginning of the first line past the region to fill.
6842 (save-excursion
6843 (while (progn (forward-line 1)
c07a80fd 6844 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4633a7c4
LW
6845 (point)))
6846 ;; Remove existing hashes
6847 (goto-char (point-min))
6848 (while (progn (forward-line 1) (< (point) (point-max)))
6849 (skip-chars-forward " \t")
8f95267c
RGS
6850 (if (looking-at "#+")
6851 (progn
6852 (if (and (eq (point) (match-beginning 0))
6853 (not (eq (point) (match-end 0)))) nil
6854 (error
6855 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
6856 (delete-char (- (match-end 0) (match-beginning 0))))))
4633a7c4
LW
6857
6858 ;; Lines with only hashes on them can be paragraph boundaries.
6859 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
6860 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
6861 (fill-prefix comment-fill-prefix))
6862 (fill-paragraph justify)))
6863 (if (and start)
8cfd7987 6864 (progn
4633a7c4
LW
6865 (goto-char start)
6866 (if (> dc 0)
8cfd7987 6867 (progn (delete-char dc) (insert spaces)))
4633a7c4
LW
6868 (if (or (= (current-column) c) iteration) nil
6869 (setq comment-column c)
6870 (indent-for-comment)
6871 ;; Repeat once more, flagging as iteration
8f95267c
RGS
6872 (cperl-fill-paragraph justify t))))))
6873 t)
4633a7c4
LW
6874
6875(defun cperl-do-auto-fill ()
6876 ;; Break out if the line is short enough
6877 (if (> (save-excursion
6878 (end-of-line)
6879 (current-column))
6880 fill-column)
8cfd7987
JH
6881 (let ((c (save-excursion (beginning-of-line)
6882 (cperl-to-comment-or-eol) (point)))
6883 (s (memq (following-char) '(?\ ?\t))) marker)
6884 (if (>= c (point)) nil
6885 (setq marker (point-marker))
6886 (cperl-fill-paragraph)
6887 (goto-char marker)
6888 ;; Is not enough, sometimes marker is a start of line
6889 (if (bolp) (progn (re-search-forward "#+[ \t]*")
6890 (goto-char (match-end 0))))
6891 ;; Following space could have gone:
6892 (if (or (not s) (memq (following-char) '(?\ ?\t))) nil
6893 (insert " ")
6894 (backward-char 1))
6895 ;; Previous space could have gone:
6896 (or (memq (preceding-char) '(?\ ?\t)) (insert " "))))))
4633a7c4 6897
9ea28adb 6898(defun cperl-imenu-addback (lst &optional isback name)
6899 ;; We suppose that the lst is a DAG, unless the first element only
6c72d195 6900 ;; loops back, and ISBACK is set. Thus this function cannot be
9ea28adb 6901 ;; applied twice without ISBACK set.
6902 (cond ((not cperl-imenu-addback) lst)
6903 (t
8cfd7987 6904 (or name
9ea28adb 6905 (setq name "+++BACK+++"))
8cfd7987
JH
6906 (mapcar (lambda (elt)
6907 (if (and (listp elt) (listp (cdr elt)))
6908 (progn
6909 ;; In the other order it goes up
6910 ;; one level only ;-(
6911 (setcdr elt (cons (cons name lst)
6912 (cdr elt)))
6913 (cperl-imenu-addback (cdr elt) t name))))
9ea28adb 6914 (if isback (cdr lst) lst))
6915 lst)))
6916
8cfd7987 6917(defun cperl-imenu--create-perl-index (&optional regexp)
4633a7c4 6918 (require 'cl)
05bbd9c3 6919 (require 'imenu) ; May be called from TAGS creator
8cfd7987 6920 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
c07a80fd 6921 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
9ea28adb 6922 (index-meth-alist '()) meth
8f95267c
RGS
6923 packages ends-ranges p marker is-proto
6924 (prev-pos 0) is-pack index index1 name (end-range 0) package)
4633a7c4 6925 (goto-char (point-min))
3ee700d1
IZ
6926 (if noninteractive
6927 (message "Scanning Perl for index")
6928 (imenu-progress-message prev-pos 0))
7bcea553 6929 (cperl-update-syntaxification (point-max) (point-max))
4633a7c4 6930 ;; Search for the function
9ea28adb 6931 (progn ;;save-match-data
4633a7c4 6932 (while (re-search-forward
8cfd7987 6933 (or regexp cperl-imenu--function-name-regexp-perl)
4633a7c4 6934 nil t)
3ee700d1
IZ
6935 (or noninteractive
6936 (imenu-progress-message prev-pos))
8f95267c 6937 ;; 2=package-group, 5=package-name 8=sub-name
c07a80fd 6938 (cond
05bbd9c3 6939 ((and ; Skip some noise if building tags
8f95267c
RGS
6940 (match-beginning 5) ; package name
6941 ;;(eq (char-after (match-beginning 2)) ?p) ; package
05bbd9c3 6942 (not (save-match-data
8cfd7987 6943 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
05bbd9c3 6944 nil)
ebcd4dbc 6945 ((and
8f95267c
RGS
6946 (or (match-beginning 2)
6947 (match-beginning 8)) ; package or sub
7bcea553 6948 ;; Skip if quoted (will not skip multi-line ''-strings :-():
ebcd4dbc
IZ
6949 (null (get-text-property (match-beginning 1) 'syntax-table))
6950 (null (get-text-property (match-beginning 1) 'syntax-type))
6951 (null (get-text-property (match-beginning 1) 'in-pod)))
8f95267c 6952 (setq is-pack (match-beginning 2))
ebcd4dbc
IZ
6953 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
6954 ;; (goto-char (match-end 0))) ; Messes what follows
8f95267c 6955 (setq meth nil
ebcd4dbc 6956 p (point))
c07a80fd 6957 (while (and ends-ranges (>= p (car ends-ranges)))
6958 ;; delete obsolete entries
6959 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
6960 (setq package (or (car packages) "")
6961 end-range (or (car ends-ranges) 0))
8f95267c
RGS
6962 (if is-pack ; doing "package"
6963 (progn
6964 (if (match-beginning 5) ; named package
6965 (setq name (buffer-substring (match-beginning 5)
6966 (match-end 5))
6967 name (progn
6968 (set-text-properties 0 (length name) nil name)
6969 name)
6970 package (concat name "::")
6971 name (concat "package " name))
6972 ;; Support nameless packages
6973 (setq name "package;" package ""))
6974 (setq end-range
6975 (save-excursion
6976 (parse-partial-sexp (point) (point-max) -1) (point))
6977 ends-ranges (cons end-range ends-ranges)
6978 packages (cons package packages)))
6979 (setq is-proto
6980 (or (eq (following-char) ?\;)
6981 (eq 0 (get-text-property (point) 'attrib-group)))))
c07a80fd 6982 ;; Skip this function name if it is a prototype declaration.
8f95267c
RGS
6983 (if (and is-proto (not is-pack)) nil
6984 (or is-pack
6985 (setq name
6986 (buffer-substring (match-beginning 8) (match-end 8)))
6987 (set-text-properties 0 (length name) nil name))
6988 (setq marker (make-marker))
6989 (set-marker marker (match-end (if is-pack 2 8)))
6990 (cond (is-pack nil)
6991 ((string-match "[:']" name)
6992 (setq meth t))
6993 ((> p end-range) nil)
6994 (t
6995 (setq name (concat package name) meth t)))
7bcea553 6996 (setq index (cons name marker))
8f95267c 6997 (if is-pack
c07a80fd 6998 (push index index-pack-alist)
6999 (push index index-alist))
9ea28adb 7000 (if meth (push index index-meth-alist))
c07a80fd 7001 (push index index-unsorted-alist)))
8f95267c
RGS
7002 ((match-beginning 16) ; POD section
7003 (setq name (buffer-substring (match-beginning 17) (match-end 17))
7004 marker (make-marker))
7005 (set-marker marker (match-beginning 17))
499d5216 7006 (set-text-properties 0 (length name) nil name)
8f95267c
RGS
7007 (setq name (concat (make-string
7008 (* 3 (- (char-after (match-beginning 16)) ?1))
7009 ?\ )
7010 name)
7011 index (cons name marker))
c07a80fd 7012 (setq index1 (cons (concat "=" name) (cdr index)))
7013 (push index index-pod-alist)
7014 (push index1 index-unsorted-alist)))))
3ee700d1
IZ
7015 (or noninteractive
7016 (imenu-progress-message prev-pos 100))
8cfd7987 7017 (setq index-alist
c07a80fd 7018 (if (default-value 'imenu-sort-function)
7019 (sort index-alist (default-value 'imenu-sort-function))
8cfd7987 7020 (nreverse index-alist)))
c07a80fd 7021 (and index-pod-alist
9ea28adb 7022 (push (cons "+POD headers+..."
c07a80fd 7023 (nreverse index-pod-alist))
7024 index-alist))
9ea28adb 7025 (and (or index-pack-alist index-meth-alist)
7026 (let ((lst index-pack-alist) hier-list pack elt group name)
7027 ;; Remove "package ", reverse and uniquify.
7028 (while lst
7029 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
7030 (if (assoc name hier-list) nil
7031 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
7032 (setq lst index-meth-alist)
7033 (while lst
7034 (setq elt (car lst) lst (cdr lst))
499d5216
IZ
7035 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
7036 (setq pack (substring (car elt) 0 (match-beginning 0)))
8cfd7987 7037 (if (setq group (assoc pack hier-list))
499d5216
IZ
7038 (if (listp (cdr group))
7039 ;; Have some functions already
8cfd7987
JH
7040 (setcdr group
7041 (cons (cons (substring
499d5216
IZ
7042 (car elt)
7043 (+ 2 (match-beginning 0)))
7044 (cdr elt))
7045 (cdr group)))
8cfd7987 7046 (setcdr group (list (cons (substring
499d5216
IZ
7047 (car elt)
7048 (+ 2 (match-beginning 0)))
7049 (cdr elt)))))
8cfd7987
JH
7050 (setq hier-list
7051 (cons (cons pack
7052 (list (cons (substring
499d5216
IZ
7053 (car elt)
7054 (+ 2 (match-beginning 0)))
7055 (cdr elt))))
7056 hier-list))))))
9ea28adb 7057 (push (cons "+Hierarchy+..."
7058 hier-list)
7059 index-alist)))
4633a7c4 7060 (and index-pack-alist
9ea28adb 7061 (push (cons "+Packages+..."
c07a80fd 7062 (nreverse index-pack-alist))
7063 index-alist))
8cfd7987 7064 (and (or index-pack-alist index-pod-alist
c07a80fd 7065 (default-value 'imenu-sort-function))
7066 index-unsorted-alist
9ea28adb 7067 (push (cons "+Unsorted List+..."
c07a80fd 7068 (nreverse index-unsorted-alist))
4633a7c4 7069 index-alist))
9ea28adb 7070 (cperl-imenu-addback index-alist)))
4633a7c4 7071
7bcea553 7072\f
7bcea553
IZ
7073;; Suggested by Mark A. Hershberger
7074(defun cperl-outline-level ()
7075 (looking-at outline-regexp)
7076 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
8f95267c
RGS
7077;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
7078 ((match-beginning 2) 0) ; package
7079 ((match-beginning 8) 1) ; sub
7080 ((match-beginning 16)
7081 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
7082 (t 5))) ; should not happen
7bcea553
IZ
7083
7084\f
8cfd7987 7085(defvar cperl-compilation-error-regexp-alist
8f95267c 7086 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
4633a7c4
LW
7087 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
7088 2 3))
7089 "Alist that specifies how to match errors in perl output.")
7090
7091(if (fboundp 'eval-after-load)
7092 (eval-after-load
8cfd7987
JH
7093 "mode-compile"
7094 '(setq perl-compilation-error-regexp-alist
7095 cperl-compilation-error-regexp-alist)))
4633a7c4
LW
7096
7097
4633a7c4
LW
7098(defun cperl-windowed-init ()
7099 "Initialization under windowed version."
8f95267c
RGS
7100 (cond ((featurep 'ps-print)
7101 (or cperl-faces-init
7102 (progn
7103 (and (boundp 'font-lock-multiline)
7104 (setq cperl-font-lock-multiline t))
7105 (cperl-init-faces))))
7106 ((not cperl-faces-init)
7107 (add-hook 'font-lock-mode-hook
7108 (function
7109 (lambda ()
7110 (if (memq major-mode '(perl-mode cperl-mode))
7111 (progn
7112 (or cperl-faces-init (cperl-init-faces)))))))
7113 (if (fboundp 'eval-after-load)
7114 (eval-after-load
7115 "ps-print"
7116 '(or cperl-faces-init (cperl-init-faces)))))))
6c72d195
IZ
7117
7118(defun cperl-load-font-lock-keywords ()
7119 (or cperl-faces-init (cperl-init-faces))
7120 perl-font-lock-keywords)
7121
7122(defun cperl-load-font-lock-keywords-1 ()
7123 (or cperl-faces-init (cperl-init-faces))
7124 perl-font-lock-keywords-1)
7125
7126(defun cperl-load-font-lock-keywords-2 ()
7127 (or cperl-faces-init (cperl-init-faces))
7128 perl-font-lock-keywords-2)
c07a80fd 7129
7130(defvar perl-font-lock-keywords-1 nil
6c72d195 7131 "Additional expressions to highlight in Perl mode. Minimal set.")
c07a80fd 7132(defvar perl-font-lock-keywords nil
6c72d195 7133 "Additional expressions to highlight in Perl mode. Default set.")
c07a80fd 7134(defvar perl-font-lock-keywords-2 nil
8f95267c 7135 "Additional expressions to highlight in Perl mode. Maximal set.")
6c72d195
IZ
7136
7137(defvar font-lock-background-mode)
7138(defvar font-lock-display-type)
7139(defun cperl-init-faces-weak ()
7140 ;; Allow `cperl-find-pods-heres' to run.
7141 (or (boundp 'font-lock-constant-face)
4584684c 7142 (cperl-force-face font-lock-constant-face
8f95267c
RGS
7143 "Face for constant and label names"))
7144 (or (boundp 'font-lock-warning-face)
7145 (cperl-force-face font-lock-warning-face
7146 "Face for things which should stand out"))
7147 ;;(setq font-lock-constant-face 'font-lock-constant-face)
7148 )
4633a7c4
LW
7149
7150(defun cperl-init-faces ()
20675f5d 7151 (condition-case errs
4633a7c4
LW
7152 (progn
7153 (require 'font-lock)
c07a80fd 7154 (and (fboundp 'font-lock-fontify-anchored-keywords)
7155 (featurep 'font-lock-extra)
6c72d195 7156 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
c07a80fd 7157 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
c07a80fd 7158 (if (fboundp 'font-lock-fontify-anchored-keywords)
7159 (setq font-lock-anchored t))
8cfd7987 7160 (setq
4633a7c4
LW
7161 t-font-lock-keywords
7162 (list
4584684c 7163 (list "[ \t]+$" 0 cperl-invalid-face t)
4633a7c4
LW
7164 (cons
7165 (concat
7166 "\\(^\\|[^$@%&\\]\\)\\<\\("
7167 (mapconcat
7168 'identity
7169 '("if" "until" "while" "elsif" "else" "unless" "for"
7170 "foreach" "continue" "exit" "die" "last" "goto" "next"
8f95267c 7171 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
7bcea553 7172 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
4633a7c4
LW
7173 "\\|") ; Flow control
7174 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
7175 ; In what follows we use `type' style
55497cff 7176 ; for overwritable builtins
4633a7c4
LW
7177 (list
7178 (concat
7179 "\\(^\\|[^$@%&\\]\\)\\<\\("
55497cff 7180 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
7181 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
7182 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
7183 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
7184 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
7185 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
7186 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
7187 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
7188 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
7189 ;; "gethostbyname" "gethostent" "getlogin"
7190 ;; "getnetbyaddr" "getnetbyname" "getnetent"
7191 ;; "getpeername" "getpgrp" "getppid" "getpriority"
7192 ;; "getprotobyname" "getprotobynumber" "getprotoent"
7193 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
7194 ;; "getservbyport" "getservent" "getsockname"
7195 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
7196 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
20675f5d 7197 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
55497cff 7198 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
7199 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
7200 ;; "quotemeta" "rand" "read" "readdir" "readline"
7201 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
7202 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
7203 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
7204 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
7205 ;; "setpriority" "setprotoent" "setpwent" "setservent"
7206 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
7207 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
7208 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
7bcea553 7209 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
55497cff 7210 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
7211 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
7212 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
8cfd7987 7213 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
4633a7c4
LW
7214 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
7215 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
7216 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
7217 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
7218 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
7219 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
7220 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
7221 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
7222 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
7223 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
7224 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
7225 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
7226 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
7227 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
7228 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
20675f5d 7229 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
4633a7c4
LW
7230 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
7231 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
7232 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
7233 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
7234 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
7235 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
7236 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
7237 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
7bcea553 7238 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|open\\|tem\\|write\\)\\|"
4633a7c4
LW
7239 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
7240 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
7241 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
7242 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
ebcd4dbc 7243 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
4633a7c4
LW
7244 "\\)\\>") 2 'font-lock-type-face)
7245 ;; In what follows we use `other' style
55497cff 7246 ;; for nonoverwritable builtins
7247 ;; Somehow 's', 'm' are not auto-generated???
4633a7c4
LW
7248 (list
7249 (concat
7250 "\\(^\\|[^$@%&\\]\\)\\<\\("
7bcea553 7251 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
55497cff 7252 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
7253 ;; "eval" "exists" "for" "foreach" "format" "goto"
7254 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
8f95267c 7255 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
55497cff 7256 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
7257 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
7258 ;; "undef" "unless" "unshift" "untie" "until" "use"
7259 ;; "while" "y"
296d8a58 7260 "AUTOLOAD\\|BEGIN\\|CHECK\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
4633a7c4 7261 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
7bcea553
IZ
7262 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|INIT\\|if\\|keys\\|"
7263 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|our\\|"
4633a7c4 7264 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
20675f5d 7265 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
4633a7c4
LW
7266 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
7267 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
7268 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
7269 "\\|[sm]" ; Added manually
4584684c 7270 "\\)\\>") 2 'cperl-nonoverridable-face)
4633a7c4
LW
7271 ;; (mapconcat 'identity
7272 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
7273 ;; "#include" "#define" "#undef")
7274 ;; "\\|")
7275 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
55497cff 7276 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
8f95267c
RGS
7277 ;; This highlights declarations and definitions differenty.
7278 ;; We do not try to highlight in the case of attributes:
7279 ;; it is already done by `cperl-find-pods-heres'
7280 (list (concat "\\<sub"
7281 cperl-white-and-comment-rex ; whitespace/comments
7282 "\\([^ \n\t{;()]+\\)" ; 2=name (assume non-anonymous)
7283 "\\("
7284 cperl-maybe-white-and-comment-rex ;whitespace/comments?
7285 "([^()]*)\\)?" ; prototype
7286 cperl-maybe-white-and-comment-rex ; whitespace/comments?
7287 "[{;]")
7288 2 (if cperl-font-lock-multiline
7289 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
7290 'font-lock-function-name-face
7291 'font-lock-variable-name-face)
7292 ;; need to manually set 'multiline' for older font-locks
7293 '(progn
7294 (if (< 1 (count-lines (match-beginning 0)
7295 (match-end 0)))
7296 (put-text-property
7297 (+ 3 (match-beginning 0)) (match-end 0)
7298 'syntax-type 'multiline))
7299 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
7300 'font-lock-function-name-face
7301 'font-lock-variable-name-face))))
c07a80fd 7302 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4633a7c4 7303 2 font-lock-function-name-face)
499d5216
IZ
7304 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
7305 1 font-lock-function-name-face)
c07a80fd 7306 (cond ((featurep 'font-lock-extra)
8cfd7987 7307 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
c07a80fd 7308 (2 font-lock-string-face t)
7309 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
7310 (font-lock-anchored
29043b61 7311 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
c07a80fd 7312 (2 font-lock-string-face t)
29043b61 7313 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
c07a80fd 7314 nil nil
7315 (1 font-lock-string-face t))))
29043b61 7316 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
c07a80fd 7317 2 font-lock-string-face t)))
6c72d195 7318 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
4633a7c4 7319 font-lock-string-face t)
8cfd7987
JH
7320 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
7321 font-lock-constant-face) ; labels
4633a7c4 7322 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
6c72d195 7323 2 font-lock-constant-face)
7bcea553
IZ
7324 ;; Uncomment to get perl-mode-like vars
7325 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
7326 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
7327 ;;; (2 (cons font-lock-variable-name-face '(underline))))
c07a80fd 7328 (cond ((featurep 'font-lock-extra)
296d8a58 7329 '("^[ \t]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
c07a80fd 7330 (3 font-lock-variable-name-face)
7331 (4 '(another 4 nil
7332 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
7333 (1 font-lock-variable-name-face)
8cfd7987 7334 (2 '(restart 2 nil) nil t)))
c07a80fd 7335 nil t))) ; local variables, multiple
7336 (font-lock-anchored
8f95267c
RGS
7337 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
7338 (` ((, (concat "\\<\\(my\\|local\\|our\\)"
7339 cperl-maybe-white-and-comment-rex
7340 "\\(("
7341 cperl-maybe-white-and-comment-rex
7342 "\\)?\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)"))
7343 (5 (, (if cperl-font-lock-multiline
7344 'font-lock-variable-name-face
7345 '(progn (setq cperl-font-lock-multiline-start
7346 (match-beginning 0))
7347 'font-lock-variable-name-face))))
7348 ((, (concat "\\="
7349 cperl-maybe-white-and-comment-rex
7350 ","
7351 cperl-maybe-white-and-comment-rex
7352 "\\([$@%*]\\([a-zA-Z0-9_:]+\\|[^a-zA-Z0-9_]\\)\\)"))
7353 ;; Bug in font-lock: limit is used not only to limit
7354 ;; searches, but to set the "extend window for
7355 ;; facification" property. Thus we need to minimize.
7356 (, (if cperl-font-lock-multiline
7357 '(if (match-beginning 3)
7358 (save-excursion
7359 (goto-char (match-beginning 3))
7360 (condition-case nil
7361 (forward-sexp 1)
7362 (error
7363 (condition-case nil
7364 (forward-char 200)
7365 (error nil)))) ; typeahead
7366 (1- (point))) ; report limit
7367 (forward-char -2)) ; disable continued expr
7368 '(if (match-beginning 3)
7369 (point-max) ; No limit for continuation
7370 (forward-char -2)))) ; disable continued expr
7371 (, (if cperl-font-lock-multiline
7372 nil
7373 '(progn ; Do at end
7374 ;; "my" may be already fontified (POD),
7375 ;; so cperl-font-lock-multiline-start is nil
7376 (if (or (not cperl-font-lock-multiline-start)
7377 (> 2 (count-lines
7378 cperl-font-lock-multiline-start
7379 (point))))
7380 nil
7381 (put-text-property
7382 (1+ cperl-font-lock-multiline-start) (point)
7383 'syntax-type 'multiline))
7384 (setq cperl-font-lock-multiline-start nil))))
7385 (3 font-lock-variable-name-face)))))
7386 (t '("^[ \t{}]*\\(my\\|local\\|our\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
c07a80fd 7387 3 font-lock-variable-name-face)))
7bcea553
IZ
7388 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
7389 4 font-lock-variable-name-face)))
8cfd7987 7390 (setq
c07a80fd 7391 t-font-lock-keywords-1
7392 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
8f95267c
RGS
7393 ;; not yet as of XEmacs 19.12, works with 21.1.11
7394 (or
7395 (not cperl-xemacs-p)
7396 (string< "21.1.9" emacs-version)
7397 (and (string< "21.1.10" emacs-version)
7398 (string< emacs-version "21.1.2")))
55497cff 7399 '(
7400 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
7401 (if (eq (char-after (match-beginning 2)) ?%)
6c72d195
IZ
7402 cperl-hash-face
7403 cperl-array-face)
55497cff 7404 t) ; arrays and hashes
7405 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
c07a80fd 7406 1
8cfd7987 7407 (if (= (- (match-end 2) (match-beginning 2)) 1)
c07a80fd 7408 (if (eq (char-after (match-beginning 3)) ?{)
6c72d195
IZ
7409 cperl-hash-face
7410 cperl-array-face) ; arrays and hashes
c07a80fd 7411 font-lock-variable-name-face) ; Just to put something
7412 t)
8f95267c
RGS
7413 ("\\(@\\|\\$#\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
7414 (1 cperl-array-face)
7415 (2 font-lock-variable-name-face))
7416 ("\\(%\\)\\(\\$+\\([a-zA-Z_:][a-zA-Z0-9_:]*\\|[^ \t\n]\\)\\)"
7417 (1 cperl-hash-face)
7418 (2 font-lock-variable-name-face))
c07a80fd 7419 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4633a7c4 7420 ;;; Too much noise from \s* @s[ and friends
8cfd7987 7421 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
c07a80fd 7422 ;;(3 font-lock-function-name-face t t)
7423 ;;(4
7424 ;; (if (cperl-slash-is-regexp)
7425 ;; font-lock-function-name-face 'default) nil t))
7426 )))
7bcea553
IZ
7427 (if cperl-highlight-variables-indiscriminately
7428 (setq t-font-lock-keywords-1
7429 (append t-font-lock-keywords-1
8f95267c 7430 (list '("\\([$*]{?\\sw+\\)" 1
7bcea553 7431 font-lock-variable-name-face)))))
8f95267c 7432 (setq perl-font-lock-keywords-1
20675f5d
IZ
7433 (if cperl-syntaxify-by-font-lock
7434 (cons 'cperl-fontify-update
7435 t-font-lock-keywords)
7436 t-font-lock-keywords)
c07a80fd 7437 perl-font-lock-keywords perl-font-lock-keywords-1
7438 perl-font-lock-keywords-2 (append
20675f5d 7439 perl-font-lock-keywords-1
c07a80fd 7440 t-font-lock-keywords-1)))
4633a7c4 7441 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
c07a80fd 7442 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
6c72d195 7443 (eval ; Avoid a warning
8cfd7987
JH
7444 '(font-lock-require-faces
7445 (list
7446 ;; Color-light Color-dark Gray-light Gray-dark Mono
7447 (list 'font-lock-comment-face
7448 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
7449 nil
7450 [nil nil t t t]
7451 [nil nil t t t]
7452 nil)
7453 (list 'font-lock-string-face
7454 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
7455 nil
7456 nil
7457 [nil nil t t t]
7458 nil)
7459 (list 'font-lock-function-name-face
7460 (vector
7461 "Blue" "LightSkyBlue" "Gray50" "LightGray"
7462 (cdr (assq 'background-color ; if mono
7463 (frame-parameters))))
7464 (vector
7465 nil nil nil nil
7466 (cdr (assq 'foreground-color ; if mono
7467 (frame-parameters))))
7468 [nil nil t t t]
7469 nil
7470 nil)
7471 (list 'font-lock-variable-name-face
7472 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
7473 nil
7474 [nil nil t t t]
7475 [nil nil t t t]
7476 nil)
7477 (list 'font-lock-type-face
7478 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
7479 nil
7480 [nil nil t t t]
7481 nil
7482 [nil nil t t t])
8f95267c
RGS
7483 (list 'font-lock-warning-face
7484 ["Pink" "Red" "Gray50" "LightGray"]
7485 ["gray20" "gray90"
7486 "gray80" "gray20"]
7487 [nil nil t t t]
7488 nil
7489 [nil nil t t t]
7490 )
8cfd7987
JH
7491 (list 'font-lock-constant-face
7492 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
7493 nil
7494 [nil nil t t t]
7495 nil
7496 [nil nil t t t])
7497 (list 'cperl-nonoverridable-face
7498 ["chartreuse3" ("orchid1" "orange")
7499 nil "Gray80"]
7500 [nil nil "gray90"]
7501 [nil nil nil t t]
7502 [nil nil t t]
7503 [nil nil t t t])
7504 (list 'cperl-array-face
7505 ["blue" "yellow" nil "Gray80"]
7506 ["lightyellow2" ("navy" "os2blue" "darkgreen")
7507 "gray90"]
7508 t
7509 nil
7510 nil)
7511 (list 'cperl-hash-face
7512 ["red" "red" nil "Gray80"]
7513 ["lightyellow2" ("navy" "os2blue" "darkgreen")
7514 "gray90"]
7515 t
7516 t
7517 nil))))
20675f5d 7518 ;; Do it the dull way, without choose-color
4633a7c4
LW
7519 (defvar cperl-guessed-background nil
7520 "Display characteristics as guessed by cperl.")
8cfd7987 7521 ;; (or (fboundp 'x-color-defined-p)
8f95267c 7522 ;; (defalias 'x-color-defined-p
8cfd7987
JH
7523 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
7524 ;; ;; XEmacs >= 19.12
7525 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
7526 ;; ;; XEmacs 19.11
7527 ;; (t 'x-valid-color-name-p))))
7528 (cperl-force-face font-lock-constant-face
20675f5d
IZ
7529 "Face for constant and label names")
7530 (cperl-force-face font-lock-variable-name-face
7531 "Face for variable names")
7532 (cperl-force-face font-lock-type-face
7533 "Face for data types")
4584684c 7534 (cperl-force-face cperl-nonoverridable-face
20675f5d 7535 "Face for data types from another group")
8f95267c
RGS
7536 (cperl-force-face font-lock-warning-face
7537 "Face for things which should stand out")
20675f5d
IZ
7538 (cperl-force-face font-lock-comment-face
7539 "Face for comments")
20675f5d
IZ
7540 (cperl-force-face font-lock-function-name-face
7541 "Face for function names")
7542 (cperl-force-face cperl-hash-face
7543 "Face for hashes")
7544 (cperl-force-face cperl-array-face
7545 "Face for arrays")
7546 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
7547 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
7548 ;;(or (boundp 'font-lock-type-face)
7549 ;; (defconst font-lock-type-face
7550 ;; 'font-lock-type-face
7551 ;; "Face to use for data types."))
4584684c
GS
7552 ;;(or (boundp 'cperl-nonoverridable-face)
7553 ;; (defconst cperl-nonoverridable-face
7554 ;; 'cperl-nonoverridable-face
20675f5d
IZ
7555 ;; "Face to use for data types from another group."))
7556 ;;(if (not cperl-xemacs-p) nil
7557 ;; (or (boundp 'font-lock-comment-face)
7558 ;; (defconst font-lock-comment-face
7559 ;; 'font-lock-comment-face
7560 ;; "Face to use for comments."))
7561 ;; (or (boundp 'font-lock-keyword-face)
7562 ;; (defconst font-lock-keyword-face
7563 ;; 'font-lock-keyword-face
7564 ;; "Face to use for keywords."))
7565 ;; (or (boundp 'font-lock-function-name-face)
7566 ;; (defconst font-lock-function-name-face
7567 ;; 'font-lock-function-name-face
7568 ;; "Face to use for function names.")))
6c72d195 7569 (if (and
8cfd7987
JH
7570 (not (cperl-is-face 'cperl-array-face))
7571 (cperl-is-face 'font-lock-emphasized-face))
20675f5d 7572 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
6c72d195 7573 (if (and
8cfd7987
JH
7574 (not (cperl-is-face 'cperl-hash-face))
7575 (cperl-is-face 'font-lock-other-emphasized-face))
7576 (copy-face 'font-lock-other-emphasized-face
6c72d195 7577 'cperl-hash-face))
4584684c 7578 (if (and
8cfd7987
JH
7579 (not (cperl-is-face 'cperl-nonoverridable-face))
7580 (cperl-is-face 'font-lock-other-type-face))
7581 (copy-face 'font-lock-other-type-face
4584684c 7582 'cperl-nonoverridable-face))
20675f5d
IZ
7583 ;;(or (boundp 'cperl-hash-face)
7584 ;; (defconst cperl-hash-face
7585 ;; 'cperl-hash-face
7586 ;; "Face to use for hashes."))
7587 ;;(or (boundp 'cperl-array-face)
7588 ;; (defconst cperl-array-face
7589 ;; 'cperl-array-face
7590 ;; "Face to use for arrays."))
4633a7c4
LW
7591 ;; Here we try to guess background
7592 (let ((background
7593 (if (boundp 'font-lock-background-mode)
7594 font-lock-background-mode
8cfd7987
JH
7595 'light))
7596 (face-list (and (fboundp 'face-list) (face-list))))
20675f5d
IZ
7597;;;; (fset 'cperl-is-face
7598;;;; (cond ((fboundp 'find-face)
7599;;;; (symbol-function 'find-face))
7600;;;; (face-list
7601;;;; (function (lambda (face) (member face face-list))))
7602;;;; (t
7603;;;; (function (lambda (face) (boundp face))))))
4633a7c4
LW
7604 (defvar cperl-guessed-background
7605 (if (and (boundp 'font-lock-display-type)
7606 (eq font-lock-display-type 'grayscale))
7607 'gray
7608 background)
7609 "Background as guessed by CPerl mode")
8cfd7987
JH
7610 (and (not (cperl-is-face 'font-lock-constant-face))
7611 (cperl-is-face 'font-lock-reference-face)
7612 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
6c72d195 7613 (if (cperl-is-face 'font-lock-type-face) nil
4633a7c4
LW
7614 (copy-face 'default 'font-lock-type-face)
7615 (cond
7616 ((eq background 'light)
7617 (set-face-foreground 'font-lock-type-face
7618 (if (x-color-defined-p "seagreen")
7619 "seagreen"
7620 "sea green")))
7621 ((eq background 'dark)
7622 (set-face-foreground 'font-lock-type-face
7623 (if (x-color-defined-p "os2pink")
7624 "os2pink"
7625 "pink")))
7626 (t
7627 (set-face-background 'font-lock-type-face "gray90"))))
4584684c 7628 (if (cperl-is-face 'cperl-nonoverridable-face)
4633a7c4 7629 nil
4584684c 7630 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
4633a7c4
LW
7631 (cond
7632 ((eq background 'light)
4584684c 7633 (set-face-foreground 'cperl-nonoverridable-face
4633a7c4
LW
7634 (if (x-color-defined-p "chartreuse3")
7635 "chartreuse3"
7636 "chartreuse")))
7637 ((eq background 'dark)
4584684c 7638 (set-face-foreground 'cperl-nonoverridable-face
4633a7c4
LW
7639 (if (x-color-defined-p "orchid1")
7640 "orchid1"
7641 "orange")))))
4584684c
GS
7642;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
7643;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
7644;;; (cond
7645;;; ((eq background 'light)
7646;;; (set-face-background 'font-lock-other-emphasized-face
7647;;; (if (x-color-defined-p "lightyellow2")
7648;;; "lightyellow2"
7649;;; (if (x-color-defined-p "lightyellow")
7650;;; "lightyellow"
7651;;; "light yellow"))))
7652;;; ((eq background 'dark)
7653;;; (set-face-background 'font-lock-other-emphasized-face
7654;;; (if (x-color-defined-p "navy")
7655;;; "navy"
7656;;; (if (x-color-defined-p "darkgreen")
7657;;; "darkgreen"
7658;;; "dark green"))))
7659;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
7660;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
7661;;; (copy-face 'bold 'font-lock-emphasized-face)
7662;;; (cond
7663;;; ((eq background 'light)
7664;;; (set-face-background 'font-lock-emphasized-face
7665;;; (if (x-color-defined-p "lightyellow2")
7666;;; "lightyellow2"
7667;;; "lightyellow")))
7668;;; ((eq background 'dark)
7669;;; (set-face-background 'font-lock-emphasized-face
7670;;; (if (x-color-defined-p "navy")
7671;;; "navy"
7672;;; (if (x-color-defined-p "darkgreen")
7673;;; "darkgreen"
7674;;; "dark green"))))
7675;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
6c72d195 7676 (if (cperl-is-face 'font-lock-variable-name-face) nil
4633a7c4 7677 (copy-face 'italic 'font-lock-variable-name-face))
6c72d195
IZ
7678 (if (cperl-is-face 'font-lock-constant-face) nil
7679 (copy-face 'italic 'font-lock-constant-face))))
c07a80fd 7680 (setq cperl-faces-init t))
20675f5d 7681 (error (message "cperl-init-faces (ignored): %s" errs))))
4633a7c4
LW
7682
7683
7684(defun cperl-ps-print-init ()
7685 "Initialization of `ps-print' components for faces used in CPerl."
4584684c
GS
7686 (eval-after-load "ps-print"
7687 '(setq ps-bold-faces
8cfd7987 7688 ;; font-lock-variable-name-face
4584684c
GS
7689 ;; font-lock-constant-face
7690 (append '(cperl-array-face
8cfd7987 7691 cperl-hash-face)
4584684c
GS
7692 ps-bold-faces)
7693 ps-italic-faces
7694 ;; font-lock-constant-face
7695 (append '(cperl-nonoverridable-face
7696 cperl-hash-face)
7697 ps-italic-faces)
7698 ps-underlined-faces
7699 ;; font-lock-type-face
7700 (append '(cperl-array-face
7701 cperl-hash-face
7702 underline
7703 cperl-nonoverridable-face)
7704 ps-underlined-faces))))
7705
7706(defvar ps-print-face-extension-alist)
7707
7708(defun cperl-ps-print (&optional file)
7709 "Pretty-print in CPerl style.
7710If optional argument FILE is an empty string, prints to printer, otherwise
7711to the file FILE. If FILE is nil, prompts for a file name.
7712
7713Style of printout regulated by the variable `cperl-ps-print-face-properties'."
7714 (interactive)
8cfd7987
JH
7715 (or file
7716 (setq file (read-from-minibuffer
4584684c
GS
7717 "Print to file (if empty - to printer): "
7718 (concat (buffer-file-name) ".ps")
7719 nil nil 'file-name-history)))
7720 (or (> (length file) 0)
7721 (setq file nil))
7722 (require 'ps-print) ; To get ps-print-face-extension-alist
7723 (let ((ps-print-color-p t)
7724 (ps-print-face-extension-alist ps-print-face-extension-alist))
7725 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
7726 (ps-print-buffer-with-faces file)))
7727
7728;;; (defun cperl-ps-print-init ()
7729;;; "Initialization of `ps-print' components for faces used in CPerl."
7730;;; ;; Guard against old versions
7731;;; (defvar ps-underlined-faces nil)
7732;;; (defvar ps-bold-faces nil)
7733;;; (defvar ps-italic-faces nil)
7734;;; (setq ps-bold-faces
7735;;; (append '(font-lock-emphasized-face
7736;;; cperl-array-face
8cfd7987
JH
7737;;; font-lock-keyword-face
7738;;; font-lock-variable-name-face
7739;;; font-lock-constant-face
7740;;; font-lock-reference-face
4584684c 7741;;; font-lock-other-emphasized-face
8cfd7987 7742;;; cperl-hash-face)
4584684c
GS
7743;;; ps-bold-faces))
7744;;; (setq ps-italic-faces
7745;;; (append '(cperl-nonoverridable-face
8cfd7987
JH
7746;;; font-lock-constant-face
7747;;; font-lock-reference-face
4584684c
GS
7748;;; font-lock-other-emphasized-face
7749;;; cperl-hash-face)
7750;;; ps-italic-faces))
7751;;; (setq ps-underlined-faces
7752;;; (append '(font-lock-emphasized-face
7753;;; cperl-array-face
7754;;; font-lock-other-emphasized-face
7755;;; cperl-hash-face
7756;;; cperl-nonoverridable-face font-lock-type-face)
7757;;; ps-underlined-faces))
7758;;; (cons 'font-lock-type-face ps-underlined-faces))
4633a7c4
LW
7759
7760
7761(if (cperl-enable-font-lock) (cperl-windowed-init))
7762
6c72d195 7763(defconst cperl-styles-entries
8cfd7987
JH
7764 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
7765 cperl-label-offset cperl-extra-newline-before-brace
8f95267c 7766 cperl-extra-newline-before-brace-multiline
6c72d195
IZ
7767 cperl-merge-trailing-else
7768 cperl-continued-statement-offset))
7769
8f95267c
RGS
7770(defconst cperl-style-examples
7771"##### Numbers etc are: cperl-indent-level cperl-brace-offset
7772##### cperl-continued-brace-offset cperl-label-offset
7773##### cperl-continued-statement-offset
7774##### cperl-merge-trailing-else cperl-extra-newline-before-brace
7775
7776########### (Do not forget cperl-extra-newline-before-brace-multiline)
7777
7778### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
7779if (foo) {
7780 bar
7781 baz;
7782 label:
7783 {
7784 boon;
7785 }
7786} else {
7787 stop;
7788}
7789
7790### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
7791if (foo) {
7792 bar
7793 baz;
7794 label:
7795 {
7796 boon;
7797 }
7798} else {
7799 stop;
7800}
7801
7802### GNU 2/0/0/-2/2/nil/t
7803if (foo)
7804 {
7805 bar
7806 baz;
7807 label:
7808 {
7809 boon;
7810 }
7811 }
7812else
7813 {
7814 stop;
7815 }
7816
7817### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
7818if (foo)
7819{
7820 bar
7821 baz;
7822 label:
7823 {
7824 boon;
7825 }
7826}
7827else
7828{
7829 stop;
7830}
7831
7832### BSD (=C++, but will not change preexisting merge-trailing-else
7833### and extra-newline-before-brace ) 4/0/-4/-4/4
7834if (foo)
7835{
7836 bar
7837 baz;
7838 label:
7839 {
7840 boon;
7841 }
7842}
7843else
7844{
7845 stop;
7846}
7847
7848### K&R (=C++ with indent 5 - merge-trailing-else, but will not
7849### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
7850if (foo)
7851{
7852 bar
7853 baz;
7854 label:
7855 {
7856 boon;
7857 }
7858}
7859else
7860{
7861 stop;
7862}
7863
7864### Whitesmith (=PerlStyle, but will not change preexisting
7865### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
7866if (foo)
7867 {
7868 bar
7869 baz;
7870 label:
7871 {
7872 boon;
7873 }
7874 }
7875else
7876 {
7877 stop;
7878 }
7879"
7880"Examples of if/else with different indent styles (with v4.23).")
7881
6c72d195 7882(defconst cperl-style-alist
8f95267c 7883 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
6c72d195
IZ
7884 (cperl-indent-level . 2)
7885 (cperl-brace-offset . 0)
7886 (cperl-continued-brace-offset . 0)
7887 (cperl-label-offset . -2)
8f95267c 7888 (cperl-continued-statement-offset . 2)
6c72d195 7889 (cperl-extra-newline-before-brace . nil)
8f95267c
RGS
7890 (cperl-extra-newline-before-brace-multiline . nil)
7891 (cperl-merge-trailing-else . t))
7892
8cfd7987 7893 ("PerlStyle" ; CPerl with 4 as indent
6c72d195
IZ
7894 (cperl-indent-level . 4)
7895 (cperl-brace-offset . 0)
7896 (cperl-continued-brace-offset . 0)
7897 (cperl-label-offset . -4)
8f95267c 7898 (cperl-continued-statement-offset . 4)
6c72d195 7899 (cperl-extra-newline-before-brace . nil)
8f95267c
RGS
7900 (cperl-extra-newline-before-brace-multiline . nil)
7901 (cperl-merge-trailing-else . t))
7902
6c72d195
IZ
7903 ("GNU"
7904 (cperl-indent-level . 2)
7905 (cperl-brace-offset . 0)
7906 (cperl-continued-brace-offset . 0)
7907 (cperl-label-offset . -2)
8f95267c 7908 (cperl-continued-statement-offset . 2)
6c72d195 7909 (cperl-extra-newline-before-brace . t)
8f95267c
RGS
7910 (cperl-extra-newline-before-brace-multiline . t)
7911 (cperl-merge-trailing-else . nil))
7912
6c72d195
IZ
7913 ("K&R"
7914 (cperl-indent-level . 5)
7915 (cperl-brace-offset . 0)
7916 (cperl-continued-brace-offset . -5)
7917 (cperl-label-offset . -5)
8f95267c 7918 (cperl-continued-statement-offset . 5)
6c72d195 7919 ;;(cperl-extra-newline-before-brace . nil) ; ???
8f95267c
RGS
7920 ;;(cperl-extra-newline-before-brace-multiline . nil)
7921 (cperl-merge-trailing-else . nil))
7922
6c72d195
IZ
7923 ("BSD"
7924 (cperl-indent-level . 4)
7925 (cperl-brace-offset . 0)
7926 (cperl-continued-brace-offset . -4)
7927 (cperl-label-offset . -4)
8f95267c 7928 (cperl-continued-statement-offset . 4)
6c72d195 7929 ;;(cperl-extra-newline-before-brace . nil) ; ???
8f95267c
RGS
7930 ;;(cperl-extra-newline-before-brace-multiline . nil)
7931 ;;(cperl-merge-trailing-else . nil) ; ???
7932 )
7933
6c72d195
IZ
7934 ("C++"
7935 (cperl-indent-level . 4)
7936 (cperl-brace-offset . 0)
7937 (cperl-continued-brace-offset . -4)
7938 (cperl-label-offset . -4)
7939 (cperl-continued-statement-offset . 4)
8f95267c
RGS
7940 (cperl-extra-newline-before-brace . t)
7941 (cperl-extra-newline-before-brace-multiline . t)
7942 (cperl-merge-trailing-else . nil))
7943
6c72d195
IZ
7944 ("Whitesmith"
7945 (cperl-indent-level . 4)
7946 (cperl-brace-offset . 0)
7947 (cperl-continued-brace-offset . 0)
7948 (cperl-label-offset . -4)
8f95267c 7949 (cperl-continued-statement-offset . 4)
6c72d195 7950 ;;(cperl-extra-newline-before-brace . nil) ; ???
8f95267c
RGS
7951 ;;(cperl-extra-newline-before-brace-multiline . nil)
7952 ;;(cperl-merge-trailing-else . nil) ; ???
7953 )
7954 ("Current"))
7955 "List of variables to set to get a particular indentation style.
7956Should be used via `cperl-set-style' or via Perl menu.
7957
7958See examples in `cperl-style-examples'.")
6c72d195 7959
4633a7c4 7960(defun cperl-set-style (style)
8cfd7987 7961 "Set CPerl mode variables to use one of several different indentation styles.
4633a7c4 7962The arguments are a string representing the desired style.
8cfd7987 7963The list of styles is in `cperl-style-alist', available styles
8f95267c 7964are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
6c72d195
IZ
7965
7966The current value of style is memorized (unless there is a memorized
7967data already), may be restored by `cperl-set-style-back'.
7968
7969Chosing \"Current\" style will not change style, so this may be used for
8f95267c 7970side-effect of memorizing only. Examples in `cperl-style-examples'."
8cfd7987 7971 (interactive
8f95267c 7972 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
6c72d195 7973 cperl-style-alist)))
4633a7c4 7974 (list (completing-read "Enter style: " list nil 'insist))))
6c72d195
IZ
7975 (or cperl-old-style
7976 (setq cperl-old-style
7977 (mapcar (function
7978 (lambda (name)
7979 (cons name (eval name))))
7980 cperl-styles-entries)))
7981 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
4633a7c4
LW
7982 (while style
7983 (setq setting (car style) style (cdr style))
6c72d195
IZ
7984 (set (car setting) (cdr setting)))))
7985
7986(defun cperl-set-style-back ()
7987 "Restore a style memorised by `cperl-set-style'."
7988 (interactive)
7989 (or cperl-old-style (error "The style was not changed"))
7990 (let (setting)
7991 (while cperl-old-style
8cfd7987 7992 (setq setting (car cperl-old-style)
6c72d195
IZ
7993 cperl-old-style (cdr cperl-old-style))
7994 (set (car setting) (cdr setting)))))
4633a7c4
LW
7995
7996(defun cperl-check-syntax ()
7997 (interactive)
7998 (require 'mode-compile)
6c72d195
IZ
7999 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
8000 (eval '(mode-compile)))) ; Avoid a warning
4633a7c4 8001
5f05dabc 8002(defun cperl-info-buffer (type)
6c72d195 8003 ;; Returns buffer with documentation. Creates if missing.
5f05dabc 8004 ;; If TYPE, this vars buffer.
8005 ;; Special care is taken to not stomp over an existing info buffer
8006 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
8007 (info (get-buffer bname))
8008 (oldbuf (get-buffer "*info*")))
4633a7c4
LW
8009 (if info info
8010 (save-window-excursion
8011 ;; Get Info running
8012 (require 'info)
5f05dabc 8013 (cond (oldbuf
8014 (set-buffer oldbuf)
8015 (rename-buffer "*info-perl-tmp*")))
4633a7c4
LW
8016 (save-window-excursion
8017 (info))
5f05dabc 8018 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
4633a7c4 8019 (set-buffer "*info*")
5f05dabc 8020 (rename-buffer bname)
8021 (cond (oldbuf
8022 (set-buffer "*info-perl-tmp*")
8023 (rename-buffer "*info*")
8024 (set-buffer bname)))
8cfd7987 8025 (make-local-variable 'window-min-height)
5f05dabc 8026 (setq window-min-height 2)
4633a7c4
LW
8027 (current-buffer)))))
8028
8029(defun cperl-word-at-point (&optional p)
8cfd7987 8030 "Return the word at point or at P."
4633a7c4
LW
8031 (save-excursion
8032 (if p (goto-char p))
5f05dabc 8033 (or (cperl-word-at-point-hard)
8034 (progn
8035 (require 'etags)
8036 (funcall (or (and (boundp 'find-tag-default-function)
8037 find-tag-default-function)
8038 (get major-mode 'find-tag-default-function)
8039 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
8040 ;; automatically used within `find-tag-default':
8041 'find-tag-default))))))
4633a7c4
LW
8042
8043(defun cperl-info-on-command (command)
8cfd7987 8044 "Show documentation for Perl command COMMAND in other window.
5f05dabc 8045If perl-info buffer is shown in some frame, uses this frame.
8046Customized by setting variables `cperl-shrink-wrap-info-frame',
8047`cperl-max-help-size'."
8cfd7987 8048 (interactive
4633a7c4 8049 (let* ((default (cperl-word-at-point))
8cfd7987
JH
8050 (read (read-string
8051 (format "Find doc for Perl function (default %s): "
8052 default))))
8053 (list (if (equal read "")
8054 default
8055 read))))
4633a7c4
LW
8056
8057 (let ((buffer (current-buffer))
c07a80fd 8058 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
5f05dabc 8059 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
8060 max-height char-height buf-list)
4633a7c4
LW
8061 (if (string-match "^-[a-zA-Z]$" command)
8062 (setq cmd-desc "^-X[ \t\n]"))
5f05dabc 8063 (setq isvar (string-match "^[$@%]" command)
8064 buf (cperl-info-buffer isvar)
8065 iniwin (selected-window)
8066 fr1 (window-frame iniwin))
8067 (set-buffer buf)
8f95267c 8068 (goto-char (point-min))
8cfd7987 8069 (or isvar
5f05dabc 8070 (progn (re-search-forward "^-X[ \t\n]")
8071 (forward-line -1)))
4633a7c4
LW
8072 (if (re-search-forward cmd-desc nil t)
8073 (progn
5f05dabc 8074 ;; Go back to beginning of the group (ex, for qq)
8075 (if (re-search-backward "^[ \t\n\f]")
8076 (forward-line 1))
8077 (beginning-of-line)
8cfd7987 8078 ;; Get some of
5f05dabc 8079 (setq pos (point)
8080 buf-list (list buf "*info-perl-var*" "*info-perl*"))
8081 (while (and (not win) buf-list)
8082 (setq win (get-buffer-window (car buf-list) t))
8083 (setq buf-list (cdr buf-list)))
8084 (or (not win)
8085 (eq (window-buffer win) buf)
8086 (set-window-buffer win buf))
8087 (and win (setq fr2 (window-frame win)))
8088 (if (or (not fr2) (eq fr1 fr2))
8089 (pop-to-buffer buf)
8090 (special-display-popup-frame buf) ; Make it visible
8091 (select-window win))
8092 (goto-char pos) ; Needed (?!).
8093 ;; Resize
8094 (setq iniheight (window-height)
8095 frheight (frame-height)
8096 not-loner (< iniheight (1- frheight))) ; Are not alone
8cfd7987 8097 (cond ((if not-loner cperl-max-help-size
5f05dabc 8098 cperl-shrink-wrap-info-frame)
8cfd7987
JH
8099 (setq height
8100 (+ 2
8101 (count-lines
8102 pos
5f05dabc 8103 (save-excursion
8104 (if (re-search-forward
8105 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
8106 (match-beginning 0) (point-max)))))
8cfd7987 8107 max-height
5f05dabc 8108 (if not-loner
8109 (/ (* (- frheight 3) cperl-max-help-size) 100)
8110 (setq char-height (frame-char-height))
8111 ;; Non-functioning under OS/2:
8112 (if (eq char-height 1) (setq char-height 18))
8113 ;; Title, menubar, + 2 for slack
8cfd7987 8114 (- (/ (x-display-pixel-height) char-height) 4)))
5f05dabc 8115 (if (> height max-height) (setq height max-height))
8116 ;;(message "was %s doing %s" iniheight height)
8117 (if not-loner
8118 (enlarge-window (- height iniheight))
8119 (set-frame-height (window-frame win) (1+ height)))))
4633a7c4
LW
8120 (set-window-start (selected-window) pos))
8121 (message "No entry for %s found." command))
5f05dabc 8122 ;;(pop-to-buffer buffer)
8123 (select-window iniwin)))
4633a7c4
LW
8124
8125(defun cperl-info-on-current-command ()
8cfd7987 8126 "Show documentation for Perl command at point in other window."
4633a7c4
LW
8127 (interactive)
8128 (cperl-info-on-command (cperl-word-at-point)))
8129
8130(defun cperl-imenu-info-imenu-search ()
8131 (if (looking-at "^-X[ \t\n]") nil
8132 (re-search-backward
ebcd4dbc 8133 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
4633a7c4
LW
8134 (forward-line 1)))
8135
8cfd7987 8136(defun cperl-imenu-info-imenu-name ()
4633a7c4
LW
8137 (buffer-substring
8138 (match-beginning 1) (match-end 1)))
8139
8140(defun cperl-imenu-on-info ()
8f95267c
RGS
8141 "Shows imenu for Perl Info Buffer.
8142Opens Perl Info buffer if needed."
4633a7c4
LW
8143 (interactive)
8144 (let* ((buffer (current-buffer))
8145 imenu-create-index-function
8cfd7987
JH
8146 imenu-prev-index-position-function
8147 imenu-extract-index-name-function
4633a7c4
LW
8148 (index-item (save-restriction
8149 (save-window-excursion
5f05dabc 8150 (set-buffer (cperl-info-buffer nil))
8cfd7987 8151 (setq imenu-create-index-function
4633a7c4
LW
8152 'imenu-default-create-index-function
8153 imenu-prev-index-position-function
8154 'cperl-imenu-info-imenu-search
8155 imenu-extract-index-name-function
8156 'cperl-imenu-info-imenu-name)
8157 (imenu-choose-buffer-index)))))
8158 (and index-item
8159 (progn
8160 (push-mark)
8161 (pop-to-buffer "*info-perl*")
8162 (cond
8163 ((markerp (cdr index-item))
8164 (goto-char (marker-position (cdr index-item))))
8165 (t
8166 (goto-char (cdr index-item))))
8167 (set-window-start (selected-window) (point))
8168 (pop-to-buffer buffer)))))
8169
8170(defun cperl-lineup (beg end &optional step minshift)
8171 "Lineup construction in a region.
8172Beginning of region should be at the start of a construction.
55497cff 8173All first occurrences of this construction in the lines that are
4633a7c4
LW
8174partially contained in the region are lined up at the same column.
8175
8176MINSHIFT is the minimal amount of space to insert before the construction.
8177STEP is the tabwidth to position constructions.
8cfd7987 8178If STEP is nil, `cperl-lineup-step' will be used
4633a7c4
LW
8179\(or `cperl-indent-level', if `cperl-lineup-step' is `nil').
8180Will not move the position at the start to the left."
8181 (interactive "r")
8f95267c 8182 (let (search col tcol seen b)
4633a7c4
LW
8183 (save-excursion
8184 (goto-char end)
8185 (end-of-line)
8186 (setq end (point-marker))
8187 (goto-char beg)
8188 (skip-chars-forward " \t\f")
8189 (setq beg (point-marker))
8190 (indent-region beg end nil)
8191 (goto-char beg)
8192 (setq col (current-column))
499d5216
IZ
8193 (if (looking-at "[a-zA-Z0-9_]")
8194 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
4633a7c4 8195 (setq search
8cfd7987
JH
8196 (concat "\\<"
8197 (regexp-quote
4633a7c4
LW
8198 (buffer-substring (match-beginning 0)
8199 (match-end 0))) "\\>"))
8200 (error "Cannot line up in a middle of the word"))
8201 (if (looking-at "$")
8202 (error "Cannot line up end of line"))
8203 (setq search (regexp-quote (char-to-string (following-char)))))
8204 (setq step (or step cperl-lineup-step cperl-indent-level))
8205 (or minshift (setq minshift 1))
8206 (while (progn
8207 (beginning-of-line 2)
8cfd7987 8208 (and (< (point) end)
4633a7c4
LW
8209 (re-search-forward search end t)
8210 (goto-char (match-beginning 0))))
8211 (setq tcol (current-column) seen t)
8212 (if (> tcol col) (setq col tcol)))
8213 (or seen
55497cff 8214 (error "The construction to line up occurred only once"))
4633a7c4
LW
8215 (goto-char beg)
8216 (setq col (+ col minshift))
8217 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
8cfd7987 8218 (while
4633a7c4 8219 (progn
8f95267c 8220 (cperl-make-indent col)
8cfd7987
JH
8221 (beginning-of-line 2)
8222 (and (< (point) end)
4633a7c4
LW
8223 (re-search-forward search end t)
8224 (goto-char (match-beginning 0)))))))) ; No body
8225
8f95267c 8226(defun cperl-etags (&optional add all files) ;; NOT USED???
4633a7c4
LW
8227 "Run etags with appropriate options for Perl files.
8228If optional argument ALL is `recursive', will process Perl files
8229in subdirectories too."
8230 (interactive)
8231 (let ((cmd "etags")
8f95267c
RGS
8232 (args '("-l" "none" "-r"
8233 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
8234 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
8235 "-r"
8236 "/\\<package[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\([#;]\\|$\\)/\\1/"
8237 "-r"
8238 "/\\<\\(package\\)[ \\t]*;/\\1;/"))
4633a7c4
LW
8239 res)
8240 (if add (setq args (cons "-a" args)))
8241 (or files (setq files (list buffer-file-name)))
8242 (cond
8243 ((eq all 'recursive)
8244 ;;(error "Not implemented: recursive")
8cfd7987 8245 (setq args (append (list "-e"
05bbd9c3 8246 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
4633a7c4
LW
8247 use File::Find;
8248 find(\\&wanted, '.');
8cfd7987 8249 exec @ARGV;"
4633a7c4
LW
8250 cmd) args)
8251 cmd "perl"))
8cfd7987 8252 (all
4633a7c4 8253 ;;(error "Not implemented: all")
8cfd7987 8254 (setq args (append (list "-e"
4633a7c4 8255 "push @ARGV, <*.PL *.pl *.pm>;
8cfd7987 8256 exec @ARGV;"
4633a7c4
LW
8257 cmd) args)
8258 cmd "perl"))
8259 (t
8260 (setq args (append args files))))
8261 (setq res (apply 'call-process cmd nil nil nil args))
8262 (or (eq res 0)
8263 (message "etags returned \"%s\"" res))))
9ea28adb 8264
8265(defun cperl-toggle-auto-newline ()
8266 "Toggle the state of `cperl-auto-newline'."
8267 (interactive)
8268 (setq cperl-auto-newline (not cperl-auto-newline))
8cfd7987 8269 (message "Newlines will %sbe auto-inserted now."
9ea28adb 8270 (if cperl-auto-newline "" "not ")))
8271
8272(defun cperl-toggle-abbrev ()
8273 "Toggle the state of automatic keyword expansion in CPerl mode."
8274 (interactive)
8275 (abbrev-mode (if abbrev-mode 0 1))
8cfd7987 8276 (message "Perl control structure will %sbe auto-inserted now."
9ea28adb 8277 (if abbrev-mode "" "not ")))
8278
8279
8280(defun cperl-toggle-electric ()
8281 "Toggle the state of parentheses doubling in CPerl mode."
8282 (interactive)
8283 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
8cfd7987 8284 (message "Parentheses will %sbe auto-doubled now."
9ea28adb 8285 (if (cperl-val 'cperl-electric-parens) "" "not ")))
8286
6c72d195 8287(defun cperl-toggle-autohelp ()
8cfd7987
JH
8288 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
8289Delay of auto-help controlled by `cperl-lazy-help-time'."
6c72d195
IZ
8290 (interactive)
8291 (if (fboundp 'run-with-idle-timer)
8292 (progn
8293 (if cperl-lazy-installed
8cfd7987 8294 (cperl-lazy-unstall)
6c72d195 8295 (cperl-lazy-install))
8cfd7987 8296 (message "Perl help messages will %sbe automatically shown now."
6c72d195
IZ
8297 (if cperl-lazy-installed "" "not ")))
8298 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
8299
8300(defun cperl-toggle-construct-fix ()
8301 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
8302 (interactive)
8cfd7987 8303 (setq cperl-indent-region-fix-constructs
4584684c
GS
8304 (if cperl-indent-region-fix-constructs
8305 nil
8306 1))
8cfd7987 8307 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
6c72d195
IZ
8308 (if cperl-indent-region-fix-constructs "" "not ")))
8309
8f95267c
RGS
8310(defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
8311 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
8312Nonpositive numeric argument disables debugging messages. The message
8313summarizes which regions it was decided to rescan for syntactic constructs.
8314
8315The message looks like this:
8316
8317 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
8318
8319Numbers are character positions in the buffer. REQ provides the range to
8320rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
8321for correct operation it should start and end outside any special syntactic
8322construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
8323by CPerl."
8324 (interactive "P")
8325 (or arg
8326 (setq arg (if (eq cperl-syntaxify-by-font-lock
8327 (if backtrace 'backtrace 'message)) 0 1)))
8328 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
8329 (setq cperl-syntaxify-by-font-lock arg)
8330 (message "Debugging messages of syntax unwind %sabled."
8331 (if (eq arg t) "dis" "en")))
8332
9ea28adb 8333;;;; Tags file creation.
8334
8335(defvar cperl-tmp-buffer " *cperl-tmp*")
8336
8337(defun cperl-setup-tmp-buf ()
8338 (set-buffer (get-buffer-create cperl-tmp-buffer))
8339 (set-syntax-table cperl-mode-syntax-table)
8340 (buffer-disable-undo)
05bbd9c3
IZ
8341 (auto-fill-mode 0)
8342 (if cperl-use-syntax-table-text-property-for-tags
8343 (progn
8cfd7987 8344 (make-local-variable 'parse-sexp-lookup-properties)
05bbd9c3
IZ
8345 ;; Do not introduce variable if not needed, we check it!
8346 (set 'parse-sexp-lookup-properties t))))
9ea28adb 8347
8348(defun cperl-xsub-scan ()
8349 (require 'cl)
499d5216 8350 (require 'imenu)
8cfd7987 8351 (let ((index-alist '())
9ea28adb 8352 (prev-pos 0) index index1 name package prefix)
8353 (goto-char (point-min))
3ee700d1
IZ
8354 (if noninteractive
8355 (message "Scanning XSUB for index")
8356 (imenu-progress-message prev-pos 0))
9ea28adb 8357 ;; Search for the function
8358 (progn ;;save-match-data
8359 (while (re-search-forward
8360 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
8361 nil t)
3ee700d1
IZ
8362 (or noninteractive
8363 (imenu-progress-message prev-pos))
9ea28adb 8364 (cond
8cfd7987 8365 ((match-beginning 2) ; SECTION
9ea28adb 8366 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
8367 (goto-char (match-beginning 0))
8368 (skip-chars-forward " \t")
8369 (forward-char 1)
8370 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
8371 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
8372 (setq prefix nil)))
8373 ((not package) nil) ; C language section
8374 ((match-beginning 3) ; XSUB
8375 (goto-char (1+ (match-beginning 3)))
8376 (setq index (imenu-example--name-and-position))
8377 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
8378 (if (and prefix (string-match (concat "^" prefix) name))
8379 (setq name (substring name (length prefix))))
9ea28adb 8380 (cond ((string-match "::" name) nil)
8381 (t
8382 (setq index1 (cons (concat package "::" name) (cdr index)))
8383 (push index1 index-alist)))
8384 (setcar index name)
8385 (push index index-alist))
8386 (t ; BOOT: section
8387 ;; (beginning-of-line)
8388 (setq index (imenu-example--name-and-position))
8389 (setcar index (concat package "::BOOT:"))
8390 (push index index-alist)))))
3ee700d1
IZ
8391 (or noninteractive
8392 (imenu-progress-message prev-pos 100))
9ea28adb 8393 index-alist))
8394
7bcea553
IZ
8395(defvar cperl-unreadable-ok nil)
8396
8397(defun cperl-find-tags (ifile xs topdir)
8cfd7987
JH
8398 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
8399 (cperl-pod-here-fontify nil) f file)
9ea28adb 8400 (save-excursion
8401 (if b (set-buffer b)
8cfd7987 8402 (cperl-setup-tmp-buf))
9ea28adb 8403 (erase-buffer)
7bcea553
IZ
8404 (condition-case err
8405 (setq file (car (insert-file-contents ifile)))
8406 (error (if cperl-unreadable-ok nil
8407 (if (y-or-n-p
8408 (format "File %s unreadable. Continue? " ifile))
8409 (setq cperl-unreadable-ok t)
8410 (error "Aborting: unreadable file %s" ifile)))))
8cfd7987 8411 (if (not file)
7bcea553 8412 (message "Unreadable file %s" ifile)
8cfd7987
JH
8413 (message "Scanning file %s ..." file)
8414 (if (and cperl-use-syntax-table-text-property-for-tags
8415 (not xs))
8416 (condition-case err ; after __END__ may have garbage
8417 (cperl-find-pods-heres nil nil noninteractive)
8418 (error (message "While scanning for syntax: %s" err))))
8419 (if xs
8420 (setq lst (cperl-xsub-scan))
8421 (setq ind (cperl-imenu--create-perl-index))
8422 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
8423 (setq lst
8424 (mapcar
8425 (function
8426 (lambda (elt)
8427 (cond ((string-match "^[_a-zA-Z]" (car elt))
8428 (goto-char (cdr elt))
8429 (beginning-of-line) ; pos should be of the start of the line
8430 (list (car elt)
8431 (point)
8432 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
8433 (buffer-substring (progn
8434 (goto-char (cdr elt))
8435 ;; After name now...
8436 (or (eolp) (forward-char 1))
8437 (point))
8438 (progn
8439 (beginning-of-line)
8440 (point))))))))
8441 lst))
8442 (erase-buffer)
8443 (while lst
8444 (setq elt (car lst) lst (cdr lst))
8445 (if elt
8446 (progn
8447 (insert (elt elt 3)
8448 127
8449 (if (string-match "^package " (car elt))
8450 (substring (car elt) 8)
8451 (car elt) )
8452 1
8453 (number-to-string (elt elt 2)) ; Line
8454 ","
8455 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
8456 "\n")
8457 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
8458 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
8459 (elt elt 3)))
8460 ;; Need to insert the name without package as well
8f95267c 8461 (setq lst (cons (cons (substring (elt elt 3)
8cfd7987
JH
8462 (match-beginning 1)
8463 (match-end 1))
8464 (cdr elt))
8465 lst))))))
8466 (setq pos (point))
8467 (goto-char 1)
8468 (setq rel file)
8469 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
8470 (set-text-properties 0 (length rel) nil rel)
8471 (and (equal topdir (substring rel 0 (length topdir)))
8472 (setq rel (substring file (length topdir))))
8473 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
8474 (setq ret (buffer-substring 1 (point-max)))
8475 (erase-buffer)
8476 (or noninteractive
8477 (message "Scanning file %s finished" file))
8478 ret))))
9ea28adb 8479
3ee700d1 8480(defun cperl-add-tags-recurse-noxs ()
8f95267c
RGS
8481 "Add to TAGS data for \"pure\" Perl files in the current directory and kids.
8482Use as
3ee700d1 8483 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
6c791c2c 8484 -f cperl-add-tags-recurse-noxs
3ee700d1
IZ
8485"
8486 (cperl-write-tags nil nil t t nil t))
8487
6c791c2c 8488(defun cperl-add-tags-recurse-noxs-fullpath ()
8f95267c
RGS
8489 "Add to TAGS data for \"pure\" Perl in the current directory and kids.
8490Writes down fullpath, so TAGS is relocatable (but if the build directory
8491is relocated, the file TAGS inside it breaks). Use as
6c791c2c
SB
8492 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
8493 -f cperl-add-tags-recurse-noxs-fullpath
8494"
8495 (cperl-write-tags nil nil t t nil t ""))
8496
3ee700d1
IZ
8497(defun cperl-add-tags-recurse ()
8498 "Add to TAGS file data for Perl files in the current directory and kids.
8499Use as
8500 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
8cfd7987 8501 -f cperl-add-tags-recurse
3ee700d1
IZ
8502"
8503 (cperl-write-tags nil nil t t))
8504
8505(defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
9ea28adb 8506 ;; If INBUFFER, do not select buffer, and do not save
8507 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
499d5216 8508 (require 'etags)
9ea28adb 8509 (if file nil
8510 (setq file (if dir default-directory (buffer-file-name)))
8511 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
3ee700d1
IZ
8512 (or topdir
8513 (setq topdir default-directory))
9ea28adb 8514 (let ((tags-file-name "TAGS")
8515 (case-fold-search (eq system-type 'emx))
7bcea553 8516 xs rel tm)
9ea28adb 8517 (save-excursion
8518 (cond (inbuffer nil) ; Already there
8519 ((file-exists-p tags-file-name)
4584684c
GS
8520 (if cperl-xemacs-p
8521 (visit-tags-table-buffer)
8cfd7987 8522 (visit-tags-table-buffer tags-file-name)))
9ea28adb 8523 (t (set-buffer (find-file-noselect tags-file-name))))
8524 (cond
8525 (dir
8526 (cond ((eq erase 'ignore))
8527 (erase
8528 (erase-buffer)
8529 (setq erase 'ignore)))
8cfd7987 8530 (let ((files
7bcea553 8531 (condition-case err
8cfd7987 8532 (directory-files file t
7bcea553
IZ
8533 (if recurse nil cperl-scan-files-regexp)
8534 t)
8535 (error
8536 (if cperl-unreadable-ok nil
8537 (if (y-or-n-p
8538 (format "Directory %s unreadable. Continue? " file))
8cfd7987
JH
8539 (setq cperl-unreadable-ok t
8540 tm nil) ; Return empty list
7bcea553 8541 (error "Aborting: unreadable directory %s" file)))))))
8f95267c 8542 (mapcar (function
8cfd7987
JH
8543 (lambda (file)
8544 (cond
8545 ((string-match cperl-noscan-files-regexp file)
8546 nil)
8547 ((not (file-directory-p file))
8548 (if (string-match cperl-scan-files-regexp file)
8549 (cperl-write-tags file erase recurse nil t noxs topdir)))
8550 ((not recurse) nil)
8551 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
8552 files)))
9ea28adb 8553 (t
8554 (setq xs (string-match "\\.xs$" file))
3ee700d1
IZ
8555 (if (not (and xs noxs))
8556 (progn
8557 (cond ((eq erase 'ignore) (goto-char (point-max)))
8cfd7987
JH
8558 (erase (erase-buffer))
8559 (t
8560 (goto-char 1)
8561 (setq rel file)
8562 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
8563 (set-text-properties 0 (length rel) nil rel)
8564 (and (equal topdir (substring rel 0 (length topdir)))
8565 (setq rel (substring file (length topdir))))
8566 (if (search-forward (concat "\f\n" rel ",") nil t)
8567 (progn
8568 (search-backward "\f\n")
8569 (delete-region (point)
8570 (save-excursion
8571 (forward-char 1)
8572 (if (search-forward "\f\n"
8573 nil 'toend)
8574 (- (point) 2)
8575 (point-max)))))
8576 (goto-char (point-max)))))
3ee700d1 8577 (insert (cperl-find-tags file xs topdir))))))
8cfd7987
JH
8578 (if inbuffer nil ; Delegate to the caller
8579 (save-buffer 0) ; No backup
5f05dabc 8580 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
8581 (initialize-new-tags-table))))))
9ea28adb 8582
8583(defvar cperl-tags-hier-regexp-list
8cfd7987 8584 (concat
ebcd4dbc
IZ
8585 "^\\("
8586 "\\(package\\)\\>"
8587 "\\|"
8588 "sub\\>[^\n]+::"
8589 "\\|"
8590 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
8591 "\\|"
8592 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
8593 "\\)"))
9ea28adb 8594
8595(defvar cperl-hierarchy '(() ())
8cfd7987 8596 "Global hierarchy of classes.")
9ea28adb 8597
8598(defun cperl-tags-hier-fill ()
8599 ;; Suppose we are in a tag table cooked by cperl.
8600 (goto-char 1)
8601 (let (type pack name pos line chunk ord cons1 file str info fileind)
8602 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
8cfd7987 8603 (setq pos (match-beginning 0)
9ea28adb 8604 pack (match-beginning 2))
8605 (beginning-of-line)
ebcd4dbc
IZ
8606 (if (looking-at (concat
8607 "\\([^\n]+\\)"
8608 "\C-?"
8609 "\\([^\n]+\\)"
8610 "\C-a"
8611 "\\([0-9]+\\)"
8612 ","
8613 "\\([0-9]+\\)"))
9ea28adb 8614 (progn
8615 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
8616 name (buffer-substring (match-beginning 2) (match-end 2))
8617 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
4584684c 8618 line (buffer-substring (match-beginning 3) (match-end 3))
9ea28adb 8619 ord (if pack 1 0)
9ea28adb 8620 file (file-of-tag)
4584684c
GS
8621 fileind (format "%s:%s" file line)
8622 ;; Moves to beginning of the next line:
8623 info (cperl-etags-snarf-tag file line))
9ea28adb 8624 ;; Move back
8625 (forward-char -1)
8626 ;; Make new member of hierarchy name ==> file ==> pos if needed
8627 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
8628 ;; Name known
8629 (setcdr cons1 (cons (cons fileind (vector file info))
8630 (cdr cons1)))
55497cff 8631 ;; First occurrence of the name, start alist
9ea28adb 8632 (setq cons1 (cons name (list (cons fileind (vector file info)))))
8cfd7987 8633 (if pack
9ea28adb 8634 (setcar (cdr cperl-hierarchy)
8635 (cons cons1 (nth 1 cperl-hierarchy)))
8636 (setcar cperl-hierarchy
8637 (cons cons1 (car cperl-hierarchy)))))))
8638 (end-of-line))))
8639
8640(defun cperl-tags-hier-init (&optional update)
8641 "Show hierarchical menu of classes and methods.
8642Finds info about classes by a scan of loaded TAGS files.
8643Supposes that the TAGS files contain fully qualified function names.
8644One may build such TAGS files from CPerl mode menu."
8645 (interactive)
8646 (require 'etags)
8647 (require 'imenu)
8648 (if (or update (null (nth 2 cperl-hierarchy)))
8cfd7987
JH
8649 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
8650 (or (nthcdr 2 elt)
8651 ;; Only in one file
8652 (setcdr elt (cdr (nth 1 elt)))))))
8653 pack name cons1 to l1 l2 l3 l4 b)
9ea28adb 8654 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
8655 (setq cperl-hierarchy (list l1 l2 l3))
4584684c
GS
8656 (if cperl-xemacs-p ; Not checked
8657 (progn
8658 (or tags-file-name
8659 ;; Does this work in XEmacs?
8660 (call-interactively 'visit-tags-table))
8661 (message "Updating list of classes...")
8662 (set-buffer (get-file-buffer tags-file-name))
8663 (cperl-tags-hier-fill))
8664 (or tags-table-list
8665 (call-interactively 'visit-tags-table))
8f95267c 8666 (mapcar
4584684c
GS
8667 (function
8668 (lambda (tagsfile)
8669 (message "Updating list of classes... %s" tagsfile)
8670 (set-buffer (get-file-buffer tagsfile))
8671 (cperl-tags-hier-fill)))
8672 tags-table-list)
8673 (message "Updating list of classes... postprocessing..."))
9ea28adb 8674 (mapcar remover (car cperl-hierarchy))
8675 (mapcar remover (nth 1 cperl-hierarchy))
8676 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
8677 (cons "Methods: " (car cperl-hierarchy))))
8678 (cperl-tags-treeify to 1)
8679 (setcar (nthcdr 2 cperl-hierarchy)
8680 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
8681 (message "Updating list of classes: done, requesting display...")
8682 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
8683 ))
8684 (or (nth 2 cperl-hierarchy)
8685 (error "No items found"))
8686 (setq update
8687;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
8f95267c 8688 (if (if (fboundp 'display-popup-menus-p)
8cfd7987
JH
8689 (let ((f 'display-popup-menus-p))
8690 (funcall f))
8691 window-system)
9ea28adb 8692 (x-popup-menu t (nth 2 cperl-hierarchy))
8693 (require 'tmm)
ebcd4dbc 8694 (tmm-prompt (nth 2 cperl-hierarchy))))
9ea28adb 8695 (if (and update (listp update))
8696 (progn (while (cdr update) (setq update (cdr update)))
8697 (setq update (car update)))) ; Get the last from the list
8cfd7987 8698 (if (vectorp update)
9ea28adb 8699 (progn
8700 (find-file (elt update 0))
4584684c 8701 (cperl-etags-goto-tag-location (elt update 1))))
9ea28adb 8702 (if (eq update -999) (cperl-tags-hier-init t)))
8703
8704(defun cperl-tags-treeify (to level)
6c72d195 8705 ;; cadr of `to' is read-write. On start it is a cons
8cfd7987 8706 (let* ((regexp (concat "^\\(" (mapconcat
9ea28adb 8707 'identity
8708 (make-list level "[_a-zA-Z0-9]+")
8709 "::")
8710 "\\)\\(::\\)?"))
8711 (packages (cdr (nth 1 to)))
8712 (methods (cdr (nth 2 to)))
8713 l1 head tail cons1 cons2 ord writeto packs recurse
8714 root-packages root-functions ms many_ms same_name ps
8715 (move-deeper
8f95267c 8716 (function
9ea28adb 8717 (lambda (elt)
8718 (cond ((and (string-match regexp (car elt))
8719 (or (eq ord 1) (match-end 2)))
8720 (setq head (substring (car elt) 0 (match-end 1))
8f95267c 8721 tail (if (match-end 2) (substring (car elt)
9ea28adb 8722 (match-end 2)))
8723 recurse t)
8724 (if (setq cons1 (assoc head writeto)) nil
8725 ;; Need to init new head
8726 (setcdr writeto (cons (list head (list "Packages: ")
8727 (list "Methods: "))
8728 (cdr writeto)))
8729 (setq cons1 (nth 1 writeto)))
8730 (setq cons2 (nth ord cons1)) ; Either packs or meths
8731 (setcdr cons2 (cons elt (cdr cons2))))
8732 ((eq ord 2)
8733 (setq root-functions (cons elt root-functions)))
8734 (t
8735 (setq root-packages (cons elt root-packages))))))))
8736 (setcdr to l1) ; Init to dynamic space
8737 (setq writeto to)
8738 (setq ord 1)
8739 (mapcar move-deeper packages)
8740 (setq ord 2)
8741 (mapcar move-deeper methods)
8742 (if recurse
8743 (mapcar (function (lambda (elt)
8744 (cperl-tags-treeify elt (1+ level))))
8745 (cdr to)))
05bbd9c3
IZ
8746 ;;Now clean up leaders with one child only
8747 (mapcar (function (lambda (elt)
8f95267c 8748 (if (not (and (listp (cdr elt))
05bbd9c3
IZ
8749 (eq (length elt) 2))) nil
8750 (setcar elt (car (nth 1 elt)))
8751 (setcdr elt (cdr (nth 1 elt))))))
8752 (cdr to))
8753 ;; Sort the roots of subtrees
8754 (if (default-value 'imenu-sort-function)
8755 (setcdr to
8756 (sort (cdr to) (default-value 'imenu-sort-function))))
9ea28adb 8757 ;; Now add back functions removed from display
8758 (mapcar (function (lambda (elt)
8759 (setcdr to (cons elt (cdr to)))))
05bbd9c3
IZ
8760 (if (default-value 'imenu-sort-function)
8761 (nreverse
8762 (sort root-functions (default-value 'imenu-sort-function)))
8763 root-functions))
9ea28adb 8764 ;; Now add back packages removed from display
8765 (mapcar (function (lambda (elt)
8f95267c
RGS
8766 (setcdr to (cons (cons (concat "package " (car elt))
8767 (cdr elt))
9ea28adb 8768 (cdr to)))))
05bbd9c3 8769 (if (default-value 'imenu-sort-function)
8cfd7987 8770 (nreverse
05bbd9c3 8771 (sort root-packages (default-value 'imenu-sort-function)))
8cfd7987 8772 root-packages))))
9ea28adb 8773
8774;;;(x-popup-menu t
8cfd7987 8775;;; '(keymap "Name1"
9ea28adb 8776;;; ("Ret1" "aa")
8cfd7987
JH
8777;;; ("Head1" "ab"
8778;;; keymap "Name2"
9ea28adb 8779;;; ("Tail1" "x") ("Tail2" "y"))))
8780
8781(defun cperl-list-fold (list name limit)
8782 (let (list1 list2 elt1 (num 0))
8783 (if (<= (length list) limit) list
8784 (setq list1 nil list2 nil)
8785 (while list
8cfd7987 8786 (setq num (1+ num)
9ea28adb 8787 elt1 (car list)
8788 list (cdr list))
8789 (if (<= num imenu-max-items)
8790 (setq list2 (cons elt1 list2))
8791 (setq list1 (cons (cons name
8792 (nreverse list2))
8793 list1)
8794 list2 (list elt1)
8795 num 1)))
8796 (nreverse (cons (cons name
8797 (nreverse list2))
8798 list1)))))
8799
8800(defun cperl-menu-to-keymap (menu &optional name)
8801 (let (list)
8cfd7987
JH
8802 (cons 'keymap
8803 (mapcar
8804 (function
9ea28adb 8805 (lambda (elt)
8806 (cond ((listp (cdr elt))
8807 (setq list (cperl-list-fold
8808 (cdr elt) (car elt) imenu-max-items))
8809 (cons nil
8810 (cons (car elt)
8811 (cperl-menu-to-keymap list))))
8812 (t
ebcd4dbc 8813 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
9ea28adb 8814 (cperl-list-fold menu "Root" imenu-max-items)))))
499d5216
IZ
8815
8816\f
8817(defvar cperl-bad-style-regexp
8818 (mapconcat 'identity
8cfd7987 8819 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
8f95267c 8820 "[-<>=+^&|]+[^- \t\n=+<>~]") ; sign+ char
8cfd7987 8821 "\\|")
499d5216
IZ
8822 "Finds places such that insertion of a whitespace may help a lot.")
8823
8cfd7987 8824(defvar cperl-not-bad-style-regexp
8f95267c 8825 (mapconcat
8cfd7987 8826 'identity
499d5216 8827 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
ebcd4dbc
IZ
8828 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
8829 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
8f95267c 8830 "<\\$?\\sw+\\(\\.\\(\\sw\\|_\\)+\\)?>" ; <IN> <stdin.h>
20675f5d 8831 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
499d5216
IZ
8832 "-[0-9]" ; -5
8833 "\\+\\+" ; ++var
8834 "--" ; --var
8835 ".->" ; a->b
8836 "->" ; a SPACE ->b
8837 "\\[-" ; a[-1]
20675f5d 8838 "\\\\[&$@*\\\\]" ; \&func
499d5216 8839 "^=" ; =head
20675f5d
IZ
8840 "\\$." ; $|
8841 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
499d5216
IZ
8842 "||"
8843 "&&"
8844 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
8cfd7987 8845 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
499d5216
IZ
8846 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
8847 ;;"[*/+-|&<.]+="
8848 )
8849 "\\|")
8850 "If matches at the start of match found by `my-bad-c-style-regexp',
8851insertion of a whitespace will not help.")
8852
8853(defvar found-bad)
8854
8855(defun cperl-find-bad-style ()
8856 "Find places in the buffer where insertion of a whitespace may help.
8857Prompts user for insertion of spaces.
8858Currently it is tuned to C and Perl syntax."
8859 (interactive)
8860 (let (found-bad (p (point)))
8861 (setq last-nonmenu-event 13) ; To disable popup
8f95267c 8862 (goto-char (point-min))
499d5216 8863 (map-y-or-n-p "Insert space here? "
8cfd7987 8864 (lambda (arg) (insert " "))
499d5216 8865 'cperl-next-bad-style
8cfd7987 8866 '("location" "locations" "insert a space into")
499d5216
IZ
8867 '((?\C-r (lambda (arg)
8868 (let ((buffer-quit-function
8869 'exit-recursive-edit))
8870 (message "Exit with Esc Esc")
8871 (recursive-edit)
8872 t)) ; Consider acted upon
8cfd7987 8873 "edit, exit with Esc Esc")
499d5216
IZ
8874 (?e (lambda (arg)
8875 (let ((buffer-quit-function
8876 'exit-recursive-edit))
8877 (message "Exit with Esc Esc")
8878 (recursive-edit)
8879 t)) ; Consider acted upon
8880 "edit, exit with Esc Esc"))
8881 t)
8882 (if found-bad (goto-char found-bad)
8883 (goto-char p)
8884 (message "No appropriate place found"))))
8885
8886(defun cperl-next-bad-style ()
8887 (let (p (not-found t) (point (point)) found)
8888 (while (and not-found
8889 (re-search-forward cperl-bad-style-regexp nil 'to-end))
8890 (setq p (point))
8891 (goto-char (match-beginning 0))
8892 (if (or
8893 (looking-at cperl-not-bad-style-regexp)
8894 ;; Check for a < -b and friends
8895 (and (eq (following-char) ?\-)
8896 (save-excursion
8897 (skip-chars-backward " \t\n")
8cfd7987 8898 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
499d5216
IZ
8899 ;; Now check for syntax type
8900 (save-match-data
8901 (setq found (point))
8902 (beginning-of-defun)
8903 (let ((pps (parse-partial-sexp (point) found)))
8904 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
8905 (goto-char (match-end 0))
8906 (goto-char (1- p))
8907 (setq not-found nil
8908 found-bad found)))
8909 (not not-found)))
8910
8cfd7987 8911\f
55497cff 8912;;; Getting help
8cfd7987 8913(defvar cperl-have-help-regexp
55497cff 8914 ;;(concat "\\("
8915 (mapconcat
8916 'identity
8cfd7987 8917 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
55497cff 8918 "[$@]\\^[a-zA-Z]" ; Special variable
8919 "[$@][^ \n\t]" ; Special variable
8920 "-[a-zA-Z]" ; File test
8921 "\\\\[a-zA-Z0]" ; Special chars
8cfd7987 8922 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
55497cff 8923 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
8924 "[a-zA-Z_0-9:]+" ; symbol or number
8925 "x="
8cfd7987 8926 "#!")
55497cff 8927 ;;"\\)\\|\\("
8cfd7987
JH
8928 "\\|")
8929 ;;"\\)"
8930 ;;)
55497cff 8931 "Matches places in the buffer we can find help for.")
8932
8933(defvar cperl-message-on-help-error t)
5f05dabc 8934(defvar cperl-help-from-timer nil)
8935
8936(defun cperl-word-at-point-hard ()
8937 ;; Does not save-excursion
8938 ;; Get to the something meaningful
8939 (or (eobp) (eolp) (forward-char 1))
8cfd7987 8940 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
5f05dabc 8941 (save-excursion (beginning-of-line) (point))
8942 'to-beg)
8943 ;; (cond
8944 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
8945 ;; (skip-chars-backward " \n\t\r({[]});,")
8946 ;; (or (bobp) (backward-char 1))))
8947 ;; Try to backtrace
8948 (cond
8949 ((looking-at "[a-zA-Z0-9_:]") ; symbol
ebcd4dbc 8950 (skip-chars-backward "a-zA-Z0-9_:")
8cfd7987 8951 (cond
5f05dabc 8952 ((and (eq (preceding-char) ?^) ; $^I
8953 (eq (char-after (- (point) 2)) ?\$))
8954 (forward-char -2))
8955 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
8956 (forward-char -1))
8957 ((and (eq (preceding-char) ?\=)
8958 (eq (current-column) 1))
8959 (forward-char -1))) ; =head1
8960 (if (and (eq (preceding-char) ?\<)
8961 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
8962 (forward-char -1)))
8963 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
8964 (forward-char -1))
8965 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
8966 (forward-char -1))
8967 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
ebcd4dbc 8968 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
5f05dabc 8969 (cond
8970 ((and (eq (preceding-char) ?\$)
8971 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
8972 (forward-char -1))
8973 ((and (eq (following-char) ?\>)
8974 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
8975 (save-excursion
8976 (forward-sexp -1)
8977 (and (eq (preceding-char) ?\<)
8978 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
8979 (search-backward "<"))))
8980 ((and (eq (following-char) ?\$)
8981 (eq (preceding-char) ?\<)
8982 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
8983 (forward-char -1)))
8984 (if (looking-at cperl-have-help-regexp)
8985 (buffer-substring (match-beginning 0) (match-end 0))))
55497cff 8986
8987(defun cperl-get-help ()
8988 "Get one-line docs on the symbol at the point.
8989The data for these docs is a little bit obsolete and may be in fact longer
6c72d195 8990than a line. Your contribution to update/shorten it is appreciated."
55497cff 8991 (interactive)
ebcd4dbc
IZ
8992 (save-match-data ; May be called "inside" query-replace
8993 (save-excursion
8994 (let ((word (cperl-word-at-point-hard)))
8995 (if word
8996 (if (and cperl-help-from-timer ; Bail out if not in mainland
8997 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
8998 (or (memq (get-text-property (point) 'face)
8999 '(font-lock-comment-face font-lock-string-face))
9000 (memq (get-text-property (point) 'syntax-type)
9001 '(pod here-doc format))))
9002 nil
9003 (cperl-describe-perl-symbol word))
9004 (if cperl-message-on-help-error
8cfd7987 9005 (message "Nothing found for %s..."
ebcd4dbc 9006 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
55497cff 9007
9008;;; Stolen from perl-descr.el by Johan Vromans:
9009
9010(defvar cperl-doc-buffer " *perl-doc*"
9011 "Where the documentation can be found.")
9012
9013(defun cperl-describe-perl-symbol (val)
9014 "Display the documentation of symbol at point, a Perl operator."
5f05dabc 9015 (let ((enable-recursive-minibuffers t)
55497cff 9016 args-file regexp)
55497cff 9017 (cond
8cfd7987
JH
9018 ((string-match "^[&*][a-zA-Z_]" val)
9019 (setq val (concat (substring val 0 1) "NAME")))
9020 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
9021 (setq val (concat "@" (substring val 1 (match-end 1)))))
9022 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
9023 (setq val (concat "%" (substring val 1 (match-end 1)))))
9024 ((and (string= val "x") (string-match "^x=" val))
9025 (setq val "x="))
9026 ((string-match "^\\$[\C-a-\C-z]" val)
9027 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
9028 ((string-match "^CORE::" val)
9029 (setq val "CORE::"))
9030 ((string-match "^SUPER::" val)
9031 (setq val "SUPER::"))
9032 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
9033 (setq val "<NAME>")))
9034 (setq regexp (concat "^"
5f05dabc 9035 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
8cfd7987 9036 (regexp-quote val)
55497cff 9037 "\\([ \t([/]\\|$\\)"))
9038
9039 ;; get the buffer with the documentation text
9040 (cperl-switch-to-doc-buffer)
9041
9042 ;; lookup in the doc
9043 (goto-char (point-min))
9044 (let ((case-fold-search nil))
8cfd7987 9045 (list
55497cff 9046 (if (re-search-forward regexp (point-max) t)
9047 (save-excursion
9048 (beginning-of-line 1)
9049 (let ((lnstart (point)))
9050 (end-of-line)
9051 (message "%s" (buffer-substring lnstart (point)))))
9052 (if cperl-message-on-help-error
9053 (message "No definition for %s" val)))))))
9054
8cfd7987 9055(defvar cperl-short-docs 'please-ignore-this-line
5f05dabc 9056 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
55497cff 9057 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
8cfd7987
JH
9058... Range (list context); flip/flop [no flop when flip] (scalar context).
9059! ... Logical negation.
5f05dabc 9060... != ... Numeric inequality.
9061... !~ ... Search pattern, substitution, or translation (negated).
6c72d195 9062$! In numeric context: errno. In a string context: error string.
55497cff 9063$\" The separator which joins elements of arrays interpolated in strings.
8cfd7987 9064$# The output format for printed numbers. Default is %.15g or close.
6c72d195 9065$$ Process number of this script. Changes in the fork()ed child process.
55497cff 9066$% The current page number of the currently selected output channel.
9067
9068 The following variables are always local to the current block:
9069
9070$1 Match of the 1st set of parentheses in the last match (auto-local).
9071$2 Match of the 2nd set of parentheses in the last match (auto-local).
9072$3 Match of the 3rd set of parentheses in the last match (auto-local).
9073$4 Match of the 4th set of parentheses in the last match (auto-local).
9074$5 Match of the 5th set of parentheses in the last match (auto-local).
9075$6 Match of the 6th set of parentheses in the last match (auto-local).
9076$7 Match of the 7th set of parentheses in the last match (auto-local).
9077$8 Match of the 8th set of parentheses in the last match (auto-local).
9078$9 Match of the 9th set of parentheses in the last match (auto-local).
9079$& The string matched by the last pattern match (auto-local).
9080$' The string after what was matched by the last match (auto-local).
9081$` The string before what was matched by the last match (auto-local).
9082
9083$( The real gid of this process.
9084$) The effective gid of this process.
9085$* Deprecated: Set to 1 to do multiline matching within a string.
9086$+ The last bracket matched by the last search pattern.
9087$, The output field separator for the print operator.
9088$- The number of lines left on the page.
9089$. The current input line number of the last filehandle that was read.
9090$/ The input record separator, newline by default.
8cfd7987 9091$0 Name of the file containing the current perl script (read/write).
5f05dabc 9092$: String may be broken after these characters to fill ^-lines in a format.
6c72d195 9093$; Subscript separator for multi-dim array emulation. Default \"\\034\".
55497cff 9094$< The real uid of this process.
6c72d195 9095$= The page length of the current output channel. Default is 60 lines.
55497cff 9096$> The effective uid of this process.
9097$? The status returned by the last ``, pipe close or `system'.
9098$@ The perl error message from the last eval or do @var{EXPR} command.
9099$ARGV The name of the current file used with <> .
9100$[ Deprecated: The index of the first element/char in an array/string.
9101$\\ The output record separator for the print operator.
9102$] The perl version string as displayed with perl -v.
9103$^ The name of the current top-of-page format.
9104$^A The current value of the write() accumulator for format() lines.
9105$^D The value of the perl debug (-D) flags.
9106$^E Information about the last system error other than that provided by $!.
9107$^F The highest system file descriptor, ordinarily 2.
9108$^H The current set of syntax checks enabled by `use strict'.
9109$^I The value of the in-place edit extension (perl -i option).
6c72d195 9110$^L What formats output to perform a formfeed. Default is \f.
20675f5d 9111$^M A buffer for emergency memory allocation when running out of memory.
55497cff 9112$^O The operating system name under which this copy of Perl was built.
9113$^P Internal debugging flag.
6c72d195 9114$^T The time the script was started. Used by -A/-M/-C file tests.
55497cff 9115$^W True if warnings are requested (perl -w flag).
9116$^X The name under which perl was invoked (argv[0] in C-speech).
9117$_ The default input and pattern-searching space.
8cfd7987 9118$| Auto-flush after write/print on current output channel? Default 0.
55497cff 9119$~ The name of the current report format.
5f05dabc 9120... % ... Modulo division.
9121... %= ... Modulo division assignment.
55497cff 9122%ENV Contains the current environment.
9123%INC List of files that have been require-d or do-ne.
9124%SIG Used to set signal handlers for various signals.
5f05dabc 9125... & ... Bitwise and.
9126... && ... Logical and.
9127... &&= ... Logical and assignment.
9128... &= ... Bitwise and assignment.
9129... * ... Multiplication.
9130... ** ... Exponentiation.
6c72d195
IZ
9131*NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
9132&NAME(arg0, ...) Subroutine call. Arguments go to @_.
5f05dabc 9133... + ... Addition. +EXPR Makes EXPR into scalar context.
9134++ Auto-increment (magical on strings). ++EXPR EXPR++
9135... += ... Addition assignment.
55497cff 9136, Comma operator.
5f05dabc 9137... - ... Subtraction.
9138-- Auto-decrement (NOT magical on strings). --EXPR EXPR--
9139... -= ... Subtraction assignment.
55497cff 9140-A Access time in days since script started.
9141-B File is a non-text (binary) file.
9142-C Inode change time in days since script started.
9143-M Age in days since script started.
9144-O File is owned by real uid.
9145-R File is readable by real uid.
9146-S File is a socket .
9147-T File is a text file.
9148-W File is writable by real uid.
9149-X File is executable by real uid.
9150-b File is a block special file.
9151-c File is a character special file.
9152-d File is a directory.
9153-e File exists .
9154-f File is a plain file.
9155-g File has setgid bit set.
9156-k File has sticky bit set.
9157-l File is a symbolic link.
9158-o File is owned by effective uid.
9159-p File is a named pipe (FIFO).
9160-r File is readable by effective uid.
9161-s File has non-zero size.
9162-t Tests if filehandle (STDIN by default) is opened to a tty.
9163-u File has setuid bit set.
9164-w File is writable by effective uid.
9165-x File is executable by effective uid.
9166-z File has zero size.
9167. Concatenate strings.
8cfd7987 9168.. Range (list context); flip/flop (scalar context) operator.
55497cff 9169.= Concatenate assignment strings
5f05dabc 9170... / ... Division. /PATTERN/ioxsmg Pattern match
9171... /= ... Division assignment.
55497cff 9172/PATTERN/ioxsmg Pattern match.
8cfd7987 9173... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6c72d195
IZ
9174<NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
9175<pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
55497cff 9176<> Reads line from union of files in @ARGV (= command line) and STDIN.
5f05dabc 9177... << ... Bitwise shift left. << start of HERE-DOCUMENT.
9178... <= ... Numeric less than or equal to.
9179... <=> ... Numeric compare.
9180... = ... Assignment.
9181... == ... Numeric equality.
9182... =~ ... Search pattern, substitution, or translation
9183... > ... Numeric greater than.
9184... >= ... Numeric greater than or equal to.
9185... >> ... Bitwise shift right.
9186... >>= ... Bitwise shift right assignment.
9187... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
9188?PATTERN? One-time pattern match.
55497cff 9189@ARGV Command line arguments (not including the command name - see $0).
9190@INC List of places to look for perl scripts during do/include/use.
8cfd7987 9191@_ Parameter array for subroutines; result of split() unless in list context.
ebcd4dbc 9192\\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
55497cff 9193\\0 Octal char, e.g. \\033.
6c72d195 9194\\E Case modification terminator. See \\Q, \\L, and \\U.
8f95267c
RGS
9195\\L Lowercase until \\E . See also \\l, lc.
9196\\U Upcase until \\E . See also \\u, uc.
6c72d195 9197\\Q Quote metacharacters until \\E . See also quotemeta.
55497cff 9198\\a Alarm character (octal 007).
9199\\b Backspace character (octal 010).
9200\\c Control character, e.g. \\c[ .
9201\\e Escape character (octal 033).
9202\\f Formfeed character (octal 014).
6c72d195 9203\\l Lowercase the next character. See also \\L and \\u, lcfirst.
ebcd4dbc
IZ
9204\\n Newline character (octal 012 on most systems).
9205\\r Return character (octal 015 on most systems).
55497cff 9206\\t Tab character (octal 011).
6c72d195 9207\\u Upcase the next character. See also \\U and \\l, ucfirst.
55497cff 9208\\x Hex character, e.g. \\x1b.
ebcd4dbc 9209... ^ ... Bitwise exclusive or.
5f05dabc 9210__END__ Ends program source.
9211__DATA__ Ends program source.
55497cff 9212__FILE__ Current (source) filename.
9213__LINE__ Current line in current source.
ebcd4dbc 9214__PACKAGE__ Current package.
6c72d195 9215ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
55497cff 9216ARGVOUT Output filehandle with -i flag.
5f05dabc 9217BEGIN { ... } Immediately executed (during compilation) piece of code.
9218END { ... } Pseudo-subroutine executed after the script finishes.
7bcea553
IZ
9219CHECK { ... } Pseudo-subroutine executed after the script is compiled.
9220INIT { ... } Pseudo-subroutine executed before the script starts running.
55497cff 9221DATA Input filehandle for what follows after __END__ or __DATA__.
9222accept(NEWSOCKET,GENERICSOCKET)
9223alarm(SECONDS)
9224atan2(X,Y)
9225bind(SOCKET,NAME)
9226binmode(FILEHANDLE)
9227caller[(LEVEL)]
9228chdir(EXPR)
9229chmod(LIST)
9230chop[(LIST|VAR)]
9231chown(LIST)
9232chroot(FILENAME)
9233close(FILEHANDLE)
9234closedir(DIRHANDLE)
5f05dabc 9235... cmp ... String compare.
55497cff 9236connect(SOCKET,NAME)
6c72d195 9237continue of { block } continue { block }. Is executed after `next' or at end.
55497cff 9238cos(EXPR)
9239crypt(PLAINTEXT,SALT)
5f05dabc 9240dbmclose(%HASH)
9241dbmopen(%HASH,DBNAME,MODE)
55497cff 9242defined(EXPR)
5f05dabc 9243delete($HASH{KEY})
55497cff 9244die(LIST)
9245do { ... }|SUBR while|until EXPR executes at least once
ebcd4dbc 9246do(EXPR|SUBR([LIST])) (with while|until executes at least once)
55497cff 9247dump LABEL
5f05dabc 9248each(%HASH)
55497cff 9249endgrent
9250endhostent
9251endnetent
9252endprotoent
9253endpwent
9254endservent
9255eof[([FILEHANDLE])]
5f05dabc 9256... eq ... String equality.
55497cff 9257eval(EXPR) or eval { BLOCK }
8f95267c 9258exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
55497cff 9259exit(EXPR)
9260exp(EXPR)
9261fcntl(FILEHANDLE,FUNCTION,SCALAR)
9262fileno(FILEHANDLE)
9263flock(FILEHANDLE,OPERATION)
9264for (EXPR;EXPR;EXPR) { ... }
9265foreach [VAR] (@ARRAY) { ... }
9266fork
5f05dabc 9267... ge ... String greater than or equal.
55497cff 9268getc[(FILEHANDLE)]
9269getgrent
9270getgrgid(GID)
9271getgrnam(NAME)
9272gethostbyaddr(ADDR,ADDRTYPE)
9273gethostbyname(NAME)
9274gethostent
9275getlogin
9276getnetbyaddr(ADDR,ADDRTYPE)
9277getnetbyname(NAME)
9278getnetent
9279getpeername(SOCKET)
9280getpgrp(PID)
9281getppid
9282getpriority(WHICH,WHO)
9283getprotobyname(NAME)
9284getprotobynumber(NUMBER)
9285getprotoent
9286getpwent
9287getpwnam(NAME)
9288getpwuid(UID)
9289getservbyname(NAME,PROTO)
9290getservbyport(PORT,PROTO)
9291getservent
9292getsockname(SOCKET)
9293getsockopt(SOCKET,LEVEL,OPTNAME)
9294gmtime(EXPR)
9295goto LABEL
5f05dabc 9296... gt ... String greater than.
55497cff 9297hex(EXPR)
9298if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
9299index(STR,SUBSTR[,OFFSET])
9300int(EXPR)
9301ioctl(FILEHANDLE,FUNCTION,SCALAR)
9302join(EXPR,LIST)
5f05dabc 9303keys(%HASH)
55497cff 9304kill(LIST)
9305last [LABEL]
5f05dabc 9306... le ... String less than or equal.
55497cff 9307length(EXPR)
9308link(OLDFILE,NEWFILE)
9309listen(SOCKET,QUEUESIZE)
9310local(LIST)
9311localtime(EXPR)
9312log(EXPR)
9313lstat(EXPR|FILEHANDLE|VAR)
5f05dabc 9314... lt ... String less than.
55497cff 9315m/PATTERN/iogsmx
9316mkdir(FILENAME,MODE)
9317msgctl(ID,CMD,ARG)
9318msgget(KEY,FLAGS)
9319msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
9320msgsnd(ID,MSG,FLAGS)
9321my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
7bcea553 9322our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
5f05dabc 9323... ne ... String inequality.
55497cff 9324next [LABEL]
9325oct(EXPR)
9326open(FILEHANDLE[,EXPR])
9327opendir(DIRHANDLE,EXPR)
ebcd4dbc 9328ord(EXPR) ASCII value of the first char of the string.
55497cff 9329pack(TEMPLATE,LIST)
5f05dabc 9330package NAME Introduces package context.
ebcd4dbc 9331pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
55497cff 9332pop(ARRAY)
9333print [FILEHANDLE] [(LIST)]
9334printf [FILEHANDLE] (FORMAT,LIST)
9335push(ARRAY,LIST)
9336q/STRING/ Synonym for 'STRING'
9337qq/STRING/ Synonym for \"STRING\"
9338qx/STRING/ Synonym for `STRING`
9339rand[(EXPR)]
9340read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
9341readdir(DIRHANDLE)
9342readlink(EXPR)
9343recv(SOCKET,SCALAR,LEN,FLAGS)
9344redo [LABEL]
9345rename(OLDNAME,NEWNAME)
9346require [FILENAME | PERL_VERSION]
9347reset[(EXPR)]
9348return(LIST)
9349reverse(LIST)
9350rewinddir(DIRHANDLE)
9351rindex(STR,SUBSTR[,OFFSET])
9352rmdir(FILENAME)
9353s/PATTERN/REPLACEMENT/gieoxsm
9354scalar(EXPR)
9355seek(FILEHANDLE,POSITION,WHENCE)
9356seekdir(DIRHANDLE,POS)
9357select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
9358semctl(ID,SEMNUM,CMD,ARG)
9359semget(KEY,NSEMS,SIZE,FLAGS)
9360semop(KEY,...)
9361send(SOCKET,MSG,FLAGS[,TO])
9362setgrent
9363sethostent(STAYOPEN)
9364setnetent(STAYOPEN)
9365setpgrp(PID,PGRP)
9366setpriority(WHICH,WHO,PRIORITY)
9367setprotoent(STAYOPEN)
9368setpwent
9369setservent(STAYOPEN)
9370setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
9371shift[(ARRAY)]
9372shmctl(ID,CMD,ARG)
9373shmget(KEY,SIZE,FLAGS)
9374shmread(ID,VAR,POS,SIZE)
9375shmwrite(ID,STRING,POS,SIZE)
9376shutdown(SOCKET,HOW)
9377sin(EXPR)
9378sleep[(EXPR)]
9379socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
9380socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
9381sort [SUBROUTINE] (LIST)
9382splice(ARRAY,OFFSET[,LENGTH[,LIST]])
9383split[(/PATTERN/[,EXPR[,LIMIT]])]
9384sprintf(FORMAT,LIST)
9385sqrt(EXPR)
9386srand(EXPR)
9387stat(EXPR|FILEHANDLE|VAR)
9388study[(SCALAR)]
5f05dabc 9389sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
55497cff 9390substr(EXPR,OFFSET[,LEN])
9391symlink(OLDFILE,NEWFILE)
9392syscall(LIST)
9393sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
8f95267c 9394system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
55497cff 9395syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
9396tell[(FILEHANDLE)]
9397telldir(DIRHANDLE)
9398time
9399times
9400tr/SEARCHLIST/REPLACEMENTLIST/cds
9401truncate(FILE|EXPR,LENGTH)
9402umask[(EXPR)]
9403undef[(EXPR)]
9404unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
9405unlink(LIST)
9406unpack(TEMPLATE,EXPR)
9407unshift(ARRAY,LIST)
5f05dabc 9408until (EXPR) { ... } EXPR until EXPR
55497cff 9409utime(LIST)
5f05dabc 9410values(%HASH)
55497cff 9411vec(EXPR,OFFSET,BITS)
9412wait
9413waitpid(PID,FLAGS)
ebcd4dbc 9414wantarray Returns true if the sub/eval is called in list context.
55497cff 9415warn(LIST)
5f05dabc 9416while (EXPR) { ... } EXPR while EXPR
55497cff 9417write[(EXPR|FILEHANDLE)]
5f05dabc 9418... x ... Repeat string or array.
9419x= ... Repetition assignment.
55497cff 9420y/SEARCHLIST/REPLACEMENTLIST/
5f05dabc 9421... | ... Bitwise or.
9422... || ... Logical or.
9423~ ... Unary bitwise complement.
6c72d195 9424#! OS interpreter indicator. If contains `perl', used for options, and -x.
5f05dabc 9425AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
9426CORE:: Prefix to access builtin function if imported sub obscures it.
9427SUPER:: Prefix to lookup for a method in @ISA classes.
9428DESTROY Shorthand for `sub DESTROY {...}'.
9429... EQ ... Obsolete synonym of `eq'.
9430... GE ... Obsolete synonym of `ge'.
9431... GT ... Obsolete synonym of `gt'.
9432... LE ... Obsolete synonym of `le'.
9433... LT ... Obsolete synonym of `lt'.
9434... NE ... Obsolete synonym of `ne'.
9435abs [ EXPR ] absolute value
9436... and ... Low-precedence synonym for &&.
9437bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6c72d195 9438chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
ebcd4dbc 9439chr Converts a number to char with the same ordinal.
5f05dabc 9440else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
9441elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
8cfd7987 9442exists $HASH{KEY} True if the key exists.
6c72d195 9443format [NAME] = Start of output format. Ended by a single dot (.) on a line.
ebcd4dbc 9444formline PICTURE, LIST Backdoor into \"format\" processing.
5f05dabc 9445glob EXPR Synonym of <EXPR>.
9446lc [ EXPR ] Returns lowercased EXPR.
9447lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
6c72d195 9448grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
ebcd4dbc 9449map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6c72d195 9450no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
ebcd4dbc 9451not ... Low-precedence synonym for ! - negation.
5f05dabc 9452... or ... Low-precedence synonym for ||.
9453pos STRING Set/Get end-position of the last match over this string, see \\G.
ebcd4dbc
IZ
9454quotemeta [ EXPR ] Quote regexp metacharacters.
9455qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
5f05dabc 9456readline FH Synonym of <FH>.
9457readpipe CMD Synonym of `CMD`.
9458ref [ EXPR ] Type of EXPR when dereferenced.
ebcd4dbc
IZ
9459sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
9460tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
9461tied Returns internal object for a tied data.
5f05dabc 9462uc [ EXPR ] Returns upcased EXPR.
9463ucfirst [ EXPR ] Returns EXPR with upcased first letter.
ebcd4dbc 9464untie VAR Unlink an object from a simple Perl variable.
5f05dabc 9465use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
9466... xor ... Low-precedence synonym for exclusive or.
9467prototype \&SUB Returns prototype of the function given a reference.
9468=head1 Top-level heading.
9469=head2 Second-level heading.
9470=head3 Third-level heading (is there such?).
9471=over [ NUMBER ] Start list.
9472=item [ TITLE ] Start new item in the list.
9473=back End list.
9474=cut Switch from POD to Perl.
9475=pod Switch from Perl to POD.
55497cff 9476")
9477
9478(defun cperl-switch-to-doc-buffer ()
9479 "Go to the perl documentation buffer and insert the documentation."
9480 (interactive)
9481 (let ((buf (get-buffer-create cperl-doc-buffer)))
9482 (if (interactive-p)
9483 (switch-to-buffer-other-window buf)
9484 (set-buffer buf))
9485 (if (= (buffer-size) 0)
9486 (progn
9487 (insert (documentation-property 'cperl-short-docs
9488 'variable-documentation))
9489 (setq buffer-read-only t)))))
9490
7bcea553 9491(defun cperl-beautify-regexp-piece (b e embed level)
ebcd4dbc
IZ
9492 ;; b is before the starting delimiter, e before the ending
9493 ;; e should be a marker, may be changed, but remains "correct".
7bcea553 9494 ;; EMBED is nil iff we process the whole REx.
8f95267c 9495 ;; The REx is guaranteed to have //x
7bcea553
IZ
9496 ;; LEVEL shows how many levels deep to go
9497 ;; position at enter and at leave is not defined
9498 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
ebcd4dbc
IZ
9499 (if (not embed)
9500 (goto-char (1+ b))
9501 (goto-char b)
7bcea553 9502 (cond ((looking-at "(\\?\\\\#") ; (?#) wrongly commented when //x-ing
ebcd4dbc
IZ
9503 (forward-char 2)
9504 (delete-char 1)
9505 (forward-char 1))
9506 ((looking-at "(\\?[^a-zA-Z]")
9507 (forward-char 3))
9508 ((looking-at "(\\?") ; (?i)
9509 (forward-char 2))
9510 (t
9511 (forward-char 1))))
05bbd9c3 9512 (setq c (if embed (current-indentation) (1- (current-column)))
ebcd4dbc
IZ
9513 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
9514 (or (looking-at "[ \t]*[\n#]")
9515 (progn
9516 (insert "\n")))
9517 (goto-char e)
9518 (beginning-of-line)
9519 (if (re-search-forward "[^ \t]" e t)
8cfd7987 9520 (progn ; Something before the ending delimiter
ebcd4dbc 9521 (goto-char e)
7bcea553 9522 (delete-horizontal-space)
ebcd4dbc 9523 (insert "\n")
8f95267c 9524 (cperl-make-indent c)
ebcd4dbc
IZ
9525 (set-marker e (point))))
9526 (goto-char b)
9527 (end-of-line 2)
9528 (while (< (point) (marker-position e))
9529 (beginning-of-line)
9530 (setq s (point)
9531 inline t)
9532 (skip-chars-forward " \t")
9533 (delete-region s (point))
8f95267c 9534 (cperl-make-indent c1)
ebcd4dbc
IZ
9535 (while (and
9536 inline
8cfd7987 9537 (looking-at
05bbd9c3
IZ
9538 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
9539 "\\|" ; Embedded variable
ebcd4dbc 9540 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
05bbd9c3 9541 "\\|" ; $ ^
ebcd4dbc 9542 "[$^]"
05bbd9c3 9543 "\\|" ; simple-code simple-code*?
ebcd4dbc 9544 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
05bbd9c3 9545 "\\|" ; Class
ebcd4dbc 9546 "\\(\\[\\)" ; 6
05bbd9c3 9547 "\\|" ; Grouping
ebcd4dbc 9548 "\\((\\(\\?\\)?\\)" ; 7 8
05bbd9c3 9549 "\\|" ; |
8cfd7987 9550 "\\(|\\)"))) ; 9
ebcd4dbc
IZ
9551 (goto-char (match-end 0))
9552 (setq spaces t)
9553 (cond ((match-beginning 1) ; Alphanum word + junk
9554 (forward-char -1))
9555 ((or (match-beginning 3) ; $ab[12]
9556 (and (match-beginning 5) ; X* X+ X{2,3}
9557 (eq (preceding-char) ?\{)))
9558 (forward-char -1)
9559 (forward-sexp 1))
8f95267c
RGS
9560 ((and ; [], already syntaxified
9561 (match-beginning 6)
9562 cperl-regexp-scan
9563 cperl-use-syntax-table-text-property)
9564 (forward-char -1)
9565 (forward-sexp 1)
9566 (or (eq (preceding-char) ?\])
9567 (error "[]-group not terminated"))
9568 (re-search-forward
9569 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
ebcd4dbc
IZ
9570 ((match-beginning 6) ; []
9571 (setq tmp (point))
9572 (if (looking-at "\\^?\\]")
9573 (goto-char (match-end 0)))
7bcea553
IZ
9574 ;; XXXX POSIX classes?!
9575 (while (and (not pos)
9576 (re-search-forward "\\[:\\|\\]" e t))
9577 (if (eq (preceding-char) ?:)
9578 (or (re-search-forward ":\\]" e t)
9579 (error "[:POSIX:]-group in []-group not terminated"))
9580 (setq pos t)))
9581 (or (eq (preceding-char) ?\])
9582 (error "[]-group not terminated"))
8f95267c
RGS
9583 (re-search-forward
9584 "\\=\\([*+?]\\|{[0-9]+\\(,[0-9]*\\)?}\\)\\??" e t))
ebcd4dbc
IZ
9585 ((match-beginning 7) ; ()
9586 (goto-char (match-beginning 0))
7bcea553
IZ
9587 (setq pos (current-column))
9588 (or (eq pos c1)
ebcd4dbc 9589 (progn
7bcea553 9590 (delete-horizontal-space)
ebcd4dbc 9591 (insert "\n")
8f95267c 9592 (cperl-make-indent c1)))
ebcd4dbc
IZ
9593 (setq tmp (point))
9594 (forward-sexp 1)
9595 ;; (or (forward-sexp 1)
9596 ;; (progn
9597 ;; (goto-char tmp)
9598 ;; (error "()-group not terminated")))
9599 (set-marker m (1- (point)))
9600 (set-marker m1 (point))
7bcea553
IZ
9601 (if (= level 1)
9602 (if (progn ; indent rigidly if multiline
8cfd7987 9603 ;; In fact does not make a lot of sense, since
7bcea553
IZ
9604 ;; the starting position can be already lost due
9605 ;; to insertion of "\n" and " "
9606 (goto-char tmp)
9607 (search-forward "\n" m1 t))
9608 (indent-rigidly (point) m1 (- c1 pos)))
9609 (setq level (1- level))
9610 (cond
9611 ((not (match-beginning 8))
9612 (cperl-beautify-regexp-piece tmp m t level))
9613 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
9614 t)
9615 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
9616 (goto-char (+ 2 tmp))
9617 (forward-sexp 1)
9618 (cperl-beautify-regexp-piece (point) m t level))
9619 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
9620 (goto-char (+ 3 tmp))
9621 (cperl-beautify-regexp-piece (point) m t level))
9622 (t
9623 (cperl-beautify-regexp-piece tmp m t level))))
ebcd4dbc
IZ
9624 (goto-char m1)
9625 (cond ((looking-at "[*+?]\\??")
9626 (goto-char (match-end 0)))
9627 ((eq (following-char) ?\{)
9628 (forward-sexp 1)
9629 (if (eq (following-char) ?\?)
9630 (forward-char))))
9631 (skip-chars-forward " \t")
9632 (setq spaces nil)
9633 (if (looking-at "[#\n]")
05bbd9c3
IZ
9634 (progn
9635 (or (eolp) (indent-for-comment))
9636 (beginning-of-line 2))
7bcea553 9637 (delete-horizontal-space)
ebcd4dbc
IZ
9638 (insert "\n"))
9639 (end-of-line)
9640 (setq inline nil))
9641 ((match-beginning 9) ; |
9642 (forward-char -1)
9643 (setq tmp (point))
9644 (beginning-of-line)
9645 (if (re-search-forward "[^ \t]" tmp t)
9646 (progn
9647 (goto-char tmp)
7bcea553 9648 (delete-horizontal-space)
ebcd4dbc
IZ
9649 (insert "\n"))
9650 ;; first at line
9651 (delete-region (point) tmp))
8f95267c 9652 (cperl-make-indent c)
ebcd4dbc
IZ
9653 (forward-char 1)
9654 (skip-chars-forward " \t")
9655 (setq spaces nil)
9656 (if (looking-at "[#\n]")
9657 (beginning-of-line 2)
7bcea553 9658 (delete-horizontal-space)
ebcd4dbc
IZ
9659 (insert "\n"))
9660 (end-of-line)
9661 (setq inline nil)))
9662 (or (looking-at "[ \t\n]")
9663 (not spaces)
9664 (insert " "))
9665 (skip-chars-forward " \t"))
8cfd7987
JH
9666 (or (looking-at "[#\n]")
9667 (error "Unknown code `%s' in a regexp"
9668 (buffer-substring (point) (1+ (point)))))
9669 (and inline (end-of-line 2)))
05bbd9c3
IZ
9670 ;; Special-case the last line of group
9671 (if (and (>= (point) (marker-position e))
9672 (/= (current-indentation) c))
9673 (progn
8cfd7987 9674 (beginning-of-line)
8f95267c 9675 (cperl-make-indent c)))))
ebcd4dbc 9676
05bbd9c3 9677(defun cperl-make-regexp-x ()
6c72d195 9678 ;; Returns position of the start
7bcea553 9679 ;; XXX this is called too often! Need to cache the result!
05bbd9c3
IZ
9680 (save-excursion
9681 (or cperl-use-syntax-table-text-property
20675f5d 9682 (error "I need to have a regexp marked!"))
05bbd9c3 9683 ;; Find the start
6c72d195
IZ
9684 (if (looking-at "\\s|")
9685 nil ; good already
20675f5d 9686 (if (looking-at "\\([smy]\\|qr\\)\\s|")
6c72d195 9687 (forward-char 1)
8cfd7987 9688 (re-search-backward "\\s|"))) ; Assume it is scanned already.
05bbd9c3
IZ
9689 ;;(forward-char 1)
9690 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
9691 (sub-p (eq (preceding-char) ?s)) s)
9692 (forward-sexp 1)
9693 (set-marker e (1- (point)))
9694 (setq delim (preceding-char))
9695 (if (and sub-p (eq delim (char-after (- (point) 2))))
9696 (error "Possible s/blah// - do not know how to deal with"))
9697 (if sub-p (forward-sexp 1))
8cfd7987 9698 (if (looking-at "\\sw*x")
05bbd9c3
IZ
9699 (setq have-x t)
9700 (insert "x"))
9701 ;; Protect fragile " ", "#"
9702 (if have-x nil
9703 (goto-char (1+ b))
9704 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
9705 (forward-char -1)
9706 (insert "\\")
9707 (forward-char 1)))
9708 b)))
9709
7bcea553 9710(defun cperl-beautify-regexp (&optional deep)
8cfd7987 9711 "Do it. (Experimental, may change semantics, recheck the result.)
ebcd4dbc 9712We suppose that the regexp is scanned already."
7bcea553 9713 (interactive "P")
8cfd7987 9714 (setq deep (if deep (prefix-numeric-value deep) -1))
7bcea553
IZ
9715 (save-excursion
9716 (goto-char (cperl-make-regexp-x))
9717 (let ((b (point)) (e (make-marker)))
9718 (forward-sexp 1)
9719 (set-marker e (1- (point)))
9720 (cperl-beautify-regexp-piece b e nil deep))))
ebcd4dbc 9721
6c72d195
IZ
9722(defun cperl-regext-to-level-start ()
9723 "Goto start of an enclosing group in regexp.
05bbd9c3
IZ
9724We suppose that the regexp is scanned already."
9725 (interactive)
6c72d195 9726 (let ((limit (cperl-make-regexp-x)) done)
05bbd9c3
IZ
9727 (while (not done)
9728 (or (eq (following-char) ?\()
6c72d195 9729 (search-backward "(" (1+ limit) t)
05bbd9c3
IZ
9730 (error "Cannot find `(' which starts a group"))
9731 (setq done
9732 (save-excursion
9733 (skip-chars-backward "\\")
9734 (looking-at "\\(\\\\\\\\\\)*(")))
6c72d195
IZ
9735 (or done (forward-char -1)))))
9736
9737(defun cperl-contract-level ()
4584684c 9738 "Find an enclosing group in regexp and contract it.
6c72d195
IZ
9739\(Experimental, may change semantics, recheck the result.)
9740We suppose that the regexp is scanned already."
9741 (interactive)
7bcea553 9742 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
8cfd7987 9743 (cperl-regext-to-level-start)
8f95267c 9744 (let ((b (point)) (e (make-marker)) c)
8cfd7987
JH
9745 (forward-sexp 1)
9746 (set-marker e (1- (point)))
9747 (goto-char b)
9748 (while (re-search-forward "\\(#\\)\\|\n" e 'to-end)
9749 (cond
9750 ((match-beginning 1) ; #-comment
9751 (or c (setq c (current-indentation)))
9752 (beginning-of-line 2) ; Skip
8f95267c 9753 (cperl-make-indent c))
8cfd7987
JH
9754 (t
9755 (delete-char -1)
9756 (just-one-space))))))
6c72d195
IZ
9757
9758(defun cperl-contract-levels ()
4584684c 9759 "Find an enclosing group in regexp and contract all the kids.
6c72d195
IZ
9760\(Experimental, may change semantics, recheck the result.)
9761We suppose that the regexp is scanned already."
9762 (interactive)
7bcea553
IZ
9763 (save-excursion
9764 (condition-case nil
9765 (cperl-regext-to-level-start)
9766 (error ; We are outside outermost group
9767 (goto-char (cperl-make-regexp-x))))
9768 (let ((b (point)) (e (make-marker)) s c)
9769 (forward-sexp 1)
9770 (set-marker e (1- (point)))
9771 (goto-char (1+ b))
9772 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
8cfd7987 9773 (cond
7bcea553
IZ
9774 ((match-beginning 1) ; Skip
9775 nil)
9776 (t ; Group
9777 (cperl-contract-level)))))))
9778
9779(defun cperl-beautify-level (&optional deep)
6c72d195
IZ
9780 "Find an enclosing group in regexp and beautify it.
9781\(Experimental, may change semantics, recheck the result.)
05bbd9c3 9782We suppose that the regexp is scanned already."
7bcea553 9783 (interactive "P")
8cfd7987 9784 (setq deep (if deep (prefix-numeric-value deep) -1))
7bcea553
IZ
9785 (save-excursion
9786 (cperl-regext-to-level-start)
9787 (let ((b (point)) (e (make-marker)))
9788 (forward-sexp 1)
9789 (set-marker e (1- (point)))
9790 (cperl-beautify-regexp-piece b e nil deep))))
6c72d195 9791
8f95267c
RGS
9792(defun cperl-invert-if-unless-modifiers ()
9793 "Change `B if A;' into `if (A) {B}' etc if possible.
9794\(Unfinished.)"
9795 (interactive) ;
9796 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
9797 (w-rex "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>"))
9798 (and (= (char-syntax (preceding-char)) ?w)
9799 (forward-sexp -1))
9800 (setq pre-if (point))
9801 (cperl-backward-to-start-of-expr)
9802 (setq pre-B (point))
9803 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
9804 (cperl-forward-to-end-of-expr)
9805 (setq post-A (point))
9806 (goto-char pre-if)
9807 (or (looking-at w-rex)
9808 ;; Find the position
9809 (progn (goto-char post-A)
9810 (while (and
9811 (not (looking-at w-rex))
9812 (> (point) pre-B))
9813 (forward-sexp -1))
9814 (setq pre-if (point))))
9815 (or (looking-at w-rex)
9816 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
9817 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
9818 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
9819 ;; First, simple part: find code boundaries
9820 (forward-sexp 1)
9821 (setq post-if (point))
9822 (forward-sexp -2)
9823 (forward-sexp 1)
9824 (setq post-B (point))
9825 (cperl-backward-to-start-of-expr)
9826 (setq pre-B (point))
9827 (setq B (buffer-substring pre-B post-B))
9828 (goto-char pre-if)
9829 (forward-sexp 2)
9830 (forward-sexp -1)
9831 ;; May be after $, @, $# etc of a variable
9832 (skip-chars-backward "$@%#")
9833 (setq pre-A (point))
9834 (cperl-forward-to-end-of-expr)
9835 (setq post-A (point))
9836 (setq A (buffer-substring pre-A post-A))
9837 ;; Now modify (from end, to not break the stuff)
9838 (skip-chars-forward " \t;")
9839 (delete-region pre-A (point)) ; we move to pre-A
9840 (insert "\n" B ";\n}")
9841 (and (looking-at "[ \t]*#") (cperl-indent-for-comment))
9842 (delete-region pre-if post-if)
9843 (delete-region pre-B post-B)
9844 (goto-char pre-B)
9845 (insert if-string " (" A ") {")
9846 (setq post-B (point))
9847 (if (looking-at "[ \t]+$")
9848 (delete-horizontal-space)
9849 (if (looking-at "[ \t]*#")
9850 (cperl-indent-for-comment)
9851 (just-one-space)))
9852 (forward-line 1)
9853 (if (looking-at "[ \t]*$")
9854 (progn ; delete line
9855 (delete-horizontal-space)
9856 (delete-region (point) (1+ (point)))))
9857 (cperl-indent-line)
9858 (goto-char (1- post-B))
9859 (forward-sexp 1)
9860 (cperl-indent-line)
9861 (goto-char pre-B)))
9862
6c72d195 9863(defun cperl-invert-if-unless ()
8f95267c
RGS
9864 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
9865If the cursor is not on the leading keyword of the BLOCK flavor of
9866construct, will assume it is the STATEMENT flavor, so will try to find
9867the appropriate statement modifier."
6c72d195 9868 (interactive)
8f95267c
RGS
9869 (and (= (char-syntax (preceding-char)) ?w)
9870 (forward-sexp -1))
7bcea553 9871 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\|for\\|foreach\\)\\>")
8f95267c
RGS
9872 (let ((pre-if (point))
9873 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
9874 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
6c72d195 9875 (forward-sexp 2)
8f95267c 9876 (setq post-A (point))
6c72d195 9877 (forward-sexp -1)
8f95267c
RGS
9878 (setq pre-A (point))
9879 (setq is-block (and (eq (following-char) ?\( )
9880 (save-excursion
9881 (condition-case nil
9882 (progn
9883 (forward-sexp 2)
9884 (forward-sexp -1)
9885 (eq (following-char) ?\{ ))
9886 (error nil)))))
9887 (if is-block
6c72d195 9888 (progn
8f95267c 9889 (goto-char post-A)
6c72d195 9890 (forward-sexp 1)
8f95267c 9891 (setq post-B (point))
6c72d195 9892 (forward-sexp -1)
8f95267c 9893 (setq pre-B (point))
6c72d195
IZ
9894 (if (and (eq (following-char) ?\{ )
9895 (progn
8f95267c 9896 (cperl-backward-to-noncomment post-A)
6c72d195
IZ
9897 (eq (preceding-char) ?\) )))
9898 (if (condition-case nil
9899 (progn
8f95267c 9900 (goto-char post-B)
6c72d195
IZ
9901 (forward-sexp 1)
9902 (forward-sexp -1)
9903 (looking-at "\\<els\\(e\\|if\\)\\>"))
9904 (error nil))
9905 (error
8f95267c
RGS
9906 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
9907 (goto-char (1- post-B))
9908 (cperl-backward-to-noncomment pre-B)
6c72d195
IZ
9909 (if (eq (preceding-char) ?\;)
9910 (forward-char -1))
8f95267c
RGS
9911 (setq end-B-code (point))
9912 (goto-char pre-B)
9913 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
6c72d195 9914 (setq p (match-beginning 0)
8f95267c
RGS
9915 A (buffer-substring p (match-end 0))
9916 state (parse-partial-sexp pre-B p))
8cfd7987 9917 (or (nth 3 state)
6c72d195
IZ
9918 (nth 4 state)
9919 (nth 5 state)
8f95267c 9920 (error "`%s' inside `%s' BLOCK" A if-string))
6c72d195
IZ
9921 (goto-char (match-end 0)))
9922 ;; Finally got it
8f95267c 9923 (goto-char (1+ pre-B))
6c72d195 9924 (skip-chars-forward " \t\n")
8f95267c
RGS
9925 (setq B (buffer-substring (point) end-B-code))
9926 (goto-char end-B-code)
6c72d195
IZ
9927 (or (looking-at ";?[ \t\n]*}")
9928 (progn
9929 (skip-chars-forward "; \t\n")
8f95267c
RGS
9930 (setq B-comment
9931 (buffer-substring (point) (1- post-B)))))
9932 (and (equal B "")
9933 (setq B "1"))
9934 (goto-char (1- post-A))
9935 (cperl-backward-to-noncomment pre-A)
6c72d195 9936 (or (looking-at "[ \t\n]*)")
8f95267c 9937 (goto-char (1- post-A)))
6c72d195 9938 (setq p (point))
8f95267c 9939 (goto-char (1+ pre-A))
6c72d195 9940 (skip-chars-forward " \t\n")
8f95267c
RGS
9941 (setq A (buffer-substring (point) p))
9942 (delete-region pre-B post-B)
9943 (delete-region pre-A post-A)
9944 (goto-char pre-if)
9945 (insert B " ")
9946 (and B-comment (insert B-comment " "))
6c72d195
IZ
9947 (just-one-space)
9948 (forward-word 1)
8f95267c
RGS
9949 (setq pre-A (point))
9950 (insert " " A ";")
7bcea553 9951 (delete-horizontal-space)
8f95267c
RGS
9952 (setq post-B (point))
9953 (if (looking-at "#")
9954 (indent-for-comment))
9955 (goto-char post-B)
6c72d195
IZ
9956 (forward-char -1)
9957 (delete-horizontal-space)
8f95267c 9958 (goto-char pre-A)
6c72d195 9959 (just-one-space)
8f95267c
RGS
9960 (goto-char pre-if)
9961 (setq pre-A (set-marker (make-marker) pre-A))
9962 (while (<= (point) (marker-position pre-A))
9963 (cperl-indent-line)
9964 (forward-line 1))
9965 (goto-char (marker-position pre-A))
9966 (if B-comment
9967 (progn
9968 (forward-line -1)
9969 (indent-for-comment)
9970 (goto-char (marker-position pre-A)))))
9971 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
9972 ;; (error "`%s' not with an (EXPR)" if-string)
9973 (forward-sexp -1)
9974 (cperl-invert-if-unless-modifiers)))
9975 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
9976 (cperl-invert-if-unless-modifiers)))
6c72d195
IZ
9977
9978;;; By Anthony Foiani <afoiani@uswest.com>
9979;;; Getting help on modules in C-h f ?
7bcea553 9980;;; This is a modified version of `man'.
6c72d195 9981;;; Need to teach it how to lookup functions
8f95267c 9982;;;###autoload
6c72d195 9983(defun cperl-perldoc (word)
7bcea553 9984 "Run `perldoc' on WORD."
6c72d195
IZ
9985 (interactive
9986 (list (let* ((default-entry (cperl-word-at-point))
9987 (input (read-string
9988 (format "perldoc entry%s: "
9989 (if (string= default-entry "")
9990 ""
9991 (format " (default %s)" default-entry))))))
9992 (if (string= input "")
9993 (if (string= default-entry "")
9994 (error "No perldoc args given")
9995 default-entry)
9996 input))))
8cfd7987
JH
9997 (require 'man)
9998 (let* ((case-fold-search nil)
9999 (is-func (and
6c72d195
IZ
10000 (string-match "^[a-z]+$" word)
10001 (string-match (concat "^" word "\\>")
10002 (documentation-property
10003 'cperl-short-docs
10004 'variable-documentation))))
10005 (manual-program (if is-func "perldoc -f" "perldoc")))
8cfd7987
JH
10006 (cond
10007 (cperl-xemacs-p
10008 (let ((Manual-program "perldoc")
10009 (Manual-switches (if is-func (list "-f"))))
10010 (manual-entry word)))
10011 (t
10012 (Man-getpage-in-background word)))))
6c72d195 10013
8f95267c 10014;;;###autoload
6c72d195 10015(defun cperl-perldoc-at-point ()
7bcea553 10016 "Run a `perldoc' on the word around point."
6c72d195
IZ
10017 (interactive)
10018 (cperl-perldoc (cperl-word-at-point)))
10019
7bcea553
IZ
10020(defcustom pod2man-program "pod2man"
10021 "*File name for `pod2man'."
10022 :type 'file
10023 :group 'cperl)
6c72d195 10024
7bcea553 10025;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
6c72d195 10026(defun cperl-pod-to-manpage ()
7bcea553 10027 "Create a virtual manpage in Emacs from the Perl Online Documentation."
6c72d195
IZ
10028 (interactive)
10029 (require 'man)
10030 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
10031 (bufname (concat "Man " buffer-file-name))
10032 (buffer (generate-new-buffer bufname)))
10033 (save-excursion
10034 (set-buffer buffer)
10035 (let ((process-environment (copy-sequence process-environment)))
10036 ;; Prevent any attempt to use display terminal fanciness.
10037 (setenv "TERM" "dumb")
10038 (set-process-sentinel
10039 (start-process pod2man-program buffer "sh" "-c"
10040 (format (cperl-pod2man-build-command) pod2man-args))
10041 'Man-bgproc-sentinel)))))
10042
8cfd7987
JH
10043;;; Updated version by him too
10044(defun cperl-build-manpage ()
10045 "Create a virtual manpage in Emacs from the POD in the file."
10046 (interactive)
10047 (require 'man)
10048 (cond
10049 (cperl-xemacs-p
10050 (let ((Manual-program "perldoc"))
10051 (manual-entry buffer-file-name)))
10052 (t
10053 (let* ((manual-program "perldoc"))
10054 (Man-getpage-in-background buffer-file-name)))))
10055
6c72d195
IZ
10056(defun cperl-pod2man-build-command ()
10057 "Builds the entire background manpage and cleaning command."
10058 (let ((command (concat pod2man-program " %s 2>/dev/null"))
8f95267c 10059 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
6c72d195
IZ
10060 (while (and flist (car flist))
10061 (let ((pcom (car (car flist)))
10062 (pargs (cdr (car flist))))
10063 (setq command
10064 (concat command " | " pcom " "
10065 (mapconcat '(lambda (phrase)
10066 (if (not (stringp phrase))
10067 (error "Malformed Man-filter-list"))
10068 phrase)
10069 pargs " ")))
10070 (setq flist (cdr flist))))
10071 command))
10072
8f95267c
RGS
10073
10074(defun cperl-next-interpolated-REx-1 ()
10075 "Move point to next REx which has interpolated parts without //o.
10076Skips RExes consisting of one interpolated variable.
10077
10078Note that skipped RExen are not performance hits."
10079 (interactive "")
10080 (cperl-next-interpolated-REx 1))
10081
10082(defun cperl-next-interpolated-REx-0 ()
10083 "Move point to next REx which has interpolated parts without //o."
10084 (interactive "")
10085 (cperl-next-interpolated-REx 0))
10086
10087(defun cperl-next-interpolated-REx (&optional skip beg limit)
10088 "Move point to next REx which has interpolated parts.
10089SKIP is a list of possible types to skip, BEG and LIMIT are the starting
10090point and the limit of search (default to point and end of buffer).
10091
10092SKIP may be a number, then it behaves as list of numbers up to SKIP; this
10093semantic may be used as a numeric argument.
10094
10095Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
10096a result of qr//, this is not a performance hit), t for the rest."
10097 (interactive "P")
10098 (if (numberp skip) (setq skip (list 0 skip)))
10099 (or beg (setq beg (point)))
10100 (or limit (setq limit (point-max))) ; needed for n-s-p-c
10101 (let (pp)
10102 (and (eq (get-text-property beg 'syntax-type) 'string)
10103 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
10104 (cperl-map-pods-heres
10105 (function (lambda (s e p)
10106 (if (memq (get-text-property s 'REx-interpolated) skip)
10107 t
10108 (setq pp s)
10109 nil))) ; nil stops
10110 'REx-interpolated beg limit)
10111 (if pp (goto-char pp)
10112 (message "No more interpolated REx"))))
10113
10114;;; Initial version contributed by Trey Belew
10115(defun cperl-here-doc-spell (&optional beg end)
10116 "Spell-check HERE-documents in the Perl buffer.
10117If a region is highlighted, restricts to the region."
10118 (interactive "")
10119 (cperl-pod-spell t beg end))
10120
10121(defun cperl-pod-spell (&optional do-heres beg end)
10122 "Spell-check POD documentation.
10123If invoked with prefix argument, will do HERE-DOCs instead.
10124If a region is highlighted, restricts to the region."
10125 (interactive "P")
10126 (save-excursion
10127 (let (beg end)
10128 (if (cperl-mark-active)
10129 (setq beg (min (mark) (point))
10130 end (max (mark) (point)))
10131 (setq beg (point-min)
10132 end (point-max)))
10133 (cperl-map-pods-heres (function
10134 (lambda (s e p)
10135 (if do-heres
10136 (setq e (save-excursion
10137 (goto-char e)
10138 (forward-line -1)
10139 (point))))
10140 (ispell-region s e)
10141 t))
10142 (if do-heres 'here-doc-group 'in-pod)
10143 beg end))))
10144
10145(defun cperl-map-pods-heres (func &optional prop s end)
10146 "Executes a function over regions of pods or here-documents.
10147PROP is the text-property to search for; default to `in-pod'. Stop when
10148function returns nil."
10149 (let (pos posend has-prop (cont t))
10150 (or prop (setq prop 'in-pod))
10151 (or s (setq s (point-min)))
10152 (or end (setq end (point-max)))
10153 (cperl-update-syntaxification end end)
10154 (save-excursion
10155 (goto-char (setq pos s))
10156 (while (and cont (< pos end))
10157 (setq has-prop (get-text-property pos prop))
10158 (setq posend (next-single-property-change pos prop nil end))
10159 (and has-prop
10160 (setq cont (funcall func pos posend prop)))
10161 (setq pos posend)))))
10162
10163;;; Based on code by Masatake YAMATO:
10164(defun cperl-get-here-doc-region (&optional pos pod)
10165 "Return HERE document region around the point.
10166Return nil if the point is not in a HERE document region. If POD is non-nil,
10167will return a POD section if point is in a POD section."
10168 (or pos (setq pos (point)))
10169 (cperl-update-syntaxification pos pos)
10170 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
10171 (and pod
10172 (eq 'pod (get-text-property pos 'syntax-type))))
10173 (let ((b (cperl-beginning-of-property pos 'syntax-type))
10174 (e (next-single-property-change pos 'syntax-type)))
10175 (cons b (or e (point-max))))))
10176
10177(defun cperl-narrow-to-here-doc (&optional pos)
10178 "Narrows editing region to the HERE-DOC at POS.
10179POS defaults to the point."
10180 (interactive "d")
10181 (or pos (setq pos (point)))
10182 (let ((p (cperl-get-here-doc-region pos)))
10183 (or p (error "Not inside a HERE document"))
10184 (narrow-to-region (car p) (cdr p))
10185 (message
10186 "When you are finished with narrow editing, type C-x n w")))
10187
10188(defun cperl-select-this-pod-or-here-doc (&optional pos)
10189 "Select the HERE-DOC (or POD section) at POS.
10190POS defaults to the point."
10191 (interactive "d")
10192 (let ((p (cperl-get-here-doc-region pos t)))
10193 (if p
10194 (progn
10195 (goto-char (car p))
10196 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
10197 (message "I do not think POS is in POD or a HERE-doc..."))))
10198
10199(defun cperl-facemenu-add-face-function (face end)
10200 "A callback to process user-initiated font-change requests.
10201Translates `bold', `italic', and `bold-italic' requests to insertion of
10202corresponding POD directives, and `underline' to C<> POD directive.
10203
10204Such requests are usually bound to M-o LETTER."
10205 (or (get-text-property (point) 'in-pod)
10206 (error "Faces can only be set within POD"))
10207 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
10208 (cdr (or (assq face '((bold . "B<")
10209 (italic . "I<")
10210 (bold-italic . "B<I<")
10211 (underline . "C<")))
10212 (error "Face %s not configured for cperl-mode"
10213 face))))
10214\f
10215(defun cperl-time-fontification (&optional l step lim)
10216 "Times how long it takes to do incremental fontification in a region.
10217L is the line to start at, STEP is the number of lines to skip when
10218doing next incremental fontification, LIM is the maximal number of
10219incremental fontification to perform. Messages are accumulated in
10220*Messages* buffer.
10221
10222May be used for pinpointing which construct slows down buffer fontification:
10223start with default arguments, then refine the slowdown regions."
10224 (interactive "nLine to start at: \nnStep to do incremental fontification: ")
10225 (or l (setq l 1))
10226 (or step (setq step 500))
10227 (or lim (setq lim 40))
10228 (let* ((timems (function (lambda ()
10229 (let ((tt (current-time)))
10230 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
10231 (tt (funcall timems)) (c 0) delta tot)
10232 (goto-line l)
10233 (cperl-mode)
10234 (setq tot (- (- tt (setq tt (funcall timems)))))
10235 (message "cperl-mode at %s: %s" l tot)
10236 (while (and (< c lim) (not (eobp)))
10237 (forward-line step)
10238 (setq l (+ l step))
10239 (setq c (1+ c))
10240 (cperl-update-syntaxification (point) (point))
10241 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
10242 (message "to %s:%6s,%7s" l delta tot))
10243 tot))
10244
10245(defun cperl-emulate-lazy-lock (&optional window-size)
10246 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
10247Start fontifying the buffer from the start (or end) using the given
10248WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
10249goes backwards; default is -50. This function is not CPerl-specific; it
10250may be used to debug problems with delayed incremental fontification."
10251 (interactive
10252 "nSize of window for incremental fontification, negative goes backwards: ")
10253 (or window-size (setq window-size -50))
10254 (let ((pos (if (> window-size 0)
10255 (point-min)
10256 (point-max)))
10257 p)
10258 (goto-char pos)
10259 (normal-mode)
10260 ;; Why needed??? With older font-locks???
10261 (set (make-local-variable 'font-lock-cache-position) (make-marker))
10262 (while (if (> window-size 0)
10263 (< pos (point-max))
10264 (> pos (point-min)))
10265 (setq p (progn
10266 (forward-line window-size)
10267 (point)))
10268 (font-lock-fontify-region (min p pos) (max p pos))
10269 (setq pos p))))
10270
10271\f
6c72d195 10272(defun cperl-lazy-install ()) ; Avoid a warning
8cfd7987 10273(defun cperl-lazy-unstall ()) ; Avoid a warning
05bbd9c3 10274
55497cff 10275(if (fboundp 'run-with-idle-timer)
10276 (progn
10277 (defvar cperl-help-shown nil
10278 "Non-nil means that the help was already shown now.")
10279
ebcd4dbc
IZ
10280 (defvar cperl-lazy-installed nil
10281 "Non-nil means that the lazy-help handlers are installed now.")
55497cff 10282
10283 (defun cperl-lazy-install ()
8cfd7987
JH
10284 "Switches on Auto-Help on Perl constructs (put in the message area).
10285Delay of auto-help controlled by `cperl-lazy-help-time'."
55497cff 10286 (interactive)
10287 (make-variable-buffer-local 'cperl-help-shown)
ebcd4dbc
IZ
10288 (if (and (cperl-val 'cperl-lazy-help-time)
10289 (not cperl-lazy-installed))
55497cff 10290 (progn
10291 (add-hook 'post-command-hook 'cperl-lazy-hook)
8cfd7987
JH
10292 (run-with-idle-timer
10293 (cperl-val 'cperl-lazy-help-time 1000000 5)
10294 t
ebcd4dbc
IZ
10295 'cperl-get-help-defer)
10296 (setq cperl-lazy-installed t))))
55497cff 10297
10298 (defun cperl-lazy-unstall ()
8cfd7987
JH
10299 "Switches off Auto-Help on Perl constructs (put in the message area).
10300Delay of auto-help controlled by `cperl-lazy-help-time'."
55497cff 10301 (interactive)
10302 (remove-hook 'post-command-hook 'cperl-lazy-hook)
ebcd4dbc
IZ
10303 (cancel-function-timers 'cperl-get-help-defer)
10304 (setq cperl-lazy-installed nil))
55497cff 10305
10306 (defun cperl-lazy-hook ()
10307 (setq cperl-help-shown nil))
10308
10309 (defun cperl-get-help-defer ()
8cfd7987 10310 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
5f05dabc 10311 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
55497cff 10312 (cperl-get-help)
10313 (setq cperl-help-shown t))))
10314 (cperl-lazy-install)))
ebcd4dbc 10315
6c72d195
IZ
10316
10317;;; Plug for wrong font-lock:
10318
10319(defun cperl-font-lock-unfontify-region-function (beg end)
10320 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
10321 (inhibit-read-only t) (inhibit-point-motion-hooks t)
10322 before-change-functions after-change-functions
10323 deactivate-mark buffer-file-name buffer-file-truename)
10324 (remove-text-properties beg end '(face nil))
8f95267c 10325 (if (and (not modified) (buffer-modified-p))
6c72d195
IZ
10326 (set-buffer-modified-p nil))))
10327
8f95267c
RGS
10328(defun cperl-font-lock-fontify-region-function (beg end loudly)
10329 "Extends the region to safe positions, then calls the default function.
10330Newer `font-lock's can do it themselves.
10331We unwind only as far as needed for fontification. Syntaxification may
10332do extra unwind via `cperl-unwind-to-safe'."
10333 (save-excursion
10334 (goto-char beg)
10335 (while (and beg
10336 (progn
10337 (beginning-of-line)
10338 (eq (get-text-property (setq beg (point)) 'syntax-type)
10339 'multiline)))
10340 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
10341 (goto-char beg)))
10342 (setq beg (point))
10343 (goto-char end)
10344 (while (and end
10345 (progn
10346 (or (bolp) (condition-case nil
10347 (forward-line 1)
10348 (error nil)))
10349 (eq (get-text-property (setq end (point)) 'syntax-type)
10350 'multiline)))
10351 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
10352 (goto-char end))
10353 (setq end (point)))
10354 (font-lock-default-fontify-region beg end loudly))
10355
6c72d195
IZ
10356(defvar cperl-d-l nil)
10357(defun cperl-fontify-syntaxically (end)
4584684c 10358 ;; Some vars for debugging only
7bcea553 10359 ;; (message "Syntaxifying...")
8f95267c 10360 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
8cfd7987 10361 (istate (car cperl-syntax-state))
8f95267c
RGS
10362 start from-start edebug-backtrace-buffer)
10363 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
10364 (progn
10365 (require 'edebug)
10366 (let ((f 'edebug-backtrace))
10367 (funcall f)))) ; Avoid compile-time warning
6c72d195 10368 (or cperl-syntax-done-to
8f95267c
RGS
10369 (setq cperl-syntax-done-to (point-min)
10370 from-start t))
10371 (setq start (if (and cperl-hook-after-change
10372 (not from-start))
10373 cperl-syntax-done-to ; Fontify without change; ignore start
10374 ;; Need to forget what is after `start'
10375 (min cperl-syntax-done-to (point))))
10376 (goto-char start)
10377 (beginning-of-line)
10378 (setq start (point))
10379 (and cperl-syntaxify-unwind
10380 (setq end (cperl-unwind-to-safe t end)
10381 start (point)))
6c72d195
IZ
10382 (and (> end start)
10383 (setq cperl-syntax-done-to start) ; In case what follows fails
10384 (cperl-find-pods-heres start end t nil t))
8f95267c
RGS
10385 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
10386 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
10387 dbg iend start end idone cperl-syntax-done-to
8cfd7987 10388 istate (car cperl-syntax-state))) ; For debugging
6c72d195
IZ
10389 nil)) ; Do not iterate
10390
20675f5d 10391(defun cperl-fontify-update (end)
8f95267c
RGS
10392 (let ((pos (point-min)) prop posend)
10393 (setq end (point-max))
20675f5d 10394 (while (< pos end)
8f95267c
RGS
10395 (setq prop (get-text-property pos 'cperl-postpone)
10396 posend (next-single-property-change pos 'cperl-postpone nil end))
20675f5d
IZ
10397 (and prop (put-text-property pos posend (car prop) (cdr prop)))
10398 (setq pos posend)))
8cfd7987 10399 nil) ; Do not iterate
20675f5d 10400
8f95267c
RGS
10401(defun cperl-fontify-update-bad (end)
10402 ;; Since fontification happens with different region than syntaxification,
10403 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
10404 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
10405 (if prop
10406 (setq pos (or (cperl-beginning-of-property
10407 (cperl-1+ pos) 'cperl-postpone)
10408 (point-min))))
10409 (while (< pos end)
10410 (setq posend (next-single-property-change pos 'cperl-postpone))
10411 (and prop (put-text-property pos posend (car prop) (cdr prop)))
10412 (setq pos posend)
10413 (setq prop (get-text-property pos 'cperl-postpone))))
10414 nil) ; Do not iterate
10415
10416;; Called when any modification is made to buffer text.
10417(defun cperl-after-change-function (beg end old-len)
10418 ;; We should have been informed about changes by `font-lock'. Since it
10419 ;; does not inform as which calls are defered, do it ourselves
10420 (if cperl-syntax-done-to
10421 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
10422
6c72d195
IZ
10423(defun cperl-update-syntaxification (from to)
10424 (if (and cperl-use-syntax-table-text-property
10425 cperl-syntaxify-by-font-lock
10426 (or (null cperl-syntax-done-to)
10427 (< cperl-syntax-done-to to)))
10428 (progn
10429 (save-excursion
10430 (goto-char from)
10431 (cperl-fontify-syntaxically to)))))
10432
8cfd7987 10433(defvar cperl-version
8f95267c 10434 (let ((v "$Revision: 5.23 $"))
4584684c
GS
10435 (string-match ":\\s *\\([0-9.]+\\)" v)
10436 (substring v (match-beginning 1) (match-end 1)))
10437 "Version of IZ-supported CPerl package this file is based on.")
10438
ebcd4dbc 10439(provide 'cperl-mode)
6c72d195
IZ
10440
10441;;; cperl-mode.el ends here