Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
9129 lines (8520 sloc) 336 KB
;;; cperl-mode.el --- Perl code editing commands for Emacs
;; Copyright (C) 1985, 86, 87, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2003
;; Free Software Foundation, Inc.
;; Author: Ilya Zakharevich and Bob Olson
;; Maintainer: Ilya Zakharevich <>
;; Keywords: languages, Perl
;; This file is part of GNU Emacs.
;;; This code started from the following message of long time ago
;;; (IZ), but Bob does not maintain this mode any more:
;;; From: (Bob Olson)
;;; Newsgroups: comp.lang.perl
;;; Subject: cperl-mode: Another perl mode for Gnuemacs
;;; Date: 14 Aug 91 15:20:01 GMT
;; Copyright (C) Ilya Zakharevich and Bob Olson
;; This file may be distributed
;; either under the same terms as GNU Emacs, or under the same terms
;; as Perl. You should have received a copy of Perl Artistic license
;; along with the Perl distribution.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
;;; Corrections made by Ilya Zakharevich
;;; XEmacs changes by Peter Arius
;;; Commentary:
;; $Id: cperl-mode.el,v 5.3 2005/10/16 09:55:42 vera Exp vera $
;;; If your Emacs does not default to `cperl-mode' on Perl files:
;;; To use this mode put the following into
;;; your .emacs file:
;; (autoload 'perl-mode "cperl-mode" "alternate mode for editing Perl programs" t)
;; You can either fine-tune the bells and whistles of this mode or
;; bulk enable them by putting
;; (setq cperl-hairy t)
;; in your .emacs file. (Emacs rulers do not consider it politically
;; correct to make whistles enabled by default.)
;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
;; `cperl-non-problems', `cperl-praise', `cperl-speed'. <<<<<<
;; Additional useful commands to put into your .emacs file (before
;; RMS Emacs 20.3):
;; (setq auto-mode-alist
;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
;; (setq interpreter-mode-alist (append interpreter-mode-alist
;; '(("miniperl" . perl-mode))))
;; The mode information (on C-h m) provides some customization help.
;; If you use font-lock feature of this mode, it is advisable to use
;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
;; Faces used now: three faces for first-class and second-class keywords
;; and control flow words, one for each: comments, string, labels,
;; functions definitions and packages, arrays, hashes, and variable
;; definitions. If you do not see all these faces, your font-lock does
;; not define them, so you need to define them manually.
;; Maybe you have an obsolete font-lock from 19.28 or earlier. Upgrade.
;; If you have a grayscale monitor, and do not have the variable
;; font-lock-display-type bound to 'grayscale, insert
;; (setq font-lock-display-type 'grayscale)
;; into your .emacs file (this is relevant before RMS Emacs 20).
;; This mode supports font-lock, imenu and mode-compile. In the
;; hairy version font-lock is on, but you should activate imenu
;; yourself (note that mode-compile is not standard yet). Well, you
;; can use imenu from keyboard anyway (M-x imenu), but it is better
;; to bind it like that:
;; (define-key global-map [M-S-down-mouse-3] 'imenu)
;;; Font lock bugs as of v4.32:
;; The following kinds of Perl code erroneously start strings:
;; \$` \$' \$"
;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
;; likewise with m, tr, y, q, qX instead of s
;;; In fact the version of font-lock that this version supports can be
;;; much newer than the version you actually have. This means that a
;;; lot of faces can be set up, but are not visible on your screen
;;; since the coloring rules for this faces are not defined.
;;; Updates: ========================================
;;; Made less hairy by default: parentheses not electric,
;;; linefeed not magic. Bug with abbrev-mode corrected.
;;;; After 1.4:
;;; Better indentation:
;;; subs inside braces should work now,
;;; Toplevel braces obey customization.
;;; indent-for-comment knows about bad cases, cperl-indent-for-comment
;;; moves cursor to a correct place.
;;; cperl-indent-exp written from the scratch! Slow... (quadratic!) :-(
;;; (50 secs on DB::DB (sub of 430 lines), 486/66)
;;; Minor documentation fixes.
;;; Imenu understands packages as prefixes (including nested).
;;; Hairy options can be switched off one-by-one by setting to null.
;;; Names of functions and variables changed to conform to `cperl-' style.
;;;; After 1.5:
;;; Some bugs with indentation of labels (and embedded subs) corrected.
;;; `cperl-indent-region' done (slow :-()).
;;; `cperl-fill-paragraph' done.
;;; Better package support for `imenu'.
;;; Progress indicator for indentation (with `imenu' loaded).
;;; `Cperl-set' was busted, now setting the individual hairy option
;;; should be better.
;;;; After 1.6:
;;; `cperl-set-style' done.
;;; `cperl-check-syntax' done.
;;; Menu done.
;;; New config variables `cperl-close-paren-offset' and `cperl-comment-column'.
;;; Bugs with `cperl-auto-newline' corrected.
;;; `cperl-electric-lbrace' can work with `cperl-auto-newline' in situation
;;; like $hash{.
;;;; 1.7 XEmacs (
;;; - use `next-command-event', if `next-command-events' does not exist
;;; - use `find-face' as def. of `is-face'
;;; - corrected def. of `x-color-defined-p'
;;; - added const defs for font-lock-comment-face,
;;; font-lock-keyword-face and font-lock-function-name-face
;;; - added def. of font-lock-variable-name-face
;;; - added (require 'easymenu) inside an `eval-when-compile'
;;; - replaced 4-argument `substitute-key-definition' with ordinary
;;; `define-key's
;;; - replaced `mark-active' in menu definition by `cperl-use-region-p'.
;;; Todo (at least):
;;; - use emacs-vers.el (
;;; for portable code?
;;; - should `cperl-mode' do a
;;; (if (featurep 'easymenu) (easy-menu-add cperl-menu))
;;; or should this be left to the user's `cperl-mode-hook'?
;;; Some bugs introduced by the above fix corrected (IZ ;-).
;;; Some bugs under XEmacs introduced by the correction corrected.
;;; Some more can remain since there are two many different variants.
;;; Please feedback!
;;; We do not support fontification of arrays and hashes under
;;; obsolete font-lock any more. Upgrade.
;;;; after 1.8 Minor bug with parentheses.
;;;; after 1.9 Improvements from Joe Marzot.
;;;; after 1.10
;;; Does not need easymenu to compile under XEmacs.
;;; `vc-insert-headers' should work better.
;;; Should work with 19.29 and 19.12.
;;; Small improvements to fontification.
;;; Expansion of keywords does not depend on C-? being backspace.
;;; after 1.10+
;;; 19.29 and 19.12 supported.
;;; `cperl-font-lock-enhanced' deprecated. Use font-lock-extra.el.
;;; Support for font-lock-extra.el.
;;;; After 1.11:
;;; Tools submenu.
;;; Support for perl5-info.
;;; `imenu-go-find-at-position' in Tools requires imenu-go.el (see hints above)
;;; Imenu entries do not work with stock imenu.el. Patch sent to maintainers.
;;; Fontifies `require a if b;', __DATA__.
;;; Arglist for auto-fill-mode was incorrect.
;;;; After 1.12:
;;; `cperl-lineup-step' and `cperl-lineup' added: lineup constructions
;;; vertically.
;;; `cperl-do-auto-fill' updated for 19.29 style.
;;; `cperl-info-on-command' now has a default.
;;; Workaround for broken C-h on XEmacs.
;;; VC strings escaped.
;;; C-h f now may prompt for function name instead of going on,
;;; controlled by `cperl-info-on-command-no-prompt'.
;;;; After 1.13:
;;; Msb buffer list includes perl files
;;; Indent-for-comment uses indent-to
;;; Can write tag files using etags.
;;;; After 1.14:
;;; Recognizes (tries to ;-) {...} which are not blocks during indentation.
;;; `cperl-close-paren-offset' affects ?\] too (and ?\} if not block)
;;; Bug with auto-filling comments started with "##" corrected.
;;;; Very slow now: on DB::DB 0.91, 486/66:
;;;Function Name Call Count Elapsed Time Average Time
;;;======================================== ========== ============ ============
;;;cperl-block-p 469 3.7799999999 0.0080597014
;;;cperl-get-state 505 163.39000000 0.3235445544
;;;cperl-comment-indent 12 0.0299999999 0.0024999999
;;;cperl-backward-to-noncomment 939 4.4599999999 0.0047497337
;;;cperl-calculate-indent 505 172.22000000 0.3410297029
;;;cperl-indent-line 505 172.88000000 0.3423366336
;;;cperl-use-region-p 40 0.0299999999 0.0007499999
;;;cperl-indent-exp 1 177.97000000 177.97000000
;;;cperl-to-comment-or-eol 1453 3.9800000000 0.0027391603
;;;cperl-backward-to-start-of-continued-exp 9 0.0300000000 0.0033333333
;;;cperl-indent-region 1 177.94000000 177.94000000
;;;; After 1.15:
;;; Takes into account white space after opening parentheses during indent.
;;; May highlight pods and here-documents: see `cperl-pod-here-scan',
;;; `cperl-pod-here-fontify', `cperl-pod-face'. Does not use this info
;;; for indentation so far.
;;; Fontification updated to 19.30 style.
;;; The change 19.29->30 did not add all the required functionality,
;;; but broke "font-lock-extra.el". Get "choose-color.el" from
;;;; After 1.16:
;;; else # comment
;;; recognized as a start of a block.
;;; Two different font-lock-levels provided.
;;; `cperl-pod-head-face' introduced. Used for highlighting.
;;; `imenu' marks pods, +Packages moved to the head.
;;;; After 1.17:
;;; Scan for pods highlights here-docs too.
;;; Note that the tag of here-doc may be rehighlighted later by lazy-lock.
;;; Only one here-doc-tag per line is supported, and one in comment
;;; or a string may break fontification.
;;; POD headers were supposed to fill one line only.
;;;; After 1.18:
;;; `font-lock-keywords' were set in 19.30 style _always_. Current scheme
;;; may break under XEmacs.
;;; `cperl-calculate-indent' dis suppose that `parse-start' was defined.
;;; `fontified' tag is added to fontified text as well as `lazy-lock' (for
;;; compatibility with older lazy-lock.el) (older one overfontifies
;;; something nevertheless :-().
;;; Will not indent something inside pod and here-documents.
;;; Fontifies the package name after import/no/bootstrap.
;;; Added new entry to menu with meta-info about the mode.
;;;; After 1.19:
;;; Prefontification works much better with 19.29. Should be checked
;;; with 19.30 as well.
;;; Some misprints in docs corrected.
;;; Now $a{-text} and -text => "blah" are fontified as strings too.
;;; Now the pod search is much stricter, so it can help you to find
;;; pod sections which are broken because of whitespace before =blah
;;; - just observe the fontification.
;;;; After 1.20
;;; Anonymous subs are indented with respect to the level of
;;; indentation of `sub' now.
;;; {} is recognized as hash after `bless' and `return'.
;;; Anonymous subs are split by `cperl-linefeed' as well.
;;; Electric parens embrace a region if present.
;;; To make `cperl-auto-newline' useful,
;;; `cperl-auto-newline-after-colon' is introduced.
;;; `cperl-electric-parens' is now t or nul. The old meaning is moved to
;;; `cperl-electric-parens-string'.
;;; `cperl-toggle-auto-newline' introduced, put on C-c C-a.
;;; `cperl-toggle-abbrev' introduced, put on C-c C-k.
;;; `cperl-toggle-electric' introduced, put on C-c C-e.
;;; Beginning-of-defun-regexp was not anchored.
;;;; After 1.21
;;; Auto-newline grants `cperl-extra-newline-before-brace' if "{" is typed
;;; after ")".
;;; {} is recognized as expression after `tr' and friends.
;;;; After 1.22
;;; Entry Hierarchy added to imenu. Very primitive so far.
;;; One needs newer `imenu-go'.el. A patch to `imenu' is needed as well.
;;; Writes its own TAGS files.
;;; Class viewer based on TAGS files. Does not trace @ISA so far.
;;; 19.31: Problems with scan for PODs corrected.
;;; First POD header correctly fontified.
;;; I needed (setq imenu-use-keymap-menu t) to get good imenu in 19.31.
;;; Apparently it makes a lot of hierarchy code obsolete...
;;;; After 1.23
;;; Tags filler now scans *.xs as well.
;;; The info from *.xs scan is used by the hierarchy viewer.
;;; Hierarchy viewer documented.
;;; Bug in 19.31 imenu documented.
;;;; After 1.24
;;; New location for info-files mentioned,
;;; Electric-; should work better.
;;; Minor bugs with POD marking.
;;;; After 1.25 (probably not...)
;;; `cperl-info-page' introduced.
;;; To make `uncomment-region' working, `comment-region' would
;;; not insert extra space.
;;; Here documents delimiters better recognized
;;; (empty one, and non-alphanums in quotes handled). May be wrong with 1<<14?
;;; `cperl-db' added, used in menu.
;;; imenu scan removes text-properties, for better debugging
;;; - but the bug is in 19.31 imenu.
;;; formats highlighted by font-lock and prescan, embedded comments
;;; are not treated.
;;; POD/friends scan merged in one pass.
;;; Syntax class is not used for analyzing the code, only char-syntax
;;; may be checked against _ or'ed with w.
;;; Syntax class of `:' changed to be _.
;;; `cperl-find-bad-style' added.
;;;; After 1.25
;;; When search for here-documents, we ignore commented << in simplest cases.
;;; `cperl-get-help' added, available on C-h v and from menu.
;;; Auto-help added. Default with `cperl-hairy', switchable on/off
;;; with startup variable `cperl-lazy-help-time' and from
;;; menu. Requires `run-with-idle-timer'.
;;; Highlighting of @abc{@efg} was wrong - interchanged two regexps.
;;;; After 1.27
;;; Indentation: At toplevel after a label - fixed.
;;; 1.27 was put to archives in binary mode ===> DOSish :-(
;;;; After 1.28
;;; Thanks to Martin Buchholz <mrb@Eng.Sun.COM>: misprints in
;;; comments and docstrings corrected, XEmacs support cleaned up.
;;; The closing parenths would enclose the region into matching
;;; parens under the same conditions as the opening ones.
;;; Minor updates to `cperl-short-docs'.
;;; Will not consider <<= as start of here-doc.
;;;; After 1.29
;;; Added an extra advice to look into Micro-docs. ;-).
;;; Enclosing of region when you press a closing parenth is regulated by
;;; `cperl-electric-parens-string'.
;;; Minor updates to `cperl-short-docs'.
;;; `initialize-new-tags-table' called only if present (Does this help
;;; with generation of tags under XEmacs?).
;;; When creating/updating tag files, new info is written at the old place,
;;; or at the end (is this a wanted behaviour? I need this in perl build directory).
;;;; After 1.30
;;; All the keywords from included (maybe with dummy explanation).
;;; No auto-help inside strings, comment, here-docs, formats, and pods.
;;; Shrinkwrapping of info, regulated by `cperl-max-help-size',
;;; `cperl-shrink-wrap-info-frame'.
;;; Info on variables as well.
;;; Recognision of HERE-DOCS improved yet more.
;;; Autonewline works on `}' without warnings.
;;; Autohelp works again on $_[0].
;;;; After 1.31
;;; perl-descr.el found its author - hi, Johan!
;;; Some support for correct indent after here-docs and friends (may
;;; be superseeded by eminent change to Emacs internals).
;;; Should work with older Emaxen as well ( `-style stuff removed).
;;;; After 1.32
;;; Started to add support for `syntax-table' property (should work
;;; with patched Emaxen), controlled by
;;; `cperl-use-syntax-table-text-property'. Currently recognized:
;;; All quote-like operators: m, s, y, tr, qq, qw, qx, q,
;;; // in most frequent context:
;;; after block or
;;; ~ { ( = | & + - * ! , ;
;;; or
;;; while if unless until and or not xor split grep map
;;; Here-documents, formats, PODs,
;;; ${...}
;;; 'abc$'
;;; sub a ($); sub a ($) {}
;;; (provide 'cperl-mode) was missing!
;;; `cperl-after-expr-p' is now much smarter after `}'.
;;; `cperl-praise' added to mini-docs.
;;; Utilities try to support subs-with-prototypes.
;;;; After 1.32.1
;;; `cperl-after-expr-p' is now much smarter after "() {}" and "word {}":
;;; if word is "else, map, grep".
;;; Updated for new values of syntax-table constants.
;;; Uses `help-char' (at last!) (disabled, does not work?!)
;;; A couple of regexps where missing _ in character classes.
;;; -s could be considered as start of regexp, 1../blah/ was not,
;;; as was not /blah/ at start of file.
;;;; After 1.32.2
;;; "\C-hv" was wrongly "\C-hf"
;;; C-hv was not working on `[index()]' because of [] in skip-chars-*.
;;; `__PACKAGE__' supported.
;;; Thanks for Greg Badros: `cperl-lazy-unstall' is more complete,
;;; `cperl-get-help' is made compatible with `query-replace'.
;;;; As of Apr 15, development version of 19.34 supports
;;;; `syntax-table' text properties. Try setting
;;;; `cperl-use-syntax-table-text-property'.
;;;; After 1.32.3
;;; We scan for s{}[] as well (in simplest situations).
;;; We scan for $blah'foo as well.
;;; The default is to use `syntax-table' text property if Emacs is good enough.
;;; `cperl-lineup' is put on C-M-| (=C-M-S-\\).
;;; Start of `cperl-beautify-regexp'.
;;;; After 1.32.4
;;; `cperl-tags-hier-init' did not work in text-mode.
;;; `cperl-noscan-files-regexp' had a misprint.
;;; Generation of Class Hierarchy was broken due to a bug in `x-popup-menu'
;;; in 19.34.
;;;; After 1.33:
;;; my,local highlight vars after {} too.
;;; TAGS could not be created before imenu was loaded.
;;; `cperl-indent-left-aligned-comments' created.
;;; Logic of `cperl-indent-exp' changed a little bit, should be more
;;; robust w.r.t. multiline strings.
;;; Recognition of blah'foo takes into account strings.
;;; Added '.al' to the list of Perl extensions.
;;; Class hierarchy is "mostly" sorted (need to rethink algorthm
;;; of pruning one-root-branch subtrees to get yet better sorting.)
;;; Regeneration of TAGS was busted.
;;; Can use `syntax-table' property when generating TAGS
;;; (governed by `cperl-use-syntax-table-text-property-for-tags').
;;;; After 1.35:
;;; Can process several =pod/=cut sections one after another.
;;; Knows of `extproc' when under `emx', indents with `__END__' and `__DATA__'.
;;; `cperl-under-as-char' implemented (XEmacs people like broken behaviour).
;;; Beautifier for regexps fixed.
;;; `cperl-beautify-level', `cperl-contract-level' coded
;;;; Emacs's 20.2 problems:
;;; `imenu.el' has bugs, `imenu-add-to-menubar' does not work.
;;; Couple of others problems with 20.2 were reported, my ability to check/fix
;;; them is very reduced now.
;;;; After 1.36:
;;; 'C-M-|' in XEmacs fixed
;;;; After 1.37:
;;; &&s was not recognized as start of regular expression;
;;; Will "preprocess" the contents of //e part of s///e too;
;;; What to do with s# blah # foo #e ?
;;; Should handle s;blah;foo;; better.
;;; Now the only known problems with regular expression recognition:
;;;;;;; s<foo>/bar/ - different delimiters (end ignored)
;;;;;;; s/foo/\\bar/ - backslash at start of subst (made into one chunk)
;;;;;;; s/foo// - empty subst (made into one chunk + '/')
;;;;;;; s/foo/(bar)/ - start-group at start of subst (internal group will not match backwards)
;;;; After 1.38:
;;; We highlight closing / of s/blah/foo/e;
;;; This handles s# blah # foo #e too;
;;; s//blah/, s///, s/blah// works again, and s#blah## too, the algorithm
;;; is much simpler now;
;;; Next round of changes: s\\\ works, s<blah>/foo/,
;;; comments between the first and the second part allowed
;;; Another problem discovered:
;;;;;;; s[foo] <blah>e - e part delimited by different <> (will not match)
;;; `cperl-find-pods-heres' somehow maybe called when string-face is undefined
;;; - put a stupid workaround for 20.1
;;;; After 1.39:
;;; Could indent here-docs for comments;
;;; These problems fixed:
;;;;;;; s/foo/\\bar/ - backslash at start of subst (made into two chunk)
;;;;;;; s[foo] <blah>e - "e" part delimited by "different" <> (will match)
;;; Matching brackets honor prefices, may expand abbreviations;
;;; When expanding abbrevs, will remove last char only after
;;; self-inserted whitespace;
;;; More convenient "Refress hard constructs" in menu;
;;; `cperl-add-tags-recurse', `cperl-add-tags-recurse-noxs'
;;; added (for -batch mode);
;;; Better handling of errors when scanning for Perl constructs;
;;;;;;; Possible "problem" with class hierarchy in Perl distribution
;;;;;;; directory: ./ext duplicates ./lib;
;;; Write relative paths for generated TAGS;
;;;; After 1.40:
;;; s /// may be separated by "\n\f" too;
;;; `s #blah' recognized as a comment;
;;; Would highlight s/abc//s wrong;
;;; Debugging code in `cperl-electric-keywords' was leaking a message;
;;;; After 1.41:
;;; RMS changes for 20.3 merged
;;;; RMS mode (has 3 misprints)
;;;; After 2.0:
;;; RMS whitespace changes for 20.3 merged
;;;; After 2.1:
;;; History updated
;;;; After 2.2:
;;; Merge `c-style-alist' since `c-mode' is no more. (Somebody who
;;; uses the styles should check that they work OK!)
;;; All the variable warnings go away, some undef functions too.
;;;; After 2.3:
;;; Added `cperl-perldoc' (thanks to Anthony Foiani <>)
;;; Added `cperl-pod-to-manpage' (thanks to Nick Roberts <>)
;;; All the function warnings go away.
;;;; After 2.4:
;;; `Perl doc', `Regexp' submenus created (latter to allow short displays).
;;; `cperl-clobber-lisp-bindings' added.
;;; $a->y() is not y///.
;;; `cperl-after-block-p' was missing a `save-excursion' => wrong results.
;;; `cperl-val' was defined too late.
;;; `cperl-init-faces' was failing.
;;; Init faces when loading `ps-print'.
;;;; After 2.4:
;;; `cperl-toggle-autohelp' implemented.
;;; `while SPACE LESS' was buggy.
;;; `-text' in `[-text => 1]' was not highlighted.
;;; `cperl-after-block-p' was FALSE after `sub f {}'.
;;;; After 2.5:
;;; `foreachmy', `formy' expanded too.
;;; Expand `=pod-directive'.
;;; `cperl-linefeed' behaves reasonable in POD-directive lines.
;;; `cperl-electric-keyword' prints a message, governed by
;;; `cperl-message-electric-keyword'.
;;;; After 2.6:
;;; Typing `}' was not checking for being block or not.
;;; Beautifying levels in RE: Did not know about lookbehind;
;;; finding *which* level was not intuitive;
;;; `cperl-beautify-levels' added.
;;; Allow here-docs contain `=head1' and friends (at least for keywords).
;;;; After 2.7:
;;; Fix for broken `font-lock-unfontify-region-function'. Should
;;; preserve `syntax-table' properties even with `lazy-lock'.
;;;; After 2.8:
;;; Some more compile time warnings crept in.
;;; `cperl-indent-region-fix-else' implemented.
;;; `cperl-fix-line-spacing' implemented.
;;; `cperl-invert-if-unless' implemented (C-c C-t and in Menu).
;;; Upgraded hints to mention 20.2's goods/bads.
;;; Started to use `cperl-extra-newline-before-brace-multiline',
;;; `cperl-break-one-line-blocks-when-indent',
;;; `cperl-fix-hanging-brace-when-indent', `cperl-merge-trailing-else'.
;;;; After 2.9:
;;; Workaround for another `font-lock's `syntax-table' text-property bug.
;;; `zerop' could be applied to nil.
;;; At last, may work with `font-lock' without setting `cperl-font-lock'.
;;; (We expect that starting from 19.33, `font-lock' supports keywords
;;; being a function - what is a correct version?)
;;; Rename `cperl-indent-region-fix-else' to
;;; `cperl-indent-region-fix-constructs'.
;;; `cperl-fix-line-spacing' could be triggered inside strings, would not
;;; know what to do with BLOCKs of map/printf/etc.
;;; `cperl-merge-trailing-else' and `cperl-fix-line-spacing' handle
;;; `continue' too.
;;; Indentation after {BLOCK} knows about map/printf/etc.
;;; Finally: treat after-comma lines as continuation lines.
;;;; After 2.10:
;;; `continue' made electric.
;;; Electric `do' inserts `do/while'.
;;; Some extra compile-time warnings crept in.
;;; `font-lock' of 19.33 could not handle font-lock-keywords being a function
;;; returning a symbol.
;;;; After 2.11:
;;; Changes to make syntaxification to be autoredone via `font-lock'.
;;; Switched on by `cperl-syntaxify-by-font-lock', off by default so far.
;;;; After 2.12:
;;; Remove some commented out chunks.
;;; Styles are slightly updated (a lot of work is needed, especially
;;; with new `cperl-fix-line-spacing').
;;;; After 2.13:
;;; Old value of style is memorized when choosing a new style, may be
;;; restored from the same menu.
;;; Mode-documentation added to micro-docs.
;;; `cperl-praise' updated.
;;; `cperl-toggle-construct-fix' added on C-c C-w and menu.
;;; `auto-fill-mode' added on C-c C-f and menu.
;;; `PerlStyle' style added.
;;; Message for termination of scan corrected.
;;;; After 2.14:
;;; Did not work with -q
;;;; After 2.15:
;;; `cperl-speed' hints added.
;;; Minor style fixes.
;;;; After 2.15:
;;; Make backspace electric after expansion of `else/continue' too.
;;;; After 2.16:
;;; Starting to merge changes to RMS emacs version.
;;;; After 2.17:
;;; Merged custom stuff and darn `font-lock-constant-face'.
;;;; After 2.18:
;;; Bumped the version to 3.1
;;;; After 3.1:
;;; Fixed customization to honor cperl-hairy.
;;; Created customization groups. Sent to RMS to include into 2.3.
;;;; After 3.2:
;;; Interaction of `font-lock-hot-pass' and `cperl-syntaxify-by-font-lock'.
;;; (`cperl-after-block-and-statement-beg'):
;;; (`cperl-after-block-p'):
;;; (`cperl-after-expr-p'): It is BLOCK if we reach lim when backup sexp.
;;; (`cperl-indent-region'): Make a marker for END - text added/removed.
;;; (`cperl-style-alist', `cperl-styles-entries')
;;; Include `cperl-merge-trailing-else' where the value is clear.
;;;; After 3.3:
;;; (`cperl-tips'):
;;; (`cperl-problems'): Improvements to docs.
;;;; After 3.4:
;;; (`cperl-mode'): Make lazy syntaxification possible.
;;; (`cperl-find-pods-heres'): Safe a position in buffer where it is safe to
;;; restart syntaxification.
;;; (`cperl-syntaxify-by-font-lock'): Set to t, should be safe now.
;;;; After 3.5:
;;; (`cperl-syntaxify-by-font-lock'): Better default, customizes to
;;; `message' too.
;;;; After 3.6:
;;; (`cperl-find-pods-heres'): changed so that -d ?foo? is a RE.
;;; (`cperl-array-face'): changed name from `font-lock-emphasized-face'.
;;; (`cperl-hash-face'): changed name from `font-lock-other-emphasized-face'.
;;; Use `defface' to define these two extra faces.
;;;; After 3.7:
;;; Can use linear algorithm for indentation if Emacs supports it:
;;; indenting DB::DB (800+ lines) improved from 69 sec to 11 sec
;;; (73 vs 15 with imenu).
;;; (`cperl-emacs-can-parse'): New state.
;;; (`cperl-indent-line'): Corrected to use global state.
;;; (`cperl-calculate-indent'): Likewise.
;;; (`cperl-fix-line-spacing'): Likewise (not used yet).
;;;; After 3.8:
;;; (`cperl-choose-color'): Converted to a function (to be compilable in text-mode).
;;;; After 3.9:
;;; (`cperl-dark-background '): Disable without window-system.
;;;; After 3.10:
;;; Do `defface' only if window-system.
;;;; After 3.11:
;;; (`cperl-fix-line-spacing'): sped up to bail out early.
;;; (`cperl-indent-region'): Disable hooks during the call (how to call them later?).
;;; Now indents 820-line-long function in 6.5 sec (including syntaxification) the first time
;;; (when buffer has few properties), 7.1 sec the second time.
;;;Function Name Call Count Elapsed Time Average Time
;;;========================================= ========== ============ ============
;;;cperl-indent-exp 1 10.039999999 10.039999999
;;;cperl-indent-region 1 10.0 10.0
;;;cperl-indent-line 821 6.2100000000 0.0075639464
;;;cperl-calculate-indent 821 5.0199999999 0.0061144945
;;;cperl-backward-to-noncomment 2856 2.0500000000 0.0007177871
;;;cperl-fontify-syntaxically 2 1.78 0.8900000000
;;;cperl-find-pods-heres 2 1.78 0.8900000000
;;;cperl-update-syntaxification 1 1.78 1.78
;;;cperl-fix-line-spacing 769 1.4800000000 0.0019245773
;;;cperl-after-block-and-statement-beg 163 1.4100000000 0.0086503067
;;;cperl-block-p 775 1.1800000000 0.0015225806
;;;cperl-to-comment-or-eol 3652 1.1200000000 0.0003066812
;;;cperl-after-block-p 165 1.0500000000 0.0063636363
;;;cperl-commentify 141 0.22 0.0015602836
;;;cperl-get-state 813 0.16 0.0001968019
;;;cperl-backward-to-start-of-continued-exp 26 0.12 0.0046153846
;;;cperl-delay-update-hook 2107 0.0899999999 4.271...e-05
;;;cperl-protect-defun-start 141 0.0700000000 0.0004964539
;;;cperl-after-label 407 0.0599999999 0.0001474201
;;;cperl-forward-re 139 0.0299999999 0.0002158273
;;;cperl-comment-indent 26 0.0299999999 0.0011538461
;;;cperl-use-region-p 8 0.0 0.0
;;;cperl-lazy-hook 15 0.0 0.0
;;;cperl-after-expr-p 8 0.0 0.0
;;;cperl-font-lock-unfontify-region-function 1 0.0 0.0
;;;Function Name Call Count Elapsed Time Average Time
;;;========================================= ========== ============ ============
;;;cperl-fix-line-spacing 769 1.4500000000 0.0018855656
;;;cperl-indent-line 13 0.3100000000 0.0238461538
;;;cperl-after-block-and-statement-beg 69 0.2700000000 0.0039130434
;;;cperl-after-block-p 69 0.2099999999 0.0030434782
;;;cperl-calculate-indent 13 0.1000000000 0.0076923076
;;;cperl-backward-to-noncomment 177 0.0700000000 0.0003954802
;;;cperl-get-state 13 0.0 0.0
;;;cperl-to-comment-or-eol 179 0.0 0.0
;;;cperl-get-help-defer 1 0.0 0.0
;;;cperl-lazy-hook 11 0.0 0.0
;;;cperl-after-expr-p 2 0.0 0.0
;;;cperl-block-p 13 0.0 0.0
;;;cperl-after-label 5 0.0 0.0
;;;; After 3.12:
;;; (`cperl-find-pods-heres'): do not warn on `=cut' if doing a chunk only.
;;;; After 3.13:
;;; (`cperl-mode'): load pseudo-faces on `cperl-find-pods-heres' (for 19.30).
;;; (`x-color-defined-p'): was not compiling on XEmacs
;;; (`cperl-find-pods-heres'): 1 << 6 was OK, but 1<<6 was considered as HERE
;;; <file/glob> made into a string.
;;;; After 3.14:
;;; (`cperl-find-pods-heres'): Postpone addition of faces after syntactic step
;;; Recognition of <FH> was wrong.
;;; (`cperl-clobber-lisp-bindings'): if set, C-c variants are the old ones
;;; (`cperl-unwind-to-safe'): New function.
;;; (`cperl-fontify-syntaxically'): Use `cperl-unwind-to-safe' to start at reasonable position.
;;;; After 3.15:
;;; (`cperl-forward-re'): Highlight the trailing / in s/foo// as string.
;;; Highlight the starting // in s//foo/ as function-name.
;;;; After 3.16:
;;; (`cperl-find-pods-heres'): Highlight `gem' in s///gem as a keyword.
;;;; After 4.0:
;;; (`cperl-find-pods-heres'): `qr' added
;;; (`cperl-electric-keyword'): Likewise
;;; (`cperl-electric-else'): Likewise
;;; (`cperl-to-comment-or-eol'): Likewise
;;; (`cperl-make-regexp-x'): Likewise
;;; (`cperl-init-faces'): Likewise, and `lock' (as overridable?).
;;; (`cperl-find-pods-heres'): Knows that split// is null-RE.
;;; Highlights separators in 3-parts expressions
;;; as labels.
;;;; After 4.1:
;;; (`cperl-find-pods-heres'): <> was considered as a glob
;;; (`cperl-syntaxify-unwind'): New configuration variable
;;; (`cperl-fontify-m-as-s'): New configuration variable
;;;; After 4.2:
;;; (`cperl-find-pods-heres'): of the last line being `=head1' fixed.
;;; Handling of a long construct is still buggy if only the part of
;;; construct touches the updated region (we unwind to the start of
;;; long construct, but the end may have residual properties).
;;; (`cperl-unwind-to-safe'): would not go to beginning of buffer.
;;; (`cperl-electric-pod'): check for after-expr was performed
;;; inside of POD too.
;;;; After 4.3:
;;; (`cperl-backward-to-noncomment'): better treatment of PODs and HEREs.
;;; Indent-line works good, but indent-region does not - at toplevel...
;;; (`cperl-unwind-to-safe'): Signature changed.
;;; (`x-color-defined-p'): was defmacro'ed with a tick. Remove another def.
;;; (`cperl-clobber-mode-lists'): New configuration variable.
;;; (`cperl-array-face'): One of definitions was garbled.
;;;; After 4.4:
;;; (`cperl-not-bad-style-regexp'): Updated.
;;; (`cperl-make-regexp-x'): Misprint in a message.
;;; (`cperl-find-pods-heres'): $a-1 ? foo : bar; was a regexp.
;;; `<< (' was considered a start of POD.
;;; Init: `cperl-is-face' was busted.
;;; (`cperl-make-face'): New macros.
;;; (`cperl-force-face'): New macros.
;;; (`cperl-init-faces'): Corrected to use new macros;
;;; `if' for copying `reference-face' to
;;; `constant-face' was backward.
;;; (`font-lock-other-type-face'): Done via `defface' too.
;;;; After 4.5:
;;; (`cperl-init-faces-weak'): use `cperl-force-face'.
;;; (`cperl-after-block-p'): After END/BEGIN we are a block.
;;; (`cperl-mode'): `font-lock-unfontify-region-function'
;;; was set to a wrong function.
;;; (`cperl-comment-indent'): Commenting __END__ was not working.
;;; (`cperl-indent-for-comment'): Likewise.
;;; (Indenting is still misbehaving at toplevel.)
;;;; After 4.5:
;;; (`cperl-unwind-to-safe'): Signature changed, unwinds end too.
;;; (`cperl-find-pods-heres'): mark qq[]-etc sections as syntax-type=string
;;; (`cperl-fontify-syntaxically'): Unwinds start and end to go out of
;;; long strings (not very successful).
;;; >>>> CPerl should be usable in write mode too now <<<<
;;; (`cperl-syntaxify-by-font-lock'): Better default - off in text-mode.
;;; (`cperl-tips'): Updated docs.
;;; (`cperl-problems'): Updated docs.
;;;; After 4.6:
;;; (`cperl-calculate-indent'): Did not consider `,' as continuation mark for statements.
;;; (`cperl-write-tags'): Correct for XEmacs's `visit-tags-table-buffer'.
;;;; After 4.7:
;;; (`cperl-calculate-indent'): Avoid parse-data optimization at toplevel.
;;; Should indent correctly at toplevel too.
;;; (`cperl-tags-hier-init'): Gross hack to pretend we work (are we?).
;;; (`cperl-find-pods-heres'): Was not processing sub protos after a comment ine.
;;; Was treating $a++ <= 5 as a glob.
;;;; After 4.8:
;;; (toplevel): require custom unprotected => failure on 19.28.
;;; (`cperl-xemacs-p') defined when compile too
;;; (`cperl-tags-hier-init'): Another try to work around XEmacs problems
;;; Better progress messages.
;;; (`cperl-find-tags'): Was writing line/pos in a wrong order,
;;; pos off by 1 and not at beg-of-line.
;;; (`cperl-etags-snarf-tag'): New macro
;;; (`cperl-etags-goto-tag-location'): New macro
;;; (`cperl-write-tags'): When removing old TAGS info was not
;;; relativizing filename
;;;; After 4.9:
;;; (`cperl-version'): New variable. New menu entry
;;;; After 4.10:
;;; (`cperl-tips'): Updated.
;;; (`cperl-non-problems'): Updated.
;;; random: References to future 20.3 removed.
;;;; After 4.11:
;;; (`perl-font-lock-keywords'): Would not highlight `sub foo($$);'.
;;; Docstrings: Menu was described as `CPerl' instead of `Perl'
;;;; After 4.12:
;;; (`cperl-toggle-construct-fix'): Was toggling to t instead of 1.
;;; (`cperl-ps-print-init'): Associate `cperl-array-face', `cperl-hash-face'
;;; remove `font-lock-emphasized-face'.
;;; remove `font-lock-other-emphasized-face'.
;;; remove `font-lock-reference-face'.
;;; remove `font-lock-keyword-face'.
;;; Use `eval-after-load'.
;;; (`cperl-init-faces'): remove init `font-lock-other-emphasized-face'.
;;; remove init `font-lock-emphasized-face'.
;;; remove init `font-lock-keyword-face'.
;;; (`cperl-tips-faces'): New variable and an entry into Mini-docs.
;;; (`cperl-indent-region'): Do not indent whitespace lines
;;; (`cperl-indent-exp'): Was not processing else-blocks.
;;; (`cperl-calculate-indent'): Remove another parse-data optimization
;;; at toplevel: would indent correctly.
;;; (`cperl-get-state'): NOP line removed.
;;;; After 4.13:
;;; (`cperl-ps-print-init'): Remove not-CPerl-related faces.
;;; (`cperl-ps-print'): New function and menu entry.
;;; (`cperl-ps-print-face-properties'): New configuration variable.
;;; (`cperl-invalid-face'): New configuration variable.
;;; (`cperl-nonoverridable-face'): New face. Renamed from
;;; `font-lock-other-type-face'.
;;; (`perl-font-lock-keywords'): Highlight trailing whitespace
;;; (`cperl-contract-levels'): Documentation corrected.
;;; (`cperl-contract-level'): Likewise.
;;;; After 4.14:
;;; (`cperl-ps-print'): `ps-print-face-extension-alist' was not in old Emaxen,
;;; same with `ps-extend-face-list'
;;; (`cperl-ps-extend-face-list'): New macro.
;;;; After 4.15:
;;; (`cperl-init-faces'): Interpolate `cperl-invalid-face'.
;;; (`cperl-forward-re'): Emit a meaningful error instead of a cryptic
;;; one for uncomplete REx near end-of-buffer.
;;; (`cperl-find-pods-heres'): Tolerate unfinished REx at end-of-buffer.
;;;; After 4.16:
;;; (`cperl-find-pods-heres'): `unwind-protect' was left commented.
;;;; After 4.17:
;;; (`cperl-invalid-face'): Change to ''underline.
;;;; After 4.18:
;;; (`cperl-find-pods-heres'): / and ? after : start a REx.
;;; (`cperl-after-expr-p'): Skip labels when checking
;;; (`cperl-calculate-indent'): Correct for labels when calculating
;;; indentation of continuations.
;;; Docstring updated.
;;;; After 4.19:
;;; Minor (mostly spelling) corrections from 20.3.3 merged.
;;;; After 4.20:
;;; (`cperl-tips'): Another workaround added. Sent to RMS for 20.4.
;;;; After 4.21:
;;; (`cperl-praise'): Mention linear-time indent.
;;; (`cperl-find-pods-heres'): @if ? a : b was considered a REx.
;;;; After 4.22:
;;; (`cperl-after-expr-p'): Make true after __END__.
;;; (`cperl-electric-pod'): "SYNOPSIS" was misspelled.
;;;; After 4.23:
;;; (`cperl-beautify-regexp-piece'): Was not allowing for *? after a class.
;;; Allow for POSIX char-classes.
;;; Remove trailing whitespace when
;;; adding new linebreak.
;;; Add a level counter to stop shallow.
;;; Indents unprocessed groups rigidly.
;;; (`cperl-beautify-regexp'): Add an optional count argument to go that
;;; many levels deep.
;;; (`cperl-beautify-level'): Likewise
;;; Menu: Add new entries to Regexp menu to do one level
;;; (`cperl-contract-level'): Was entering an infinite loop
;;; (`cperl-find-pods-heres'): Typo (double quoting).
;;; Was detecting < $file > as FH instead of glob.
;;; Support for comments in RExen (except
;;; for m#\#comment#x), governed by
;;; `cperl-regexp-scan'.
;;; (`cperl-regexp-scan'): New customization variable.
;;; (`cperl-forward-re'): Improve logic of resetting syntax table.
;;;; After 4.23 and: After 4.24:
;;; (`cperl-contract-levels'): Restore position.
;;; (`cperl-beautify-level'): Likewise.
;;; (`cperl-beautify-regexp'): Likewise.
;;; (`cperl-commentify'): Rudimental support for length=1 runs
;;; (`cperl-find-pods-heres'): Process 1-char long REx comments too /a#/x
;;; Processes REx-comments in #-delimited RExen.
;;; MAJOR BUG CORRECTED: after a misparse
;;; a body of a subroutine could be corrupted!!!
;;; One might need to reeval the function body
;;; to fix things. (A similar bug was
;;; present in `cperl-indent-region' eons ago.)
;;; To reproduce:
;; (defun foo () (let ((a '(t))) (insert (format "%s" a)) (setcar a 'BUG) t))
;; (foo)
;; (foo)
;;; C-x C-e the above three lines (at end-of-line). First evaluation
;;; of `foo' inserts (t), second one inserts (BUG) ?!
;;; In CPerl it was triggered by inserting then deleting `/' at start of
;;; / a (?# asdf {[(}asdf )ef,/;
;;;; After 4.25:
;;; (`cperl-commentify'): Was recognizing length=2 "strings" as length=1.
;;; (`imenu-example--create-perl-index'):
;;; Was not enforcing syntaxification-to-the-end.
;;; (`cperl-invert-if-unless'): Allow `for', `foreach'.
;;; (`cperl-find-pods-heres'): Quote `cperl-nonoverridable-face'.
;;; Mark qw(), m()x as indentable.
;;; (`cperl-init-faces'): Highlight `sysopen' too.
;;; Highlight $var in `for my $var' too.
;;; (`cperl-invert-if-unless'): Was leaving whitespace at end.
;;; (`cperl-linefeed'): Was splitting $var{$foo} if point after `{'.
;;; (`cperl-calculate-indent'): Remove old commented out code.
;;; Support (primitive) indentation of qw(), m()x.
;;;; After 4.26:
;;; (`cperl-problems'): Mention `fill-paragraph' on comment. \"" and
;;; q [] with intervening newlines.
;;; (`cperl-autoindent-on-semi'): New customization variable.
;;; (`cperl-electric-semi'): Use `cperl-autoindent-on-semi'.
;;; (`cperl-tips'): Mention how to make CPerl the default mode.
;;; (`cperl-mode'): Support `outline-minor-mode'
;;; (Thanks to Mark A. Hershberger).
;;; (`cperl-outline-level'): New function.
;;; (`cperl-highlight-variables-indiscriminately'): New customization var.
;;; (`cperl-init-faces'): Use `cperl-highlight-variables-indiscriminately'.
;;; (Thanks to Sean Kamath <>).
;;; (`cperl-after-block-p'): Support CHECK and INIT.
;;; (`cperl-init-faces'): Likewise and "our".
;;; (Thanks to Doug MacEachern <>).
;;; (`cperl-short-docs'): Likewise and "our".
;;;; After 4.27:
;;; (`cperl-find-pods-heres'): Recognize \"" as a string.
;;; Mark whitespace and comments between q and []
;;; as `syntax-type' => `prestring'.
;;; Allow whitespace between << and "FOO".
;;; (`cperl-problems'): Remove \"" and q [] with intervening newlines.
;;; Mention multiple <<EOF as unsupported.
;;; (`cperl-highlight-variables-indiscriminately'): Doc misprint fixed.
;;; (`cperl-indent-parens-as-block'): New configuration variable.
;;; (`cperl-calculate-indent'): Merge cases of indenting non-BLOCK groups.
;;; Use `cperl-indent-parens-as-block'.
;;; (`cperl-find-pods-heres'): Test for =cut without empty line instead of
;;; complaining about no =cut.
;;; (`cperl-electric-pod'): Change the REx for POD from "\n\n=" to "^\n=".
;;; (`cperl-find-pods-heres'): Likewise.
;;; (`cperl-electric-pod'): Change `forward-sexp' to `forward-word':
;;; POD could've been marked as comment already.
;;; (`cperl-unwind-to-safe'): Unwind before start of POD too.
;;;; After 4.28:
;;; (`cperl-forward-re'): Throw an error at proper moment REx unfinished.
;;;; After 4.29:
;;; (`x-color-defined-p'): Make an extra case to peacify the warning.
;;; Toplevel: `defvar' to peacify the warnings.
;;; (`cperl-find-pods-heres'): Could access `font-lock-comment-face' in -nw.
;;;; No -nw-compile time warnings now.
;;; (`cperl-find-tags'): TAGS file had too short substring-to-search.
;;; Be less verbose in non-interactive mode
;;; (`imenu-example--create-perl-index'): Set index-marker after name
;;; (`cperl-outline-regexp'): New variable.
;;; (`cperl-outline-level'): Made compatible with `cperl-outline-regexp'.
;;; (`cperl-mode'): Made use `cperl-outline-regexp'.
;;;; After 4.30:
;;; (`cperl-find-pods-heres'): =cut the last thing, no blank line, was error.
;;; (`cperl-outline-level'): Make start-of-file same level as `package'.
;;;; After 4.31:
;;; (`cperl-electric-pod'): `head1' and `over' electric only if empty.
;;; (`cperl-unreadable-ok'): New variable.
;;; (`cperl-find-tags'): Use `cperl-unreadable-ok', do not fail
;;; on an unreadable file
;;; (`cperl-write-tags'): Use `cperl-unreadable-ok', do not fail
;;; on an unreadable directory
;;;; After 4.32:
;;; Syncronized with v1.60 from Emacs 21.3.
;;; Mostly docstring and formatting changes, and:
;;; (`cperl-noscan-files-regexp'): Do not scan CVS subdirs
;;; (`cperl-problems'): Note that newer XEmacsen may syntaxify too
;;; (`imenu-example--create-perl-index'):
;;; Renamed to `cperl-imenu--create-perl-index'
;;; (`cperl-mode'): Replace `make-variable-buffer-local' by `make-local-variable'
;;; (`cperl-setup-tmp-buf'): Likewise
;;; (`cperl-fix-line-spacing'): Fix a misprint of "t" for "\t"
;;; (`cperl-next-bad-style'): Fix misprints in character literals
;;;; After 4.33:
;;; (`cperl-font-lock-keywords'): +etc: Aliased to perl-font-lock-keywords.
;;;; After 4.34:
;;; Further updates of whitespace and spelling w.r.t. RMS version.
;;; (`cperl-font-lock-keywords'): +etc: Avoid warnings when aliasing.
;;; (`cperl-mode'): Use `normal-auto-fill-function' if present.
;;; (`cperl-use-major-mode'): New variable
;;; (`cperl-can-font-lock'): New variable; replaces `window-system'
;;; (`cperl-tags-hier-init'): use `display-popup-menus-p' (if present)
;;; to choose `x-popup-menu' vs `tmm-prompt'
;;;; 4.35 has the following differences from version 1.40+ of RMS Emacs:
;;; New variables `cperl-use-major-mode', `cperl-can-font-lock';
;;; `cperl-use-major-mode' is (effectively) 'cperl-mode in RMS.
;;; `cperl-under-as-char' is nil in RMS.
;;; Minor differences in docstrings, and `cperl-non-problems'.
;;; Backward compatibility addressed: (`); (function (lambda ...)); font-lock;
;;; (:italic t bold t) vs (:slant italic :weight bold) in faces;
;;; `normal-auto-fill-function'.
;;; RMS version has wrong logic in `cperl-calculate-indent': $a = { } is
;;; wrongly indented if the closing brace is on a separate line.
;;; Different choice of ordering if's for is-x-REx and (eq (char-after b) ?\#)
;;; in `cperl-find-pods-heres'. [Cosmetic]
;;;; After 4.35:
;;; (`cperl-find-pods-heres'): If no end of HERE-doc found, mark to the end
;;; of buffer. This enables recognition of end
;;; of HERE-doc "as one types".
;;; Require "\n" after trailing tag of HERE-doc.
;;; \( made non-quoting outside of string/comment
;;; (gdj-contributed).
;;; Likewise for \$.
;;; Remove `here-doc-group' text property at start
;;; (makes this property reliable).
;;; Text property `first-format-line' ==> t.
;;; Do not recognize $opt_s and $opt::s as s///.
;;; (`cperl-perldoc'): Use case-sensitive search (contributed).
;;; (`cperl-fix-line-spacing'): Allow "_" in $vars of foreach etc. when
;;; underscore isn't a word char (gdj-contributed).
;;; (`defun-prompt-regexp'): Allow prototypes.
;;; (`cperl-vc-header-alist'): Extract numeric version from the Id.
;;; Toplevel: Put toggle-autohelp into the mode menu.
;;; Better docs for toggle/set/unset autohelp.
;;; (`cperl-electric-backspace-untabify'): New customization variable
;;; (`cperl-after-expr-p'): Works after here-docs, formats, and PODs too
;;; (affects many electric constructs).
;;; (`cperl-calculate-indent'): Takes into account `first-format-line' ==>
;;; works after format.
;;; (`cperl-short-docs'): Make it work with ... too.
;;; "array context" ==> "list context"
;;; (`cperl-electric-keyword'): make $if (etc: "$@%&*") non-electric
;;; '(' after keyword would insert a doubled paren
;;; (`cperl-electric-paren'): documented affected by `cperl-electric-parens'
;;; (`cperl-electric-rparen'): Likewise
;;; (`cperl-build-manpage'): New function by Nick Roberts
;;; (`cperl-perldoc'): Make it work in XEmacs too
;;;; After 4.36:
;;; (`cperl-find-pods-heres'): Recognize s => 1 and {s} (as a key or varname),
;;; { s:: } and { s::bar::baz } as varnames.
;;; (`cperl-after-expr-p'): Updates syntaxification before checks
;;; (`cperl-calculate-indent'): Likewise
;;; Fix wrong indent of blocks starting with POD
;;; (`cperl-after-block-p'): Optional argument for checking for a pre-block
;;; Recognize `continue' blocks too.
;;; (`cperl-electric-brace'): use `cperl-after-block-p' for detection;
;;; Now works for else/continue/sub blocks
;;; (`cperl-short-docs'): Minor edits; make messages fit 80-column screen
;;;; After 5.0:
;;; `cperl-add-tags-recurse-noxs-fullpath': new function (for -batch mode)
;;;; After 5.1:
;;;;;; Major edit. Summary of most visible changes:
;;;;;; a) Multiple <<HERE per line allowed.
;;;;;; b) Handles multiline subroutine declaration headers (with comments).
;;;;;; (The exception is `cperl-etags' - but it is not used in the rest
;;;;;; of the mode.)
;;;;;; c) Fontifies multiline my/our declarations (even with comments,
;;;;;; and with legacy `font-lock').
;;;;;; d) Major speedup of syntaxification, both immediate and postponed
;;;;;; (3.5x on the huge real-life document I tested).
;;;;;; e) New bindings, edits to imenu.
;;;;;; f) "_" is made into word-char during fontification/syntaxification;
;;;;;; some attempts to recognize non-word "_" during other operations too.
;;;;;; g) Detect bug in Emacs with `looking-at' inside `narrow' and bulk out.
;;;;;; h) autoload some more perldoc-related stuff
;;;;;; i) Some new convenience features: ISpell POD/HEREDOCs, narrow-to-HEREDOC
;;;;;; j) Attempt to incorporate XEmacs edits which reached me
;;;; Fine-grained changelog:
;;; `cperl-hook-after-change': New configuration variable
;;; `cperl-vc-sccs-header': Likewise
;;; `cperl-vc-sccs-header': Likewise
;;; `cperl-vc-header-alist': Default via two preceding variables
;;; `cperl-invalid-face': Remove double quoting under XEmacs
;;; (still needed under 21.2)
;;; `cperl-tips': Update URLs for resources
;;; `cperl-problems': Likewise
;;; `cperl-praise': Mention new features
;;; New C-c key bindings: for `cperl-find-bad-style',
;;; `cperl-pod-spell', `cperl-here-doc-spell', `cperl-narrow-to-here-doc',
;;; `cperl-perdoc', `cperl-perldoc-at-point'
;;; CPerl Mode menu changes: "Fix style by spaces", "Imenu on Perl Info"
;;; moved, new submenu of Tools with Ispell entries and narrowing.
;;; `cperl-after-sub-regexp': New defsubst
;;; `cperl-imenu--function-name-regexp-perl': Use `cperl-after-sub-regexp',
;;; Allows heads up to head4
;;; Allow "package;"
;;; `defun-prompt-regexp': Use `cperl-after-sub-regexp',
;;; `paren-backwards-message': ??? Something for XEmacs???
;;; `cperl-mode': Never auto-switch abbrev-mode off
;;; Try to allow '_' be non-word char
;;; Do not use `font-lock-unfontify-region-function' on XEmacs
;;; Reset syntax cache on mode start
;;; Support multiline facification (even
;;; on legacy `font-lock')
;;; `cperl-facemenu-add-face-function': ??? Some contributed code ???
;;; `cperl-after-change-function': Since `font-lock' and `lazy-lock'
;;; refuse to inform us whether the fontification is due to lazy
;;; calling or due to edit to a buffer, install our own hook
;;; (controlled by `cperl-hook-after-change')
;;; `cperl-electric-pod': =cut may have been recognized as start
;;; `cperl-block-p': Moved, updated for attributes
;;; `cperl-calculate-indent': Try to allow '_' be non-word char
;;; Support subs with attributes
;;; `cperl-where-am-i': Queit (?) a warning
;;; `cperl-cached-syntax-table' New function
;;; `cperl-forward-re': Use `cperl-cached-syntax-table'
;;; `cperl-unwind-to-safe': Recognize `syntax-type' property
;;; changing in a middle of line
;;; `cperl-find-sub-attrs': New function
;;; `cperl-find-pods-heres': Allow many <<EOP per line
;;; Allow subs with attributes
;;; Major speedups (3.5x on a real-life
;;; test file
;;; Recognize "extproc " (OS/2)
;;; case-folded and only at start
;;; /x on s///x with empty replacement was
;;; not recognized
;;; Better comments
;;; `cperl-after-block-p': Remarks on diff with `cperl-block-p'
;;; Allow subs with attributes, labels
;;; Do not confuse "else::foo" with "else"
;;; Minor optimizations...
;;; `cperl-after-expr-p': Try to allow '_' be non-word char
;;; `cperl-fill-paragraph': Try to detect a major bug in Emacs
;;; with `looking-at' inside `narrow' and bulk out if found
;;; `cperl-imenu--create-perl-index': Updates for new
;;; `cperl-imenu--function-name-regexp-perl'
;;; `cperl-outline-level': Likewise
;;; `cperl-init-faces': Allow multiline subroutine headers
;;; and my/our declarations, and ones with comments
;;; Allow subroutine attributes
;;; `cperl-imenu-on-info': Better docstring.
;;; `cperl-etags' Rudimentary support for attributes
;;; Support for packages and "package;"
;;; `cperl-add-tags-recurse-noxs': Better (?) docstring
;;; `cperl-add-tags-recurse-noxs-fullpath': Likewise
;;; `cperl-tags-hier-init': Misprint for `fboundp' fixed
;;; `cperl-not-bad-style-regexp': Try to allow '_' be non-word char
;;; `cperl-perldoc': Add autoload
;;; `cperl-perldoc-at-point': Likewise
;;; `cperl-here-doc-spell': New function
;;; `cperl-pod-spell': Likewise
;;; `cperl-map-pods-heres': Likewise
;;; `cperl-get-here-doc-region': Likewise
;;; `cperl-font-lock-fontify-region-function': Likewise (backward compatibility
;;; for legacy `font-lock')
;;; `cperl-font-lock-unfontify-region-function': Fix style
;;; `cperl-fontify-syntaxically': Recognize and optimize away
;;; deferred calls with no-change. Governed by `cperl-hook-after-change'
;;; `cperl-fontify-update': Recognize that syntaxification region
;;; can be larger than fontification one.
;;; XXXX we leave `cperl-postpone' property, so this is quadratic...
;;; `cperl-fontify-update-bad': Temporary placeholder until
;;; it is clear how to implement `cperl-fontify-update'.
;;; `cperl-time-fontification': New function
;;; `attrib-group': New text attribute
;;; `multiline': New value: `syntax-type' text attribute
;;;; After 5.2:
;;; `cperl-emulate-lazy-lock': New function
;;; `cperl-fontify-syntaxically': Would skip large regions
;;; Add `cperl-time-fontification', `cperl-emulate-lazy-lock' to menu
;;; Some globals were declared, but uninitialized
;;; Code:
(if (fboundp 'eval-when-compile)
(condition-case nil
(require 'custom)
(error nil))
(condition-case nil
(require 'man)
(error nil))
(defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
(defvar cperl-can-font-lock
(or cperl-xemacs-p
(and (boundp 'emacs-major-version)
(or window-system
(> emacs-major-version 20)))))
(if cperl-can-font-lock
(require 'font-lock))
(defvar msb-menu-cond)
(defvar gud-perldb-history)
(defvar font-lock-background-mode) ; not in Emacs
(defvar font-lock-display-type) ; ditto
(or (fboundp 'defgroup)
(defmacro defgroup (name val doc &rest arr)
(or (fboundp 'custom-declare-variable)
(defmacro defcustom (name val doc &rest arr)
(` (defvar (, name) (, val) (, doc)))))
(or (and (fboundp 'custom-declare-variable)
(string< "19.31" emacs-version)) ; Checked with 19.30: defface does not work
(defmacro defface (&rest arr)
;; Avoid warning (tmp definitions)
(or (fboundp 'x-color-defined-p)
(defmacro x-color-defined-p (col)
(cond ((fboundp 'color-defined-p) (` (color-defined-p (, col))))
;; XEmacs >= 19.12
((fboundp 'valid-color-name-p) (` (valid-color-name-p (, col))))
;; XEmacs 19.11
((fboundp 'x-valid-color-name-p) (` (x-valid-color-name-p (, col))))
(t '(error "Cannot implement color-defined-p")))))
(defmacro cperl-is-face (arg) ; Takes quoted arg
(cond ((fboundp 'find-face)
(` (find-face (, arg))))
(;;(and (fboundp 'face-list)
;; (face-list))
(fboundp 'face-list)
(` (member (, arg) (and (fboundp 'face-list)
(` (boundp (, arg))))))
(defmacro cperl-make-face (arg descr) ; Takes unquoted arg
(cond ((fboundp 'make-face)
(` (make-face (quote (, arg)))))
(` (defvar (, arg) (quote (, arg)) (, descr))))))
(defmacro cperl-force-face (arg descr) ; Takes unquoted arg
(` (progn
(or (cperl-is-face (quote (, arg)))
(cperl-make-face (, arg) (, descr)))
(or (boundp (quote (, arg))) ; We use unquoted variants too
(defvar (, arg) (quote (, arg)) (, descr))))))
(if cperl-xemacs-p
(defmacro cperl-etags-snarf-tag (file line)
(` (progn
(beginning-of-line 2)
(list (, file) (, line)))))
(defmacro cperl-etags-snarf-tag (file line)
(` (etags-snarf-tag))))
(if cperl-xemacs-p
(defmacro cperl-etags-goto-tag-location (elt)
;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
;; (set-buffer (get-file-buffer (elt (, elt) 0)))
;; Probably will not work due to some save-excursion???
;; Or save-file-position?
;; (message "Did I get to line %s?" (elt (, elt) 1))
(goto-line (string-to-int (elt (, elt) 1)))))
(defmacro cperl-etags-goto-tag-location (elt)
(` (etags-goto-tag-location (, elt)))))))
(defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
(defvar cperl-can-font-lock
(or cperl-xemacs-p
(and (boundp 'emacs-major-version)
(or window-system
(> emacs-major-version 20)))))
(condition-case nil
(require 'custom)
(error nil)) ; Already fixed by eval-when-compile
(defun cperl-choose-color (&rest list)
(let (answer)
(while list
(or answer
(if (or (x-color-defined-p (car list))
(null (cdr list)))
(setq answer (car list))))
(setq list (cdr list)))
(defgroup cperl nil
"Major mode for editing Perl code."
:prefix "cperl-"
:group 'languages)
(defgroup cperl-indentation-details nil
:prefix "cperl-"
:group 'cperl)
(defgroup cperl-affected-by-hairy nil
"Variables affected by `cperl-hairy'."
:prefix "cperl-"
:group 'cperl)
(defgroup cperl-autoinsert-details nil
"Auto-insert tuneup."
:prefix "cperl-"
:group 'cperl)
(defgroup cperl-faces nil
"Fontification colors."
:prefix "cperl-"
:group 'cperl)
(defgroup cperl-speed nil
"Speed vs. validity tuneup."
:prefix "cperl-"
:group 'cperl)
(defgroup cperl-help-system nil
"Help system tuneup."
:prefix "cperl-"
:group 'cperl)
(defcustom cperl-extra-newline-before-brace nil
"*Non-nil means that if, elsif, while, until, else, for, foreach
and do constructs look like:
if ()
instead of:
if () {
:type 'boolean
:group 'cperl-autoinsert-details)
(defcustom cperl-extra-newline-before-brace-multiline
"*Non-nil means the same as `cperl-extra-newline-before-brace', but
for constructs with multiline if/unless/while/until/for/foreach condition."
:type 'boolean
:group 'cperl-autoinsert-details)
(defcustom cperl-indent-level 2
"*Indentation of CPerl statements with respect to containing block."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-lineup-step nil
"*`cperl-lineup' will always lineup at multiple of this number.
If nil, the value of `cperl-indent-level' will be used."
:type '(choice (const nil) integer)
:group 'cperl-indentation-details)
(defcustom cperl-brace-imaginary-offset 0
"*Imagined indentation of a Perl open brace that actually follows a statement.
An open brace following other text is treated as if it were this far
to the right of the start of its line."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-brace-offset 0
"*Extra indentation for braces, compared with other text in same context."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-label-offset -2
"*Offset of CPerl label lines relative to usual indentation."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-min-label-indent 1
"*Minimal offset of CPerl label lines."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-continued-statement-offset 2
"*Extra indent for lines not starting new statements."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-continued-brace-offset 0
"*Extra indent for substatements that start with open-braces.
This is in addition to cperl-continued-statement-offset."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-close-paren-offset -1
"*Extra indent for substatements that start with close-parenthesis."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-auto-newline nil
"*Non-nil means automatically newline before and after braces,
and after colons and semicolons, inserted in CPerl code. The following
\\[cperl-electric-backspace] will remove the inserted whitespace.
Insertion after colons requires both this variable and
`cperl-auto-newline-after-colon' set."
:type 'boolean
:group 'cperl-autoinsert-details)
(defcustom cperl-autoindent-on-semi nil
"*Non-nil means automatically indent after insertion of (semi)colon.
Active if `cperl-auto-newline' is false."
:type 'boolean
:group 'cperl-autoinsert-details)
(defcustom cperl-auto-newline-after-colon nil
"*Non-nil means automatically newline even after colons.
Subject to `cperl-auto-newline' setting."
:type 'boolean
:group 'cperl-autoinsert-details)
(defcustom cperl-tab-always-indent t
"*Non-nil means TAB in CPerl mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used."
:type 'boolean
:group 'cperl-indentation-details)
(defcustom cperl-font-lock nil
"*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
Can be overwritten by `cperl-hairy' if nil."
:type '(choice (const null) boolean)
:group 'cperl-affected-by-hairy)
(defcustom cperl-electric-lbrace-space nil
"*Non-nil (and non-null) means { after $ should be preceded by ` '.
Can be overwritten by `cperl-hairy' if nil."
:type '(choice (const null) boolean)
:group 'cperl-affected-by-hairy)
(defcustom cperl-electric-parens-string "({[]})<"
"*String of parentheses that should be electric in CPerl.
Closing ones are electric only if the region is highlighted."
:type 'string
:group 'cperl-affected-by-hairy)
(defcustom cperl-electric-parens nil
"*Non-nil (and non-null) means parentheses should be electric in CPerl.
Can be overwritten by `cperl-hairy' if nil."
:type '(choice (const null) boolean)
:group 'cperl-affected-by-hairy)
(defvar zmacs-regions) ; Avoid warning
(defcustom cperl-electric-parens-mark
(and window-system
(or (and (boundp 'transient-mark-mode) ; For Emacs
(and (boundp 'zmacs-regions) ; For XEmacs
"*Not-nil means that electric parens look for active mark.
Default is yes if there is visual feedback on mark."
:type 'boolean
:group 'cperl-autoinsert-details)
(defcustom cperl-electric-linefeed nil
"*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
In any case these two mean plain and hairy linefeeds together.
Can be overwritten by `cperl-hairy' if nil."
:type '(choice (const null) boolean)
:group 'cperl-affected-by-hairy)
(defcustom cperl-electric-keywords nil
"*Not-nil (and non-null) means keywords are electric in CPerl.
Can be overwritten by `cperl-hairy' if nil."
:type '(choice (const null) boolean)
:group 'cperl-affected-by-hairy)
(defcustom cperl-electric-backspace-untabify t
"*Not-nil means electric-backspace will untabify in CPerl."
:type 'boolean
:group 'cperl-autoinsert-details)
(defcustom cperl-hairy nil
"*Not-nil means most of the bells and whistles are enabled in CPerl.
Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
`cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
`cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
:type 'boolean
:group 'cperl-affected-by-hairy)
(defcustom cperl-comment-column 32
"*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
:type 'integer
:group 'cperl-indentation-details)
(defcustom cperl-vc-sccs-header '("($sccs) = ('%W\%' =~ /(\\d+(\\.\\d+)+)/) ;")
"*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
:type '(repeat string)
:group 'cperl)
(defcustom cperl-vc-rcs-header '("($rcs) = (' $Id\$ ' =~ /(\\d+(\\.\\d+)+)/);")
"*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
:type '(repeat string)
:group 'cperl)
;; This became obsolete...
(defcustom cperl-vc-header-alist '()
"*What to use as `vc-header-alist' in CPerl.
Obsolete, with newer Emacsen use `cperl-vc-rcs-header' or
`cperl-vc-sccs-header' instead. If this list is empty, `vc-header-alist'
will be reconstructed basing on these two variables."
:type '(repeat (list symbol string))
:group 'cperl)
(defcustom cperl-clobber-mode-lists
(boundp 'interpreter-mode-alist)
(assoc "miniperl" interpreter-mode-alist)
(assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
"*Whether to install us into `interpreter-' and `extension' mode lists."
:type 'boolean
:group 'cperl)
(defcustom cperl-info-on-command-no-prompt nil
"*Not-nil (and non-null) means not to prompt on C-h f.
The opposite behaviour is always available if prefixed with C-c.
Can be overwritten by `cperl-hairy' if nil."
:type '(choice (const null) boolean)
:group 'cperl-affected-by-hairy)
(defcustom cperl-clobber-lisp-bindings nil
"*Not-nil (and non-null) means not overwrite C-h f.
The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
Can be overwritten by `cperl-hairy' if nil."
:type '(choice (const null) boolean)
:group 'cperl-affected-by-hairy)
(defcustom cperl-lazy-help-time nil
"*Not-nil (and non-null) means to show lazy help after given idle time.
Can be overwritten by `cperl-hairy' to be 5 sec if nil."
:type '(choice (const null) (const nil) integer)
:group 'cperl-affected-by-hairy)
(defcustom cperl-pod-face 'font-lock-comment-face
"*The result of evaluation of this expression is used for POD highlighting."
:type 'face
:group 'cperl-faces)
(defcustom cperl-pod-head-face 'font-lock-variable-name-face
"*The result of evaluation of this expression is used for POD highlighting.
Font for POD headers."
:type 'face
:group 'cperl-faces)
(defcustom cperl-here-face 'font-lock-string-face
"*The result of evaluation of this expression is used for here-docs highlighting."
:type 'face
:group 'cperl-faces)
;;; Some double-evaluation happened with font-locks... Needed with 21.2...
(defvar cperl-singly-quote-face cperl-xemacs-p)
(defcustom cperl-invalid-face ; Does not customize with '' on XEmacs
(if cperl-singly-quote-face
'underline ''underline) ; On older Emacsen was evaluated by `font-lock'
(if cperl-singly-quote-face
"*This face is used for highlighting trailing whitespace."
"*The result of evaluation of this expression highlights trailing whitespace.")
:type 'face
:group 'cperl-faces)
(defcustom cperl-pod-here-fontify '(featurep 'font-lock)
"*Not-nil after evaluation means to highlight POD and here-docs sections."
:type 'boolean
:group 'cperl-faces)
(defcustom cperl-fontify-m-as-s t
"*Not-nil means highlight 1arg regular expressions operators same as 2arg."
:type 'boolean
:group 'cperl-faces)
(defcustom cperl-highlight-variables-indiscriminately nil
"*Non-nil means perform additional highlighting on variables.
Currently only changes how scalar variables are highlighted.
Note that that variable is only read at initialization time for
the variable `perl-font-lock-keywords-2', so changing it after you've
entered CPerl mode the first time will have no effect."
:type 'boolean
:group 'cperl)
(defcustom cperl-pod-here-scan t
"*Not-nil means look for POD and here-docs sections during startup.
You can always make lookup from menu or using \\[cperl-find-pods-heres]."
:type 'boolean
:group 'cperl-speed)
(defcustom cperl-regexp-scan t
"*Not-nil means make marking of regular expression more thorough.
Effective only with `cperl-pod-here-scan'. Not implemented yet."
:type 'boolean
:group 'cperl-speed)
(defcustom cperl-hook-after-change t
"*Not-nil means install hook to know which regions of buffer are changed.
May significantly speed up delayed fontification. Changes take effect
after reload."
:type 'boolean
:group 'cperl-speed)
(defcustom cperl-imenu-addback nil
"*Not-nil means add backreferences to generated `imenu's.
May require patched `imenu' and `imenu-go'. Obsolete."
:type 'boolean
:group 'cperl-help-system)
(defcustom cperl-max-help-size 66
"*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
:type '(choice integer (const nil))
:group 'cperl-help-system)
(defcustom cperl-shrink-wrap-info-frame t
"*Non-nil means shrink-wrapping of info-buffer-frame allowed."
:type 'boolean
:group 'cperl-help-system)
(defcustom cperl-info-page "perl"
"*Name of the info page containing perl docs.
Older version of this page was called `perl5', newer `perl'."
:type 'string
:group 'cperl-help-system)
(defcustom cperl-use-syntax-table-text-property
(boundp 'parse-sexp-lookup-properties)
"*Non-nil means CPerl sets up and uses `syntax-table' text property."
:type 'boolean
:group 'cperl-speed)
(defcustom cperl-use-syntax-table-text-property-for-tags
"*Non-nil means: set up and use `syntax-table' text property generating TAGS."
:type 'boolean
:group 'cperl-speed)
(defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
"*Regexp to match files to scan when generating TAGS."
:type 'regexp
:group 'cperl)
(defcustom cperl-noscan-files-regexp
"*Regexp to match files/dirs to skip when generating TAGS."
:type 'regexp
:group 'cperl)
(defcustom cperl-regexp-indent-step nil
"*Indentation used when beautifying regexps.
If nil, the value of `cperl-indent-level' will be used."
:type '(choice integer (const nil))
:group 'cperl-indentation-details)
(defcustom cperl-indent-left-aligned-comments t
"*Non-nil means that the comment starting in leftmost column should indent."
:type 'boolean
:group 'cperl-indentation-details)
(defcustom cperl-under-as-char t
"*Non-nil means that the _ (underline) should be treated as word char."
:type 'boolean
:group 'cperl)
(defcustom cperl-extra-perl-args ""
"*Extra arguments to use when starting Perl.
Currently used with `cperl-check-syntax' only."
:type 'string
:group 'cperl)
(defcustom cperl-message-electric-keyword t
"*Non-nil means that the `cperl-electric-keyword' prints a help message."
:type 'boolean
:group 'cperl-help-system)
(defcustom cperl-indent-region-fix-constructs 1
"*Amount of space to insert between `}' and `else' or `elsif'
in `cperl-indent-region'. Set to nil to leave as is. Values other
than 1 and nil will probably not work."
:type '(choice (const nil) (const 1))
:group 'cperl-indentation-details)
(defcustom cperl-break-one-line-blocks-when-indent t
"*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
need to be reformatted into multiline ones when indenting a region."
:type 'boolean
:group 'cperl-indentation-details)
(defcustom cperl-fix-hanging-brace-when-indent t
"*Non-nil means that BLOCK-end `}' may be put on a separate line
when indenting a region.
Braces followed by else/elsif/while/until are excepted."
:type 'boolean
:group 'cperl-indentation-details)
(defcustom cperl-merge-trailing-else t
"*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
may be merged to be on the same line when indenting a region."
:type 'boolean
:group 'cperl-indentation-details)
(defcustom cperl-indent-parens-as-block nil
"*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
but for trailing \",\" inside the group, which won't increase indentation.
One should tune up `cperl-close-paren-offset' as well."
:type 'boolean
:group 'cperl-indentation-details)
(defcustom cperl-syntaxify-by-font-lock
(and cperl-can-font-lock
(boundp 'parse-sexp-lookup-properties))
"*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
:type '(choice (const message) boolean)
:group 'cperl-speed)
(defcustom cperl-syntaxify-unwind
"*Non-nil means that CPerl unwinds to a start of a long construction
when syntaxifying a chunk of buffer."
:type 'boolean
:group 'cperl-speed)
(defcustom cperl-ps-print-face-properties
'((font-lock-keyword-face nil nil bold shadow)
(font-lock-variable-name-face nil nil bold)
(font-lock-function-name-face nil nil bold italic box)
(font-lock-constant-face nil "LightGray" bold)
(cperl-array-face nil "LightGray" bold underline)
(cperl-hash-face nil "LightGray" bold italic underline)
(font-lock-comment-face nil "LightGray" italic)
(font-lock-string-face nil nil italic underline)
(cperl-nonoverridable-face nil nil italic underline)
(font-lock-type-face nil nil underline)
(underline nil "LightGray" strikeout))
"List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
:type '(repeat (cons symbol
(cons (choice (const nil) string)
(cons (choice (const nil) string)
(repeat symbol)))))
:group 'cperl-faces)
(if cperl-can-font-lock
(defvar cperl-dark-background
(cperl-choose-color "navy" "os2blue" "darkgreen"))
(defvar cperl-dark-foreground
(cperl-choose-color "orchid1" "orange"))
(defface cperl-nonoverridable-face
(` ((((class grayscale) (background light))
(:background "Gray90" :italic t :underline t))
(((class grayscale) (background dark))
(:foreground "Gray80" :italic t :underline t :bold t))
(((class color) (background light))
(:foreground "chartreuse3"))
(((class color) (background dark))
(:foreground (, cperl-dark-foreground)))
(t (:bold t :underline t))))
"Font Lock mode face used to highlight array names."
:group 'cperl-faces)
(defface cperl-array-face
(` ((((class grayscale) (background light))
(:background "Gray90" :bold t))
(((class grayscale) (background dark))
(:foreground "Gray80" :bold t))
(((class color) (background light))
(:foreground "Blue" :background "lightyellow2" :bold t))
(((class color) (background dark))
(:foreground "yellow" :background (, cperl-dark-background) :bold t))
(t (:bold t))))
"Font Lock mode face used to highlight array names."
:group 'cperl-faces)
(defface cperl-hash-face
(` ((((class grayscale) (background light))
(:background "Gray90" :bold t :italic t))
(((class grayscale) (background dark))
(:foreground "Gray80" :bold t :italic t))
(((class color) (background light))
(:foreground "Red" :background "lightyellow2" :bold t :italic t))
(((class color) (background dark))
(:foreground "Red" :background (, cperl-dark-background) :bold t :italic t))
(t (:bold t :italic t))))
"Font Lock mode face used to highlight hash names."
:group 'cperl-faces)))
;;; Short extra-docs.
(defvar cperl-tips 'please-ignore-this-line
"Get maybe newer version of this package from
Subdirectory `cperl-mode' may contain yet newer development releases and/or
patches to related files.
For best results apply to an older Emacs the patches from
\(this upgrades syntax-parsing abilities of RMS Emaxen v19.34 and
v20.2 up to the level of RMS Emacs v20.3 - a must for a good Perl
mode.) As of beginning of 2003, XEmacs may provide a similar ability.
Get support packages choose-color.el (or font-lock-extra.el before
19.30), imenu-go.el from the same place. \(Look for other files there
too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
later you should use choose-color.el *instead* of font-lock-extra.el
\(and you will not get smart highlighting in C :-().
Note that to enable Compile choices in the menu you need to install
If your Emacs does not default to `cperl-mode' on Perl files, and you
want it to: put the following into your .emacs file:
(autoload 'perl-mode \"cperl-mode\" \"alternate mode for editing Perl programs\" t)
(defalias 'perl-mode 'cperl-mode)
Get perl5-info from
Also, one can generate a newer documentation running `pod2texi' converter
If you use imenu-go, run imenu on perl5-info buffer (you can do it
from Perl menu). If many files are related, generate TAGS files from
Tools/Tags submenu in Perl menu.
If some class structure is too complicated, use Tools/Hierarchy-view
from Perl menu, or hierarchic view of imenu. The second one uses the
current buffer only, the first one requires generation of TAGS from
Perl/Tools/Tags menu beforehand.
Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
Switch auto-help on/off with Perl/Tools/Auto-help.
Though with contemporary Emaxen CPerl mode should maintain the correct
parsing of Perl even when editing, sometimes it may be lost. Fix this by
M-x norm RET
In cases of more severe confusion sometimes it is helpful to do
M-x load-l RET cperl-mode RET
M-x norm RET
\\[load-library] cperl-mode RET
Before reporting (non-)problems look in the problem section of online
micro-docs on what I know about CPerl problems.")
(defvar cperl-problems 'please-ignore-this-line
"Description of problems in CPerl mode.
Some faces will not be shown on some versions of Emacs unless you
install choose-color.el, available from
`fill-paragraph' on a comment may leave the point behind the
paragraph. Parsing of lines with several <<EOF is not implemented
Emacs had a _very_ restricted syntax parsing engine until RMS's Emacs
20.1. Most problems below are corrected starting from this version of
Emacs, and all of them should be fixed in RMS's version 20.3. (Or apply
patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
this respect (until 2003).
Note that even with newer Emacsen in some very rare cases the details
of interaction of `font-lock' and syntaxification may be not cleaned
up yet. You may get slightly different colors basing on the order of
fontification and syntaxification. Say, the initial faces is correct,
but editing the buffer breaks this.
Even with older Emacsen CPerl mode tries to corrects some Emacs
misunderstandings, however, for efficiency reasons the degree of
correction is different for different operations. The partially
corrected problems are: POD sections, here-documents, regexps. The
operations are: highlighting, indentation, electric keywords, electric
This may be confusing, since the regexp s#//#/#\; may be highlighted
as a comment, but it will be recognized as a regexp by the indentation
code. Or the opposite case, when a POD section is highlighted, but
may break the indentation of the following code (though indentation
should work if the balance of delimiters is not broken by POD).
The main trick (to make $ a \"backslash\") makes constructions like
${aaa} look like unbalanced braces. The only trick I can think of is
to insert it as $ {aaa} (legal in perl5, not in perl4).
Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
as /($|\\s)/. Note that such a transposition is not always possible.
The solution is to upgrade your Emacs or patch an older one. Note
that RMS's 20.2 has some bugs related to `syntax-table' text
properties. Patches are available on the main CPerl download site,
and on CPAN.
If these bugs cannot be fixed on your machine (say, you have an inferior
environment and cannot recompile), you may still disable all the fancy stuff
via `cperl-use-syntax-table-text-property'.")
(defvar cperl-non-problems 'please-ignore-this-line
"As you know from `problems' section, Perl syntax is too hard for CPerl on
older Emacsen. Here is what you can do if you cannot upgrade, or if
you want to switch off these capabilities on RMS Emacs 20.2 (+patches) or 20.3
or better. Please skip this docs if you run a capable Emacs already.
Most of the time, if you write your own code, you may find an equivalent
\(and almost as readable) expression (what is discussed below is usually
not relevant on newer Emacsen, since they can do it automatically).
Try to help CPerl: add comments with embedded quotes to fix CPerl
misunderstandings about the end of quotation:
$a='500$'; # ';
You won't need it too often. The reason: $ \"quotes\" the following
character (this saves a life a lot of times in CPerl), thus due to
Emacs parsing rules it does not consider tick (i.e., ' ) after a
dollar as a closing one, but as a usual character. This is usually
correct, but not in the above context.
Even with older Emacsen the indentation code is pretty wise. The only
drawback is that it relied on Emacs parsing to find matching
parentheses. And Emacs *could not* match parentheses in Perl 100%
correctly. So
1 if s#//#/#;
would not break indentation, but
1 if ( s#//#/# );
would. Upgrade.
By similar reasons
could confuse CPerl a lot.
If you still get wrong indentation in situation that you think the
code should be able to parse, try:
a) Check what Emacs thinks about balance of your parentheses.
b) Supply the code to me (IZ).
Pods were treated _very_ rudimentally. Here-documents were not
treated at all (except highlighting and inhibiting indentation). Upgrade.
To speed up coloring the following compromises exist:
a) sub in $mypackage::sub may be highlighted.
b) -z in [a-z] may be highlighted.
c) if your regexp contains a keyword (like \"s\"), it may be highlighted.
Imenu in 19.31 is broken. Set `imenu-use-keymap-menu' to t, and remove
`car' before `imenu-choose-buffer-index' in `imenu'.
`imenu-add-to-menubar' in 20.2 is broken.
A lot of things on XEmacs may be broken too, judging by bug reports I
receive. Note that some releases of XEmacs are better than the others
as far as bugs reports I see are concerned.")
(defvar cperl-praise 'please-ignore-this-line
"Advantages of CPerl mode.
0) It uses the newest `syntax-table' property ;-);
1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
mode - but the latter number may have improved too in last years) even
with old Emaxen which do not support `syntax-table' property.
When using `syntax-table' property for syntax assist hints, it should
handle 99.995% of lines correct - or somesuch. It automatically
updates syntax assist hints when you edit your script.
2) It is generally believed to be \"the most user-friendly Emacs
package\" whatever it may mean (I doubt that the people who say similar
things tried _all_ the rest of Emacs ;-), but this was not a lonely
3) Everything is customizable, one-by-one or in a big sweep;
4) It has many easily-accessable \"tools\":
a) Can run program, check syntax, start debugger;
b) Can lineup vertically \"middles\" of rows, like `=' in
a = b;
cc = d;
c) Can insert spaces where this impoves readability (in one
interactive sweep over the buffer);
d) Has support for imenu, including:
1) Separate unordered list of \"interesting places\";
2) Separate TOC of POD sections;
3) Separate list of packages;
4) Hierarchical view of methods in (sub)packages;
5) and functions (by the full name - with package);
e) Has an interface to INFO docs for Perl; The interface is
very flexible, including shrink-wrapping of
documentation buffer/frame;
f) Has a builtin list of one-line explanations for perl constructs.
g) Can show these explanations if you stay long enough at the
corresponding place (or on demand);
h) Has an enhanced fontification (using 3 or 4 additional faces
comparing to font-lock - basically, different
namespaces in Perl have different colors);
i) Can construct TAGS basing on its knowledge of Perl syntax,
the standard menu has 6 different way to generate
TAGS (if \"by directory\", .xs files - with C-language
bindings - are included in the scan);
j) Can build a hierarchical view of classes (via imenu) basing
on generated TAGS file;
k) Has electric parentheses, electric newlines, uses Abbrev
for electric logical constructs
while () {}
with different styles of expansion (context sensitive
to be not so bothering). Electric parentheses behave
\"as they should\" in a presence of a visible region.
l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
m) Can convert from
if (A) { B }
B if A;
n) Highlights (by user-choice) either 3-delimiters constructs
(such as tr/a/b/), or regular expressions and `y/tr';
o) Highlights trailing whitespace;
p) Is able to manipulate Perl Regular Expressions to ease
conversion to a more readable form.
q) Can ispell POD sections and HERE-DOCs.
5) The indentation engine was very smart, but most of tricks may be
not needed anymore with the support for `syntax-table' property. Has
progress indicator for indentation (with `imenu' loaded).
6) Indent-region improves inline-comments as well; also corrects
whitespace *inside* the conditional/loop constructs.
7) Fill-paragraph correctly handles multi-line comments;
8) Can switch to different indentation styles by one command, and restore
the settings present before the switch.
9) When doing indentation of control constructs, may correct
line-breaks/spacing between elements of the construct.
10) Uses a linear-time algorith for indentation of regions (on Emaxen with
capable syntax engines).")
(defvar cperl-speed 'please-ignore-this-line
"This is an incomplete compendium of what is available in other parts
of CPerl documentation. (Please inform me if I skept anything.)
There is a perception that CPerl is slower than alternatives. This part
of documentation is designed to overcome this misconception.
*By default* CPerl tries to enable the most comfortable settings.
From most points of view, correctly working package is infinitely more
comfortable than a non-correctly working one, thus by default CPerl
prefers correctness over speed. Below is the guide how to change
settings if your preferences are different.
A) Speed of loading the file. When loading file, CPerl may perform a
scan which indicates places which cannot be parsed by primitive Emacs
syntax-parsing routines, and marks them up so that either
A1) CPerl may work around these deficiencies (for big chunks, mostly
PODs and HERE-documents), or
A2) On capable Emaxen CPerl will use improved syntax-handlings
which reads mark-up hints directly.
The scan in case A2 is much more comprehensive, thus may be slower.
User can disable syntax-engine-helping scan of A2 by setting
variable to nil (if it is set to t).
One can disable the scan altogether (both A1 and A2) by setting
to nil.
B) Speed of editing operations.
One can add a (minor) speedup to editing operations by setting
variable to nil (if it is set to t). This will disable
syntax-engine-helping scan, thus will make many more Perl
constructs be wrongly recognized by CPerl, thus may lead to
wrongly matched parentheses, wrong indentation, etc.
One can unset `cperl-syntaxify-unwind'. This might speed up editing
of, say, long POD sections.")
(defvar cperl-tips-faces 'please-ignore-this-line
"CPerl mode uses following faces for highlighting:
`cperl-array-face' Array names
`cperl-hash-face' Hash names
`font-lock-comment-face' Comments, PODs and whatever is considered
syntaxically to be not code
`font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
2-arg operators s/y/tr/ or of RExen,
`font-lock-function-name-face' Special-cased m// and s//foo/, _ as
a target of a file tests, file tests,
subroutine names at the moment of definition
(except those conflicting with Perl operators),
package names (when recognized), format names
`font-lock-keyword-face' Control flow switch constructs, declarators
`cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
`font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
literal parts and the terminator of formats
and whatever is syntaxically considered
as string literals
`font-lock-type-face' Overridable keywords
`font-lock-variable-name-face' Variable declarations, indirect array and
hash names, POD headers/item names
`cperl-invalid-face' Trailing whitespace
Note that in several situations the highlighting tries to inform about
possible confusion, such as different colors for function names in
declarations depending on what they (do not) override, or special cases
m// and s/// which do not do what one would expect them to do.
Help with best setup of these faces for printout requested (for each of
the faces: please specify bold, italic, underline, shadow and box.)
\(Not finished.)")
;;; Portability stuff:
(defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
(` (define-key cperl-mode-map
(, (if xemacs-key
(` (if cperl-xemacs-p (, xemacs-key) (, emacs-key)))
(, definition))))
(defvar cperl-del-back-ch
(car (append (where-is-internal 'delete-backward-char)
(where-is-internal 'backward-delete-char-untabify)))
"Character generated by key bound to `delete-backward-char'.")
(and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
(setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
(defun cperl-mark-active () (mark)) ; Avoid undefined warning
(if cperl-xemacs-p
;; "Active regions" are on: use region only if active
;; "Active regions" are off: use region unconditionally
(defun cperl-use-region-p ()
(if zmacs-regions (mark) t)))
(defun cperl-use-region-p ()
(if transient-mark-mode mark-active t))
(defun cperl-mark-active () mark-active))
(defsubst cperl-enable-font-lock ()
(defun cperl-putback-char (c) ; Emacs 19
(set 'unread-command-events (list c))) ; Avoid undefined warning
(if (boundp 'unread-command-events)
(if cperl-xemacs-p
(defun cperl-putback-char (c) ; XEmacs >= 19.12
(setq unread-command-events (list (eval '(character-to-event c))))))
(defun cperl-putback-char (c) ; XEmacs <= 19.11
(set 'unread-command-event (eval '(character-to-event c))))) ; Avoid warnings
(or (fboundp 'uncomment-region)
(defun uncomment-region (beg end)
(interactive "r")
(comment-region beg end -1)))
(defvar cperl-do-not-fontify
(if (string< emacs-version "19.30")
"Text property which inhibits refontification.")
(defsubst cperl-put-do-not-fontify (from to &optional post)
;; If POST, do not do it with postponed fontification
(if (and post cperl-syntaxify-by-font-lock)
(put-text-property (max (point-min) (1- from))
to cperl-do-not-fontify t)))
(defcustom cperl-mode-hook nil
"Hook run by CPerl mode."
:type 'hook
:group 'cperl)
(defvar cperl-syntax-state nil)
(defvar cperl-syntax-done-to nil)
(defvar cperl-emacs-can-parse (> (length (save-excursion
(parse-partial-sexp (point) (point)))) 9))
;; Make customization possible "in reverse"
(defsubst cperl-val (symbol &optional default hairy)
((eq (symbol-value symbol) 'null) default)
(cperl-hairy (or hairy t))
(t (symbol-value symbol))))
;;; Probably it is too late to set these guys already, but it can help later:
(and cperl-clobber-mode-lists
(setq auto-mode-alist
(append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
(and (boundp 'interpreter-mode-alist)
(setq interpreter-mode-alist (append interpreter-mode-alist
'(("miniperl" . perl-mode))))))
(if (fboundp 'eval-when-compile)
(mapcar (lambda (p)
(condition-case nil
(require p)
(error nil)))
'(imenu easymenu etags timer man info))
(if (fboundp 'ps-extend-face-list)
(defmacro cperl-ps-extend-face-list (arg)
(` (ps-extend-face-list (, arg))))
(defmacro cperl-ps-extend-face-list (arg)
(` (error "This version of Emacs has no `ps-extend-face-list'"))))
;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
;; macros instead of defsubsts don't work on Emacs, so we do the
;; expansion manually. Any other suggestions?
(if cperl-can-font-lock
(require 'font-lock))
(require 'cl)))
(defvar cperl-mode-abbrev-table nil
"Abbrev table in use in CPerl mode buffers.")
(add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
(defvar cperl-mode-map () "Keymap used in CPerl mode.")
(if cperl-mode-map nil
(setq cperl-mode-map (make-sparse-keymap))
(cperl-define-key "{" 'cperl-electric-lbrace)
(cperl-define-key "[" 'cperl-electric-paren)
(cperl-define-key "(" 'cperl-electric-paren)
(cperl-define-key "<" 'cperl-electric-paren)
(cperl-define-key "}" 'cperl-electric-brace)
(cperl-define-key "]" 'cperl-electric-rparen)
(cperl-define-key ")" 'cperl-electric-rparen)
(cperl-define-key ";" 'cperl-electric-semi)
(cperl-define-key ":" 'cperl-electric-terminator)
(cperl-define-key "\C-j" 'newline-and-indent)
(cperl-define-key "\C-c\C-j" 'cperl-linefeed)
(cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
(cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
(cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
(cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
(cperl-define-key "\C-c\C-f" 'auto-fill-mode)
(cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
(cperl-define-key "\C-c\C-b" 'cperl-find-bad-style)
(cperl-define-key "\C-c\C-p" 'cperl-pod-spell)
(cperl-define-key "\C-c\C-d" 'cperl-here-doc-spell)
(cperl-define-key "\C-c\C-n" 'cperl-narrow-to-here-doc)
(cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
(cperl-define-key "\C-c\C-hp" 'cperl-perldoc)
(cperl-define-key "\C-c\C-hP" 'cperl-perldoc-at-point)
(cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
(cperl-define-key [?\C-\M-\|] 'cperl-lineup
[(control meta |)])
;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
(cperl-define-key "\177" 'cperl-electric-backspace)
(cperl-define-key "\t" 'cperl-indent-command)
;; don't clobber the backspace binding:
(cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
[(control c) (control h) F])
(if (cperl-val 'cperl-clobber-lisp-bindings)
(cperl-define-key "\C-hf"
;;(concat (char-to-string help-char) "f") ; does not work
[(control h) f])
(cperl-define-key "\C-hv"
;;(concat (char-to-string help-char) "v") ; does not work
[(control h) v])
(cperl-define-key "\C-c\C-hf"
;;(concat (char-to-string help-char) "f") ; does not work
(key-binding "\C-hf")
[(control c) (control h) f])
(cperl-define-key "\C-c\C-hv"
;;(concat (char-to-string help-char) "v") ; does not work
(key-binding "\C-hv")
[(control c) (control h) v]))
(cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
[(control c) (control h) f])
(cperl-define-key "\C-c\C-hv"
;;(concat (char-to-string help-char) "v") ; does not work
[(control c) (control h) v]))
(if (and cperl-xemacs-p
(<= emacs-minor-version 11) (<= emacs-major-version 19))
;; substitute-key-definition is usefulness-deenhanced...
(cperl-define-key "\M-q" 'cperl-fill-paragraph)
(cperl-define-key "\e;" 'cperl-indent-for-comment)
(cperl-define-key "\e\C-\\" 'cperl-indent-region))
'indent-sexp 'cperl-indent-exp
cperl-mode-map global-map)
'fill-paragraph 'cperl-fill-paragraph
cperl-mode-map global-map)
'indent-region 'cperl-indent-region
cperl-mode-map global-map)
'indent-for-comment 'cperl-indent-for-comment
cperl-mode-map global-map)))
(defvar cperl-menu)
(defvar cperl-lazy-installed)
(defvar cperl-old-style nil)
(condition-case nil
(require 'easymenu)
cperl-menu cperl-mode-map "Menu for CPerl mode"
["Beginning of function" beginning-of-defun t]
["End of function" end-of-defun t]
["Mark function" mark-defun t]
["Indent expression" cperl-indent-exp t]
["Fill paragraph/comment" cperl-fill-paragraph t]
["Line up a construction" cperl-lineup (cperl-use-region-p)]
["Invert if/unless/while etc" cperl-invert-if-unless t]
["Beautify" cperl-beautify-regexp
["Beautify one level deep" (cperl-beautify-regexp 1)
["Beautify a group" cperl-beautify-level
["Beautify a group one level deep" (cperl-beautify-level 1)
["Contract a group" cperl-contract-level
["Contract groups" cperl-contract-levels
["Insert spaces if needed to fix style" cperl-find-bad-style t]
["Refresh \"hard\" constructions" cperl-find-pods-heres t]
["Indent region" cperl-indent-region (cperl-use-region-p)]
["Comment region" cperl-comment-region (cperl-use-region-p)]
["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
["Run" mode-compile (fboundp 'mode-compile)]
["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
(get-buffer "*compilation*"))]
["Next error" next-error (get-buffer "*compilation*")]
["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
["Debugger" cperl-db t]
["Imenu" imenu (fboundp 'imenu)]
["Imenu on Perl Info" cperl-imenu-on-info (featurep 'imenu)]
["Ispell PODs" cperl-pod-spell
(get-text-property (point-min) 'in-pod)
(< (next-single-property-change (point-min) 'in-pod nil (point-max))
["Ispell HERE-DOCs" cperl-here-doc-spell
(< (next-single-property-change (point-min) 'here-doc-group nil (point-max)) (point-max))]
["Narrow to this HERE-DOC" cperl-narrow-to-here-doc
(eq 'here-doc (get-text-property (point) 'syntax-type))]
["CPerl pretty print (exprmntl)" cperl-ps-print
(fboundp 'ps-extend-face-list)]
["Profile syntaxification" cperl-time-fontification t]
["Debug errors in delayed fontification" cperl-emulate-lazy-lock t]
["Class Hierarchy from TAGS" cperl-tags-hier-init t]
;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
;;; ["Create tags for current file" cperl-etags t]
;;; ["Add tags for current file" (cperl-etags t) t]
;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
;;; ["Create tags for Perl files in (sub)directories"
;;; (cperl-etags nil 'recursive) t]
;;; ["Add tags for Perl files in (sub)directories"
;;; (cperl-etags t 'recursive) t])
;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
["Create tags for current file" (cperl-write-tags nil t) t]
["Add tags for current file" (cperl-write-tags) t]
["Create tags for Perl files in directory"
(cperl-write-tags nil t nil t) t]
["Add tags for Perl files in directory"
(cperl-write-tags nil nil nil t) t]
["Create tags for Perl files in (sub)directories"
(cperl-write-tags nil t t t) t]
["Add tags for Perl files in (sub)directories"
(cperl-write-tags nil nil t t) t]))
("Perl docs"
["Define word at point" imenu-go-find-at-position
(fboundp 'imenu-go-find-at-position)]
["Help on function" cperl-info-on-command t]
["Help on function at point" cperl-info-on-current-command t]
["Help on symbol at point" cperl-get-help t]
["Perldoc" cperl-perldoc t]
["Perldoc on word at point" cperl-perldoc-at-point t]
["View manpage of POD in this file" cperl-build-manpage t]
["Auto-help on" cperl-lazy-install
(and (fboundp 'run-with-idle-timer)
(not cperl-lazy-installed))]
["Auto-help off" cperl-lazy-unstall
(and (fboundp 'run-with-idle-timer)
["Auto newline" cperl-toggle-auto-newline t]
["Electric parens" cperl-toggle-electric t]
["Electric keywords" cperl-toggle-abbrev t]
["Fix whitespace on indent" cperl-toggle-construct-fix t]
["Auto-help on Perl constructs" cperl-toggle-autohelp t]
["Auto fill" auto-fill-mode t])
("Indent styles..."
["CPerl" (cperl-set-style "CPerl") t]
["PerlStyle" (cperl-set-style "PerlStyle") t]
["GNU" (cperl-set-style "GNU") t]
["C++" (cperl-set-style "C++") t]
["FSF" (cperl-set-style "FSF") t]
["BSD" (cperl-set-style "BSD") t]
["Whitesmith" (cperl-set-style "Whitesmith") t]
["Current" (cperl-set-style "Current") t]
["Memorized" (cperl-set-style-back) cperl-old-style])
["Tips" (describe-variable 'cperl-tips) t]
["Problems" (describe-variable 'cperl-problems) t]
["Non-problems" (describe-variable 'cperl-non-problems) t]
["Speed" (describe-variable 'cperl-speed) t]
["Praise" (describe-variable 'cperl-praise) t]
["Faces" (describe-variable 'cperl-tips-faces) t]
["CPerl mode" (describe-function 'cperl-mode) t]
["CPerl version"
(message "The version of master-file for this CPerl is %s"
cperl-version) t]))))
(error nil))
(autoload 'c-macro-expand "cmacexp"
"Display the result of expanding all C macros occurring in the region.
The expansion is entirely correct because it uses the C preprocessor."
;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
;;; `cperl-outline-regexp', `defun-prompt-regexp'.
;;; Details of groups in this may be used in several functions; see comments
;;; near mentioned above variable(s)...
;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
(defsubst cperl-after-sub-regexp (named attr) ; 9 groups without attr...
"Match the text after `sub' in a subroutine declaration.
If NAMED is nil, allows anonymous subroutines. Matches up to the first \":\"
of attributes (if present), or end of the name or prototype (whatever is
the last)."
(concat ; Assume n groups before this...
"\\(" ; n+1=name-group
"\\([ \t\n]+\\|#[^\n]*\n\\)+" ; n+2=pre-name
"\\(::[a-zA-Z_0-9:']+\\|[a-zA-Z_'][a-zA-Z_0-9:']*\\)" ; n+3=name
"\\)" ; END n+1=name-group
(if named "" "?")
"\\(" ; n+4=proto-group
"\\([ \t\n]+\\|#[^\n]*\n\\)*" ; n+5=pre-proto
"\\(([^()]*)\\)" ; n+6=prototype
"\\)?" ; END n+4=proto-group
"\\(" ; n+7=attr-group
"\\([ \t\n]+\\|#[^\n]*\n\\)*" ; n+8=pre-attr
"\\(" ; n+9=start-attr
(if attr (concat
"\\([ \t\n]+\\|#[^\n]*\n\\)*" ; whitespace-comments
"\\(\\sw\\|_\\)+" ; attr-name
;; attr-arg (1 level of internal parens allowed!)
"\\(" ; optional : (XXX allows trailing???)
"\\([ \t\n]+\\|#[^\n]*\n\\)*" ; whitespace-comments
"\\)?" ; END n+6=proto-group
;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
;;; and `cperl-outline-level'.
;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
(defvar cperl-imenu--function-name-regexp-perl
"^\\(" ; 1 = all
"\\([ \t]*package" ; 2 = package-group
"\\(" ; 3 = package-name-group
"\\([ \t\n]+\\|#[^\n]*\n\\)+" ; 4 = pre-package-name
"\\([a-zA-Z_0-9:']+\\)\\)?\\)" ; 5 = package-name
"[ \t]*sub"
(cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
"\\([ \t\n]+\\|#[^\n]*\n\\)*" ; 15=pre-block
"=head\\([1-4]\\)[ \t]+" ; 16=level
"\\([^\n]+\\)$" ; 17=text
(defvar cperl-outline-regexp
(concat cperl-imenu--function-name-regexp-perl "\\|" "\\`"))
(defvar cperl-mode-syntax-table nil
"Syntax table in use in CPerl mode buffers.")
(defvar cperl-string-syntax-table nil
"Syntax table in use in CPerl mode string-like chunks.")
(if cperl-mode-syntax-table
(setq cperl-mode-syntax-table (make-syntax-table))
(modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
(modify-syntax-entry ?/ "." cperl-mode-syntax-table)
(modify-syntax-entry ?* "." cperl-mode-syntax-table)
(modify-syntax-entry ?+ "." cperl-mode-syntax-table)
(modify-syntax-entry ?- "." cperl-mode-syntax-table)
(modify-syntax-entry ?= "." cperl-mode-syntax-table)
(modify-syntax-entry ?% "." cperl-mode-syntax-table)
(modify-syntax-entry ?< "." cperl-mode-syntax-table)
(modify-syntax-entry ?> "." cperl-mode-syntax-table)
(modify-syntax-entry ?& "." cperl-mode-syntax-table)
(modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
(modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
(modify-syntax-entry ?# "<" cperl-mode-syntax-table)
(modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
(modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
(if cperl-under-as-char
(modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
(modify-syntax-entry ?: "_" cperl-mode-syntax-table)
(modify-syntax-entry ?| "." cperl-mode-syntax-table)
(setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
(modify-syntax-entry ?$ "." cperl-string-syntax-table)
(modify-syntax-entry ?# "." cperl-string-syntax-table)) ; (?# comment )
;; provide an alias for working with emacs 19. the perl-mode that comes
;; with it is really bad, and this lets us seamlessly replace it.
(fset 'perl-mode 'cperl-mode)
(defvar cperl-faces-init nil)
;; Fix for msb.el
(defvar cperl-msb-fixed nil)
(defvar font-lock-syntactic-keywords)
(defvar perl-font-lock-keywords)
(defvar perl-font-lock-keywords-1)
(defvar perl-font-lock-keywords-2)
(defvar outline-level)
(if (fboundp 'defvaralias)
(let ((f 'defvaralias)) ; Some functions deduce stuff from the mode name...
(funcall f 'cperl-font-lock-keywords 'perl-font-lock-keywords)
(funcall f 'cperl-font-lock-keywords-1 'perl-font-lock-keywords-1)
(funcall f 'cperl-font-lock-keywords-2 'perl-font-lock-keywords-2)))
(defvar cperl-use-major-mode 'perl-mode)
(defvar cperl-font-lock-multiline-start nil)
(defvar cperl-font-lock-multiline nil)
(defvar cperl-compilation-error-regexp-alist nil)
(defun cperl-mode ()
"Major mode for editing Perl code.
Expression and list commands understand all C brackets.
Tab indents for Perl code.
Paragraphs are separated by blank lines only.
Delete converts tabs to spaces as it moves back.
Various characters in Perl almost always come in pairs: {}, (), [],
sometimes <>. When the user types the first, she gets the second as
well, with optional special formatting done on {}. (Disabled by
default.) You can always quote (with \\[quoted-insert]) the left
\"paren\" to avoid the expansion. The processing of < is special,
since most the time you mean \"less\". CPerl mode tries to guess
whether you want to type pair <>, and inserts is if it
appropriate. You can set `cperl-electric-parens-string' to the string that
contains the parenths from the above list you want to be electrical.
Electricity of parenths is controlled by `cperl-electric-parens'.
You may also set `cperl-electric-parens-mark' to have electric parens
look for active mark and \"embrace\" a region if possible.'
CPerl mode provides expansion of the Perl control constructs:
if, else, elsif, unless, while, until, continue, do,
for, foreach, formy and foreachmy.
and POD directives (Disabled by default, see `cperl-electric-keywords'.)
The user types the keyword immediately followed by a space, which
causes the construct to be expanded, and the point is positioned where
she is most likely to want to be. eg. when the user types a space
following \"if\" the following appears in the buffer: if () { or if ()
} { } and the cursor is between the parentheses. The user can then
type some boolean expression within the parens. Having done that,
typing \\[cperl-linefeed] places you - appropriately indented - on a
new line between the braces (if you typed \\[cperl-linefeed] in a POD
directive line, then appropriate number of new lines is inserted).
If CPerl decides that you want to insert \"English\" style construct like
bite if angry;
it will not do any expansion. See also help on variable
`cperl-extra-newline-before-brace'. (Note that one can switch the
help message on expansion by setting `cperl-message-electric-keyword'
to nil.)
\\[cperl-linefeed] is a convenience replacement for typing carriage
return. It places you in the next line with proper indentation, or if
you type it inside the inline block of control construct, like
foreach (@lines) {print; print}
and you are on a boundary of a statement inside braces, it will
transform the construct into a multiline and will place you into an
appropriately indented blank line. If you need a usual
`newline-and-indent' behaviour, it is on \\[newline-and-indent],
see documentation on `cperl-electric-linefeed'.
Use \\[cperl-invert-if-unless] to change a construction of the form
if (A) { B }
B if A;
Setting the variable `cperl-font-lock' to t switches on font-lock-mode
\(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
on electric space between $ and {, `cperl-electric-parens-string' is
the string that contains parentheses that should be electric in CPerl
\(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
setting `cperl-electric-keywords' enables electric expansion of
control structures in CPerl. `cperl-electric-linefeed' governs which
one of two linefeed behavior is preferable. You can enable all these
options simultaneously (recommended mode of use) by setting
`cperl-hairy' to t. In this case you can switch separate options off
by setting them to `null'. Note that one may undo the extra
whitespace inserted by semis and braces in `auto-newline'-mode by
consequent \\[cperl-electric-backspace].
If your site has perl5 documentation in info format, you can use commands
\\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
These keys run commands `cperl-info-on-current-command' and
`cperl-info-on-command', which one is which is controlled by variable
`cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
\(in turn affected by `cperl-hairy').
Even if you have no info-format documentation, short one-liner-style
help is available on \\[cperl-get-help], and one can run perldoc or
man via menu.
It is possible to show this help automatically after some idle time.
This is regulated by variable `cperl-lazy-help-time'. Default with
`cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
secs idle time . It is also possible to switch this on/off from the
menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
Use \\[cperl-lineup] to vertically lineup some construction - put the
beginning of the region at the start of construction, and make region
span the needed amount of lines.
Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
`cperl-pod-face', `cperl-pod-head-face' control processing of POD and
here-docs sections. With capable Emaxen results of scan are used
for indentation too, otherwise they are used for highlighting only.
Variables controlling indentation style:
Non-nil means TAB in CPerl mode should always reindent the current line,
regardless of where in the line point is when the TAB command is used.
Non-nil means that the comment starting in leftmost column should indent.
Non-nil means automatically newline before and after braces,
and after colons and semicolons, inserted in Perl code. The following
\\[cperl-electric-backspace] will remove the inserted whitespace.
Insertion after colons requires both this variable and
`cperl-auto-newline-after-colon' set.
Non-nil means automatically newline even after colons.
Subject to `cperl-auto-newline' setting.
Indentation of Perl statements within surrounding block.
The surrounding block's indentation is the indentation
of the line on which the open-brace appears.
Extra indentation given to a substatement, such as the
then-clause of an if, or body of a while, or just a statement continuation.
Extra indentation given to a brace that starts a substatement.
This is in addition to `cperl-continued-statement-offset'.
Extra indentation for line if it starts with an open brace.
An open brace following other text is treated as if it the line started
this far to the right of the actual line indentation.
Extra indentation for line that is a label.
Minimal indentation for line that is a label.
Settings for K&R and BSD indentation styles are
`cperl-indent-level' 5 8
`cperl-continued-statement-offset' 5 8
`cperl-brace-offset' -5 -8
`cperl-label-offset' -5 -8
CPerl knows several indentation styles, and may bulk set the
corresponding variables. Use \\[cperl-set-style] to do this. Use
\\[cperl-set-style-back] to restore the memorized preexisting values
\(both available from menu).
If `cperl-indent-level' is 0, the statement after opening brace in
column 0 is indented on
Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
with no args.
DO NOT FORGET to read micro-docs (available from `Perl' menu)
or as help on variables `cperl-tips', `cperl-problems',
`cperl-non-problems', `cperl-praise', `cperl-speed'."
(use-local-map cperl-mode-map)
(if (cperl-val 'cperl-electric-linefeed)
(local-set-key "\C-J" 'cperl-linefeed)
(local-set-key "\C-C\C-J" 'newline-and-indent)))
(if (and
(cperl-val 'cperl-clobber-lisp-bindings)
(cperl-val 'cperl-info-on-command-no-prompt))
;; don't clobber the backspace binding:
(cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
(cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
[(control c) (control h) f])))
(setq major-mode cperl-use-major-mode)
(setq mode-name "CPerl")
(if (not cperl-mode-abbrev-table)
(let ((prev-a-c abbrevs-changed))
(define-abbrev-table 'cperl-mode-abbrev-table '(
("if" "if" cperl-electric-keyword 0)
("elsif" "elsif" cperl-electric-keyword 0)
("while" "while" cperl-electric-keyword 0)
("until" "until" cperl-electric-keyword 0)
("unless" "unless" cperl-electric-keyword 0)
("else" "else" cperl-electric-else 0)
("continue" "continue" cperl-electric-else 0)
("for" "for" cperl-electric-keyword 0)
("foreach" "foreach" cperl-electric-keyword 0)
("formy" "formy" cperl-electric-keyword 0)
("foreachmy" "foreachmy" cperl-electric-keyword 0)
("do" "do" cperl-electric-keyword 0)
("=pod" "=pod" cperl-electric-pod 0)
("=over" "=over" cperl-electric-pod 0)
("=head1" "=head1" cperl-electric-pod 0)
("=head2" "=head2" cperl-electric-pod 0)
("pod" "pod" cperl-electric-pod 0)
("over" "over" cperl-electric-pod 0)
("head1" "head1" cperl-electric-pod 0)
("head2" "head2" cperl-electric-pod 0)))
(setq abbrevs-changed prev-a-c)))
(setq local-abbrev-table cperl-mode-abbrev-table)
(if (cperl-val 'cperl-electric-keywords)
(abbrev-mode 1))
(set-syntax-table cperl-mode-syntax-table)
;; Until Emacs is multi-threaded, we do not actually need it local:
(make-local-variable 'cperl-font-lock-multiline-start)
(make-local-variable 'outline-regexp)
;; (setq outline-regexp imenu-example--function-name-regexp-perl)
(setq outline-regexp cperl-outline-regexp)
(make-local-variable 'outline-level)
(setq outline-level 'cperl-outline-level)
(make-local-variable 'paragraph-start)
(setq paragraph-start (concat "^$\\|" page-delimiter))
(make-local-variable 'paragraph-separate)
(setq paragraph-separate paragraph-start)
(make-local-variable 'paragraph-ignore-fill-prefix)
(setq paragraph-ignore-fill-prefix t)
(if cperl-xemacs-p
(make-local-variable 'paren-backwards-message)
(set 'paren-backwards-message t)))
(make-local-variable 'indent-line-function)
(setq indent-line-function 'cperl-indent-line)
(make-local-variable 'require-final-newline)
(setq require-final-newline t)
(make-local-variable 'comment-start)
(setq comment-start "# ")
(make-local-variable 'comment-end)
(setq comment-end "")
(make-local-variable 'comment-column)
(setq comment-column cperl-comment-column)
(make-local-variable 'comment-start-skip)
(setq comment-start-skip "#+ *")
(make-local-variable 'defun-prompt-regexp)
;;; "[ \t]*sub"
;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
;;; "\\([ \t\n]+\\|#[^\n]*\n\\)*" ; 15=pre-block
(setq defun-prompt-regexp
(concat "[ \t]*sub"
(cperl-after-sub-regexp 'named 'attr-groups)
"\\([ \t\n]+\\|#[^\n]*\n\\)*"))
(make-local-variable 'comment-indent-function)
(setq comment-indent-function 'cperl-comment-indent)
(make-local-variable 'parse-sexp-ignore-comments)
(setq parse-sexp-ignore-comments t)
(make-local-variable 'indent-region-function)
(setq indent-region-function 'cperl-indent-region)
;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
(make-local-variable 'imenu-create-index-function)
(setq imenu-create-index-function
(function cperl-imenu--create-perl-index))
(make-local-variable 'imenu-sort-function)
(setq imenu-sort-function nil)
(make-local-variable 'vc-rcs-header)
(set 'vc-rcs-header cperl-vc-rcs-header)
(make-local-variable 'vc-sccs-header)
(set 'vc-sccs-header cperl-vc-sccs-header)
;; This one is obsolete...
(make-local-variable 'vc-header-alist)
(set 'vc-header-alist (or cperl-vc-header-alist ; Avoid warning
(` ((SCCS (, (car cperl-vc-sccs-header)))
(RCS (, (car cperl-vc-rcs-header)))))))
(cond ((boundp 'compilation-error-regexp-alist-alist);; xemacs 20.x
(make-local-variable 'compilation-error-regexp-alist-alist)
(set 'compilation-error-regexp-alist-alist
(cons (cons 'cperl cperl-compilation-error-regexp-alist)
(symbol-value 'compilation-error-regexp-alist-alist)))
(let ((f 'compilation-build-compilation-error-regexp-alist))
(funcall f)))
((boundp 'compilation-error-regexp-alist);; xmeacs 19.x
(make-local-variable 'compilation-error-regexp-alist)
(set 'compilation-error-regexp-alist
(cons cperl-compilation-error-regexp-alist
(symbol-value 'compilation-error-regexp-alist)))))
(make-local-variable 'font-lock-defaults)
(setq font-lock-defaults
((string< emacs-version "19.30")
'(perl-font-lock-keywords-2 nil nil ((?_ . "w"))))
((string< emacs-version "19.33") ; Which one to use?
perl-font-lock-keywords-2) nil nil ((?_ . "w"))))
cperl-load-font-lock-keywords-2) nil nil ((?_ . "w"))))))
(make-local-variable 'cperl-syntax-state)
(setq cperl-syntax-state nil) ; reset syntaxification cache
(if cperl-use-syntax-table-text-property
(make-local-variable 'parse-sexp-lookup-properties)
;; Do not introduce variable if not needed, we check it!
(set 'parse-sexp-lookup-properties t)
;; Fix broken font-lock:
(or (boundp 'font-lock-unfontify-region-function)
(set 'font-lock-unfontify-region-function
(unless cperl-xemacs-p ; Our: just a plug for wrong font-lock
(make-local-variable 'font-lock-unfontify-region-function)
(set 'font-lock-unfontify-region-function ; not present with old Emacs
(make-local-variable 'cperl-syntax-done-to)
(setq cperl-syntax-done-to nil) ; reset syntaxification cache
;; Another bug: unless font-lock-syntactic-keywords, font-lock
;; ignores syntax-table text-property. (t) is a hack
;; to make font-lock think that font-lock-syntactic-keywords
;; are defined
(make-local-variable 'font-lock-syntactic-keywords)
(setq font-lock-syntactic-keywords
(if cperl-syntaxify-by-font-lock
'(t (cperl-fontify-syntaxically))
(if (boundp 'font-lock-multiline) ; Newer font-lock; use its facilities
(setq cperl-font-lock-multiline t) ; Not localized...
(set 'font-lock-multiline t)) ; not present with old Emacs; auto-local
(make-local-variable 'font-lock-fontify-region-function)
(set 'font-lock-fontify-region-function ; not present with old Emacs
(make-local-variable 'font-lock-fontify-region-function)
(set 'font-lock-fontify-region-function ; not present with old Emacs
(make-local-variable 'cperl-old-style)
(if (boundp 'normal-auto-fill-function) ; 19.33 and later
(set (make-local-variable 'normal-auto-fill-function)
'cperl-do-auto-fill) ; RMS has it as #'cperl-do-auto-fill ???
(or (fboundp 'cperl-old-auto-fill-mode)
(fset 'cperl-old-auto-fill-mode (symbol-function 'auto-fill-mode))
(defun auto-fill-mode (&optional arg)
(interactive "P")
(eval '(cperl-old-auto-fill-mode arg)) ; Avoid a warning
(and auto-fill-function (memq major-mode '(perl-mode cperl-mode))
(setq auto-fill-function 'cperl-do-auto-fill))))))
(if (cperl-enable-font-lock)
(if (cperl-val 'cperl-font-lock)
(progn (or cperl-faces-init (cperl-init-faces))
(font-lock-mode 1))))
(set (make-local-variable 'facemenu-add-face-function)
'cperl-facemenu-add-face-function) ; XXXX What this guy is for???
(and (boundp 'msb-menu-cond)
(not cperl-msb-fixed)
(if (featurep 'easymenu)
(easy-menu-add cperl-menu)) ; A NOP in RMS Emacs.
(run-hooks 'cperl-mode-hook)
(if cperl-hook-after-change
(make-local-hook 'after-change-functions)
(add-hook 'after-change-functions 'cperl-after-change-function nil t)))
;; After hooks since fontification will break this
(if cperl-pod-here-scan
(or cperl-syntaxify-by-font-lock
(progn (or cperl-faces-init (cperl-init-faces-weak))
;; Fix for perldb - make default reasonable
(defun cperl-db ()
(require 'gud)
(perldb (read-from-minibuffer "Run perldb (like this): "
(if (consp gud-perldb-history)
(car gud-perldb-history)
(concat "perl " ;;(file-name-nondirectory
;; I have problems
;; in OS/2
;; otherwise
nil nil
'(gud-perldb-history . 1))))
(defun cperl-msb-fix ()
;; Adds perl files to msb menu, supposes that msb is already loaded
(setq cperl-msb-fixed t)
(let* ((l (length msb-menu-cond))
(last (nth (1- l) msb-menu-cond))
(precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
(handle (1- (nth 1 last))))
(setcdr precdr (list
'(memq major-mode '(cperl-mode perl-mode))
"Perl Files (%d)")
;; This is used by indent-for-comment
;; to decide how much to indent a comment in CPerl code
;; based on its context. Do fallback if comment is found wrong.
(defvar cperl-wrong-comment)
(defvar cperl-st-cfence '(14)) ; Comment-fence
(defvar cperl-st-sfence '(15)) ; String-fence
(defvar cperl-st-punct '(1))
(defvar cperl-st-word '(2))
(defvar cperl-st-bra '(4 . ?\>))
(defvar cperl-st-ket '(5 . ?\<))
(defun cperl-comment-indent ()
(let ((p (point)) (c (current-column)) was phony)
(if (looking-at "^#") 0 ; Existing comment at bol stays there.
;; Wrong comment found
(setq was (cperl-to-comment-or-eol)
phony (eq (get-text-property (point) 'syntax-table)
(if phony
(re-search-forward "#\\|$") ; Hmm, what about embedded #?
(if (eq (preceding-char) ?\#)
(forward-char -1))
(setq was nil)))
(if (= (point) p)
(skip-chars-backward " \t")
(max (1+ (current-column)) ; Else indent at comment column
(if was nil
(insert comment-start)
(backward-char (length comment-start)))
(setq cperl-wrong-comment t)
(indent-to comment-column 1) ; Indent minimum 1
c))))) ; except leave at least one space.
;;;(defun cperl-comment-indent-fallback ()
;;; "Is called if the standard comment-search procedure fails.
;;;Point is at start of real comment."
;;; (let ((c (current-column)) target cnt prevc)
;;; (if (= c comment-column) nil
;;; (setq cnt (skip-chars-backward "[ \t]"))
;;; (setq target (max (1+ (setq prevc
;;; (current-column))) ; Else indent at comment column
;;; comment-column))
;;; (if (= c comment-column) nil
;;; (delete-backward-char cnt)
;;; (while (< prevc target)
;;; (insert "\t")
;;; (setq prevc (current-column)))
;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
;;; (while (< prevc target)
;;; (insert " ")
;;; (setq prevc (current-column)))))))
(defun cperl-indent-for-comment ()
"Substitute for `indent-for-comment' in CPerl."
(let (cperl-wrong-comment)
(if cperl-wrong-comment
(progn (cperl-to-comment-or-eol)
(forward-char (length comment-start))))))
(defun cperl-comment-region (b e arg)
"Comment or uncomment each line in the region in CPerl mode.
See `comment-region'."
(interactive "r\np")
(let ((comment-start "#"))
(comment-region b e arg)))
(defun cperl-uncomment-region (b e arg)
"Uncomment or comment each line in the region in CPerl mode.
See `comment-region'."
(interactive "r\np")
(let ((comment-start "#"))
(comment-region b e (- arg))))
(defvar cperl-brace-recursing nil)
(defun cperl-electric-brace (arg &optional only-before)
"Insert character and correct line's indentation.
If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
place (even in empty line), but not after. If after \")\" and the inserted
char is \"{\", insert extra newline before only if
(interactive "P")
(let (insertpos
(other-end (if (and cperl-electric-parens-mark
(< (mark) (point)))
(if (and other-end
(not cperl-brace-recursing)
(cperl-val 'cperl-electric-parens)
(>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
;; Need to insert a matching pair
(setq insertpos (point-marker))
(goto-char other-end)
(setq last-command-char ?\{)
(cperl-electric-lbrace arg insertpos))
(forward-char 1))
;; Check whether we close something "usual" with `}'
(if (and (eq last-command-char ?\})
(condition-case nil
(up-list (- (prefix-numeric-value arg)))
;;(cperl-after-block-p (point-min))
(or (cperl-after-expr-p nil "{;)")
;; after sub, else, continue
(cperl-after-block-p nil 'pre)))
(error nil))))
;; Just insert the guy
(self-insert-command (prefix-numeric-value arg))
(if (and (not arg) ; No args, end (of empty line or auto)
(or (and (null only-before)
(skip-chars-backward " \t")
(and (eq last-command-char ?\{) ; Do not insert newline
;; if after ")" and `cperl-extra-newline-before-brace'
;; is nil, do not insert extra newline.
(not cperl-extra-newline-before-brace)
(skip-chars-backward " \t")
(eq (preceding-char) ?\))))
(if cperl-auto-newline
(progn (cperl-indent-line) (newline) t) nil)))
(self-insert-command (prefix-numeric-value arg))
(if cperl-auto-newline
(setq insertpos (1- (point))))
(if (and cperl-auto-newline (null only-before))
(if insertpos (progn (goto-char insertpos)
(search-forward (make-string
1 last-command-char))
(setq insertpos (1- (point)))))
(delete-char -1))))
(if insertpos
(goto-char insertpos)
(self-insert-command (prefix-numeric-value arg)))
(self-insert-command (prefix-numeric-value arg)))))))
(defun cperl-electric-lbrace (arg &optional end)
"Insert character, correct line's indentation, correct quoting by space."
(interactive "P")
(let ((cperl-brace-recursing t)
(cperl-auto-newline cperl-auto-newline)
(other-end (or end
(if (and cperl-electric-parens-mark
(> (mark) (point)))
(goto-char (mark))
pos after)
(and (cperl-val 'cperl-electric-lbrace-space)
(eq (preceding-char) ?$)
(skip-chars-backward "$")
(looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
(insert ?\ ))
;; Check whether we are in comment
(if (and
(not (looking-at "[ \t]*#")))
(cperl-after-expr-p nil "{;)"))
(setq cperl-auto-newline nil))
(cperl-electric-brace arg)
(and (cperl-val 'cperl-electric-parens)
(eq last-command-char ?{)
(memq last-command-char
(append cperl-electric-parens-string nil))
(or (if other-end (goto-char (marker-position other-end)))
(setq last-command-char ?} pos (point))
(progn (cperl-electric-brace arg t)
(goto-char pos)))))
(defun cperl-electric-paren (arg)
"Insert an opening parenthesis or a matching pair of parentheses.
See `cperl-electric-parens'."
(interactive "P")
(let ((beg (save-excursion (beginning-of-line) (point)))
(other-end (if (and cperl-electric-parens-mark
(> (mark) (point)))
(goto-char (mark))
(if (and (cperl-val 'cperl-electric-parens)
(memq last-command-char
(append cperl-electric-parens-string nil))
(>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
;;(not (save-excursion (search-backward "#" beg t)))
(if (eq last-command-char ?<)
(and abbrev-mode ; later it is too late, may be after `for'
(cperl-after-expr-p nil "{;(,:="))
(self-insert-command (prefix-numeric-value arg))
(if other-end (goto-char (marker-position other-end)))
(insert (make-string
(prefix-numeric-value arg)
(cdr (assoc last-command-char '((?{ .?})
(?[ . ?])
(?( . ?))
(?< . ?>))))))
(forward-char (- (prefix-numeric-value arg))))
(self-insert-command (prefix-numeric-value arg)))))
(defun cperl-electric-rparen (arg)
"Insert a matching pair of parentheses if marking is active.
If not, or if we are not at the end of marking range, would self-insert.
Affected by `cperl-electric-parens'."
(interactive "P")
(let ((beg (save-excursion (beginning-of-line) (point)))
(other-end (if (and cperl-electric-parens-mark
(cperl-val 'cperl-electric-parens)
(memq last-command-char
(append cperl-electric-parens-string nil))
(< (mark) (point)))
(if (and other-end
(cperl-val 'cperl-electric-parens)
(memq last-command-char '( ?\) ?\] ?\} ?\> ))
(>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
;;(not (save-excursion (search-backward "#" beg t)))
(self-insert-command (prefix-numeric-value arg))
(setq p (point))
(if other-end (goto-char other-end))
(insert (make-string
(prefix-numeric-value arg)
(cdr (assoc last-command-char '((?\} . ?\{)
(?\] . ?\[)
(?\) . ?\()
(?\> . ?\<))))))
(goto-char (1+ p)))
(self-insert-command (prefix-numeric-value arg)))))
(defun cperl-electric-keyword ()
"Insert a construction appropriate after a keyword.
Help message may be switched off by setting `cperl-message-electric-keyword'
to nil."
(let ((beg (save-excursion (beginning-of-line) (point)))
(dollar (and (eq last-command-char ?$)
(eq this-command 'self-insert-command)))
(delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
(memq this-command '(self-insert-command newline))))
my do)
(and (save-excursion
(condition-case nil
(backward-sexp 1)
(setq do (looking-at "do\\>")))
(error nil))
(cperl-after-expr-p nil "{;:"))
beg t)))
(save-excursion (or (not (re-search-backward "^=" nil t))
(looking-at "=cut")
(and cperl-use-syntax-table-text-property
(not (eq (get-text-property (point)
(save-excursion (forward-sexp -1)
(not (memq (following-char) (append "$@%&*" nil))))
(and (eq (preceding-char) ?y)
(progn ; "foreachmy"
(forward-char -2)
(insert " ")
(forward-char 2)
(setq my t dollar t
(memq this-command '(self-insert-command newline)))))
(and dollar (insert " $"))
;;(insert " () {\n}")
(insert (if do "\n" " ()\n"))
(insert "{")
(insert "\n")
(insert "\n}")
(and do (insert " while ();")))
(insert (if do " {\n} while ();" " () {\n}"))))
(or (looking-at "[ \t]\\|$") (insert " "))
(if dollar (progn (search-backward "$")
(if my
(forward-char 1)
(delete-char 1)))
(search-backward ")")
(if (eq last-command-char ?\()
(progn ; Avoid "if (())"
(delete-backward-char 1)
(delete-backward-char -1))))
(if delete
(cperl-putback-char cperl-del-back-ch))
(if cperl-message-electric-keyword
(message "Precede char by C-q to avoid expansion"))))))
(defun cperl-ensure-newlines (n &optional pos)
"Make sure there are N newlines after the point."
(or pos (setq pos (point)))
(if (looking-at "\n")
(forward-char 1)
(insert "\n"))
(if (> n 1)
(cperl-ensure-newlines (1- n) pos)
(goto-char pos)))
(defun cperl-electric-pod ()
"Insert a POD chunk appropriate after a =POD directive."
(let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
(memq this-command '(self-insert-command newline))))
head1 notlast name p really-delete over)
(and (save-excursion
(forward-word -1)
(eq (preceding-char) ?=)
(setq head1 (looking-at "head1\\>[ \t]*$"))
(setq over (and (looking-at "over\\>[ \t]*$")
(not (looking-at "over[ \t]*\n\n\n*=item\\>"))))
(forward-char -1)
(get-text-property (point) 'in-pod)
(cperl-after-expr-p nil "{;:")
(and (re-search-backward "\\(\\`\n?\\|^\n\\)=\\sw+" (point-min) t)
(not (looking-at "\n*=cut"))
(or (not cperl-use-syntax-table-text-property)
(eq (get-text-property (point) 'syntax-type) 'pod))))))
(setq notlast (re-search-forward "^\n=" nil t)))
(or notlast
(insert "\n\n=cut")
(cperl-ensure-newlines 2)
(forward-word -2)
(if (and head1
(forward-char -1)
(re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
nil t)))) ; Only one
(forward-word 1)
(setq name (file-name-sans-extension
(file-name-nondirectory (buffer-file-name)))
p (point))
(insert " NAME\n\n" name
" - \n\n=head1 SYNOPSIS\n\n\n\n"
(cperl-ensure-newlines 4)
(goto-char p)
(forward-word 2)
(setq really-delete t))
(forward-word 1))))
(if over
(setq p (point))
(insert "\n\n=item \n\n\n\n"
(cperl-ensure-newlines 2)
(goto-char p)
(forward-word 1)
(setq really-delete t)))
(if (and delete really-delete)
(cperl-putback-char cperl-del-back-ch))))))
(defun cperl-electric-else ()
"Insert a construction appropriate after a keyword.
Help message may be switched off by setting `cperl-message-electric-keyword'
to nil."
(let ((beg (save-excursion (beginning-of-line) (point))))
(and (save-excursion
(backward-sexp 1)
(cperl-after-expr-p nil "{;:"))
beg t)))
(save-excursion (or (not (re-search-backward "^=" nil t))
(looking-at "=cut")
(and cperl-use-syntax-table-text-property
(not (eq (get-text-property (point)
;;(insert " {\n\n}")
(insert "\n")
(insert "{")
(insert "\n\n}"))
(insert " {\n\n}")))
(or (looking-at "[ \t]\\|$") (insert " "))
(forward-line -1)
(cperl-putback-char cperl-del-back-ch)
(setq this-command 'cperl-electric-else)
(if cperl-message-electric-keyword
(message "Precede char by C-q to avoid expansion"))))))
(defun cperl-linefeed ()
"Go to end of line, open a new line and indent appropriately.
If in POD, insert appropriate lines."
(let ((beg (save-excursion (beginning-of-line) (point)))
(end (save-excursion (end-of-line) (point)))
(pos (point)) start over cut res)
(if (and ; Check if we need to split:
; i.e., on a boundary and inside "{...}"
(save-excursion (cperl-to-comment-or-eol)
(>= (point) pos)) ; Not in a comment
(or (save-excursion
(skip-chars-backward " \t" beg)
(forward-char -1)
(looking-at "[;{]")) ; After { or ; + spaces
(looking-at "[ \t]*}") ; Before }
(re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
(eq (car (parse-partial-sexp pos end -1)) -1)
; Leave the level of parens
(looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
; Are at end
(cperl-after-block-p (point-min))
(backward-sexp 1)
(setq start (point-marker))
(<= start pos))))) ; Redundant? Are after the
; start of parens group.
(skip-chars-backward " \t")
(or (memq (preceding-char) (append ";{" nil))
(insert ";"))
(insert "\n")
(forward-line -1)
(goto-char start)
(or (looking-at "{[ \t]*$") ; If there is a statement
; before, move it to separate line
(forward-char 1)
(insert "\n")
(forward-line 1) ; We are on the target line
(or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
; after, move it to separate line
(search-backward "}" beg)
(skip-chars-backward " \t")
(or (memq (preceding-char) (append ";{" nil))
(insert ";"))
(insert "\n")
(forward-line -1)))
(forward-line -1) ; We are on the line before target
(end-of-line) ; else - no splitting
((and (looking-at "\n[ \t]*{$")
(skip-chars-backward " \t")
(eq (preceding-char) ?\)))) ; Probably if () {} group
; with an extra newline.
(forward-line 2)
((save-excursion ; In POD header
(forward-paragraph -1)
;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
;; We are after \n now, so look for the rest
(if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
(setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
(setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
(if (and over
(forward-paragraph -1)
(forward-word 1)
(setq pos (point))
(setq cut (buffer-substring (point)
(delete-char (- (save-excursion (end-of-line) (point))
(setq res (expand-abbrev))
(goto-char pos)
(insert cut))
(cperl-ensure-newlines (if cut 2 4))
(forward-line 2)))
((get-text-property (point) 'in-pod) ; In POD section
(cperl-ensure-newlines 4)
(forward-line 2))
((looking-at "\n[ \t]*$") ; Next line is empty - use it.
(forward-line 1)
(defun cperl-electric-semi (arg)
"Insert character and correct line's indentation."
(interactive "P")
(if cperl-auto-newline
(cperl-electric-terminator arg)
(self-insert-command (prefix-numeric-value arg))
(if cperl-autoindent-on-semi
(defun cperl-electric-terminator (arg)
"Insert character and correct line's indentation."
(interactive "P")
(let ((end (point))
(auto (and cperl-auto-newline
(or (not (eq last-command-char ?:))
(if (and ;;(not arg)
(not (save-excursion
(skip-chars-forward " \t")
;; Ignore in comment lines
(= (following-char) ?#)
;; Colon is special only after a label
;; So quickly rule out most other uses of colon
;; and do no indentation for them.
(and (eq last-command-char ?:)
(forward-word 1)
(skip-chars-forward " \t")
(and (< (point) end)
(progn (goto-char (- end 1))
(not (looking-at ":"))))))
(let ((pps (parse-partial-sexp (point) end)))
(or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
(self-insert-command (prefix-numeric-value arg))
;;(forward-char -1)
(if auto (setq insertpos (point-marker)))
;;(forward-char 1)
(if auto
(if insertpos (goto-char (1- (marker-position insertpos)))
(forward-char -1))
(delete-char 1))))
(if insertpos
(goto-char insertpos)
(self-insert-command (prefix-numeric-value arg)))
(self-insert-command (prefix-numeric-value arg)))))
(defun cperl-electric-backspace (arg)
"Backspace, or remove the whitespace around the point inserted by an electric
key. Will untabivy if `cperl-electric-backspace-untabify' is non-nil."
(interactive "p")
(if (and cperl-auto-newline
(memq last-command '(cperl-electric-semi
(memq (preceding-char) '(?\ ?\t ?\n)))
(let (p)
(if (eq last-command 'cperl-electric-lbrace)
(skip-chars-forward " \t\n"))
(setq p (point))
(skip-chars-backward " \t\n")
(delete-region (point) p))
(and (eq last-command 'cperl-electric-else)
;; We are removing the whitespace *inside* cperl-electric-else
(setq this-command 'cperl-electric-else-really))
(if (and cperl-auto-newline
(eq last-command 'cperl-electric-else-really)
(memq (preceding-char) '(?\ ?\t ?\n)))
(let (p)
(skip-chars-forward " \t\n")
(setq p (point))
(skip-chars-backward " \t\n")
(delete-region (point) p))
(if cperl-electric-backspace-untabify
(backward-delete-char-untabify arg)
(delete-backward-char arg)))))
(defun cperl-inside-parens-p () ;; NOT USED????
(condition-case ()
(narrow-to-region (point)
(progn (beginning-of-defun) (point)))
(goto-char (point-max))
(= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
(error nil)))
(defun cperl-indent-command (&optional whole-exp)
"Indent current line as Perl code, or in some cases insert a tab character.
If `cperl-tab-always-indent' is non-nil (the default), always indent current
line. Otherwise, indent the current line only if point is at the left margin
or in the line's indentation; otherwise insert a tab.
A numeric argument, regardless of its value,
means indent rigidly all the lines of the expression starting after point
so that this line becomes properly indented.
The relative indentation among the lines of the expression are preserved."
(interactive "P")
(cperl-update-syntaxification (point) (point))
(if whole-exp
;; If arg, always indent this line as Perl
;; and shift remaining lines of expression the same amount.
(let ((shift-amt (cperl-indent-line))
beg end)
(if cperl-tab-always-indent
(setq beg (point))
(forward-sexp 1)
(setq end (point))
(goto-char beg)
(forward-line 1)
(setq beg (point)))
(if (and shift-amt (> end beg))
(indent-code-rigidly beg end shift-amt "#")))
(if (and (not cperl-tab-always-indent)
(skip-chars-backward " \t")
(not (bolp))))
(defun cperl-indent-line (&optional parse-data)
"Indent current line as Perl code.
Return the amount the indentation changed by."
(let ((case-fold-search nil)
(pos (- (point-max) (point)))
indent i beg shift-amt)
(setq indent (cperl-calculate-indent parse-data)
i indent)
(setq beg (point))
(cond ((or (eq indent nil) (eq indent t))
(setq indent (current-indentation) i nil))
;;((eq indent t) ; Never?
;; (setq indent (cperl-calculate-indent-within-comment)))
;;((looking-at "[ \t]*#")
;; (setq indent 0))
(skip-chars-forward " \t")
(if (listp indent) (setq indent (car indent)))
(cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
(and (> indent 0)
(setq indent (max cperl-min-label-indent
(+ indent cperl-label-offset)))))
((= (following-char) ?})
(setq indent (- indent cperl-indent-level)))
((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
(setq indent (+ indent cperl-close-paren-offset)))
((= (following-char) ?{)
(setq indent (+ indent cperl-brace-offset))))))
(skip-chars-forward " \t")
(setq shift-amt (and i (- indent (current-column))))
(if (or (not shift-amt)
(zerop shift-amt))
(if (> (- (point-max) pos) (point))
(goto-char (- (point-max) pos)))
(delete-region beg (point))
(indent-to indent)
;; If initial point was within line's indentation,
;; position after the indentation. Else stay at same point in text.
(if (> (- (point-max) pos) (point))
(goto-char (- (point-max) pos))))
(defun cperl-after-label ()
;; Returns true if the point is after label. Does not do save-excursion.
(and (eq (preceding-char) ?:)
(memq (char-syntax (char-after (- (point) 2)))
'(?w ?_))
(looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
(defun cperl-get-state (&optional parse-start start-state)
;; START is a good place to start parsing, or equal to
;; PARSE-START if preset,
;; STATE is what is returned by `parse-partial-sexp'.
;; DEPTH is true is we are immediately after end of block
;; which contains START.
;; PRESTART is the position basing on which START was found.
(let ((start-point (point)) depth state start prestart)
(if (and parse-start
(<= parse-start start-point))
(goto-char parse-start)
(setq start-state nil))
(setq prestart (point))
(if start-state nil
;; Try to go out, if sub is not on the outermost level
(while (< (point) start-point)
(setq start (point) parse-start start depth nil
state (parse-partial-sexp start start-point -1))
(if (> (car state) -1) nil
;; The current line could start like }}}, so the indentation
;; corresponds to a different level than what we reached
(setq depth t)
(beginning-of-line 2))) ; Go to the next line.
(if start (goto-char start))) ; Not at the start of file
(setq start (point))
(or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
(list start state depth prestart))))
(defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
(defun cperl-calculate-indent (&optional parse-data) ; was parse-start
"Return appropriate indentation for current line as Perl code.
In usual case returns an integer: the column to indent to.
Returns nil if line starts inside a string, t if in a comment.
Will not correct the indentation for labels, but will correct it for braces
and closing parentheses and brackets."
(cperl-update-syntaxification (point) (point))
(if (or
(and (memq (get-text-property (point) 'syntax-type)
'(pod here-doc here-doc-delim format))
(not (get-text-property (point) 'indentable)))
;; before start of POD - whitespace found since do not have 'pod!
(and (looking-at "[ \t]*\n=")
(error "Spaces before POD section!"))
(and (not cperl-indent-left-aligned-comments)
(looking-at "^#")))
(let ((indent-point (point))
(char-after (save-excursion
(skip-chars-forward " \t")
(in-pod (get-text-property (point) 'in-pod))
(pre-indent-point (point))
p prop look-prop is-block delim)
;; In the verbatim part, probably code example. What to do???
;; Not in POD
(cperl-backward-to-noncomment nil)
(setq p (max (point-min) (1- (point)))
prop (get-text-property p 'syntax-type)
look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
(if (memq prop '(pod here-doc format here-doc-delim))
(goto-char (or (previous-single-property-change p look-prop)
(setq pre-indent-point (point)))))))
(goto-char pre-indent-point)
(let* ((case-fold-search nil)
(s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
(start (or (nth 2 parse-data)
(nth 0 s-s)))
(state (nth 1 s-s))
(containing-sexp (car (cdr state)))
(if (and
;;containing-sexp ;; We are buggy at toplevel :-(
(setcar parse-data pre-indent-point)
(setcar (cdr parse-data) state)
(or (nth 2 parse-data)
(setcar (cddr parse-data) start))
;; Before this point: end of statement
(setq old-indent (nth 3 parse-data))))
(cond ((get-text-property (point) 'indentable)
;; indent to just after the surrounding open,
;; skip blanks if we do not close the expression.
(goto-char (1+ (previous-single-property-change (point) 'indentable)))
(or (memq char-after (append ")]}" nil))
(looking-at "[ \t]*\\(#\\