| blob | 436bc04d0440d6dd24178ad53fe574207a952ed2 |
1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
3 ;; Copyright (C) 1985,86,87,91,92,93,94,95,96,97,98,99,2000,03,2004,2005
4 ;; Free Software Foundation, Inc.
6 ;; Author: Ilya Zakharevich and Bob Olson
7 ;; Maintainer: Ilya Zakharevich <cperl@ilyaz.org>
8 ;; Keywords: languages, Perl
10 ;; This file is part of GNU Emacs.
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.
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.
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.
27 ;;; Corrections made by Ilya Zakharevich cperl@ilyaz.org
29 ;;; Commentary:
31 ;; You can either fine-tune the bells and whistles of this mode or
32 ;; bulk enable them by putting
34 ;; (setq cperl-hairy t)
36 ;; in your .emacs file. (Emacs rulers do not consider it politically
37 ;; correct to make whistles enabled by default.)
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'. <<<<<<
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.
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.
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:
59 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
61 ;;; Font lock bugs as of v4.32:
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
68 ;;; Code:
70 ;; Some macros are needed for `defcustom'
91 ;; (face-list))
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))
124 ;;)
144 answer))
147 "Major mode for editing Perl code."
153 "Indentation."
158 "Variables affected by `cperl-hairy'."
163 "Auto-insert tuneup."
168 "Fontification colors."
173 "Speed vs. validity tuneup."
178 "Help system tuneup."
182 \f
184 "*Non-nil means that if, elsif, while, until, else, for, foreach
185 and do constructs look like:
187 if ()
188 {
189 }
191 instead of:
193 if () {
194 }"
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."
206 "*Indentation of CPerl statements with respect to containing block."
211 "*`cperl-lineup' will always lineup at multiple of this number.
212 If nil, the value of `cperl-indent-level' will be used."
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."
224 "*Extra indentation for braces, compared with other text in same context."
228 "*Offset of CPerl label lines relative to usual indentation."
232 "*Minimal offset of CPerl label lines."
236 "*Extra indent for lines not starting new statements."
240 "*Extra indent for substatements that start with open-braces.
241 This is in addition to cperl-continued-statement-offset."
245 "*Extra indent for substatements that start with close-parenthesis."
250 "*Non-nil means automatically newline before and after braces,
251 and after colons and semicolons, inserted in CPerl code. The following
253 Insertion after colons requires both this variable and
254 `cperl-auto-newline-after-colon' set."
259 "*Non-nil means automatically indent after insertion of (semi)colon.
260 Active if `cperl-auto-newline' is false."
265 "*Non-nil means automatically newline even after colons.
266 Subject to `cperl-auto-newline' setting."
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."
277 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
278 Can be overwritten by `cperl-hairy' if nil."
283 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
284 Can be overwritten by `cperl-hairy' if nil."
289 "*String of parentheses that should be electric in CPerl.
290 Closing ones are electric only if the region is highlighted."
295 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
296 Can be overwritten by `cperl-hairy' if nil."
305 transient-mark-mode)
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."
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."
321 "*Not-nil (and non-null) means keywords are electric in CPerl.
322 Can be overwritten by `cperl-hairy' if nil."
327 "*Not-nil means electric-backspace will untabify in CPerl."
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'."
347 "*What to use as `vc-header-alist' in CPerl."
357 "*Whether to install us into `interpreter-' and `extension' mode lists."
362 "*Not-nil (and non-null) means not to prompt on C-h f.
363 The opposite behaviour is always available if prefixed with C-c.
364 Can be overwritten by `cperl-hairy' if nil."
369 "*Not-nil (and non-null) means not overwrite C-h f.
371 Can be overwritten by `cperl-hairy' if nil."
376 "*Not-nil (and non-null) means to show lazy help after given idle time.
377 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
382 "*Face for POD highlighting."
387 "*Face for POD highlighting.
388 Font for POD headers."
393 "*Face for here-docs highlighting."
398 "*Face for highlighting trailing whitespace."
404 "*Not-nil after evaluation means to highlight POD and here-docs sections."
409 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
414 "*Non-nil means perform additional highlighting on variables.
415 Currently only changes how scalar variables are highlighted.
416 Note that that variable is only read at initialization time for
417 the variable `cperl-font-lock-keywords-2', so changing it after you've
418 entered CPerl mode the first time will have no effect."
423 "*Not-nil means look for POD and here-docs sections during startup.
429 "*Not-nil means make marking of regular expression more thorough.
430 Effective only with `cperl-pod-here-scan'. Not implemented yet."
435 "*Not-nil means add backreferences to generated `imenu's.
436 May require patched `imenu' and `imenu-go'. Obsolete."
441 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
446 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
451 "*Name of the info page containing perl docs.
452 Older version of this page was called `perl5', newer `perl'."
458 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
463 cperl-use-syntax-table-text-property
464 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
469 "*Regexp to match files to scan when generating TAGS."
475 "*Regexp to match files/dirs to skip when generating TAGS."
480 "*Indentation used when beautifying regexps.
481 If nil, the value of `cperl-indent-level' will be used."
486 "*Non-nil means that the comment starting in leftmost column should indent."
491 "*Non-nil means that the _ (underline) should be treated as word char."
496 "*Extra arguments to use when starting Perl.
497 Currently used with `cperl-check-syntax' only."
502 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
507 "*Amount of space to insert between `}' and `else' or `elsif'
508 in `cperl-indent-region'. Set to nil to leave as is. Values other
509 than 1 and nil will probably not work."
514 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
515 need to be reformatted into multiline ones when indenting a region."
520 "*Non-nil means that BLOCK-end `}' may be put on a separate line
521 when indenting a region.
522 Braces followed by else/elsif/while/until are excepted."
527 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
528 may be merged to be on the same line when indenting a region."
533 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
535 One should tune up `cperl-close-paren-offset' as well."
542 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
547 t
548 "*Non-nil means that CPerl unwinds to a start of a long construction
549 when syntaxifying a chunk of buffer."
565 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
587 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
600 "Font Lock mode face used to highlight array names."
613 "Font Lock mode face used to highlight hash names."
616 \f
618 ;;; Short extra-docs.
621 "Get maybe newer version of this package from
622 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs
623 and/or
624 ftp://ftp.math.ohio-state.edu/pub/users/ilya/perl
625 Subdirectory `cperl-mode' may contain yet newer development releases and/or
626 patches to related files.
628 For best results apply to an older Emacs the patches from
629 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
630 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
631 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
632 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
634 Get support packages choose-color.el (or font-lock-extra.el before
635 19.30), imenu-go.el from the same place. \(Look for other files there
636 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
637 later you should use choose-color.el *instead* of font-lock-extra.el
638 \(and you will not get smart highlighting in C :-().
640 Note that to enable Compile choices in the menu you need to install
641 mode-compile.el.
643 If your Emacs does not default to `cperl-mode' on Perl files, and you
644 want it to: put the following into your .emacs file:
646 (defalias 'perl-mode 'cperl-mode)
648 Get perl5-info from
649 $CPAN/doc/manual/info/perl-info.tar.gz
650 older version was on
651 http://www.metronet.com:70/9/perlinfo/perl5/manual/perl5-info.tar.gz
653 If you use imenu-go, run imenu on perl5-info buffer (you can do it
654 from Perl menu). If many files are related, generate TAGS files from
655 Tools/Tags submenu in Perl menu.
657 If some class structure is too complicated, use Tools/Hierarchy-view
658 from Perl menu, or hierarchic view of imenu. The second one uses the
659 current buffer only, the first one requires generation of TAGS from
660 Perl/Tools/Tags menu beforehand.
662 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
664 Switch auto-help on/off with Perl/Tools/Auto-help.
666 Though with contemporary Emaxen CPerl mode should maintain the correct
667 parsing of Perl even when editing, sometimes it may be lost. Fix this by
671 In cases of more severe confusion sometimes it is helpful to do
676 Before reporting (non-)problems look in the problem section of online
680 "Description of problems in CPerl mode.
681 Some faces will not be shown on some versions of Emacs unless you
682 install choose-color.el, available from
683 ftp://ftp.math.ohio-state.edu/pub/users/ilya/emacs/
685 `fill-paragraph' on a comment may leave the point behind the
686 paragraph. Parsing of lines with several <<EOF is not implemented
687 yet.
689 Emacs had a _very_ restricted syntax parsing engine until version
690 20.1. Most problems below are corrected starting from this version of
691 Emacs, and all of them should be fixed in version 20.3. (Or apply
692 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
693 this respect (until 2003).
695 Note that even with newer Emacsen in some very rare cases the details
696 of interaction of `font-lock' and syntaxification may be not cleaned
697 up yet. You may get slightly different colors basing on the order of
698 fontification and syntaxification. Say, the initial faces is correct,
699 but editing the buffer breaks this.
701 Even with older Emacsen CPerl mode tries to corrects some Emacs
702 misunderstandings, however, for efficiency reasons the degree of
703 correction is different for different operations. The partially
704 corrected problems are: POD sections, here-documents, regexps. The
705 operations are: highlighting, indentation, electric keywords, electric
706 braces.
708 This may be confusing, since the regexp s#//#/#\; may be highlighted
709 as a comment, but it will be recognized as a regexp by the indentation
710 code. Or the opposite case, when a POD section is highlighted, but
711 may break the indentation of the following code (though indentation
712 should work if the balance of delimiters is not broken by POD).
715 ${aaa} look like unbalanced braces. The only trick I can think of is
716 to insert it as $ {aaa} (valid in perl5, not in perl4).
721 The solution is to upgrade your Emacs or patch an older one. Note
722 that Emacs 20.2 has some bugs related to `syntax-table' text
723 properties. Patches are available on the main CPerl download site,
724 and on CPAN.
726 If these bugs cannot be fixed on your machine (say, you have an inferior
727 environment and cannot recompile), you may still disable all the fancy stuff
731 "Advantages of CPerl mode.
733 0) It uses the newest `syntax-table' property ;-);
735 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
736 mode - but the latter number may have improved too in last years) even
737 with old Emaxen which do not support `syntax-table' property.
739 When using `syntax-table' property for syntax assist hints, it should
740 handle 99.995% of lines correct - or somesuch. It automatically
741 updates syntax assist hints when you edit your script.
745 things tried _all_ the rest of Emacs ;-), but this was not a lonely
746 voice);
748 3) Everything is customizable, one-by-one or in a big sweep;
751 a) Can run program, check syntax, start debugger;
753 a = b;
754 cc = d;
755 c) Can insert spaces where this impoves readability (in one
756 interactive sweep over the buffer);
757 d) Has support for imenu, including:
759 2) Separate TOC of POD sections;
760 3) Separate list of packages;
761 4) Hierarchical view of methods in (sub)packages;
762 5) and functions (by the full name - with package);
763 e) Has an interface to INFO docs for Perl; The interface is
764 very flexible, including shrink-wrapping of
765 documentation buffer/frame;
766 f) Has a builtin list of one-line explanations for perl constructs.
767 g) Can show these explanations if you stay long enough at the
768 corresponding place (or on demand);
769 h) Has an enhanced fontification (using 3 or 4 additional faces
770 comparing to font-lock - basically, different
771 namespaces in Perl have different colors);
772 i) Can construct TAGS basing on its knowledge of Perl syntax,
773 the standard menu has 6 different way to generate
775 bindings - are included in the scan);
776 j) Can build a hierarchical view of classes (via imenu) basing
777 on generated TAGS file;
778 k) Has electric parentheses, electric newlines, uses Abbrev
779 for electric logical constructs
780 while () {}
781 with different styles of expansion (context sensitive
782 to be not so bothering). Electric parentheses behave
785 m) Can convert from
786 if (A) { B }
787 to
788 B if A;
790 n) Highlights (by user-choice) either 3-delimiters constructs
791 (such as tr/a/b/), or regular expressions and `y/tr';
792 o) Highlights trailing whitespace;
793 p) Is able to manipulate Perl Regular Expressions to ease
794 conversion to a more readable form.
796 5) The indentation engine was very smart, but most of tricks may be
797 not needed anymore with the support for `syntax-table' property. Has
798 progress indicator for indentation (with `imenu' loaded).
800 6) Indent-region improves inline-comments as well; also corrects
801 whitespace *inside* the conditional/loop constructs.
803 7) Fill-paragraph correctly handles multi-line comments;
805 8) Can switch to different indentation styles by one command, and restore
806 the settings present before the switch.
808 9) When doing indentation of control constructs, may correct
809 line-breaks/spacing between elements of the construct.
811 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
815 "This is an incomplete compendium of what is available in other parts
816 of CPerl documentation. (Please inform me if I skept anything.)
818 There is a perception that CPerl is slower than alternatives. This part
819 of documentation is designed to overcome this misconception.
821 *By default* CPerl tries to enable the most comfortable settings.
822 From most points of view, correctly working package is infinitely more
823 comfortable than a non-correctly working one, thus by default CPerl
824 prefers correctness over speed. Below is the guide how to change
825 settings if your preferences are different.
827 A) Speed of loading the file. When loading file, CPerl may perform a
828 scan which indicates places which cannot be parsed by primitive Emacs
829 syntax-parsing routines, and marks them up so that either
831 A1) CPerl may work around these deficiencies (for big chunks, mostly
832 PODs and HERE-documents), or
833 A2) On capable Emaxen CPerl will use improved syntax-handlings
834 which reads mark-up hints directly.
836 The scan in case A2 is much more comprehensive, thus may be slower.
838 User can disable syntax-engine-helping scan of A2 by setting
839 `cperl-use-syntax-table-text-property'
840 variable to nil (if it is set to t).
842 One can disable the scan altogether (both A1 and A2) by setting
843 `cperl-pod-here-scan'
844 to nil.
846 B) Speed of editing operations.
848 One can add a (minor) speedup to editing operations by setting
849 `cperl-use-syntax-table-text-property'
850 variable to nil (if it is set to t). This will disable
851 syntax-engine-helping scan, thus will make many more Perl
852 constructs be wrongly recognized by CPerl, thus may lead to
853 wrongly matched parentheses, wrong indentation, etc.
855 One can unset `cperl-syntaxify-unwind'. This might speed up editing
859 "CPerl mode uses following faces for highlighting:
861 `cperl-array-face' Array names
862 `cperl-hash-face' Hash names
863 `font-lock-comment-face' Comments, PODs and whatever is considered
864 syntaxically to be not code
865 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
866 2-arg operators s/y/tr/ or of RExen,
867 `font-lock-function-name-face' Special-cased m// and s//foo/, _ as
868 a target of a file tests, file tests,
869 subroutine names at the moment of definition
870 (except those conflicting with Perl operators),
871 package names (when recognized), format names
872 `font-lock-keyword-face' Control flow switch constructs, declarators
873 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
874 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
875 literal parts and the terminator of formats
876 and whatever is syntaxically considered
877 as string literals
878 `font-lock-type-face' Overridable keywords
879 `font-lock-variable-name-face' Variable declarations, indirect array and
880 hash names, POD headers/item names
881 `cperl-invalid-face' Trailing whitespace
883 Note that in several situations the highlighting tries to inform about
884 possible confusion, such as different colors for function names in
885 declarations depending on what they (do not) override, or special cases
886 m// and s/// which do not do what one would expect them to do.
888 Help with best setup of these faces for printout requested (for each of
889 the faces: please specify bold, italic, underline, shadow and box.)
893 \f
895 ;;; Portability stuff:
901 emacs-key)
915 ;; "Active regions" are on: use region only if active
916 ;; "Active regions" are off: use region unconditionally
924 cperl-can-font-lock)
940 'fontified
945 ;; If POST, do not do it with postponed fontification
947 nil
949 to cperl-do-not-fontify t)))
952 "Hook run by CPerl mode."
960 \f
961 ;; Make customization possible "in reverse"
967 \f
968 ;;; Probably it is too late to set these guys already, but it can help later:
970 ;;;(and cperl-clobber-mode-lists
971 ;;;(setq auto-mode-alist
972 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
973 ;;;(and (boundp 'interpreter-mode-alist)
974 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
975 ;;; '(("miniperl" . perl-mode))))))
987 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
988 ;; macros instead of defsubsts don't work on Emacs, so we do the
989 ;; expansion manually. Any other suggestions?
1022 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1023 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1026 ;; don't clobber the backspace binding:
1032 ;;(concat (char-to-string help-char) "f") ; does not work
1033 'cperl-info-on-command
1036 ;;(concat (char-to-string help-char) "v") ; does not work
1037 'cperl-get-help
1040 ;;(concat (char-to-string help-char) "f") ; does not work
1044 ;;(concat (char-to-string help-char) "v") ; does not work
1050 ;;(concat (char-to-string help-char) "v") ; does not work
1051 'cperl-get-help
1056 ;; substitute-key-definition is usefulness-deenhanced...
1062 cperl-mode-map global-map)
1065 cperl-mode-map global-map)
1068 cperl-mode-map global-map)))
1077 cperl-menu cperl-mode-map "Menu for CPerl mode"
1084 "----"
1089 cperl-use-syntax-table-text-property]
1091 cperl-use-syntax-table-text-property]
1093 cperl-use-syntax-table-text-property]
1095 cperl-use-syntax-table-text-property]
1097 cperl-use-syntax-table-text-property]
1099 cperl-use-syntax-table-text-property])
1101 "----"
1105 "----"
1111 "----"
1113 "----"
1118 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1123 ;;; ["Create tags for current file" cperl-etags t]
1124 ;;; ["Add tags for current file" (cperl-etags t) t]
1125 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1126 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1127 ;;; ["Create tags for Perl files in (sub)directories"
1128 ;;; (cperl-etags nil 'recursive) t]
1129 ;;; ["Add tags for Perl files in (sub)directories"
1130 ;;; (cperl-etags t 'recursive) t])
1131 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1156 cperl-lazy-installed)])
1187 "Display the result of expanding all C macros occurring in the region.
1188 The expansion is entirely correct because it uses the C preprocessor."
1189 t)
1209 ()
1235 \f
1237 ;; Fix for msb.el
1241 ;;;###autoload
1243 "Major mode for editing Perl code.
1244 Expression and list commands understand all C brackets.
1245 Tab indents for Perl code.
1246 Paragraphs are separated by blank lines only.
1247 Delete converts tabs to spaces as it moves back.
1249 Various characters in Perl almost always come in pairs: {}, (), [],
1250 sometimes <>. When the user types the first, she gets the second as
1251 well, with optional special formatting done on {}. (Disabled by
1255 whether you want to type pair <>, and inserts is if it
1256 appropriate. You can set `cperl-electric-parens-string' to the string that
1257 contains the parenths from the above list you want to be electrical.
1258 Electricity of parenths is controlled by `cperl-electric-parens'.
1259 You may also set `cperl-electric-parens-mark' to have electric parens
1262 CPerl mode provides expansion of the Perl control constructs:
1264 if, else, elsif, unless, while, until, continue, do,
1265 for, foreach, formy and foreachmy.
1267 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1269 The user types the keyword immediately followed by a space, which
1270 causes the construct to be expanded, and the point is positioned where
1271 she is most likely to want to be. eg. when the user types a space
1273 } { } and the cursor is between the parentheses. The user can then
1274 type some boolean expression within the parens. Having done that,
1277 directive line, then appropriate number of new lines is inserted).
1281 bite if angry;
1283 it will not do any expansion. See also help on variable
1284 `cperl-extra-newline-before-brace'. (Note that one can switch the
1285 help message on expansion by setting `cperl-message-electric-keyword'
1286 to nil.)
1289 return. It places you in the next line with proper indentation, or if
1290 you type it inside the inline block of control construct, like
1292 foreach (@lines) {print; print}
1294 and you are on a boundary of a statement inside braces, it will
1295 transform the construct into a multiline and will place you into an
1296 appropriately indented blank line. If you need a usual
1298 see documentation on `cperl-electric-linefeed'.
1302 if (A) { B }
1304 into
1306 B if A;
1310 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1311 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1312 on electric space between $ and {, `cperl-electric-parens-string' is
1313 the string that contains parentheses that should be electric in CPerl
1314 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1315 setting `cperl-electric-keywords' enables electric expansion of
1316 control structures in CPerl. `cperl-electric-linefeed' governs which
1317 one of two linefeed behavior is preferable. You can enable all these
1318 options simultaneously (recommended mode of use) by setting
1319 `cperl-hairy' to t. In this case you can switch separate options off
1320 by setting them to `null'. Note that one may undo the extra
1321 whitespace inserted by semis and braces in `auto-newline'-mode by
1324 If your site has perl5 documentation in info format, you can use commands
1326 These keys run commands `cperl-info-on-current-command' and
1327 `cperl-info-on-command', which one is which is controlled by variable
1328 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1329 \(in turn affected by `cperl-hairy').
1331 Even if you have no info-format documentation, short one-liner-style
1333 man via menu.
1335 It is possible to show this help automatically after some idle time.
1336 This is regulated by variable `cperl-lazy-help-time'. Default with
1337 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1338 secs idle time . It is also possible to switch this on/off from the
1342 beginning of the region at the start of construction, and make region
1343 span the needed amount of lines.
1345 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1346 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1347 here-docs sections. With capable Emaxen results of scan are used
1348 for indentation too, otherwise they are used for highlighting only.
1350 Variables controlling indentation style:
1351 `cperl-tab-always-indent'
1352 Non-nil means TAB in CPerl mode should always reindent the current line,
1353 regardless of where in the line point is when the TAB command is used.
1354 `cperl-indent-left-aligned-comments'
1355 Non-nil means that the comment starting in leftmost column should indent.
1356 `cperl-auto-newline'
1357 Non-nil means automatically newline before and after braces,
1358 and after colons and semicolons, inserted in Perl code. The following
1360 Insertion after colons requires both this variable and
1361 `cperl-auto-newline-after-colon' set.
1362 `cperl-auto-newline-after-colon'
1363 Non-nil means automatically newline even after colons.
1364 Subject to `cperl-auto-newline' setting.
1365 `cperl-indent-level'
1366 Indentation of Perl statements within surrounding block.
1367 The surrounding block's indentation is the indentation
1368 of the line on which the open-brace appears.
1369 `cperl-continued-statement-offset'
1370 Extra indentation given to a substatement, such as the
1371 then-clause of an if, or body of a while, or just a statement continuation.
1372 `cperl-continued-brace-offset'
1373 Extra indentation given to a brace that starts a substatement.
1374 This is in addition to `cperl-continued-statement-offset'.
1375 `cperl-brace-offset'
1376 Extra indentation for line if it starts with an open brace.
1377 `cperl-brace-imaginary-offset'
1378 An open brace following other text is treated as if it the line started
1379 this far to the right of the actual line indentation.
1380 `cperl-label-offset'
1381 Extra indentation for line that is a label.
1382 `cperl-min-label-indent'
1383 Minimal indentation for line that is a label.
1385 Settings for K&R and BSD indentation styles are
1386 `cperl-indent-level' 5 8
1387 `cperl-continued-statement-offset' 5 8
1388 `cperl-brace-offset' -5 -8
1389 `cperl-label-offset' -5 -8
1391 CPerl knows several indentation styles, and may bulk set the
1394 \(both available from menu).
1396 If `cperl-indent-level' is 0, the statement after opening brace in
1397 column 0 is indented on
1398 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1400 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1401 with no args.
1403 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1404 or as help on variables `cperl-tips', `cperl-problems',
1405 `cperl-praise', `cperl-speed'."
1417 ;; don't clobber the backspace binding:
1451 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1475 (setq defun-prompt-regexp "^[ \t]*sub[ \t\n]+\\([^ \t\n{(;]+\\)\\([ \t\n]*([^()]*)[ \t\n]*\\)?[ \t\n]*)")
1482 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1497 cperl-font-lock-keywords-1
1498 cperl-font-lock-keywords-2)))
1501 cperl-load-font-lock-keywords-1
1502 cperl-load-font-lock-keywords-2)))))
1507 ;; Do not introduce variable if not needed, we check it!
1509 ;; Fix broken font-lock:
1521 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1522 ;; used to ignore syntax-table text-properties. (t) is a hack
1523 ;; to make font-lock think that font-lock-syntactic-keywords
1524 ;; are defined.
1548 ;; After hooks since fontification will break this
1553 \f
1554 ;; Fix for perldb - make default reasonable
1562 ;; I have problems
1563 ;; in OS/2
1564 ;; otherwise
1566 nil nil
1568 \f
1570 ;; Adds perl files to msb menu, supposes that msb is already loaded
1579 handle
1581 last))))
1582 \f
1583 ;; This is used by indent-for-comment
1584 ;; to decide how much to indent a comment in CPerl code
1585 ;; based on its context. Do fallback if comment is found wrong.
1599 ;; Wrong comment found
1603 cperl-st-cfence))
1614 comment-column))
1622 ;;;(defun cperl-comment-indent-fallback ()
1623 ;;; "Is called if the standard comment-search procedure fails.
1624 ;;;Point is at start of real comment."
1625 ;;; (let ((c (current-column)) target cnt prevc)
1626 ;;; (if (= c comment-column) nil
1627 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1628 ;;; (setq target (max (1+ (setq prevc
1629 ;;; (current-column))) ; Else indent at comment column
1630 ;;; comment-column))
1631 ;;; (if (= c comment-column) nil
1632 ;;; (delete-backward-char cnt)
1633 ;;; (while (< prevc target)
1634 ;;; (insert "\t")
1635 ;;; (setq prevc (current-column)))
1636 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1637 ;;; (while (< prevc target)
1638 ;;; (insert " ")
1639 ;;; (setq prevc (current-column)))))))
1642 "Substitute for `indent-for-comment' in CPerl."
1651 "Comment or uncomment each line in the region in CPerl mode.
1652 See `comment-region'."
1658 "Uncomment or comment each line in the region in CPerl mode.
1659 See `comment-region'."
1667 "Insert character and correct line's indentation.
1668 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1671 `cperl-extra-newline-before-brace'."
1678 nil)))
1683 ;; Need to insert a matching pair
1691 ;; Check whether we close something "usual" with `}'
1697 ;;(cperl-after-block-p (point-min))
1699 ;; after sub, else, continue
1702 ;; Just insert the guy
1711 ;; if after ")" and `cperl-extra-newline-before-brace'
1712 ;; is nil, do not insert extra newline.
1741 "Insert character, correct line's indentation, correct quoting by space."
1752 nil)))
1753 pos after)
1760 ;; Check whether we are in comment
1766 nil
1774 t)
1780 "Insert an opening parenthesis or a matching pair of parentheses.
1781 See `cperl-electric-parens'."
1790 nil)))
1795 ;;(not (save-excursion (search-backward "#" beg t)))
1815 "Insert a matching pair of parentheses if marking is active.
1816 If not, or if we are not at the end of marking range, would self-insert.
1817 Affected by `cperl-electric-parens'."
1827 nil))
1828 p)
1833 ;;(not (save-excursion (search-backward "#" beg t)))
1834 )
1849 "Insert a construction appropriate after a keyword.
1850 Help message may be switched off by setting `cperl-message-electric-keyword'
1851 to nil."
1857 my do)
1869 beg t)))
1886 delete
1890 ;;(insert " () {\n}")
1919 "Make sure there are N newlines after the point."
1929 "Insert a POD chunk appropriate after a =POD directive."
1932 head1 notlast name p really-delete over)
1947 ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
1997 "Insert a construction appropriate after a keyword.
1998 Help message may be switched off by setting `cperl-message-electric-keyword'
1999 to nil."
2008 beg t)))
2017 ;;(insert " {\n\n}")
2036 "Go to end of line, open a new line and indent appropriately.
2037 If in POD, insert appropriate lines."
2043 ; i.e., on a boundary and inside "{...}"
2055 ; Leave the level of parens
2057 ; Are at end
2063 ; start of parens group.
2073 ; before, move it to separate line
2082 ; after, move it to separate line
2101 ; with an extra newline.
2106 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2107 ;; We are after \n now, so look for the rest
2112 t)))
2128 res))
2129 nil
2142 "Insert character and correct line's indentation."
2151 "Insert character and correct line's indentation."
2156 cperl-auto-newline-after-colon)))
2157 insertpos)
2164 ;; Ignore in comment lines
2166 ;; Colon is special only after a label
2167 ;; So quickly rule out most other uses of colon
2168 ;; and do no indentation for them.
2182 ;;(forward-char -1)
2184 ;;(forward-char 1)
2201 "Backspace, or remove the whitespace around the point inserted by an electric
2202 key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2206 cperl-electric-terminator
2207 cperl-electric-lbrace))
2216 ;; We are removing the whitespace *inside* cperl-electric-else
2241 \f
2243 "Indent current line as Perl code, or in some cases insert a tab character.
2244 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2245 line. Otherwise, indent the current line only if point is at the left margin
2246 or in the line's indentation; otherwise insert a tab.
2248 A numeric argument, regardless of its value,
2249 means indent rigidly all the lines of the expression starting after point
2250 so that this line becomes properly indented.
2251 The relative indentation among the lines of the expression are preserved."
2255 ;; If arg, always indent this line as Perl
2256 ;; and shift remaining lines of expression the same amount.
2258 beg end)
2278 "Indent current line as Perl code.
2279 Return the amount the indentation changed by."
2282 indent i beg shift-amt)
2284 i indent)
2289 ;;((eq indent t) ; Never?
2290 ;; (setq indent (cperl-calculate-indent-within-comment)))
2291 ;;((looking-at "[ \t]*#")
2292 ;; (setq indent 0))
2314 ;; If initial point was within line's indentation,
2315 ;; position after the indentation. Else stay at same point in text.
2318 shift-amt))
2321 ;; Returns true if the point is after label. Does not do save-excursion.
2330 ;; returns list (START STATE DEPTH PRESTART),
2331 ;; START is a good place to start parsing, or equal to
2332 ;; PARSE-START if preset,
2333 ;; STATE is what is returned by `parse-partial-sexp'.
2334 ;; DEPTH is true is we are immediately after end of block
2335 ;; which contains START.
2336 ;; PRESTART is the position basing on which START was found.
2346 ;; Try to go out, if sub is not on the outermost level
2351 ;; The current line could start like }}}, so the indentation
2352 ;; corresponds to a different level than what we reached
2361 ;; Positions is before ?\{. Checks whether it starts a block.
2362 ;; No save-excursion!
2365 ; Label may be mixed up with `$blah :'
2370 ;; Need take into account `bless', `return', `tr',...
2384 "Return appropriate indentation for current line as Perl code.
2385 In usual case returns an integer: the column to indent to.
2386 Returns nil if line starts inside a string, t if in a comment.
2388 Will not correct the indentation for labels, but will correct it for braces
2389 and closing parentheses and brackets."
2396 ;; before start of POD - whitespace found since do not have 'pod!
2401 nil
2409 p prop look-prop is-block delim)
2412 ;; In the verbatim part, probably code example. What to do???
2413 )
2416 ;; Not in POD
2435 old-indent)
2437 ;;containing-sexp ;; We are buggy at toplevel :-(
2438 parse-data)
2444 ;; Before this point: end of statement
2447 ;; indent to just after the surrounding open,
2448 ;; skip blanks if we do not close the expression.
2455 ;; return nil or t if should not change this line
2457 ;; XXXX Do we need to special-case this?
2459 ;; Line is at top level. May be data or function definition,
2460 ;; or may be function argument declaration.
2461 ;; Indent like the previous top level line
2462 ;; unless that ends in a closeparen without semicolon,
2463 ;; in which case this line is the first argument decl.
2472 ;; Look at previous line that's at column 0
2473 ;; to determine whether we are in top-level decls
2474 ;; or function's arg decls. Set basic-indent accordingly.
2475 ;; Now add a little if this is a continuation line.
2479 ;; Had ?\) too
2496 cperl-continued-statement-offset))))
2503 cperl-indent-parens-as-block))
2504 ;; group is an expression, not a block:
2505 ;; indent to just after the surrounding open parens,
2506 ;; skip blanks if we do not close the expression.
2515 ;; Correct indentation of trailing ?\}
2518 ;;; ((and (/= (char-after containing-sexp) ?{)
2519 ;;; (not cperl-indent-parens-as-block))
2520 ;;; ;; line is expression, not statement:
2521 ;;; ;; indent to just after the surrounding open,
2522 ;;; ;; skip blanks if we do not close the expression.
2523 ;;; (goto-char (1+ containing-sexp))
2524 ;;; (or (memq char-after (append ")]}" nil))
2525 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2526 ;;; (skip-chars-forward " \t"))
2527 ;;; (current-column))
2528 ;;; ((progn
2529 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
2530 ;;; (goto-char containing-sexp)
2531 ;;; (and (not (cperl-block-p))
2532 ;;; (not cperl-indent-parens-as-block)))
2533 ;;; (goto-char (1+ containing-sexp))
2534 ;;; (or (eq char-after ?\})
2535 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2536 ;;; (skip-chars-forward " \t"))
2537 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
2538 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
2539 ;;; cperl-close-paren-offset)
2540 ;;; 0)))
2542 ;; Statement level. Is it a continuation or a new statement?
2543 ;; Find previous non-comment character.
2546 ;; Back up over label lines, since they don't
2547 ;; affect whether our line is a continuation.
2548 ;; (Had \, too)
2554 ;;)
2556 ;; Will go to beginning of line, essentially.
2557 ;; Will ignore embedded sexpr XXXX.
2561 ;; Now we get the answer.
2567 containing-sexp))
2569 ;; This line is continuation of preceding line's statement;
2570 ;; indent `cperl-continued-statement-offset' more than the
2571 ;; previous line of the statement.
2572 ;;
2573 ;; There might be a label on this line, just
2574 ;; consider it bad style and ignore it.
2579 cperl-continued-statement-offset)
2583 0
2584 ;; Now it is a hash reference
2589 ;; Do not move `parse-data', this should
2590 ;; be quick anyway (this comment comes
2591 ;; from different location):
2596 ;; This line starts a new statement.
2597 ;; Position following last unclosed open.
2599 ;; Is line first statement after an open-brace?
2601 ;; If no, find that first statement and indent like
2602 ;; it. If the first statement begins with label, do
2603 ;; not believe when the indentation of the label is too
2604 ;; small.
2612 ;; Skip over comments and labels following openbrace.
2619 ;; label:
2624 ;; The first following code counts
2625 ;; if it is before the line we want to indent.
2629 cperl-min-label-indent)
2631 ;; Do not believe: `max' is involved
2634 ;; If no previous statement,
2635 ;; indent it relative to line brace is on.
2636 ;; For open brace in column zero, don't let statement
2637 ;; start there too. If cperl-indent-level is zero,
2638 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2639 ;; For open-braces not the first thing in a line,
2640 ;; add in cperl-brace-imaginary-offset.
2642 ;; If first thing on a line: ?????
2645 cperl-indent-level)
2649 0
2650 ;; Now it is a hash reference
2652 ;; Move back over whitespace before the openbrace.
2653 ;; If openbrace is not first nonwhite thing on the line,
2654 ;; add the cperl-brace-imaginary-offset.
2657 ;; If the openbrace is preceded by a parenthesized exp,
2658 ;; move to the beginning of that;
2659 ;; possibly a different line
2663 ;; In the case it starts a subroutine, indent with
2664 ;; respect to `sub', not with respect to the
2665 ;; first thing on the line, say in the case of
2666 ;; anonymous sub in a hash.
2667 ;;
2681 ;; Get initial indentation of the line we are on.
2682 ;; If line starts with label, calculate label indentation
2688 ;; Do not move `parse-data', this should
2689 ;; be quick anyway:
2693 ;; (defvar cperl-indent-alist
2694 ;; '((string nil)
2695 ;; (comment nil)
2696 ;; (toplevel 0)
2697 ;; (toplevel-after-parenth 2)
2698 ;; (toplevel-continued 2)
2699 ;; (expression 1))
2700 ;; "Alist of indentation rules for CPerl mode.
2701 ;; The values mean:
2702 ;; nil: do not indent;
2703 ;; number: add this amount of indentation.
2705 ;; Not finished, not used.")
2707 ;; (defun cperl-where-am-i (&optional parse-start start-state)
2708 ;; ;; Unfinished
2709 ;; "Return a list of lists ((TYPE POS)...) of good points before the point.
2710 ;; ;; POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2712 ;; ;; Not finished, not used."
2713 ;; (save-excursion
2714 ;; (let* ((start-point (point))
2715 ;; (s-s (cperl-get-state))
2716 ;; (start (nth 0 s-s))
2717 ;; (state (nth 1 s-s))
2718 ;; (prestart (nth 3 s-s))
2719 ;; (containing-sexp (car (cdr state)))
2720 ;; (case-fold-search nil)
2721 ;; (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
2722 ;; (cond ((nth 3 state) ; In string
2723 ;; (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
2724 ;; ((nth 4 state) ; In comment
2725 ;; (setq res (cons '(comment) res)))
2726 ;; ((null containing-sexp)
2727 ;; ;; Line is at top level.
2728 ;; ;; Indent like the previous top level line
2729 ;; ;; unless that ends in a closeparen without semicolon,
2730 ;; ;; in which case this line is the first argument decl.
2731 ;; (cperl-backward-to-noncomment (or parse-start (point-min)))
2732 ;; ;;(skip-chars-backward " \t\f\n")
2733 ;; (cond
2734 ;; ((or (bobp)
2735 ;; (memq (preceding-char) (append ";}" nil)))
2736 ;; (setq res (cons (list 'toplevel start) res)))
2737 ;; ((eq (preceding-char) ?\) )
2738 ;; (setq res (cons (list 'toplevel-after-parenth start) res)))
2739 ;; (t
2740 ;; (setq res (cons (list 'toplevel-continued start) res)))))
2741 ;; ((/= (char-after containing-sexp) ?{)
2742 ;; ;; line is expression, not statement:
2743 ;; ;; indent to just after the surrounding open.
2744 ;; ;; skip blanks if we do not close the expression.
2745 ;; (setq res (cons (list 'expression-blanks
2746 ;; (progn
2747 ;; (goto-char (1+ containing-sexp))
2748 ;; (or (looking-at "[ \t]*\\(#\\|$\\)")
2749 ;; (skip-chars-forward " \t"))
2750 ;; (point)))
2751 ;; (cons (list 'expression containing-sexp) res))))
2752 ;; ((progn
2753 ;; ;; Containing-expr starts with \{. Check whether it is a hash.
2754 ;; (goto-char containing-sexp)
2755 ;; (not (cperl-block-p)))
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 ;; (t
2764 ;; ;; Statement level.
2765 ;; (setq res (cons (list 'in-block containing-sexp) res))
2766 ;; ;; Is it a continuation or a new statement?
2767 ;; ;; Find previous non-comment character.
2768 ;; (cperl-backward-to-noncomment containing-sexp)
2769 ;; ;; Back up over label lines, since they don't
2770 ;; ;; affect whether our line is a continuation.
2771 ;; ;; Back up comma-delimited lines too ?????
2772 ;; (while (or (eq (preceding-char) ?\,)
2773 ;; (save-excursion (cperl-after-label)))
2774 ;; (if (eq (preceding-char) ?\,)
2775 ;; ;; Will go to beginning of line, essentially
2776 ;; ;; Will ignore embedded sexpr XXXX.
2777 ;; (cperl-backward-to-start-of-continued-exp containing-sexp))
2778 ;; (beginning-of-line)
2779 ;; (cperl-backward-to-noncomment containing-sexp))
2780 ;; ;; Now we get the answer.
2781 ;; (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
2782 ;; ;; This line is continuation of preceding line's statement.
2783 ;; (list (list 'statement-continued containing-sexp))
2784 ;; ;; This line starts a new statement.
2785 ;; ;; Position following last unclosed open.
2786 ;; (goto-char containing-sexp)
2787 ;; ;; Is line first statement after an open-brace?
2788 ;; (or
2789 ;; ;; If no, find that first statement and indent like
2790 ;; ;; it. If the first statement begins with label, do
2791 ;; ;; not believe when the indentation of the label is too
2792 ;; ;; small.
2793 ;; (save-excursion
2794 ;; (forward-char 1)
2795 ;; (let ((colon-line-end 0))
2796 ;; (while (progn (skip-chars-forward " \t\n" start-point)
2797 ;; (and (< (point) start-point)
2798 ;; (looking-at
2799 ;; "#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
2800 ;; ;; Skip over comments and labels following openbrace.
2801 ;; (cond ((= (following-char) ?\#)
2802 ;; ;;(forward-line 1)
2803 ;; (end-of-line))
2804 ;; ;; label:
2805 ;; (t
2806 ;; (save-excursion (end-of-line)
2807 ;; (setq colon-line-end (point)))
2808 ;; (search-forward ":"))))
2809 ;; ;; Now at the point, after label, or at start
2810 ;; ;; of first statement in the block.
2811 ;; (and (< (point) start-point)
2812 ;; (if (> colon-line-end (point))
2813 ;; ;; Before statement after label
2814 ;; (if (> (current-indentation)
2815 ;; cperl-min-label-indent)
2816 ;; (list (list 'label-in-block (point)))
2817 ;; ;; Do not believe: `max' is involved
2818 ;; (list
2819 ;; (list 'label-in-block-min-indent (point))))
2820 ;; ;; Before statement
2821 ;; (list 'statement-in-block (point))))))
2822 ;; ;; If no previous statement,
2823 ;; ;; indent it relative to line brace is on.
2824 ;; ;; For open brace in column zero, don't let statement
2825 ;; ;; start there too. If cperl-indent-level is zero,
2826 ;; ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2827 ;; ;; For open-braces not the first thing in a line,
2828 ;; ;; add in cperl-brace-imaginary-offset.
2830 ;; ;; If first thing on a line: ?????
2831 ;; (+ (if (and (bolp) (zerop cperl-indent-level))
2832 ;; (+ cperl-brace-offset cperl-continued-statement-offset)
2833 ;; cperl-indent-level)
2834 ;; ;; Move back over whitespace before the openbrace.
2835 ;; ;; If openbrace is not first nonwhite thing on the line,
2836 ;; ;; add the cperl-brace-imaginary-offset.
2837 ;; (progn (skip-chars-backward " \t")
2838 ;; (if (bolp) 0 cperl-brace-imaginary-offset))
2839 ;; ;; If the openbrace is preceded by a parenthesized exp,
2840 ;; ;; move to the beginning of that;
2841 ;; ;; possibly a different line
2842 ;; (progn
2843 ;; (if (eq (preceding-char) ?\))
2844 ;; (forward-sexp -1))
2845 ;; ;; Get initial indentation of the line we are on.
2846 ;; ;; If line starts with label, calculate label indentation
2847 ;; (if (save-excursion
2848 ;; (beginning-of-line)
2849 ;; (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
2850 ;; (if (> (current-indentation) cperl-min-label-indent)
2851 ;; (- (current-indentation) cperl-label-offset)
2852 ;; (cperl-calculate-indent))
2853 ;; (current-indentation))))))))
2854 ;; res)))
2857 "Return the indentation amount for line, assuming that
2858 the current line is to be regarded as part of a block comment."
2873 "Go to position before comment on the current line, or to end of line.
2874 Returns true if comment is found."
2881 ;; Else
2884 ; stop at comment
2885 ;; If fails (beginning-of-line inside sexp), then contains not-comment
2887 ; (nth 2 state) can be
2888 ; beginning of m,s,qq and so
2889 ; on
2926 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2935 nil
2936 ;; We suppose that e is _after_ the end of construction, as after eol.
2939 ;; one-char string/comment?!
2947 ;; Fontify
2960 ;; Works *before* syntax recognition is done
2961 ;; May modify syntax-type text property if the situation is too hard
2964 ;; ender means matching-char matcher.
2968 ;; What if starter == ?\\ ????
2979 ;; Whether we have an intermediate point
2981 ;; Prepare the syntax table:
2989 ;; We use `$' syntax class to find matching stuff, but $$
2990 ;; is recognized the same as $, so we need to check this manually.
2993 ;; $ has TeXish matching rules, so $$ equiv $...
3002 ;; Now the problem is with m;blah;;
3010 ;; Now we are after the first part.
3016 ;; Make trailing letter into punctuation
3034 argument starter ender)
3042 "End of `%s%s%c ... %c' string/RE not found: %s"
3043 argument
3051 ;; i: have 2 args, after end of the first arg
3052 ;; i2: start of the second arg, if any (before delim iff `ender').
3053 ;; ender: the last arg bounded by parens-like chars, the second one of them
3054 ;; starter: the starting delimiter of the first arg
3055 ;; go-forward: has 2 args, and the second part is empty
3059 ;;(defvar font-lock-reference-face)
3062 ;; Do after syntactic fontification?
3067 ;;; Here is how the global structures (those which cannot be
3068 ;;; recognized locally) are marked:
3069 ;; a) PODs:
3070 ;; Start-to-end is marked `in-pod' ==> t
3071 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3072 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3073 ;; b) HEREs:
3074 ;; Start-to-end is marked `here-doc-group' ==> t
3075 ;; The body is marked `syntax-type' ==> `here-doc'
3076 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3077 ;; c) FORMATs:
3078 ;; First line (to =) marked `first-format-line' ==> t
3079 ;; After-this--to-end is marked `syntax-type' ==> `format'
3080 ;; d) 'Q'uoted string:
3081 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3082 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3085 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3097 ;; Up to the start
3099 ;; Skip empty lines
3105 ;; Do the same for end, going small steps
3117 "Scans the buffer for hard-to-parse Perl constructions.
3118 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3119 the sections using `cperl-pod-head-face', `cperl-pod-face',
3120 `cperl-here-face'."
3123 cperl-syntax-state nil
3124 cperl-syntax-done-to min))
3127 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3128 is-REx is-x-REx REx-comment-start REx-comment-end was-comment i2
3139 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3141 ;; Somehow font-lock may be not loaded yet...
3143 font-lock-string-face
3146 font-lock-constant-face
3150 font-lock-function-name-face
3154 font-lock-comment-face
3158 cperl-nonoverridable-face
3162 max))
3167 ;; One extra () before this:
3168 "<<"
3170 ;; First variant "BLAH" or just ``.
3176 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3178 ;; Do not have <<= or << 30 or <<30 or << $blah.
3179 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3183 ;; 1+6 extra () before this:
3188 ;; 1+6+2=9 extra () before this:
3191 ;; 1+6+2+1=10 extra () before this:
3194 ;; 1+6+2+1+1=11 extra () before this:
3197 ;; 1+6+2+1+1+2=13 extra () before this:
3200 ;; 1+6+2+1+1+2+1=14 extra () before this:
3202 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3205 ;; 1+6+2+1+1+2+1+1+1=16 extra () before this:
3215 ;; We had evals here, do not know why...
3217 head-face cperl-pod-head-face
3218 here-face cperl-here-face))
3221 cperl-postpone t
3222 syntax-subtype t
3223 rear-nonsticky t
3224 here-doc-group t
3225 first-format-line t
3226 indentable t))
3227 ;; Need to remove face as well...
3233 nil))
3240 ;; "\\(\\`\n?\\|^\n\\)="
3243 nil ; Doing a chunk only
3249 bb b
3252 ;; We do not search to max, since we may be called from
3253 ;; some hook of fontification, and max is random
3268 cperl-postpone t
3269 syntax-subtype t
3270 here-doc-group t
3271 rear-nonsticky t
3272 first-format-line t
3273 indentable t))
3279 ;; We start 'pod 1 char earlier to include the preceding line
3283 ;; mark the non-literal parts as PODs
3293 ;; mark the non-literal parts as PODs
3298 ;; mark the headers
3303 ;; One paragraph
3306 ;; mark the headers
3314 ;; Here document
3315 ;; We do only one here-per-line
3316 ;; ;; One extra () before this:
3317 ;;"<<"
3318 ;; "\\(" ; 1 + 1
3319 ;; ;; First variant "BLAH" or just ``.
3320 ;; "[ \t]*" ; Yes, whitespace is allowed!
3321 ;; "\\([\"'`]\\)" ; 2 + 1
3322 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3323 ;; "\\3"
3324 ;; "\\|"
3325 ;; ;; Second variant: Identifier or \ID or empty
3326 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3327 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3328 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3329 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3330 ;; "\\)"
3332 ;; Abort in comment:
3335 state-point b
3346 nil ; Skip it.
3355 ;; Highlight the starting delimiter
3360 ;; We do not search to max, since we may be called from
3361 ;; some hook of fontification, and max is random
3372 ;; Highlight the ending delimiter
3376 ;; Highlight the HERE-DOC
3390 ;; format
3392 ;; 1+6=7 extra () before this:
3393 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3420 ;; Highlight the format line
3425 ;; We do not search to max, since we may be called from
3426 ;; some hook of fontification, and max is random
3431 ;; Highlight the ending delimiter
3442 ;; Regexp:
3444 ;; 1+6+2=9 extra () before this:
3445 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3446 ;; "\\|"
3447 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3452 i b
3455 ;; bb == "Not a stringy"
3462 ?\:))
3466 ?\-))
3470 ?\&)))
3472 ;; <file> or <$file>
3474 ;; Do not stringify <FH>, <$fh> :
3484 b1 nil
3485 bb ; Not a regexp?
3488 ;; What is below: regexp-p?
3492 ;; $a++ ? 1 : 2
3493 "~{(=|&*!,;:"
3500 ;; After these keywords `/' starts a RE. One should add all the
3501 ;; functions/builtins which expect an argument, but ...
3503 ;; -d ?foo? is a RE
3509 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
3513 ;; m|blah| ? foo : bar;
3516 cperl-use-syntax-table-text-property
3522 ;; s y tr m
3523 ;; Check for $a -> y
3528 ;; Not a regexp
3531 state-point b nil nil state)
3532 state-point b))
3542 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
3562 ;; Check for { foo => 1, s => 2 }
3563 ;; Apparently s=> is never a substitution...
3576 ;; Skip whitespace and comments...
3582 ;; qtag means two-arg matcher, may be reset to
3583 ;; 2 or 3 later if some special quoting is needed.
3584 ;; e1 means matching-char matcher.
3586 ;; has 2 args
3588 ;; We do not search to max, since we may be called from
3589 ;; some hook of fontification, and max is random
3591 i2
3592 t st-l err-l argument)
3593 ;; Note that if `go', then it is considered as 1-arg
3596 ; is with matching chars []
3600 ;; Before end of the second part if non-matching: ///
3604 qtag nil ; need to preserve backslashitis
3606 ;; Commenting \\ is dangerous, what about ( ?
3613 ;; Considered as 1arg form
3618 ;; ignore other text properties:
3629 ;; silent:
3631 ;; Error
3647 ;; Now: tail: if the second part is non-matching without ///e
3654 ;; Check whether it is m// which means "previous match"
3655 ;; and highlight differently
3662 ;; split // *is* using zero-pattern
3684 ;; Process RExen better
3700 was-comment t)
3703 ;; XXX not working if outside delimiter is #
3706 ;; Not a comment, avoid loop:
3714 ;; Works also if the outside delimiters are ().
3717 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
3718 REx-comment-start))))
3725 REx-comment-start REx-comment-end nil)
3727 REx-comment-start REx-comment-end
3745 nil
3747 state-point b nil nil state)
3748 state-point b)
3750 nil
3751 ;; Mark as string
3754 ;; 1+6+2+1+1+2=13 extra () before this:
3755 ;; "\\$\\(['{]\\)"
3765 ;; 1+6+2+1+1+2=13 extra () before this:
3766 ;; "\\$\\(['{]\\)"
3770 ;; 1+6+2+1+1+2+1=14 extra () before this:
3771 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3776 state-point b nil nil state)
3777 state-point b)
3779 nil
3782 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3783 ;; "__\\(END\\|DATA\\)__"
3788 state-point b nil nil state)
3789 state-point b)
3791 nil
3792 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3797 ;; Trailing backslash ==> non-quoting outside string/comment
3802 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
3804 state-point b nil nil state)
3805 state-point b)
3807 nil
3830 ;; Stops at lim or after non-whitespace that is not in comment
3847 "Return true if the preceeding } ends a block or a following { starts one.
3848 Would not look before LIM. If PRE-BLOCK is nil checks preceeding }.
3849 otherwise following {."
3850 ;; We suppose that the preceding char is }.
3862 ;; sub f {}
3873 "Return true if the position is good for start of expression.
3874 TEST is the expression to evaluate at the found position. If absent,
3875 CHARS is a string that contains good characters to have before us (however,
3878 stop p pr)
3885 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
3886 ;; '(pod here-doc here-doc-delim))
3898 ;; Else: last iteration, or a label
3932 ;; We assume that we are after ?\}
3947 \f
3949 "Simple variant of indentation of continued-sexp.
3951 Will not indent comment if it starts at `comment-indent' or looks like
3952 continuation of the comment on the previous line.
3954 If `cperl-indent-region-fix-constructs', will improve spacing on
3955 conditional/loop constructs."
3982 "Improve whitespace in a conditional/loop construct.
3983 Returns some position at the last line."
3990 p pp ml have-brace ret)
3994 ;; }? continue
3995 ;; blah; }
3997 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
3999 nil ; Do not need to do anything
4000 ;; Looking at:
4001 ;; }
4002 ;; else
4013 ;; Looking at:
4014 ;; } else
4021 ;; Looking at:
4022 ;; else {
4024 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4030 ;; Looking at:
4031 ;; foreach my $var
4039 ;; Looking at:
4040 ;; foreach my $var (
4042 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4049 ;; Looking at:
4050 ;; } foreach my $var () {
4052 "[ \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]*{")
4062 ;; after `else' or nothing
4067 ;; Now after the sexp before the brace
4068 ;; Multiline expr should be special
4076 nil)
4080 cperl-extra-newline-before-brace-multiline
4081 cperl-extra-newline-before-brace)
4094 cperl-extra-newline-before-brace-multiline
4095 cperl-extra-newline-before-brace)))
4101 ;; Now we are before `{'
4111 ;; not good: multi-line BLOCK
4121 ;; Now check whether there is a hanging `}'
4122 ;; Looking at:
4123 ;; } blah
4125 cperl-fix-hanging-brace-when-indent
4126 have-brace
4127 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
4134 t
4136 nil))
4142 ;; `}' was the first thing on the line, insert NL *after* it.
4159 ret))
4168 "Simple variant of indentation of region in CPerl mode.
4169 Should be slow. Will not indent comment if it starts at `comment-indent'
4170 or looks like continuation of the comment on the previous line.
4171 Indents all the lines whose first character is between START and END
4172 inclusive.
4174 If `cperl-indent-region-fix-constructs', will improve spacing on
4175 conditional/loop constructs."
4182 nil))
4184 after-change-functions ; Speed it up!
4185 st comm old-comm-indent new-comm-indent p pp i empty)
4190 new-comm-indent old-comm-indent)
4200 comment-column))
4207 cperl-st-cfence)))
4224 cperl-st-cfence))
4231 ;; Now run the update hooks
4233 cperl-update-end
4242 ;; Stolen from lisp-mode with a lot of improvements
4245 "Like `fill-paragraph', but handle CPerl comments.
4246 If any of the current line is a comment, fill the comment or the
4247 block of it that point is in, preserving the comment's initial
4248 indentation and initial hashes. Behaves usually outside of comment."
4249 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
4251 has-comment
4253 ;; If has-comment, the appropriate fill-prefix for the comment.
4254 comment-fill-prefix
4255 ;; Line that contains code and comment (or nil)
4256 start
4258 ;; Figure out what kind of comment we are looking at.
4263 ;; A line with nothing but a comment on it?
4269 ;; A line with some code, followed by a comment? Remember that the
4270 ;; semi which starts the comment shouldn't be part of a string or
4271 ;; character.
4276 comment-fill-prefix
4287 ;; Narrow to include only the comment, and then fill the region.
4290 ;; Find the first line we should include in the region to fill.
4295 ;; We may have gone to far. Go forward again.
4299 ;; Find the beginning of the first line past the region to fill.
4304 ;; Remove existing hashes
4312 ;; Lines with only hashes on them can be paragraph boundaries.
4325 ;; Repeat once more, flagging as iteration
4329 ;; Break out if the line is short enough
4333 fill-column)
4338 ;; Don't break line inside code: only inside comment.
4339 nil
4343 ;; Is not enough, sometimes marker is a start of line
4346 ;; Following space could have gone:
4350 ;; Previous space could have gone:
4354 ;; We suppose that the lst is a DAG, unless the first element only
4355 ;; loops back, and ISBACK is set. Thus this function cannot be
4356 ;; applied twice without ISBACK set.
4364 ;; In the other order it goes up
4365 ;; one level only ;-(
4370 lst)))
4377 packages ends-ranges p marker
4381 ;; Search for the function
4385 nil t)
4392 nil)
4395 ;; Skip if quoted (will not skip multi-line ''-strings :-():
4402 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4403 ;; (goto-char (match-end 0))) ; Messes what follows
4405 meth nil
4408 ;; delete obsolete entries
4416 name)
4419 end-range
4424 ;; )
4425 ;; Skip this function name if it is a prototype declaration.
4445 ;; (beginning-of-line)
4462 index-alist))
4465 ;; Remove "package ", reverse and uniquify.
4477 ;; Have some functions already
4494 hier-list))))))
4496 hier-list)
4497 index-alist)))
4501 index-alist))
4504 index-unsorted-alist
4507 index-alist))
4510 \f
4511 ;; Suggested by Mark A. Hershberger
4525 \f
4527 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4534 "mode-compile"
4536 cperl-compilation-error-regexp-alist)))
4540 "Initialization under windowed version."
4542 ;; Need to init anyway:
4552 "ps-print"
4564 cperl-font-lock-keywords)
4568 cperl-font-lock-keywords-1)
4572 cperl-font-lock-keywords-2)
4575 ;; Allow `cperl-find-pods-heres' to run.
4579 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4580 ))
4593 t-font-lock-keywords
4600 'identity
4607 ; In what follows we use `type' style
4608 ; for overwritable builtins
4612 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4613 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4614 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4615 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4616 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4617 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4618 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4619 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4620 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4621 ;; "gethostbyname" "gethostent" "getlogin"
4622 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4623 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4624 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4625 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4626 ;; "getservbyport" "getservent" "getsockname"
4627 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4628 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
4629 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
4630 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4631 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4632 ;; "quotemeta" "rand" "read" "readdir" "readline"
4633 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4634 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4635 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4636 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4637 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4638 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4639 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4640 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
4641 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
4642 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4643 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4644 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
4677 ;; In what follows we use `other' style
4678 ;; for nonoverwritable builtins
4679 ;; Somehow 's', 'm' are not auto-generated???
4683 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
4684 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4685 ;; "eval" "exists" "for" "foreach" "format" "goto"
4686 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4687 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4688 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4689 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4690 ;; "undef" "unless" "unshift" "untie" "until" "use"
4691 ;; "while" "y"
4703 ;; (mapconcat 'identity
4704 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4705 ;; "#include" "#define" "#undef")
4706 ;; "\\|")
4710 font-lock-function-name-face)
4711 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4723 nil nil
4728 font-lock-string-face t)
4729 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
4731 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
4733 ;; Uncomment to get perl-mode-like vars
4734 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
4735 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
4736 ;;; (2 (cons font-lock-variable-name-face '(underline))))
4749 nil nil
4753 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
4755 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
4759 t-font-lock-keywords-1
4762 '(
4765 cperl-hash-face
4766 cperl-array-face)
4769 1
4772 cperl-hash-face
4775 t)
4776 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4777 ;;; Too much noise from \s* @s[ and friends
4778 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
4779 ;;(3 font-lock-function-name-face t t)
4780 ;;(4
4781 ;; (if (cperl-slash-is-regexp)
4782 ;; font-lock-function-name-face 'default) nil t))
4783 )))
4788 font-lock-variable-name-face)))))
4792 t-font-lock-keywords)
4793 t-font-lock-keywords)
4794 cperl-font-lock-keywords cperl-font-lock-keywords-1
4796 cperl-font-lock-keywords-1
4797 t-font-lock-keywords-1)))
4803 ;; Color-light Color-dark Gray-light Gray-dark Mono
4806 nil
4809 nil)
4812 nil
4813 nil
4815 nil)
4822 nil nil nil nil
4826 nil
4827 nil)
4830 nil
4833 nil)
4836 nil
4838 nil
4842 nil
4844 nil
4857 t
4858 nil
4859 nil)
4864 t
4865 t
4866 nil))))
4867 ;; Do it the dull way, without choose-color
4870 ;; (or (fboundp 'x-color-defined-p)
4871 ;; (defalias 'x-color-defined-p
4872 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4873 ;; ;; XEmacs >= 19.12
4874 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4875 ;; ;; XEmacs 19.11
4876 ;; (t 'x-valid-color-name-p))))
4893 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4894 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4895 ;;(or (boundp 'font-lock-type-face)
4896 ;; (defconst font-lock-type-face
4897 ;; 'font-lock-type-face
4898 ;; "Face to use for data types."))
4899 ;;(or (boundp 'cperl-nonoverridable-face)
4900 ;; (defconst cperl-nonoverridable-face
4901 ;; 'cperl-nonoverridable-face
4902 ;; "Face to use for data types from another group."))
4903 ;;(if (not cperl-xemacs-p) nil
4904 ;; (or (boundp 'font-lock-comment-face)
4905 ;; (defconst font-lock-comment-face
4906 ;; 'font-lock-comment-face
4907 ;; "Face to use for comments."))
4908 ;; (or (boundp 'font-lock-keyword-face)
4909 ;; (defconst font-lock-keyword-face
4910 ;; 'font-lock-keyword-face
4911 ;; "Face to use for keywords."))
4912 ;; (or (boundp 'font-lock-function-name-face)
4913 ;; (defconst font-lock-function-name-face
4914 ;; 'font-lock-function-name-face
4915 ;; "Face to use for function names.")))
4930 ;;(or (boundp 'cperl-hash-face)
4931 ;; (defconst cperl-hash-face
4932 ;; 'cperl-hash-face
4933 ;; "Face to use for hashes."))
4934 ;;(or (boundp 'cperl-array-face)
4935 ;; (defconst cperl-array-face
4936 ;; 'cperl-array-face
4937 ;; "Face to use for arrays."))
4938 ;; Here we try to guess background
4941 font-lock-background-mode
4944 ;;;; (fset 'cperl-is-face
4945 ;;;; (cond ((fboundp 'find-face)
4946 ;;;; (symbol-function 'find-face))
4947 ;;;; (face-list
4948 ;;;; (function (lambda (face) (member face face-list))))
4949 ;;;; (t
4950 ;;;; (function (lambda (face) (boundp face))))))
4954 'gray
4955 background)
4966 "seagreen"
4971 "os2pink"
4976 nil
4982 "chartreuse3"
4987 "orchid1"
4989 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
4990 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
4991 ;;; (cond
4992 ;;; ((eq background 'light)
4993 ;;; (set-face-background 'font-lock-other-emphasized-face
4994 ;;; (if (x-color-defined-p "lightyellow2")
4995 ;;; "lightyellow2"
4996 ;;; (if (x-color-defined-p "lightyellow")
4997 ;;; "lightyellow"
4998 ;;; "light yellow"))))
4999 ;;; ((eq background 'dark)
5000 ;;; (set-face-background 'font-lock-other-emphasized-face
5001 ;;; (if (x-color-defined-p "navy")
5002 ;;; "navy"
5003 ;;; (if (x-color-defined-p "darkgreen")
5004 ;;; "darkgreen"
5005 ;;; "dark green"))))
5006 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
5007 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
5008 ;;; (copy-face 'bold 'font-lock-emphasized-face)
5009 ;;; (cond
5010 ;;; ((eq background 'light)
5011 ;;; (set-face-background 'font-lock-emphasized-face
5012 ;;; (if (x-color-defined-p "lightyellow2")
5013 ;;; "lightyellow2"
5014 ;;; "lightyellow")))
5015 ;;; ((eq background 'dark)
5016 ;;; (set-face-background 'font-lock-emphasized-face
5017 ;;; (if (x-color-defined-p "navy")
5018 ;;; "navy"
5019 ;;; (if (x-color-defined-p "darkgreen")
5020 ;;; "darkgreen"
5021 ;;; "dark green"))))
5022 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
5032 "Initialization of `ps-print' components for faces used in CPerl."
5035 ;; font-lock-variable-name-face
5036 ;; font-lock-constant-face
5038 cperl-hash-face)
5039 ps-bold-faces)
5040 ps-italic-faces
5041 ;; font-lock-constant-face
5043 cperl-hash-face)
5044 ps-italic-faces)
5045 ps-underlined-faces
5046 ;; font-lock-type-face
5048 cperl-hash-face
5049 underline
5050 cperl-nonoverridable-face)
5051 ps-underlined-faces))))
5056 "Pretty-print in CPerl style.
5057 If optional argument FILE is an empty string, prints to printer, otherwise
5058 to the file FILE. If FILE is nil, prompts for a file name.
5060 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
5064 "Print to file (if empty - to printer): "
5075 ;;; (defun cperl-ps-print-init ()
5076 ;;; "Initialization of `ps-print' components for faces used in CPerl."
5077 ;;; ;; Guard against old versions
5078 ;;; (defvar ps-underlined-faces nil)
5079 ;;; (defvar ps-bold-faces nil)
5080 ;;; (defvar ps-italic-faces nil)
5081 ;;; (setq ps-bold-faces
5082 ;;; (append '(font-lock-emphasized-face
5083 ;;; cperl-array-face
5084 ;;; font-lock-keyword-face
5085 ;;; font-lock-variable-name-face
5086 ;;; font-lock-constant-face
5087 ;;; font-lock-reference-face
5088 ;;; font-lock-other-emphasized-face
5089 ;;; cperl-hash-face)
5090 ;;; ps-bold-faces))
5091 ;;; (setq ps-italic-faces
5092 ;;; (append '(cperl-nonoverridable-face
5093 ;;; font-lock-constant-face
5094 ;;; font-lock-reference-face
5095 ;;; font-lock-other-emphasized-face
5096 ;;; cperl-hash-face)
5097 ;;; ps-italic-faces))
5098 ;;; (setq ps-underlined-faces
5099 ;;; (append '(font-lock-emphasized-face
5100 ;;; cperl-array-face
5101 ;;; font-lock-other-emphasized-face
5102 ;;; cperl-hash-face
5103 ;;; cperl-nonoverridable-face font-lock-type-face)
5104 ;;; ps-underlined-faces))
5105 ;;; (cons 'font-lock-type-face ps-underlined-faces))
5112 cperl-label-offset cperl-extra-newline-before-brace
5113 cperl-merge-trailing-else
5114 cperl-continued-statement-offset))
5146 ;;(cperl-extra-newline-before-brace . nil) ; ???
5154 ;;(cperl-extra-newline-before-brace . nil) ; ???
5170 ;;(cperl-extra-newline-before-brace . nil) ; ???
5172 "(Experimental) list of variables to set to get a particular indentation style.
5176 "Set CPerl mode variables to use one of several different indentation styles.
5177 The arguments are a string representing the desired style.
5178 The list of styles is in `cperl-style-alist', available styles
5179 are GNU, K&R, BSD, C++ and Whitesmith.
5181 The current value of style is memorized (unless there is a memorized
5182 data already), may be restored by `cperl-set-style-back'.
5185 side-effect of memorizing only."
5188 cperl-style-alist)))
5195 cperl-styles-entries)))
5202 "Restore a style memorised by `cperl-set-style'."
5218 ;; Returns buffer with documentation. Creates if missing.
5219 ;; If TYPE, this vars buffer.
5220 ;; Special care is taken to not stomp over an existing info buffer
5226 ;; Get Info running
5245 "Return the word at point or at P."
5252 find-tag-default-function)
5254 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
5255 ;; automatically used within `find-tag-default':
5259 "Show documentation for Perl command COMMAND in other window.
5260 If perl-info buffer is shown in some frame, uses this frame.
5261 Customized by setting variables `cperl-shrink-wrap-info-frame',
5262 `cperl-max-help-size'."
5267 default))))
5269 default
5270 read))))
5274 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
5275 max-height char-height buf-list)
5289 ;; Go back to beginning of the group (ex, for qq)
5293 ;; Get some of
5308 ;; Resize
5313 cperl-shrink-wrap-info-frame)
5317 pos
5322 max-height
5326 ;; Non-functioning under OS/2:
5328 ;; Title, menubar, + 2 for slack
5331 ;;(message "was %s doing %s" iniheight height)
5337 ;;(pop-to-buffer buffer)
5341 "Show documentation for Perl command at point in other window."
5358 imenu-create-index-function
5359 imenu-prev-index-position-function
5360 imenu-extract-index-name-function
5365 'imenu-default-create-index-function
5366 imenu-prev-index-position-function
5367 'cperl-imenu-info-imenu-search
5368 imenu-extract-index-name-function
5384 "Lineup construction in a region.
5385 Beginning of region should be at the start of a construction.
5386 All first occurrences of this construction in the lines that are
5387 partially contained in the region are lined up at the same column.
5389 MINSHIFT is the minimal amount of space to insert before the construction.
5390 STEP is the tabwidth to position constructions.
5391 If STEP is nil, `cperl-lineup-step' will be used
5392 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
5393 Will not move the position at the start to the left."
5443 "Run etags with appropriate options for Perl files.
5444 If optional argument ALL is `recursive', will process Perl files
5445 in subdirectories too."
5448 (args '("-l" "none" "-r" "/\\<\\(package\\|sub\\)[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([{#]\\|$\\)\\)/\\4/"))
5449 res)
5454 ;;(error "Not implemented: recursive")
5457 use File::Find;
5459 exec @ARGV;"
5463 ;;(error "Not implemented: all")
5465 "push @ARGV, <*.PL *.pl *.pm>;
5466 exec @ARGV;"
5476 "Toggle the state of `cperl-auto-newline'."
5483 "Toggle the state of automatic keyword expansion in CPerl mode."
5491 "Toggle the state of parentheses doubling in CPerl mode."
5498 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
5499 Delay of auto-help controlled by `cperl-lazy-help-time'."
5511 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
5515 nil
5520 ;;;; Tags file creation.
5532 ;; Do not introduce variable if not needed, we check it!
5540 ;; Search for the function
5543 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5544 nil t)
5568 ;; (beginning-of-line)
5572 index-alist))
5614 ;; After name now...
5620 lst))
5627 127
5631 1
5633 ","
5639 ;; Need to insert the name without package as well
5644 lst))))))
5648 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5657 ret))))
5660 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5661 Use as
5662 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5663 -f cperl-add-tags-recurse
5664 "
5668 "Add to TAGS file data for Perl files in the current directory and kids.
5669 Use as
5670 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5671 -f cperl-add-tags-recurse
5672 "
5676 ;; If INBUFFER, do not select buffer, and do not save
5677 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5686 xs rel tm)
5704 t)
5716 nil)
5722 files)))
5732 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5769 ;; Suppose we are in a tag table cooked by cperl.
5778 "\C-?"
5780 "\C-a"
5782 ","
5787 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5792 ;; Moves to beginning of the next line:
5794 ;; Move back
5796 ;; Make new member of hierarchy name ==> file ==> pos if needed
5798 ;; Name known
5801 ;; First occurrence of the name, start alist
5811 "Show hierarchical menu of classes and methods.
5812 Finds info about classes by a scan of loaded TAGS files.
5813 Supposes that the TAGS files contain fully qualified function names.
5814 One may build such TAGS files from CPerl mode menu."
5821 ;; Only in one file
5823 pack name cons1 to l1 l2 l3 l4 b)
5824 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5829 ;; Does this work in XEmacs?
5842 tags-table-list)
5852 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5853 ))
5857 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
5861 window-system)
5875 ;; cadr of `to' is read-write. On start it is a cons
5877 'identity
5883 l1 head tail cons1 cons2 ord writeto packs recurse
5884 root-packages root-functions ms many_ms same_name ps
5893 recurse t)
5895 ;; Need to init new head
5916 ;;Now clean up leaders with one child only
5923 ;; Sort the roots of subtrees
5927 ;; Now add back functions removed from display
5933 root-functions))
5934 ;; Now add back packages removed from display
5942 root-packages))))
5944 ;;;(x-popup-menu t
5945 ;;; '(keymap "Name1"
5946 ;;; ("Ret1" "aa")
5947 ;;; ("Head1" "ab"
5948 ;;; keymap "Name2"
5949 ;;; ("Tail1" "x") ("Tail2" "y"))))
5963 list1)
5968 list1)))))
5986 \f
5996 'identity
6012 "||"
6013 "&&"
6016 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
6017 ;;"[*/+-|&<.]+="
6018 )
6020 "If matches at the start of match found by `my-bad-c-style-regexp',
6026 "Find places in the buffer where insertion of a whitespace may help.
6027 Prompts user for insertion of spaces.
6028 Currently it is tuned to C and Perl syntax."
6036 'cperl-next-bad-style
6052 t)
6065 ;; Check for a < -b and friends
6070 ;; Now check for syntax type
6079 found-bad found)))
6082 \f
6083 ;;; Getting help
6085 ;;(concat "\\("
6087 'identity
6096 "x="
6098 ;;"\\)\\|\\("
6100 ;;"\\)"
6101 ;;)
6108 ;; Does not save-excursion
6109 ;; Get to the something meaningful
6114 ;; (cond
6115 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
6116 ;; (skip-chars-backward " \n\t\r({[]});,")
6117 ;; (or (bobp) (backward-char 1))))
6118 ;; Try to backtrace
6159 "Get one-line docs on the symbol at the point.
6160 The data for these docs is a little bit obsolete and may be in fact longer
6161 than a line. Your contribution to update/shorten it is appreciated."
6173 nil
6179 ;;; Stolen from perl-descr.el by Johan Vromans:
6185 "Display the documentation of symbol at point, a Perl operator."
6187 args-file regexp)
6210 ;; get the buffer with the documentation text
6213 ;; lookup in the doc
6227 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
6228 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
6229 ... Range (list context); flip/flop [no flop when flip] (scalar context).
6230 ! ... Logical negation.
6231 ... != ... Numeric inequality.
6232 ... !~ ... Search pattern, substitution, or translation (negated).
6233 $! In numeric context: errno. In a string context: error string.
6235 $# The output format for printed numbers. Default is %.15g or close.
6236 $$ Process number of this script. Changes in the fork()ed child process.
6237 $% The current page number of the currently selected output channel.
6239 The following variables are always local to the current block:
6241 $1 Match of the 1st set of parentheses in the last match (auto-local).
6242 $2 Match of the 2nd set of parentheses in the last match (auto-local).
6243 $3 Match of the 3rd set of parentheses in the last match (auto-local).
6244 $4 Match of the 4th set of parentheses in the last match (auto-local).
6245 $5 Match of the 5th set of parentheses in the last match (auto-local).
6246 $6 Match of the 6th set of parentheses in the last match (auto-local).
6247 $7 Match of the 7th set of parentheses in the last match (auto-local).
6248 $8 Match of the 8th set of parentheses in the last match (auto-local).
6249 $9 Match of the 9th set of parentheses in the last match (auto-local).
6250 $& The string matched by the last pattern match (auto-local).
6251 $' The string after what was matched by the last match (auto-local).
6252 $` The string before what was matched by the last match (auto-local).
6254 $( The real gid of this process.
6255 $) The effective gid of this process.
6256 $* Deprecated: Set to 1 to do multiline matching within a string.
6257 $+ The last bracket matched by the last search pattern.
6258 $, The output field separator for the print operator.
6259 $- The number of lines left on the page.
6260 $. The current input line number of the last filehandle that was read.
6261 $/ The input record separator, newline by default.
6262 $0 Name of the file containing the current perl script (read/write).
6263 $: String may be broken after these characters to fill ^-lines in a format.
6265 $< The real uid of this process.
6266 $= The page length of the current output channel. Default is 60 lines.
6267 $> The effective uid of this process.
6268 $? The status returned by the last ``, pipe close or `system'.
6269 $@ The perl error message from the last eval or do @var{EXPR} command.
6270 $ARGV The name of the current file used with <> .
6271 $[ Deprecated: The index of the first element/char in an array/string.
6273 $] The perl version string as displayed with perl -v.
6274 $^ The name of the current top-of-page format.
6275 $^A The current value of the write() accumulator for format() lines.
6276 $^D The value of the perl debug (-D) flags.
6277 $^E Information about the last system error other than that provided by $!.
6278 $^F The highest system file descriptor, ordinarily 2.
6279 $^H The current set of syntax checks enabled by `use strict'.
6280 $^I The value of the in-place edit extension (perl -i option).
6282 $^M A buffer for emergency memory allocation when running out of memory.
6283 $^O The operating system name under which this copy of Perl was built.
6284 $^P Internal debugging flag.
6285 $^T The time the script was started. Used by -A/-M/-C file tests.
6286 $^W True if warnings are requested (perl -w flag).
6287 $^X The name under which perl was invoked (argv[0] in C-speech).
6288 $_ The default input and pattern-searching space.
6289 $| Auto-flush after write/print on current output channel? Default 0.
6290 $~ The name of the current report format.
6291 ... % ... Modulo division.
6292 ... %= ... Modulo division assignment.
6293 %ENV Contains the current environment.
6294 %INC List of files that have been require-d or do-ne.
6295 %SIG Used to set signal handlers for various signals.
6296 ... & ... Bitwise and.
6297 ... && ... Logical and.
6298 ... &&= ... Logical and assignment.
6299 ... &= ... Bitwise and assignment.
6300 ... * ... Multiplication.
6301 ... ** ... Exponentiation.
6302 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6303 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
6304 ... + ... Addition. +EXPR Makes EXPR into scalar context.
6305 ++ Auto-increment (magical on strings). ++EXPR EXPR++
6306 ... += ... Addition assignment.
6307 , Comma operator.
6308 ... - ... Subtraction.
6309 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6310 ... -= ... Subtraction assignment.
6311 -A Access time in days since script started.
6312 -B File is a non-text (binary) file.
6313 -C Inode change time in days since script started.
6314 -M Age in days since script started.
6315 -O File is owned by real uid.
6316 -R File is readable by real uid.
6317 -S File is a socket .
6318 -T File is a text file.
6319 -W File is writable by real uid.
6320 -X File is executable by real uid.
6321 -b File is a block special file.
6322 -c File is a character special file.
6323 -d File is a directory.
6324 -e File exists .
6325 -f File is a plain file.
6326 -g File has setgid bit set.
6327 -k File has sticky bit set.
6328 -l File is a symbolic link.
6329 -o File is owned by effective uid.
6330 -p File is a named pipe (FIFO).
6331 -r File is readable by effective uid.
6332 -s File has non-zero size.
6333 -t Tests if filehandle (STDIN by default) is opened to a tty.
6334 -u File has setuid bit set.
6335 -w File is writable by effective uid.
6336 -x File is executable by effective uid.
6337 -z File has zero size.
6338 . Concatenate strings.
6339 .. Range (list context); flip/flop (scalar context) operator.
6340 .= Concatenate assignment strings
6341 ... / ... Division. /PATTERN/ioxsmg Pattern match
6342 ... /= ... Division assignment.
6343 /PATTERN/ioxsmg Pattern match.
6344 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6345 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6346 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6347 <> Reads line from union of files in @ARGV (= command line) and STDIN.
6348 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6349 ... <= ... Numeric less than or equal to.
6350 ... <=> ... Numeric compare.
6351 ... = ... Assignment.
6352 ... == ... Numeric equality.
6353 ... =~ ... Search pattern, substitution, or translation
6354 ... > ... Numeric greater than.
6355 ... >= ... Numeric greater than or equal to.
6356 ... >> ... Bitwise shift right.
6357 ... >>= ... Bitwise shift right assignment.
6358 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6359 ?PATTERN? One-time pattern match.
6360 @ARGV Command line arguments (not including the command name - see $0).
6361 @INC List of places to look for perl scripts during do/include/use.
6362 @_ Parameter array for subroutines; result of split() unless in list context.
6380 ... ^ ... Bitwise exclusive or.
6381 __END__ Ends program source.
6382 __DATA__ Ends program source.
6383 __FILE__ Current (source) filename.
6384 __LINE__ Current line in current source.
6385 __PACKAGE__ Current package.
6386 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6387 ARGVOUT Output filehandle with -i flag.
6388 BEGIN { ... } Immediately executed (during compilation) piece of code.
6389 END { ... } Pseudo-subroutine executed after the script finishes.
6390 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
6391 INIT { ... } Pseudo-subroutine executed before the script starts running.
6392 DATA Input filehandle for what follows after __END__ or __DATA__.
6393 accept(NEWSOCKET,GENERICSOCKET)
6394 alarm(SECONDS)
6395 atan2(X,Y)
6396 bind(SOCKET,NAME)
6397 binmode(FILEHANDLE)
6398 caller[(LEVEL)]
6399 chdir(EXPR)
6400 chmod(LIST)
6401 chop[(LIST|VAR)]
6402 chown(LIST)
6403 chroot(FILENAME)
6404 close(FILEHANDLE)
6405 closedir(DIRHANDLE)
6406 ... cmp ... String compare.
6407 connect(SOCKET,NAME)
6408 continue of { block } continue { block }. Is executed after `next' or at end.
6409 cos(EXPR)
6410 crypt(PLAINTEXT,SALT)
6411 dbmclose(%HASH)
6412 dbmopen(%HASH,DBNAME,MODE)
6413 defined(EXPR)
6414 delete($HASH{KEY})
6415 die(LIST)
6416 do { ... }|SUBR while|until EXPR executes at least once
6417 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6418 dump LABEL
6419 each(%HASH)
6420 endgrent
6421 endhostent
6422 endnetent
6423 endprotoent
6424 endpwent
6425 endservent
6426 eof[([FILEHANDLE])]
6427 ... eq ... String equality.
6428 eval(EXPR) or eval { BLOCK }
6429 exec(LIST)
6430 exit(EXPR)
6431 exp(EXPR)
6432 fcntl(FILEHANDLE,FUNCTION,SCALAR)
6433 fileno(FILEHANDLE)
6434 flock(FILEHANDLE,OPERATION)
6435 for (EXPR;EXPR;EXPR) { ... }
6436 foreach [VAR] (@ARRAY) { ... }
6437 fork
6438 ... ge ... String greater than or equal.
6439 getc[(FILEHANDLE)]
6440 getgrent
6441 getgrgid(GID)
6442 getgrnam(NAME)
6443 gethostbyaddr(ADDR,ADDRTYPE)
6444 gethostbyname(NAME)
6445 gethostent
6446 getlogin
6447 getnetbyaddr(ADDR,ADDRTYPE)
6448 getnetbyname(NAME)
6449 getnetent
6450 getpeername(SOCKET)
6451 getpgrp(PID)
6452 getppid
6453 getpriority(WHICH,WHO)
6454 getprotobyname(NAME)
6455 getprotobynumber(NUMBER)
6456 getprotoent
6457 getpwent
6458 getpwnam(NAME)
6459 getpwuid(UID)
6460 getservbyname(NAME,PROTO)
6461 getservbyport(PORT,PROTO)
6462 getservent
6463 getsockname(SOCKET)
6464 getsockopt(SOCKET,LEVEL,OPTNAME)
6465 gmtime(EXPR)
6466 goto LABEL
6467 ... gt ... String greater than.
6468 hex(EXPR)
6469 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6470 index(STR,SUBSTR[,OFFSET])
6471 int(EXPR)
6472 ioctl(FILEHANDLE,FUNCTION,SCALAR)
6473 join(EXPR,LIST)
6474 keys(%HASH)
6475 kill(LIST)
6476 last [LABEL]
6477 ... le ... String less than or equal.
6478 length(EXPR)
6479 link(OLDFILE,NEWFILE)
6480 listen(SOCKET,QUEUESIZE)
6481 local(LIST)
6482 localtime(EXPR)
6483 log(EXPR)
6484 lstat(EXPR|FILEHANDLE|VAR)
6485 ... lt ... String less than.
6486 m/PATTERN/iogsmx
6487 mkdir(FILENAME,MODE)
6488 msgctl(ID,CMD,ARG)
6489 msgget(KEY,FLAGS)
6490 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6491 msgsnd(ID,MSG,FLAGS)
6492 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6493 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
6494 ... ne ... String inequality.
6495 next [LABEL]
6496 oct(EXPR)
6497 open(FILEHANDLE[,EXPR])
6498 opendir(DIRHANDLE,EXPR)
6499 ord(EXPR) ASCII value of the first char of the string.
6500 pack(TEMPLATE,LIST)
6501 package NAME Introduces package context.
6502 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6503 pop(ARRAY)
6504 print [FILEHANDLE] [(LIST)]
6505 printf [FILEHANDLE] (FORMAT,LIST)
6506 push(ARRAY,LIST)
6507 q/STRING/ Synonym for 'STRING'
6509 qx/STRING/ Synonym for `STRING`
6510 rand[(EXPR)]
6511 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6512 readdir(DIRHANDLE)
6513 readlink(EXPR)
6514 recv(SOCKET,SCALAR,LEN,FLAGS)
6515 redo [LABEL]
6516 rename(OLDNAME,NEWNAME)
6517 require [FILENAME | PERL_VERSION]
6518 reset[(EXPR)]
6519 return(LIST)
6520 reverse(LIST)
6521 rewinddir(DIRHANDLE)
6522 rindex(STR,SUBSTR[,OFFSET])
6523 rmdir(FILENAME)
6524 s/PATTERN/REPLACEMENT/gieoxsm
6525 scalar(EXPR)
6526 seek(FILEHANDLE,POSITION,WHENCE)
6527 seekdir(DIRHANDLE,POS)
6528 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6529 semctl(ID,SEMNUM,CMD,ARG)
6530 semget(KEY,NSEMS,SIZE,FLAGS)
6531 semop(KEY,...)
6532 send(SOCKET,MSG,FLAGS[,TO])
6533 setgrent
6534 sethostent(STAYOPEN)
6535 setnetent(STAYOPEN)
6536 setpgrp(PID,PGRP)
6537 setpriority(WHICH,WHO,PRIORITY)
6538 setprotoent(STAYOPEN)
6539 setpwent
6540 setservent(STAYOPEN)
6541 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6542 shift[(ARRAY)]
6543 shmctl(ID,CMD,ARG)
6544 shmget(KEY,SIZE,FLAGS)
6545 shmread(ID,VAR,POS,SIZE)
6546 shmwrite(ID,STRING,POS,SIZE)
6547 shutdown(SOCKET,HOW)
6548 sin(EXPR)
6549 sleep[(EXPR)]
6550 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6551 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6552 sort [SUBROUTINE] (LIST)
6553 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6554 split[(/PATTERN/[,EXPR[,LIMIT]])]
6555 sprintf(FORMAT,LIST)
6556 sqrt(EXPR)
6557 srand(EXPR)
6558 stat(EXPR|FILEHANDLE|VAR)
6559 study[(SCALAR)]
6560 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6561 substr(EXPR,OFFSET[,LEN])
6562 symlink(OLDFILE,NEWFILE)
6563 syscall(LIST)
6564 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6565 system(LIST)
6566 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6567 tell[(FILEHANDLE)]
6568 telldir(DIRHANDLE)
6569 time
6570 times
6571 tr/SEARCHLIST/REPLACEMENTLIST/cds
6572 truncate(FILE|EXPR,LENGTH)
6573 umask[(EXPR)]
6574 undef[(EXPR)]
6575 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6576 unlink(LIST)
6577 unpack(TEMPLATE,EXPR)
6578 unshift(ARRAY,LIST)
6579 until (EXPR) { ... } EXPR until EXPR
6580 utime(LIST)
6581 values(%HASH)
6582 vec(EXPR,OFFSET,BITS)
6583 wait
6584 waitpid(PID,FLAGS)
6585 wantarray Returns true if the sub/eval is called in list context.
6586 warn(LIST)
6587 while (EXPR) { ... } EXPR while EXPR
6588 write[(EXPR|FILEHANDLE)]
6589 ... x ... Repeat string or array.
6590 x= ... Repetition assignment.
6591 y/SEARCHLIST/REPLACEMENTLIST/
6592 ... | ... Bitwise or.
6593 ... || ... Logical or.
6594 ~ ... Unary bitwise complement.
6595 #! OS interpreter indicator. If contains `perl', used for options, and -x.
6596 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6597 CORE:: Prefix to access builtin function if imported sub obscures it.
6598 SUPER:: Prefix to lookup for a method in @ISA classes.
6599 DESTROY Shorthand for `sub DESTROY {...}'.
6600 ... EQ ... Obsolete synonym of `eq'.
6601 ... GE ... Obsolete synonym of `ge'.
6602 ... GT ... Obsolete synonym of `gt'.
6603 ... LE ... Obsolete synonym of `le'.
6604 ... LT ... Obsolete synonym of `lt'.
6605 ... NE ... Obsolete synonym of `ne'.
6606 abs [ EXPR ] absolute value
6607 ... and ... Low-precedence synonym for &&.
6608 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6609 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6610 chr Converts a number to char with the same ordinal.
6611 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6612 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6613 exists $HASH{KEY} True if the key exists.
6614 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6616 glob EXPR Synonym of <EXPR>.
6617 lc [ EXPR ] Returns lowercased EXPR.
6618 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
6619 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
6620 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6621 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6622 not ... Low-precedence synonym for ! - negation.
6623 ... or ... Low-precedence synonym for ||.
6625 quotemeta [ EXPR ] Quote regexp metacharacters.
6626 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6627 readline FH Synonym of <FH>.
6628 readpipe CMD Synonym of `CMD`.
6629 ref [ EXPR ] Type of EXPR when dereferenced.
6630 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6631 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6632 tied Returns internal object for a tied data.
6633 uc [ EXPR ] Returns upcased EXPR.
6634 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6635 untie VAR Unlink an object from a simple Perl variable.
6636 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6637 ... xor ... Low-precedence synonym for exclusive or.
6638 prototype \&SUB Returns prototype of the function given a reference.
6639 =head1 Top-level heading.
6640 =head2 Second-level heading.
6641 =head3 Third-level heading (is there such?).
6642 =over [ NUMBER ] Start list.
6643 =item [ TITLE ] Start new item in the list.
6644 =back End list.
6645 =cut Switch from POD to Perl.
6646 =pod Switch from Perl to POD.
6650 "Go to the perl documentation buffer and insert the documentation."
6663 ;; b is before the starting delimiter, e before the ending
6664 ;; e should be a marker, may be changed, but remains "correct".
6665 ;; EMBED is nil iff we process the whole REx.
6666 ;; The REx is guarantied to have //x
6667 ;; LEVEL shows how many levels deep to go
6668 ;; position at enter and at leave is not defined
6702 inline t)
6707 inline
6713 "[$^]"
6735 ;; XXXX POSIX classes?!
6760 ;; (or (forward-sexp 1)
6761 ;; (progn
6762 ;; (goto-char tmp)
6763 ;; (error "()-group not terminated")))
6768 ;; In fact does not make a lot of sense, since
6769 ;; the starting position can be already lost due
6770 ;; to insertion of "\n" and " "
6779 t)
6815 ;; first at line
6835 ;; Special-case the last line of group
6846 ;; Returns position of the start
6847 ;; XXX this is called too often! Need to cache the result!
6851 ;; Find the start
6853 nil ; good already
6857 ;;(forward-char 1)
6869 ;; Protect fragile " ", "#"
6872 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
6876 b)))
6879 "Do it. (Experimental, may change semantics, recheck the result.)
6880 We suppose that the regexp is scanned already."
6891 "Goto start of an enclosing group in regexp.
6892 We suppose that the regexp is scanned already."
6906 "Find an enclosing group in regexp and contract it.
6907 \(Experimental, may change semantics, recheck the result.)
6908 We suppose that the regexp is scanned already."
6910 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
6930 "Find an enclosing group in regexp and contract all the kids.
6931 \(Experimental, may change semantics, recheck the result.)
6932 We suppose that the regexp is scanned already."
6946 nil)
6951 "Find an enclosing group in regexp and beautify it.
6952 \(Experimental, may change semantics, recheck the result.)
6953 We suppose that the regexp is scanned already."
6964 "Change `if (A) {B}' into `B if A;' etc if possible."
6970 pos2 pos3 pos4 pos5 s1 s2 state p pos45
6983 ;; XXXX In fact may be `A if (B); {C}' ...
7003 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
7012 ;; Finally got it
7049 ;;; By Anthony Foiani <afoiani@uswest.com>
7050 ;;; Getting help on modules in C-h f ?
7051 ;;; This is a modified version of `man'.
7052 ;;; Need to teach it how to lookup functions
7054 "Run `perldoc' on WORD."
7060 ""
7065 default-entry)
7066 input))))
7073 'cperl-short-docs
7085 "Run a `perldoc' on the word around point."
7090 "*File name for `pod2man'."
7094 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
7096 "Create a virtual manpage in Emacs from the Perl Online Documentation."
7105 ;; Prevent any attempt to use display terminal fanciness.
7112 ;;; Updated version by him too
7114 "Create a virtual manpage in Emacs from the POD in the file."
7126 "Builds the entire background manpage and cleaning command."
7137 phrase)
7140 command))
7154 "Switches on Auto-Help on Perl constructs (put in the message area).
7155 Delay of auto-help controlled by `cperl-lazy-help-time'."
7164 t
7169 "Switches off Auto-Help on Perl constructs (put in the message area).
7170 Delay of auto-help controlled by `cperl-lazy-help-time'."
7187 ;;; Plug for wrong font-lock:
7190 ;; Simplified now that font-lock-unfontify-region uses save-buffer-state.
7196 ;; Some vars for debugging only
7197 ;; (message "Syntaxifying...")
7200 start)
7209 ;; Need to forget what is after `start'
7211 ;; Fontification without a change
7218 dbg iend
7219 start end cperl-syntax-done-to
7234 cperl-syntaxify-by-font-lock
7250 ;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
7251 ;;; cperl-mode.el ends here