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