(save_excursion_save): Additionally record the
[bpt/emacs.git] / lisp / progmodes / cperl-mode.el
CommitLineData
f83d2997
KH
1;;; cperl-mode.el --- Perl code editing commands for Emacs
2
3;; Copyright (C) 1985, 86, 87, 91, 92, 93, 94, 95, 96, 1997
4;; Free Software Foundation, Inc.
5
6;; Author: Ilya Zakharevich and Bob Olson
7;; Maintainer: Ilya Zakharevich <ilya@math.ohio-state.edu>
8;; Keywords: languages, Perl
9
10;; This file is part of GNU Emacs.
11
12;; GNU Emacs is free software; you can redistribute it and/or modify
13;; it under the terms of the GNU General Public License as published by
14;; the Free Software Foundation; either version 2, or (at your option)
15;; any later version.
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
23;; along with GNU Emacs; see the file COPYING. If not, write to the
24;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25;; Boston, MA 02111-1307, USA.
26
27;;; Corrections made by Ilya Zakharevich ilya@math.mps.ohio-state.edu
f83d2997
KH
28
29;;; Commentary:
30
31;;; You can either fine-tune the bells and whistles of this mode or
32;;; bulk enable them by putting
33
34;; (setq cperl-hairy t)
35
36;;; in your .emacs file. (Emacs rulers do not consider it politically
37;;; correct to make whistles enabled by default.)
38
39;;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
40;;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
db133cb6 41;;; `cperl-non-problems', `cperl-praise', `cperl-speed'. <<<<<<
f83d2997
KH
42
43;;; The mode information (on C-h m) provides some customization help.
44;;; If you use font-lock feature of this mode, it is advisable to use
45;;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
46
47;;; Faces used now: three faces for first-class and second-class keywords
48;;; and control flow words, one for each: comments, string, labels,
49;;; functions definitions and packages, arrays, hashes, and variable
50;;; definitions. If you do not see all these faces, your font-lock does
51;;; not define them, so you need to define them manually.
52
53;;; into your .emacs file.
54
55;;;; This mode supports font-lock, imenu and mode-compile. In the
56;;;; hairy version font-lock is on, but you should activate imenu
57;;;; yourself (note that mode-compile is not standard yet). Well, you
58;;;; can use imenu from keyboard anyway (M-x imenu), but it is better
59;;;; to bind it like that:
60
61;; (define-key global-map [M-S-down-mouse-3] 'imenu)
62
63;;; Code:
64
5bd52f0e 65;; Some macros are needed for `defcustom'
80585273
DL
66(eval-when-compile
67 (require 'font-lock)
68 (defvar msb-menu-cond)
69 (defvar gud-perldb-history)
70 (defvar font-lock-background-mode) ; not in Emacs
71 (defvar font-lock-display-type) ; ditto
72 (defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
73 (defmacro cperl-is-face (arg) ; Takes quoted arg
74 (cond ((fboundp 'find-face)
75 `(find-face ,arg))
76 (;;(and (fboundp 'face-list)
77 ;; (face-list))
78 (fboundp 'face-list)
79 `(member ,arg (and (fboundp 'face-list)
80 (face-list))))
81 (t
82 `(boundp ,arg))))
83 (defmacro cperl-make-face (arg descr) ; Takes unquoted arg
84 (cond ((fboundp 'make-face)
85 `(make-face (quote ,arg)))
86 (t
87 `(defconst ,arg (quote ,arg) ,descr))))
88 (defmacro cperl-force-face (arg descr) ; Takes unquoted arg
89 `(progn
90 (or (cperl-is-face (quote ,arg))
91 (cperl-make-face ,arg ,descr))
92 (or (boundp (quote ,arg)) ; We use unquoted variants too
93 (defconst ,arg (quote ,arg) ,descr))))
94 (if cperl-xemacs-p
95 (defmacro cperl-etags-snarf-tag (file line)
b787fc05 96 `(progn
80585273
DL
97 (beginning-of-line 2)
98 (list ,file ,line)))
99 (defmacro cperl-etags-snarf-tag (file line)
100 `(etags-snarf-tag)))
101 (if cperl-xemacs-p
102 (defmacro cperl-etags-goto-tag-location (elt)
103 ;;(progn
104 ;; (switch-to-buffer (get-file-buffer (elt (, elt) 0)))
105 ;; (set-buffer (get-file-buffer (elt (, elt) 0)))
106 ;; Probably will not work due to some save-excursion???
107 ;; Or save-file-position?
108 ;; (message "Did I get to line %s?" (elt (, elt) 1))
109 `(goto-line (string-to-int (elt ,elt 1))))
110 ;;)
111 (defmacro cperl-etags-goto-tag-location (elt)
112 `(etags-goto-tag-location ,elt)))
113 (autoload 'tmm-prompt "tmm"))
5bd52f0e
RS
114
115(defun cperl-choose-color (&rest list)
116 (let (answer)
117 (while list
118 (or answer
119 (if (or (x-color-defined-p (car list))
120 (null (cdr list)))
121 (setq answer (car list))))
122 (setq list (cdr list)))
123 answer))
124
ccc3ce39
SE
125(defgroup cperl nil
126 "Major mode for editing Perl code."
127 :prefix "cperl-"
db133cb6
RS
128 :group 'languages
129 :version "20.3")
130
131(defgroup cperl-indentation-details nil
132 "Indentation."
133 :prefix "cperl-"
134 :group 'cperl)
135
136(defgroup cperl-affected-by-hairy nil
137 "Variables affected by `cperl-hairy'."
138 :prefix "cperl-"
139 :group 'cperl)
140
141(defgroup cperl-autoinsert-details nil
142 "Auto-insert tuneup."
143 :prefix "cperl-"
144 :group 'cperl)
145
146(defgroup cperl-faces nil
147 "Fontification colors."
148 :prefix "cperl-"
149 :group 'cperl)
150
151(defgroup cperl-speed nil
152 "Speed vs. validity tuneup."
153 :prefix "cperl-"
154 :group 'cperl)
155
156(defgroup cperl-help-system nil
157 "Help system tuneup."
158 :prefix "cperl-"
159 :group 'cperl)
ccc3ce39 160
f83d2997 161\f
ccc3ce39 162(defcustom cperl-extra-newline-before-brace nil
f83d2997
KH
163 "*Non-nil means that if, elsif, while, until, else, for, foreach
164and do constructs look like:
165
166 if ()
167 {
168 }
169
170instead of:
171
172 if () {
173 }
ccc3ce39
SE
174"
175 :type 'boolean
db133cb6
RS
176 :group 'cperl-autoinsert-details)
177
5c8b7eaf 178(defcustom cperl-extra-newline-before-brace-multiline
db133cb6
RS
179 cperl-extra-newline-before-brace
180 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
181for constructs with multiline if/unless/while/until/for/foreach condition."
182 :type 'boolean
183 :group 'cperl-autoinsert-details)
ccc3ce39
SE
184
185(defcustom cperl-indent-level 2
186 "*Indentation of CPerl statements with respect to containing block."
187 :type 'integer
db133cb6 188 :group 'cperl-indentation-details)
f83d2997 189
ccc3ce39 190(defcustom cperl-lineup-step nil
f83d2997 191 "*`cperl-lineup' will always lineup at multiple of this number.
ccc3ce39
SE
192If `nil', the value of `cperl-indent-level' will be used."
193 :type '(choice (const nil) integer)
db133cb6
RS
194 :group 'cperl-indentation-details)
195
ccc3ce39 196(defcustom cperl-brace-imaginary-offset 0
f83d2997
KH
197 "*Imagined indentation of a Perl open brace that actually follows a statement.
198An open brace following other text is treated as if it were this far
ccc3ce39
SE
199to the right of the start of its line."
200 :type 'integer
db133cb6 201 :group 'cperl-indentation-details)
ccc3ce39
SE
202
203(defcustom cperl-brace-offset 0
204 "*Extra indentation for braces, compared with other text in same context."
205 :type 'integer
db133cb6 206 :group 'cperl-indentation-details)
ccc3ce39
SE
207(defcustom cperl-label-offset -2
208 "*Offset of CPerl label lines relative to usual indentation."
209 :type 'integer
db133cb6 210 :group 'cperl-indentation-details)
ccc3ce39
SE
211(defcustom cperl-min-label-indent 1
212 "*Minimal offset of CPerl label lines."
213 :type 'integer
db133cb6 214 :group 'cperl-indentation-details)
ccc3ce39
SE
215(defcustom cperl-continued-statement-offset 2
216 "*Extra indent for lines not starting new statements."
217 :type 'integer
db133cb6 218 :group 'cperl-indentation-details)
ccc3ce39 219(defcustom cperl-continued-brace-offset 0
f83d2997 220 "*Extra indent for substatements that start with open-braces.
ccc3ce39
SE
221This is in addition to cperl-continued-statement-offset."
222 :type 'integer
db133cb6 223 :group 'cperl-indentation-details)
ccc3ce39
SE
224(defcustom cperl-close-paren-offset -1
225 "*Extra indent for substatements that start with close-parenthesis."
226 :type 'integer
db133cb6 227 :group 'cperl-indentation-details)
ccc3ce39
SE
228
229(defcustom cperl-auto-newline nil
f83d2997
KH
230 "*Non-nil means automatically newline before and after braces,
231and after colons and semicolons, inserted in CPerl code. The following
232\\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf 233Insertion after colons requires both this variable and
ccc3ce39
SE
234`cperl-auto-newline-after-colon' set."
235 :type 'boolean
db133cb6 236 :group 'cperl-autoinsert-details)
f83d2997 237
ccc3ce39 238(defcustom cperl-auto-newline-after-colon nil
f83d2997 239 "*Non-nil means automatically newline even after colons.
ccc3ce39
SE
240Subject to `cperl-auto-newline' setting."
241 :type 'boolean
db133cb6 242 :group 'cperl-autoinsert-details)
f83d2997 243
ccc3ce39 244(defcustom cperl-tab-always-indent t
f83d2997 245 "*Non-nil means TAB in CPerl mode should always reindent the current line,
ccc3ce39
SE
246regardless of where in the line point is when the TAB command is used."
247 :type 'boolean
db133cb6 248 :group 'cperl-indentation-details)
f83d2997 249
ccc3ce39 250(defcustom cperl-font-lock nil
f83d2997 251 "*Non-nil (and non-null) means CPerl buffers will use font-lock-mode.
ccc3ce39 252Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
253 :type '(choice (const null) boolean)
254 :group 'cperl-affected-by-hairy)
f83d2997 255
ccc3ce39 256(defcustom cperl-electric-lbrace-space nil
f83d2997 257 "*Non-nil (and non-null) means { after $ in CPerl buffers should be preceded by ` '.
ccc3ce39 258Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
259 :type '(choice (const null) boolean)
260 :group 'cperl-affected-by-hairy)
f83d2997 261
ccc3ce39 262(defcustom cperl-electric-parens-string "({[]})<"
f83d2997 263 "*String of parentheses that should be electric in CPerl.
ccc3ce39
SE
264Closing ones are electric only if the region is highlighted."
265 :type 'string
db133cb6 266 :group 'cperl-affected-by-hairy)
f83d2997 267
ccc3ce39 268(defcustom cperl-electric-parens nil
f83d2997 269 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
ccc3ce39 270Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
271 :type '(choice (const null) boolean)
272 :group 'cperl-affected-by-hairy)
273
274(defvar zmacs-regions) ; Avoid warning
275
5c8b7eaf 276(defcustom cperl-electric-parens-mark
f83d2997
KH
277 (and window-system
278 (or (and (boundp 'transient-mark-mode) ; For Emacs
279 transient-mark-mode)
280 (and (boundp 'zmacs-regions) ; For XEmacs
281 zmacs-regions)))
282 "*Not-nil means that electric parens look for active mark.
ccc3ce39
SE
283Default is yes if there is visual feedback on mark."
284 :type 'boolean
db133cb6 285 :group 'cperl-autoinsert-details)
f83d2997 286
ccc3ce39 287(defcustom cperl-electric-linefeed nil
f83d2997
KH
288 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
289In any case these two mean plain and hairy linefeeds together.
ccc3ce39 290Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
291 :type '(choice (const null) boolean)
292 :group 'cperl-affected-by-hairy)
f83d2997 293
ccc3ce39 294(defcustom cperl-electric-keywords nil
f83d2997 295 "*Not-nil (and non-null) means keywords are electric in CPerl.
ccc3ce39 296Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
297 :type '(choice (const null) boolean)
298 :group 'cperl-affected-by-hairy)
ccc3ce39
SE
299
300(defcustom cperl-hairy nil
db133cb6 301 "*Not-nil means most of the bells and whistles are enabled in CPerl.
5c8b7eaf 302Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
db133cb6
RS
303`cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
304`cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
305`cperl-lazy-help-time'."
ccc3ce39 306 :type 'boolean
db133cb6 307 :group 'cperl-affected-by-hairy)
ccc3ce39
SE
308
309(defcustom cperl-comment-column 32
310 "*Column to put comments in CPerl (use \\[cperl-indent] to lineup with code)."
311 :type 'integer
db133cb6 312 :group 'cperl-indentation-details)
ccc3ce39
SE
313
314(defcustom cperl-vc-header-alist '((SCCS "$sccs = '%W\%' ;")
315 (RCS "$rcs = ' $Id\$ ' ;"))
316 "*What to use as `vc-header-alist' in CPerl."
317 :type '(repeat (list symbol string))
318 :group 'cperl)
319
5c8b7eaf 320(defcustom cperl-clobber-mode-lists
5bd52f0e
RS
321 (not
322 (and
323 (boundp 'interpreter-mode-alist)
324 (assoc "miniperl" interpreter-mode-alist)
325 (assoc "\\.\\([pP][Llm]\\|al\\)$" auto-mode-alist)))
326 "*Whether to install us into `interpreter-' and `extension' mode lists."
327 :type 'boolean
328 :group 'cperl)
329
ccc3ce39 330(defcustom cperl-info-on-command-no-prompt nil
f83d2997
KH
331 "*Not-nil (and non-null) means not to prompt on C-h f.
332The opposite behaviour is always available if prefixed with C-c.
ccc3ce39 333Can be overwritten by `cperl-hairy' if nil."
db133cb6
RS
334 :type '(choice (const null) boolean)
335 :group 'cperl-affected-by-hairy)
336
337(defcustom cperl-clobber-lisp-bindings nil
338 "*Not-nil (and non-null) means not overwrite C-h f.
339The function is available on \\[cperl-info-on-command], \\[cperl-get-help].
340Can be overwritten by `cperl-hairy' if nil."
341 :type '(choice (const null) boolean)
342 :group 'cperl-affected-by-hairy)
f83d2997 343
ccc3ce39 344(defcustom cperl-lazy-help-time nil
db133cb6
RS
345 "*Not-nil (and non-null) means to show lazy help after given idle time.
346Can be overwritten by `cperl-hairy' to be 5 sec if nil."
300f7bb3 347 :type '(choice (const null) (const nil) integer)
db133cb6 348 :group 'cperl-affected-by-hairy)
f83d2997 349
ccc3ce39 350(defcustom cperl-pod-face 'font-lock-comment-face
80585273 351 "*Face for pod highlighting."
ccc3ce39 352 :type 'face
db133cb6 353 :group 'cperl-faces)
f83d2997 354
ccc3ce39 355(defcustom cperl-pod-head-face 'font-lock-variable-name-face
80585273 356 "*Face for pod highlighting.
ccc3ce39
SE
357Font for POD headers."
358 :type 'face
db133cb6 359 :group 'cperl-faces)
f83d2997 360
ccc3ce39 361(defcustom cperl-here-face 'font-lock-string-face
80585273 362 "*Face for here-docs highlighting."
ccc3ce39 363 :type 'face
db133cb6 364 :group 'cperl-faces)
f83d2997 365
5c8b7eaf 366(defcustom cperl-invalid-face ''underline
80585273
DL
367 "*Face for highlighting trailing whitespace."
368 :type 'face
5bd52f0e
RS
369 :group 'cperl-faces)
370
ccc3ce39
SE
371(defcustom cperl-pod-here-fontify '(featurep 'font-lock)
372 "*Not-nil after evaluation means to highlight pod and here-docs sections."
373 :type 'boolean
db133cb6 374 :group 'cperl-faces)
f83d2997 375
5bd52f0e
RS
376(defcustom cperl-fontify-m-as-s t
377 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
378 :type 'boolean
379 :group 'cperl-faces)
380
ccc3ce39 381(defcustom cperl-pod-here-scan t
f83d2997 382 "*Not-nil means look for pod and here-docs sections during startup.
ccc3ce39
SE
383You can always make lookup from menu or using \\[cperl-find-pods-heres]."
384 :type 'boolean
db133cb6 385 :group 'cperl-speed)
f83d2997 386
ccc3ce39 387(defcustom cperl-imenu-addback nil
f83d2997 388 "*Not-nil means add backreferences to generated `imenu's.
db133cb6 389May require patched `imenu' and `imenu-go'. Obsolete."
ccc3ce39 390 :type 'boolean
db133cb6 391 :group 'cperl-help-system)
f83d2997 392
ccc3ce39
SE
393(defcustom cperl-max-help-size 66
394 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
395 :type '(choice integer (const nil))
db133cb6 396 :group 'cperl-help-system)
f83d2997 397
ccc3ce39
SE
398(defcustom cperl-shrink-wrap-info-frame t
399 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
400 :type 'boolean
db133cb6 401 :group 'cperl-help-system)
f83d2997 402
ccc3ce39 403(defcustom cperl-info-page "perl"
f83d2997 404 "*Name of the info page containing perl docs.
ccc3ce39
SE
405Older version of this page was called `perl5', newer `perl'."
406 :type 'string
db133cb6 407 :group 'cperl-help-system)
f83d2997 408
5c8b7eaf 409(defcustom cperl-use-syntax-table-text-property
f83d2997 410 (boundp 'parse-sexp-lookup-properties)
ccc3ce39
SE
411 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
412 :type 'boolean
db133cb6 413 :group 'cperl-speed)
f83d2997 414
5c8b7eaf 415(defcustom cperl-use-syntax-table-text-property-for-tags
f83d2997 416 cperl-use-syntax-table-text-property
ccc3ce39
SE
417 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
418 :type 'boolean
db133cb6 419 :group 'cperl-speed)
ccc3ce39
SE
420
421(defcustom cperl-scan-files-regexp "\\.\\([pP][Llm]\\|xs\\)$"
422 "*Regexp to match files to scan when generating TAGS."
423 :type 'regexp
424 :group 'cperl)
425
426(defcustom cperl-noscan-files-regexp "/\\(\\.\\.?\\|SCCS\\|RCS\\|blib\\)$"
427 "*Regexp to match files/dirs to skip when generating TAGS."
428 :type 'regexp
429 :group 'cperl)
430
431(defcustom cperl-regexp-indent-step nil
432 "*Indentation used when beautifying regexps.
433If `nil', the value of `cperl-indent-level' will be used."
434 :type '(choice integer (const nil))
db133cb6 435 :group 'cperl-indentation-details)
ccc3ce39
SE
436
437(defcustom cperl-indent-left-aligned-comments t
438 "*Non-nil means that the comment starting in leftmost column should indent."
439 :type 'boolean
db133cb6 440 :group 'cperl-indentation-details)
ccc3ce39 441
8f222248 442(defcustom cperl-under-as-char nil
ccc3ce39
SE
443 "*Non-nil means that the _ (underline) should be treated as word char."
444 :type 'boolean
445 :group 'cperl)
f83d2997 446
db133cb6
RS
447(defcustom cperl-extra-perl-args ""
448 "*Extra arguments to use when starting Perl.
449Currently used with `cperl-check-syntax' only."
450 :type 'string
451 :group 'cperl)
452
453(defcustom cperl-message-electric-keyword t
454 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
455 :type 'boolean
456 :group 'cperl-help-system)
457
458(defcustom cperl-indent-region-fix-constructs 1
459 "*Amount of space to insert between `}' and `else' or `elsif'
460in `cperl-indent-region'. Set to nil to leave as is. Values other
461than 1 and nil will probably not work."
462 :type '(choice (const nil) (const 1))
463 :group 'cperl-indentation-details)
464
465(defcustom cperl-break-one-line-blocks-when-indent t
466 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
467need to be reformated into multiline ones when indenting a region."
468 :type 'boolean
469 :group 'cperl-indentation-details)
470
471(defcustom cperl-fix-hanging-brace-when-indent t
472 "*Non-nil means that BLOCK-end `}' may be put on a separate line
5c8b7eaf 473when indenting a region.
db133cb6
RS
474Braces followed by else/elsif/while/until are excepted."
475 :type 'boolean
476 :group 'cperl-indentation-details)
477
478(defcustom cperl-merge-trailing-else t
5c8b7eaf 479 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
db133cb6
RS
480may be merged to be on the same line when indenting a region."
481 :type 'boolean
482 :group 'cperl-indentation-details)
483
5c8b7eaf
SS
484(defcustom cperl-syntaxify-by-font-lock
485 (and window-system
5bd52f0e 486 (boundp 'parse-sexp-lookup-properties))
db133cb6 487 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification.
5bd52f0e
RS
488Having it TRUE may be not completely debugged yet."
489 :type '(choice (const message) boolean)
490 :group 'cperl-speed)
491
492(defcustom cperl-syntaxify-unwind
493 t
494 "*Non-nil means that CPerl unwinds to a start of along construction
495when syntaxifying a chunk of buffer."
db133cb6
RS
496 :type 'boolean
497 :group 'cperl-speed)
498
5bd52f0e
RS
499(defcustom cperl-ps-print-face-properties
500 '((font-lock-keyword-face nil nil bold shadow)
501 (font-lock-variable-name-face nil nil bold)
502 (font-lock-function-name-face nil nil bold italic box)
503 (font-lock-constant-face nil "LightGray" bold)
504 (cperl-array-face nil "LightGray" bold underline)
505 (cperl-hash-face nil "LightGray" bold italic underline)
506 (font-lock-comment-face nil "LightGray" italic)
507 (font-lock-string-face nil nil italic underline)
508 (cperl-nonoverridable-face nil nil italic underline)
509 (font-lock-type-face nil nil underline)
510 (underline nil "LightGray" strikeout))
511 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
5c8b7eaf 512 :type '(repeat (cons symbol
5bd52f0e
RS
513 (cons (choice (const nil) string)
514 (cons (choice (const nil) string)
515 (repeat symbol)))))
516 :group 'cperl-faces)
517
518(if window-system
519 (progn
5c8b7eaf 520 (defvar cperl-dark-background
5bd52f0e 521 (cperl-choose-color "navy" "os2blue" "darkgreen"))
5c8b7eaf 522 (defvar cperl-dark-foreground
5bd52f0e
RS
523 (cperl-choose-color "orchid1" "orange"))
524
525 (defface cperl-nonoverridable-face
b787fc05
GM
526 `((((class grayscale) (background light))
527 (:background "Gray90" :italic t :underline t))
528 (((class grayscale) (background dark))
529 (:foreground "Gray80" :italic t :underline t :bold t))
5c8b7eaf 530 (((class color) (background light))
b787fc05 531 (:foreground "chartreuse3"))
5c8b7eaf 532 (((class color) (background dark))
b787fc05
GM
533 (:foreground ,cperl-dark-foreground))
534 (t (:bold t :underline t)))
5bd52f0e
RS
535 "Font Lock mode face used to highlight array names."
536 :group 'cperl-faces)
537
538 (defface cperl-array-face
b787fc05
GM
539 `((((class grayscale) (background light))
540 (:background "Gray90" :bold t))
541 (((class grayscale) (background dark))
542 (:foreground "Gray80" :bold t))
5c8b7eaf 543 (((class color) (background light))
b787fc05 544 (:foreground "Blue" :background "lightyellow2" :bold t))
5c8b7eaf 545 (((class color) (background dark))
b787fc05
GM
546 (:foreground "yellow" :background ,cperl-dark-background :bold t))
547 (t (:bold t)))
5bd52f0e
RS
548 "Font Lock mode face used to highlight array names."
549 :group 'cperl-faces)
550
551 (defface cperl-hash-face
b787fc05
GM
552 `((((class grayscale) (background light))
553 (:background "Gray90" :bold t :italic t))
554 (((class grayscale) (background dark))
555 (:foreground "Gray80" :bold t :italic t))
5c8b7eaf 556 (((class color) (background light))
b787fc05 557 (:foreground "Red" :background "lightyellow2" :bold t :italic t))
5c8b7eaf 558 (((class color) (background dark))
b787fc05
GM
559 (:foreground "Red" :background ,cperl-dark-background :bold t :italic t))
560 (t (:bold t :italic t)))
5bd52f0e
RS
561 "Font Lock mode face used to highlight hash names."
562 :group 'cperl-faces)))
563
f83d2997
KH
564\f
565
566;;; Short extra-docs.
567
568(defvar cperl-tips 'please-ignore-this-line
569 "Get newest version of this package from
570 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
571and/or
572 ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
db133cb6
RS
573Subdirectory `cperl-mode' may contain yet newer development releases and/or
574patches to related files.
f83d2997 575
5bd52f0e
RS
576For best results apply to an older Emacs the patches from
577 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
5c8b7eaf 578\(this upgrades syntax-parsing abilities of RMS Emaxen v19.34 and
5bd52f0e
RS
579v20.2 up to the level of RMS Emacs v20.3 - a must for a good Perl
580mode.) You will not get much from XEmacs, it's syntax abilities are
581too primitive.
582
f83d2997
KH
583Get support packages choose-color.el (or font-lock-extra.el before
58419.30), imenu-go.el from the same place. \(Look for other files there
585too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
5c8b7eaf 586later you should use choose-color.el *instead* of font-lock-extra.el
f83d2997
KH
587\(and you will not get smart highlighting in C :-().
588
589Note that to enable Compile choices in the menu you need to install
590mode-compile.el.
591
5c8b7eaf 592Get perl5-info from
f83d2997
KH
593 $CPAN/doc/manual/info/perl-info.tar.gz
594older version was on
595 http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
596
597If you use imenu-go, run imenu on perl5-info buffer (you can do it
5bd52f0e
RS
598from Perl menu). If many files are related, generate TAGS files from
599Tools/Tags submenu in Perl menu.
f83d2997
KH
600
601If some class structure is too complicated, use Tools/Hierarchy-view
5bd52f0e 602from Perl menu, or hierarchic view of imenu. The second one uses the
f83d2997 603current buffer only, the first one requires generation of TAGS from
5bd52f0e
RS
604Perl/Tools/Tags menu beforehand.
605
606Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
607
608Switch auto-help on/off with Perl/Tools/Auto-help.
609
610Though with contemporary Emaxen CPerl mode should maintain the correct
611parsing of Perl even when editing, sometimes it may be lost. Fix this by
612
613 M-x norm RET
f83d2997 614
5bd52f0e 615In cases of more severe confusion sometimes it is helpful to do
f83d2997 616
5bd52f0e
RS
617 M-x load-l RET cperl-mode RET
618 M-x norm RET
f83d2997 619
5bd52f0e
RS
620Before reporting (non-)problems look in the problem section of online
621micro-docs on what I know about CPerl problems.")
f83d2997
KH
622
623(defvar cperl-problems 'please-ignore-this-line
bab27c0c
RS
624"Some faces will not be shown on some versions of Emacs unless you
625install choose-color.el, available from
626 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
627
5bd52f0e
RS
628Emacs had a _very_ restricted syntax parsing engine until RMS's Emacs
62920.1. Most problems below are corrected starting from this version of
630Emacs, and all of them should go with (future) RMS's version 20.3.
631
632Note that even with newer Emacsen interaction of `font-lock' and
bab27c0c
RS
633syntaxification is not cleaned up. You may get slightly different
634colors basing on the order of fontification and syntaxification. This
635might be corrected by setting `cperl-syntaxify-by-font-lock' to t, but
636the corresponding code is still extremely buggy.
f83d2997 637
db133cb6
RS
638Even with older Emacsen CPerl mode tries to corrects some Emacs
639misunderstandings, however, for efficiency reasons the degree of
640correction is different for different operations. The partially
641corrected problems are: POD sections, here-documents, regexps. The
642operations are: highlighting, indentation, electric keywords, electric
643braces.
f83d2997
KH
644
645This may be confusing, since the regexp s#//#/#\; may be highlighted
646as a comment, but it will be recognized as a regexp by the indentation
647code. Or the opposite case, when a pod section is highlighted, but
648may break the indentation of the following code (though indentation
649should work if the balance of delimiters is not broken by POD).
650
651The main trick (to make $ a \"backslash\") makes constructions like
652${aaa} look like unbalanced braces. The only trick I can think of is
5c8b7eaf 653to insert it as $ {aaa} (legal in perl5, not in perl4).
f83d2997
KH
654
655Similar problems arise in regexps, when /(\\s|$)/ should be rewritten
db133cb6
RS
656as /($|\\s)/. Note that such a transposition is not always possible.
657
5bd52f0e
RS
658The solution is to upgrade your Emacs or patch an older one. Note
659that RMS's 20.2 has some bugs related to `syntax-table' text
660properties. Patches are available on the main CPerl download site,
661and on CPAN.
db133cb6
RS
662
663If these bugs cannot be fixed on your machine (say, you have an inferior
664environment and cannot recompile), you may still disable all the fancy stuff
665via `cperl-use-syntax-table-text-property'." )
f83d2997
KH
666
667(defvar cperl-non-problems 'please-ignore-this-line
5c8b7eaf 668"As you know from `problems' section, Perl syntax is too hard for CPerl on
5bd52f0e
RS
669older Emacsen. Here is what you can do if you cannot upgrade, or if
670you want to switch off these capabilities on RMS Emacs 20.2 (+patches) or 20.3
671or better. Please skip this docs if you run a capable Emacs already.
f83d2997 672
db133cb6
RS
673Most of the time, if you write your own code, you may find an equivalent
674\(and almost as readable) expression (what is discussed below is usually
675not relevant on newer Emacsen, since they can do it automatically).
f83d2997
KH
676
677Try to help CPerl: add comments with embedded quotes to fix CPerl
678misunderstandings about the end of quotation:
679
680$a='500$'; # ';
681
682You won't need it too often. The reason: $ \"quotes\" the following
683character (this saves a life a lot of times in CPerl), thus due to
684Emacs parsing rules it does not consider tick (i.e., ' ) after a
db133cb6
RS
685dollar as a closing one, but as a usual character. This is usually
686correct, but not in the above context.
f83d2997 687
db133cb6
RS
688Even with older Emacsen the indentation code is pretty wise. The only
689drawback is that it relied on Emacs parsing to find matching
690parentheses. And Emacs *could not* match parentheses in Perl 100%
691correctly. So
f83d2997 692 1 if s#//#/#;
db133cb6 693would not break indentation, but
f83d2997 694 1 if ( s#//#/# );
db133cb6 695would. Upgrade.
f83d2997
KH
696
697By similar reasons
698 s\"abc\"def\";
db133cb6 699would confuse CPerl a lot.
f83d2997
KH
700
701If you still get wrong indentation in situation that you think the
702code should be able to parse, try:
703
704a) Check what Emacs thinks about balance of your parentheses.
705b) Supply the code to me (IZ).
706
db133cb6
RS
707Pods were treated _very_ rudimentally. Here-documents were not
708treated at all (except highlighting and inhibiting indentation). Upgrade.
f83d2997
KH
709
710To speed up coloring the following compromises exist:
711 a) sub in $mypackage::sub may be highlighted.
712 b) -z in [a-z] may be highlighted.
713 c) if your regexp contains a keyword (like \"s\"), it may be highlighted.
714
715
716Imenu in 19.31 is broken. Set `imenu-use-keymap-menu' to t, and remove
717`car' before `imenu-choose-buffer-index' in `imenu'.
5c8b7eaf 718`imenu-add-to-menubar' in 20.2 is broken.
5bd52f0e 719
bab27c0c
RS
720A lot of things on XEmacs may be broken too, judging by bug reports I
721recieve. Note that some releases of XEmacs are better than the others
722as far as bugs reports I see are concerned.")
f83d2997
KH
723
724(defvar cperl-praise 'please-ignore-this-line
725 "RMS asked me to list good things about CPerl. Here they go:
726
7270) It uses the newest `syntax-table' property ;-);
728
7291) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
5c8b7eaf 730mode - but the latter number may have improved too in last years) even
5bd52f0e
RS
731with old Emaxen which do not support `syntax-table' property.
732
733When using `syntax-table' property for syntax assist hints, it should
734handle 99.995% of lines correct - or somesuch. It automatically
735updates syntax assist hints when you edit your script.
f83d2997 736
bab27c0c 7372) It is generally believed to be \"the most user-friendly Emacs
f83d2997
KH
738package\" whatever it may mean (I doubt that the people who say similar
739things tried _all_ the rest of Emacs ;-), but this was not a lonely
740voice);
741
7423) Everything is customizable, one-by-one or in a big sweep;
743
7444) It has many easily-accessable \"tools\":
745 a) Can run program, check syntax, start debugger;
746 b) Can lineup vertically \"middles\" of rows, like `=' in
747 a = b;
748 cc = d;
749 c) Can insert spaces where this impoves readability (in one
750 interactive sweep over the buffer);
751 d) Has support for imenu, including:
752 1) Separate unordered list of \"interesting places\";
753 2) Separate TOC of POD sections;
754 3) Separate list of packages;
755 4) Hierarchical view of methods in (sub)packages;
756 5) and functions (by the full name - with package);
757 e) Has an interface to INFO docs for Perl; The interface is
758 very flexible, including shrink-wrapping of
759 documentation buffer/frame;
760 f) Has a builtin list of one-line explanations for perl constructs.
761 g) Can show these explanations if you stay long enough at the
762 corresponding place (or on demand);
763 h) Has an enhanced fontification (using 3 or 4 additional faces
764 comparing to font-lock - basically, different
765 namespaces in Perl have different colors);
766 i) Can construct TAGS basing on its knowledge of Perl syntax,
767 the standard menu has 6 different way to generate
db133cb6 768 TAGS (if \"by directory\", .xs files - with C-language
f83d2997
KH
769 bindings - are included in the scan);
770 j) Can build a hierarchical view of classes (via imenu) basing
771 on generated TAGS file;
772 k) Has electric parentheses, electric newlines, uses Abbrev
773 for electric logical constructs
774 while () {}
775 with different styles of expansion (context sensitive
776 to be not so bothering). Electric parentheses behave
777 \"as they should\" in a presence of a visible region.
778 l) Changes msb.el \"on the fly\" to insert a group \"Perl files\";
db133cb6
RS
779 m) Can convert from
780 if (A) { B }
781 to
782 B if A;
f83d2997 783
5bd52f0e
RS
784 n) Highlights (by user-choice) either 3-delimiters constructs
785 (such as tr/a/b/), or regular expressions and `y/tr'.
786 o) Highlights trailing whitespace.
787
f83d2997
KH
7885) The indentation engine was very smart, but most of tricks may be
789not needed anymore with the support for `syntax-table' property. Has
790progress indicator for indentation (with `imenu' loaded).
791
5c8b7eaf 7926) Indent-region improves inline-comments as well; also corrects
db133cb6 793whitespace *inside* the conditional/loop constructs.
f83d2997
KH
794
7957) Fill-paragraph correctly handles multi-line comments;
db133cb6
RS
796
7978) Can switch to different indentation styles by one command, and restore
798the settings present before the switch.
799
5c8b7eaf 8009) When doing indentation of control constructs, may correct
db133cb6
RS
801line-breaks/spacing between elements of the construct.
802")
803
804(defvar cperl-speed 'please-ignore-this-line
805 "This is an incomplete compendium of what is available in other parts
806of CPerl documentation. (Please inform me if I skept anything.)
807
808There is a perception that CPerl is slower than alternatives. This part
809of documentation is designed to overcome this misconception.
810
811*By default* CPerl tries to enable the most comfortable settings.
812From most points of view, correctly working package is infinitely more
813comfortable than a non-correctly working one, thus by default CPerl
814prefers correctness over speed. Below is the guide how to change
815settings if your preferences are different.
816
817A) Speed of loading the file. When loading file, CPerl may perform a
818scan which indicates places which cannot be parsed by primitive Emacs
819syntax-parsing routines, and marks them up so that either
820
821 A1) CPerl may work around these deficiencies (for big chunks, mostly
822 PODs and HERE-documents), or
823 A2) On capable Emaxen CPerl will use improved syntax-handlings
824 which reads mark-up hints directly.
825
826 The scan in case A2 is much more comprehensive, thus may be slower.
827
828 User can disable syntax-engine-helping scan of A2 by setting
829 `cperl-use-syntax-table-text-property'
830 variable to nil (if it is set to t).
831
832 One can disable the scan altogether (both A1 and A2) by setting
833 `cperl-pod-here-scan'
834 to nil.
835
5c8b7eaf 836B) Speed of editing operations.
db133cb6
RS
837
838 One can add a (minor) speedup to editing operations by setting
839 `cperl-use-syntax-table-text-property'
840 variable to nil (if it is set to t). This will disable
841 syntax-engine-helping scan, thus will make many more Perl
842 constructs be wrongly recognized by CPerl, thus may lead to
843 wrongly matched parentheses, wrong indentation, etc.
5bd52f0e
RS
844
845 One can unset `cperl-syntaxify-unwind'. This might speed up editing
846 of, say, long POD sections.
f83d2997
KH
847")
848
5bd52f0e
RS
849(defvar cperl-tips-faces 'please-ignore-this-line
850 "CPerl mode uses following faces for highlighting:
851
852 cperl-array-face Array names
853 cperl-hash-face Hash names
854 font-lock-comment-face Comments, PODs and whatever is considered
855 syntaxically to be not code
856 font-lock-constant-face HERE-doc delimiters, labels, delimiters of
857 2-arg operators s/y/tr/ or of RExen,
5c8b7eaf 858 font-lock-function-name-face Special-cased m// and s//foo/, _ as
5bd52f0e
RS
859 a target of a file tests, file tests,
860 subroutine names at the moment of definition
861 (except those conflicting with Perl operators),
862 package names (when recognized), format names
863 font-lock-keyword-face Control flow switch constructs, declarators
864 cperl-nonoverridable-face Non-overridable keywords, modifiers of RExen
865 font-lock-string-face Strings, qw() constructs, RExen, POD sections,
866 literal parts and the terminator of formats
867 and whatever is syntaxically considered
868 as string literals
869 font-lock-type-face Overridable keywords
870 font-lock-variable-name-face Variable declarations, indirect array and
871 hash names, POD headers/item names
872 cperl-invalid-face Trailing whitespace
873
874Note that in several situations the highlighting tries to inform about
875possible confusion, such as different colors for function names in
876declarations depending on what they (do not) override, or special cases
877m// and s/// which do not do what one would expect them to do.
878
5c8b7eaf 879Help with best setup of these faces for printout requested (for each of
5bd52f0e
RS
880the faces: please specify bold, italic, underline, shadow and box.)
881
882\(Not finished.)")
883
f83d2997
KH
884\f
885
886;;; Portability stuff:
887
db133cb6
RS
888(defconst cperl-xemacs-p (string-match "XEmacs\\|Lucid" emacs-version))
889
f83d2997 890(defmacro cperl-define-key (emacs-key definition &optional xemacs-key)
b787fc05
GM
891 `(define-key cperl-mode-map
892 ,(if xemacs-key
893 `(if cperl-xemacs-p ,xemacs-key ,emacs-key)
894 emacs-key)
895 ,definition))
f83d2997
KH
896
897(defvar cperl-del-back-ch
898 (car (append (where-is-internal 'delete-backward-char)
899 (where-is-internal 'backward-delete-char-untabify)))
900 "Character generated by key bound to delete-backward-char.")
901
5c8b7eaf 902(and (vectorp cperl-del-back-ch) (= (length cperl-del-back-ch) 1)
f83d2997
KH
903 (setq cperl-del-back-ch (aref cperl-del-back-ch 0)))
904
db133cb6 905(defun cperl-mark-active () (mark)) ; Avoid undefined warning
f83d2997
KH
906(if cperl-xemacs-p
907 (progn
908 ;; "Active regions" are on: use region only if active
909 ;; "Active regions" are off: use region unconditionally
910 (defun cperl-use-region-p ()
db133cb6 911 (if zmacs-regions (mark) t)))
f83d2997
KH
912 (defun cperl-use-region-p ()
913 (if transient-mark-mode mark-active t))
914 (defun cperl-mark-active () mark-active))
915
916(defsubst cperl-enable-font-lock ()
917 (or cperl-xemacs-p window-system))
918
db133cb6
RS
919(defun cperl-putback-char (c) ; Emacs 19
920 (set 'unread-command-events (list c))) ; Avoid undefined warning
921
f83d2997
KH
922(if (boundp 'unread-command-events)
923 (if cperl-xemacs-p
924 (defun cperl-putback-char (c) ; XEmacs >= 19.12
db133cb6 925 (setq unread-command-events (list (eval '(character-to-event c))))))
f83d2997 926 (defun cperl-putback-char (c) ; XEmacs <= 19.11
db133cb6 927 (set 'unread-command-event (eval '(character-to-event c))))) ; Avoid warnings
f83d2997
KH
928
929(or (fboundp 'uncomment-region)
930 (defun uncomment-region (beg end)
931 (interactive "r")
932 (comment-region beg end -1)))
933
934(defvar cperl-do-not-fontify
935 (if (string< emacs-version "19.30")
936 'fontified
937 'lazy-lock)
938 "Text property which inhibits refontification.")
939
5bd52f0e
RS
940(defsubst cperl-put-do-not-fontify (from to &optional post)
941 ;; If POST, do not do it with postponed fontification
942 (if (and post cperl-syntaxify-by-font-lock)
943 nil
f83d2997 944 (put-text-property (max (point-min) (1- from))
5bd52f0e 945 to cperl-do-not-fontify t)))
f83d2997 946
ccc3ce39
SE
947(defcustom cperl-mode-hook nil
948 "Hook run by `cperl-mode'."
949 :type 'hook
950 :group 'cperl)
f83d2997 951
db133cb6
RS
952(defvar cperl-syntax-state nil)
953(defvar cperl-syntax-done-to nil)
5bd52f0e
RS
954(defvar cperl-emacs-can-parse (> (length (save-excursion
955 (parse-partial-sexp 1 1))) 9))
db133cb6
RS
956\f
957;; Make customization possible "in reverse"
958(defsubst cperl-val (symbol &optional default hairy)
959 (cond
960 ((eq (symbol-value symbol) 'null) default)
961 (cperl-hairy (or hairy t))
962 (t (symbol-value symbol))))
f83d2997
KH
963\f
964;;; Probably it is too late to set these guys already, but it can help later:
965
5bd52f0e 966;;;(and cperl-clobber-mode-lists
f83d2997
KH
967;;;(setq auto-mode-alist
968;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
969;;;(and (boundp 'interpreter-mode-alist)
970;;; (setq interpreter-mode-alist (append interpreter-mode-alist
5bd52f0e 971;;; '(("miniperl" . perl-mode))))))
80585273
DL
972(eval-when-compile
973 (condition-case nil
974 (require 'imenu)
975 (error nil))
976 (condition-case nil
977 (require 'easymenu)
978 (error nil))
979 (condition-case nil
980 (require 'etags)
981 (error nil))
982 (condition-case nil
983 (require 'timer)
984 (error nil))
985 (condition-case nil
986 (require 'man)
987 (error nil))
988 (condition-case nil
989 (require 'info)
990 (error nil))
991 (if (fboundp 'ps-extend-face-list)
992 (defmacro cperl-ps-extend-face-list (arg)
993 `(ps-extend-face-list ,arg))
994 (defmacro cperl-ps-extend-face-list (arg)
995 `(error "This version of Emacs has no `ps-extend-face-list'.")))
996 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
997 ;; macros instead of defsubsts don't work on Emacs, so we do the
998 ;; expansion manually. Any other suggestions?
999 (require 'cl))
f83d2997
KH
1000
1001(defvar cperl-mode-abbrev-table nil
1002 "Abbrev table in use in Cperl-mode buffers.")
1003
1004(add-hook 'edit-var-mode-alist '(perl-mode (regexp . "^cperl-")))
1005
1006(defvar cperl-mode-map () "Keymap used in CPerl mode.")
1007
1008(if cperl-mode-map nil
1009 (setq cperl-mode-map (make-sparse-keymap))
1010 (cperl-define-key "{" 'cperl-electric-lbrace)
1011 (cperl-define-key "[" 'cperl-electric-paren)
1012 (cperl-define-key "(" 'cperl-electric-paren)
1013 (cperl-define-key "<" 'cperl-electric-paren)
1014 (cperl-define-key "}" 'cperl-electric-brace)
1015 (cperl-define-key "]" 'cperl-electric-rparen)
1016 (cperl-define-key ")" 'cperl-electric-rparen)
1017 (cperl-define-key ";" 'cperl-electric-semi)
1018 (cperl-define-key ":" 'cperl-electric-terminator)
1019 (cperl-define-key "\C-j" 'newline-and-indent)
1020 (cperl-define-key "\C-c\C-j" 'cperl-linefeed)
db133cb6 1021 (cperl-define-key "\C-c\C-t" 'cperl-invert-if-unless)
f83d2997
KH
1022 (cperl-define-key "\C-c\C-a" 'cperl-toggle-auto-newline)
1023 (cperl-define-key "\C-c\C-k" 'cperl-toggle-abbrev)
db133cb6
RS
1024 (cperl-define-key "\C-c\C-w" 'cperl-toggle-construct-fix)
1025 (cperl-define-key "\C-c\C-f" 'auto-fill-mode)
f83d2997 1026 (cperl-define-key "\C-c\C-e" 'cperl-toggle-electric)
db133cb6 1027 (cperl-define-key "\C-c\C-ha" 'cperl-toggle-autohelp)
f83d2997
KH
1028 (cperl-define-key "\e\C-q" 'cperl-indent-exp) ; Usually not bound
1029 (cperl-define-key [?\C-\M-\|] 'cperl-lineup
1030 [(control meta |)])
1031 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1032 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1033 (cperl-define-key "\177" 'cperl-electric-backspace)
1034 (cperl-define-key "\t" 'cperl-indent-command)
1035 ;; don't clobber the backspace binding:
db133cb6
RS
1036 (cperl-define-key "\C-c\C-hF" 'cperl-info-on-command
1037 [(control c) (control h) F])
db133cb6
RS
1038 (if (cperl-val 'cperl-clobber-lisp-bindings)
1039 (progn
1040 (cperl-define-key "\C-hf"
1041 ;;(concat (char-to-string help-char) "f") ; does not work
1042 'cperl-info-on-command
1043 [(control h) f])
1044 (cperl-define-key "\C-hv"
1045 ;;(concat (char-to-string help-char) "v") ; does not work
1046 'cperl-get-help
5bd52f0e
RS
1047 [(control h) v])
1048 (cperl-define-key "\C-c\C-hf"
1049 ;;(concat (char-to-string help-char) "f") ; does not work
1050 (key-binding "\C-hf")
1051 [(control c) (control h) f])
1052 (cperl-define-key "\C-c\C-hv"
1053 ;;(concat (char-to-string help-char) "v") ; does not work
1054 (key-binding "\C-hv")
1055 [(control c) (control h) v]))
1056 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-current-command
1057 [(control c) (control h) f])
1058 (cperl-define-key "\C-c\C-hv"
1059 ;;(concat (char-to-string help-char) "v") ; does not work
1060 'cperl-get-help
1061 [(control c) (control h) v]))
5c8b7eaf 1062 (if (and cperl-xemacs-p
f83d2997
KH
1063 (<= emacs-minor-version 11) (<= emacs-major-version 19))
1064 (progn
1065 ;; substitute-key-definition is usefulness-deenhanced...
1066 (cperl-define-key "\M-q" 'cperl-fill-paragraph)
1067 (cperl-define-key "\e;" 'cperl-indent-for-comment)
1068 (cperl-define-key "\e\C-\\" 'cperl-indent-region))
1069 (substitute-key-definition
1070 'indent-sexp 'cperl-indent-exp
1071 cperl-mode-map global-map)
1072 (substitute-key-definition
1073 'fill-paragraph 'cperl-fill-paragraph
1074 cperl-mode-map global-map)
1075 (substitute-key-definition
1076 'indent-region 'cperl-indent-region
1077 cperl-mode-map global-map)
1078 (substitute-key-definition
1079 'indent-for-comment 'cperl-indent-for-comment
1080 cperl-mode-map global-map)))
1081
1082(defvar cperl-menu)
db133cb6
RS
1083(defvar cperl-lazy-installed)
1084(defvar cperl-old-style nil)
f83d2997
KH
1085(condition-case nil
1086 (progn
1087 (require 'easymenu)
1088 (easy-menu-define cperl-menu cperl-mode-map "Menu for CPerl mode"
1089 '("Perl"
1090 ["Beginning of function" beginning-of-defun t]
1091 ["End of function" end-of-defun t]
1092 ["Mark function" mark-defun t]
1093 ["Indent expression" cperl-indent-exp t]
1094 ["Fill paragraph/comment" cperl-fill-paragraph t]
1095 "----"
1096 ["Line up a construction" cperl-lineup (cperl-use-region-p)]
db133cb6
RS
1097 ["Invert if/unless/while/until" cperl-invert-if-unless t]
1098 ("Regexp"
1099 ["Beautify" cperl-beautify-regexp
1100 cperl-use-syntax-table-text-property]
1101 ["Beautify a group" cperl-beautify-level
1102 cperl-use-syntax-table-text-property]
1103 ["Contract a group" cperl-contract-level
1104 cperl-use-syntax-table-text-property]
1105 ["Contract groups" cperl-contract-levels
1106 cperl-use-syntax-table-text-property])
f83d2997
KH
1107 ["Refresh \"hard\" constructions" cperl-find-pods-heres t]
1108 "----"
1109 ["Indent region" cperl-indent-region (cperl-use-region-p)]
1110 ["Comment region" cperl-comment-region (cperl-use-region-p)]
1111 ["Uncomment region" cperl-uncomment-region (cperl-use-region-p)]
1112 "----"
1113 ["Run" mode-compile (fboundp 'mode-compile)]
1114 ["Kill" mode-compile-kill (and (fboundp 'mode-compile-kill)
1115 (get-buffer "*compilation*"))]
1116 ["Next error" next-error (get-buffer "*compilation*")]
1117 ["Check syntax" cperl-check-syntax (fboundp 'mode-compile)]
1118 "----"
1119 ["Debugger" cperl-db t]
1120 "----"
1121 ("Tools"
1122 ["Imenu" imenu (fboundp 'imenu)]
1123 ["Insert spaces if needed" cperl-find-bad-style t]
1124 ["Class Hierarchy from TAGS" cperl-tags-hier-init t]
1125 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
5c8b7eaf 1126 ["CPerl pretty print (exprmntl)" cperl-ps-print
5bd52f0e 1127 (fboundp 'ps-extend-face-list)]
f83d2997
KH
1128 ["Imenu on info" cperl-imenu-on-info (featurep 'imenu)]
1129 ("Tags"
1130;;; ["Create tags for current file" cperl-etags t]
1131;;; ["Add tags for current file" (cperl-etags t) t]
1132;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1133;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
5c8b7eaf 1134;;; ["Create tags for Perl files in (sub)directories"
f83d2997
KH
1135;;; (cperl-etags nil 'recursive) t]
1136;;; ["Add tags for Perl files in (sub)directories"
5c8b7eaf 1137;;; (cperl-etags t 'recursive) t])
f83d2997
KH
1138;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1139 ["Create tags for current file" (cperl-write-tags nil t) t]
1140 ["Add tags for current file" (cperl-write-tags) t]
5c8b7eaf 1141 ["Create tags for Perl files in directory"
f83d2997 1142 (cperl-write-tags nil t nil t) t]
5c8b7eaf 1143 ["Add tags for Perl files in directory"
f83d2997 1144 (cperl-write-tags nil nil nil t) t]
5c8b7eaf 1145 ["Create tags for Perl files in (sub)directories"
f83d2997
KH
1146 (cperl-write-tags nil t t t) t]
1147 ["Add tags for Perl files in (sub)directories"
db133cb6
RS
1148 (cperl-write-tags nil nil t t) t]))
1149 ("Perl docs"
5c8b7eaf 1150 ["Define word at point" imenu-go-find-at-position
f83d2997
KH
1151 (fboundp 'imenu-go-find-at-position)]
1152 ["Help on function" cperl-info-on-command t]
1153 ["Help on function at point" cperl-info-on-current-command t]
1154 ["Help on symbol at point" cperl-get-help t]
db133cb6
RS
1155 ["Perldoc" cperl-perldoc t]
1156 ["Perldoc on word at point" cperl-perldoc-at-point t]
1157 ["View manpage of POD in this file" cperl-pod-to-manpage t]
5c8b7eaf 1158 ["Auto-help on" cperl-lazy-install
db133cb6
RS
1159 (and (fboundp 'run-with-idle-timer)
1160 (not cperl-lazy-installed))]
5c8b7eaf 1161 ["Auto-help off" (eval '(cperl-lazy-unstall))
db133cb6
RS
1162 (and (fboundp 'run-with-idle-timer)
1163 cperl-lazy-installed)])
f83d2997
KH
1164 ("Toggle..."
1165 ["Auto newline" cperl-toggle-auto-newline t]
1166 ["Electric parens" cperl-toggle-electric t]
1167 ["Electric keywords" cperl-toggle-abbrev t]
db133cb6 1168 ["Fix whitespace on indent" cperl-toggle-construct-fix t]
5c8b7eaf 1169 ["Auto fill" auto-fill-mode t])
f83d2997 1170 ("Indent styles..."
db133cb6
RS
1171 ["CPerl" (cperl-set-style "CPerl") t]
1172 ["PerlStyle" (cperl-set-style "PerlStyle") t]
f83d2997
KH
1173 ["GNU" (cperl-set-style "GNU") t]
1174 ["C++" (cperl-set-style "C++") t]
1175 ["FSF" (cperl-set-style "FSF") t]
1176 ["BSD" (cperl-set-style "BSD") t]
db133cb6
RS
1177 ["Whitesmith" (cperl-set-style "Whitesmith") t]
1178 ["Current" (cperl-set-style "Current") t]
1179 ["Memorized" (cperl-set-style-back) cperl-old-style])
f83d2997
KH
1180 ("Micro-docs"
1181 ["Tips" (describe-variable 'cperl-tips) t]
1182 ["Problems" (describe-variable 'cperl-problems) t]
1183 ["Non-problems" (describe-variable 'cperl-non-problems) t]
db133cb6
RS
1184 ["Speed" (describe-variable 'cperl-speed) t]
1185 ["Praise" (describe-variable 'cperl-praise) t]
5bd52f0e
RS
1186 ["Faces" (describe-variable 'cperl-tips-faces) t]
1187 ["CPerl mode" (describe-function 'cperl-mode) t]
5c8b7eaf
SS
1188 ["CPerl version"
1189 (message "The version of master-file for this CPerl is %s"
5bd52f0e 1190 cperl-version) t]))))
f83d2997
KH
1191 (error nil))
1192
1193(autoload 'c-macro-expand "cmacexp"
1194 "Display the result of expanding all C macros occurring in the region.
1195The expansion is entirely correct because it uses the C preprocessor."
1196 t)
1197
1198(defvar cperl-mode-syntax-table nil
1199 "Syntax table in use in Cperl-mode buffers.")
1200
1201(defvar cperl-string-syntax-table nil
1202 "Syntax table in use in Cperl-mode string-like chunks.")
1203
1204(if cperl-mode-syntax-table
1205 ()
1206 (setq cperl-mode-syntax-table (make-syntax-table))
1207 (modify-syntax-entry ?\\ "\\" cperl-mode-syntax-table)
1208 (modify-syntax-entry ?/ "." cperl-mode-syntax-table)
1209 (modify-syntax-entry ?* "." cperl-mode-syntax-table)
1210 (modify-syntax-entry ?+ "." cperl-mode-syntax-table)
1211 (modify-syntax-entry ?- "." cperl-mode-syntax-table)
1212 (modify-syntax-entry ?= "." cperl-mode-syntax-table)
1213 (modify-syntax-entry ?% "." cperl-mode-syntax-table)
1214 (modify-syntax-entry ?< "." cperl-mode-syntax-table)
1215 (modify-syntax-entry ?> "." cperl-mode-syntax-table)
1216 (modify-syntax-entry ?& "." cperl-mode-syntax-table)
1217 (modify-syntax-entry ?$ "\\" cperl-mode-syntax-table)
1218 (modify-syntax-entry ?\n ">" cperl-mode-syntax-table)
1219 (modify-syntax-entry ?# "<" cperl-mode-syntax-table)
1220 (modify-syntax-entry ?' "\"" cperl-mode-syntax-table)
1221 (modify-syntax-entry ?` "\"" cperl-mode-syntax-table)
1222 (if cperl-under-as-char
1223 (modify-syntax-entry ?_ "w" cperl-mode-syntax-table))
1224 (modify-syntax-entry ?: "_" cperl-mode-syntax-table)
1225 (modify-syntax-entry ?| "." cperl-mode-syntax-table)
1226 (setq cperl-string-syntax-table (copy-syntax-table cperl-mode-syntax-table))
1227 (modify-syntax-entry ?$ "." cperl-string-syntax-table)
1228 (modify-syntax-entry ?# "." cperl-string-syntax-table) ; (?# comment )
1229)
1230
1231
1232\f
db133cb6 1233(defvar cperl-faces-init nil)
f83d2997
KH
1234;; Fix for msb.el
1235(defvar cperl-msb-fixed nil)
1236;;;###autoload
1237(defun cperl-mode ()
1238 "Major mode for editing Perl code.
1239Expression and list commands understand all C brackets.
1240Tab indents for Perl code.
1241Paragraphs are separated by blank lines only.
1242Delete converts tabs to spaces as it moves back.
1243
1244Various characters in Perl almost always come in pairs: {}, (), [],
1245sometimes <>. When the user types the first, she gets the second as
1246well, with optional special formatting done on {}. (Disabled by
1247default.) You can always quote (with \\[quoted-insert]) the left
1248\"paren\" to avoid the expansion. The processing of < is special,
1249since most the time you mean \"less\". Cperl mode tries to guess
1250whether you want to type pair <>, and inserts is if it
1251appropriate. You can set `cperl-electric-parens-string' to the string that
1252contains the parenths from the above list you want to be electrical.
1253Electricity of parenths is controlled by `cperl-electric-parens'.
1254You may also set `cperl-electric-parens-mark' to have electric parens
1255look for active mark and \"embrace\" a region if possible.'
1256
1257CPerl mode provides expansion of the Perl control constructs:
db133cb6 1258
5c8b7eaf 1259 if, else, elsif, unless, while, until, continue, do,
db133cb6
RS
1260 for, foreach, formy and foreachmy.
1261
1262and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1263
1264The user types the keyword immediately followed by a space, which
1265causes the construct to be expanded, and the point is positioned where
1266she is most likely to want to be. eg. when the user types a space
1267following \"if\" the following appears in the buffer: if () { or if ()
1268} { } and the cursor is between the parentheses. The user can then
1269type some boolean expression within the parens. Having done that,
1270typing \\[cperl-linefeed] places you - appropriately indented - on a
1271new line between the braces (if you typed \\[cperl-linefeed] in a POD
5c8b7eaf 1272directive line, then appropriate number of new lines is inserted).
db133cb6
RS
1273
1274If CPerl decides that you want to insert \"English\" style construct like
1275
f83d2997 1276 bite if angry;
db133cb6
RS
1277
1278it will not do any expansion. See also help on variable
1279`cperl-extra-newline-before-brace'. (Note that one can switch the
1280help message on expansion by setting `cperl-message-electric-keyword'
1281to nil.)
f83d2997
KH
1282
1283\\[cperl-linefeed] is a convenience replacement for typing carriage
1284return. It places you in the next line with proper indentation, or if
1285you type it inside the inline block of control construct, like
db133cb6 1286
f83d2997 1287 foreach (@lines) {print; print}
db133cb6 1288
f83d2997
KH
1289and you are on a boundary of a statement inside braces, it will
1290transform the construct into a multiline and will place you into an
5c8b7eaf
SS
1291appropriately indented blank line. If you need a usual
1292`newline-and-indent' behaviour, it is on \\[newline-and-indent],
f83d2997
KH
1293see documentation on `cperl-electric-linefeed'.
1294
db133cb6
RS
1295Use \\[cperl-invert-if-unless] to change a construction of the form
1296
1297 if (A) { B }
1298
1299into
1300
1301 B if A;
1302
f83d2997
KH
1303\\{cperl-mode-map}
1304
db133cb6
RS
1305Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1306\(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1307on electric space between $ and {, `cperl-electric-parens-string' is
1308the string that contains parentheses that should be electric in CPerl
1309\(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
f83d2997
KH
1310setting `cperl-electric-keywords' enables electric expansion of
1311control structures in CPerl. `cperl-electric-linefeed' governs which
1312one of two linefeed behavior is preferable. You can enable all these
1313options simultaneously (recommended mode of use) by setting
1314`cperl-hairy' to t. In this case you can switch separate options off
db133cb6
RS
1315by setting them to `null'. Note that one may undo the extra
1316whitespace inserted by semis and braces in `auto-newline'-mode by
1317consequent \\[cperl-electric-backspace].
f83d2997
KH
1318
1319If your site has perl5 documentation in info format, you can use commands
1320\\[cperl-info-on-current-command] and \\[cperl-info-on-command] to access it.
1321These keys run commands `cperl-info-on-current-command' and
1322`cperl-info-on-command', which one is which is controlled by variable
5c8b7eaf 1323`cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
db133cb6 1324\(in turn affected by `cperl-hairy').
f83d2997
KH
1325
1326Even if you have no info-format documentation, short one-liner-style
db133cb6
RS
1327help is available on \\[cperl-get-help], and one can run perldoc or
1328man via menu.
f83d2997 1329
db133cb6
RS
1330It is possible to show this help automatically after some idle time.
1331This is regulated by variable `cperl-lazy-help-time'. Default with
1332`cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1333secs idle time . It is also possible to switch this on/off from the
1334menu, or via \\[cperl-toggle-autohelp]. Requires `run-with-idle-timer'.
f83d2997
KH
1335
1336Use \\[cperl-lineup] to vertically lineup some construction - put the
1337beginning of the region at the start of construction, and make region
1338span the needed amount of lines.
1339
1340Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1341`cperl-pod-face', `cperl-pod-head-face' control processing of pod and
db133cb6
RS
1342here-docs sections. With capable Emaxen results of scan are used
1343for indentation too, otherwise they are used for highlighting only.
f83d2997
KH
1344
1345Variables controlling indentation style:
1346 `cperl-tab-always-indent'
1347 Non-nil means TAB in CPerl mode should always reindent the current line,
1348 regardless of where in the line point is when the TAB command is used.
db133cb6
RS
1349 `cperl-indent-left-aligned-comments'
1350 Non-nil means that the comment starting in leftmost column should indent.
f83d2997
KH
1351 `cperl-auto-newline'
1352 Non-nil means automatically newline before and after braces,
1353 and after colons and semicolons, inserted in Perl code. The following
1354 \\[cperl-electric-backspace] will remove the inserted whitespace.
5c8b7eaf
SS
1355 Insertion after colons requires both this variable and
1356 `cperl-auto-newline-after-colon' set.
f83d2997
KH
1357 `cperl-auto-newline-after-colon'
1358 Non-nil means automatically newline even after colons.
1359 Subject to `cperl-auto-newline' setting.
1360 `cperl-indent-level'
1361 Indentation of Perl statements within surrounding block.
1362 The surrounding block's indentation is the indentation
1363 of the line on which the open-brace appears.
1364 `cperl-continued-statement-offset'
1365 Extra indentation given to a substatement, such as the
1366 then-clause of an if, or body of a while, or just a statement continuation.
1367 `cperl-continued-brace-offset'
1368 Extra indentation given to a brace that starts a substatement.
1369 This is in addition to `cperl-continued-statement-offset'.
1370 `cperl-brace-offset'
1371 Extra indentation for line if it starts with an open brace.
1372 `cperl-brace-imaginary-offset'
1373 An open brace following other text is treated as if it the line started
1374 this far to the right of the actual line indentation.
1375 `cperl-label-offset'
1376 Extra indentation for line that is a label.
1377 `cperl-min-label-indent'
1378 Minimal indentation for line that is a label.
1379
1380Settings for K&R and BSD indentation styles are
1381 `cperl-indent-level' 5 8
1382 `cperl-continued-statement-offset' 5 8
1383 `cperl-brace-offset' -5 -8
1384 `cperl-label-offset' -5 -8
1385
db133cb6
RS
1386CPerl knows several indentation styles, and may bulk set the
1387corresponding variables. Use \\[cperl-set-style] to do this. Use
1388\\[cperl-set-style-back] to restore the memorized preexisting values
1389\(both available from menu).
1390
1391If `cperl-indent-level' is 0, the statement after opening brace in
5c8b7eaf 1392column 0 is indented on
db133cb6 1393`cperl-brace-offset'+`cperl-continued-statement-offset'.
f83d2997
KH
1394
1395Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
db133cb6
RS
1396with no args.
1397
1398DO NOT FORGET to read micro-docs (available from `Perl' menu)
1399or as help on variables `cperl-tips', `cperl-problems',
1400`cperl-non-problems', `cperl-praise', `cperl-speed'."
f83d2997
KH
1401 (interactive)
1402 (kill-all-local-variables)
f83d2997
KH
1403 (use-local-map cperl-mode-map)
1404 (if (cperl-val 'cperl-electric-linefeed)
1405 (progn
1406 (local-set-key "\C-J" 'cperl-linefeed)
1407 (local-set-key "\C-C\C-J" 'newline-and-indent)))
db133cb6
RS
1408 (if (and
1409 (cperl-val 'cperl-clobber-lisp-bindings)
1410 (cperl-val 'cperl-info-on-command-no-prompt))
f83d2997
KH
1411 (progn
1412 ;; don't clobber the backspace binding:
1413 (cperl-define-key "\C-hf" 'cperl-info-on-current-command [(control h) f])
1414 (cperl-define-key "\C-c\C-hf" 'cperl-info-on-command
1415 [(control c) (control h) f])))
1416 (setq major-mode 'perl-mode)
1417 (setq mode-name "CPerl")
1418 (if (not cperl-mode-abbrev-table)
1419 (let ((prev-a-c abbrevs-changed))
1420 (define-abbrev-table 'cperl-mode-abbrev-table '(
1421 ("if" "if" cperl-electric-keyword 0)
1422 ("elsif" "elsif" cperl-electric-keyword 0)
1423 ("while" "while" cperl-electric-keyword 0)
1424 ("until" "until" cperl-electric-keyword 0)
1425 ("unless" "unless" cperl-electric-keyword 0)
1426 ("else" "else" cperl-electric-else 0)
db133cb6 1427 ("continue" "continue" cperl-electric-else 0)
f83d2997
KH
1428 ("for" "for" cperl-electric-keyword 0)
1429 ("foreach" "foreach" cperl-electric-keyword 0)
db133cb6
RS
1430 ("formy" "formy" cperl-electric-keyword 0)
1431 ("foreachmy" "foreachmy" cperl-electric-keyword 0)
1432 ("do" "do" cperl-electric-keyword 0)
1433 ("pod" "pod" cperl-electric-pod 0)
1434 ("over" "over" cperl-electric-pod 0)
1435 ("head1" "head1" cperl-electric-pod 0)
1436 ("head2" "head2" cperl-electric-pod 0)))
f83d2997
KH
1437 (setq abbrevs-changed prev-a-c)))
1438 (setq local-abbrev-table cperl-mode-abbrev-table)
1439 (abbrev-mode (if (cperl-val 'cperl-electric-keywords) 1 0))
1440 (set-syntax-table cperl-mode-syntax-table)
1441 (make-local-variable 'paragraph-start)
1442 (setq paragraph-start (concat "^$\\|" page-delimiter))
1443 (make-local-variable 'paragraph-separate)
1444 (setq paragraph-separate paragraph-start)
1445 (make-local-variable 'paragraph-ignore-fill-prefix)
1446 (setq paragraph-ignore-fill-prefix t)
1447 (make-local-variable 'indent-line-function)
1448 (setq indent-line-function 'cperl-indent-line)
1449 (make-local-variable 'require-final-newline)
1450 (setq require-final-newline t)
1451 (make-local-variable 'comment-start)
1452 (setq comment-start "# ")
1453 (make-local-variable 'comment-end)
1454 (setq comment-end "")
1455 (make-local-variable 'comment-column)
1456 (setq comment-column cperl-comment-column)
1457 (make-local-variable 'comment-start-skip)
1458 (setq comment-start-skip "#+ *")
1459 (make-local-variable 'defun-prompt-regexp)
1460 (setq defun-prompt-regexp "^[ \t]*sub[ \t]+\\([^ \t\n{(;]+\\)[ \t]*")
1461 (make-local-variable 'comment-indent-function)
1462 (setq comment-indent-function 'cperl-comment-indent)
1463 (make-local-variable 'parse-sexp-ignore-comments)
1464 (setq parse-sexp-ignore-comments t)
1465 (make-local-variable 'indent-region-function)
1466 (setq indent-region-function 'cperl-indent-region)
1467 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1468 (make-local-variable 'imenu-create-index-function)
1469 (setq imenu-create-index-function
80585273 1470 (function cperl-imenu--create-perl-index))
f83d2997
KH
1471 (make-local-variable 'imenu-sort-function)
1472 (setq imenu-sort-function nil)
1473 (make-local-variable 'vc-header-alist)
db133cb6 1474 (set 'vc-header-alist cperl-vc-header-alist) ; Avoid warning
f83d2997
KH
1475 (make-local-variable 'font-lock-defaults)
1476 (setq font-lock-defaults
db133cb6
RS
1477 (cond
1478 ((string< emacs-version "19.30")
1479 '(perl-font-lock-keywords-2))
1480 ((string< emacs-version "19.33") ; Which one to use?
f83d2997
KH
1481 '((perl-font-lock-keywords
1482 perl-font-lock-keywords-1
db133cb6
RS
1483 perl-font-lock-keywords-2)))
1484 (t
1485 '((cperl-load-font-lock-keywords
1486 cperl-load-font-lock-keywords-1
1487 cperl-load-font-lock-keywords-2)))))
1488 (make-local-variable 'cperl-syntax-state)
f83d2997
KH
1489 (if cperl-use-syntax-table-text-property
1490 (progn
1491 (make-variable-buffer-local 'parse-sexp-lookup-properties)
1492 ;; Do not introduce variable if not needed, we check it!
db133cb6
RS
1493 (set 'parse-sexp-lookup-properties t)
1494 ;; Fix broken font-lock:
1495 (or (boundp 'font-lock-unfontify-region-function)
1496 (set 'font-lock-unfontify-region-function
5bd52f0e 1497 'font-lock-default-unfontify-region))
db133cb6 1498 (make-variable-buffer-local 'font-lock-unfontify-region-function)
5c8b7eaf 1499 (set 'font-lock-unfontify-region-function
db133cb6
RS
1500 'cperl-font-lock-unfontify-region-function)
1501 (make-variable-buffer-local 'cperl-syntax-done-to)
1502 ;; Another bug: unless font-lock-syntactic-keywords, font-lock
1503 ;; ignores syntax-table text-property. (t) is a hack
1504 ;; to make font-lock think that font-lock-syntactic-keywords
1505 ;; are defined
1506 (make-variable-buffer-local 'font-lock-syntactic-keywords)
5c8b7eaf 1507 (setq font-lock-syntactic-keywords
db133cb6
RS
1508 (if cperl-syntaxify-by-font-lock
1509 '(t (cperl-fontify-syntaxically))
1510 '(t)))))
1511 (make-local-variable 'cperl-old-style)
80585273
DL
1512 (set (make-local-variable 'normal-auto-fill-function)
1513 #'cperl-old-auto-fill-mode)
f83d2997 1514 (if (cperl-enable-font-lock)
5c8b7eaf 1515 (if (cperl-val 'cperl-font-lock)
f83d2997
KH
1516 (progn (or cperl-faces-init (cperl-init-faces))
1517 (font-lock-mode 1))))
1518 (and (boundp 'msb-menu-cond)
1519 (not cperl-msb-fixed)
1520 (cperl-msb-fix))
1521 (if (featurep 'easymenu)
46c72468 1522 (easy-menu-add cperl-menu)) ; A NOP in Emacs.
f83d2997
KH
1523 (run-hooks 'cperl-mode-hook)
1524 ;; After hooks since fontification will break this
5c8b7eaf 1525 (if cperl-pod-here-scan
5bd52f0e
RS
1526 (or ;;(and (boundp 'font-lock-mode)
1527 ;; (eval 'font-lock-mode) ; Avoid warning
1528 ;; (boundp 'font-lock-hot-pass) ; Newer font-lock
1529 cperl-syntaxify-by-font-lock ;;)
1530 (progn (or cperl-faces-init (cperl-init-faces-weak))
1531 (cperl-find-pods-heres)))))
f83d2997
KH
1532\f
1533;; Fix for perldb - make default reasonable
1534(defun cperl-db ()
1535 (interactive)
1536 (require 'gud)
1537 (perldb (read-from-minibuffer "Run perldb (like this): "
1538 (if (consp gud-perldb-history)
1539 (car gud-perldb-history)
1540 (concat "perl " ;;(file-name-nondirectory
1541 ;; I have problems
1542 ;; in OS/2
1543 ;; otherwise
1544 (buffer-file-name)))
1545 nil nil
1546 '(gud-perldb-history . 1))))
1547\f
f83d2997
KH
1548(defun cperl-msb-fix ()
1549 ;; Adds perl files to msb menu, supposes that msb is already loaded
1550 (setq cperl-msb-fixed t)
1551 (let* ((l (length msb-menu-cond))
1552 (last (nth (1- l) msb-menu-cond))
1553 (precdr (nthcdr (- l 2) msb-menu-cond)) ; cdr of this is last
1554 (handle (1- (nth 1 last))))
1555 (setcdr precdr (list
1556 (list
1557 '(eq major-mode 'perl-mode)
1558 handle
1559 "Perl Files (%d)")
1560 last))))
1561\f
1562;; This is used by indent-for-comment
1563;; to decide how much to indent a comment in CPerl code
1564;; based on its context. Do fallback if comment is found wrong.
1565
1566(defvar cperl-wrong-comment)
5bd52f0e
RS
1567(defvar cperl-st-cfence '(14)) ; Comment-fence
1568(defvar cperl-st-sfence '(15)) ; String-fence
1569(defvar cperl-st-punct '(1))
1570(defvar cperl-st-word '(2))
1571(defvar cperl-st-bra '(4 . ?\>))
1572(defvar cperl-st-ket '(5 . ?\<))
1573
f83d2997
KH
1574
1575(defun cperl-comment-indent ()
5bd52f0e 1576 (let ((p (point)) (c (current-column)) was phony)
f83d2997
KH
1577 (if (looking-at "^#") 0 ; Existing comment at bol stays there.
1578 ;; Wrong comment found
1579 (save-excursion
5bd52f0e
RS
1580 (setq was (cperl-to-comment-or-eol)
1581 phony (eq (get-text-property (point) 'syntax-table)
1582 cperl-st-cfence))
1583 (if phony
1584 (progn
1585 (re-search-forward "#\\|$") ; Hmm, what about embedded #?
1586 (if (eq (preceding-char) ?\#)
1587 (forward-char -1))
1588 (setq was nil)))
f83d2997
KH
1589 (if (= (point) p)
1590 (progn
1591 (skip-chars-backward " \t")
1592 (max (1+ (current-column)) ; Else indent at comment column
1593 comment-column))
1594 (if was nil
1595 (insert comment-start)
1596 (backward-char (length comment-start)))
1597 (setq cperl-wrong-comment t)
1598 (indent-to comment-column 1) ; Indent minimum 1
1599 c))))) ; except leave at least one space.
1600
1601;;;(defun cperl-comment-indent-fallback ()
1602;;; "Is called if the standard comment-search procedure fails.
1603;;;Point is at start of real comment."
1604;;; (let ((c (current-column)) target cnt prevc)
1605;;; (if (= c comment-column) nil
1606;;; (setq cnt (skip-chars-backward "[ \t]"))
5c8b7eaf 1607;;; (setq target (max (1+ (setq prevc
f83d2997
KH
1608;;; (current-column))) ; Else indent at comment column
1609;;; comment-column))
1610;;; (if (= c comment-column) nil
1611;;; (delete-backward-char cnt)
1612;;; (while (< prevc target)
1613;;; (insert "\t")
1614;;; (setq prevc (current-column)))
1615;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1616;;; (while (< prevc target)
1617;;; (insert " ")
1618;;; (setq prevc (current-column)))))))
1619
1620(defun cperl-indent-for-comment ()
1621 "Substitute for `indent-for-comment' in CPerl."
1622 (interactive)
1623 (let (cperl-wrong-comment)
1624 (indent-for-comment)
1625 (if cperl-wrong-comment
1626 (progn (cperl-to-comment-or-eol)
1627 (forward-char (length comment-start))))))
1628
1629(defun cperl-comment-region (b e arg)
1630 "Comment or uncomment each line in the region in CPerl mode.
1631See `comment-region'."
1632 (interactive "r\np")
1633 (let ((comment-start "#"))
1634 (comment-region b e arg)))
1635
1636(defun cperl-uncomment-region (b e arg)
1637 "Uncomment or comment each line in the region in CPerl mode.
1638See `comment-region'."
1639 (interactive "r\np")
1640 (let ((comment-start "#"))
1641 (comment-region b e (- arg))))
1642
1643(defvar cperl-brace-recursing nil)
1644
1645(defun cperl-electric-brace (arg &optional only-before)
1646 "Insert character and correct line's indentation.
1647If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1648place (even in empty line), but not after. If after \")\" and the inserted
5c8b7eaf 1649char is \"{\", insert extra newline before only if
f83d2997
KH
1650`cperl-extra-newline-before-brace'."
1651 (interactive "P")
1652 (let (insertpos
1653 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 1654 (cperl-mark-active)
f83d2997 1655 (< (mark) (point)))
5c8b7eaf 1656 (mark)
f83d2997
KH
1657 nil)))
1658 (if (and other-end
1659 (not cperl-brace-recursing)
1660 (cperl-val 'cperl-electric-parens)
1661 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point)))
1662 ;; Need to insert a matching pair
1663 (progn
1664 (save-excursion
1665 (setq insertpos (point-marker))
1666 (goto-char other-end)
1667 (setq last-command-char ?\{)
1668 (cperl-electric-lbrace arg insertpos))
1669 (forward-char 1))
db133cb6
RS
1670 ;: Check whether we close something "usual" with `}'
1671 (if (and (eq last-command-char ?\})
5c8b7eaf 1672 (not
db133cb6
RS
1673 (condition-case nil
1674 (save-excursion
1675 (up-list (- (prefix-numeric-value arg)))
1676 ;;(cperl-after-block-p (point-min))
1677 (cperl-after-expr-p nil "{;)"))
1678 (error nil))))
1679 ;; Just insert the guy
1680 (self-insert-command (prefix-numeric-value arg))
1681 (if (and (not arg) ; No args, end (of empty line or auto)
1682 (eolp)
1683 (or (and (null only-before)
1684 (save-excursion
1685 (skip-chars-backward " \t")
1686 (bolp)))
1687 (and (eq last-command-char ?\{) ; Do not insert newline
1688 ;; if after ")" and `cperl-extra-newline-before-brace'
1689 ;; is nil, do not insert extra newline.
1690 (not cperl-extra-newline-before-brace)
1691 (save-excursion
1692 (skip-chars-backward " \t")
1693 (eq (preceding-char) ?\))))
5c8b7eaf 1694 (if cperl-auto-newline
db133cb6
RS
1695 (progn (cperl-indent-line) (newline) t) nil)))
1696 (progn
1697 (self-insert-command (prefix-numeric-value arg))
1698 (cperl-indent-line)
1699 (if cperl-auto-newline
1700 (setq insertpos (1- (point))))
1701 (if (and cperl-auto-newline (null only-before))
1702 (progn
1703 (newline)
1704 (cperl-indent-line)))
1705 (save-excursion
1706 (if insertpos (progn (goto-char insertpos)
5c8b7eaf 1707 (search-forward (make-string
db133cb6
RS
1708 1 last-command-char))
1709 (setq insertpos (1- (point)))))
1710 (delete-char -1))))
1711 (if insertpos
f83d2997 1712 (save-excursion
db133cb6
RS
1713 (goto-char insertpos)
1714 (self-insert-command (prefix-numeric-value arg)))
1715 (self-insert-command (prefix-numeric-value arg)))))))
f83d2997
KH
1716
1717(defun cperl-electric-lbrace (arg &optional end)
1718 "Insert character, correct line's indentation, correct quoting by space."
1719 (interactive "P")
5c8b7eaf 1720 (let (pos after
f83d2997
KH
1721 (cperl-brace-recursing t)
1722 (cperl-auto-newline cperl-auto-newline)
1723 (other-end (or end
1724 (if (and cperl-electric-parens-mark
1725 (cperl-mark-active)
1726 (> (mark) (point)))
1727 (save-excursion
1728 (goto-char (mark))
5c8b7eaf 1729 (point-marker))
f83d2997
KH
1730 nil))))
1731 (and (cperl-val 'cperl-electric-lbrace-space)
1732 (eq (preceding-char) ?$)
1733 (save-excursion
1734 (skip-chars-backward "$")
1735 (looking-at "\\(\\$\\$\\)*\\$\\([^\\$]\\|$\\)"))
1736 (insert ?\ ))
bab27c0c 1737 ;; Check whether we are in comment
5c8b7eaf 1738 (if (and
bab27c0c
RS
1739 (save-excursion
1740 (beginning-of-line)
1741 (not (looking-at "[ \t]*#")))
1742 (cperl-after-expr-p nil "{;)"))
1743 nil
1744 (setq cperl-auto-newline nil))
f83d2997
KH
1745 (cperl-electric-brace arg)
1746 (and (cperl-val 'cperl-electric-parens)
1747 (eq last-command-char ?{)
5c8b7eaf 1748 (memq last-command-char
f83d2997
KH
1749 (append cperl-electric-parens-string nil))
1750 (or (if other-end (goto-char (marker-position other-end)))
1751 t)
1752 (setq last-command-char ?} pos (point))
1753 (progn (cperl-electric-brace arg t)
1754 (goto-char pos)))))
1755
1756(defun cperl-electric-paren (arg)
1757 "Insert a matching pair of parentheses."
1758 (interactive "P")
1759 (let ((beg (save-excursion (beginning-of-line) (point)))
1760 (other-end (if (and cperl-electric-parens-mark
5c8b7eaf 1761 (cperl-mark-active)
f83d2997
KH
1762 (> (mark) (point)))
1763 (save-excursion
1764 (goto-char (mark))
5c8b7eaf 1765 (point-marker))
f83d2997
KH
1766 nil)))
1767 (if (and (cperl-val 'cperl-electric-parens)
1768 (memq last-command-char
1769 (append cperl-electric-parens-string nil))
1770 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1771 ;;(not (save-excursion (search-backward "#" beg t)))
1772 (if (eq last-command-char ?<)
1773 (progn
1774 (and abbrev-mode ; later it is too late, may be after `for'
1775 (expand-abbrev))
1776 (cperl-after-expr-p nil "{;(,:="))
1777 1))
1778 (progn
1779 (self-insert-command (prefix-numeric-value arg))
1780 (if other-end (goto-char (marker-position other-end)))
5c8b7eaf 1781 (insert (make-string
f83d2997
KH
1782 (prefix-numeric-value arg)
1783 (cdr (assoc last-command-char '((?{ .?})
1784 (?[ . ?])
1785 (?( . ?))
1786 (?< . ?>))))))
1787 (forward-char (- (prefix-numeric-value arg))))
1788 (self-insert-command (prefix-numeric-value arg)))))
1789
1790(defun cperl-electric-rparen (arg)
1791 "Insert a matching pair of parentheses if marking is active.
1792If not, or if we are not at the end of marking range, would self-insert."
1793 (interactive "P")
1794 (let ((beg (save-excursion (beginning-of-line) (point)))
1795 (other-end (if (and cperl-electric-parens-mark
1796 (cperl-val 'cperl-electric-parens)
1797 (memq last-command-char
1798 (append cperl-electric-parens-string nil))
5c8b7eaf 1799 (cperl-mark-active)
f83d2997 1800 (< (mark) (point)))
5c8b7eaf 1801 (mark)
f83d2997
KH
1802 nil))
1803 p)
1804 (if (and other-end
1805 (cperl-val 'cperl-electric-parens)
1806 (memq last-command-char '( ?\) ?\] ?\} ?\> ))
1807 (>= (save-excursion (cperl-to-comment-or-eol) (point)) (point))
1808 ;;(not (save-excursion (search-backward "#" beg t)))
1809 )
1810 (progn
1811 (self-insert-command (prefix-numeric-value arg))
1812 (setq p (point))
1813 (if other-end (goto-char other-end))
1814 (insert (make-string
1815 (prefix-numeric-value arg)
1816 (cdr (assoc last-command-char '((?\} . ?\{)
1817 (?\] . ?\[)
1818 (?\) . ?\()
1819 (?\> . ?\<))))))
1820 (goto-char (1+ p)))
1821 (self-insert-command (prefix-numeric-value arg)))))
1822
1823(defun cperl-electric-keyword ()
db133cb6
RS
1824 "Insert a construction appropriate after a keyword.
1825Help message may be switched off by setting `cperl-message-electric-keyword'
1826to nil."
5c8b7eaf 1827 (let ((beg (save-excursion (beginning-of-line) (point)))
f83d2997
KH
1828 (dollar (and (eq last-command-char ?$)
1829 (eq this-command 'self-insert-command)))
1830 (delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
db133cb6
RS
1831 (memq this-command '(self-insert-command newline))))
1832 my do)
f83d2997 1833 (and (save-excursion
db133cb6
RS
1834 (condition-case nil
1835 (progn
1836 (backward-sexp 1)
1837 (setq do (looking-at "do\\>")))
1838 (error nil))
f83d2997 1839 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
1840 (save-excursion
1841 (not
f83d2997 1842 (re-search-backward
5bd52f0e 1843 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
1844 beg t)))
1845 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
1846 (or
1847 (looking-at "=cut")
1848 (and cperl-use-syntax-table-text-property
1849 (not (eq (get-text-property (point)
1850 'syntax-type)
1851 'pod))))))
f83d2997 1852 (progn
db133cb6
RS
1853 (and (eq (preceding-char) ?y)
1854 (progn ; "foreachmy"
1855 (forward-char -2)
1856 (insert " ")
1857 (forward-char 2)
5c8b7eaf
SS
1858 (setq my t dollar t
1859 delete
db133cb6 1860 (memq this-command '(self-insert-command newline)))))
f83d2997
KH
1861 (and dollar (insert " $"))
1862 (cperl-indent-line)
1863 ;;(insert " () {\n}")
1864 (cond
1865 (cperl-extra-newline-before-brace
db133cb6 1866 (insert (if do "\n" " ()\n"))
f83d2997
KH
1867 (insert "{")
1868 (cperl-indent-line)
1869 (insert "\n")
1870 (cperl-indent-line)
db133cb6
RS
1871 (insert "\n}")
1872 (and do (insert " while ();")))
f83d2997 1873 (t
db133cb6 1874 (insert (if do " {\n} while ();" " () {\n}")))
f83d2997
KH
1875 )
1876 (or (looking-at "[ \t]\\|$") (insert " "))
1877 (cperl-indent-line)
1878 (if dollar (progn (search-backward "$")
5c8b7eaf 1879 (if my
db133cb6
RS
1880 (forward-char 1)
1881 (delete-char 1)))
f83d2997
KH
1882 (search-backward ")"))
1883 (if delete
db133cb6
RS
1884 (cperl-putback-char cperl-del-back-ch))
1885 (if cperl-message-electric-keyword
1886 (message "Precede char by C-q to avoid expansion"))))))
1887
1888(defun cperl-ensure-newlines (n &optional pos)
1889 "Make sure there are N newlines after the point."
1890 (or pos (setq pos (point)))
1891 (if (looking-at "\n")
1892 (forward-char 1)
1893 (insert "\n"))
1894 (if (> n 1)
1895 (cperl-ensure-newlines (1- n) pos)
1896 (goto-char pos)))
1897
1898(defun cperl-electric-pod ()
1899 "Insert a POD chunk appropriate after a =POD directive."
1900 (let ((delete (and (memq last-command-char '(?\ ?\n ?\t ?\f))
1901 (memq this-command '(self-insert-command newline))))
1902 head1 notlast name p really-delete over)
1903 (and (save-excursion
1904 (condition-case nil
1905 (backward-sexp 1)
1906 (error nil))
5c8b7eaf 1907 (and
db133cb6
RS
1908 (eq (preceding-char) ?=)
1909 (progn
1910 (setq head1 (looking-at "head1\\>"))
1911 (setq over (looking-at "over\\>"))
1912 (forward-char -1)
1913 (bolp))
5c8b7eaf 1914 (or
5bd52f0e 1915 (get-text-property (point) 'in-pod)
db133cb6
RS
1916 (cperl-after-expr-p nil "{;:")
1917 (and (re-search-backward
1918 "\\(\\`\n?\\|\n\n\\)=\\sw+" (point-min) t)
1919 (not (or
1920 (looking-at "=cut")
1921 (and cperl-use-syntax-table-text-property
1922 (not (eq (get-text-property (point) 'syntax-type)
1923 'pod)))))))))
1924 (progn
1925 (save-excursion
1926 (setq notlast (search-forward "\n\n=" nil t)))
1927 (or notlast
1928 (progn
1929 (insert "\n\n=cut")
1930 (cperl-ensure-newlines 2)
1931 (forward-sexp -2)
5c8b7eaf
SS
1932 (if (and head1
1933 (not
db133cb6
RS
1934 (save-excursion
1935 (forward-char -1)
1936 (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\>"
1937 nil t)))) ; Only one
5c8b7eaf 1938 (progn
db133cb6
RS
1939 (forward-sexp 1)
1940 (setq name (file-name-sans-extension
1941 (file-name-nondirectory (buffer-file-name)))
1942 p (point))
5c8b7eaf 1943 (insert " NAME\n\n" name
db133cb6
RS
1944 " - \n\n=head1 SYNOPSYS\n\n\n\n"
1945 "=head1 DESCRIPTION")
1946 (cperl-ensure-newlines 4)
1947 (goto-char p)
1948 (forward-sexp 2)
1949 (end-of-line)
1950 (setq really-delete t))
1951 (forward-sexp 1))))
1952 (if over
1953 (progn
1954 (setq p (point))
1955 (insert "\n\n=item \n\n\n\n"
1956 "=back")
1957 (cperl-ensure-newlines 2)
1958 (goto-char p)
1959 (forward-sexp 1)
1960 (end-of-line)
1961 (setq really-delete t)))
1962 (if (and delete really-delete)
f83d2997
KH
1963 (cperl-putback-char cperl-del-back-ch))))))
1964
1965(defun cperl-electric-else ()
db133cb6
RS
1966 "Insert a construction appropriate after a keyword.
1967Help message may be switched off by setting `cperl-message-electric-keyword'
1968to nil."
f83d2997
KH
1969 (let ((beg (save-excursion (beginning-of-line) (point))))
1970 (and (save-excursion
1971 (backward-sexp 1)
1972 (cperl-after-expr-p nil "{;:"))
5c8b7eaf
SS
1973 (save-excursion
1974 (not
f83d2997 1975 (re-search-backward
5bd52f0e 1976 "[#\"'`]\\|\\<q\\(\\|[wqxr]\\)\\>"
f83d2997
KH
1977 beg t)))
1978 (save-excursion (or (not (re-search-backward "^=" nil t))
db133cb6
RS
1979 (looking-at "=cut")
1980 (and cperl-use-syntax-table-text-property
1981 (not (eq (get-text-property (point)
1982 'syntax-type)
1983 'pod)))))
f83d2997
KH
1984 (progn
1985 (cperl-indent-line)
1986 ;;(insert " {\n\n}")
1987 (cond
1988 (cperl-extra-newline-before-brace
1989 (insert "\n")
1990 (insert "{")
1991 (cperl-indent-line)
1992 (insert "\n\n}"))
1993 (t
1994 (insert " {\n\n}"))
1995 )
1996 (or (looking-at "[ \t]\\|$") (insert " "))
1997 (cperl-indent-line)
1998 (forward-line -1)
1999 (cperl-indent-line)
db133cb6
RS
2000 (cperl-putback-char cperl-del-back-ch)
2001 (setq this-command 'cperl-electric-else)
2002 (if cperl-message-electric-keyword
2003 (message "Precede char by C-q to avoid expansion"))))))
f83d2997
KH
2004
2005(defun cperl-linefeed ()
db133cb6
RS
2006 "Go to end of line, open a new line and indent appropriately.
2007If in POD, insert appropriate lines."
f83d2997
KH
2008 (interactive)
2009 (let ((beg (save-excursion (beginning-of-line) (point)))
2010 (end (save-excursion (end-of-line) (point)))
db133cb6 2011 (pos (point)) start over cut res)
f83d2997 2012 (if (and ; Check if we need to split:
5c8b7eaf 2013 ; i.e., on a boundary and inside "{...}"
f83d2997
KH
2014 (save-excursion (cperl-to-comment-or-eol)
2015 (>= (point) pos)) ; Not in a comment
2016 (or (save-excursion
2017 (skip-chars-backward " \t" beg)
2018 (forward-char -1)
2019 (looking-at "[;{]")) ; After { or ; + spaces
2020 (looking-at "[ \t]*}") ; Before }
2021 (re-search-forward "\\=[ \t]*;" end t)) ; Before spaces + ;
2022 (save-excursion
2023 (and
5c8b7eaf 2024 (eq (car (parse-partial-sexp pos end -1)) -1)
f83d2997
KH
2025 ; Leave the level of parens
2026 (looking-at "[,; \t]*\\($\\|#\\)") ; Comma to allow anon subr
2027 ; Are at end
2028 (progn
2029 (backward-sexp 1)
2030 (setq start (point-marker))
db133cb6 2031 (<= start pos))))) ; Redundant? Are after the
f83d2997
KH
2032 ; start of parens group.
2033 (progn
2034 (skip-chars-backward " \t")
2035 (or (memq (preceding-char) (append ";{" nil))
2036 (insert ";"))
2037 (insert "\n")
2038 (forward-line -1)
2039 (cperl-indent-line)
2040 (goto-char start)
2041 (or (looking-at "{[ \t]*$") ; If there is a statement
2042 ; before, move it to separate line
2043 (progn
2044 (forward-char 1)
2045 (insert "\n")
2046 (cperl-indent-line)))
2047 (forward-line 1) ; We are on the target line
2048 (cperl-indent-line)
2049 (beginning-of-line)
2050 (or (looking-at "[ \t]*}[,; \t]*$") ; If there is a statement
2051 ; after, move it to separate line
2052 (progn
2053 (end-of-line)
2054 (search-backward "}" beg)
2055 (skip-chars-backward " \t")
2056 (or (memq (preceding-char) (append ";{" nil))
2057 (insert ";"))
2058 (insert "\n")
2059 (cperl-indent-line)
2060 (forward-line -1)))
5c8b7eaf 2061 (forward-line -1) ; We are on the line before target
f83d2997
KH
2062 (end-of-line)
2063 (newline-and-indent))
db133cb6 2064 (end-of-line) ; else - no splitting
f83d2997
KH
2065 (cond
2066 ((and (looking-at "\n[ \t]*{$")
2067 (save-excursion
2068 (skip-chars-backward " \t")
2069 (eq (preceding-char) ?\)))) ; Probably if () {} group
2070 ; with an extra newline.
2071 (forward-line 2)
2072 (cperl-indent-line))
db133cb6
RS
2073 ((save-excursion ; In POD header
2074 (forward-paragraph -1)
2075 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2076 ;; We are after \n now, so look for the rest
2077 (if (looking-at "\\(\\`\n?\\|\n\\)=\\sw+")
5c8b7eaf 2078 (progn
db133cb6
RS
2079 (setq cut (looking-at "\\(\\`\n?\\|\n\\)=cut\\>"))
2080 (setq over (looking-at "\\(\\`\n?\\|\n\\)=over\\>"))
2081 t)))
2082 (if (and over
2083 (progn
2084 (forward-paragraph -1)
2085 (forward-word 1)
2086 (setq pos (point))
2087 (setq cut (buffer-substring (point)
2088 (save-excursion
2089 (end-of-line)
2090 (point))))
2091 (delete-char (- (save-excursion (end-of-line) (point))
2092 (point)))
2093 (setq res (expand-abbrev))
2094 (save-excursion
2095 (goto-char pos)
2096 (insert cut))
2097 res))
2098 nil
2099 (cperl-ensure-newlines (if cut 2 4))
2100 (forward-line 2)))
2101 ((get-text-property (point) 'in-pod) ; In POD section
2102 (cperl-ensure-newlines 4)
2103 (forward-line 2))
f83d2997
KH
2104 ((looking-at "\n[ \t]*$") ; Next line is empty - use it.
2105 (forward-line 1)
2106 (cperl-indent-line))
2107 (t
2108 (newline-and-indent))))))
2109
2110(defun cperl-electric-semi (arg)
2111 "Insert character and correct line's indentation."
2112 (interactive "P")
2113 (if cperl-auto-newline
2114 (cperl-electric-terminator arg)
2115 (self-insert-command (prefix-numeric-value arg))))
2116
2117(defun cperl-electric-terminator (arg)
2118 "Insert character and correct line's indentation."
2119 (interactive "P")
5c8b7eaf 2120 (let (insertpos (end (point))
f83d2997
KH
2121 (auto (and cperl-auto-newline
2122 (or (not (eq last-command-char ?:))
2123 cperl-auto-newline-after-colon))))
5c8b7eaf 2124 (if (and ;;(not arg)
f83d2997
KH
2125 (eolp)
2126 (not (save-excursion
2127 (beginning-of-line)
2128 (skip-chars-forward " \t")
2129 (or
2130 ;; Ignore in comment lines
2131 (= (following-char) ?#)
2132 ;; Colon is special only after a label
2133 ;; So quickly rule out most other uses of colon
2134 ;; and do no indentation for them.
2135 (and (eq last-command-char ?:)
2136 (save-excursion
2137 (forward-word 1)
2138 (skip-chars-forward " \t")
2139 (and (< (point) end)
2140 (progn (goto-char (- end 1))
2141 (not (looking-at ":"))))))
2142 (progn
2143 (beginning-of-defun)
2144 (let ((pps (parse-partial-sexp (point) end)))
2145 (or (nth 3 pps) (nth 4 pps) (nth 5 pps))))))))
2146 (progn
2147 (self-insert-command (prefix-numeric-value arg))
2148 ;;(forward-char -1)
2149 (if auto (setq insertpos (point-marker)))
2150 ;;(forward-char 1)
2151 (cperl-indent-line)
2152 (if auto
2153 (progn
2154 (newline)
2155 (cperl-indent-line)))
f83d2997
KH
2156 (save-excursion
2157 (if insertpos (goto-char (1- (marker-position insertpos)))
2158 (forward-char -1))
2159 (delete-char 1))))
2160 (if insertpos
2161 (save-excursion
2162 (goto-char insertpos)
2163 (self-insert-command (prefix-numeric-value arg)))
2164 (self-insert-command (prefix-numeric-value arg)))))
2165
2166(defun cperl-electric-backspace (arg)
5c8b7eaf 2167 "Backspace-untabify, or remove the whitespace around the point inserted
db133cb6 2168by an electric key."
f83d2997 2169 (interactive "p")
5c8b7eaf
SS
2170 (if (and cperl-auto-newline
2171 (memq last-command '(cperl-electric-semi
f83d2997
KH
2172 cperl-electric-terminator
2173 cperl-electric-lbrace))
2174 (memq (preceding-char) '(?\ ?\t ?\n)))
2175 (let (p)
5c8b7eaf 2176 (if (eq last-command 'cperl-electric-lbrace)
f83d2997
KH
2177 (skip-chars-forward " \t\n"))
2178 (setq p (point))
2179 (skip-chars-backward " \t\n")
2180 (delete-region (point) p))
db133cb6
RS
2181 (and (eq last-command 'cperl-electric-else)
2182 ;; We are removing the whitespace *inside* cperl-electric-else
2183 (setq this-command 'cperl-electric-else-really))
5c8b7eaf 2184 (if (and cperl-auto-newline
db133cb6
RS
2185 (eq last-command 'cperl-electric-else-really)
2186 (memq (preceding-char) '(?\ ?\t ?\n)))
2187 (let (p)
2188 (skip-chars-forward " \t\n")
2189 (setq p (point))
2190 (skip-chars-backward " \t\n")
2191 (delete-region (point) p))
2192 (backward-delete-char-untabify arg))))
f83d2997
KH
2193
2194(defun cperl-inside-parens-p ()
2195 (condition-case ()
2196 (save-excursion
2197 (save-restriction
2198 (narrow-to-region (point)
2199 (progn (beginning-of-defun) (point)))
2200 (goto-char (point-max))
2201 (= (char-after (or (scan-lists (point) -1 1) (point-min))) ?\()))
2202 (error nil)))
2203\f
2204(defun cperl-indent-command (&optional whole-exp)
2205 "Indent current line as Perl code, or in some cases insert a tab character.
5c8b7eaf 2206If `cperl-tab-always-indent' is non-nil (the default), always indent current
db133cb6 2207line. Otherwise, indent the current line only if point is at the left margin
f83d2997
KH
2208or in the line's indentation; otherwise insert a tab.
2209
2210A numeric argument, regardless of its value,
2211means indent rigidly all the lines of the expression starting after point
2212so that this line becomes properly indented.
2213The relative indentation among the lines of the expression are preserved."
2214 (interactive "P")
5bd52f0e 2215 (cperl-update-syntaxification (point) (point))
f83d2997
KH
2216 (if whole-exp
2217 ;; If arg, always indent this line as Perl
2218 ;; and shift remaining lines of expression the same amount.
2219 (let ((shift-amt (cperl-indent-line))
2220 beg end)
2221 (save-excursion
2222 (if cperl-tab-always-indent
2223 (beginning-of-line))
2224 (setq beg (point))
2225 (forward-sexp 1)
2226 (setq end (point))
2227 (goto-char beg)
2228 (forward-line 1)
2229 (setq beg (point)))
db133cb6 2230 (if (and shift-amt (> end beg))
f83d2997
KH
2231 (indent-code-rigidly beg end shift-amt "#")))
2232 (if (and (not cperl-tab-always-indent)
2233 (save-excursion
2234 (skip-chars-backward " \t")
2235 (not (bolp))))
2236 (insert-tab)
2237 (cperl-indent-line))))
2238
5bd52f0e 2239(defun cperl-indent-line (&optional parse-data)
f83d2997
KH
2240 "Indent current line as Perl code.
2241Return the amount the indentation changed by."
db133cb6 2242 (let (indent i beg shift-amt
f83d2997
KH
2243 (case-fold-search nil)
2244 (pos (- (point-max) (point))))
5bd52f0e 2245 (setq indent (cperl-calculate-indent parse-data)
db133cb6 2246 i indent)
f83d2997
KH
2247 (beginning-of-line)
2248 (setq beg (point))
2249 (cond ((or (eq indent nil) (eq indent t))
db133cb6 2250 (setq indent (current-indentation) i nil))
f83d2997
KH
2251 ;;((eq indent t) ; Never?
2252 ;; (setq indent (cperl-calculate-indent-within-comment)))
2253 ;;((looking-at "[ \t]*#")
2254 ;; (setq indent 0))
2255 (t
2256 (skip-chars-forward " \t")
2257 (if (listp indent) (setq indent (car indent)))
2258 (cond ((looking-at "[A-Za-z_][A-Za-z_0-9]*:[^:]")
2259 (and (> indent 0)
2260 (setq indent (max cperl-min-label-indent
2261 (+ indent cperl-label-offset)))))
2262 ((= (following-char) ?})
2263 (setq indent (- indent cperl-indent-level)))
2264 ((memq (following-char) '(?\) ?\])) ; To line up with opening paren.
2265 (setq indent (+ indent cperl-close-paren-offset)))
2266 ((= (following-char) ?{)
2267 (setq indent (+ indent cperl-brace-offset))))))
2268 (skip-chars-forward " \t")
db133cb6
RS
2269 (setq shift-amt (and i (- indent (current-column))))
2270 (if (or (not shift-amt)
2271 (zerop shift-amt))
f83d2997
KH
2272 (if (> (- (point-max) pos) (point))
2273 (goto-char (- (point-max) pos)))
2274 (delete-region beg (point))
2275 (indent-to indent)
2276 ;; If initial point was within line's indentation,
2277 ;; position after the indentation. Else stay at same point in text.
2278 (if (> (- (point-max) pos) (point))
2279 (goto-char (- (point-max) pos))))
2280 shift-amt))
2281
2282(defun cperl-after-label ()
2283 ;; Returns true if the point is after label. Does not do save-excursion.
2284 (and (eq (preceding-char) ?:)
2285 (memq (char-syntax (char-after (- (point) 2)))
2286 '(?w ?_))
2287 (progn
2288 (backward-sexp)
2289 (looking-at "[a-zA-Z_][a-zA-Z0-9_]*:[^:]"))))
2290
2291(defun cperl-get-state (&optional parse-start start-state)
5bd52f0e
RS
2292 ;; returns list (START STATE DEPTH PRESTART),
2293 ;; START is a good place to start parsing, or equal to
5c8b7eaf 2294 ;; PARSE-START if preset,
5bd52f0e
RS
2295 ;; STATE is what is returned by `parse-partial-sexp'.
2296 ;; DEPTH is true is we are immediately after end of block
2297 ;; which contains START.
2298 ;; PRESTART is the position basing on which START was found.
f83d2997
KH
2299 (save-excursion
2300 (let ((start-point (point)) depth state start prestart)
5bd52f0e
RS
2301 (if (and parse-start
2302 (<= parse-start start-point))
f83d2997 2303 (goto-char parse-start)
5bd52f0e
RS
2304 (beginning-of-defun)
2305 (setq start-state nil))
f83d2997
KH
2306 (setq prestart (point))
2307 (if start-state nil
2308 ;; Try to go out, if sub is not on the outermost level
2309 (while (< (point) start-point)
2310 (setq start (point) parse-start start depth nil
2311 state (parse-partial-sexp start start-point -1))
2312 (if (> (car state) -1) nil
2313 ;; The current line could start like }}}, so the indentation
2314 ;; corresponds to a different level than what we reached
2315 (setq depth t)
2316 (beginning-of-line 2))) ; Go to the next line.
2317 (if start (goto-char start))) ; Not at the start of file
2318 (setq start (point))
f83d2997
KH
2319 (or state (setq state (parse-partial-sexp start start-point -1 nil start-state)))
2320 (list start state depth prestart))))
2321
2322(defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
2323 ;; Positions is before ?\{. Checks whether it starts a block.
2324 ;; No save-excursion!
2325 (cperl-backward-to-noncomment (point-min))
f83d2997
KH
2326 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
2327 ; Label may be mixed up with `$blah :'
2328 (save-excursion (cperl-after-label))
2329 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2330 (progn
2331 (backward-sexp)
2332 ;; Need take into account `bless', `return', `tr',...
2333 (or (and (looking-at "[a-zA-Z0-9_:]+[ \t\n\f]*[{#]") ; Method call syntax
5bd52f0e 2334 (not (looking-at "\\(bless\\|return\\|q[wqrx]?\\|tr\\|[smy]\\)\\>")))
f83d2997
KH
2335 (progn
2336 (skip-chars-backward " \t\n\f")
2337 (and (memq (char-syntax (preceding-char)) '(?w ?_))
2338 (progn
2339 (backward-sexp)
5c8b7eaf 2340 (looking-at
f83d2997
KH
2341 "sub[ \t]+[a-zA-Z0-9_:]+[ \t\n\f]*\\(([^()]*)[ \t\n\f]*\\)?[#{]")))))))))
2342
2343(defvar cperl-look-for-prop '((pod in-pod) (here-doc-delim here-doc-group)))
2344
5bd52f0e 2345(defun cperl-calculate-indent (&optional parse-data) ; was parse-start
f83d2997
KH
2346 "Return appropriate indentation for current line as Perl code.
2347In usual case returns an integer: the column to indent to.
5bd52f0e
RS
2348Returns nil if line starts inside a string, t if in a comment.
2349
2350Will not correct the indentation for labels, but will correct it for braces
2351and closing parentheses and brackets.."
f83d2997
KH
2352 (save-excursion
2353 (if (or
5c8b7eaf 2354 (memq (get-text-property (point) 'syntax-type)
f83d2997
KH
2355 '(pod here-doc here-doc-delim format))
2356 ;; before start of POD - whitespace found since do not have 'pod!
2357 (and (looking-at "[ \t]*\n=")
2358 (error "Spaces before pod section!"))
2359 (and (not cperl-indent-left-aligned-comments)
2360 (looking-at "^#")))
2361 nil
2362 (beginning-of-line)
2363 (let ((indent-point (point))
2364 (char-after (save-excursion
2365 (skip-chars-forward " \t")
2366 (following-char)))
2367 (in-pod (get-text-property (point) 'in-pod))
2368 (pre-indent-point (point))
2369 p prop look-prop)
2370 (cond
5c8b7eaf 2371 (in-pod
f83d2997
KH
2372 ;; In the verbatim part, probably code example. What to do???
2373 )
5c8b7eaf 2374 (t
f83d2997
KH
2375 (save-excursion
2376 ;; Not in pod
2377 (cperl-backward-to-noncomment nil)
2378 (setq p (max (point-min) (1- (point)))
2379 prop (get-text-property p 'syntax-type)
2380 look-prop (or (nth 1 (assoc prop cperl-look-for-prop))
2381 'syntax-type))
2382 (if (memq prop '(pod here-doc format here-doc-delim))
2383 (progn
5c8b7eaf 2384 (goto-char (or (previous-single-property-change p look-prop)
f83d2997
KH
2385 (point-min)))
2386 (beginning-of-line)
2387 (setq pre-indent-point (point)))))))
2388 (goto-char pre-indent-point)
2389 (let* ((case-fold-search nil)
5bd52f0e 2390 (s-s (cperl-get-state (car parse-data) (nth 1 parse-data)))
5c8b7eaf 2391 (start (or (nth 2 parse-data)
5bd52f0e 2392 (nth 0 s-s)))
f83d2997
KH
2393 (state (nth 1 s-s))
2394 (containing-sexp (car (cdr state)))
f83d2997 2395 old-indent)
5c8b7eaf 2396 (if (and
5bd52f0e 2397 ;;containing-sexp ;; We are buggy at toplevel :-(
5c8b7eaf 2398 parse-data)
5bd52f0e
RS
2399 (progn
2400 (setcar parse-data pre-indent-point)
2401 (setcar (cdr parse-data) state)
2402 (or (nth 2 parse-data)
2403 (setcar (cddr parse-data) start))
2404 ;; Before this point: end of statement
2405 (setq old-indent (nth 3 parse-data))))
f83d2997 2406 ;; (or parse-start (null symbol)
5c8b7eaf
SS
2407 ;; (setq parse-start (symbol-value symbol)
2408 ;; start-indent (nth 2 parse-start)
f83d2997
KH
2409 ;; parse-start (car parse-start)))
2410 ;; (if parse-start
2411 ;; (goto-char parse-start)
2412 ;; (beginning-of-defun))
2413 ;; ;; Try to go out
2414 ;; (while (< (point) indent-point)
2415 ;; (setq start (point) parse-start start moved nil
2416 ;; state (parse-partial-sexp start indent-point -1))
2417 ;; (if (> (car state) -1) nil
2418 ;; ;; The current line could start like }}}, so the indentation
2419 ;; ;; corresponds to a different level than what we reached
2420 ;; (setq moved t)
2421 ;; (beginning-of-line 2))) ; Go to the next line.
2422 ;; (if start ; Not at the start of file
2423 ;; (progn
2424 ;; (goto-char start)
2425 ;; (setq start-indent (current-indentation))
2426 ;; (if moved ; Should correct...
2427 ;; (setq start-indent (- start-indent cperl-indent-level))))
2428 ;; (setq start-indent 0))
2429 ;; (if (< (point) indent-point) (setq parse-start (point)))
5c8b7eaf 2430 ;; (or state (setq state (parse-partial-sexp
f83d2997 2431 ;; (point) indent-point -1 nil start-state)))
5c8b7eaf
SS
2432 ;; (setq containing-sexp
2433 ;; (or (car (cdr state))
f83d2997
KH
2434 ;; (and (>= (nth 6 state) 0) old-containing-sexp))
2435 ;; old-containing-sexp nil start-state nil)
2436;;;; (while (< (point) indent-point)
2437;;;; (setq parse-start (point))
2438;;;; (setq state (parse-partial-sexp (point) indent-point -1 nil start-state))
5c8b7eaf
SS
2439;;;; (setq containing-sexp
2440;;;; (or (car (cdr state))
f83d2997
KH
2441;;;; (and (>= (nth 6 state) 0) old-containing-sexp))
2442;;;; old-containing-sexp nil start-state nil))
2443 ;; (if symbol (set symbol (list indent-point state start-indent)))
2444 ;; (goto-char indent-point)
2445 (cond ((or (nth 3 state) (nth 4 state))
2446 ;; return nil or t if should not change this line
2447 (nth 4 state))
2448 ((null containing-sexp)
2449 ;; Line is at top level. May be data or function definition,
2450 ;; or may be function argument declaration.
2451 ;; Indent like the previous top level line
2452 ;; unless that ends in a closeparen without semicolon,
2453 ;; in which case this line is the first argument decl.
2454 (skip-chars-forward " \t")
5bd52f0e
RS
2455 (+ (save-excursion
2456 (goto-char start)
2457 (- (current-indentation)
2458 (if (nth 2 s-s) cperl-indent-level 0)))
2459 (if (= char-after ?{) cperl-continued-brace-offset 0)
f83d2997 2460 (progn
5bd52f0e 2461 (cperl-backward-to-noncomment (or old-indent (point-min)))
f83d2997
KH
2462 ;; Look at previous line that's at column 0
2463 ;; to determine whether we are in top-level decls
2464 ;; or function's arg decls. Set basic-indent accordingly.
2465 ;; Now add a little if this is a continuation line.
2466 (if (or (bobp)
5bd52f0e 2467 (eq (point) old-indent) ; old-indent was at comment
db133cb6
RS
2468 (eq (preceding-char) ?\;)
2469 ;; Had ?\) too
2470 (and (eq (preceding-char) ?\})
5bd52f0e
RS
2471 (cperl-after-block-and-statement-beg
2472 (point-min))) ; Was start - too close
f83d2997
KH
2473 (memq char-after (append ")]}" nil))
2474 (and (eq (preceding-char) ?\:) ; label
2475 (progn
2476 (forward-sexp -1)
2477 (skip-chars-backward " \t")
5c8b7eaf 2478 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*[ \t]*:"))))
5bd52f0e
RS
2479 (progn
2480 (if (and parse-data
2481 (not (eq char-after ?\C-j)))
2482 (setcdr (cddr parse-data)
2483 (list pre-indent-point)))
2484 0)
f83d2997
KH
2485 cperl-continued-statement-offset))))
2486 ((/= (char-after containing-sexp) ?{)
2487 ;; line is expression, not statement:
2488 ;; indent to just after the surrounding open,
2489 ;; skip blanks if we do not close the expression.
2490 (goto-char (1+ containing-sexp))
2491 (or (memq char-after (append ")]}" nil))
2492 (looking-at "[ \t]*\\(#\\|$\\)")
2493 (skip-chars-forward " \t"))
2494 (current-column))
2495 ((progn
2496 ;; Containing-expr starts with \{. Check whether it is a hash.
2497 (goto-char containing-sexp)
2498 (not (cperl-block-p)))
2499 (goto-char (1+ containing-sexp))
2500 (or (eq char-after ?\})
2501 (looking-at "[ \t]*\\(#\\|$\\)")
2502 (skip-chars-forward " \t"))
2503 (+ (current-column) ; Correct indentation of trailing ?\}
2504 (if (eq char-after ?\}) (+ cperl-indent-level
5c8b7eaf 2505 cperl-close-paren-offset)
f83d2997
KH
2506 0)))
2507 (t
2508 ;; Statement level. Is it a continuation or a new statement?
2509 ;; Find previous non-comment character.
2510 (goto-char pre-indent-point)
2511 (cperl-backward-to-noncomment containing-sexp)
2512 ;; Back up over label lines, since they don't
2513 ;; affect whether our line is a continuation.
5bd52f0e
RS
2514 ;; (Had \, too)
2515 (while ;;(or (eq (preceding-char) ?\,)
f83d2997
KH
2516 (and (eq (preceding-char) ?:)
2517 (or;;(eq (char-after (- (point) 2)) ?\') ; ????
2518 (memq (char-syntax (char-after (- (point) 2)))
5bd52f0e
RS
2519 '(?w ?_))))
2520 ;;)
f83d2997
KH
2521 (if (eq (preceding-char) ?\,)
2522 ;; Will go to beginning of line, essentially.
2523 ;; Will ignore embedded sexpr XXXX.
2524 (cperl-backward-to-start-of-continued-exp containing-sexp))
2525 (beginning-of-line)
2526 (cperl-backward-to-noncomment containing-sexp))
2527 ;; Now we get the answer.
db133cb6
RS
2528 ;; Had \?, too:
2529 (if (not (or (memq (preceding-char) (append " ;{" '(nil)))
2530 (and (eq (preceding-char) ?\})
5c8b7eaf 2531 (cperl-after-block-and-statement-beg
db133cb6 2532 containing-sexp)))) ; Was ?\,
f83d2997
KH
2533 ;; This line is continuation of preceding line's statement;
2534 ;; indent `cperl-continued-statement-offset' more than the
2535 ;; previous line of the statement.
5bd52f0e
RS
2536 ;;
2537 ;; There might be a label on this line, just
2538 ;; consider it bad style and ignore it.
f83d2997
KH
2539 (progn
2540 (cperl-backward-to-start-of-continued-exp containing-sexp)
2541 (+ (if (memq char-after (append "}])" nil))
2542 0 ; Closing parenth
2543 cperl-continued-statement-offset)
5bd52f0e
RS
2544 (if (looking-at "\\w+[ \t]*:")
2545 (if (> (current-indentation) cperl-min-label-indent)
2546 (- (current-indentation) cperl-label-offset)
2547 ;; Do not move `parse-data', this should
5c8b7eaf 2548 ;; be quick anyway (this comment comes
5bd52f0e
RS
2549 ;;from different location):
2550 (cperl-calculate-indent))
2551 (current-column))
f83d2997
KH
2552 (if (eq char-after ?\{)
2553 cperl-continued-brace-offset 0)))
2554 ;; This line starts a new statement.
2555 ;; Position following last unclosed open.
2556 (goto-char containing-sexp)
2557 ;; Is line first statement after an open-brace?
2558 (or
2559 ;; If no, find that first statement and indent like
2560 ;; it. If the first statement begins with label, do
2561 ;; not believe when the indentation of the label is too
2562 ;; small.
2563 (save-excursion
2564 (forward-char 1)
2565 (setq old-indent (current-indentation))
2566 (let ((colon-line-end 0))
2567 (while (progn (skip-chars-forward " \t\n")
2568 (looking-at "#\\|[a-zA-Z0-9_$]*:[^:]"))
2569 ;; Skip over comments and labels following openbrace.
2570 (cond ((= (following-char) ?\#)
2571 (forward-line 1))
2572 ;; label:
2573 (t
2574 (save-excursion (end-of-line)
2575 (setq colon-line-end (point)))
2576 (search-forward ":"))))
2577 ;; The first following code counts
2578 ;; if it is before the line we want to indent.
2579 (and (< (point) indent-point)
2580 (if (> colon-line-end (point)) ; After label
5c8b7eaf 2581 (if (> (current-indentation)
f83d2997
KH
2582 cperl-min-label-indent)
2583 (- (current-indentation) cperl-label-offset)
2584 ;; Do not believe: `max' is involved
2585 (+ old-indent cperl-indent-level))
2586 (current-column)))))
2587 ;; If no previous statement,
2588 ;; indent it relative to line brace is on.
2589 ;; For open brace in column zero, don't let statement
2590 ;; start there too. If cperl-indent-level is zero,
2591 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2592 ;; For open-braces not the first thing in a line,
2593 ;; add in cperl-brace-imaginary-offset.
2594
2595 ;; If first thing on a line: ?????
2596 (+ (if (and (bolp) (zerop cperl-indent-level))
2597 (+ cperl-brace-offset cperl-continued-statement-offset)
2598 cperl-indent-level)
2599 ;; Move back over whitespace before the openbrace.
2600 ;; If openbrace is not first nonwhite thing on the line,
2601 ;; add the cperl-brace-imaginary-offset.
2602 (progn (skip-chars-backward " \t")
2603 (if (bolp) 0 cperl-brace-imaginary-offset))
2604 ;; If the openbrace is preceded by a parenthesized exp,
2605 ;; move to the beginning of that;
2606 ;; possibly a different line
2607 (progn
2608 (if (eq (preceding-char) ?\))
2609 (forward-sexp -1))
2610 ;; In the case it starts a subroutine, indent with
2611 ;; respect to `sub', not with respect to the the
2612 ;; first thing on the line, say in the case of
2613 ;; anonymous sub in a hash.
2614 ;;
2615 (skip-chars-backward " \t")
2616 (if (and (eq (preceding-char) ?b)
2617 (progn
2618 (forward-sexp -1)
2619 (looking-at "sub\\>"))
5c8b7eaf
SS
2620 (setq old-indent
2621 (nth 1
2622 (parse-partial-sexp
2623 (save-excursion (beginning-of-line) (point))
f83d2997
KH
2624 (point)))))
2625 (progn (goto-char (1+ old-indent))
2626 (skip-chars-forward " \t")
2627 (current-column))
2628 ;; Get initial indentation of the line we are on.
2629 ;; If line starts with label, calculate label indentation
2630 (if (save-excursion
2631 (beginning-of-line)
2632 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2633 (if (> (current-indentation) cperl-min-label-indent)
2634 (- (current-indentation) cperl-label-offset)
5bd52f0e
RS
2635 ;; Do not move `parse-data', this should
2636 ;; be quick anyway:
2637 (cperl-calculate-indent))
f83d2997
KH
2638 (current-indentation))))))))))))))
2639
2640(defvar cperl-indent-alist
2641 '((string nil)
2642 (comment nil)
2643 (toplevel 0)
2644 (toplevel-after-parenth 2)
2645 (toplevel-continued 2)
2646 (expression 1))
2647 "Alist of indentation rules for CPerl mode.
2648The values mean:
2649 nil: do not indent;
db133cb6
RS
2650 number: add this amount of indentation.
2651
2652Not finished, not used.")
f83d2997
KH
2653
2654(defun cperl-where-am-i (&optional parse-start start-state)
2655 ;; Unfinished
2656 "Return a list of lists ((TYPE POS)...) of good points before the point.
db133cb6
RS
2657POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2658
2659Not finished, not used."
f83d2997
KH
2660 (save-excursion
2661 (let* ((start-point (point))
2662 (s-s (cperl-get-state))
2663 (start (nth 0 s-s))
2664 (state (nth 1 s-s))
2665 (prestart (nth 3 s-s))
2666 (containing-sexp (car (cdr state)))
2667 (case-fold-search nil)
2668 (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
2669 (cond ((nth 3 state) ; In string
2670 (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
2671 ((nth 4 state) ; In comment
2672 (setq res (cons '(comment) res)))
2673 ((null containing-sexp)
5c8b7eaf 2674 ;; Line is at top level.
f83d2997
KH
2675 ;; Indent like the previous top level line
2676 ;; unless that ends in a closeparen without semicolon,
2677 ;; in which case this line is the first argument decl.
2678 (cperl-backward-to-noncomment (or parse-start (point-min)))
2679 ;;(skip-chars-backward " \t\f\n")
2680 (cond
2681 ((or (bobp)
2682 (memq (preceding-char) (append ";}" nil)))
2683 (setq res (cons (list 'toplevel start) res)))
2684 ((eq (preceding-char) ?\) )
2685 (setq res (cons (list 'toplevel-after-parenth start) res)))
5c8b7eaf 2686 (t
f83d2997
KH
2687 (setq res (cons (list 'toplevel-continued start) res)))))
2688 ((/= (char-after containing-sexp) ?{)
2689 ;; line is expression, not statement:
2690 ;; indent to just after the surrounding open.
2691 ;; skip blanks if we do not close the expression.
2692 (setq res (cons (list 'expression-blanks
2693 (progn
2694 (goto-char (1+ containing-sexp))
2695 (or (looking-at "[ \t]*\\(#\\|$\\)")
2696 (skip-chars-forward " \t"))
2697 (point)))
2698 (cons (list 'expression containing-sexp) res))))
2699 ((progn
2700 ;; Containing-expr starts with \{. Check whether it is a hash.
2701 (goto-char containing-sexp)
2702 (not (cperl-block-p)))
2703 (setq res (cons (list 'expression-blanks
2704 (progn
2705 (goto-char (1+ containing-sexp))
2706 (or (looking-at "[ \t]*\\(#\\|$\\)")
2707 (skip-chars-forward " \t"))
2708 (point)))
2709 (cons (list 'expression containing-sexp) res))))
2710 (t
2711 ;; Statement level.
2712 (setq res (cons (list 'in-block containing-sexp) res))
2713 ;; Is it a continuation or a new statement?
2714 ;; Find previous non-comment character.
2715 (cperl-backward-to-noncomment containing-sexp)
2716 ;; Back up over label lines, since they don't
2717 ;; affect whether our line is a continuation.
2718 ;; Back up comma-delimited lines too ?????
2719 (while (or (eq (preceding-char) ?\,)
2720 (save-excursion (cperl-after-label)))
2721 (if (eq (preceding-char) ?\,)
2722 ;; Will go to beginning of line, essentially
2723 ;; Will ignore embedded sexpr XXXX.
2724 (cperl-backward-to-start-of-continued-exp containing-sexp))
2725 (beginning-of-line)
2726 (cperl-backward-to-noncomment containing-sexp))
2727 ;; Now we get the answer.
2728 (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
2729 ;; This line is continuation of preceding line's statement.
2730 (list (list 'statement-continued containing-sexp))
2731 ;; This line starts a new statement.
2732 ;; Position following last unclosed open.
2733 (goto-char containing-sexp)
2734 ;; Is line first statement after an open-brace?
2735 (or
2736 ;; If no, find that first statement and indent like
2737 ;; it. If the first statement begins with label, do
2738 ;; not believe when the indentation of the label is too
2739 ;; small.
2740 (save-excursion
2741 (forward-char 1)
2742 (let ((colon-line-end 0))
2743 (while (progn (skip-chars-forward " \t\n" start-point)
2744 (and (< (point) start-point)
2745 (looking-at
2746 "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
2747 ;; Skip over comments and labels following openbrace.
2748 (cond ((= (following-char) ?\#)
2749 ;;(forward-line 1)
2750 (end-of-line))
2751 ;; label:
2752 (t
2753 (save-excursion (end-of-line)
2754 (setq colon-line-end (point)))
2755 (search-forward ":"))))
5c8b7eaf 2756 ;; Now at the point, after label, or at start
f83d2997
KH
2757 ;; of first statement in the block.
2758 (and (< (point) start-point)
5c8b7eaf 2759 (if (> colon-line-end (point))
f83d2997 2760 ;; Before statement after label
5c8b7eaf 2761 (if (> (current-indentation)
f83d2997
KH
2762 cperl-min-label-indent)
2763 (list (list 'label-in-block (point)))
2764 ;; Do not believe: `max' is involved
2765 (list
2766 (list 'label-in-block-min-indent (point))))
2767 ;; Before statement
2768 (list 'statement-in-block (point))))))
2769 ;; If no previous statement,
2770 ;; indent it relative to line brace is on.
2771 ;; For open brace in column zero, don't let statement
2772 ;; start there too. If cperl-indent-level is zero,
2773 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2774 ;; For open-braces not the first thing in a line,
2775 ;; add in cperl-brace-imaginary-offset.
2776
2777 ;; If first thing on a line: ?????
2778 (+ (if (and (bolp) (zerop cperl-indent-level))
2779 (+ cperl-brace-offset cperl-continued-statement-offset)
2780 cperl-indent-level)
2781 ;; Move back over whitespace before the openbrace.
2782 ;; If openbrace is not first nonwhite thing on the line,
2783 ;; add the cperl-brace-imaginary-offset.
2784 (progn (skip-chars-backward " \t")
2785 (if (bolp) 0 cperl-brace-imaginary-offset))
2786 ;; If the openbrace is preceded by a parenthesized exp,
2787 ;; move to the beginning of that;
2788 ;; possibly a different line
2789 (progn
2790 (if (eq (preceding-char) ?\))
2791 (forward-sexp -1))
2792 ;; Get initial indentation of the line we are on.
2793 ;; If line starts with label, calculate label indentation
2794 (if (save-excursion
2795 (beginning-of-line)
2796 (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2797 (if (> (current-indentation) cperl-min-label-indent)
2798 (- (current-indentation) cperl-label-offset)
5bd52f0e 2799 (cperl-calculate-indent))
f83d2997
KH
2800 (current-indentation))))))))
2801 res)))
2802
2803(defun cperl-calculate-indent-within-comment ()
2804 "Return the indentation amount for line, assuming that
2805the current line is to be regarded as part of a block comment."
2806 (let (end star-start)
2807 (save-excursion
2808 (beginning-of-line)
2809 (skip-chars-forward " \t")
2810 (setq end (point))
2811 (and (= (following-char) ?#)
2812 (forward-line -1)
2813 (cperl-to-comment-or-eol)
2814 (setq end (point)))
2815 (goto-char end)
2816 (current-column))))
2817
2818
2819(defun cperl-to-comment-or-eol ()
2820 "Goes to position before comment on the current line, or to end of line.
2821Returns true if comment is found."
2822 (let (state stop-in cpoint (lim (progn (end-of-line) (point))))
2823 (beginning-of-line)
5c8b7eaf 2824 (if (or
f83d2997
KH
2825 (eq (get-text-property (point) 'syntax-type) 'pod)
2826 (re-search-forward "\\=[ \t]*\\(#\\|$\\)" lim t))
2827 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
2828 ;; Else
2829 (while (not stop-in)
2830 (setq state (parse-partial-sexp (point) lim nil nil nil t))
2831 ; stop at comment
2832 ;; If fails (beginning-of-line inside sexp), then contains not-comment
f83d2997
KH
2833 (if (nth 4 state) ; After `#';
2834 ; (nth 2 state) can be
2835 ; beginning of m,s,qq and so
2836 ; on
2837 (if (nth 2 state)
2838 (progn
2839 (setq cpoint (point))
2840 (goto-char (nth 2 state))
2841 (cond
2842 ((looking-at "\\(s\\|tr\\)\\>")
2843 (or (re-search-forward
2844 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*"
2845 lim 'move)
2846 (setq stop-in t)))
5bd52f0e 2847 ((looking-at "\\(m\\|q\\([qxwr]\\)?\\)\\>")
f83d2997
KH
2848 (or (re-search-forward
2849 "\\=\\w+[ \t]*#\\([^\n\\\\#]\\|\\\\[\\\\#]\\)*#"
2850 lim 'move)
2851 (setq stop-in t)))
2852 (t ; It was fair comment
2853 (setq stop-in t) ; Finish
2854 (goto-char (1- cpoint)))))
2855 (setq stop-in t) ; Finish
2856 (forward-char -1))
2857 (setq stop-in t)) ; Finish
2858 )
2859 (nth 4 state))))
2860
2861(defsubst cperl-1- (p)
2862 (max (point-min) (1- p)))
2863
2864(defsubst cperl-1+ (p)
2865 (min (point-max) (1+ p)))
2866
f83d2997
KH
2867(defsubst cperl-modify-syntax-type (at how)
2868 (if (< at (point-max))
2869 (progn
2870 (put-text-property at (1+ at) 'syntax-table how)
2871 (put-text-property at (1+ at) 'rear-nonsticky t))))
2872
2873(defun cperl-protect-defun-start (s e)
2874 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2875 (save-excursion
2876 (goto-char s)
2877 (while (re-search-forward "^\\s(" e 'to-end)
2878 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
2879
5bd52f0e 2880(defun cperl-commentify (bb e string &optional noface)
5c8b7eaf 2881 (if cperl-use-syntax-table-text-property
5bd52f0e
RS
2882 (if (eq noface 'n) ; Only immediate
2883 nil
f83d2997
KH
2884 ;; We suppose that e is _after_ the end of construction, as after eol.
2885 (setq string (if string cperl-st-sfence cperl-st-cfence))
2886 (cperl-modify-syntax-type bb string)
2887 (cperl-modify-syntax-type (1- e) string)
2888 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
5c8b7eaf 2889 (put-text-property (1+ bb) (1- e)
f83d2997 2890 'syntax-table cperl-string-syntax-table))
5bd52f0e
RS
2891 (cperl-protect-defun-start bb e))
2892 ;; Fontify
2893 (or noface
2894 (not cperl-pod-here-fontify)
2895 (put-text-property bb e 'face (if string 'font-lock-string-face
2896 'font-lock-comment-face)))))
2897(defvar cperl-starters '(( ?\( . ?\) )
2898 ( ?\[ . ?\] )
2899 ( ?\{ . ?\} )
2900 ( ?\< . ?\> )))
f83d2997
KH
2901
2902(defun cperl-forward-re (lim end is-2arg set-st st-l err-l argument
2903 &optional ostart oend)
2904 ;; Works *before* syntax recognition is done
2905 ;; May modify syntax-type text property if the situation is too hard
2906 (let (b starter ender st i i2 go-forward)
2907 (skip-chars-forward " \t")
2908 ;; ender means matching-char matcher.
5c8b7eaf 2909 (setq b (point)
5bd52f0e
RS
2910 starter (if (eobp) 0 (char-after b))
2911 ender (cdr (assoc starter cperl-starters)))
f83d2997
KH
2912 ;; What if starter == ?\\ ????
2913 (if set-st
2914 (if (car st-l)
2915 (setq st (car st-l))
2916 (setcar st-l (make-syntax-table))
2917 (setq i 0 st (car st-l))
2918 (while (< i 256)
2919 (modify-syntax-entry i "." st)
2920 (setq i (1+ i)))
2921 (modify-syntax-entry ?\\ "\\" st)))
2922 (setq set-st t)
2923 ;; Whether we have an intermediate point
2924 (setq i nil)
2925 ;; Prepare the syntax table:
2926 (and set-st
2927 (if (not ender) ; m/blah/, s/x//, s/x/y/
2928 (modify-syntax-entry starter "$" st)
2929 (modify-syntax-entry starter (concat "(" (list ender)) st)
2930 (modify-syntax-entry ender (concat ")" (list starter)) st)))
2931 (condition-case bb
2932 (progn
5bd52f0e
RS
2933 ;; We use `$' syntax class to find matching stuff, but $$
2934 ;; is recognized the same as $, so we need to check this manually.
f83d2997
KH
2935 (if (and (eq starter (char-after (cperl-1+ b)))
2936 (not ender))
2937 ;; $ has TeXish matching rules, so $$ equiv $...
2938 (forward-char 2)
2939 (set-syntax-table st)
2940 (forward-sexp 1)
2941 (set-syntax-table cperl-mode-syntax-table)
2942 ;; Now the problem is with m;blah;;
2943 (and (not ender)
2944 (eq (preceding-char)
2945 (char-after (- (point) 2)))
2946 (save-excursion
2947 (forward-char -2)
2948 (= 0 (% (skip-chars-backward "\\\\") 2)))
2949 (forward-char -1)))
5bd52f0e 2950 ;; Now we are after the first part.
f83d2997
KH
2951 (and is-2arg ; Have trailing part
2952 (not ender)
2953 (eq (following-char) starter) ; Empty trailing part
2954 (progn
2955 (or (eq (char-syntax (following-char)) ?.)
2956 ;; Make trailing letter into punctuation
2957 (cperl-modify-syntax-type (point) cperl-st-punct))
2958 (setq is-2arg nil go-forward t))) ; Ignore the tail
2959 (if is-2arg ; Not number => have second part
2960 (progn
2961 (setq i (point) i2 i)
2962 (if ender
2963 (if (memq (following-char) '(?\ ?\t ?\n ?\f))
2964 (progn
2965 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
2966 (goto-char (match-end 0))
2967 (skip-chars-forward " \t\n\f"))
2968 (setq i2 (point))))
2969 (forward-char -1))
2970 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
5c8b7eaf 2971 (if ender (modify-syntax-entry ender "." st))
f83d2997 2972 (setq set-st nil)
5bd52f0e
RS
2973 (setq ender (cperl-forward-re lim end nil t st-l err-l
2974 argument starter ender)
f83d2997
KH
2975 ender (nth 2 ender)))))
2976 (error (goto-char lim)
2977 (setq set-st nil)
2978 (or end
2979 (message
5bd52f0e 2980 "End of `%s%s%c ... %c' string/RE not found: %s"
f83d2997
KH
2981 argument
2982 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
2983 starter (or ender starter) bb)
2984 (or (car err-l) (setcar err-l b)))))
2985 (if set-st
2986 (progn
2987 (modify-syntax-entry starter (if (eq starter ?\\) "\\" ".") st)
2988 (if ender (modify-syntax-entry ender "." st))))
5bd52f0e
RS
2989 ;; i: have 2 args, after end of the first arg
2990 ;; i2: start of the second arg, if any (before delim iff `ender').
2991 ;; ender: the last arg bounded by parens-like chars, the second one of them
2992 ;; starter: the starting delimiter of the first arg
2993 ;; go-forward: has 2 args, and the second part is empth
f83d2997
KH
2994 (list i i2 ender starter go-forward)))
2995
5c8b7eaf 2996(defsubst cperl-postpone-fontification (b e type val &optional now)
5bd52f0e
RS
2997 ;; Do after syntactic fontification?
2998 (if cperl-syntaxify-by-font-lock
2999 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3000 (put-text-property b e type val)))
3001
3002;;; Here is how the global structures (those which cannot be
3003;;; recognized locally) are marked:
5c8b7eaf 3004;; a) PODs:
5bd52f0e
RS
3005;; Start-to-end is marked `in-pod' ==> t
3006;; Each non-literal part is marked `syntax-type' ==> `pod'
3007;; Each literal part is marked `syntax-type' ==> `in-pod'
5c8b7eaf 3008;; b) HEREs:
5bd52f0e
RS
3009;; Start-to-end is marked `here-doc-group' ==> t
3010;; The body is marked `syntax-type' ==> `here-doc'
3011;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
5c8b7eaf 3012;; c) FORMATs:
5bd52f0e 3013;; After-initial-line--to-end is marked `syntax-type' ==> `format'
5c8b7eaf 3014;; d) 'Q'uoted string:
5bd52f0e
RS
3015;; part between markers inclusive is marked `syntax-type' ==> `string'
3016
3017(defun cperl-unwind-to-safe (before &optional end)
3018 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3019 (let ((pos (point)) opos)
3020 (setq opos pos)
3021 (while (and pos (get-text-property pos 'syntax-type))
3022 (setq pos (previous-single-property-change pos 'syntax-type))
3023 (if pos
3024 (if before
3025 (progn
3026 (goto-char (cperl-1- pos))
3027 (beginning-of-line)
3028 (setq pos (point)))
3029 (goto-char (setq pos (cperl-1- pos))))
3030 ;; Up to the start
3031 (goto-char (point-min))))
3032 (if end
3033 ;; Do the same for end, going small steps
3034 (progn
3035 (while (and end (get-text-property end 'syntax-type))
3036 (setq pos end
3037 end (next-single-property-change end 'syntax-type)))
3038 (or end pos)))))
3039
db133cb6 3040(defun cperl-find-pods-heres (&optional min max non-inter end ignore-max)
f83d2997 3041 "Scans the buffer for hard-to-parse Perl constructions.
5c8b7eaf
SS
3042If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3043the sections using `cperl-pod-head-face', `cperl-pod-face',
f83d2997
KH
3044`cperl-here-face'."
3045 (interactive)
db133cb6
RS
3046 (or min (setq min (point-min)
3047 cperl-syntax-state nil
3048 cperl-syntax-done-to min))
f83d2997 3049 (or max (setq max (point-max)))
5bd52f0e 3050 (let* (face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
5c8b7eaf 3051 (cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
db133cb6
RS
3052 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3053 (modified (buffer-modified-p))
3054 (after-change-functions nil)
3055 (use-syntax-state (and cperl-syntax-state
3056 (>= min (car cperl-syntax-state))))
3057 (state-point (if use-syntax-state
3058 (car cperl-syntax-state)
3059 (point-min)))
3060 (state (if use-syntax-state
3061 (cdr cperl-syntax-state)))
3062 (st-l '(nil)) (err-l '(nil)) i2
3063 ;; Somehow font-lock may be not loaded yet...
3064 (font-lock-string-face (if (boundp 'font-lock-string-face)
3065 font-lock-string-face
3066 'font-lock-string-face))
5bd52f0e
RS
3067 (font-lock-constant-face (if (boundp 'font-lock-constant-face)
3068 font-lock-constant-face
3069 'font-lock-constant-face))
5c8b7eaf 3070 (font-lock-function-name-face
5bd52f0e
RS
3071 (if (boundp 'font-lock-function-name-face)
3072 font-lock-function-name-face
3073 'font-lock-function-name-face))
5c8b7eaf 3074 (cperl-nonoverridable-face
5bd52f0e
RS
3075 (if (boundp 'cperl-nonoverridable-face)
3076 cperl-nonoverridable-face
3077 'cperl-nonoverridable-face))
5c8b7eaf 3078 (stop-point (if ignore-max
db133cb6
RS
3079 (point-max)
3080 max))
3081 (search
3082 (concat
5c8b7eaf 3083 "\\(\\`\n?\\|\n\n\\)="
db133cb6
RS
3084 "\\|"
3085 ;; One extra () before this:
5c8b7eaf 3086 "<<"
5bd52f0e 3087 "\\(" ; 1 + 1
db133cb6 3088 ;; First variant "BLAH" or just ``.
5bd52f0e
RS
3089 "\\([\"'`]\\)" ; 2 + 1
3090 "\\([^\"'`\n]*\\)" ; 3 + 1
db133cb6
RS
3091 "\\3"
3092 "\\|"
5bd52f0e
RS
3093 ;; Second variant: Identifier or \ID or empty
3094 "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3095 ;; Do not have <<= or << 30 or <<30 or << $blah.
3096 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3097 "\\(\\)" ; To preserve count of pars :-( 6 + 1
db133cb6
RS
3098 "\\)"
3099 "\\|"
3100 ;; 1+6 extra () before this:
3101 "^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3102 (if cperl-use-syntax-table-text-property
3103 (concat
3104 "\\|"
3105 ;; 1+6+2=9 extra () before this:
5bd52f0e 3106 "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
db133cb6
RS
3107 "\\|"
3108 ;; 1+6+2+1=10 extra () before this:
5bd52f0e 3109 "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
db133cb6
RS
3110 "\\|"
3111 ;; 1+6+2+1+1=11 extra () before this:
3112 "\\<sub\\>[ \t]*\\([a-zA-Z_:'0-9]+[ \t]*\\)?\\(([^()]*)\\)"
3113 "\\|"
3114 ;; 1+6+2+1+1+2=13 extra () before this:
3115 "\\$\\(['{]\\)"
3116 "\\|"
3117 ;; 1+6+2+1+1+2+1=14 extra () before this:
3118 "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'"
3119 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3120 "\\|"
3121 "__\\(END\\|DATA\\)__" ; Commented - does not help with indent...
3122 )
3123 ""))))
f83d2997
KH
3124 (unwind-protect
3125 (progn
3126 (save-excursion
3127 (or non-inter
3128 (message "Scanning for \"hard\" Perl constructions..."))
db133cb6 3129 (and cperl-pod-here-fontify
f83d2997
KH
3130 ;; We had evals here, do not know why...
3131 (setq face cperl-pod-face
3132 head-face cperl-pod-head-face
3133 here-face cperl-here-face))
5c8b7eaf 3134 (remove-text-properties min max
5bd52f0e
RS
3135 '(syntax-type t in-pod t syntax-table t
3136 cperl-postpone t))
f83d2997
KH
3137 ;; Need to remove face as well...
3138 (goto-char min)
db133cb6
RS
3139 (and (eq system-type 'emx)
3140 (looking-at "extproc[ \t]") ; Analogue of #!
5c8b7eaf 3141 (cperl-commentify min
db133cb6
RS
3142 (save-excursion (end-of-line) (point))
3143 nil))
3144 (while (and
3145 (< (point) max)
3146 (re-search-forward search max t))
5bd52f0e 3147 (setq tmpend nil) ; Valid for most cases
5c8b7eaf 3148 (cond
f83d2997 3149 ((match-beginning 1) ; POD section
5c8b7eaf 3150 ;; "\\(\\`\n?\\|\n\n\\)="
f83d2997 3151 (if (looking-at "\n*cut\\>")
5bd52f0e
RS
3152 (if ignore-max
3153 nil ; Doing a chunk only
f83d2997
KH
3154 (message "=cut is not preceded by a POD section")
3155 (or (car err-l) (setcar err-l (point))))
3156 (beginning-of-line)
5c8b7eaf
SS
3157
3158 (setq b (point)
5bd52f0e
RS
3159 bb b
3160 tb (match-beginning 0)
3161 b1 nil) ; error condition
db133cb6
RS
3162 ;; We do not search to max, since we may be called from
3163 ;; some hook of fontification, and max is random
3164 (or (re-search-forward "\n\n=cut\\>" stop-point 'toend)
f83d2997
KH
3165 (progn
3166 (message "End of a POD section not marked by =cut")
5bd52f0e 3167 (setq b1 t)
f83d2997
KH
3168 (or (car err-l) (setcar err-l b))))
3169 (beginning-of-line 2) ; An empty line after =cut is not POD!
3170 (setq e (point))
5bd52f0e
RS
3171 (if (and b1 (eobp))
3172 ;; Unrecoverable error
3173 nil
db133cb6 3174 (and (> e max)
5bd52f0e 3175 (progn
5c8b7eaf 3176 (remove-text-properties
5bd52f0e
RS
3177 max e '(syntax-type t in-pod t syntax-table t
3178 'cperl-postpone t))
3179 (setq tmpend tb)))
f83d2997 3180 (put-text-property b e 'in-pod t)
5bd52f0e 3181 (put-text-property b e 'syntax-type 'in-pod)
f83d2997
KH
3182 (goto-char b)
3183 (while (re-search-forward "\n\n[ \t]" e t)
3184 ;; We start 'pod 1 char earlier to include the preceding line
3185 (beginning-of-line)
3186 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
5bd52f0e
RS
3187 (cperl-put-do-not-fontify b (point) t)
3188 ;; mark the non-literal parts as PODs
5c8b7eaf 3189 (if cperl-pod-here-fontify
5bd52f0e 3190 (cperl-postpone-fontification b (point) 'face face t))
f83d2997
KH
3191 (re-search-forward "\n\n[^ \t\f\n]" e 'toend)
3192 (beginning-of-line)
3193 (setq b (point)))
3194 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
5bd52f0e 3195 (cperl-put-do-not-fontify (point) e t)
5c8b7eaf
SS
3196 (if cperl-pod-here-fontify
3197 (progn
5bd52f0e
RS
3198 ;; mark the non-literal parts as PODs
3199 (cperl-postpone-fontification (point) e 'face face t)
f83d2997 3200 (goto-char bb)
5c8b7eaf 3201 (if (looking-at
f83d2997 3202 "=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$")
5bd52f0e 3203 ;; mark the headers
5c8b7eaf 3204 (cperl-postpone-fontification
f83d2997
KH
3205 (match-beginning 1) (match-end 1)
3206 'face head-face))
3207 (while (re-search-forward
3208 ;; One paragraph
3209 "\n\n=[a-zA-Z0-9_]+\\>[ \t]*\\(\\(\n?[^\n]\\)+\\)$"
3210 e 'toend)
5bd52f0e 3211 ;; mark the headers
5c8b7eaf 3212 (cperl-postpone-fontification
f83d2997
KH
3213 (match-beginning 1) (match-end 1)
3214 'face head-face))))
3215 (cperl-commentify bb e nil)
3216 (goto-char e)
3217 (or (eq e (point-max))
5bd52f0e 3218 (forward-char -1))))) ; Prepare for immediate pod start.
f83d2997
KH
3219 ;; Here document
3220 ;; We do only one here-per-line
5bd52f0e 3221 ;; ;; One extra () before this:
5c8b7eaf 3222 ;;"<<"
5bd52f0e
RS
3223 ;; "\\(" ; 1 + 1
3224 ;; ;; First variant "BLAH" or just ``.
3225 ;; "\\([\"'`]\\)" ; 2 + 1
3226 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3227 ;; "\\3"
3228 ;; "\\|"
3229 ;; ;; Second variant: Identifier or \ID or empty
3230 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3231 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3232 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3233 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3234 ;; "\\)"
f83d2997
KH
3235 ((match-beginning 2) ; 1 + 1
3236 ;; Abort in comment:
3237 (setq b (point))
3238 (setq state (parse-partial-sexp state-point b nil nil state)
5bd52f0e
RS
3239 state-point b
3240 tb (match-beginning 0)
3241 i (or (nth 3 state) (nth 4 state)))
5c8b7eaf 3242 (if i
5bd52f0e
RS
3243 (setq c t)
3244 (setq c (and
3245 (match-beginning 5)
3246 (not (match-beginning 6)) ; Empty
3247 (looking-at
3248 "[ \t]*[=0-9$@%&(]"))))
3249 (if c ; Not here-doc
3250 nil ; Skip it.
f83d2997
KH
3251 (if (match-beginning 5) ;4 + 1
3252 (setq b1 (match-beginning 5) ; 4 + 1
3253 e1 (match-end 5)) ; 4 + 1
3254 (setq b1 (match-beginning 4) ; 3 + 1
3255 e1 (match-end 4))) ; 3 + 1
3256 (setq tag (buffer-substring b1 e1)
3257 qtag (regexp-quote tag))
5c8b7eaf 3258 (cond (cperl-pod-here-fontify
5bd52f0e
RS
3259 ;; Highlight the starting delimiter
3260 (cperl-postpone-fontification b1 e1 'face font-lock-constant-face)
3261 (cperl-put-do-not-fontify b1 e1 t)))
f83d2997
KH
3262 (forward-line)
3263 (setq b (point))
db133cb6
RS
3264 ;; We do not search to max, since we may be called from
3265 ;; some hook of fontification, and max is random
5c8b7eaf 3266 (cond ((re-search-forward (concat "^" qtag "$")
db133cb6 3267 stop-point 'toend)
5c8b7eaf 3268 (if cperl-pod-here-fontify
f83d2997 3269 (progn
5bd52f0e 3270 ;; Highlight the ending delimiter
5c8b7eaf 3271 (cperl-postpone-fontification (match-beginning 0) (match-end 0)
883212ce 3272 'face font-lock-constant-face)
5bd52f0e
RS
3273 (cperl-put-do-not-fontify b (match-end 0) t)
3274 ;; Highlight the HERE-DOC
5c8b7eaf 3275 (cperl-postpone-fontification b (match-beginning 0)
f83d2997
KH
3276 'face here-face)))
3277 (setq e1 (cperl-1+ (match-end 0)))
5c8b7eaf 3278 (put-text-property b (match-beginning 0)
f83d2997
KH
3279 'syntax-type 'here-doc)
3280 (put-text-property (match-beginning 0) e1
3281 'syntax-type 'here-doc-delim)
3282 (put-text-property b e1
3283 'here-doc-group t)
3284 (cperl-commentify b e1 nil)
5bd52f0e
RS
3285 (cperl-put-do-not-fontify b (match-end 0) t)
3286 (if (> e1 max)
3287 (setq tmpend tb)))
f83d2997
KH
3288 (t (message "End of here-document `%s' not found." tag)
3289 (or (car err-l) (setcar err-l b))))))
3290 ;; format
3291 ((match-beginning 8)
3292 ;; 1+6=7 extra () before this:
3293 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3294 (setq b (point)
3295 name (if (match-beginning 8) ; 7 + 1
3296 (buffer-substring (match-beginning 8) ; 7 + 1
3297 (match-end 8)) ; 7 + 1
5bd52f0e
RS
3298 "")
3299 tb (match-beginning 0))
f83d2997 3300 (setq argument nil)
5c8b7eaf 3301 (if cperl-pod-here-fontify
f83d2997
KH
3302 (while (and (eq (forward-line) 0)
3303 (not (looking-at "^[.;]$")))
3304 (cond
3305 ((looking-at "^#")) ; Skip comments
3306 ((and argument ; Skip argument multi-lines
5c8b7eaf 3307 (looking-at "^[ \t]*{"))
f83d2997
KH
3308 (forward-sexp 1)
3309 (setq argument nil))
3310 (argument ; Skip argument lines
3311 (setq argument nil))
3312 (t ; Format line
3313 (setq b1 (point))
3314 (setq argument (looking-at "^[^\n]*[@^]"))
3315 (end-of-line)
5bd52f0e 3316 ;; Highlight the format line
5c8b7eaf 3317 (cperl-postpone-fontification b1 (point)
f83d2997
KH
3318 'face font-lock-string-face)
3319 (cperl-commentify b1 (point) nil)
5bd52f0e 3320 (cperl-put-do-not-fontify b1 (point) t))))
db133cb6
RS
3321 ;; We do not search to max, since we may be called from
3322 ;; some hook of fontification, and max is random
3323 (re-search-forward "^[.;]$" stop-point 'toend))
f83d2997 3324 (beginning-of-line)
5bd52f0e 3325 (if (looking-at "^\\.$") ; ";" is not supported yet
f83d2997 3326 (progn
5bd52f0e
RS
3327 ;; Highlight the ending delimiter
3328 (cperl-postpone-fontification (point) (+ (point) 2)
f83d2997
KH
3329 'face font-lock-string-face)
3330 (cperl-commentify (point) (+ (point) 2) nil)
5bd52f0e 3331 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
f83d2997
KH
3332 (message "End of format `%s' not found." name)
3333 (or (car err-l) (setcar err-l b)))
3334 (forward-line)
5bd52f0e
RS
3335 (if (> (point) max)
3336 (setq tmpend tb))
db133cb6 3337 (put-text-property b (point) 'syntax-type 'format))
f83d2997
KH
3338 ;; Regexp:
3339 ((or (match-beginning 10) (match-beginning 11))
3340 ;; 1+6+2=9 extra () before this:
5bd52f0e 3341 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
f83d2997 3342 ;; "\\|"
5bd52f0e 3343 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
f83d2997
KH
3344 (setq b1 (if (match-beginning 10) 10 11)
3345 argument (buffer-substring
3346 (match-beginning b1) (match-end b1))
3347 b (point)
3348 i b
3349 c (char-after (match-beginning b1))
3350 bb (char-after (1- (match-beginning b1))) ; tmp holder
5bd52f0e
RS
3351 ;; bb == "Not a stringy"
3352 bb (if (eq b1 10) ; user variables/whatever
f83d2997
KH
3353 (or
3354 (memq bb '(?\$ ?\@ ?\% ?\* ?\#)) ; $#y
3355 (and (eq bb ?-) (eq c ?s)) ; -s file test
3356 (and (eq bb ?\&) ; &&m/blah/
5c8b7eaf 3357 (not (eq (char-after
f83d2997 3358 (- (match-beginning b1) 2))
5bd52f0e
RS
3359 ?\&))))
3360 ;; <file> or <$file>
3361 (and (eq c ?\<)
3362 ;; Do not stringify <FH> :
3363 (save-match-data
5c8b7eaf 3364 (looking-at
5bd52f0e
RS
3365 "\\s *\\$?\\([_a-zA-Z:][_a-zA-Z0-9:]*\\s *\\)?>"))))
3366 tb (match-beginning 0))
db133cb6
RS
3367 (goto-char (match-beginning b1))
3368 (cperl-backward-to-noncomment (point-min))
f83d2997 3369 (or bb
5bd52f0e 3370 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
f83d2997 3371 (setq argument ""
db133cb6
RS
3372 bb ; Not a regexp?
3373 (progn
5c8b7eaf 3374 (not
db133cb6
RS
3375 ;; What is below: regexp-p?
3376 (and
3377 (or (memq (preceding-char)
5bd52f0e 3378 (append (if (memq c '(?\? ?\<))
db133cb6 3379 ;; $a++ ? 1 : 2
5bd52f0e
RS
3380 "~{(=|&*!,;:"
3381 "~{(=|&+-*!,;:") nil))
db133cb6
RS
3382 (and (eq (preceding-char) ?\})
3383 (cperl-after-block-p (point-min)))
3384 (and (eq (char-syntax (preceding-char)) ?w)
3385 (progn
3386 (forward-sexp -1)
3387;;; After these keywords `/' starts a RE. One should add all the
3388;;; functions/builtins which expect an argument, but ...
5bd52f0e
RS
3389 (if (eq (preceding-char) ?-)
3390 ;; -d ?foo? is a RE
3391 (looking-at "[a-zA-Z]\\>")
5c8b7eaf 3392 (looking-at
5bd52f0e 3393 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>"))))
db133cb6
RS
3394 (and (eq (preceding-char) ?.)
3395 (eq (char-after (- (point) 2)) ?.))
3396 (bobp))
3397 ;; m|blah| ? foo : bar;
3398 (not
3399 (and (eq c ?\?)
5c8b7eaf 3400 cperl-use-syntax-table-text-property
db133cb6
RS
3401 (not (bobp))
3402 (progn
3403 (forward-char -1)
3404 (looking-at "\\s|")))))))
3405 b (1- b))
3406 ;; s y tr m
3407 ;; Check for $a->y
3408 (if (and (eq (preceding-char) ?>)
3409 (eq (char-after (- (point) 2)) ?-))
3410 ;; Not a regexp
3411 (setq bb t))))
5c8b7eaf 3412 (or bb (setq state (parse-partial-sexp
f83d2997
KH
3413 state-point b nil nil state)
3414 state-point b))
3415 (goto-char b)
3416 (if (or bb (nth 3 state) (nth 4 state))
3417 (goto-char i)
3418 (if (looking-at "[ \t\n\f]+\\(#[^\n]*\n[ \t\n\f]*\\)+")
3419 (goto-char (match-end 0))
3420 (skip-chars-forward " \t\n\f"))
3421 ;; qtag means two-arg matcher, may be reset to
3422 ;; 2 or 3 later if some special quoting is needed.
3423 ;; e1 means matching-char matcher.
3424 (setq b (point)
5bd52f0e
RS
3425 ;; has 2 args
3426 i2 (string-match "^\\([sy]\\|tr\\)$" argument)
db133cb6
RS
3427 ;; We do not search to max, since we may be called from
3428 ;; some hook of fontification, and max is random
3429 i (cperl-forward-re stop-point end
5bd52f0e 3430 i2
db133cb6 3431 t st-l err-l argument)
5bd52f0e
RS
3432 ;; Note that if `go', then it is considered as 1-arg
3433 b1 (nth 1 i) ; start of the second part
5c8b7eaf 3434 tag (nth 2 i) ; ender-char, true if second part
5bd52f0e 3435 ; is with matching chars []
f83d2997
KH
3436 go (nth 4 i) ; There is a 1-char part after the end
3437 i (car i) ; intermediate point
5c8b7eaf 3438 e1 (point) ; end
5bd52f0e 3439 ;; Before end of the second part if non-matching: ///
5c8b7eaf 3440 tail (if (and i (not tag))
5bd52f0e
RS
3441 (1- e1))
3442 e (if i i e1) ; end of the first part
3443 qtag nil) ; need to preserve backslashitis
f83d2997
KH
3444 ;; Commenting \\ is dangerous, what about ( ?
3445 (and i tail
3446 (eq (char-after i) ?\\)
5bd52f0e 3447 (setq qtag t))
f83d2997 3448 (if (null i)
5bd52f0e 3449 ;; Considered as 1arg form
f83d2997
KH
3450 (progn
3451 (cperl-commentify b (point) t)
5bd52f0e
RS
3452 (put-text-property b (point) 'syntax-type 'string)
3453 (and go
3454 (setq e1 (cperl-1+ e1))
3455 (or (eobp)
3456 (forward-char 1))))
f83d2997
KH
3457 (cperl-commentify b i t)
3458 (if (looking-at "\\sw*e") ; s///e
3459 (progn
3460 (and
3461 ;; silent:
5bd52f0e 3462 (cperl-find-pods-heres b1 (1- (point)) t end)
f83d2997
KH
3463 ;; Error
3464 (goto-char (1+ max)))
5bd52f0e 3465 (if (and tag (eq (preceding-char) ?\>))
f83d2997
KH
3466 (progn
3467 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
5bd52f0e
RS
3468 (cperl-modify-syntax-type i cperl-st-bra)))
3469 (put-text-property b i 'syntax-type 'string))
3470 (cperl-commentify b1 (point) t)
3471 (put-text-property b (point) 'syntax-type 'string)
3472 (if qtag
db133cb6 3473 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
f83d2997 3474 (setq tail nil)))
5bd52f0e 3475 ;; Now: tail: if the second part is non-matching without ///e
f83d2997
KH
3476 (if (eq (char-syntax (following-char)) ?w)
3477 (progn
3478 (forward-word 1) ; skip modifiers s///s
5bd52f0e 3479 (if tail (cperl-commentify tail (point) t))
5c8b7eaf 3480 (cperl-postpone-fontification
5bd52f0e
RS
3481 e1 (point) 'face cperl-nonoverridable-face)))
3482 ;; Check whether it is m// which means "previous match"
3483 ;; and highlight differently
3484 (if (and (eq e (+ 2 b))
3485 (string-match "^\\([sm]?\\|qr\\)$" argument)
3486 ;; <> is already filtered out
3487 ;; split // *is* using zero-pattern
3488 (save-excursion
3489 (condition-case nil
3490 (progn
3491 (goto-char tb)
3492 (forward-sexp -1)
3493 (not (looking-at "split\\>")))
3494 (error t))))
5c8b7eaf 3495 (cperl-postpone-fontification
5bd52f0e
RS
3496 b e 'face font-lock-function-name-face)
3497 (if (or i2 ; Has 2 args
3498 (and cperl-fontify-m-as-s
3499 (or
3500 (string-match "^\\(m\\|qr\\)$" argument)
3501 (and (eq 0 (length argument))
3502 (not (eq ?\< (char-after b)))))))
3503 (progn
5c8b7eaf 3504 (cperl-postpone-fontification
5bd52f0e 3505 b (cperl-1+ b) 'face font-lock-constant-face)
5c8b7eaf 3506 (cperl-postpone-fontification
5bd52f0e
RS
3507 (1- e) e 'face font-lock-constant-face))))
3508 (if i2
3509 (progn
5c8b7eaf 3510 (cperl-postpone-fontification
5bd52f0e
RS
3511 (1- e1) e1 'face font-lock-constant-face)
3512 (if (assoc (char-after b) cperl-starters)
5c8b7eaf 3513 (cperl-postpone-fontification
5bd52f0e
RS
3514 b1 (1+ b1) 'face font-lock-constant-face))))
3515 (if (> (point) max)
3516 (setq tmpend tb))))
f83d2997
KH
3517 ((match-beginning 13) ; sub with prototypes
3518 (setq b (match-beginning 0))
3519 (if (memq (char-after (1- b))
3520 '(?\$ ?\@ ?\% ?\& ?\*))
3521 nil
5c8b7eaf 3522 (setq state (parse-partial-sexp
5bd52f0e
RS
3523 state-point b nil nil state)
3524 state-point b)
f83d2997
KH
3525 (if (or (nth 3 state) (nth 4 state))
3526 nil
3527 ;; Mark as string
3528 (cperl-commentify (match-beginning 13) (match-end 13) t))
3529 (goto-char (match-end 0))))
3530 ;; 1+6+2+1+1+2=13 extra () before this:
3531 ;; "\\$\\(['{]\\)"
3532 ((and (match-beginning 14)
db133cb6 3533 (eq (preceding-char) ?\')) ; $'
f83d2997 3534 (setq b (1- (point))
5c8b7eaf 3535 state (parse-partial-sexp
f83d2997
KH
3536 state-point (1- b) nil nil state)
3537 state-point (1- b))
3538 (if (nth 3 state) ; in string
3539 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3540 (goto-char (1+ b)))
3541 ;; 1+6+2+1+1+2=13 extra () before this:
3542 ;; "\\$\\(['{]\\)"
3543 ((match-beginning 14) ; ${
3544 (setq bb (match-beginning 0))
3545 (cperl-modify-syntax-type bb cperl-st-punct))
3546 ;; 1+6+2+1+1+2+1=14 extra () before this:
3547 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3548 ((match-beginning 15) ; old $abc'efg syntax
3549 (setq bb (match-end 0)
3550 b (match-beginning 0)
5c8b7eaf 3551 state (parse-partial-sexp
f83d2997
KH
3552 state-point b nil nil state)
3553 state-point b)
3554 (if (nth 3 state) ; in string
3555 nil
3556 (put-text-property (1- bb) bb 'syntax-table cperl-st-word))
3557 (goto-char bb))
3558 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3559 ;; "__\\(END\\|DATA\\)__"
3560 (t ; __END__, __DATA__
3561 (setq bb (match-end 0)
3562 b (match-beginning 0)
5c8b7eaf 3563 state (parse-partial-sexp
f83d2997
KH
3564 state-point b nil nil state)
3565 state-point b)
3566 (if (or (nth 3 state) (nth 4 state))
3567 nil
3568 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3569 (cperl-commentify b bb nil)
3570 (setq end t))
3571 (goto-char bb)))
db133cb6 3572 (if (> (point) stop-point)
f83d2997 3573 (progn
5c8b7eaf 3574 (if end
f83d2997
KH
3575 (message "Garbage after __END__/__DATA__ ignored")
3576 (message "Unbalanced syntax found while scanning")
3577 (or (car err-l) (setcar err-l b)))
db133cb6
RS
3578 (goto-char stop-point))))
3579 (setq cperl-syntax-state (cons state-point state)
5bd52f0e 3580 cperl-syntax-done-to (or tmpend (max (point) max))))
f83d2997 3581 (if (car err-l) (goto-char (car err-l))
db133cb6
RS
3582 (or non-inter
3583 (message "Scanning for \"hard\" Perl constructions... done"))))
f83d2997
KH
3584 (and (buffer-modified-p)
3585 (not modified)
3586 (set-buffer-modified-p nil))
3587 (set-syntax-table cperl-mode-syntax-table))
3588 (car err-l)))
3589
3590(defun cperl-backward-to-noncomment (lim)
3591 ;; Stops at lim or after non-whitespace that is not in comment
5bd52f0e 3592 (let (stop p pr)
f83d2997
KH
3593 (while (and (not stop) (> (point) (or lim 1)))
3594 (skip-chars-backward " \t\n\f" lim)
3595 (setq p (point))
3596 (beginning-of-line)
5bd52f0e
RS
3597 (if (memq (setq pr (get-text-property (point) 'syntax-type))
3598 '(pod here-doc here-doc-delim))
3599 (cperl-unwind-to-safe nil)
f83d2997
KH
3600 (if (or (looking-at "^[ \t]*\\(#\\|$\\)")
3601 (progn (cperl-to-comment-or-eol) (bolp)))
3602 nil ; Only comment, skip
3603 ;; Else
3604 (skip-chars-backward " \t")
3605 (if (< p (point)) (goto-char p))
5bd52f0e 3606 (setq stop t))))))
f83d2997
KH
3607
3608(defun cperl-after-block-p (lim)
3609 ;; We suppose that the preceding char is }.
3610 (save-excursion
3611 (condition-case nil
3612 (progn
3613 (forward-sexp -1)
3614 (cperl-backward-to-noncomment lim)
bab27c0c
RS
3615 (or (eq (point) lim)
3616 (eq (preceding-char) ?\) ) ; if () {} sub f () {}
db133cb6
RS
3617 (if (eq (char-syntax (preceding-char)) ?w) ; else {}
3618 (save-excursion
3619 (forward-sexp -1)
5bd52f0e 3620 (or (looking-at "\\(else\\|grep\\|map\\|BEGIN\\|END\\)\\>")
db133cb6
RS
3621 ;; sub f {}
3622 (progn
3623 (cperl-backward-to-noncomment lim)
3624 (and (eq (char-syntax (preceding-char)) ?w)
3625 (progn
3626 (forward-sexp -1)
3627 (looking-at "sub\\>"))))))
3628 (cperl-after-expr-p lim))))
f83d2997
KH
3629 (error nil))))
3630
3631(defun cperl-after-expr-p (&optional lim chars test)
3632 "Returns true if the position is good for start of expression.
3633TEST is the expression to evaluate at the found position. If absent,
3634CHARS is a string that contains good characters to have before us (however,
3635`}' is treated \"smartly\" if it is not in the list)."
5c8b7eaf 3636 (let (stop p
f83d2997
KH
3637 (lim (or lim (point-min))))
3638 (save-excursion
3639 (while (and (not stop) (> (point) lim))
3640 (skip-chars-backward " \t\n\f" lim)
3641 (setq p (point))
3642 (beginning-of-line)
3643 (if (looking-at "^[ \t]*\\(#\\|$\\)") nil ; Only comment, skip
5bd52f0e 3644 ;; Else: last iteration, or a label
5c8b7eaf 3645 (cperl-to-comment-or-eol)
f83d2997
KH
3646 (skip-chars-backward " \t")
3647 (if (< p (point)) (goto-char p))
5bd52f0e
RS
3648 (setq p (point))
3649 (if (and (eq (preceding-char) ?:)
3650 (progn
3651 (forward-char -1)
3652 (skip-chars-backward " \t\n\f" lim)
3653 (eq (char-syntax (preceding-char)) ?w)))
3654 (forward-sexp -1) ; Possibly label. Skip it
3655 (goto-char p)
3656 (setq stop t))))
bab27c0c
RS
3657 (or (bobp) ; ???? Needed
3658 (eq (point) lim)
f83d2997
KH
3659 (progn
3660 (if test (eval test)
3661 (or (memq (preceding-char) (append (or chars "{;") nil))
3662 (and (eq (preceding-char) ?\})
3663 (cperl-after-block-p lim)))))))))
3664
3665(defun cperl-backward-to-start-of-continued-exp (lim)
3666 (if (memq (preceding-char) (append ")]}\"'`" nil))
3667 (forward-sexp -1))
3668 (beginning-of-line)
3669 (if (<= (point) lim)
3670 (goto-char (1+ lim)))
3671 (skip-chars-forward " \t"))
3672
db133cb6
RS
3673(defun cperl-after-block-and-statement-beg (lim)
3674 ;; We assume that we are after ?\}
5c8b7eaf 3675 (and
db133cb6
RS
3676 (cperl-after-block-p lim)
3677 (save-excursion
3678 (forward-sexp -1)
3679 (cperl-backward-to-noncomment (point-min))
3680 (or (bobp)
bab27c0c 3681 (eq (point) lim)
db133cb6
RS
3682 (not (= (char-syntax (preceding-char)) ?w))
3683 (progn
3684 (forward-sexp -1)
5c8b7eaf 3685 (not
db133cb6
RS
3686 (looking-at
3687 "\\(map\\|grep\\|printf?\\|system\\|exec\\|tr\\|s\\)\\>")))))))
3688
f83d2997 3689\f
f83d2997
KH
3690(defun cperl-indent-exp ()
3691 "Simple variant of indentation of continued-sexp.
5bd52f0e
RS
3692
3693Will not indent comment if it starts at `comment-indent' or looks like
3694continuation of the comment on the previous line.
db133cb6 3695
5c8b7eaf 3696If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 3697conditional/loop constructs."
f83d2997
KH
3698 (interactive)
3699 (save-excursion
3700 (let ((tmp-end (progn (end-of-line) (point))) top done)
3701 (save-excursion
3702 (beginning-of-line)
3703 (while (null done)
3704 (setq top (point))
3705 (while (= (nth 0 (parse-partial-sexp (point) tmp-end
3706 -1)) -1)
3707 (setq top (point))) ; Get the outermost parenths in line
3708 (goto-char top)
3709 (while (< (point) tmp-end)
3710 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
3711 (or (eolp) (forward-sexp 1)))
5bd52f0e
RS
3712 (if (> (point) tmp-end)
3713 (save-excursion
3714 (end-of-line)
3715 (setq tmp-end (point)))
f83d2997
KH
3716 (setq done t)))
3717 (goto-char tmp-end)
3718 (setq tmp-end (point-marker)))
db133cb6
RS
3719 (if cperl-indent-region-fix-constructs
3720 (cperl-fix-line-spacing tmp-end))
f83d2997
KH
3721 (cperl-indent-region (point) tmp-end))))
3722
5bd52f0e
RS
3723(defun cperl-fix-line-spacing (&optional end parse-data)
3724 "Improve whitespace in a conditional/loop construct.
3725Returns some position at the last line."
db133cb6
RS
3726 (interactive)
3727 (or end
3728 (setq end (point-max)))
5bd52f0e
RS
3729 (let (p pp ml have-brace ret
3730 (ee (save-excursion (end-of-line) (point)))
db133cb6
RS
3731 (cperl-indent-region-fix-constructs
3732 (or cperl-indent-region-fix-constructs 1)))
3733 (save-excursion
3734 (beginning-of-line)
5bd52f0e 3735 (setq ret (point))
5c8b7eaf 3736 ;; }? continue
5bd52f0e 3737 ;; blah; }
5c8b7eaf 3738 (if (not
5bd52f0e
RS
3739 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
3740 (setq have-brace (save-excursion (search-forward "}" ee t)))))
3741 nil ; Do not need to do anything
db133cb6 3742 ;; Looking at:
5c8b7eaf 3743 ;; }
db133cb6
RS
3744 ;; else
3745 (if (and cperl-merge-trailing-else
3746 (looking-at
3747 "[ \t]*}[ \t]*\n[ \t\n]*\\(els\\(e\\|if\\)\\|continue\\)\\>"))
3748 (progn
3749 (search-forward "}")
3750 (setq p (point))
3751 (skip-chars-forward " \t\n")
3752 (delete-region p (point))
3753 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
3754 (beginning-of-line)))
3755 ;; Looking at:
3756 ;; } else
3757 (if (looking-at "[ \t]*}\\(\t*\\|[ \t][ \t]+\\)\\<\\(els\\(e\\|if\\)\\|continue\\)\\>")
3758 (progn
3759 (search-forward "}")
3760 (delete-horizontal-space)
3761 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
3762 (beginning-of-line)))
3763 ;; Looking at:
3764 ;; else {
5c8b7eaf 3765 (if (looking-at
5bd52f0e 3766 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
db133cb6
RS
3767 (progn
3768 (forward-word 1)
3769 (delete-horizontal-space)
3770 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
3771 (beginning-of-line)))
3772 ;; Looking at:
3773 ;; foreach my $var
5c8b7eaf 3774 (if (looking-at
db133cb6
RS
3775 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\)\\(\t*\\|[ \t][ \t]+\\)[^ \t\n]")
3776 (progn
3777 (forward-word 2)
3778 (delete-horizontal-space)
3779 (insert (make-string cperl-indent-region-fix-constructs ?\ ))
3780 (beginning-of-line)))
3781 ;; Looking at:
3782 ;; foreach my $var (
5c8b7eaf 3783 (if (looking-at
db133cb6
RS
3784 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
3785 (progn
3786 (forward-word 3)
3787 (delete-horizontal-space)
3788 (insert
3789 (make-string cperl-indent-region-fix-constructs ?\ ))
3790 (beginning-of-line)))
3791 ;; Looking at:
3792 ;; } foreach my $var () {
5c8b7eaf 3793 (if (looking-at
5bd52f0e 3794 "[ \t]*\\(}[ \t]*\\)?\\<\\(\\els\\(e\\|if\\)\\|continue\\|if\\|unless\\|while\\|for\\(each\\)?\\(\\([ t]+\\(my\\|local\\)\\)?[ \t]*\\$[_a-zA-Z0-9]+\\)?\\|until\\)\\>\\([ \t]*(\\|[ \t\n]*{\\)\\|[ \t]*{")
db133cb6
RS
3795 (progn
3796 (setq ml (match-beginning 8))
3797 (re-search-forward "[({]")
3798 (forward-char -1)
3799 (setq p (point))
3800 (if (eq (following-char) ?\( )
3801 (progn
3802 (forward-sexp 1)
3803 (setq pp (point)))
3804 ;; after `else' or nothing
3805 (if ml ; after `else'
3806 (skip-chars-backward " \t\n")
3807 (beginning-of-line))
3808 (setq pp nil))
3809 ;; Now after the sexp before the brace
3810 ;; Multiline expr should be special
3811 (setq ml (and pp (save-excursion (goto-char p)
3812 (search-forward "\n" pp t))))
3813 (if (and (or (not pp) (< pp end))
3814 (looking-at "[ \t\n]*{"))
3815 (progn
5c8b7eaf 3816 (cond
db133cb6
RS
3817 ((bolp) ; Were before `{', no if/else/etc
3818 nil)
3819 ((looking-at "\\(\t*\\| [ \t]+\\){")
3820 (delete-horizontal-space)
5c8b7eaf 3821 (if (if ml
db133cb6
RS
3822 cperl-extra-newline-before-brace-multiline
3823 cperl-extra-newline-before-brace)
3824 (progn
3825 (delete-horizontal-space)
3826 (insert "\n")
5bd52f0e
RS
3827 (setq ret (point))
3828 (if (cperl-indent-line parse-data)
5c8b7eaf 3829 (progn
5bd52f0e
RS
3830 (cperl-fix-line-spacing end parse-data)
3831 (setq ret (point)))))
db133cb6
RS
3832 (insert
3833 (make-string cperl-indent-region-fix-constructs ?\ ))))
3834 ((and (looking-at "[ \t]*\n")
5c8b7eaf 3835 (not (if ml
db133cb6
RS
3836 cperl-extra-newline-before-brace-multiline
3837 cperl-extra-newline-before-brace)))
3838 (setq pp (point))
3839 (skip-chars-forward " \t\n")
3840 (delete-region pp (point))
3841 (insert
3842 (make-string cperl-indent-region-fix-constructs ?\ ))))
3843 ;; Now we are before `{'
3844 (if (looking-at "[ \t\n]*{[ \t]*[^ \t\n#]")
3845 (progn
3846 (skip-chars-forward " \t\n")
3847 (setq pp (point))
3848 (forward-sexp 1)
3849 (setq p (point))
3850 (goto-char pp)
3851 (setq ml (search-forward "\n" p t))
3852 (if (or cperl-break-one-line-blocks-when-indent ml)
3853 ;; not good: multi-line BLOCK
3854 (progn
3855 (goto-char (1+ pp))
3856 (delete-horizontal-space)
3857 (insert "\n")
5bd52f0e
RS
3858 (setq ret (point))
3859 (if (cperl-indent-line parse-data)
3860 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
db133cb6 3861 (beginning-of-line)
5bd52f0e 3862 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
db133cb6
RS
3863 ;; Now check whether there is a hanging `}'
3864 ;; Looking at:
3865 ;; } blah
5c8b7eaf 3866 (if (and
db133cb6 3867 cperl-fix-hanging-brace-when-indent
5bd52f0e 3868 have-brace
db133cb6
RS
3869 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
3870 (condition-case nil
3871 (progn
3872 (up-list 1)
5c8b7eaf 3873 (if (and (<= (point) pp)
db133cb6 3874 (eq (preceding-char) ?\} )
5c8b7eaf 3875 (cperl-after-block-and-statement-beg (point-min)))
db133cb6
RS
3876 t
3877 (goto-char p)
3878 nil))
3879 (error nil)))
3880 (progn
3881 (forward-char -1)
3882 (skip-chars-backward " \t")
3883 (if (bolp)
3884 ;; `}' was the first thing on the line, insert NL *after* it.
3885 (progn
5bd52f0e 3886 (cperl-indent-line parse-data)
db133cb6
RS
3887 (search-forward "}")
3888 (delete-horizontal-space)
3889 (insert "\n"))
3890 (delete-horizontal-space)
3891 (or (eq (preceding-char) ?\;)
3892 (bolp)
3893 (and (eq (preceding-char) ?\} )
3894 (cperl-after-block-p (point-min)))
3895 (insert ";"))
5bd52f0e
RS
3896 (insert "\n")
3897 (setq ret (point)))
3898 (if (cperl-indent-line parse-data)
3899 (setq ret (cperl-fix-line-spacing end parse-data)))
3900 (beginning-of-line)))))
3901 ret))
3902
3903(defvar cperl-update-start) ; Do not need to make them local
3904(defvar cperl-update-end)
3905(defun cperl-delay-update-hook (beg end old-len)
3906 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
3907 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
db133cb6 3908
f83d2997
KH
3909(defun cperl-indent-region (start end)
3910 "Simple variant of indentation of region in CPerl mode.
5c8b7eaf 3911Should be slow. Will not indent comment if it starts at `comment-indent'
f83d2997 3912or looks like continuation of the comment on the previous line.
5c8b7eaf
SS
3913Indents all the lines whose first character is between START and END
3914inclusive.
db133cb6 3915
5c8b7eaf 3916If `cperl-indent-region-fix-constructs', will improve spacing on
db133cb6 3917conditional/loop constructs."
f83d2997 3918 (interactive "r")
5bd52f0e 3919 (cperl-update-syntaxification end end)
f83d2997 3920 (save-excursion
5bd52f0e
RS
3921 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
3922 (let (st comm old-comm-indent new-comm-indent p pp i empty
3923 (indent-info (if cperl-emacs-can-parse
3924 (list nil nil nil) ; Cannot use '(), since will modify
3925 nil))
3926 after-change-functions ; Speed it up!
f83d2997 3927 (pm 0) (imenu-scanning-message "Indenting... (%3d%%)"))
5bd52f0e 3928 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
f83d2997
KH
3929 (goto-char start)
3930 (setq old-comm-indent (and (cperl-to-comment-or-eol)
3931 (current-column))
3932 new-comm-indent old-comm-indent)
3933 (goto-char start)
bab27c0c 3934 (setq end (set-marker (make-marker) end)) ; indentation changes pos
f83d2997
KH
3935 (or (bolp) (beginning-of-line 2))
3936 (or (fboundp 'imenu-progress-message)
3937 (message "Indenting... For feedback load `imenu'..."))
3938 (while (and (<= (point) end) (not (eobp))) ; bol to check start
3939 (and (fboundp 'imenu-progress-message)
5c8b7eaf 3940 (imenu-progress-message
f83d2997 3941 pm (/ (* 100 (- (point) start)) (- end start -1))))
5bd52f0e
RS
3942 (setq st (point))
3943 (if (or
3944 (setq empty (looking-at "[ \t]*\n"))
3945 (and (setq comm (looking-at "[ \t]*#"))
5c8b7eaf 3946 (or (eq (current-indentation) (or old-comm-indent
f83d2997 3947 comment-column))
5bd52f0e 3948 (setq old-comm-indent nil))))
f83d2997 3949 (if (and old-comm-indent
5bd52f0e 3950 (not empty)
f83d2997 3951 (= (current-indentation) old-comm-indent)
5bd52f0e
RS
3952 (not (eq (get-text-property (point) 'syntax-type) 'pod))
3953 (not (eq (get-text-property (point) 'syntax-table)
3954 cperl-st-cfence)))
f83d2997
KH
3955 (let ((comment-column new-comm-indent))
3956 (indent-for-comment)))
5c8b7eaf 3957 (progn
5bd52f0e 3958 (setq i (cperl-indent-line indent-info))
f83d2997 3959 (or comm
db133cb6 3960 (not i)
f83d2997 3961 (progn
db133cb6 3962 (if cperl-indent-region-fix-constructs
5bd52f0e 3963 (goto-char (cperl-fix-line-spacing end indent-info)))
5c8b7eaf 3964 (if (setq old-comm-indent
f83d2997 3965 (and (cperl-to-comment-or-eol)
5c8b7eaf 3966 (not (memq (get-text-property (point)
f83d2997
KH
3967 'syntax-type)
3968 '(pod here-doc)))
5c8b7eaf 3969 (not (eq (get-text-property (point)
5bd52f0e
RS
3970 'syntax-table)
3971 cperl-st-cfence))
f83d2997
KH
3972 (current-column)))
3973 (progn (indent-for-comment)
3974 (skip-chars-backward " \t")
3975 (skip-chars-backward "#")
3976 (setq new-comm-indent (current-column))))))))
3977 (beginning-of-line 2))
3978 (if (fboundp 'imenu-progress-message)
3979 (imenu-progress-message pm 100)
5bd52f0e
RS
3980 (message nil)))
3981 ;; Now run the update hooks
3982 (if after-change-functions
3983 (save-excursion
3984 (if cperl-update-end
3985 (progn
3986 (goto-char cperl-update-end)
3987 (insert " ")
3988 (delete-char -1)
3989 (goto-char cperl-update-start)
3990 (insert " ")
3991 (delete-char -1))))))))
f83d2997 3992
f83d2997
KH
3993;; Stolen from lisp-mode with a lot of improvements
3994
3995(defun cperl-fill-paragraph (&optional justify iteration)
3996 "Like \\[fill-paragraph], but handle CPerl comments.
3997If any of the current line is a comment, fill the comment or the
3998block of it that point is in, preserving the comment's initial
3999indentation and initial hashes. Behaves usually outside of comment."
4000 (interactive "P")
4001 (let (
4002 ;; Non-nil if the current line contains a comment.
4003 has-comment
4004
4005 ;; If has-comment, the appropriate fill-prefix for the comment.
4006 comment-fill-prefix
4007 ;; Line that contains code and comment (or nil)
4008 start
4009 c spaces len dc (comment-column comment-column))
4010 ;; Figure out what kind of comment we are looking at.
4011 (save-excursion
4012 (beginning-of-line)
4013 (cond
4014
4015 ;; A line with nothing but a comment on it?
4016 ((looking-at "[ \t]*#[# \t]*")
4017 (setq has-comment t
4018 comment-fill-prefix (buffer-substring (match-beginning 0)
4019 (match-end 0))))
4020
4021 ;; A line with some code, followed by a comment? Remember that the
4022 ;; semi which starts the comment shouldn't be part of a string or
4023 ;; character.
4024 ((cperl-to-comment-or-eol)
4025 (setq has-comment t)
4026 (looking-at "#+[ \t]*")
5c8b7eaf 4027 (setq start (point) c (current-column)
f83d2997
KH
4028 comment-fill-prefix
4029 (concat (make-string (current-column) ?\ )
4030 (buffer-substring (match-beginning 0) (match-end 0)))
5c8b7eaf 4031 spaces (progn (skip-chars-backward " \t")
f83d2997 4032 (buffer-substring (point) start))
5c8b7eaf 4033 dc (- c (current-column)) len (- start (point))
f83d2997
KH
4034 start (point-marker))
4035 (delete-char len)
4036 (insert (make-string dc ?-)))))
4037 (if (not has-comment)
4038 (fill-paragraph justify) ; Do the usual thing outside of comment
4039 ;; Narrow to include only the comment, and then fill the region.
4040 (save-restriction
4041 (narrow-to-region
4042 ;; Find the first line we should include in the region to fill.
4043 (if start (progn (beginning-of-line) (point))
4044 (save-excursion
4045 (while (and (zerop (forward-line -1))
4046 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4047 ;; We may have gone to far. Go forward again.
4048 (or (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")
4049 (forward-line 1))
4050 (point)))
4051 ;; Find the beginning of the first line past the region to fill.
4052 (save-excursion
4053 (while (progn (forward-line 1)
4054 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
4055 (point)))
4056 ;; Remove existing hashes
4057 (goto-char (point-min))
4058 (while (progn (forward-line 1) (< (point) (point-max)))
4059 (skip-chars-forward " \t")
5c8b7eaf 4060 (and (looking-at "#+")
f83d2997
KH
4061 (delete-char (- (match-end 0) (match-beginning 0)))))
4062
4063 ;; Lines with only hashes on them can be paragraph boundaries.
4064 (let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
4065 (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
4066 (fill-prefix comment-fill-prefix))
4067 (fill-paragraph justify)))
4068 (if (and start)
5c8b7eaf 4069 (progn
f83d2997
KH
4070 (goto-char start)
4071 (if (> dc 0)
4072 (progn (delete-char dc) (insert spaces)))
4073 (if (or (= (current-column) c) iteration) nil
4074 (setq comment-column c)
4075 (indent-for-comment)
4076 ;; Repeat once more, flagging as iteration
4077 (cperl-fill-paragraph justify t)))))))
4078
4079(defun cperl-do-auto-fill ()
4080 ;; Break out if the line is short enough
4081 (if (> (save-excursion
4082 (end-of-line)
4083 (current-column))
4084 fill-column)
4085 (let ((c (save-excursion (beginning-of-line)
4086 (cperl-to-comment-or-eol) (point)))
4087 (s (memq (following-char) '(?\ ?\t))) marker)
4088 (if (>= c (point)) nil
4089 (setq marker (point-marker))
4090 (cperl-fill-paragraph)
4091 (goto-char marker)
4092 ;; Is not enough, sometimes marker is a start of line
5c8b7eaf 4093 (if (bolp) (progn (re-search-forward "#+[ \t]*")
f83d2997
KH
4094 (goto-char (match-end 0))))
4095 ;; Following space could have gone:
4096 (if (or (not s) (memq (following-char) '(?\ ?\t))) nil
4097 (insert " ")
4098 (backward-char 1))
4099 ;; Previous space could have gone:
4100 (or (memq (preceding-char) '(?\ ?\t)) (insert " "))))))
4101
80585273 4102(defvar cperl-imenu--function-name-regexp-perl
5c8b7eaf 4103 (concat
f83d2997
KH
4104 "^\\("
4105 "[ \t]*\\(sub\\|package\\)[ \t\n]+\\([a-zA-Z_0-9:']+\\)[ \t]*\\(([^()]*)[ \t]*\\)?"
4106 "\\|"
4107 "=head\\([12]\\)[ \t]+\\([^\n]+\\)$"
4108 "\\)"))
4109
4110(defun cperl-imenu-addback (lst &optional isback name)
4111 ;; We suppose that the lst is a DAG, unless the first element only
4112 ;; loops back, and ISBACK is set. Thus this function cannot be
4113 ;; applied twice without ISBACK set.
4114 (cond ((not cperl-imenu-addback) lst)
4115 (t
5c8b7eaf 4116 (or name
f83d2997
KH
4117 (setq name "+++BACK+++"))
4118 (mapcar (function (lambda (elt)
4119 (if (and (listp elt) (listp (cdr elt)))
4120 (progn
4121 ;; In the other order it goes up
4122 ;; one level only ;-(
4123 (setcdr elt (cons (cons name lst)
4124 (cdr elt)))
4125 (cperl-imenu-addback (cdr elt) t name)
4126 ))))
4127 (if isback (cdr lst) lst))
4128 lst)))
4129
80585273 4130(defun cperl-imenu--create-perl-index (&optional regexp)
f83d2997 4131 (require 'imenu) ; May be called from TAGS creator
5c8b7eaf 4132 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
f83d2997
KH
4133 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
4134 (index-meth-alist '()) meth
4135 packages ends-ranges p
4136 (prev-pos 0) char fchar index index1 name (end-range 0) package)
4137 (goto-char (point-min))
4138 (if noninteractive
4139 (message "Scanning Perl for index")
4140 (imenu-progress-message prev-pos 0))
4141 ;; Search for the function
4142 (progn ;;save-match-data
4143 (while (re-search-forward
80585273 4144 (or regexp cperl-imenu--function-name-regexp-perl)
f83d2997
KH
4145 nil t)
4146 (or noninteractive
4147 (imenu-progress-message prev-pos))
f83d2997
KH
4148 (cond
4149 ((and ; Skip some noise if building tags
4150 (match-beginning 2) ; package or sub
4151 (eq (char-after (match-beginning 2)) ?p) ; package
4152 (not (save-match-data
4153 (looking-at "[ \t\n]*;")))) ; Plain text word 'package'
4154 nil)
4155 ((and
4156 (match-beginning 2) ; package or sub
4157 ;; Skip if quoted (will not skip multi-line ''-comments :-():
4158 (null (get-text-property (match-beginning 1) 'syntax-table))
4159 (null (get-text-property (match-beginning 1) 'syntax-type))
4160 (null (get-text-property (match-beginning 1) 'in-pod)))
4161 (save-excursion
4162 (goto-char (match-beginning 2))
4163 (setq fchar (following-char))
4164 )
4165 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4166 ;; (goto-char (match-end 0))) ; Messes what follows
5c8b7eaf 4167 (setq char (following-char)
f83d2997
KH
4168 meth nil
4169 p (point))
4170 (while (and ends-ranges (>= p (car ends-ranges)))
4171 ;; delete obsolete entries
4172 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
4173 (setq package (or (car packages) "")
4174 end-range (or (car ends-ranges) 0))
4175 (if (eq fchar ?p)
4176 (setq name (buffer-substring (match-beginning 3) (match-end 3))
4177 name (progn
4178 (set-text-properties 0 (length name) nil name)
4179 name)
5c8b7eaf 4180 package (concat name "::")
f83d2997 4181 name (concat "package " name)
5c8b7eaf 4182 end-range
f83d2997
KH
4183 (save-excursion
4184 (parse-partial-sexp (point) (point-max) -1) (point))
4185 ends-ranges (cons end-range ends-ranges)
4186 packages (cons package packages)))
4187 ;; )
4188 ;; Skip this function name if it is a prototype declaration.
4189 (if (and (eq fchar ?s) (eq char ?\;)) nil
4190 (setq index (imenu-example--name-and-position))
4191 (if (eq fchar ?p) nil
4192 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
4193 (set-text-properties 0 (length name) nil name)
4194 (cond ((string-match "[:']" name)
4195 (setq meth t))
4196 ((> p end-range) nil)
5c8b7eaf 4197 (t
f83d2997
KH
4198 (setq name (concat package name) meth t))))
4199 (setcar index name)
5c8b7eaf 4200 (if (eq fchar ?p)
f83d2997
KH
4201 (push index index-pack-alist)
4202 (push index index-alist))
4203 (if meth (push index index-meth-alist))
4204 (push index index-unsorted-alist)))
4205 ((match-beginning 5) ; Pod section
4206 ;; (beginning-of-line)
4207 (setq index (imenu-example--name-and-position)
4208 name (buffer-substring (match-beginning 6) (match-end 6)))
4209 (set-text-properties 0 (length name) nil name)
4210 (if (eq (char-after (match-beginning 5)) ?2)
4211 (setq name (concat " " name)))
4212 (setcar index name)
4213 (setq index1 (cons (concat "=" name) (cdr index)))
4214 (push index index-pod-alist)
4215 (push index1 index-unsorted-alist)))))
4216 (or noninteractive
4217 (imenu-progress-message prev-pos 100))
5c8b7eaf 4218 (setq index-alist
f83d2997
KH
4219 (if (default-value 'imenu-sort-function)
4220 (sort index-alist (default-value 'imenu-sort-function))
4221 (nreverse index-alist)))
4222 (and index-pod-alist
4223 (push (cons "+POD headers+..."
4224 (nreverse index-pod-alist))
4225 index-alist))
4226 (and (or index-pack-alist index-meth-alist)
4227 (let ((lst index-pack-alist) hier-list pack elt group name)
4228 ;; Remove "package ", reverse and uniquify.
4229 (while lst
4230 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
4231 (if (assoc name hier-list) nil
4232 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
4233 (setq lst index-meth-alist)
4234 (while lst
4235 (setq elt (car lst) lst (cdr lst))
4236 (cond ((string-match "\\(::\\|'\\)[_a-zA-Z0-9]+$" (car elt))
4237 (setq pack (substring (car elt) 0 (match-beginning 0)))
5c8b7eaf 4238 (if (setq group (assoc pack hier-list))
f83d2997
KH
4239 (if (listp (cdr group))
4240 ;; Have some functions already
5c8b7eaf
SS
4241 (setcdr group
4242 (cons (cons (substring
f83d2997
KH
4243 (car elt)
4244 (+ 2 (match-beginning 0)))
4245 (cdr elt))
4246 (cdr group)))
5c8b7eaf 4247 (setcdr group (list (cons (substring
f83d2997
KH
4248 (car elt)
4249 (+ 2 (match-beginning 0)))
4250 (cdr elt)))))
5c8b7eaf
SS
4251 (setq hier-list
4252 (cons (cons pack
4253 (list (cons (substring
f83d2997
KH
4254 (car elt)
4255 (+ 2 (match-beginning 0)))
4256 (cdr elt))))
4257 hier-list))))))
4258 (push (cons "+Hierarchy+..."
4259 hier-list)
4260 index-alist)))
4261 (and index-pack-alist
4262 (push (cons "+Packages+..."
4263 (nreverse index-pack-alist))
4264 index-alist))
5c8b7eaf 4265 (and (or index-pack-alist index-pod-alist
f83d2997
KH
4266 (default-value 'imenu-sort-function))
4267 index-unsorted-alist
4268 (push (cons "+Unsorted List+..."
4269 (nreverse index-unsorted-alist))
4270 index-alist))
4271 (cperl-imenu-addback index-alist)))
4272
5c8b7eaf 4273(defvar cperl-compilation-error-regexp-alist
f83d2997
KH
4274 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4275 '(("^[^\n]* \\(file\\|at\\) \\([^ \t\n]+\\) [^\n]*line \\([0-9]+\\)[\\., \n]"
4276 2 3))
4277 "Alist that specifies how to match errors in perl output.")
4278
4279(if (fboundp 'eval-after-load)
4280 (eval-after-load
4281 "mode-compile"
4282 '(setq perl-compilation-error-regexp-alist
4283 cperl-compilation-error-regexp-alist)))
4284
4285
f83d2997
KH
4286(defun cperl-windowed-init ()
4287 "Initialization under windowed version."
db133cb6
RS
4288 (if (or (featurep 'ps-print) cperl-faces-init)
4289 ;; Need to init anyway:
4290 (or cperl-faces-init (cperl-init-faces))
4291 (add-hook 'font-lock-mode-hook
4292 (function
4293 (lambda ()
4294 (if (or
4295 (eq major-mode 'perl-mode)
4296 (eq major-mode 'cperl-mode))
4297 (progn
4298 (or cperl-faces-init (cperl-init-faces)))))))
4299 (if (fboundp 'eval-after-load)
4300 (eval-after-load
4301 "ps-print"
4302 '(or cperl-faces-init (cperl-init-faces))))))
4303
80585273
DL
4304(defvar perl-font-lock-keywords-1 nil
4305 "Additional expressions to highlight in Perl mode. Minimal set.")
4306(defvar perl-font-lock-keywords nil
4307 "Additional expressions to highlight in Perl mode. Default set.")
4308(defvar perl-font-lock-keywords-2 nil
4309 "Additional expressions to highlight in Perl mode. Maximal set")
4310
db133cb6
RS
4311(defun cperl-load-font-lock-keywords ()
4312 (or cperl-faces-init (cperl-init-faces))
4313 perl-font-lock-keywords)
4314
4315(defun cperl-load-font-lock-keywords-1 ()
4316 (or cperl-faces-init (cperl-init-faces))
4317 perl-font-lock-keywords-1)
4318
4319(defun cperl-load-font-lock-keywords-2 ()
4320 (or cperl-faces-init (cperl-init-faces))
4321 perl-font-lock-keywords-2)
f83d2997 4322
5bd52f0e
RS
4323(defun cperl-init-faces-weak ()
4324 ;; Allow `cperl-find-pods-heres' to run.
4325 (or (boundp 'font-lock-constant-face)
4326 (cperl-force-face font-lock-constant-face
4327 "Face for constant and label names")
4328 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4329 ))
4330
f83d2997 4331(defun cperl-init-faces ()
5bd52f0e 4332 (condition-case errs
f83d2997
KH
4333 (progn
4334 (require 'font-lock)
4335 (and (fboundp 'font-lock-fontify-anchored-keywords)
4336 (featurep 'font-lock-extra)
4337 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
4338 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
f83d2997
KH
4339 (if (fboundp 'font-lock-fontify-anchored-keywords)
4340 (setq font-lock-anchored t))
5c8b7eaf 4341 (setq
f83d2997
KH
4342 t-font-lock-keywords
4343 (list
5bd52f0e 4344 (list "[ \t]+$" 0 cperl-invalid-face t)
f83d2997
KH
4345 (cons
4346 (concat
4347 "\\(^\\|[^$@%&\\]\\)\\<\\("
4348 (mapconcat
4349 'identity
4350 '("if" "until" "while" "elsif" "else" "unless" "for"
4351 "foreach" "continue" "exit" "die" "last" "goto" "next"
4352 "redo" "return" "local" "exec" "sub" "do" "dump" "use"
4353 "require" "package" "eval" "my" "BEGIN" "END")
4354 "\\|") ; Flow control
4355 "\\)\\>") 2) ; was "\\)[ \n\t;():,\|&]"
4356 ; In what follows we use `type' style
4357 ; for overwritable builtins
4358 (list
4359 (concat
4360 "\\(^\\|[^$@%&\\]\\)\\<\\("
4361 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4362 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4363 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4364 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4365 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4366 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4367 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4368 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4369 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4370 ;; "gethostbyname" "gethostent" "getlogin"
4371 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4372 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4373 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4374 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4375 ;; "getservbyport" "getservent" "getsockname"
4376 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4377 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5bd52f0e 4378 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
f83d2997
KH
4379 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4380 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4381 ;; "quotemeta" "rand" "read" "readdir" "readline"
4382 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4383 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4384 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4385 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4386 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4387 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4388 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4389 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
4390 ;; "syscall" "sysread" "system" "syswrite" "tell"
4391 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4392 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4393 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5c8b7eaf 4394 "a\\(bs\\|ccept\\|tan2\\|larm\\|nd\\)\\|"
f83d2997
KH
4395 "b\\(in\\(d\\|mode\\)\\|less\\)\\|"
4396 "c\\(h\\(r\\(\\|oot\\)\\|dir\\|mod\\|own\\)\\|aller\\|rypt\\|"
4397 "lose\\(\\|dir\\)\\|mp\\|o\\(s\\|n\\(tinue\\|nect\\)\\)\\)\\|"
4398 "CORE\\|d\\(ie\\|bm\\(close\\|open\\)\\|ump\\)\\|"
4399 "e\\(x\\(p\\|it\\|ec\\)\\|q\\|nd\\(p\\(rotoent\\|went\\)\\|"
4400 "hostent\\|servent\\|netent\\|grent\\)\\|of\\)\\|"
4401 "f\\(ileno\\|cntl\\|lock\\|or\\(k\\|mline\\)\\)\\|"
4402 "g\\(t\\|lob\\|mtime\\|e\\(\\|t\\(p\\(pid\\|r\\(iority\\|"
4403 "oto\\(byn\\(ame\\|umber\\)\\|ent\\)\\)\\|eername\\|w"
4404 "\\(uid\\|ent\\|nam\\)\\|grp\\)\\|host\\(by\\(addr\\|name\\)\\|"
4405 "ent\\)\\|s\\(erv\\(by\\(port\\|name\\)\\|ent\\)\\|"
4406 "ock\\(name\\|opt\\)\\)\\|c\\|login\\|net\\(by\\(addr\\|name\\)\\|"
4407 "ent\\)\\|gr\\(ent\\|nam\\|gid\\)\\)\\)\\)\\|"
4408 "hex\\|i\\(n\\(t\\|dex\\)\\|octl\\)\\|join\\|kill\\|"
4409 "l\\(i\\(sten\\|nk\\)\\|stat\\|c\\(\\|first\\)\\|t\\|e"
5bd52f0e 4410 "\\(\\|ngth\\)\\|o\\(c\\(altime\\|k\\)\\|g\\)\\)\\|m\\(sg\\(rcv\\|snd\\|"
f83d2997
KH
4411 "ctl\\|get\\)\\|kdir\\)\\|n\\(e\\|ot\\)\\|o\\(pen\\(\\|dir\\)\\|"
4412 "r\\(\\|d\\)\\|ct\\)\\|p\\(ipe\\|ack\\)\\|quotemeta\\|"
4413 "r\\(index\\|and\\|mdir\\|e\\(quire\\|ad\\(pipe\\|\\|lin"
4414 "\\(k\\|e\\)\\|dir\\)\\|set\\|cv\\|verse\\|f\\|winddir\\|name"
4415 "\\)\\)\\|s\\(printf\\|qrt\\|rand\\|tat\\|ubstr\\|e\\(t\\(p\\(r"
4416 "\\(iority\\|otoent\\)\\|went\\|grp\\)\\|hostent\\|s\\(ervent\\|"
4417 "ockopt\\)\\|netent\\|grent\\)\\|ek\\(\\|dir\\)\\|lect\\|"
4418 "m\\(ctl\\|op\\|get\\)\\|nd\\)\\|h\\(utdown\\|m\\(read\\|ctl\\|"
4419 "write\\|get\\)\\)\\|y\\(s\\(read\\|call\\|tem\\|write\\)\\|"
4420 "mlink\\)\\|in\\|leep\\|ocket\\(pair\\|\\)\\)\\|t\\(runcate\\|"
4421 "ell\\(\\|dir\\)\\|ime\\(\\|s\\)\\)\\|u\\(c\\(\\|first\\)\\|"
4422 "time\\|mask\\|n\\(pack\\|link\\)\\)\\|v\\(alues\\|ec\\)\\|"
4423 "w\\(a\\(rn\\|it\\(pid\\|\\)\\|ntarray\\)\\|rite\\)\\|"
4424 "x\\(\\|or\\)\\|__\\(FILE__\\|LINE__\\|PACKAGE__\\)"
4425 "\\)\\>") 2 'font-lock-type-face)
4426 ;; In what follows we use `other' style
4427 ;; for nonoverwritable builtins
4428 ;; Somehow 's', 'm' are not auto-generated???
4429 (list
4430 (concat
4431 "\\(^\\|[^$@%&\\]\\)\\<\\("
4432 ;; "AUTOLOAD" "BEGIN" "DESTROY" "END" "__END__" "chomp"
4433 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4434 ;; "eval" "exists" "for" "foreach" "format" "goto"
4435 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4436 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4437 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4438 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4439 ;; "undef" "unless" "unshift" "untie" "until" "use"
4440 ;; "while" "y"
4441 "AUTOLOAD\\|BEGIN\\|cho\\(p\\|mp\\)\\|d\\(e\\(fined\\|lete\\)\\|"
4442 "o\\)\\|DESTROY\\|e\\(ach\\|val\\|xists\\|ls\\(e\\|if\\)\\)\\|"
4443 "END\\|for\\(\\|each\\|mat\\)\\|g\\(rep\\|oto\\)\\|if\\|keys\\|"
4444 "l\\(ast\\|ocal\\)\\|m\\(ap\\|y\\)\\|n\\(ext\\|o\\)\\|"
4445 "p\\(ackage\\|rint\\(\\|f\\)\\|ush\\|o\\(p\\|s\\)\\)\\|"
5bd52f0e 4446 "q\\(\\|q\\|w\\|x\\|r\\)\\|re\\(turn\\|do\\)\\|s\\(pli\\(ce\\|t\\)\\|"
f83d2997
KH
4447 "calar\\|tudy\\|ub\\|hift\\|ort\\)\\|t\\(r\\|ie\\)\\|"
4448 "u\\(se\\|n\\(shift\\|ti\\(l\\|e\\)\\|def\\|less\\)\\)\\|"
4449 "while\\|y\\|__\\(END\\|DATA\\)__" ;__DATA__ added manually
4450 "\\|[sm]" ; Added manually
5bd52f0e 4451 "\\)\\>") 2 'cperl-nonoverridable-face)
f83d2997
KH
4452 ;; (mapconcat 'identity
4453 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4454 ;; "#include" "#define" "#undef")
4455 ;; "\\|")
4456 '("-[rwxoRWXOezsfdlpSbctugkTBMAC]\\>\\([ \t]+_\\>\\)?" 0
4457 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
5bd52f0e 4458 '("\\<sub[ \t]+\\([^ \t{;()]+\\)[ \t]*\\(([^()]*)[ \t]*\\)?[#{\n]" 1
f83d2997
KH
4459 font-lock-function-name-face)
4460 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4461 2 font-lock-function-name-face)
4462 '("^[ \t]*format[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t]*=[ \t]*$"
4463 1 font-lock-function-name-face)
4464 (cond ((featurep 'font-lock-extra)
5c8b7eaf 4465 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
f83d2997
KH
4466 (2 font-lock-string-face t)
4467 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
4468 (font-lock-anchored
4469 '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4470 (2 font-lock-string-face t)
4471 ("\\=[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4472 nil nil
4473 (1 font-lock-string-face t))))
4474 (t '("\\([]}\\\\%@>*&]\\|\\$[a-zA-Z0-9_:]*\\)[ \t]*{[ \t]*\\(-?[a-zA-Z0-9_:]+\\)[ \t]*}"
4475 2 font-lock-string-face t)))
db133cb6 4476 '("[\[ \t{,(]\\(-?[a-zA-Z0-9_:]+\\)[ \t]*=>" 1
f83d2997 4477 font-lock-string-face t)
5c8b7eaf 4478 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
883212ce 4479 font-lock-constant-face) ; labels
f83d2997 4480 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
883212ce 4481 2 font-lock-constant-face)
f83d2997
KH
4482 (cond ((featurep 'font-lock-extra)
4483 '("^[ \t]*\\(my\\|local\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4484 (3 font-lock-variable-name-face)
4485 (4 '(another 4 nil
4486 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)\\([ \t]*,\\)?"
4487 (1 font-lock-variable-name-face)
5c8b7eaf 4488 (2 '(restart 2 nil) nil t)))
f83d2997
KH
4489 nil t))) ; local variables, multiple
4490 (font-lock-anchored
4491 '("^[ \t{}]*\\(my\\|local\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4492 (3 font-lock-variable-name-face)
4493 ("\\=[ \t]*,[ \t]*\\([$@%*][a-zA-Z0-9_:]+\\)"
4494 nil nil
4495 (1 font-lock-variable-name-face))))
4496 (t '("^[ \t{}]*\\(my\\|local\\)[ \t]*\\(([ \t]*\\)?\\([$@%*][a-zA-Z0-9_:]+\\)"
4497 3 font-lock-variable-name-face)))
4498 '("\\<for\\(each\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
4499 2 font-lock-variable-name-face)))
5c8b7eaf 4500 (setq
f83d2997
KH
4501 t-font-lock-keywords-1
4502 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
4503 (not cperl-xemacs-p) ; not yet as of XEmacs 19.12
4504 '(
4505 ("\\(\\([@%]\\|\$#\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)" 1
4506 (if (eq (char-after (match-beginning 2)) ?%)
5bd52f0e
RS
4507 cperl-hash-face
4508 cperl-array-face)
f83d2997
KH
4509 t) ; arrays and hashes
4510 ("\\(\\([$@]+\\)[a-zA-Z_:][a-zA-Z0-9_:]*\\)[ \t]*\\([[{]\\)"
4511 1
5c8b7eaf 4512 (if (= (- (match-end 2) (match-beginning 2)) 1)
f83d2997 4513 (if (eq (char-after (match-beginning 3)) ?{)
5bd52f0e
RS
4514 cperl-hash-face
4515 cperl-array-face) ; arrays and hashes
f83d2997
KH
4516 font-lock-variable-name-face) ; Just to put something
4517 t)
4518 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4519 ;;; Too much noise from \s* @s[ and friends
5c8b7eaf 4520 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
f83d2997
KH
4521 ;;(3 font-lock-function-name-face t t)
4522 ;;(4
4523 ;; (if (cperl-slash-is-regexp)
4524 ;; font-lock-function-name-face 'default) nil t))
4525 )))
5c8b7eaf 4526 (setq perl-font-lock-keywords-1
5bd52f0e
RS
4527 (if cperl-syntaxify-by-font-lock
4528 (cons 'cperl-fontify-update
4529 t-font-lock-keywords)
4530 t-font-lock-keywords)
f83d2997
KH
4531 perl-font-lock-keywords perl-font-lock-keywords-1
4532 perl-font-lock-keywords-2 (append
5bd52f0e 4533 perl-font-lock-keywords-1
f83d2997
KH
4534 t-font-lock-keywords-1)))
4535 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
4536 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
db133cb6
RS
4537 (eval ; Avoid a warning
4538 '(font-lock-require-faces
f83d2997
KH
4539 (list
4540 ;; Color-light Color-dark Gray-light Gray-dark Mono
4541 (list 'font-lock-comment-face
4542 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
4543 nil
4544 [nil nil t t t]
4545 [nil nil t t t]
4546 nil)
4547 (list 'font-lock-string-face
4548 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
4549 nil
4550 nil
4551 [nil nil t t t]
4552 nil)
f83d2997
KH
4553 (list 'font-lock-function-name-face
4554 (vector
4555 "Blue" "LightSkyBlue" "Gray50" "LightGray"
4556 (cdr (assq 'background-color ; if mono
4557 (frame-parameters))))
4558 (vector
4559 nil nil nil nil
4560 (cdr (assq 'foreground-color ; if mono
4561 (frame-parameters))))
4562 [nil nil t t t]
4563 nil
4564 nil)
4565 (list 'font-lock-variable-name-face
4566 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
4567 nil
4568 [nil nil t t t]
4569 [nil nil t t t]
4570 nil)
4571 (list 'font-lock-type-face
4572 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
4573 nil
4574 [nil nil t t t]
4575 nil
4576 [nil nil t t t]
4577 )
883212ce 4578 (list 'font-lock-constant-face
f83d2997
KH
4579 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
4580 nil
4581 [nil nil t t t]
4582 nil
4583 [nil nil t t t]
4584 )
5bd52f0e 4585 (list 'cperl-nonoverridable-face
f83d2997
KH
4586 ["chartreuse3" ("orchid1" "orange")
4587 nil "Gray80"]
4588 [nil nil "gray90"]
4589 [nil nil nil t t]
4590 [nil nil t t]
4591 [nil nil t t t]
4592 )
5bd52f0e 4593 (list 'cperl-array-face
f83d2997
KH
4594 ["blue" "yellow" nil "Gray80"]
4595 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4596 "gray90"]
4597 t
4598 nil
4599 nil)
5bd52f0e 4600 (list 'cperl-hash-face
f83d2997
KH
4601 ["red" "red" nil "Gray80"]
4602 ["lightyellow2" ("navy" "os2blue" "darkgreen")
4603 "gray90"]
4604 t
4605 t
db133cb6 4606 nil))))
5bd52f0e 4607 ;; Do it the dull way, without choose-color
f83d2997
KH
4608 (defvar cperl-guessed-background nil
4609 "Display characteristics as guessed by cperl.")
5bd52f0e 4610;; (or (fboundp 'x-color-defined-p)
5c8b7eaf 4611;; (defalias 'x-color-defined-p
5bd52f0e
RS
4612;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4613;; ;; XEmacs >= 19.12
4614;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4615;; ;; XEmacs 19.11
4616;; (t 'x-valid-color-name-p))))
5c8b7eaf 4617 (cperl-force-face font-lock-constant-face
5bd52f0e
RS
4618 "Face for constant and label names")
4619 (cperl-force-face font-lock-variable-name-face
4620 "Face for variable names")
4621 (cperl-force-face font-lock-type-face
4622 "Face for data types")
4623 (cperl-force-face cperl-nonoverridable-face
4624 "Face for data types from another group")
4625 (cperl-force-face font-lock-comment-face
4626 "Face for comments")
4627 (cperl-force-face font-lock-function-name-face
4628 "Face for function names")
4629 (cperl-force-face cperl-hash-face
4630 "Face for hashes")
4631 (cperl-force-face cperl-array-face
4632 "Face for arrays")
4633 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4634 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4635 ;;(or (boundp 'font-lock-type-face)
4636 ;; (defconst font-lock-type-face
4637 ;; 'font-lock-type-face
4638 ;; "Face to use for data types."))
4639 ;;(or (boundp 'cperl-nonoverridable-face)
4640 ;; (defconst cperl-nonoverridable-face
4641 ;; 'cperl-nonoverridable-face
4642 ;; "Face to use for data types from another group."))
4643 ;;(if (not cperl-xemacs-p) nil
4644 ;; (or (boundp 'font-lock-comment-face)
4645 ;; (defconst font-lock-comment-face
4646 ;; 'font-lock-comment-face
4647 ;; "Face to use for comments."))
4648 ;; (or (boundp 'font-lock-keyword-face)
4649 ;; (defconst font-lock-keyword-face
4650 ;; 'font-lock-keyword-face
4651 ;; "Face to use for keywords."))
4652 ;; (or (boundp 'font-lock-function-name-face)
4653 ;; (defconst font-lock-function-name-face
4654 ;; 'font-lock-function-name-face
4655 ;; "Face to use for function names.")))
4656 (if (and
5c8b7eaf
SS
4657 (not (cperl-is-face 'cperl-array-face))
4658 (cperl-is-face 'font-lock-emphasized-face))
5bd52f0e
RS
4659 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
4660 (if (and
5c8b7eaf
SS
4661 (not (cperl-is-face 'cperl-hash-face))
4662 (cperl-is-face 'font-lock-other-emphasized-face))
4663 (copy-face 'font-lock-other-emphasized-face
5bd52f0e
RS
4664 'cperl-hash-face))
4665 (if (and
5c8b7eaf
SS
4666 (not (cperl-is-face 'cperl-nonoverridable-face))
4667 (cperl-is-face 'font-lock-other-type-face))
4668 (copy-face 'font-lock-other-type-face
5bd52f0e
RS
4669 'cperl-nonoverridable-face))
4670 ;;(or (boundp 'cperl-hash-face)
4671 ;; (defconst cperl-hash-face
4672 ;; 'cperl-hash-face
4673 ;; "Face to use for hashes."))
4674 ;;(or (boundp 'cperl-array-face)
4675 ;; (defconst cperl-array-face
4676 ;; 'cperl-array-face
4677 ;; "Face to use for arrays."))
f83d2997
KH
4678 ;; Here we try to guess background
4679 (let ((background
4680 (if (boundp 'font-lock-background-mode)
4681 font-lock-background-mode
5c8b7eaf 4682 'light))
f83d2997 4683 (face-list (and (fboundp 'face-list) (face-list)))
5bd52f0e
RS
4684 ;; cperl-is-face
4685 )
4686;;;; (fset 'cperl-is-face
4687;;;; (cond ((fboundp 'find-face)
4688;;;; (symbol-function 'find-face))
4689;;;; (face-list
4690;;;; (function (lambda (face) (member face face-list))))
4691;;;; (t
4692;;;; (function (lambda (face) (boundp face))))))
f83d2997
KH
4693 (defvar cperl-guessed-background
4694 (if (and (boundp 'font-lock-display-type)
4695 (eq font-lock-display-type 'grayscale))
4696 'gray
4697 background)
4698 "Background as guessed by CPerl mode")
5c8b7eaf
SS
4699 (if (and
4700 (not (cperl-is-face 'font-lock-constant-face))
4701 (cperl-is-face 'font-lock-reference-face))
db133cb6
RS
4702 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
4703 (if (cperl-is-face 'font-lock-type-face) nil
f83d2997
KH
4704 (copy-face 'default 'font-lock-type-face)
4705 (cond
4706 ((eq background 'light)
4707 (set-face-foreground 'font-lock-type-face
4708 (if (x-color-defined-p "seagreen")
4709 "seagreen"
4710 "sea green")))
4711 ((eq background 'dark)
4712 (set-face-foreground 'font-lock-type-face
4713 (if (x-color-defined-p "os2pink")
4714 "os2pink"
4715 "pink")))
4716 (t
4717 (set-face-background 'font-lock-type-face "gray90"))))
5bd52f0e 4718 (if (cperl-is-face 'cperl-nonoverridable-face)
f83d2997 4719 nil
5bd52f0e 4720 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
f83d2997
KH
4721 (cond
4722 ((eq background 'light)
5bd52f0e 4723 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
4724 (if (x-color-defined-p "chartreuse3")
4725 "chartreuse3"
4726 "chartreuse")))
4727 ((eq background 'dark)
5bd52f0e 4728 (set-face-foreground 'cperl-nonoverridable-face
f83d2997
KH
4729 (if (x-color-defined-p "orchid1")
4730 "orchid1"
4731 "orange")))))
5bd52f0e
RS
4732;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
4733;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
4734;;; (cond
4735;;; ((eq background 'light)
4736;;; (set-face-background 'font-lock-other-emphasized-face
4737;;; (if (x-color-defined-p "lightyellow2")
4738;;; "lightyellow2"
4739;;; (if (x-color-defined-p "lightyellow")
4740;;; "lightyellow"
4741;;; "light yellow"))))
4742;;; ((eq background 'dark)
4743;;; (set-face-background 'font-lock-other-emphasized-face
4744;;; (if (x-color-defined-p "navy")
4745;;; "navy"
4746;;; (if (x-color-defined-p "darkgreen")
4747;;; "darkgreen"
4748;;; "dark green"))))
4749;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
4750;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
4751;;; (copy-face 'bold 'font-lock-emphasized-face)
4752;;; (cond
4753;;; ((eq background 'light)
4754;;; (set-face-background 'font-lock-emphasized-face
4755;;; (if (x-color-defined-p "lightyellow2")
4756;;; "lightyellow2"
4757;;; "lightyellow")))
4758;;; ((eq background 'dark)
4759;;; (set-face-background 'font-lock-emphasized-face
4760;;; (if (x-color-defined-p "navy")
4761;;; "navy"
4762;;; (if (x-color-defined-p "darkgreen")
4763;;; "darkgreen"
4764;;; "dark green"))))
4765;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
db133cb6 4766 (if (cperl-is-face 'font-lock-variable-name-face) nil
f83d2997 4767 (copy-face 'italic 'font-lock-variable-name-face))
db133cb6 4768 (if (cperl-is-face 'font-lock-constant-face) nil
883212ce 4769 (copy-face 'italic 'font-lock-constant-face))))
f83d2997 4770 (setq cperl-faces-init t))
5bd52f0e 4771 (error (message "cperl-init-faces (ignored): %s" errs))))
f83d2997
KH
4772
4773
4774(defun cperl-ps-print-init ()
4775 "Initialization of `ps-print' components for faces used in CPerl."
5bd52f0e
RS
4776 (eval-after-load "ps-print"
4777 '(setq ps-bold-faces
5c8b7eaf 4778 ;; font-lock-variable-name-face
5bd52f0e
RS
4779 ;; font-lock-constant-face
4780 (append '(cperl-array-face
5c8b7eaf 4781 cperl-hash-face)
5bd52f0e
RS
4782 ps-bold-faces)
4783 ps-italic-faces
4784 ;; font-lock-constant-face
4785 (append '(cperl-nonoverridable-face
4786 cperl-hash-face)
4787 ps-italic-faces)
4788 ps-underlined-faces
4789 ;; font-lock-type-face
4790 (append '(cperl-array-face
4791 cperl-hash-face
4792 underline
4793 cperl-nonoverridable-face)
4794 ps-underlined-faces))))
4795
4796(defvar ps-print-face-extension-alist)
4797
4798(defun cperl-ps-print (&optional file)
4799 "Pretty-print in CPerl style.
4800If optional argument FILE is an empty string, prints to printer, otherwise
4801to the file FILE. If FILE is nil, prompts for a file name.
4802
4803Style of printout regulated by the variable `cperl-ps-print-face-properties'."
4804 (interactive)
5c8b7eaf
SS
4805 (or file
4806 (setq file (read-from-minibuffer
5bd52f0e
RS
4807 "Print to file (if empty - to printer): "
4808 (concat (buffer-file-name) ".ps")
4809 nil nil 'file-name-history)))
4810 (or (> (length file) 0)
4811 (setq file nil))
4812 (require 'ps-print) ; To get ps-print-face-extension-alist
4813 (let ((ps-print-color-p t)
4814 (ps-print-face-extension-alist ps-print-face-extension-alist))
4815 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
4816 (ps-print-buffer-with-faces file)))
4817
4818;;; (defun cperl-ps-print-init ()
4819;;; "Initialization of `ps-print' components for faces used in CPerl."
4820;;; ;; Guard against old versions
4821;;; (defvar ps-underlined-faces nil)
4822;;; (defvar ps-bold-faces nil)
4823;;; (defvar ps-italic-faces nil)
4824;;; (setq ps-bold-faces
4825;;; (append '(font-lock-emphasized-face
4826;;; cperl-array-face
5c8b7eaf
SS
4827;;; font-lock-keyword-face
4828;;; font-lock-variable-name-face
4829;;; font-lock-constant-face
4830;;; font-lock-reference-face
5bd52f0e 4831;;; font-lock-other-emphasized-face
5c8b7eaf 4832;;; cperl-hash-face)
5bd52f0e
RS
4833;;; ps-bold-faces))
4834;;; (setq ps-italic-faces
4835;;; (append '(cperl-nonoverridable-face
5c8b7eaf
SS
4836;;; font-lock-constant-face
4837;;; font-lock-reference-face
5bd52f0e
RS
4838;;; font-lock-other-emphasized-face
4839;;; cperl-hash-face)
4840;;; ps-italic-faces))
4841;;; (setq ps-underlined-faces
4842;;; (append '(font-lock-emphasized-face
4843;;; cperl-array-face
4844;;; font-lock-other-emphasized-face
4845;;; cperl-hash-face
4846;;; cperl-nonoverridable-face font-lock-type-face)
4847;;; ps-underlined-faces))
4848;;; (cons 'font-lock-type-face ps-underlined-faces))
f83d2997
KH
4849
4850
4851(if (cperl-enable-font-lock) (cperl-windowed-init))
4852
db133cb6 4853(defconst cperl-styles-entries
5c8b7eaf
SS
4854 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
4855 cperl-label-offset cperl-extra-newline-before-brace
bab27c0c 4856 cperl-merge-trailing-else
db133cb6
RS
4857 cperl-continued-statement-offset))
4858
4859(defconst cperl-style-alist
4860 '(("CPerl" ; =GNU without extra-newline-before-brace
4861 (cperl-indent-level . 2)
4862 (cperl-brace-offset . 0)
4863 (cperl-continued-brace-offset . 0)
4864 (cperl-label-offset . -2)
4865 (cperl-extra-newline-before-brace . nil)
bab27c0c 4866 (cperl-merge-trailing-else . t)
db133cb6
RS
4867 (cperl-continued-statement-offset . 2))
4868 ("PerlStyle" ; CPerl with 4 as indent
4869 (cperl-indent-level . 4)
4870 (cperl-brace-offset . 0)
4871 (cperl-continued-brace-offset . 0)
4872 (cperl-label-offset . -4)
4873 (cperl-extra-newline-before-brace . nil)
bab27c0c 4874 (cperl-merge-trailing-else . t)
db133cb6
RS
4875 (cperl-continued-statement-offset . 4))
4876 ("GNU"
4877 (cperl-indent-level . 2)
4878 (cperl-brace-offset . 0)
4879 (cperl-continued-brace-offset . 0)
4880 (cperl-label-offset . -2)
4881 (cperl-extra-newline-before-brace . t)
bab27c0c 4882 (cperl-merge-trailing-else . nil)
db133cb6
RS
4883 (cperl-continued-statement-offset . 2))
4884 ("K&R"
4885 (cperl-indent-level . 5)
4886 (cperl-brace-offset . 0)
4887 (cperl-continued-brace-offset . -5)
4888 (cperl-label-offset . -5)
4889 ;;(cperl-extra-newline-before-brace . nil) ; ???
bab27c0c 4890 (cperl-merge-trailing-else . nil)
db133cb6
RS
4891 (cperl-continued-statement-offset . 5))
4892 ("BSD"
4893 (cperl-indent-level . 4)
4894 (cperl-brace-offset . 0)
4895 (cperl-continued-brace-offset . -4)
4896 (cperl-label-offset . -4)
4897 ;;(cperl-extra-newline-before-brace . nil) ; ???
4898 (cperl-continued-statement-offset . 4))
4899 ("C++"
4900 (cperl-indent-level . 4)
4901 (cperl-brace-offset . 0)
4902 (cperl-continued-brace-offset . -4)
4903 (cperl-label-offset . -4)
4904 (cperl-continued-statement-offset . 4)
bab27c0c 4905 (cperl-merge-trailing-else . nil)
db133cb6
RS
4906 (cperl-extra-newline-before-brace . t))
4907 ("Current")
4908 ("Whitesmith"
4909 (cperl-indent-level . 4)
4910 (cperl-brace-offset . 0)
4911 (cperl-continued-brace-offset . 0)
4912 (cperl-label-offset . -4)
4913 ;;(cperl-extra-newline-before-brace . nil) ; ???
4914 (cperl-continued-statement-offset . 4)))
4915 "(Experimental) list of variables to set to get a particular indentation style.
5bd52f0e 4916Should be used via `cperl-set-style' or via Perl menu.")
db133cb6 4917
f83d2997
KH
4918(defun cperl-set-style (style)
4919 "Set CPerl-mode variables to use one of several different indentation styles.
4920The arguments are a string representing the desired style.
5c8b7eaf 4921The list of styles is in `cperl-style-alist', available styles
db133cb6
RS
4922are GNU, K&R, BSD, C++ and Whitesmith.
4923
4924The current value of style is memorized (unless there is a memorized
4925data already), may be restored by `cperl-set-style-back'.
4926
4927Chosing \"Current\" style will not change style, so this may be used for
4928side-effect of memorizing only."
5c8b7eaf
SS
4929 (interactive
4930 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
db133cb6 4931 cperl-style-alist)))
f83d2997 4932 (list (completing-read "Enter style: " list nil 'insist))))
db133cb6
RS
4933 (or cperl-old-style
4934 (setq cperl-old-style
4935 (mapcar (function
4936 (lambda (name)
4937 (cons name (eval name))))
4938 cperl-styles-entries)))
4939 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
f83d2997
KH
4940 (while style
4941 (setq setting (car style) style (cdr style))
db133cb6
RS
4942 (set (car setting) (cdr setting)))))
4943
4944(defun cperl-set-style-back ()
4945 "Restore a style memorised by `cperl-set-style'."
4946 (interactive)
4947 (or cperl-old-style (error "The style was not changed"))
4948 (let (setting)
4949 (while cperl-old-style
5c8b7eaf 4950 (setq setting (car cperl-old-style)
db133cb6
RS
4951 cperl-old-style (cdr cperl-old-style))
4952 (set (car setting) (cdr setting)))))
f83d2997
KH
4953
4954(defun cperl-check-syntax ()
4955 (interactive)
4956 (require 'mode-compile)
db133cb6
RS
4957 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
4958 (eval '(mode-compile)))) ; Avoid a warning
f83d2997
KH
4959
4960(defun cperl-info-buffer (type)
4961 ;; Returns buffer with documentation. Creates if missing.
4962 ;; If TYPE, this vars buffer.
4963 ;; Special care is taken to not stomp over an existing info buffer
4964 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
4965 (info (get-buffer bname))
4966 (oldbuf (get-buffer "*info*")))
4967 (if info info
4968 (save-window-excursion
4969 ;; Get Info running
4970 (require 'info)
4971 (cond (oldbuf
4972 (set-buffer oldbuf)
4973 (rename-buffer "*info-perl-tmp*")))
4974 (save-window-excursion
4975 (info))
4976 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
4977 (set-buffer "*info*")
4978 (rename-buffer bname)
4979 (cond (oldbuf
4980 (set-buffer "*info-perl-tmp*")
4981 (rename-buffer "*info*")
4982 (set-buffer bname)))
4983 (make-variable-buffer-local 'window-min-height)
4984 (setq window-min-height 2)
4985 (current-buffer)))))
4986
4987(defun cperl-word-at-point (&optional p)
4988 ;; Returns the word at point or at P.
4989 (save-excursion
4990 (if p (goto-char p))
4991 (or (cperl-word-at-point-hard)
4992 (progn
4993 (require 'etags)
4994 (funcall (or (and (boundp 'find-tag-default-function)
4995 find-tag-default-function)
4996 (get major-mode 'find-tag-default-function)
4997 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
4998 ;; automatically used within `find-tag-default':
4999 'find-tag-default))))))
5000
5001(defun cperl-info-on-command (command)
5002 "Shows documentation for Perl command in other window.
5003If perl-info buffer is shown in some frame, uses this frame.
5004Customized by setting variables `cperl-shrink-wrap-info-frame',
5005`cperl-max-help-size'."
5c8b7eaf 5006 (interactive
f83d2997 5007 (let* ((default (cperl-word-at-point))
5c8b7eaf
SS
5008 (read (read-string
5009 (format "Find doc for Perl function (default %s): "
f83d2997 5010 default))))
5c8b7eaf
SS
5011 (list (if (equal read "")
5012 default
f83d2997
KH
5013 read))))
5014
5015 (let ((buffer (current-buffer))
5016 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
5017 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
5018 max-height char-height buf-list)
5019 (if (string-match "^-[a-zA-Z]$" command)
5020 (setq cmd-desc "^-X[ \t\n]"))
5021 (setq isvar (string-match "^[$@%]" command)
5022 buf (cperl-info-buffer isvar)
5023 iniwin (selected-window)
5024 fr1 (window-frame iniwin))
5025 (set-buffer buf)
5026 (beginning-of-buffer)
5c8b7eaf 5027 (or isvar
f83d2997
KH
5028 (progn (re-search-forward "^-X[ \t\n]")
5029 (forward-line -1)))
5030 (if (re-search-forward cmd-desc nil t)
5031 (progn
5032 ;; Go back to beginning of the group (ex, for qq)
5033 (if (re-search-backward "^[ \t\n\f]")
5034 (forward-line 1))
5035 (beginning-of-line)
5c8b7eaf 5036 ;; Get some of
f83d2997
KH
5037 (setq pos (point)
5038 buf-list (list buf "*info-perl-var*" "*info-perl*"))
5039 (while (and (not win) buf-list)
5040 (setq win (get-buffer-window (car buf-list) t))
5041 (setq buf-list (cdr buf-list)))
5042 (or (not win)
5043 (eq (window-buffer win) buf)
5044 (set-window-buffer win buf))
5045 (and win (setq fr2 (window-frame win)))
5046 (if (or (not fr2) (eq fr1 fr2))
5047 (pop-to-buffer buf)
5048 (special-display-popup-frame buf) ; Make it visible
5049 (select-window win))
5050 (goto-char pos) ; Needed (?!).
5051 ;; Resize
5052 (setq iniheight (window-height)
5053 frheight (frame-height)
5054 not-loner (< iniheight (1- frheight))) ; Are not alone
5c8b7eaf 5055 (cond ((if not-loner cperl-max-help-size
f83d2997 5056 cperl-shrink-wrap-info-frame)
5c8b7eaf
SS
5057 (setq height
5058 (+ 2
5059 (count-lines
5060 pos
f83d2997
KH
5061 (save-excursion
5062 (if (re-search-forward
5063 "^[ \t][^\n]*\n+\\([^ \t\n\f]\\|\\'\\)" nil t)
5064 (match-beginning 0) (point-max)))))
5c8b7eaf 5065 max-height
f83d2997
KH
5066 (if not-loner
5067 (/ (* (- frheight 3) cperl-max-help-size) 100)
5068 (setq char-height (frame-char-height))
5069 ;; Non-functioning under OS/2:
5070 (if (eq char-height 1) (setq char-height 18))
5071 ;; Title, menubar, + 2 for slack
5072 (- (/ (x-display-pixel-height) char-height) 4)
5073 ))
5074 (if (> height max-height) (setq height max-height))
5075 ;;(message "was %s doing %s" iniheight height)
5076 (if not-loner
5077 (enlarge-window (- height iniheight))
5078 (set-frame-height (window-frame win) (1+ height)))))
5079 (set-window-start (selected-window) pos))
5080 (message "No entry for %s found." command))
5081 ;;(pop-to-buffer buffer)
5082 (select-window iniwin)))
5083
5084(defun cperl-info-on-current-command ()
5085 "Shows documentation for Perl command at point in other window."
5086 (interactive)
5087 (cperl-info-on-command (cperl-word-at-point)))
5088
5089(defun cperl-imenu-info-imenu-search ()
5090 (if (looking-at "^-X[ \t\n]") nil
5091 (re-search-backward
5092 "^\n\\([-a-zA-Z_]+\\)[ \t\n]")
5093 (forward-line 1)))
5094
5c8b7eaf 5095(defun cperl-imenu-info-imenu-name ()
f83d2997
KH
5096 (buffer-substring
5097 (match-beginning 1) (match-end 1)))
5098
5099(defun cperl-imenu-on-info ()
5100 (interactive)
5101 (let* ((buffer (current-buffer))
5102 imenu-create-index-function
5c8b7eaf
SS
5103 imenu-prev-index-position-function
5104 imenu-extract-index-name-function
f83d2997
KH
5105 (index-item (save-restriction
5106 (save-window-excursion
5107 (set-buffer (cperl-info-buffer nil))
5c8b7eaf 5108 (setq imenu-create-index-function
f83d2997
KH
5109 'imenu-default-create-index-function
5110 imenu-prev-index-position-function
5111 'cperl-imenu-info-imenu-search
5112 imenu-extract-index-name-function
5113 'cperl-imenu-info-imenu-name)
5114 (imenu-choose-buffer-index)))))
5115 (and index-item
5116 (progn
5117 (push-mark)
5118 (pop-to-buffer "*info-perl*")
5119 (cond
5120 ((markerp (cdr index-item))
5121 (goto-char (marker-position (cdr index-item))))
5122 (t
5123 (goto-char (cdr index-item))))
5124 (set-window-start (selected-window) (point))
5125 (pop-to-buffer buffer)))))
5126
5127(defun cperl-lineup (beg end &optional step minshift)
5128 "Lineup construction in a region.
5129Beginning of region should be at the start of a construction.
5130All first occurrences of this construction in the lines that are
5131partially contained in the region are lined up at the same column.
5132
5133MINSHIFT is the minimal amount of space to insert before the construction.
5134STEP is the tabwidth to position constructions.
5c8b7eaf 5135If STEP is `nil', `cperl-lineup-step' will be used
f83d2997
KH
5136\(or `cperl-indent-level', if `cperl-lineup-step' is `nil').
5137Will not move the position at the start to the left."
5138 (interactive "r")
5139 (let (search col tcol seen b e)
5140 (save-excursion
5141 (goto-char end)
5142 (end-of-line)
5143 (setq end (point-marker))
5144 (goto-char beg)
5145 (skip-chars-forward " \t\f")
5146 (setq beg (point-marker))
5147 (indent-region beg end nil)
5148 (goto-char beg)
5149 (setq col (current-column))
5150 (if (looking-at "[a-zA-Z0-9_]")
5151 (if (looking-at "\\<[a-zA-Z0-9_]+\\>")
5152 (setq search
5c8b7eaf
SS
5153 (concat "\\<"
5154 (regexp-quote
f83d2997
KH
5155 (buffer-substring (match-beginning 0)
5156 (match-end 0))) "\\>"))
5157 (error "Cannot line up in a middle of the word"))
5158 (if (looking-at "$")
5159 (error "Cannot line up end of line"))
5160 (setq search (regexp-quote (char-to-string (following-char)))))
5161 (setq step (or step cperl-lineup-step cperl-indent-level))
5162 (or minshift (setq minshift 1))
5163 (while (progn
5164 (beginning-of-line 2)
5c8b7eaf 5165 (and (< (point) end)
f83d2997
KH
5166 (re-search-forward search end t)
5167 (goto-char (match-beginning 0))))
5168 (setq tcol (current-column) seen t)
5169 (if (> tcol col) (setq col tcol)))
5170 (or seen
5171 (error "The construction to line up occurred only once"))
5172 (goto-char beg)
5173 (setq col (+ col minshift))
5174 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
5c8b7eaf 5175 (while
f83d2997
KH
5176 (progn
5177 (setq e (point))
5178 (skip-chars-backward " \t")
5179 (delete-region (point) e)
5180 (indent-to-column col); (make-string (- col (current-column)) ?\ ))
5c8b7eaf
SS
5181 (beginning-of-line 2)
5182 (and (< (point) end)
f83d2997
KH
5183 (re-search-forward search end t)
5184 (goto-char (match-beginning 0)))))))) ; No body
5185
5186(defun cperl-etags (&optional add all files)
5187 "Run etags with appropriate options for Perl files.
5188If optional argument ALL is `recursive', will process Perl files
5189in subdirectories too."
5190 (interactive)
5191 (let ((cmd "etags")
5192 (args '("-l" "none" "-r" "/\\<\\(package\\|sub\\)[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([{#]\\|$\\)\\)/\\4/"))
5193 res)
5194 (if add (setq args (cons "-a" args)))
5195 (or files (setq files (list buffer-file-name)))
5196 (cond
5197 ((eq all 'recursive)
5198 ;;(error "Not implemented: recursive")
5c8b7eaf 5199 (setq args (append (list "-e"
f83d2997
KH
5200 "sub wanted {push @ARGV, $File::Find::name if /\\.[pP][Llm]$/}
5201 use File::Find;
5202 find(\\&wanted, '.');
5c8b7eaf 5203 exec @ARGV;"
f83d2997
KH
5204 cmd) args)
5205 cmd "perl"))
5c8b7eaf 5206 (all
f83d2997 5207 ;;(error "Not implemented: all")
5c8b7eaf 5208 (setq args (append (list "-e"
f83d2997 5209 "push @ARGV, <*.PL *.pl *.pm>;
5c8b7eaf 5210 exec @ARGV;"
f83d2997
KH
5211 cmd) args)
5212 cmd "perl"))
5213 (t
5214 (setq args (append args files))))
5215 (setq res (apply 'call-process cmd nil nil nil args))
5216 (or (eq res 0)
5217 (message "etags returned \"%s\"" res))))
5218
5219(defun cperl-toggle-auto-newline ()
5220 "Toggle the state of `cperl-auto-newline'."
5221 (interactive)
5222 (setq cperl-auto-newline (not cperl-auto-newline))
5c8b7eaf 5223 (message "Newlines will %sbe auto-inserted now."
f83d2997
KH
5224 (if cperl-auto-newline "" "not ")))
5225
5226(defun cperl-toggle-abbrev ()
5227 "Toggle the state of automatic keyword expansion in CPerl mode."
5228 (interactive)
5229 (abbrev-mode (if abbrev-mode 0 1))
5c8b7eaf 5230 (message "Perl control structure will %sbe auto-inserted now."
f83d2997
KH
5231 (if abbrev-mode "" "not ")))
5232
5233
5234(defun cperl-toggle-electric ()
5235 "Toggle the state of parentheses doubling in CPerl mode."
5236 (interactive)
5237 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
5c8b7eaf 5238 (message "Parentheses will %sbe auto-doubled now."
f83d2997
KH
5239 (if (cperl-val 'cperl-electric-parens) "" "not ")))
5240
db133cb6
RS
5241(defun cperl-toggle-autohelp ()
5242 "Toggle the state of automatic help message in CPerl mode.
5243See `cperl-lazy-help-time' too."
5244 (interactive)
5245 (if (fboundp 'run-with-idle-timer)
5246 (progn
5247 (if cperl-lazy-installed
5248 (eval '(cperl-lazy-unstall))
5249 (cperl-lazy-install))
5c8b7eaf 5250 (message "Perl help messages will %sbe automatically shown now."
db133cb6
RS
5251 (if cperl-lazy-installed "" "not ")))
5252 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
5253
5254(defun cperl-toggle-construct-fix ()
5255 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
5256 (interactive)
5c8b7eaf 5257 (setq cperl-indent-region-fix-constructs
5bd52f0e
RS
5258 (if cperl-indent-region-fix-constructs
5259 nil
5260 1))
5c8b7eaf 5261 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
db133cb6
RS
5262 (if cperl-indent-region-fix-constructs "" "not ")))
5263
f83d2997
KH
5264;;;; Tags file creation.
5265
5266(defvar cperl-tmp-buffer " *cperl-tmp*")
5267
5268(defun cperl-setup-tmp-buf ()
5269 (set-buffer (get-buffer-create cperl-tmp-buffer))
5270 (set-syntax-table cperl-mode-syntax-table)
5271 (buffer-disable-undo)
5272 (auto-fill-mode 0)
5273 (if cperl-use-syntax-table-text-property-for-tags
5274 (progn
5275 (make-variable-buffer-local 'parse-sexp-lookup-properties)
5276 ;; Do not introduce variable if not needed, we check it!
5277 (set 'parse-sexp-lookup-properties t))))
5278
5279(defun cperl-xsub-scan ()
f83d2997 5280 (require 'imenu)
5c8b7eaf 5281 (let ((index-alist '())
f83d2997
KH
5282 (prev-pos 0) index index1 name package prefix)
5283 (goto-char (point-min))
5284 (if noninteractive
5285 (message "Scanning XSUB for index")
5286 (imenu-progress-message prev-pos 0))
5287 ;; Search for the function
5288 (progn ;;save-match-data
5289 (while (re-search-forward
5290 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5291 nil t)
5292 (or noninteractive
5293 (imenu-progress-message prev-pos))
5294 (cond
5295 ((match-beginning 2) ; SECTION
5296 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
5297 (goto-char (match-beginning 0))
5298 (skip-chars-forward " \t")
5299 (forward-char 1)
5300 (if (looking-at "[^\n]*\\<PREFIX[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9]*\\)\\>")
5301 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
5302 (setq prefix nil)))
5303 ((not package) nil) ; C language section
5304 ((match-beginning 3) ; XSUB
5305 (goto-char (1+ (match-beginning 3)))
5306 (setq index (imenu-example--name-and-position))
5307 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
5308 (if (and prefix (string-match (concat "^" prefix) name))
5309 (setq name (substring name (length prefix))))
5310 (cond ((string-match "::" name) nil)
5311 (t
5312 (setq index1 (cons (concat package "::" name) (cdr index)))
5313 (push index1 index-alist)))
5314 (setcar index name)
5315 (push index index-alist))
5316 (t ; BOOT: section
5317 ;; (beginning-of-line)
5318 (setq index (imenu-example--name-and-position))
5319 (setcar index (concat package "::BOOT:"))
5320 (push index index-alist)))))
5321 (or noninteractive
5322 (imenu-progress-message prev-pos 100))
f83d2997
KH
5323 index-alist))
5324
5325(defun cperl-find-tags (file xs topdir)
5326 (let (ind (b (get-buffer cperl-tmp-buffer)) lst elt pos ret rel
5327 (cperl-pod-here-fontify nil))
5328 (save-excursion
5329 (if b (set-buffer b)
5330 (cperl-setup-tmp-buf))
5331 (erase-buffer)
5332 (setq file (car (insert-file-contents file)))
5333 (message "Scanning file %s ..." file)
5334 (if (and cperl-use-syntax-table-text-property-for-tags
5335 (not xs))
5336 (condition-case err ; after __END__ may have garbage
5337 (cperl-find-pods-heres)
5338 (error (message "While scanning for syntax: %s" err))))
5339 (if xs
5340 (setq lst (cperl-xsub-scan))
80585273 5341 (setq ind (cperl-imenu--create-perl-index))
f83d2997 5342 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
5c8b7eaf
SS
5343 (setq lst
5344 (mapcar
5345 (function
f83d2997
KH
5346 (lambda (elt)
5347 (cond ((string-match "^[_a-zA-Z]" (car elt))
5348 (goto-char (cdr elt))
5bd52f0e 5349 (beginning-of-line) ; pos should be of the start of the line
5c8b7eaf
SS
5350 (list (car elt)
5351 (point)
5bd52f0e 5352 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
f83d2997 5353 (buffer-substring (progn
5c8b7eaf 5354 (skip-chars-forward
f83d2997
KH
5355 ":_a-zA-Z0-9")
5356 (or (eolp) (forward-char 1))
5357 (point))
5358 (progn
5359 (beginning-of-line)
5360 (point))))))))
5361 lst))
5362 (erase-buffer)
5363 (while lst
5364 (setq elt (car lst) lst (cdr lst))
5365 (if elt
5366 (progn
5c8b7eaf 5367 (insert (elt elt 3)
f83d2997
KH
5368 127
5369 (if (string-match "^package " (car elt))
5370 (substring (car elt) 8)
5371 (car elt) )
5372 1
5bd52f0e 5373 (number-to-string (elt elt 2)) ; Line
f83d2997 5374 ","
5bd52f0e 5375 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
f83d2997
KH
5376 "\n")
5377 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
5378 (string-match "^sub[ \t]+\\([_a-zA-Z]+\\)[^:_a-zA-Z]"
5379 (elt elt 3)))
5380 ;; Need to insert the name without package as well
5c8b7eaf 5381 (setq lst (cons (cons (substring (elt elt 3)
f83d2997
KH
5382 (match-beginning 1)
5383 (match-end 1))
5384 (cdr elt))
5385 lst))))))
5386 (setq pos (point))
5387 (goto-char 1)
5388 (setq rel file)
5389 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5390 (set-text-properties 0 (length rel) nil rel)
5391 (and (equal topdir (substring rel 0 (length topdir)))
5392 (setq rel (substring file (length topdir))))
5393 (insert "\f\n" rel "," (number-to-string (1- pos)) "\n")
5394 (setq ret (buffer-substring 1 (point-max)))
5395 (erase-buffer)
5396 (or noninteractive
5397 (message "Scanning file %s finished" file))
5398 ret)))
5399
5400(defun cperl-add-tags-recurse-noxs ()
5401 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5402Use as
5403 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5c8b7eaf 5404 -f cperl-add-tags-recurse
f83d2997
KH
5405"
5406 (cperl-write-tags nil nil t t nil t))
5407
5408(defun cperl-add-tags-recurse ()
5409 "Add to TAGS file data for Perl files in the current directory and kids.
5410Use as
5411 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5c8b7eaf 5412 -f cperl-add-tags-recurse
f83d2997
KH
5413"
5414 (cperl-write-tags nil nil t t))
5415
5416(defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
5417 ;; If INBUFFER, do not select buffer, and do not save
5418 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5419 (require 'etags)
5420 (if file nil
5421 (setq file (if dir default-directory (buffer-file-name)))
5422 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
5423 (or topdir
5424 (setq topdir default-directory))
5425 (let ((tags-file-name "TAGS")
5426 (case-fold-search (eq system-type 'emx))
5bd52f0e 5427 xs rel)
f83d2997
KH
5428 (save-excursion
5429 (cond (inbuffer nil) ; Already there
5430 ((file-exists-p tags-file-name)
5bd52f0e
RS
5431 (if cperl-xemacs-p
5432 (visit-tags-table-buffer)
5433 (visit-tags-table-buffer tags-file-name)))
f83d2997
KH
5434 (t (set-buffer (find-file-noselect tags-file-name))))
5435 (cond
5436 (dir
5437 (cond ((eq erase 'ignore))
5438 (erase
5439 (erase-buffer)
5440 (setq erase 'ignore)))
5c8b7eaf
SS
5441 (let ((files
5442 (directory-files file t
f83d2997
KH
5443 (if recurse nil cperl-scan-files-regexp)
5444 t)))
5445 (mapcar (function (lambda (file)
5446 (cond
5447 ((string-match cperl-noscan-files-regexp file)
5448 nil)
5449 ((not (file-directory-p file))
5450 (if (string-match cperl-scan-files-regexp file)
5451 (cperl-write-tags file erase recurse nil t noxs topdir)))
5452 ((not recurse) nil)
5453 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
5454 files))
5455 )
5456 (t
5457 (setq xs (string-match "\\.xs$" file))
5458 (if (not (and xs noxs))
5459 (progn
5460 (cond ((eq erase 'ignore) (goto-char (point-max)))
5461 (erase (erase-buffer))
5462 (t
5463 (goto-char 1)
5bd52f0e
RS
5464 (setq rel file)
5465 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5466 (set-text-properties 0 (length rel) nil rel)
5467 (and (equal topdir (substring rel 0 (length topdir)))
5468 (setq rel (substring file (length topdir))))
5469 (if (search-forward (concat "\f\n" rel ",") nil t)
f83d2997
KH
5470 (progn
5471 (search-backward "\f\n")
5472 (delete-region (point)
5473 (save-excursion
5474 (forward-char 1)
5c8b7eaf 5475 (if (search-forward "\f\n"
f83d2997
KH
5476 nil 'toend)
5477 (- (point) 2)
5478 (point-max)))))
5479 (goto-char (point-max)))))
5480 (insert (cperl-find-tags file xs topdir))))))
5481 (if inbuffer nil ; Delegate to the caller
5482 (save-buffer 0) ; No backup
5483 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
5484 (initialize-new-tags-table))))))
5485
5486(defvar cperl-tags-hier-regexp-list
5c8b7eaf 5487 (concat
f83d2997
KH
5488 "^\\("
5489 "\\(package\\)\\>"
5490 "\\|"
5491 "sub\\>[^\n]+::"
5492 "\\|"
5493 "[a-zA-Z_][a-zA-Z_0-9:]*(\C-?[^\n]+::" ; XSUB?
5494 "\\|"
5495 "[ \t]*BOOT:\C-?[^\n]+::" ; BOOT section
5496 "\\)"))
5497
5498(defvar cperl-hierarchy '(() ())
5499 "Global hierarchy of classes")
5500
5501(defun cperl-tags-hier-fill ()
5502 ;; Suppose we are in a tag table cooked by cperl.
5503 (goto-char 1)
5504 (let (type pack name pos line chunk ord cons1 file str info fileind)
5505 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
5c8b7eaf 5506 (setq pos (match-beginning 0)
f83d2997
KH
5507 pack (match-beginning 2))
5508 (beginning-of-line)
5509 (if (looking-at (concat
5510 "\\([^\n]+\\)"
5511 "\C-?"
5512 "\\([^\n]+\\)"
5513 "\C-a"
5514 "\\([0-9]+\\)"
5515 ","
5516 "\\([0-9]+\\)"))
5517 (progn
5518 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
5519 name (buffer-substring (match-beginning 2) (match-end 2))
5520 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5bd52f0e 5521 line (buffer-substring (match-beginning 3) (match-end 3))
f83d2997 5522 ord (if pack 1 0)
f83d2997 5523 file (file-of-tag)
5bd52f0e
RS
5524 fileind (format "%s:%s" file line)
5525 ;; Moves to beginning of the next line:
5526 info (cperl-etags-snarf-tag file line))
f83d2997
KH
5527 ;; Move back
5528 (forward-char -1)
5529 ;; Make new member of hierarchy name ==> file ==> pos if needed
5530 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
5531 ;; Name known
5532 (setcdr cons1 (cons (cons fileind (vector file info))
5533 (cdr cons1)))
5534 ;; First occurrence of the name, start alist
5535 (setq cons1 (cons name (list (cons fileind (vector file info)))))
5c8b7eaf 5536 (if pack
f83d2997
KH
5537 (setcar (cdr cperl-hierarchy)
5538 (cons cons1 (nth 1 cperl-hierarchy)))
5539 (setcar cperl-hierarchy
5540 (cons cons1 (car cperl-hierarchy)))))))
5541 (end-of-line))))
5542
5543(defun cperl-tags-hier-init (&optional update)
5544 "Show hierarchical menu of classes and methods.
5545Finds info about classes by a scan of loaded TAGS files.
5546Supposes that the TAGS files contain fully qualified function names.
5547One may build such TAGS files from CPerl mode menu."
5548 (interactive)
5549 (require 'etags)
5550 (require 'imenu)
5551 (if (or update (null (nth 2 cperl-hierarchy)))
5bd52f0e 5552 (let (pack name cons1 to l1 l2 l3 l4 b
f83d2997
KH
5553 (remover (function (lambda (elt) ; (name (file1...) (file2..))
5554 (or (nthcdr 2 elt)
5555 ;; Only in one file
5556 (setcdr elt (cdr (nth 1 elt))))))))
5557 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5558 (setq cperl-hierarchy (list l1 l2 l3))
5bd52f0e
RS
5559 (if cperl-xemacs-p ; Not checked
5560 (progn
5561 (or tags-file-name
5562 ;; Does this work in XEmacs?
f83d2997
KH
5563 (call-interactively 'visit-tags-table))
5564 (message "Updating list of classes...")
5bd52f0e
RS
5565 (set-buffer (get-file-buffer tags-file-name))
5566 (cperl-tags-hier-fill))
5567 (or tags-table-list
5568 (call-interactively 'visit-tags-table))
5c8b7eaf 5569 (mapcar
f83d2997
KH
5570 (function
5571 (lambda (tagsfile)
5bd52f0e 5572 (message "Updating list of classes... %s" tagsfile)
f83d2997
KH
5573 (set-buffer (get-file-buffer tagsfile))
5574 (cperl-tags-hier-fill)))
5575 tags-table-list)
5bd52f0e 5576 (message "Updating list of classes... postprocessing..."))
f83d2997
KH
5577 (mapcar remover (car cperl-hierarchy))
5578 (mapcar remover (nth 1 cperl-hierarchy))
5579 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
5580 (cons "Methods: " (car cperl-hierarchy))))
5581 (cperl-tags-treeify to 1)
5582 (setcar (nthcdr 2 cperl-hierarchy)
5583 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
5584 (message "Updating list of classes: done, requesting display...")
5585 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5586 ))
5587 (or (nth 2 cperl-hierarchy)
5588 (error "No items found"))
5589 (setq update
5590;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
5591 (if window-system
5592 (x-popup-menu t (nth 2 cperl-hierarchy))
5593 (require 'tmm)
5594 (tmm-prompt (nth 2 cperl-hierarchy))))
5595 (if (and update (listp update))
5596 (progn (while (cdr update) (setq update (cdr update)))
5597 (setq update (car update)))) ; Get the last from the list
5c8b7eaf 5598 (if (vectorp update)
f83d2997
KH
5599 (progn
5600 (find-file (elt update 0))
5bd52f0e 5601 (cperl-etags-goto-tag-location (elt update 1))))
f83d2997
KH
5602 (if (eq update -999) (cperl-tags-hier-init t)))
5603
5604(defun cperl-tags-treeify (to level)
5605 ;; cadr of `to' is read-write. On start it is a cons
5c8b7eaf 5606 (let* ((regexp (concat "^\\(" (mapconcat
f83d2997
KH
5607 'identity
5608 (make-list level "[_a-zA-Z0-9]+")
5609 "::")
5610 "\\)\\(::\\)?"))
5611 (packages (cdr (nth 1 to)))
5612 (methods (cdr (nth 2 to)))
5613 l1 head tail cons1 cons2 ord writeto packs recurse
5614 root-packages root-functions ms many_ms same_name ps
5615 (move-deeper
5c8b7eaf 5616 (function
f83d2997
KH
5617 (lambda (elt)
5618 (cond ((and (string-match regexp (car elt))
5619 (or (eq ord 1) (match-end 2)))
5620 (setq head (substring (car elt) 0 (match-end 1))
5c8b7eaf 5621 tail (if (match-end 2) (substring (car elt)
f83d2997
KH
5622 (match-end 2)))
5623 recurse t)
5624 (if (setq cons1 (assoc head writeto)) nil
5625 ;; Need to init new head
5626 (setcdr writeto (cons (list head (list "Packages: ")
5627 (list "Methods: "))
5628 (cdr writeto)))
5629 (setq cons1 (nth 1 writeto)))
5630 (setq cons2 (nth ord cons1)) ; Either packs or meths
5631 (setcdr cons2 (cons elt (cdr cons2))))
5632 ((eq ord 2)
5633 (setq root-functions (cons elt root-functions)))
5634 (t
5635 (setq root-packages (cons elt root-packages))))))))
5636 (setcdr to l1) ; Init to dynamic space
5637 (setq writeto to)
5638 (setq ord 1)
5639 (mapcar move-deeper packages)
5640 (setq ord 2)
5641 (mapcar move-deeper methods)
5642 (if recurse
5643 (mapcar (function (lambda (elt)
5644 (cperl-tags-treeify elt (1+ level))))
5645 (cdr to)))
5646 ;;Now clean up leaders with one child only
5647 (mapcar (function (lambda (elt)
5c8b7eaf 5648 (if (not (and (listp (cdr elt))
f83d2997
KH
5649 (eq (length elt) 2))) nil
5650 (setcar elt (car (nth 1 elt)))
5651 (setcdr elt (cdr (nth 1 elt))))))
5652 (cdr to))
5653 ;; Sort the roots of subtrees
5654 (if (default-value 'imenu-sort-function)
5655 (setcdr to
5656 (sort (cdr to) (default-value 'imenu-sort-function))))
5657 ;; Now add back functions removed from display
5658 (mapcar (function (lambda (elt)
5659 (setcdr to (cons elt (cdr to)))))
5660 (if (default-value 'imenu-sort-function)
5661 (nreverse
5662 (sort root-functions (default-value 'imenu-sort-function)))
5663 root-functions))
5664 ;; Now add back packages removed from display
5665 (mapcar (function (lambda (elt)
5c8b7eaf
SS
5666 (setcdr to (cons (cons (concat "package " (car elt))
5667 (cdr elt))
f83d2997
KH
5668 (cdr to)))))
5669 (if (default-value 'imenu-sort-function)
5c8b7eaf 5670 (nreverse
f83d2997
KH
5671 (sort root-packages (default-value 'imenu-sort-function)))
5672 root-packages))
5673 ))
5674
5675;;;(x-popup-menu t
5c8b7eaf 5676;;; '(keymap "Name1"
f83d2997 5677;;; ("Ret1" "aa")
5c8b7eaf
SS
5678;;; ("Head1" "ab"
5679;;; keymap "Name2"
f83d2997
KH
5680;;; ("Tail1" "x") ("Tail2" "y"))))
5681
5682(defun cperl-list-fold (list name limit)
5683 (let (list1 list2 elt1 (num 0))
5684 (if (<= (length list) limit) list
5685 (setq list1 nil list2 nil)
5686 (while list
5c8b7eaf 5687 (setq num (1+ num)
f83d2997
KH
5688 elt1 (car list)
5689 list (cdr list))
5690 (if (<= num imenu-max-items)
5691 (setq list2 (cons elt1 list2))
5692 (setq list1 (cons (cons name
5693 (nreverse list2))
5694 list1)
5695 list2 (list elt1)
5696 num 1)))
5697 (nreverse (cons (cons name
5698 (nreverse list2))
5699 list1)))))
5700
5701(defun cperl-menu-to-keymap (menu &optional name)
5702 (let (list)
5c8b7eaf
SS
5703 (cons 'keymap
5704 (mapcar
5705 (function
f83d2997
KH
5706 (lambda (elt)
5707 (cond ((listp (cdr elt))
5708 (setq list (cperl-list-fold
5709 (cdr elt) (car elt) imenu-max-items))
5710 (cons nil
5711 (cons (car elt)
5712 (cperl-menu-to-keymap list))))
5713 (t
5714 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
5715 (cperl-list-fold menu "Root" imenu-max-items)))))
5716
5717\f
5718(defvar cperl-bad-style-regexp
5719 (mapconcat 'identity
5720 '("[^-\n\t <>=+!.&|(*/'`\"#^][-=+<>!|&^]" ; char sign
5721 "[-<>=+^&|]+[^- \t\n=+<>~]" ; sign+ char
5722 )
5723 "\\|")
5724 "Finds places such that insertion of a whitespace may help a lot.")
5725
5c8b7eaf 5726(defvar cperl-not-bad-style-regexp
f83d2997
KH
5727 (mapconcat 'identity
5728 '("[^-\t <>=+]\\(--\\|\\+\\+\\)" ; var-- var++
5729 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
5730 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
5731 "<\\$?\\sw+\\(\\.\\sw+\\)?>" ; <IN> <stdin.h>
5bd52f0e 5732 "-[a-zA-Z][ \t]+[_$\"'`a-zA-Z]" ; -f file, -t STDIN
f83d2997
KH
5733 "-[0-9]" ; -5
5734 "\\+\\+" ; ++var
5735 "--" ; --var
5736 ".->" ; a->b
5737 "->" ; a SPACE ->b
5738 "\\[-" ; a[-1]
5bd52f0e 5739 "\\\\[&$@*\\\\]" ; \&func
f83d2997 5740 "^=" ; =head
5bd52f0e
RS
5741 "\\$." ; $|
5742 "<<[a-zA-Z_'\"`]" ; <<FOO, <<'FOO'
f83d2997
KH
5743 "||"
5744 "&&"
5745 "[CBIXSLFZ]<\\(\\sw\\|\\s \\|\\s_\\|[\n]\\)*>" ; C<code like text>
5746 "-[a-zA-Z_0-9]+[ \t]*=>" ; -option => value
5747 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
5748 ;;"[*/+-|&<.]+="
5749 )
5750 "\\|")
5751 "If matches at the start of match found by `my-bad-c-style-regexp',
5752insertion of a whitespace will not help.")
5753
5754(defvar found-bad)
5755
5756(defun cperl-find-bad-style ()
5757 "Find places in the buffer where insertion of a whitespace may help.
5758Prompts user for insertion of spaces.
5759Currently it is tuned to C and Perl syntax."
5760 (interactive)
5761 (let (found-bad (p (point)))
5762 (setq last-nonmenu-event 13) ; To disable popup
5763 (beginning-of-buffer)
5764 (map-y-or-n-p "Insert space here? "
5765 (function (lambda (arg) (insert " ")))
5766 'cperl-next-bad-style
5c8b7eaf 5767 '("location" "locations" "insert a space into")
f83d2997
KH
5768 '((?\C-r (lambda (arg)
5769 (let ((buffer-quit-function
5770 'exit-recursive-edit))
5771 (message "Exit with Esc Esc")
5772 (recursive-edit)
5773 t)) ; Consider acted upon
5c8b7eaf 5774 "edit, exit with Esc Esc")
f83d2997
KH
5775 (?e (lambda (arg)
5776 (let ((buffer-quit-function
5777 'exit-recursive-edit))
5778 (message "Exit with Esc Esc")
5779 (recursive-edit)
5780 t)) ; Consider acted upon
5781 "edit, exit with Esc Esc"))
5782 t)
5783 (if found-bad (goto-char found-bad)
5784 (goto-char p)
5785 (message "No appropriate place found"))))
5786
5787(defun cperl-next-bad-style ()
5788 (let (p (not-found t) (point (point)) found)
5789 (while (and not-found
5790 (re-search-forward cperl-bad-style-regexp nil 'to-end))
5791 (setq p (point))
5792 (goto-char (match-beginning 0))
5793 (if (or
5794 (looking-at cperl-not-bad-style-regexp)
5795 ;; Check for a < -b and friends
5796 (and (eq (following-char) ?\-)
5797 (save-excursion
5798 (skip-chars-backward " \t\n")
5799 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\(, ?\[, ?\{))))
5800 ;; Now check for syntax type
5801 (save-match-data
5802 (setq found (point))
5803 (beginning-of-defun)
5804 (let ((pps (parse-partial-sexp (point) found)))
5805 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
5806 (goto-char (match-end 0))
5807 (goto-char (1- p))
5808 (setq not-found nil
5809 found-bad found)))
5810 (not not-found)))
5811
f1d851ae 5812\f
f83d2997 5813;;; Getting help
5c8b7eaf 5814(defvar cperl-have-help-regexp
f83d2997
KH
5815 ;;(concat "\\("
5816 (mapconcat
5817 'identity
5818 '("[$@%*&][0-9a-zA-Z_:]+\\([ \t]*[[{]\\)?" ; Usual variable
5819 "[$@]\\^[a-zA-Z]" ; Special variable
5820 "[$@][^ \n\t]" ; Special variable
5821 "-[a-zA-Z]" ; File test
5822 "\\\\[a-zA-Z0]" ; Special chars
5823 "^=[a-z][a-zA-Z0-9_]*" ; Pod sections
5824 "[-!&*+,-./<=>?\\\\^|~]+" ; Operator
5825 "[a-zA-Z_0-9:]+" ; symbol or number
5826 "x="
5827 "#!"
5828 )
5829 ;;"\\)\\|\\("
5830 "\\|"
5831 )
5832 ;;"\\)"
5833 ;;)
5834 "Matches places in the buffer we can find help for.")
5835
5836(defvar cperl-message-on-help-error t)
5837(defvar cperl-help-from-timer nil)
5838
5839(defun cperl-word-at-point-hard ()
5840 ;; Does not save-excursion
5841 ;; Get to the something meaningful
5842 (or (eobp) (eolp) (forward-char 1))
5c8b7eaf 5843 (re-search-backward "[-a-zA-Z0-9_:!&*+,-./<=>?\\\\^|~$%@]"
f83d2997
KH
5844 (save-excursion (beginning-of-line) (point))
5845 'to-beg)
5846 ;; (cond
5847 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
5848 ;; (skip-chars-backward " \n\t\r({[]});,")
5849 ;; (or (bobp) (backward-char 1))))
5850 ;; Try to backtrace
5851 (cond
5852 ((looking-at "[a-zA-Z0-9_:]") ; symbol
5853 (skip-chars-backward "a-zA-Z0-9_:")
5c8b7eaf 5854 (cond
f83d2997
KH
5855 ((and (eq (preceding-char) ?^) ; $^I
5856 (eq (char-after (- (point) 2)) ?\$))
5857 (forward-char -2))
5858 ((memq (preceding-char) (append "*$@%&\\" nil)) ; *glob
5859 (forward-char -1))
5860 ((and (eq (preceding-char) ?\=)
5861 (eq (current-column) 1))
5862 (forward-char -1))) ; =head1
5863 (if (and (eq (preceding-char) ?\<)
5864 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <FH>
5865 (forward-char -1)))
5866 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
5867 (forward-char -1))
5868 ((and (looking-at "\\^") (eq (preceding-char) ?\$)) ; $^I
5869 (forward-char -1))
5870 ((looking-at "[-!&*+,-./<=>?\\\\^|~]")
5871 (skip-chars-backward "-!&*+,-./<=>?\\\\^|~")
5872 (cond
5873 ((and (eq (preceding-char) ?\$)
5874 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
5875 (forward-char -1))
5876 ((and (eq (following-char) ?\>)
5877 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
5878 (save-excursion
5879 (forward-sexp -1)
5880 (and (eq (preceding-char) ?\<)
5881 (looking-at "\\$?[a-zA-Z0-9_:]+>")))) ; <FH>
5882 (search-backward "<"))))
5883 ((and (eq (following-char) ?\$)
5884 (eq (preceding-char) ?\<)
5885 (looking-at "\\$?[a-zA-Z0-9_:]+>")) ; <$fh>
5886 (forward-char -1)))
5887 (if (looking-at cperl-have-help-regexp)
5888 (buffer-substring (match-beginning 0) (match-end 0))))
5889
5890(defun cperl-get-help ()
5891 "Get one-line docs on the symbol at the point.
5892The data for these docs is a little bit obsolete and may be in fact longer
5893than a line. Your contribution to update/shorten it is appreciated."
5894 (interactive)
5895 (save-match-data ; May be called "inside" query-replace
5896 (save-excursion
5897 (let ((word (cperl-word-at-point-hard)))
5898 (if word
5899 (if (and cperl-help-from-timer ; Bail out if not in mainland
5900 (not (string-match "^#!\\|\\\\\\|^=" word)) ; Show help even in comments/strings.
5901 (or (memq (get-text-property (point) 'face)
5902 '(font-lock-comment-face font-lock-string-face))
5903 (memq (get-text-property (point) 'syntax-type)
5904 '(pod here-doc format))))
5905 nil
5906 (cperl-describe-perl-symbol word))
5907 (if cperl-message-on-help-error
5c8b7eaf 5908 (message "Nothing found for %s..."
f83d2997
KH
5909 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
5910
5911;;; Stolen from perl-descr.el by Johan Vromans:
5912
5913(defvar cperl-doc-buffer " *perl-doc*"
5914 "Where the documentation can be found.")
5915
5916(defun cperl-describe-perl-symbol (val)
5917 "Display the documentation of symbol at point, a Perl operator."
5918 (let ((enable-recursive-minibuffers t)
5919 args-file regexp)
5920 (cond
5921 ((string-match "^[&*][a-zA-Z_]" val)
5922 (setq val (concat (substring val 0 1) "NAME")))
5923 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*\\[" val)
5924 (setq val (concat "@" (substring val 1 (match-end 1)))))
5925 ((string-match "^[$@]\\([a-zA-Z_:0-9]+\\)[ \t]*{" val)
5926 (setq val (concat "%" (substring val 1 (match-end 1)))))
5927 ((and (string= val "x") (string-match "^x=" val))
5928 (setq val "x="))
5929 ((string-match "^\\$[\C-a-\C-z]" val)
5930 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
5931 ((string-match "^CORE::" val)
5932 (setq val "CORE::"))
5933 ((string-match "^SUPER::" val)
5934 (setq val "SUPER::"))
5935 ((and (string= "<" val) (string-match "^<\\$?[a-zA-Z0-9_:]+>" val))
5936 (setq val "<NAME>")))
5c8b7eaf 5937 (setq regexp (concat "^"
f83d2997 5938 "\\([^a-zA-Z0-9_:]+[ \t]+\\)?"
5c8b7eaf 5939 (regexp-quote val)
f83d2997
KH
5940 "\\([ \t([/]\\|$\\)"))
5941
5942 ;; get the buffer with the documentation text
5943 (cperl-switch-to-doc-buffer)
5944
5945 ;; lookup in the doc
5946 (goto-char (point-min))
5947 (let ((case-fold-search nil))
5c8b7eaf 5948 (list
f83d2997
KH
5949 (if (re-search-forward regexp (point-max) t)
5950 (save-excursion
5951 (beginning-of-line 1)
5952 (let ((lnstart (point)))
5953 (end-of-line)
5954 (message "%s" (buffer-substring lnstart (point)))))
5955 (if cperl-message-on-help-error
5956 (message "No definition for %s" val)))))))
5957
5958(defvar cperl-short-docs "Ignore my value"
5959 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
5960 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
5c8b7eaf 5961! ... Logical negation.
f83d2997
KH
5962... != ... Numeric inequality.
5963... !~ ... Search pattern, substitution, or translation (negated).
5964$! In numeric context: errno. In a string context: error string.
5965$\" The separator which joins elements of arrays interpolated in strings.
5966$# The output format for printed numbers. Initial value is %.15g or close.
5967$$ Process number of this script. Changes in the fork()ed child process.
5968$% The current page number of the currently selected output channel.
5969
5970 The following variables are always local to the current block:
5971
5972$1 Match of the 1st set of parentheses in the last match (auto-local).
5973$2 Match of the 2nd set of parentheses in the last match (auto-local).
5974$3 Match of the 3rd set of parentheses in the last match (auto-local).
5975$4 Match of the 4th set of parentheses in the last match (auto-local).
5976$5 Match of the 5th set of parentheses in the last match (auto-local).
5977$6 Match of the 6th set of parentheses in the last match (auto-local).
5978$7 Match of the 7th set of parentheses in the last match (auto-local).
5979$8 Match of the 8th set of parentheses in the last match (auto-local).
5980$9 Match of the 9th set of parentheses in the last match (auto-local).
5981$& The string matched by the last pattern match (auto-local).
5982$' The string after what was matched by the last match (auto-local).
5983$` The string before what was matched by the last match (auto-local).
5984
5985$( The real gid of this process.
5986$) The effective gid of this process.
5987$* Deprecated: Set to 1 to do multiline matching within a string.
5988$+ The last bracket matched by the last search pattern.
5989$, The output field separator for the print operator.
5990$- The number of lines left on the page.
5991$. The current input line number of the last filehandle that was read.
5992$/ The input record separator, newline by default.
5993$0 Name of the file containing the perl script being executed. May be set.
5994$: String may be broken after these characters to fill ^-lines in a format.
5995$; Subscript separator for multi-dim array emulation. Default \"\\034\".
5996$< The real uid of this process.
5997$= The page length of the current output channel. Default is 60 lines.
5998$> The effective uid of this process.
5999$? The status returned by the last ``, pipe close or `system'.
6000$@ The perl error message from the last eval or do @var{EXPR} command.
6001$ARGV The name of the current file used with <> .
6002$[ Deprecated: The index of the first element/char in an array/string.
6003$\\ The output record separator for the print operator.
6004$] The perl version string as displayed with perl -v.
6005$^ The name of the current top-of-page format.
6006$^A The current value of the write() accumulator for format() lines.
6007$^D The value of the perl debug (-D) flags.
6008$^E Information about the last system error other than that provided by $!.
6009$^F The highest system file descriptor, ordinarily 2.
6010$^H The current set of syntax checks enabled by `use strict'.
6011$^I The value of the in-place edit extension (perl -i option).
6012$^L What formats output to perform a formfeed. Default is \f.
5bd52f0e 6013$^M A buffer for emergency memory allocation when running out of memory.
f83d2997
KH
6014$^O The operating system name under which this copy of Perl was built.
6015$^P Internal debugging flag.
6016$^T The time the script was started. Used by -A/-M/-C file tests.
6017$^W True if warnings are requested (perl -w flag).
6018$^X The name under which perl was invoked (argv[0] in C-speech).
6019$_ The default input and pattern-searching space.
5c8b7eaf 6020$| Auto-flush after write/print on current output channel? Default 0.
f83d2997
KH
6021$~ The name of the current report format.
6022... % ... Modulo division.
6023... %= ... Modulo division assignment.
6024%ENV Contains the current environment.
6025%INC List of files that have been require-d or do-ne.
6026%SIG Used to set signal handlers for various signals.
6027... & ... Bitwise and.
6028... && ... Logical and.
6029... &&= ... Logical and assignment.
6030... &= ... Bitwise and assignment.
6031... * ... Multiplication.
6032... ** ... Exponentiation.
6033*NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6034&NAME(arg0, ...) Subroutine call. Arguments go to @_.
6035... + ... Addition. +EXPR Makes EXPR into scalar context.
6036++ Auto-increment (magical on strings). ++EXPR EXPR++
6037... += ... Addition assignment.
6038, Comma operator.
6039... - ... Subtraction.
6040-- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6041... -= ... Subtraction assignment.
6042-A Access time in days since script started.
6043-B File is a non-text (binary) file.
6044-C Inode change time in days since script started.
6045-M Age in days since script started.
6046-O File is owned by real uid.
6047-R File is readable by real uid.
6048-S File is a socket .
6049-T File is a text file.
6050-W File is writable by real uid.
6051-X File is executable by real uid.
6052-b File is a block special file.
6053-c File is a character special file.
6054-d File is a directory.
6055-e File exists .
6056-f File is a plain file.
6057-g File has setgid bit set.
6058-k File has sticky bit set.
6059-l File is a symbolic link.
6060-o File is owned by effective uid.
6061-p File is a named pipe (FIFO).
6062-r File is readable by effective uid.
6063-s File has non-zero size.
6064-t Tests if filehandle (STDIN by default) is opened to a tty.
6065-u File has setuid bit set.
6066-w File is writable by effective uid.
6067-x File is executable by effective uid.
6068-z File has zero size.
6069. Concatenate strings.
6070.. Alternation, also range operator.
6071.= Concatenate assignment strings
6072... / ... Division. /PATTERN/ioxsmg Pattern match
6073... /= ... Division assignment.
6074/PATTERN/ioxsmg Pattern match.
6075... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6076<NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6077<pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6078<> Reads line from union of files in @ARGV (= command line) and STDIN.
6079... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6080... <= ... Numeric less than or equal to.
6081... <=> ... Numeric compare.
6082... = ... Assignment.
6083... == ... Numeric equality.
6084... =~ ... Search pattern, substitution, or translation
6085... > ... Numeric greater than.
6086... >= ... Numeric greater than or equal to.
6087... >> ... Bitwise shift right.
6088... >>= ... Bitwise shift right assignment.
6089... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6090?PATTERN? One-time pattern match.
6091@ARGV Command line arguments (not including the command name - see $0).
6092@INC List of places to look for perl scripts during do/include/use.
6093@_ Parameter array for subroutines. Also used by split unless in array context.
6094\\ Creates reference to what follows, like \$var, or quotes non-\w in strings.
6095\\0 Octal char, e.g. \\033.
6096\\E Case modification terminator. See \\Q, \\L, and \\U.
6097\\L Lowercase until \\E . See also \l, lc.
6098\\U Upcase until \\E . See also \u, uc.
6099\\Q Quote metacharacters until \\E . See also quotemeta.
6100\\a Alarm character (octal 007).
6101\\b Backspace character (octal 010).
6102\\c Control character, e.g. \\c[ .
6103\\e Escape character (octal 033).
6104\\f Formfeed character (octal 014).
6105\\l Lowercase the next character. See also \\L and \\u, lcfirst.
6106\\n Newline character (octal 012 on most systems).
6107\\r Return character (octal 015 on most systems).
6108\\t Tab character (octal 011).
6109\\u Upcase the next character. See also \\U and \\l, ucfirst.
6110\\x Hex character, e.g. \\x1b.
6111... ^ ... Bitwise exclusive or.
6112__END__ Ends program source.
6113__DATA__ Ends program source.
6114__FILE__ Current (source) filename.
6115__LINE__ Current line in current source.
6116__PACKAGE__ Current package.
6117ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6118ARGVOUT Output filehandle with -i flag.
6119BEGIN { ... } Immediately executed (during compilation) piece of code.
6120END { ... } Pseudo-subroutine executed after the script finishes.
6121DATA Input filehandle for what follows after __END__ or __DATA__.
6122accept(NEWSOCKET,GENERICSOCKET)
6123alarm(SECONDS)
6124atan2(X,Y)
6125bind(SOCKET,NAME)
6126binmode(FILEHANDLE)
6127caller[(LEVEL)]
6128chdir(EXPR)
6129chmod(LIST)
6130chop[(LIST|VAR)]
6131chown(LIST)
6132chroot(FILENAME)
6133close(FILEHANDLE)
6134closedir(DIRHANDLE)
6135... cmp ... String compare.
6136connect(SOCKET,NAME)
6137continue of { block } continue { block }. Is executed after `next' or at end.
6138cos(EXPR)
6139crypt(PLAINTEXT,SALT)
6140dbmclose(%HASH)
6141dbmopen(%HASH,DBNAME,MODE)
6142defined(EXPR)
6143delete($HASH{KEY})
6144die(LIST)
6145do { ... }|SUBR while|until EXPR executes at least once
6146do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6147dump LABEL
6148each(%HASH)
6149endgrent
6150endhostent
6151endnetent
6152endprotoent
6153endpwent
6154endservent
6155eof[([FILEHANDLE])]
6156... eq ... String equality.
6157eval(EXPR) or eval { BLOCK }
6158exec(LIST)
6159exit(EXPR)
6160exp(EXPR)
6161fcntl(FILEHANDLE,FUNCTION,SCALAR)
6162fileno(FILEHANDLE)
6163flock(FILEHANDLE,OPERATION)
6164for (EXPR;EXPR;EXPR) { ... }
6165foreach [VAR] (@ARRAY) { ... }
6166fork
6167... ge ... String greater than or equal.
6168getc[(FILEHANDLE)]
6169getgrent
6170getgrgid(GID)
6171getgrnam(NAME)
6172gethostbyaddr(ADDR,ADDRTYPE)
6173gethostbyname(NAME)
6174gethostent
6175getlogin
6176getnetbyaddr(ADDR,ADDRTYPE)
6177getnetbyname(NAME)
6178getnetent
6179getpeername(SOCKET)
6180getpgrp(PID)
6181getppid
6182getpriority(WHICH,WHO)
6183getprotobyname(NAME)
6184getprotobynumber(NUMBER)
6185getprotoent
6186getpwent
6187getpwnam(NAME)
6188getpwuid(UID)
6189getservbyname(NAME,PROTO)
6190getservbyport(PORT,PROTO)
6191getservent
6192getsockname(SOCKET)
6193getsockopt(SOCKET,LEVEL,OPTNAME)
6194gmtime(EXPR)
6195goto LABEL
f83d2997
KH
6196... gt ... String greater than.
6197hex(EXPR)
6198if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6199index(STR,SUBSTR[,OFFSET])
6200int(EXPR)
6201ioctl(FILEHANDLE,FUNCTION,SCALAR)
6202join(EXPR,LIST)
6203keys(%HASH)
6204kill(LIST)
6205last [LABEL]
6206... le ... String less than or equal.
6207length(EXPR)
6208link(OLDFILE,NEWFILE)
6209listen(SOCKET,QUEUESIZE)
6210local(LIST)
6211localtime(EXPR)
6212log(EXPR)
6213lstat(EXPR|FILEHANDLE|VAR)
6214... lt ... String less than.
6215m/PATTERN/iogsmx
6216mkdir(FILENAME,MODE)
6217msgctl(ID,CMD,ARG)
6218msgget(KEY,FLAGS)
6219msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6220msgsnd(ID,MSG,FLAGS)
6221my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6222... ne ... String inequality.
6223next [LABEL]
6224oct(EXPR)
6225open(FILEHANDLE[,EXPR])
6226opendir(DIRHANDLE,EXPR)
6227ord(EXPR) ASCII value of the first char of the string.
6228pack(TEMPLATE,LIST)
6229package NAME Introduces package context.
6230pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6231pop(ARRAY)
6232print [FILEHANDLE] [(LIST)]
6233printf [FILEHANDLE] (FORMAT,LIST)
6234push(ARRAY,LIST)
6235q/STRING/ Synonym for 'STRING'
6236qq/STRING/ Synonym for \"STRING\"
6237qx/STRING/ Synonym for `STRING`
6238rand[(EXPR)]
6239read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6240readdir(DIRHANDLE)
6241readlink(EXPR)
6242recv(SOCKET,SCALAR,LEN,FLAGS)
6243redo [LABEL]
6244rename(OLDNAME,NEWNAME)
6245require [FILENAME | PERL_VERSION]
6246reset[(EXPR)]
6247return(LIST)
6248reverse(LIST)
6249rewinddir(DIRHANDLE)
6250rindex(STR,SUBSTR[,OFFSET])
6251rmdir(FILENAME)
6252s/PATTERN/REPLACEMENT/gieoxsm
6253scalar(EXPR)
6254seek(FILEHANDLE,POSITION,WHENCE)
6255seekdir(DIRHANDLE,POS)
6256select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6257semctl(ID,SEMNUM,CMD,ARG)
6258semget(KEY,NSEMS,SIZE,FLAGS)
6259semop(KEY,...)
6260send(SOCKET,MSG,FLAGS[,TO])
6261setgrent
6262sethostent(STAYOPEN)
6263setnetent(STAYOPEN)
6264setpgrp(PID,PGRP)
6265setpriority(WHICH,WHO,PRIORITY)
6266setprotoent(STAYOPEN)
6267setpwent
6268setservent(STAYOPEN)
6269setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6270shift[(ARRAY)]
6271shmctl(ID,CMD,ARG)
6272shmget(KEY,SIZE,FLAGS)
6273shmread(ID,VAR,POS,SIZE)
6274shmwrite(ID,STRING,POS,SIZE)
6275shutdown(SOCKET,HOW)
6276sin(EXPR)
6277sleep[(EXPR)]
6278socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6279socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6280sort [SUBROUTINE] (LIST)
6281splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6282split[(/PATTERN/[,EXPR[,LIMIT]])]
6283sprintf(FORMAT,LIST)
6284sqrt(EXPR)
6285srand(EXPR)
6286stat(EXPR|FILEHANDLE|VAR)
6287study[(SCALAR)]
6288sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6289substr(EXPR,OFFSET[,LEN])
6290symlink(OLDFILE,NEWFILE)
6291syscall(LIST)
6292sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6293system(LIST)
6294syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6295tell[(FILEHANDLE)]
6296telldir(DIRHANDLE)
6297time
6298times
6299tr/SEARCHLIST/REPLACEMENTLIST/cds
6300truncate(FILE|EXPR,LENGTH)
6301umask[(EXPR)]
6302undef[(EXPR)]
6303unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6304unlink(LIST)
6305unpack(TEMPLATE,EXPR)
6306unshift(ARRAY,LIST)
6307until (EXPR) { ... } EXPR until EXPR
6308utime(LIST)
6309values(%HASH)
6310vec(EXPR,OFFSET,BITS)
6311wait
6312waitpid(PID,FLAGS)
6313wantarray Returns true if the sub/eval is called in list context.
6314warn(LIST)
6315while (EXPR) { ... } EXPR while EXPR
6316write[(EXPR|FILEHANDLE)]
6317... x ... Repeat string or array.
6318x= ... Repetition assignment.
6319y/SEARCHLIST/REPLACEMENTLIST/
6320... | ... Bitwise or.
6321... || ... Logical or.
6322~ ... Unary bitwise complement.
db133cb6 6323#! OS interpreter indicator. If contains `perl', used for options, and -x.
f83d2997
KH
6324AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6325CORE:: Prefix to access builtin function if imported sub obscures it.
6326SUPER:: Prefix to lookup for a method in @ISA classes.
6327DESTROY Shorthand for `sub DESTROY {...}'.
6328... EQ ... Obsolete synonym of `eq'.
6329... GE ... Obsolete synonym of `ge'.
6330... GT ... Obsolete synonym of `gt'.
6331... LE ... Obsolete synonym of `le'.
6332... LT ... Obsolete synonym of `lt'.
6333... NE ... Obsolete synonym of `ne'.
6334abs [ EXPR ] absolute value
6335... and ... Low-precedence synonym for &&.
6336bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6337chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6338chr Converts a number to char with the same ordinal.
6339else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6340elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6341exists $HASH{KEY} True if the key exists.
6342format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6343formline PICTURE, LIST Backdoor into \"format\" processing.
6344glob EXPR Synonym of <EXPR>.
6345lc [ EXPR ] Returns lowercased EXPR.
6346lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
db133cb6 6347grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
f83d2997
KH
6348map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6349no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6350not ... Low-precedence synonym for ! - negation.
6351... or ... Low-precedence synonym for ||.
6352pos STRING Set/Get end-position of the last match over this string, see \\G.
6353quotemeta [ EXPR ] Quote regexp metacharacters.
6354qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6355readline FH Synonym of <FH>.
6356readpipe CMD Synonym of `CMD`.
6357ref [ EXPR ] Type of EXPR when dereferenced.
6358sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6359tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6360tied Returns internal object for a tied data.
6361uc [ EXPR ] Returns upcased EXPR.
6362ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6363untie VAR Unlink an object from a simple Perl variable.
6364use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6365... xor ... Low-precedence synonym for exclusive or.
6366prototype \&SUB Returns prototype of the function given a reference.
6367=head1 Top-level heading.
6368=head2 Second-level heading.
6369=head3 Third-level heading (is there such?).
6370=over [ NUMBER ] Start list.
6371=item [ TITLE ] Start new item in the list.
6372=back End list.
6373=cut Switch from POD to Perl.
6374=pod Switch from Perl to POD.
6375")
6376
6377(defun cperl-switch-to-doc-buffer ()
6378 "Go to the perl documentation buffer and insert the documentation."
6379 (interactive)
6380 (let ((buf (get-buffer-create cperl-doc-buffer)))
6381 (if (interactive-p)
6382 (switch-to-buffer-other-window buf)
6383 (set-buffer buf))
6384 (if (= (buffer-size) 0)
6385 (progn
6386 (insert (documentation-property 'cperl-short-docs
6387 'variable-documentation))
6388 (setq buffer-read-only t)))))
6389
6390(defun cperl-beautify-regexp-piece (b e embed)
6391 ;; b is before the starting delimiter, e before the ending
6392 ;; e should be a marker, may be changed, but remains "correct".
6393 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code)
6394 (if (not embed)
6395 (goto-char (1+ b))
6396 (goto-char b)
6397 (cond ((looking-at "(\\?\\\\#") ; badly commented (?#)
6398 (forward-char 2)
6399 (delete-char 1)
6400 (forward-char 1))
6401 ((looking-at "(\\?[^a-zA-Z]")
6402 (forward-char 3))
6403 ((looking-at "(\\?") ; (?i)
6404 (forward-char 2))
6405 (t
6406 (forward-char 1))))
6407 (setq c (if embed (current-indentation) (1- (current-column)))
6408 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
6409 (or (looking-at "[ \t]*[\n#]")
6410 (progn
6411 (insert "\n")))
6412 (goto-char e)
6413 (beginning-of-line)
6414 (if (re-search-forward "[^ \t]" e t)
6415 (progn
6416 (goto-char e)
6417 (insert "\n")
6418 (indent-to-column c)
6419 (set-marker e (point))))
6420 (goto-char b)
6421 (end-of-line 2)
6422 (while (< (point) (marker-position e))
6423 (beginning-of-line)
6424 (setq s (point)
6425 inline t)
6426 (skip-chars-forward " \t")
6427 (delete-region s (point))
6428 (indent-to-column c1)
6429 (while (and
6430 inline
5c8b7eaf 6431 (looking-at
f83d2997
KH
6432 (concat "\\([a-zA-Z0-9]+[^*+{?]\\)" ; 1 word
6433 "\\|" ; Embedded variable
6434 "\\$\\([a-zA-Z0-9_]+\\([[{]\\)?\\|[^\n \t)|]\\)" ; 2 3
6435 "\\|" ; $ ^
6436 "[$^]"
6437 "\\|" ; simple-code simple-code*?
6438 "\\(\\\\.\\|[^][()#|*+?\n]\\)\\([*+{?]\\??\\)?" ; 4 5
6439 "\\|" ; Class
6440 "\\(\\[\\)" ; 6
6441 "\\|" ; Grouping
6442 "\\((\\(\\?\\)?\\)" ; 7 8
6443 "\\|" ; |
6444 "\\(|\\)" ; 9
6445 )))
6446 (goto-char (match-end 0))
6447 (setq spaces t)
6448 (cond ((match-beginning 1) ; Alphanum word + junk
6449 (forward-char -1))
6450 ((or (match-beginning 3) ; $ab[12]
6451 (and (match-beginning 5) ; X* X+ X{2,3}
6452 (eq (preceding-char) ?\{)))
6453 (forward-char -1)
6454 (forward-sexp 1))
6455 ((match-beginning 6) ; []
6456 (setq tmp (point))
6457 (if (looking-at "\\^?\\]")
6458 (goto-char (match-end 0)))
6459 (or (re-search-forward "\\]\\([*+{?]\\)?" e t)
6460 (progn
6461 (goto-char (1- tmp))
6462 (error "[]-group not terminated")))
6463 (if (not (eq (preceding-char) ?\{)) nil
6464 (forward-char -1)
6465 (forward-sexp 1)))
6466 ((match-beginning 7) ; ()
6467 (goto-char (match-beginning 0))
6468 (or (eq (current-column) c1)
6469 (progn
6470 (insert "\n")
6471 (indent-to-column c1)))
6472 (setq tmp (point))
6473 (forward-sexp 1)
6474 ;; (or (forward-sexp 1)
6475 ;; (progn
6476 ;; (goto-char tmp)
6477 ;; (error "()-group not terminated")))
6478 (set-marker m (1- (point)))
6479 (set-marker m1 (point))
6480 (cond
6481 ((not (match-beginning 8))
6482 (cperl-beautify-regexp-piece tmp m t))
6483 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
6484 t)
6485 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
6486 (goto-char (+ 2 tmp))
6487 (forward-sexp 1)
6488 (cperl-beautify-regexp-piece (point) m t))
db133cb6
RS
6489 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
6490 (goto-char (+ 3 tmp))
6491 (cperl-beautify-regexp-piece (point) m t))
f83d2997
KH
6492 (t
6493 (cperl-beautify-regexp-piece tmp m t)))
6494 (goto-char m1)
6495 (cond ((looking-at "[*+?]\\??")
6496 (goto-char (match-end 0)))
6497 ((eq (following-char) ?\{)
6498 (forward-sexp 1)
6499 (if (eq (following-char) ?\?)
6500 (forward-char))))
6501 (skip-chars-forward " \t")
6502 (setq spaces nil)
6503 (if (looking-at "[#\n]")
6504 (progn
6505 (or (eolp) (indent-for-comment))
6506 (beginning-of-line 2))
6507 (insert "\n"))
6508 (end-of-line)
6509 (setq inline nil))
6510 ((match-beginning 9) ; |
6511 (forward-char -1)
6512 (setq tmp (point))
6513 (beginning-of-line)
6514 (if (re-search-forward "[^ \t]" tmp t)
6515 (progn
6516 (goto-char tmp)
6517 (insert "\n"))
6518 ;; first at line
6519 (delete-region (point) tmp))
6520 (indent-to-column c)
6521 (forward-char 1)
6522 (skip-chars-forward " \t")
6523 (setq spaces nil)
6524 (if (looking-at "[#\n]")
6525 (beginning-of-line 2)
6526 (insert "\n"))
6527 (end-of-line)
6528 (setq inline nil)))
6529 (or (looking-at "[ \t\n]")
6530 (not spaces)
6531 (insert " "))
6532 (skip-chars-forward " \t"))
6533 (or (looking-at "[#\n]")
6534 (error "unknown code \"%s\" in a regexp" (buffer-substring (point)
6535 (1+ (point)))))
6536 (and inline (end-of-line 2)))
6537 ;; Special-case the last line of group
6538 (if (and (>= (point) (marker-position e))
6539 (/= (current-indentation) c))
6540 (progn
6541 (beginning-of-line)
6542 (setq s (point))
6543 (skip-chars-forward " \t")
6544 (delete-region s (point))
6545 (indent-to-column c)))
6546 ))
6547
6548(defun cperl-make-regexp-x ()
db133cb6 6549 ;; Returns position of the start
f83d2997
KH
6550 (save-excursion
6551 (or cperl-use-syntax-table-text-property
5bd52f0e 6552 (error "I need to have a regexp marked!"))
f83d2997 6553 ;; Find the start
db133cb6
RS
6554 (if (looking-at "\\s|")
6555 nil ; good already
5bd52f0e 6556 (if (looking-at "\\([smy]\\|qr\\)\\s|")
db133cb6
RS
6557 (forward-char 1)
6558 (re-search-backward "\\s|"))) ; Assume it is scanned already.
f83d2997
KH
6559 ;;(forward-char 1)
6560 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
6561 (sub-p (eq (preceding-char) ?s)) s)
6562 (forward-sexp 1)
6563 (set-marker e (1- (point)))
6564 (setq delim (preceding-char))
6565 (if (and sub-p (eq delim (char-after (- (point) 2))))
6566 (error "Possible s/blah// - do not know how to deal with"))
6567 (if sub-p (forward-sexp 1))
5c8b7eaf 6568 (if (looking-at "\\sw*x")
f83d2997
KH
6569 (setq have-x t)
6570 (insert "x"))
6571 ;; Protect fragile " ", "#"
6572 (if have-x nil
6573 (goto-char (1+ b))
6574 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
6575 (forward-char -1)
6576 (insert "\\")
6577 (forward-char 1)))
6578 b)))
6579
6580(defun cperl-beautify-regexp ()
6581 "do it. (Experimental, may change semantics, recheck the result.)
6582We suppose that the regexp is scanned already."
6583 (interactive)
db133cb6 6584 (goto-char (cperl-make-regexp-x))
f83d2997
KH
6585 (let ((b (point)) (e (make-marker)))
6586 (forward-sexp 1)
6587 (set-marker e (1- (point)))
6588 (cperl-beautify-regexp-piece b e nil)))
6589
db133cb6
RS
6590(defun cperl-regext-to-level-start ()
6591 "Goto start of an enclosing group in regexp.
f83d2997
KH
6592We suppose that the regexp is scanned already."
6593 (interactive)
db133cb6 6594 (let ((limit (cperl-make-regexp-x)) done)
f83d2997
KH
6595 (while (not done)
6596 (or (eq (following-char) ?\()
db133cb6 6597 (search-backward "(" (1+ limit) t)
f83d2997
KH
6598 (error "Cannot find `(' which starts a group"))
6599 (setq done
6600 (save-excursion
6601 (skip-chars-backward "\\")
6602 (looking-at "\\(\\\\\\\\\\)*(")))
db133cb6
RS
6603 (or done (forward-char -1)))))
6604
6605(defun cperl-contract-level ()
5bd52f0e 6606 "Find an enclosing group in regexp and contract it.
db133cb6
RS
6607\(Experimental, may change semantics, recheck the result.)
6608We suppose that the regexp is scanned already."
6609 (interactive)
6610 (cperl-regext-to-level-start)
6611 (let ((b (point)) (e (make-marker)) s c)
6612 (forward-sexp 1)
6613 (set-marker e (1- (point)))
6614 (goto-char b)
6615 (while (re-search-forward "\\(#\\)\\|\n" e t)
5c8b7eaf 6616 (cond
db133cb6
RS
6617 ((match-beginning 1) ; #-comment
6618 (or c (setq c (current-indentation)))
6619 (beginning-of-line 2) ; Skip
6620 (setq s (point))
6621 (skip-chars-forward " \t")
6622 (delete-region s (point))
6623 (indent-to-column c))
6624 (t
6625 (delete-char -1)
6626 (just-one-space))))))
6627
6628(defun cperl-contract-levels ()
5bd52f0e 6629 "Find an enclosing group in regexp and contract all the kids.
db133cb6
RS
6630\(Experimental, may change semantics, recheck the result.)
6631We suppose that the regexp is scanned already."
6632 (interactive)
6633 (condition-case nil
6634 (cperl-regext-to-level-start)
6635 (error ; We are outside outermost group
6636 (goto-char (cperl-make-regexp-x))))
6637 (let ((b (point)) (e (make-marker)) s c)
6638 (forward-sexp 1)
6639 (set-marker e (1- (point)))
6640 (goto-char (1+ b))
6641 (while (re-search-forward "\\(\\\\\\\\\\)\\|(" e t)
5c8b7eaf 6642 (cond
db133cb6
RS
6643 ((match-beginning 1) ; Skip
6644 nil)
6645 (t ; Group
6646 (cperl-contract-level))))))
f83d2997
KH
6647
6648(defun cperl-beautify-level ()
6649 "Find an enclosing group in regexp and beautify it.
6650\(Experimental, may change semantics, recheck the result.)
6651We suppose that the regexp is scanned already."
6652 (interactive)
db133cb6
RS
6653 (cperl-regext-to-level-start)
6654 (let ((b (point)) (e (make-marker)))
6655 (forward-sexp 1)
6656 (set-marker e (1- (point)))
6657 (cperl-beautify-regexp-piece b e nil)))
6658
6659(defun cperl-invert-if-unless ()
b7ec9e59 6660 "Change `if (A) {B}' into `B if A;' if possible."
db133cb6
RS
6661 (interactive)
6662 (or (looking-at "\\<")
6663 (forward-sexp -1))
6664 (if (looking-at "\\<\\(if\\|unless\\|while\\|until\\)\\>")
6665 (let ((pos1 (point))
6666 pos2 pos3 pos4 pos5 s1 s2 state p pos45
6667 (s0 (buffer-substring (match-beginning 0) (match-end 0))))
6668 (forward-sexp 2)
6669 (setq pos3 (point))
6670 (forward-sexp -1)
6671 (setq pos2 (point))
6672 (if (eq (following-char) ?\( )
6673 (progn
6674 (goto-char pos3)
6675 (forward-sexp 1)
6676 (setq pos5 (point))
6677 (forward-sexp -1)
6678 (setq pos4 (point))
6679 ;; XXXX In fact may be `A if (B); {C}' ...
6680 (if (and (eq (following-char) ?\{ )
6681 (progn
6682 (cperl-backward-to-noncomment pos3)
6683 (eq (preceding-char) ?\) )))
6684 (if (condition-case nil
6685 (progn
6686 (goto-char pos5)
6687 (forward-sexp 1)
6688 (forward-sexp -1)
6689 (looking-at "\\<els\\(e\\|if\\)\\>"))
6690 (error nil))
6691 (error
6692 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" s0)
6693 (goto-char (1- pos5))
6694 (cperl-backward-to-noncomment pos4)
6695 (if (eq (preceding-char) ?\;)
6696 (forward-char -1))
6697 (setq pos45 (point))
6698 (goto-char pos4)
6699 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
6700 (setq p (match-beginning 0)
6701 s1 (buffer-substring p (match-end 0))
6702 state (parse-partial-sexp pos4 p))
5c8b7eaf 6703 (or (nth 3 state)
db133cb6
RS
6704 (nth 4 state)
6705 (nth 5 state)
6706 (error "`%s' inside `%s' BLOCK" s1 s0))
6707 (goto-char (match-end 0)))
6708 ;; Finally got it
6709 (goto-char (1+ pos4))
6710 (skip-chars-forward " \t\n")
6711 (setq s2 (buffer-substring (point) pos45))
6712 (goto-char pos45)
6713 (or (looking-at ";?[ \t\n]*}")
6714 (progn
6715 (skip-chars-forward "; \t\n")
6716 (setq s2 (concat s2 "\n" (buffer-substring (point) (1- pos5))))))
6717 (and (equal s2 "")
6718 (setq s2 "1"))
6719 (goto-char (1- pos3))
6720 (cperl-backward-to-noncomment pos2)
6721 (or (looking-at "[ \t\n]*)")
6722 (goto-char (1- pos3)))
6723 (setq p (point))
6724 (goto-char (1+ pos2))
6725 (skip-chars-forward " \t\n")
6726 (setq s1 (buffer-substring (point) p))
6727 (delete-region pos4 pos5)
6728 (delete-region pos2 pos3)
6729 (goto-char pos1)
6730 (insert s2 " ")
6731 (just-one-space)
6732 (forward-word 1)
6733 (setq pos1 (point))
6734 (insert " " s1 ";")
6735 (forward-char -1)
6736 (delete-horizontal-space)
6737 (goto-char pos1)
6738 (just-one-space)
6739 (cperl-indent-line))
6740 (error "`%s' (EXPR) not with an {BLOCK}" s0)))
6741 (error "`%s' not with an (EXPR)" s0)))
6742 (error "Not at `if', `unless', `while', or `unless'")))
6743
5bd52f0e 6744;;; By Anthony Foiani <afoiani@uswest.com>
b7ec9e59
RS
6745;;; Getting help on modules in C-h f ?
6746;;; This is a modified version of `man'.
6747;;; Need to teach it how to lookup functions
6748(defun cperl-perldoc (word)
6749 "Run `perldoc' on WORD."
6750 (interactive
6751 (list (let* ((default-entry (cperl-word-at-point))
6752 (input (read-string
6753 (format "perldoc entry%s: "
6754 (if (string= default-entry "")
6755 ""
6756 (format " (default %s)" default-entry))))))
6757 (if (string= input "")
6758 (if (string= default-entry "")
6759 (error "No perldoc args given")
6760 default-entry)
6761 input))))
5c8b7eaf 6762 (let* ((is-func (and
b7ec9e59
RS
6763 (string-match "^[a-z]+$" word)
6764 (string-match (concat "^" word "\\>")
6765 (documentation-property
6766 'cperl-short-docs
6767 'variable-documentation))))
6768 (manual-program (if is-func "perldoc -f" "perldoc")))
6769 (require 'man)
6770 (Man-getpage-in-background word)))
6771
6772(defun cperl-perldoc-at-point ()
6773 "Run a `perldoc' on the word around point."
6774 (interactive)
6775 (cperl-perldoc (cperl-word-at-point)))
6776
6777(defcustom pod2man-program "pod2man"
6778 "*File name for `pod2man'."
6779 :type 'file
6780 :group 'cperl)
6781
5bd52f0e 6782;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
b7ec9e59
RS
6783(defun cperl-pod-to-manpage ()
6784 "Create a virtual manpage in Emacs from the Perl Online Documentation."
6785 (interactive)
6786 (require 'man)
6787 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
6788 (bufname (concat "Man " buffer-file-name))
6789 (buffer (generate-new-buffer bufname)))
6790 (save-excursion
6791 (set-buffer buffer)
6792 (let ((process-environment (copy-sequence process-environment)))
6793 ;; Prevent any attempt to use display terminal fanciness.
6794 (setenv "TERM" "dumb")
6795 (set-process-sentinel
6796 (start-process pod2man-program buffer "sh" "-c"
6797 (format (cperl-pod2man-build-command) pod2man-args))
6798 'Man-bgproc-sentinel)))))
6799
6800(defun cperl-pod2man-build-command ()
6801 "Builds the entire background manpage and cleaning command."
6802 (let ((command (concat pod2man-program " %s 2>/dev/null"))
6803 (flist Man-filter-list))
6804 (while (and flist (car flist))
6805 (let ((pcom (car (car flist)))
6806 (pargs (cdr (car flist))))
6807 (setq command
6808 (concat command " | " pcom " "
6809 (mapconcat '(lambda (phrase)
6810 (if (not (stringp phrase))
6811 (error "Malformed Man-filter-list"))
6812 phrase)
6813 pargs " ")))
6814 (setq flist (cdr flist))))
6815 command))
db133cb6
RS
6816
6817(defun cperl-lazy-install ()) ; Avoid a warning
f83d2997
KH
6818
6819(if (fboundp 'run-with-idle-timer)
6820 (progn
6821 (defvar cperl-help-shown nil
6822 "Non-nil means that the help was already shown now.")
6823
6824 (defvar cperl-lazy-installed nil
6825 "Non-nil means that the lazy-help handlers are installed now.")
6826
6827 (defun cperl-lazy-install ()
6828 (interactive)
6829 (make-variable-buffer-local 'cperl-help-shown)
6830 (if (and (cperl-val 'cperl-lazy-help-time)
6831 (not cperl-lazy-installed))
6832 (progn
6833 (add-hook 'post-command-hook 'cperl-lazy-hook)
5c8b7eaf
SS
6834 (run-with-idle-timer
6835 (cperl-val 'cperl-lazy-help-time 1000000 5)
6836 t
f83d2997
KH
6837 'cperl-get-help-defer)
6838 (setq cperl-lazy-installed t))))
6839
6840 (defun cperl-lazy-unstall ()
6841 (interactive)
6842 (remove-hook 'post-command-hook 'cperl-lazy-hook)
6843 (cancel-function-timers 'cperl-get-help-defer)
6844 (setq cperl-lazy-installed nil))
6845
6846 (defun cperl-lazy-hook ()
6847 (setq cperl-help-shown nil))
6848
6849 (defun cperl-get-help-defer ()
6850 (if (not (eq major-mode 'perl-mode)) nil
6851 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
6852 (cperl-get-help)
6853 (setq cperl-help-shown t))))
6854 (cperl-lazy-install)))
6855
db133cb6
RS
6856
6857;;; Plug for wrong font-lock:
6858
6859(defun cperl-font-lock-unfontify-region-function (beg end)
6860 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
6861 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6862 before-change-functions after-change-functions
6863 deactivate-mark buffer-file-name buffer-file-truename)
6864 (remove-text-properties beg end '(face nil))
6865 (when (and (not modified) (buffer-modified-p))
6866 (set-buffer-modified-p nil))))
6867
6868(defvar cperl-d-l nil)
6869(defun cperl-fontify-syntaxically (end)
5bd52f0e 6870 ;; Some vars for debugging only
5c8b7eaf 6871 (let (start (dbg (point)) (iend end)
5bd52f0e
RS
6872 (istate (car cperl-syntax-state)))
6873 (and cperl-syntaxify-unwind
6874 (setq end (cperl-unwind-to-safe t end)))
6875 (setq start (point))
db133cb6
RS
6876 (or cperl-syntax-done-to
6877 (setq cperl-syntax-done-to (point-min)))
6878 (if (or (not (boundp 'font-lock-hot-pass))
5bd52f0e
RS
6879 (eval 'font-lock-hot-pass)
6880 t) ; Not debugged otherwise
db133cb6
RS
6881 ;; Need to forget what is after `start'
6882 (setq start (min cperl-syntax-done-to start))
6883 ;; Fontification without a change
6884 (setq start (max cperl-syntax-done-to start)))
6885 (and (> end start)
6886 (setq cperl-syntax-done-to start) ; In case what follows fails
6887 (cperl-find-pods-heres start end t nil t))
5c8b7eaf
SS
6888 ;;(setq cperl-d-l (cons (format "Syntaxifying %s..%s from %s to %s\n"
6889 ;; dbg end start cperl-syntax-done-to)
db133cb6
RS
6890 ;; cperl-d-l))
6891 ;;(let ((standard-output (get-buffer "*Messages*")))
5c8b7eaf 6892 ;;(princ (format "Syntaxifying %s..%s from %s to %s\n"
db133cb6 6893 ;; dbg end start cperl-syntax-done-to)))
5bd52f0e 6894 (if (eq cperl-syntaxify-by-font-lock 'message)
5c8b7eaf
SS
6895 (message "Syntaxified %s..%s from %s to %s(%s), state %s-->%s"
6896 dbg iend
6897 start end cperl-syntax-done-to
6898 istate (car cperl-syntax-state))) ; For debugging
db133cb6
RS
6899 nil)) ; Do not iterate
6900
5bd52f0e
RS
6901(defun cperl-fontify-update (end)
6902 (let ((pos (point)) prop posend)
6903 (while (< pos end)
6904 (setq prop (get-text-property pos 'cperl-postpone))
6905 (setq posend (next-single-property-change pos 'cperl-postpone nil end))
6906 (and prop (put-text-property pos posend (car prop) (cdr prop)))
6907 (setq pos posend)))
6908 nil) ; Do not iterate
6909
6910(defun cperl-update-syntaxification (from to)
6911 (if (and cperl-use-syntax-table-text-property
6912 cperl-syntaxify-by-font-lock
6913 (or (null cperl-syntax-done-to)
6914 (< cperl-syntax-done-to to)))
6915 (progn
6916 (save-excursion
6917 (goto-char from)
6918 (cperl-fontify-syntaxically to)))))
6919
5c8b7eaf 6920(defvar cperl-version
5bd52f0e
RS
6921 (let ((v "Revision: 4.21"))
6922 (string-match ":\\s *\\([0-9.]+\\)" v)
6923 (substring v (match-beginning 1) (match-end 1)))
6924 "Version of IZ-supported CPerl package this file is based on.")
6925
f83d2997
KH
6926(provide 'cperl-mode)
6927
6928;;; cperl-mode.el ends here