| blob | c6721524a51eb25ca4bf35b18af75bb0fb015846 |
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, 2003
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 to highlight array names."
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} (legal 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)
943 'fontified
948 ;; If POST, do not do it with postponed fontification
950 nil
952 to cperl-do-not-fontify t)))
955 "Hook run by CPerl mode."
963 \f
964 ;; Make customization possible "in reverse"
970 \f
971 ;;; Probably it is too late to set these guys already, but it can help later:
973 ;;;(and cperl-clobber-mode-lists
974 ;;;(setq auto-mode-alist
975 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
976 ;;;(and (boundp 'interpreter-mode-alist)
977 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
978 ;;; '(("miniperl" . perl-mode))))))
990 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
991 ;; macros instead of defsubsts don't work on Emacs, so we do the
992 ;; expansion manually. Any other suggestions?
1025 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1026 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1029 ;; don't clobber the backspace binding:
1035 ;;(concat (char-to-string help-char) "f") ; does not work
1036 'cperl-info-on-command
1039 ;;(concat (char-to-string help-char) "v") ; does not work
1040 'cperl-get-help
1043 ;;(concat (char-to-string help-char) "f") ; does not work
1047 ;;(concat (char-to-string help-char) "v") ; does not work
1053 ;;(concat (char-to-string help-char) "v") ; does not work
1054 'cperl-get-help
1059 ;; substitute-key-definition is usefulness-deenhanced...
1065 cperl-mode-map global-map)
1068 cperl-mode-map global-map)
1071 cperl-mode-map global-map)
1074 cperl-mode-map global-map)))
1083 cperl-menu cperl-mode-map "Menu for CPerl mode"
1090 "----"
1095 cperl-use-syntax-table-text-property]
1097 cperl-use-syntax-table-text-property]
1099 cperl-use-syntax-table-text-property]
1101 cperl-use-syntax-table-text-property]
1103 cperl-use-syntax-table-text-property]
1105 cperl-use-syntax-table-text-property])
1107 "----"
1111 "----"
1117 "----"
1119 "----"
1124 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1129 ;;; ["Create tags for current file" cperl-etags t]
1130 ;;; ["Add tags for current file" (cperl-etags t) t]
1131 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1132 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1133 ;;; ["Create tags for Perl files in (sub)directories"
1134 ;;; (cperl-etags nil 'recursive) t]
1135 ;;; ["Add tags for Perl files in (sub)directories"
1136 ;;; (cperl-etags t 'recursive) t])
1137 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1162 cperl-lazy-installed)])
1193 "Display the result of expanding all C macros occurring in the region.
1194 The expansion is entirely correct because it uses the C preprocessor."
1195 t)
1215 ()
1241 \f
1243 ;; Fix for msb.el
1247 ;;;###autoload
1249 "Major mode for editing Perl code.
1250 Expression and list commands understand all C brackets.
1251 Tab indents for Perl code.
1252 Paragraphs are separated by blank lines only.
1253 Delete converts tabs to spaces as it moves back.
1255 Various characters in Perl almost always come in pairs: {}, (), [],
1256 sometimes <>. When the user types the first, she gets the second as
1257 well, with optional special formatting done on {}. (Disabled by
1261 whether you want to type pair <>, and inserts is if it
1262 appropriate. You can set `cperl-electric-parens-string' to the string that
1263 contains the parenths from the above list you want to be electrical.
1264 Electricity of parenths is controlled by `cperl-electric-parens'.
1265 You may also set `cperl-electric-parens-mark' to have electric parens
1268 CPerl mode provides expansion of the Perl control constructs:
1270 if, else, elsif, unless, while, until, continue, do,
1271 for, foreach, formy and foreachmy.
1273 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1275 The user types the keyword immediately followed by a space, which
1276 causes the construct to be expanded, and the point is positioned where
1277 she is most likely to want to be. eg. when the user types a space
1279 } { } and the cursor is between the parentheses. The user can then
1280 type some boolean expression within the parens. Having done that,
1283 directive line, then appropriate number of new lines is inserted).
1287 bite if angry;
1289 it will not do any expansion. See also help on variable
1290 `cperl-extra-newline-before-brace'. (Note that one can switch the
1291 help message on expansion by setting `cperl-message-electric-keyword'
1292 to nil.)
1295 return. It places you in the next line with proper indentation, or if
1296 you type it inside the inline block of control construct, like
1298 foreach (@lines) {print; print}
1300 and you are on a boundary of a statement inside braces, it will
1301 transform the construct into a multiline and will place you into an
1302 appropriately indented blank line. If you need a usual
1304 see documentation on `cperl-electric-linefeed'.
1308 if (A) { B }
1310 into
1312 B if A;
1316 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1317 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1318 on electric space between $ and {, `cperl-electric-parens-string' is
1319 the string that contains parentheses that should be electric in CPerl
1320 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1321 setting `cperl-electric-keywords' enables electric expansion of
1322 control structures in CPerl. `cperl-electric-linefeed' governs which
1323 one of two linefeed behavior is preferable. You can enable all these
1324 options simultaneously (recommended mode of use) by setting
1325 `cperl-hairy' to t. In this case you can switch separate options off
1326 by setting them to `null'. Note that one may undo the extra
1327 whitespace inserted by semis and braces in `auto-newline'-mode by
1330 If your site has perl5 documentation in info format, you can use commands
1332 These keys run commands `cperl-info-on-current-command' and
1333 `cperl-info-on-command', which one is which is controlled by variable
1334 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1335 \(in turn affected by `cperl-hairy').
1337 Even if you have no info-format documentation, short one-liner-style
1339 man via menu.
1341 It is possible to show this help automatically after some idle time.
1342 This is regulated by variable `cperl-lazy-help-time'. Default with
1343 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1344 secs idle time . It is also possible to switch this on/off from the
1348 beginning of the region at the start of construction, and make region
1349 span the needed amount of lines.
1351 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1352 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1353 here-docs sections. With capable Emaxen results of scan are used
1354 for indentation too, otherwise they are used for highlighting only.
1356 Variables controlling indentation style:
1357 `cperl-tab-always-indent'
1358 Non-nil means TAB in CPerl mode should always reindent the current line,
1359 regardless of where in the line point is when the TAB command is used.
1360 `cperl-indent-left-aligned-comments'
1361 Non-nil means that the comment starting in leftmost column should indent.
1362 `cperl-auto-newline'
1363 Non-nil means automatically newline before and after braces,
1364 and after colons and semicolons, inserted in Perl code. The following
1366 Insertion after colons requires both this variable and
1367 `cperl-auto-newline-after-colon' set.
1368 `cperl-auto-newline-after-colon'
1369 Non-nil means automatically newline even after colons.
1370 Subject to `cperl-auto-newline' setting.
1371 `cperl-indent-level'
1372 Indentation of Perl statements within surrounding block.
1373 The surrounding block's indentation is the indentation
1374 of the line on which the open-brace appears.
1375 `cperl-continued-statement-offset'
1376 Extra indentation given to a substatement, such as the
1377 then-clause of an if, or body of a while, or just a statement continuation.
1378 `cperl-continued-brace-offset'
1379 Extra indentation given to a brace that starts a substatement.
1380 This is in addition to `cperl-continued-statement-offset'.
1381 `cperl-brace-offset'
1382 Extra indentation for line if it starts with an open brace.
1383 `cperl-brace-imaginary-offset'
1384 An open brace following other text is treated as if it the line started
1385 this far to the right of the actual line indentation.
1386 `cperl-label-offset'
1387 Extra indentation for line that is a label.
1388 `cperl-min-label-indent'
1389 Minimal indentation for line that is a label.
1391 Settings for K&R and BSD indentation styles are
1392 `cperl-indent-level' 5 8
1393 `cperl-continued-statement-offset' 5 8
1394 `cperl-brace-offset' -5 -8
1395 `cperl-label-offset' -5 -8
1397 CPerl knows several indentation styles, and may bulk set the
1400 \(both available from menu).
1402 If `cperl-indent-level' is 0, the statement after opening brace in
1403 column 0 is indented on
1404 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1406 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1407 with no args.
1409 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1410 or as help on variables `cperl-tips', `cperl-problems',
1411 `cperl-praise', `cperl-speed'."
1423 ;; don't clobber the backspace binding:
1457 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1480 (setq defun-prompt-regexp "^[ \t]*sub[ \t]+\\([^ \t\n{(;]+\\)\\([ \t]*([^()]*)[ \t]*\\)?[ \t]*")
1487 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1502 cperl-font-lock-keywords-1
1503 cperl-font-lock-keywords-2)))
1506 cperl-load-font-lock-keywords-1
1507 cperl-load-font-lock-keywords-2)))))
1512 ;; Do not introduce variable if not needed, we check it!
1514 ;; Fix broken font-lock:
1522 ;; Another bug: unless font-lock-syntactic-keywords, font-lock
1523 ;; ignores syntax-table text-property. (t) is a hack
1524 ;; to make font-lock think that font-lock-syntactic-keywords
1525 ;; are defined
1553 ;; After hooks since fontification will break this
1558 \f
1559 ;; Fix for perldb - make default reasonable
1567 ;; I have problems
1568 ;; in OS/2
1569 ;; otherwise
1571 nil nil
1573 \f
1575 ;; Adds perl files to msb menu, supposes that msb is already loaded
1584 handle
1586 last))))
1587 \f
1588 ;; This is used by indent-for-comment
1589 ;; to decide how much to indent a comment in CPerl code
1590 ;; based on its context. Do fallback if comment is found wrong.
1604 ;; Wrong comment found
1608 cperl-st-cfence))
1619 comment-column))
1627 ;;;(defun cperl-comment-indent-fallback ()
1628 ;;; "Is called if the standard comment-search procedure fails.
1629 ;;;Point is at start of real comment."
1630 ;;; (let ((c (current-column)) target cnt prevc)
1631 ;;; (if (= c comment-column) nil
1632 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1633 ;;; (setq target (max (1+ (setq prevc
1634 ;;; (current-column))) ; Else indent at comment column
1635 ;;; comment-column))
1636 ;;; (if (= c comment-column) nil
1637 ;;; (delete-backward-char cnt)
1638 ;;; (while (< prevc target)
1639 ;;; (insert "\t")
1640 ;;; (setq prevc (current-column)))
1641 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1642 ;;; (while (< prevc target)
1643 ;;; (insert " ")
1644 ;;; (setq prevc (current-column)))))))
1647 "Substitute for `indent-for-comment' in CPerl."
1656 "Comment or uncomment each line in the region in CPerl mode.
1657 See `comment-region'."
1663 "Uncomment or comment each line in the region in CPerl mode.
1664 See `comment-region'."
1672 "Insert character and correct line's indentation.
1673 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
1676 `cperl-extra-newline-before-brace'."
1683 nil)))
1688 ;; Need to insert a matching pair
1696 ;; Check whether we close something "usual" with `}'
1702 ;;(cperl-after-block-p (point-min))
1704 ;; after sub, else, continue
1707 ;; Just insert the guy
1716 ;; if after ")" and `cperl-extra-newline-before-brace'
1717 ;; is nil, do not insert extra newline.
1746 "Insert character, correct line's indentation, correct quoting by space."
1757 nil)))
1758 pos after)
1765 ;; Check whether we are in comment
1771 nil
1779 t)
1785 "Insert an opening parenthesis or a matching pair of parentheses.
1786 See `cperl-electric-parens'."
1795 nil)))
1800 ;;(not (save-excursion (search-backward "#" beg t)))
1820 "Insert a matching pair of parentheses if marking is active.
1821 If not, or if we are not at the end of marking range, would self-insert.
1822 Affected by `cperl-electric-parens'."
1832 nil))
1833 p)
1838 ;;(not (save-excursion (search-backward "#" beg t)))
1839 )
1854 "Insert a construction appropriate after a keyword.
1855 Help message may be switched off by setting `cperl-message-electric-keyword'
1856 to nil."
1862 my do)
1874 beg t)))
1891 delete
1895 ;;(insert " () {\n}")
1924 "Make sure there are N newlines after the point."
1934 "Insert a POD chunk appropriate after a =POD directive."
1937 head1 notlast name p really-delete over)
1952 ;; "\\(\\`\n?\\|\n\n\\)=\\sw+"
2002 "Insert a construction appropriate after a keyword.
2003 Help message may be switched off by setting `cperl-message-electric-keyword'
2004 to nil."
2013 beg t)))
2022 ;;(insert " {\n\n}")
2041 "Go to end of line, open a new line and indent appropriately.
2042 If in POD, insert appropriate lines."
2048 ; i.e., on a boundary and inside "{...}"
2060 ; Leave the level of parens
2062 ; Are at end
2068 ; start of parens group.
2078 ; before, move it to separate line
2087 ; after, move it to separate line
2106 ; with an extra newline.
2111 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2112 ;; We are after \n now, so look for the rest
2117 t)))
2133 res))
2134 nil
2147 "Insert character and correct line's indentation."
2156 "Insert character and correct line's indentation."
2161 cperl-auto-newline-after-colon)))
2162 insertpos)
2169 ;; Ignore in comment lines
2171 ;; Colon is special only after a label
2172 ;; So quickly rule out most other uses of colon
2173 ;; and do no indentation for them.
2187 ;;(forward-char -1)
2189 ;;(forward-char 1)
2206 "Backspace, or remove the whitespace around the point inserted by an electric
2207 key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2211 cperl-electric-terminator
2212 cperl-electric-lbrace))
2221 ;; We are removing the whitespace *inside* cperl-electric-else
2246 \f
2248 "Indent current line as Perl code, or in some cases insert a tab character.
2249 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2250 line. Otherwise, indent the current line only if point is at the left margin
2251 or in the line's indentation; otherwise insert a tab.
2253 A numeric argument, regardless of its value,
2254 means indent rigidly all the lines of the expression starting after point
2255 so that this line becomes properly indented.
2256 The relative indentation among the lines of the expression are preserved."
2260 ;; If arg, always indent this line as Perl
2261 ;; and shift remaining lines of expression the same amount.
2263 beg end)
2283 "Indent current line as Perl code.
2284 Return the amount the indentation changed by."
2287 indent i beg shift-amt)
2289 i indent)
2294 ;;((eq indent t) ; Never?
2295 ;; (setq indent (cperl-calculate-indent-within-comment)))
2296 ;;((looking-at "[ \t]*#")
2297 ;; (setq indent 0))
2319 ;; If initial point was within line's indentation,
2320 ;; position after the indentation. Else stay at same point in text.
2323 shift-amt))
2326 ;; Returns true if the point is after label. Does not do save-excursion.
2335 ;; returns list (START STATE DEPTH PRESTART),
2336 ;; START is a good place to start parsing, or equal to
2337 ;; PARSE-START if preset,
2338 ;; STATE is what is returned by `parse-partial-sexp'.
2339 ;; DEPTH is true is we are immediately after end of block
2340 ;; which contains START.
2341 ;; PRESTART is the position basing on which START was found.
2351 ;; Try to go out, if sub is not on the outermost level
2356 ;; The current line could start like }}}, so the indentation
2357 ;; corresponds to a different level than what we reached
2366 ;; Positions is before ?\{. Checks whether it starts a block.
2367 ;; No save-excursion!
2370 ; Label may be mixed up with `$blah :'
2375 ;; Need take into account `bless', `return', `tr',...
2389 "Return appropriate indentation for current line as Perl code.
2390 In usual case returns an integer: the column to indent to.
2391 Returns nil if line starts inside a string, t if in a comment.
2393 Will not correct the indentation for labels, but will correct it for braces
2394 and closing parentheses and brackets."
2401 ;; before start of POD - whitespace found since do not have 'pod!
2406 nil
2414 p prop look-prop is-block delim)
2417 ;; In the verbatim part, probably code example. What to do???
2418 )
2421 ;; Not in POD
2440 old-indent)
2442 ;;containing-sexp ;; We are buggy at toplevel :-(
2443 parse-data)
2449 ;; Before this point: end of statement
2452 ;; indent to just after the surrounding open,
2453 ;; skip blanks if we do not close the expression.
2460 ;; return nil or t if should not change this line
2462 ;; XXXX Do we need to special-case this?
2464 ;; Line is at top level. May be data or function definition,
2465 ;; or may be function argument declaration.
2466 ;; Indent like the previous top level line
2467 ;; unless that ends in a closeparen without semicolon,
2468 ;; in which case this line is the first argument decl.
2477 ;; Look at previous line that's at column 0
2478 ;; to determine whether we are in top-level decls
2479 ;; or function's arg decls. Set basic-indent accordingly.
2480 ;; Now add a little if this is a continuation line.
2484 ;; Had ?\) too
2501 cperl-continued-statement-offset))))
2508 cperl-indent-parens-as-block))
2509 ;; group is an expression, not a block:
2510 ;; indent to just after the surrounding open parens,
2511 ;; skip blanks if we do not close the expression.
2520 ;; Correct indentation of trailing ?\}
2523 ;;; ((and (/= (char-after containing-sexp) ?{)
2524 ;;; (not cperl-indent-parens-as-block))
2525 ;;; ;; line is expression, not statement:
2526 ;;; ;; indent to just after the surrounding open,
2527 ;;; ;; skip blanks if we do not close the expression.
2528 ;;; (goto-char (1+ containing-sexp))
2529 ;;; (or (memq char-after (append ")]}" nil))
2530 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2531 ;;; (skip-chars-forward " \t"))
2532 ;;; (current-column))
2533 ;;; ((progn
2534 ;;; ;; Containing-expr starts with \{. Check whether it is a hash.
2535 ;;; (goto-char containing-sexp)
2536 ;;; (and (not (cperl-block-p))
2537 ;;; (not cperl-indent-parens-as-block)))
2538 ;;; (goto-char (1+ containing-sexp))
2539 ;;; (or (eq char-after ?\})
2540 ;;; (looking-at "[ \t]*\\(#\\|$\\)")
2541 ;;; (skip-chars-forward " \t"))
2542 ;;; (+ (current-column) ; Correct indentation of trailing ?\}
2543 ;;; (if (eq char-after ?\}) (+ cperl-indent-level
2544 ;;; cperl-close-paren-offset)
2545 ;;; 0)))
2547 ;; Statement level. Is it a continuation or a new statement?
2548 ;; Find previous non-comment character.
2551 ;; Back up over label lines, since they don't
2552 ;; affect whether our line is a continuation.
2553 ;; (Had \, too)
2559 ;;)
2561 ;; Will go to beginning of line, essentially.
2562 ;; Will ignore embedded sexpr XXXX.
2566 ;; Now we get the answer.
2572 containing-sexp))
2574 ;; This line is continuation of preceding line's statement;
2575 ;; indent `cperl-continued-statement-offset' more than the
2576 ;; previous line of the statement.
2577 ;;
2578 ;; There might be a label on this line, just
2579 ;; consider it bad style and ignore it.
2584 cperl-continued-statement-offset)
2588 0
2589 ;; Now it is a hash reference
2594 ;; Do not move `parse-data', this should
2595 ;; be quick anyway (this comment comes
2596 ;; from different location):
2601 ;; This line starts a new statement.
2602 ;; Position following last unclosed open.
2604 ;; Is line first statement after an open-brace?
2606 ;; If no, find that first statement and indent like
2607 ;; it. If the first statement begins with label, do
2608 ;; not believe when the indentation of the label is too
2609 ;; small.
2617 ;; Skip over comments and labels following openbrace.
2624 ;; label:
2629 ;; The first following code counts
2630 ;; if it is before the line we want to indent.
2634 cperl-min-label-indent)
2636 ;; Do not believe: `max' is involved
2639 ;; If no previous statement,
2640 ;; indent it relative to line brace is on.
2641 ;; For open brace in column zero, don't let statement
2642 ;; start there too. If cperl-indent-level is zero,
2643 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2644 ;; For open-braces not the first thing in a line,
2645 ;; add in cperl-brace-imaginary-offset.
2647 ;; If first thing on a line: ?????
2650 cperl-indent-level)
2654 0
2655 ;; Now it is a hash reference
2657 ;; Move back over whitespace before the openbrace.
2658 ;; If openbrace is not first nonwhite thing on the line,
2659 ;; add the cperl-brace-imaginary-offset.
2662 ;; If the openbrace is preceded by a parenthesized exp,
2663 ;; move to the beginning of that;
2664 ;; possibly a different line
2668 ;; In the case it starts a subroutine, indent with
2669 ;; respect to `sub', not with respect to the
2670 ;; first thing on the line, say in the case of
2671 ;; anonymous sub in a hash.
2672 ;;
2686 ;; Get initial indentation of the line we are on.
2687 ;; If line starts with label, calculate label indentation
2693 ;; Do not move `parse-data', this should
2694 ;; be quick anyway:
2705 "Alist of indentation rules for CPerl mode.
2706 The values mean:
2707 nil: do not indent;
2708 number: add this amount of indentation.
2713 ;; Unfinished
2714 "Return a list of lists ((TYPE POS)...) of good points before the point.
2715 POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.
2717 Not finished, not used."
2732 ;; Line is at top level.
2733 ;; Indent like the previous top level line
2734 ;; unless that ends in a closeparen without semicolon,
2735 ;; in which case this line is the first argument decl.
2737 ;;(skip-chars-backward " \t\f\n")
2747 ;; line is expression, not statement:
2748 ;; indent to just after the surrounding open.
2749 ;; skip blanks if we do not close the expression.
2758 ;; Containing-expr starts with \{. Check whether it is a hash.
2769 ;; Statement level.
2771 ;; Is it a continuation or a new statement?
2772 ;; Find previous non-comment character.
2774 ;; Back up over label lines, since they don't
2775 ;; affect whether our line is a continuation.
2776 ;; Back up comma-delimited lines too ?????
2780 ;; Will go to beginning of line, essentially
2781 ;; Will ignore embedded sexpr XXXX.
2785 ;; Now we get the answer.
2787 ;; This line is continuation of preceding line's statement.
2789 ;; This line starts a new statement.
2790 ;; Position following last unclosed open.
2792 ;; Is line first statement after an open-brace?
2794 ;; If no, find that first statement and indent like
2795 ;; it. If the first statement begins with label, do
2796 ;; not believe when the indentation of the label is too
2797 ;; small.
2805 ;; Skip over comments and labels following openbrace.
2807 ;;(forward-line 1)
2809 ;; label:
2814 ;; Now at the point, after label, or at start
2815 ;; of first statement in the block.
2818 ;; Before statement after label
2820 cperl-min-label-indent)
2822 ;; Do not believe: `max' is involved
2825 ;; Before statement
2827 ;; If no previous statement,
2828 ;; indent it relative to line brace is on.
2829 ;; For open brace in column zero, don't let statement
2830 ;; start there too. If cperl-indent-level is zero,
2831 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
2832 ;; For open-braces not the first thing in a line,
2833 ;; add in cperl-brace-imaginary-offset.
2835 ;; If first thing on a line: ?????
2838 cperl-indent-level)
2839 ;; Move back over whitespace before the openbrace.
2840 ;; If openbrace is not first nonwhite thing on the line,
2841 ;; add the cperl-brace-imaginary-offset.
2844 ;; If the openbrace is preceded by a parenthesized exp,
2845 ;; move to the beginning of that;
2846 ;; possibly a different line
2850 ;; Get initial indentation of the line we are on.
2851 ;; If line starts with label, calculate label indentation
2859 res)))
2862 "Return the indentation amount for line, assuming that
2863 the current line is to be regarded as part of a block comment."
2878 "Go to position before comment on the current line, or to end of line.
2879 Returns true if comment is found."
2886 ;; Else
2889 ; stop at comment
2890 ;; If fails (beginning-of-line inside sexp), then contains not-comment
2892 ; (nth 2 state) can be
2893 ; beginning of m,s,qq and so
2894 ; on
2931 ;; C code looks for "^\\s(" to skip comment backward in "hard" situations
2940 nil
2941 ;; We suppose that e is _after_ the end of construction, as after eol.
2944 ;; one-char string/comment?!
2952 ;; Fontify
2965 ;; Works *before* syntax recognition is done
2966 ;; May modify syntax-type text property if the situation is too hard
2969 ;; ender means matching-char matcher.
2973 ;; What if starter == ?\\ ????
2984 ;; Whether we have an intermediate point
2986 ;; Prepare the syntax table:
2994 ;; We use `$' syntax class to find matching stuff, but $$
2995 ;; is recognized the same as $, so we need to check this manually.
2998 ;; $ has TeXish matching rules, so $$ equiv $...
3007 ;; Now the problem is with m;blah;;
3015 ;; Now we are after the first part.
3021 ;; Make trailing letter into punctuation
3039 argument starter ender)
3047 "End of `%s%s%c ... %c' string/RE not found: %s"
3048 argument
3056 ;; i: have 2 args, after end of the first arg
3057 ;; i2: start of the second arg, if any (before delim iff `ender').
3058 ;; ender: the last arg bounded by parens-like chars, the second one of them
3059 ;; starter: the starting delimiter of the first arg
3060 ;; go-forward: has 2 args, and the second part is empty
3064 ;;(defvar font-lock-reference-face)
3067 ;; Do after syntactic fontification?
3072 ;;; Here is how the global structures (those which cannot be
3073 ;;; recognized locally) are marked:
3074 ;; a) PODs:
3075 ;; Start-to-end is marked `in-pod' ==> t
3076 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3077 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3078 ;; b) HEREs:
3079 ;; Start-to-end is marked `here-doc-group' ==> t
3080 ;; The body is marked `syntax-type' ==> `here-doc'
3081 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3082 ;; c) FORMATs:
3083 ;; First line (to =) marked `first-format-line' ==> t
3084 ;; After-this--to-end is marked `syntax-type' ==> `format'
3085 ;; d) 'Q'uoted string:
3086 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3087 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3090 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3102 ;; Up to the start
3104 ;; Skip empty lines
3110 ;; Do the same for end, going small steps
3122 "Scans the buffer for hard-to-parse Perl constructions.
3123 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3124 the sections using `cperl-pod-head-face', `cperl-pod-face',
3125 `cperl-here-face'."
3128 cperl-syntax-state nil
3129 cperl-syntax-done-to min))
3132 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3133 is-REx is-x-REx REx-comment-start REx-comment-end was-comment i2
3144 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3146 ;; Somehow font-lock may be not loaded yet...
3148 font-lock-string-face
3151 font-lock-constant-face
3155 font-lock-function-name-face
3159 font-lock-comment-face
3163 cperl-nonoverridable-face
3167 max))
3172 ;; One extra () before this:
3173 "<<"
3175 ;; First variant "BLAH" or just ``.
3181 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3183 ;; Do not have <<= or << 30 or <<30 or << $blah.
3184 ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3188 ;; 1+6 extra () before this:
3193 ;; 1+6+2=9 extra () before this:
3196 ;; 1+6+2+1=10 extra () before this:
3199 ;; 1+6+2+1+1=11 extra () before this:
3202 ;; 1+6+2+1+1+2=13 extra () before this:
3205 ;; 1+6+2+1+1+2+1=14 extra () before this:
3207 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3210 ;; 1+6+2+1+1+2+1+1+1=16 extra () before this:
3220 ;; We had evals here, do not know why...
3222 head-face cperl-pod-head-face
3223 here-face cperl-here-face))
3226 cperl-postpone t
3227 syntax-subtype t
3228 rear-nonsticky t
3229 here-doc-group t
3230 first-format-line t
3231 indentable t))
3232 ;; Need to remove face as well...
3238 nil))
3245 ;; "\\(\\`\n?\\|^\n\\)="
3248 nil ; Doing a chunk only
3254 bb b
3257 ;; We do not search to max, since we may be called from
3258 ;; some hook of fontification, and max is random
3273 cperl-postpone t
3274 syntax-subtype t
3275 here-doc-group t
3276 rear-nonsticky t
3277 first-format-line t
3278 indentable t))
3284 ;; We start 'pod 1 char earlier to include the preceding line
3288 ;; mark the non-literal parts as PODs
3298 ;; mark the non-literal parts as PODs
3303 ;; mark the headers
3308 ;; One paragraph
3311 ;; mark the headers
3319 ;; Here document
3320 ;; We do only one here-per-line
3321 ;; ;; One extra () before this:
3322 ;;"<<"
3323 ;; "\\(" ; 1 + 1
3324 ;; ;; First variant "BLAH" or just ``.
3325 ;; "[ \t]*" ; Yes, whitespace is allowed!
3326 ;; "\\([\"'`]\\)" ; 2 + 1
3327 ;; "\\([^\"'`\n]*\\)" ; 3 + 1
3328 ;; "\\3"
3329 ;; "\\|"
3330 ;; ;; Second variant: Identifier or \ID or empty
3331 ;; "\\\\?\\(\\([a-zA-Z_][a-zA-Z_0-9]*\\)?\\)" ; 4 + 1, 5 + 1
3332 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3333 ;; ;; "\\([^= \t0-9$@%&]\\|[ \t]+[^ \t\n0-9$@%&]\\)" ; 6 + 1
3334 ;; "\\(\\)" ; To preserve count of pars :-( 6 + 1
3335 ;; "\\)"
3337 ;; Abort in comment:
3340 state-point b
3351 nil ; Skip it.
3360 ;; Highlight the starting delimiter
3365 ;; We do not search to max, since we may be called from
3366 ;; some hook of fontification, and max is random
3377 ;; Highlight the ending delimiter
3381 ;; Highlight the HERE-DOC
3395 ;; format
3397 ;; 1+6=7 extra () before this:
3398 ;;"^[ \t]*\\(format\\)[ \t]*\\([a-zA-Z0-9_]+\\)?[ \t]*=[ \t]*$"
3425 ;; Highlight the format line
3430 ;; We do not search to max, since we may be called from
3431 ;; some hook of fontification, and max is random
3436 ;; Highlight the ending delimiter
3447 ;; Regexp:
3449 ;; 1+6+2=9 extra () before this:
3450 ;; "\\<\\(q[wxqr]?\\|[msy]\\|tr\\)\\>"
3451 ;; "\\|"
3452 ;; "\\([?/<]\\)" ; /blah/ or ?blah? or <file*glob>
3457 i b
3460 ;; bb == "Not a stringy"
3467 ?\:))
3471 ?\-))
3475 ?\&)))
3477 ;; <file> or <$file>
3479 ;; Do not stringify <FH>, <$fh> :
3489 b1 nil
3490 bb ; Not a regexp?
3493 ;; What is below: regexp-p?
3497 ;; $a++ ? 1 : 2
3498 "~{(=|&*!,;:"
3505 ;; After these keywords `/' starts a RE. One should add all the
3506 ;; functions/builtins which expect an argument, but ...
3508 ;; -d ?foo? is a RE
3514 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
3518 ;; m|blah| ? foo : bar;
3521 cperl-use-syntax-table-text-property
3527 ;; s y tr m
3528 ;; Check for $a -> y
3533 ;; Not a regexp
3536 state-point b nil nil state)
3537 state-point b))
3547 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
3567 ;; Check for { foo => 1, s => 2 }
3568 ;; Apparently s=> is never a substitution...
3581 ;; Skip whitespace and comments...
3587 ;; qtag means two-arg matcher, may be reset to
3588 ;; 2 or 3 later if some special quoting is needed.
3589 ;; e1 means matching-char matcher.
3591 ;; has 2 args
3593 ;; We do not search to max, since we may be called from
3594 ;; some hook of fontification, and max is random
3596 i2
3597 t st-l err-l argument)
3598 ;; Note that if `go', then it is considered as 1-arg
3601 ; is with matching chars []
3605 ;; Before end of the second part if non-matching: ///
3609 qtag nil ; need to preserve backslashitis
3611 ;; Commenting \\ is dangerous, what about ( ?
3618 ;; Considered as 1arg form
3623 ;; ignore other text properties:
3634 ;; silent:
3636 ;; Error
3652 ;; Now: tail: if the second part is non-matching without ///e
3659 ;; Check whether it is m// which means "previous match"
3660 ;; and highlight differently
3667 ;; split // *is* using zero-pattern
3689 ;; Process RExen better
3705 was-comment t)
3708 ;; XXX not working if outside delimiter is #
3711 ;; Not a comment, avoid loop:
3719 ;; Works also if the outside delimiters are ().
3722 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
3723 REx-comment-start))))
3730 REx-comment-start REx-comment-end nil)
3732 REx-comment-start REx-comment-end
3750 nil
3752 state-point b nil nil state)
3753 state-point b)
3755 nil
3756 ;; Mark as string
3759 ;; 1+6+2+1+1+2=13 extra () before this:
3760 ;; "\\$\\(['{]\\)"
3770 ;; 1+6+2+1+1+2=13 extra () before this:
3771 ;; "\\$\\(['{]\\)"
3775 ;; 1+6+2+1+1+2+1=14 extra () before this:
3776 ;; "\\(\\<sub[ \t\n\f]+\\|[&*$@%]\\)[a-zA-Z0-9_]*'")
3781 state-point b nil nil state)
3782 state-point b)
3784 nil
3787 ;; 1+6+2+1+1+2+1+1=15 extra () before this:
3788 ;; "__\\(END\\|DATA\\)__"
3793 state-point b nil nil state)
3794 state-point b)
3796 nil
3797 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
3802 ;; Trailing backslash ==> non-quoting outside string/comment
3807 ;;;(setq i2 (= (% (skip-chars-backward "\\\\") 2) -1))
3809 state-point b nil nil state)
3810 state-point b)
3812 nil
3835 ;; Stops at lim or after non-whitespace that is not in comment
3852 "Return true if the preceeding } ends a block or a following { starts one.
3853 Would not look before LIM. If PRE-BLOCK is nil checks preceeding }.
3854 otherwise following {."
3855 ;; We suppose that the preceding char is }.
3867 ;; sub f {}
3878 "Return true if the position is good for start of expression.
3879 TEST is the expression to evaluate at the found position. If absent,
3880 CHARS is a string that contains good characters to have before us (however,
3883 stop p pr)
3890 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
3891 ;; '(pod here-doc here-doc-delim))
3903 ;; Else: last iteration, or a label
3937 ;; We assume that we are after ?\}
3952 \f
3954 "Simple variant of indentation of continued-sexp.
3956 Will not indent comment if it starts at `comment-indent' or looks like
3957 continuation of the comment on the previous line.
3959 If `cperl-indent-region-fix-constructs', will improve spacing on
3960 conditional/loop constructs."
3987 "Improve whitespace in a conditional/loop construct.
3988 Returns some position at the last line."
3995 p pp ml have-brace ret)
3999 ;; }? continue
4000 ;; blah; }
4002 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
4004 nil ; Do not need to do anything
4005 ;; Looking at:
4006 ;; }
4007 ;; else
4018 ;; Looking at:
4019 ;; } else
4026 ;; Looking at:
4027 ;; else {
4029 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4035 ;; Looking at:
4036 ;; foreach my $var
4044 ;; Looking at:
4045 ;; foreach my $var (
4047 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
4054 ;; Looking at:
4055 ;; } foreach my $var () {
4057 "[ \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]*{")
4067 ;; after `else' or nothing
4072 ;; Now after the sexp before the brace
4073 ;; Multiline expr should be special
4081 nil)
4085 cperl-extra-newline-before-brace-multiline
4086 cperl-extra-newline-before-brace)
4099 cperl-extra-newline-before-brace-multiline
4100 cperl-extra-newline-before-brace)))
4106 ;; Now we are before `{'
4116 ;; not good: multi-line BLOCK
4126 ;; Now check whether there is a hanging `}'
4127 ;; Looking at:
4128 ;; } blah
4130 cperl-fix-hanging-brace-when-indent
4131 have-brace
4132 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
4139 t
4141 nil))
4147 ;; `}' was the first thing on the line, insert NL *after* it.
4164 ret))
4173 "Simple variant of indentation of region in CPerl mode.
4174 Should be slow. Will not indent comment if it starts at `comment-indent'
4175 or looks like continuation of the comment on the previous line.
4176 Indents all the lines whose first character is between START and END
4177 inclusive.
4179 If `cperl-indent-region-fix-constructs', will improve spacing on
4180 conditional/loop constructs."
4187 nil))
4189 after-change-functions ; Speed it up!
4190 st comm old-comm-indent new-comm-indent p pp i empty)
4195 new-comm-indent old-comm-indent)
4210 comment-column))
4217 cperl-st-cfence)))
4234 cperl-st-cfence))
4244 ;; Now run the update hooks
4246 cperl-update-end
4255 ;; Stolen from lisp-mode with a lot of improvements
4259 If any of the current line is a comment, fill the comment or the
4260 block of it that point is in, preserving the comment's initial
4261 indentation and initial hashes. Behaves usually outside of comment."
4264 has-comment
4266 ;; If has-comment, the appropriate fill-prefix for the comment.
4267 comment-fill-prefix
4268 ;; Line that contains code and comment (or nil)
4269 start
4271 ;; Figure out what kind of comment we are looking at.
4276 ;; A line with nothing but a comment on it?
4282 ;; A line with some code, followed by a comment? Remember that the
4283 ;; semi which starts the comment shouldn't be part of a string or
4284 ;; character.
4289 comment-fill-prefix
4300 ;; Narrow to include only the comment, and then fill the region.
4303 ;; Find the first line we should include in the region to fill.
4308 ;; We may have gone to far. Go forward again.
4312 ;; Find the beginning of the first line past the region to fill.
4317 ;; Remove existing hashes
4324 ;; Lines with only hashes on them can be paragraph boundaries.
4337 ;; Repeat once more, flagging as iteration
4341 ;; Break out if the line is short enough
4345 fill-column)
4353 ;; Is not enough, sometimes marker is a start of line
4356 ;; Following space could have gone:
4360 ;; Previous space could have gone:
4364 ;; We suppose that the lst is a DAG, unless the first element only
4365 ;; loops back, and ISBACK is set. Thus this function cannot be
4366 ;; applied twice without ISBACK set.
4374 ;; In the other order it goes up
4375 ;; one level only ;-(
4380 lst)))
4387 packages ends-ranges p marker
4394 ;; Search for the function
4398 nil t)
4407 nil)
4410 ;; Skip if quoted (will not skip multi-line ''-strings :-():
4417 ;; (if (looking-at "([^()]*)[ \t\n\f]*")
4418 ;; (goto-char (match-end 0))) ; Messes what follows
4420 meth nil
4423 ;; delete obsolete entries
4431 name)
4434 end-range
4439 ;; )
4440 ;; Skip this function name if it is a prototype declaration.
4460 ;; (beginning-of-line)
4479 index-alist))
4482 ;; Remove "package ", reverse and uniquify.
4494 ;; Have some functions already
4511 hier-list))))))
4513 hier-list)
4514 index-alist)))
4518 index-alist))
4521 index-unsorted-alist
4524 index-alist))
4527 \f
4528 ;; Suggested by Mark A. Hershberger
4542 \f
4544 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORK).
4551 "mode-compile"
4553 cperl-compilation-error-regexp-alist)))
4557 "Initialization under windowed version."
4559 ;; Need to init anyway:
4569 "ps-print"
4581 cperl-font-lock-keywords)
4585 cperl-font-lock-keywords-1)
4589 cperl-font-lock-keywords-2)
4592 ;; Allow `cperl-find-pods-heres' to run.
4596 ;;(setq font-lock-constant-face 'font-lock-constant-face)
4597 ))
4610 t-font-lock-keywords
4617 'identity
4624 ; In what follows we use `type' style
4625 ; for overwritable builtins
4629 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
4630 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
4631 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
4632 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
4633 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
4634 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
4635 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
4636 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
4637 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
4638 ;; "gethostbyname" "gethostent" "getlogin"
4639 ;; "getnetbyaddr" "getnetbyname" "getnetent"
4640 ;; "getpeername" "getpgrp" "getppid" "getpriority"
4641 ;; "getprotobyname" "getprotobynumber" "getprotoent"
4642 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
4643 ;; "getservbyport" "getservent" "getsockname"
4644 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
4645 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
4646 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
4647 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
4648 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
4649 ;; "quotemeta" "rand" "read" "readdir" "readline"
4650 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
4651 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
4652 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
4653 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
4654 ;; "setpriority" "setprotoent" "setpwent" "setservent"
4655 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
4656 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
4657 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
4658 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
4659 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
4660 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
4661 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
4694 ;; In what follows we use `other' style
4695 ;; for nonoverwritable builtins
4696 ;; Somehow 's', 'm' are not auto-generated???
4700 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
4701 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
4702 ;; "eval" "exists" "for" "foreach" "format" "goto"
4703 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
4704 ;; "no" "package" "pop" "pos" "print" "printf" "push"
4705 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
4706 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
4707 ;; "undef" "unless" "unshift" "untie" "until" "use"
4708 ;; "while" "y"
4720 ;; (mapconcat 'identity
4721 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
4722 ;; "#include" "#define" "#undef")
4723 ;; "\\|")
4727 font-lock-function-name-face)
4728 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
4740 nil nil
4745 font-lock-string-face t)
4746 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
4748 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
4750 ;; Uncomment to get perl-mode-like vars
4751 ;;; '("[$*]{?\\(\\sw+\\)" 1 font-lock-variable-name-face)
4752 ;;; '("\\([@%]\\|\\$#\\)\\(\\sw+\\)"
4753 ;;; (2 (cons font-lock-variable-name-face '(underline))))
4766 nil nil
4770 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
4773 t-font-lock-keywords-1
4776 '(
4779 cperl-hash-face
4780 cperl-array-face)
4783 1
4786 cperl-hash-face
4789 t)
4790 ;;("\\([smy]\\|tr\\)\\([^a-z_A-Z0-9]\\)\\(\\([^\n\\]*||\\)\\)\\2")
4791 ;;; Too much noise from \s* @s[ and friends
4792 ;;("\\(\\<\\([msy]\\|tr\\)[ \t]*\\([^ \t\na-zA-Z0-9_]\\)\\|\\(/\\)\\)"
4793 ;;(3 font-lock-function-name-face t t)
4794 ;;(4
4795 ;; (if (cperl-slash-is-regexp)
4796 ;; font-lock-function-name-face 'default) nil t))
4797 )))
4802 font-lock-variable-name-face)))))
4806 t-font-lock-keywords)
4807 t-font-lock-keywords)
4808 cperl-font-lock-keywords cperl-font-lock-keywords-1
4810 cperl-font-lock-keywords-1
4811 t-font-lock-keywords-1)))
4817 ;; Color-light Color-dark Gray-light Gray-dark Mono
4820 nil
4823 nil)
4826 nil
4827 nil
4829 nil)
4836 nil nil nil nil
4840 nil
4841 nil)
4844 nil
4847 nil)
4850 nil
4852 nil
4856 nil
4858 nil
4871 t
4872 nil
4873 nil)
4878 t
4879 t
4880 nil))))
4881 ;; Do it the dull way, without choose-color
4884 ;; (or (fboundp 'x-color-defined-p)
4885 ;; (defalias 'x-color-defined-p
4886 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
4887 ;; ;; XEmacs >= 19.12
4888 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
4889 ;; ;; XEmacs 19.11
4890 ;; (t 'x-valid-color-name-p))))
4907 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
4908 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
4909 ;;(or (boundp 'font-lock-type-face)
4910 ;; (defconst font-lock-type-face
4911 ;; 'font-lock-type-face
4912 ;; "Face to use for data types."))
4913 ;;(or (boundp 'cperl-nonoverridable-face)
4914 ;; (defconst cperl-nonoverridable-face
4915 ;; 'cperl-nonoverridable-face
4916 ;; "Face to use for data types from another group."))
4917 ;;(if (not cperl-xemacs-p) nil
4918 ;; (or (boundp 'font-lock-comment-face)
4919 ;; (defconst font-lock-comment-face
4920 ;; 'font-lock-comment-face
4921 ;; "Face to use for comments."))
4922 ;; (or (boundp 'font-lock-keyword-face)
4923 ;; (defconst font-lock-keyword-face
4924 ;; 'font-lock-keyword-face
4925 ;; "Face to use for keywords."))
4926 ;; (or (boundp 'font-lock-function-name-face)
4927 ;; (defconst font-lock-function-name-face
4928 ;; 'font-lock-function-name-face
4929 ;; "Face to use for function names.")))
4944 ;;(or (boundp 'cperl-hash-face)
4945 ;; (defconst cperl-hash-face
4946 ;; 'cperl-hash-face
4947 ;; "Face to use for hashes."))
4948 ;;(or (boundp 'cperl-array-face)
4949 ;; (defconst cperl-array-face
4950 ;; 'cperl-array-face
4951 ;; "Face to use for arrays."))
4952 ;; Here we try to guess background
4955 font-lock-background-mode
4958 ;;;; (fset 'cperl-is-face
4959 ;;;; (cond ((fboundp 'find-face)
4960 ;;;; (symbol-function 'find-face))
4961 ;;;; (face-list
4962 ;;;; (function (lambda (face) (member face face-list))))
4963 ;;;; (t
4964 ;;;; (function (lambda (face) (boundp face))))))
4968 'gray
4969 background)
4980 "seagreen"
4985 "os2pink"
4990 nil
4996 "chartreuse3"
5001 "orchid1"
5003 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
5004 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
5005 ;;; (cond
5006 ;;; ((eq background 'light)
5007 ;;; (set-face-background 'font-lock-other-emphasized-face
5008 ;;; (if (x-color-defined-p "lightyellow2")
5009 ;;; "lightyellow2"
5010 ;;; (if (x-color-defined-p "lightyellow")
5011 ;;; "lightyellow"
5012 ;;; "light yellow"))))
5013 ;;; ((eq background 'dark)
5014 ;;; (set-face-background 'font-lock-other-emphasized-face
5015 ;;; (if (x-color-defined-p "navy")
5016 ;;; "navy"
5017 ;;; (if (x-color-defined-p "darkgreen")
5018 ;;; "darkgreen"
5019 ;;; "dark green"))))
5020 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
5021 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
5022 ;;; (copy-face 'bold 'font-lock-emphasized-face)
5023 ;;; (cond
5024 ;;; ((eq background 'light)
5025 ;;; (set-face-background 'font-lock-emphasized-face
5026 ;;; (if (x-color-defined-p "lightyellow2")
5027 ;;; "lightyellow2"
5028 ;;; "lightyellow")))
5029 ;;; ((eq background 'dark)
5030 ;;; (set-face-background 'font-lock-emphasized-face
5031 ;;; (if (x-color-defined-p "navy")
5032 ;;; "navy"
5033 ;;; (if (x-color-defined-p "darkgreen")
5034 ;;; "darkgreen"
5035 ;;; "dark green"))))
5036 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
5046 "Initialization of `ps-print' components for faces used in CPerl."
5049 ;; font-lock-variable-name-face
5050 ;; font-lock-constant-face
5052 cperl-hash-face)
5053 ps-bold-faces)
5054 ps-italic-faces
5055 ;; font-lock-constant-face
5057 cperl-hash-face)
5058 ps-italic-faces)
5059 ps-underlined-faces
5060 ;; font-lock-type-face
5062 cperl-hash-face
5063 underline
5064 cperl-nonoverridable-face)
5065 ps-underlined-faces))))
5070 "Pretty-print in CPerl style.
5071 If optional argument FILE is an empty string, prints to printer, otherwise
5072 to the file FILE. If FILE is nil, prompts for a file name.
5074 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
5078 "Print to file (if empty - to printer): "
5089 ;;; (defun cperl-ps-print-init ()
5090 ;;; "Initialization of `ps-print' components for faces used in CPerl."
5091 ;;; ;; Guard against old versions
5092 ;;; (defvar ps-underlined-faces nil)
5093 ;;; (defvar ps-bold-faces nil)
5094 ;;; (defvar ps-italic-faces nil)
5095 ;;; (setq ps-bold-faces
5096 ;;; (append '(font-lock-emphasized-face
5097 ;;; cperl-array-face
5098 ;;; font-lock-keyword-face
5099 ;;; font-lock-variable-name-face
5100 ;;; font-lock-constant-face
5101 ;;; font-lock-reference-face
5102 ;;; font-lock-other-emphasized-face
5103 ;;; cperl-hash-face)
5104 ;;; ps-bold-faces))
5105 ;;; (setq ps-italic-faces
5106 ;;; (append '(cperl-nonoverridable-face
5107 ;;; font-lock-constant-face
5108 ;;; font-lock-reference-face
5109 ;;; font-lock-other-emphasized-face
5110 ;;; cperl-hash-face)
5111 ;;; ps-italic-faces))
5112 ;;; (setq ps-underlined-faces
5113 ;;; (append '(font-lock-emphasized-face
5114 ;;; cperl-array-face
5115 ;;; font-lock-other-emphasized-face
5116 ;;; cperl-hash-face
5117 ;;; cperl-nonoverridable-face font-lock-type-face)
5118 ;;; ps-underlined-faces))
5119 ;;; (cons 'font-lock-type-face ps-underlined-faces))
5126 cperl-label-offset cperl-extra-newline-before-brace
5127 cperl-merge-trailing-else
5128 cperl-continued-statement-offset))
5160 ;;(cperl-extra-newline-before-brace . nil) ; ???
5168 ;;(cperl-extra-newline-before-brace . nil) ; ???
5184 ;;(cperl-extra-newline-before-brace . nil) ; ???
5186 "(Experimental) list of variables to set to get a particular indentation style.
5190 "Set CPerl mode variables to use one of several different indentation styles.
5191 The arguments are a string representing the desired style.
5192 The list of styles is in `cperl-style-alist', available styles
5193 are GNU, K&R, BSD, C++ and Whitesmith.
5195 The current value of style is memorized (unless there is a memorized
5196 data already), may be restored by `cperl-set-style-back'.
5199 side-effect of memorizing only."
5202 cperl-style-alist)))
5209 cperl-styles-entries)))
5216 "Restore a style memorised by `cperl-set-style'."
5232 ;; Returns buffer with documentation. Creates if missing.
5233 ;; If TYPE, this vars buffer.
5234 ;; Special care is taken to not stomp over an existing info buffer
5240 ;; Get Info running
5259 "Return the word at point or at P."
5266 find-tag-default-function)
5268 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
5269 ;; automatically used within `find-tag-default':
5273 "Show documentation for Perl command COMMAND in other window.
5274 If perl-info buffer is shown in some frame, uses this frame.
5275 Customized by setting variables `cperl-shrink-wrap-info-frame',
5276 `cperl-max-help-size'."
5281 default))))
5283 default
5284 read))))
5288 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
5289 max-height char-height buf-list)
5303 ;; Go back to beginning of the group (ex, for qq)
5307 ;; Get some of
5322 ;; Resize
5327 cperl-shrink-wrap-info-frame)
5331 pos
5336 max-height
5340 ;; Non-functioning under OS/2:
5342 ;; Title, menubar, + 2 for slack
5345 ;;(message "was %s doing %s" iniheight height)
5351 ;;(pop-to-buffer buffer)
5355 "Show documentation for Perl command at point in other window."
5372 imenu-create-index-function
5373 imenu-prev-index-position-function
5374 imenu-extract-index-name-function
5379 'imenu-default-create-index-function
5380 imenu-prev-index-position-function
5381 'cperl-imenu-info-imenu-search
5382 imenu-extract-index-name-function
5398 "Lineup construction in a region.
5399 Beginning of region should be at the start of a construction.
5400 All first occurrences of this construction in the lines that are
5401 partially contained in the region are lined up at the same column.
5403 MINSHIFT is the minimal amount of space to insert before the construction.
5404 STEP is the tabwidth to position constructions.
5405 If STEP is nil, `cperl-lineup-step' will be used
5406 \(or `cperl-indent-level', if `cperl-lineup-step' is `nil').
5407 Will not move the position at the start to the left."
5457 "Run etags with appropriate options for Perl files.
5458 If optional argument ALL is `recursive', will process Perl files
5459 in subdirectories too."
5462 (args '("-l" "none" "-r" "/\\<\\(package\\|sub\\)[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([{#]\\|$\\)\\)/\\4/"))
5463 res)
5468 ;;(error "Not implemented: recursive")
5471 use File::Find;
5473 exec @ARGV;"
5477 ;;(error "Not implemented: all")
5479 "push @ARGV, <*.PL *.pl *.pm>;
5480 exec @ARGV;"
5490 "Toggle the state of `cperl-auto-newline'."
5497 "Toggle the state of automatic keyword expansion in CPerl mode."
5505 "Toggle the state of parentheses doubling in CPerl mode."
5512 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
5513 Delay of auto-help controlled by `cperl-lazy-help-time'."
5525 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
5529 nil
5534 ;;;; Tags file creation.
5546 ;; Do not introduce variable if not needed, we check it!
5557 ;; Search for the function
5560 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
5561 nil t)
5587 ;; (beginning-of-line)
5593 index-alist))
5635 ;; After name now...
5641 lst))
5648 127
5652 1
5654 ","
5660 ;; Need to insert the name without package as well
5665 lst))))))
5669 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5678 ret))))
5681 "Add to TAGS data for Perl and XSUB files in the current directory and kids.
5682 Use as
5683 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5684 -f cperl-add-tags-recurse
5685 "
5689 "Add to TAGS file data for Perl files in the current directory and kids.
5690 Use as
5691 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
5692 -f cperl-add-tags-recurse
5693 "
5697 ;; If INBUFFER, do not select buffer, and do not save
5698 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
5707 xs rel tm)
5725 t)
5737 nil)
5743 files)))
5753 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
5790 ;; Suppose we are in a tag table cooked by cperl.
5799 "\C-?"
5801 "\C-a"
5803 ","
5808 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
5813 ;; Moves to beginning of the next line:
5815 ;; Move back
5817 ;; Make new member of hierarchy name ==> file ==> pos if needed
5819 ;; Name known
5822 ;; First occurrence of the name, start alist
5832 "Show hierarchical menu of classes and methods.
5833 Finds info about classes by a scan of loaded TAGS files.
5834 Supposes that the TAGS files contain fully qualified function names.
5835 One may build such TAGS files from CPerl mode menu."
5842 ;; Only in one file
5844 pack name cons1 to l1 l2 l3 l4 b)
5845 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
5850 ;; Does this work in XEmacs?
5863 tags-table-list)
5873 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
5874 ))
5878 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
5882 window-system)
5896 ;; cadr of `to' is read-write. On start it is a cons
5898 'identity
5904 l1 head tail cons1 cons2 ord writeto packs recurse
5905 root-packages root-functions ms many_ms same_name ps
5914 recurse t)
5916 ;; Need to init new head
5937 ;;Now clean up leaders with one child only
5944 ;; Sort the roots of subtrees
5948 ;; Now add back functions removed from display
5954 root-functions))
5955 ;; Now add back packages removed from display
5963 root-packages))))
5965 ;;;(x-popup-menu t
5966 ;;; '(keymap "Name1"
5967 ;;; ("Ret1" "aa")
5968 ;;; ("Head1" "ab"
5969 ;;; keymap "Name2"
5970 ;;; ("Tail1" "x") ("Tail2" "y"))))
5984 list1)
5989 list1)))))
6007 \f
6017 'identity
6033 "||"
6034 "&&"
6037 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
6038 ;;"[*/+-|&<.]+="
6039 )
6041 "If matches at the start of match found by `my-bad-c-style-regexp',
6047 "Find places in the buffer where insertion of a whitespace may help.
6048 Prompts user for insertion of spaces.
6049 Currently it is tuned to C and Perl syntax."
6056 'cperl-next-bad-style
6072 t)
6085 ;; Check for a < -b and friends
6090 ;; Now check for syntax type
6099 found-bad found)))
6102 \f
6103 ;;; Getting help
6105 ;;(concat "\\("
6107 'identity
6116 "x="
6118 ;;"\\)\\|\\("
6120 ;;"\\)"
6121 ;;)
6128 ;; Does not save-excursion
6129 ;; Get to the something meaningful
6134 ;; (cond
6135 ;; ((or (eobp) (looking-at "[][ \t\n{}();,]")) ; Not at a symbol
6136 ;; (skip-chars-backward " \n\t\r({[]});,")
6137 ;; (or (bobp) (backward-char 1))))
6138 ;; Try to backtrace
6179 "Get one-line docs on the symbol at the point.
6180 The data for these docs is a little bit obsolete and may be in fact longer
6181 than a line. Your contribution to update/shorten it is appreciated."
6193 nil
6199 ;;; Stolen from perl-descr.el by Johan Vromans:
6205 "Display the documentation of symbol at point, a Perl operator."
6207 args-file regexp)
6230 ;; get the buffer with the documentation text
6233 ;; lookup in the doc
6247 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
6248 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
6249 ... Range (list context); flip/flop [no flop when flip] (scalar context).
6250 ! ... Logical negation.
6251 ... != ... Numeric inequality.
6252 ... !~ ... Search pattern, substitution, or translation (negated).
6253 $! In numeric context: errno. In a string context: error string.
6255 $# The output format for printed numbers. Default is %.15g or close.
6256 $$ Process number of this script. Changes in the fork()ed child process.
6257 $% The current page number of the currently selected output channel.
6259 The following variables are always local to the current block:
6261 $1 Match of the 1st set of parentheses in the last match (auto-local).
6262 $2 Match of the 2nd set of parentheses in the last match (auto-local).
6263 $3 Match of the 3rd set of parentheses in the last match (auto-local).
6264 $4 Match of the 4th set of parentheses in the last match (auto-local).
6265 $5 Match of the 5th set of parentheses in the last match (auto-local).
6266 $6 Match of the 6th set of parentheses in the last match (auto-local).
6267 $7 Match of the 7th set of parentheses in the last match (auto-local).
6268 $8 Match of the 8th set of parentheses in the last match (auto-local).
6269 $9 Match of the 9th set of parentheses in the last match (auto-local).
6270 $& The string matched by the last pattern match (auto-local).
6271 $' The string after what was matched by the last match (auto-local).
6272 $` The string before what was matched by the last match (auto-local).
6274 $( The real gid of this process.
6275 $) The effective gid of this process.
6276 $* Deprecated: Set to 1 to do multiline matching within a string.
6277 $+ The last bracket matched by the last search pattern.
6278 $, The output field separator for the print operator.
6279 $- The number of lines left on the page.
6280 $. The current input line number of the last filehandle that was read.
6281 $/ The input record separator, newline by default.
6282 $0 Name of the file containing the current perl script (read/write).
6283 $: String may be broken after these characters to fill ^-lines in a format.
6285 $< The real uid of this process.
6286 $= The page length of the current output channel. Default is 60 lines.
6287 $> The effective uid of this process.
6288 $? The status returned by the last ``, pipe close or `system'.
6289 $@ The perl error message from the last eval or do @var{EXPR} command.
6290 $ARGV The name of the current file used with <> .
6291 $[ Deprecated: The index of the first element/char in an array/string.
6293 $] The perl version string as displayed with perl -v.
6294 $^ The name of the current top-of-page format.
6295 $^A The current value of the write() accumulator for format() lines.
6296 $^D The value of the perl debug (-D) flags.
6297 $^E Information about the last system error other than that provided by $!.
6298 $^F The highest system file descriptor, ordinarily 2.
6299 $^H The current set of syntax checks enabled by `use strict'.
6300 $^I The value of the in-place edit extension (perl -i option).
6302 $^M A buffer for emergency memory allocation when running out of memory.
6303 $^O The operating system name under which this copy of Perl was built.
6304 $^P Internal debugging flag.
6305 $^T The time the script was started. Used by -A/-M/-C file tests.
6306 $^W True if warnings are requested (perl -w flag).
6307 $^X The name under which perl was invoked (argv[0] in C-speech).
6308 $_ The default input and pattern-searching space.
6309 $| Auto-flush after write/print on current output channel? Default 0.
6310 $~ The name of the current report format.
6311 ... % ... Modulo division.
6312 ... %= ... Modulo division assignment.
6313 %ENV Contains the current environment.
6314 %INC List of files that have been require-d or do-ne.
6315 %SIG Used to set signal handlers for various signals.
6316 ... & ... Bitwise and.
6317 ... && ... Logical and.
6318 ... &&= ... Logical and assignment.
6319 ... &= ... Bitwise and assignment.
6320 ... * ... Multiplication.
6321 ... ** ... Exponentiation.
6322 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
6323 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
6324 ... + ... Addition. +EXPR Makes EXPR into scalar context.
6325 ++ Auto-increment (magical on strings). ++EXPR EXPR++
6326 ... += ... Addition assignment.
6327 , Comma operator.
6328 ... - ... Subtraction.
6329 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
6330 ... -= ... Subtraction assignment.
6331 -A Access time in days since script started.
6332 -B File is a non-text (binary) file.
6333 -C Inode change time in days since script started.
6334 -M Age in days since script started.
6335 -O File is owned by real uid.
6336 -R File is readable by real uid.
6337 -S File is a socket .
6338 -T File is a text file.
6339 -W File is writable by real uid.
6340 -X File is executable by real uid.
6341 -b File is a block special file.
6342 -c File is a character special file.
6343 -d File is a directory.
6344 -e File exists .
6345 -f File is a plain file.
6346 -g File has setgid bit set.
6347 -k File has sticky bit set.
6348 -l File is a symbolic link.
6349 -o File is owned by effective uid.
6350 -p File is a named pipe (FIFO).
6351 -r File is readable by effective uid.
6352 -s File has non-zero size.
6353 -t Tests if filehandle (STDIN by default) is opened to a tty.
6354 -u File has setuid bit set.
6355 -w File is writable by effective uid.
6356 -x File is executable by effective uid.
6357 -z File has zero size.
6358 . Concatenate strings.
6359 .. Range (list context); flip/flop (scalar context) operator.
6360 .= Concatenate assignment strings
6361 ... / ... Division. /PATTERN/ioxsmg Pattern match
6362 ... /= ... Division assignment.
6363 /PATTERN/ioxsmg Pattern match.
6364 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
6365 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
6366 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
6367 <> Reads line from union of files in @ARGV (= command line) and STDIN.
6368 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
6369 ... <= ... Numeric less than or equal to.
6370 ... <=> ... Numeric compare.
6371 ... = ... Assignment.
6372 ... == ... Numeric equality.
6373 ... =~ ... Search pattern, substitution, or translation
6374 ... > ... Numeric greater than.
6375 ... >= ... Numeric greater than or equal to.
6376 ... >> ... Bitwise shift right.
6377 ... >>= ... Bitwise shift right assignment.
6378 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
6379 ?PATTERN? One-time pattern match.
6380 @ARGV Command line arguments (not including the command name - see $0).
6381 @INC List of places to look for perl scripts during do/include/use.
6382 @_ Parameter array for subroutines; result of split() unless in list context.
6400 ... ^ ... Bitwise exclusive or.
6401 __END__ Ends program source.
6402 __DATA__ Ends program source.
6403 __FILE__ Current (source) filename.
6404 __LINE__ Current line in current source.
6405 __PACKAGE__ Current package.
6406 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
6407 ARGVOUT Output filehandle with -i flag.
6408 BEGIN { ... } Immediately executed (during compilation) piece of code.
6409 END { ... } Pseudo-subroutine executed after the script finishes.
6410 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
6411 INIT { ... } Pseudo-subroutine executed before the script starts running.
6412 DATA Input filehandle for what follows after __END__ or __DATA__.
6413 accept(NEWSOCKET,GENERICSOCKET)
6414 alarm(SECONDS)
6415 atan2(X,Y)
6416 bind(SOCKET,NAME)
6417 binmode(FILEHANDLE)
6418 caller[(LEVEL)]
6419 chdir(EXPR)
6420 chmod(LIST)
6421 chop[(LIST|VAR)]
6422 chown(LIST)
6423 chroot(FILENAME)
6424 close(FILEHANDLE)
6425 closedir(DIRHANDLE)
6426 ... cmp ... String compare.
6427 connect(SOCKET,NAME)
6428 continue of { block } continue { block }. Is executed after `next' or at end.
6429 cos(EXPR)
6430 crypt(PLAINTEXT,SALT)
6431 dbmclose(%HASH)
6432 dbmopen(%HASH,DBNAME,MODE)
6433 defined(EXPR)
6434 delete($HASH{KEY})
6435 die(LIST)
6436 do { ... }|SUBR while|until EXPR executes at least once
6437 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
6438 dump LABEL
6439 each(%HASH)
6440 endgrent
6441 endhostent
6442 endnetent
6443 endprotoent
6444 endpwent
6445 endservent
6446 eof[([FILEHANDLE])]
6447 ... eq ... String equality.
6448 eval(EXPR) or eval { BLOCK }
6449 exec(LIST)
6450 exit(EXPR)
6451 exp(EXPR)
6452 fcntl(FILEHANDLE,FUNCTION,SCALAR)
6453 fileno(FILEHANDLE)
6454 flock(FILEHANDLE,OPERATION)
6455 for (EXPR;EXPR;EXPR) { ... }
6456 foreach [VAR] (@ARRAY) { ... }
6457 fork
6458 ... ge ... String greater than or equal.
6459 getc[(FILEHANDLE)]
6460 getgrent
6461 getgrgid(GID)
6462 getgrnam(NAME)
6463 gethostbyaddr(ADDR,ADDRTYPE)
6464 gethostbyname(NAME)
6465 gethostent
6466 getlogin
6467 getnetbyaddr(ADDR,ADDRTYPE)
6468 getnetbyname(NAME)
6469 getnetent
6470 getpeername(SOCKET)
6471 getpgrp(PID)
6472 getppid
6473 getpriority(WHICH,WHO)
6474 getprotobyname(NAME)
6475 getprotobynumber(NUMBER)
6476 getprotoent
6477 getpwent
6478 getpwnam(NAME)
6479 getpwuid(UID)
6480 getservbyname(NAME,PROTO)
6481 getservbyport(PORT,PROTO)
6482 getservent
6483 getsockname(SOCKET)
6484 getsockopt(SOCKET,LEVEL,OPTNAME)
6485 gmtime(EXPR)
6486 goto LABEL
6487 ... gt ... String greater than.
6488 hex(EXPR)
6489 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
6490 index(STR,SUBSTR[,OFFSET])
6491 int(EXPR)
6492 ioctl(FILEHANDLE,FUNCTION,SCALAR)
6493 join(EXPR,LIST)
6494 keys(%HASH)
6495 kill(LIST)
6496 last [LABEL]
6497 ... le ... String less than or equal.
6498 length(EXPR)
6499 link(OLDFILE,NEWFILE)
6500 listen(SOCKET,QUEUESIZE)
6501 local(LIST)
6502 localtime(EXPR)
6503 log(EXPR)
6504 lstat(EXPR|FILEHANDLE|VAR)
6505 ... lt ... String less than.
6506 m/PATTERN/iogsmx
6507 mkdir(FILENAME,MODE)
6508 msgctl(ID,CMD,ARG)
6509 msgget(KEY,FLAGS)
6510 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
6511 msgsnd(ID,MSG,FLAGS)
6512 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
6513 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
6514 ... ne ... String inequality.
6515 next [LABEL]
6516 oct(EXPR)
6517 open(FILEHANDLE[,EXPR])
6518 opendir(DIRHANDLE,EXPR)
6519 ord(EXPR) ASCII value of the first char of the string.
6520 pack(TEMPLATE,LIST)
6521 package NAME Introduces package context.
6522 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
6523 pop(ARRAY)
6524 print [FILEHANDLE] [(LIST)]
6525 printf [FILEHANDLE] (FORMAT,LIST)
6526 push(ARRAY,LIST)
6527 q/STRING/ Synonym for 'STRING'
6529 qx/STRING/ Synonym for `STRING`
6530 rand[(EXPR)]
6531 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6532 readdir(DIRHANDLE)
6533 readlink(EXPR)
6534 recv(SOCKET,SCALAR,LEN,FLAGS)
6535 redo [LABEL]
6536 rename(OLDNAME,NEWNAME)
6537 require [FILENAME | PERL_VERSION]
6538 reset[(EXPR)]
6539 return(LIST)
6540 reverse(LIST)
6541 rewinddir(DIRHANDLE)
6542 rindex(STR,SUBSTR[,OFFSET])
6543 rmdir(FILENAME)
6544 s/PATTERN/REPLACEMENT/gieoxsm
6545 scalar(EXPR)
6546 seek(FILEHANDLE,POSITION,WHENCE)
6547 seekdir(DIRHANDLE,POS)
6548 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
6549 semctl(ID,SEMNUM,CMD,ARG)
6550 semget(KEY,NSEMS,SIZE,FLAGS)
6551 semop(KEY,...)
6552 send(SOCKET,MSG,FLAGS[,TO])
6553 setgrent
6554 sethostent(STAYOPEN)
6555 setnetent(STAYOPEN)
6556 setpgrp(PID,PGRP)
6557 setpriority(WHICH,WHO,PRIORITY)
6558 setprotoent(STAYOPEN)
6559 setpwent
6560 setservent(STAYOPEN)
6561 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
6562 shift[(ARRAY)]
6563 shmctl(ID,CMD,ARG)
6564 shmget(KEY,SIZE,FLAGS)
6565 shmread(ID,VAR,POS,SIZE)
6566 shmwrite(ID,STRING,POS,SIZE)
6567 shutdown(SOCKET,HOW)
6568 sin(EXPR)
6569 sleep[(EXPR)]
6570 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
6571 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
6572 sort [SUBROUTINE] (LIST)
6573 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
6574 split[(/PATTERN/[,EXPR[,LIMIT]])]
6575 sprintf(FORMAT,LIST)
6576 sqrt(EXPR)
6577 srand(EXPR)
6578 stat(EXPR|FILEHANDLE|VAR)
6579 study[(SCALAR)]
6580 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
6581 substr(EXPR,OFFSET[,LEN])
6582 symlink(OLDFILE,NEWFILE)
6583 syscall(LIST)
6584 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6585 system(LIST)
6586 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
6587 tell[(FILEHANDLE)]
6588 telldir(DIRHANDLE)
6589 time
6590 times
6591 tr/SEARCHLIST/REPLACEMENTLIST/cds
6592 truncate(FILE|EXPR,LENGTH)
6593 umask[(EXPR)]
6594 undef[(EXPR)]
6595 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
6596 unlink(LIST)
6597 unpack(TEMPLATE,EXPR)
6598 unshift(ARRAY,LIST)
6599 until (EXPR) { ... } EXPR until EXPR
6600 utime(LIST)
6601 values(%HASH)
6602 vec(EXPR,OFFSET,BITS)
6603 wait
6604 waitpid(PID,FLAGS)
6605 wantarray Returns true if the sub/eval is called in list context.
6606 warn(LIST)
6607 while (EXPR) { ... } EXPR while EXPR
6608 write[(EXPR|FILEHANDLE)]
6609 ... x ... Repeat string or array.
6610 x= ... Repetition assignment.
6611 y/SEARCHLIST/REPLACEMENTLIST/
6612 ... | ... Bitwise or.
6613 ... || ... Logical or.
6614 ~ ... Unary bitwise complement.
6615 #! OS interpreter indicator. If contains `perl', used for options, and -x.
6616 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
6617 CORE:: Prefix to access builtin function if imported sub obscures it.
6618 SUPER:: Prefix to lookup for a method in @ISA classes.
6619 DESTROY Shorthand for `sub DESTROY {...}'.
6620 ... EQ ... Obsolete synonym of `eq'.
6621 ... GE ... Obsolete synonym of `ge'.
6622 ... GT ... Obsolete synonym of `gt'.
6623 ... LE ... Obsolete synonym of `le'.
6624 ... LT ... Obsolete synonym of `lt'.
6625 ... NE ... Obsolete synonym of `ne'.
6626 abs [ EXPR ] absolute value
6627 ... and ... Low-precedence synonym for &&.
6628 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
6629 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
6630 chr Converts a number to char with the same ordinal.
6631 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6632 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
6633 exists $HASH{KEY} True if the key exists.
6634 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
6636 glob EXPR Synonym of <EXPR>.
6637 lc [ EXPR ] Returns lowercased EXPR.
6638 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
6639 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
6640 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
6641 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
6642 not ... Low-precedence synonym for ! - negation.
6643 ... or ... Low-precedence synonym for ||.
6645 quotemeta [ EXPR ] Quote regexp metacharacters.
6646 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
6647 readline FH Synonym of <FH>.
6648 readpipe CMD Synonym of `CMD`.
6649 ref [ EXPR ] Type of EXPR when dereferenced.
6650 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
6651 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
6652 tied Returns internal object for a tied data.
6653 uc [ EXPR ] Returns upcased EXPR.
6654 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
6655 untie VAR Unlink an object from a simple Perl variable.
6656 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
6657 ... xor ... Low-precedence synonym for exclusive or.
6658 prototype \&SUB Returns prototype of the function given a reference.
6659 =head1 Top-level heading.
6660 =head2 Second-level heading.
6661 =head3 Third-level heading (is there such?).
6662 =over [ NUMBER ] Start list.
6663 =item [ TITLE ] Start new item in the list.
6664 =back End list.
6665 =cut Switch from POD to Perl.
6666 =pod Switch from Perl to POD.
6670 "Go to the perl documentation buffer and insert the documentation."
6683 ;; b is before the starting delimiter, e before the ending
6684 ;; e should be a marker, may be changed, but remains "correct".
6685 ;; EMBED is nil iff we process the whole REx.
6686 ;; The REx is guarantied to have //x
6687 ;; LEVEL shows how many levels deep to go
6688 ;; position at enter and at leave is not defined
6722 inline t)
6727 inline
6733 "[$^]"
6755 ;; XXXX POSIX classes?!
6780 ;; (or (forward-sexp 1)
6781 ;; (progn
6782 ;; (goto-char tmp)
6783 ;; (error "()-group not terminated")))
6788 ;; In fact does not make a lot of sense, since
6789 ;; the starting position can be already lost due
6790 ;; to insertion of "\n" and " "
6799 t)
6835 ;; first at line
6855 ;; Special-case the last line of group
6866 ;; Returns position of the start
6867 ;; XXX this is called too often! Need to cache the result!
6871 ;; Find the start
6873 nil ; good already
6877 ;;(forward-char 1)
6889 ;; Protect fragile " ", "#"
6892 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
6896 b)))
6899 "Do it. (Experimental, may change semantics, recheck the result.)
6900 We suppose that the regexp is scanned already."
6911 "Goto start of an enclosing group in regexp.
6912 We suppose that the regexp is scanned already."
6926 "Find an enclosing group in regexp and contract it.
6927 \(Experimental, may change semantics, recheck the result.)
6928 We suppose that the regexp is scanned already."
6930 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
6950 "Find an enclosing group in regexp and contract all the kids.
6951 \(Experimental, may change semantics, recheck the result.)
6952 We suppose that the regexp is scanned already."
6966 nil)
6971 "Find an enclosing group in regexp and beautify it.
6972 \(Experimental, may change semantics, recheck the result.)
6973 We suppose that the regexp is scanned already."
6984 "Change `if (A) {B}' into `B if A;' etc if possible."
6990 pos2 pos3 pos4 pos5 s1 s2 state p pos45
7003 ;; XXXX In fact may be `A if (B); {C}' ...
7023 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" pos45 t)
7032 ;; Finally got it
7069 ;;; By Anthony Foiani <afoiani@uswest.com>
7070 ;;; Getting help on modules in C-h f ?
7071 ;;; This is a modified version of `man'.
7072 ;;; Need to teach it how to lookup functions
7074 "Run `perldoc' on WORD."
7080 ""
7085 default-entry)
7086 input))))
7093 'cperl-short-docs
7105 "Run a `perldoc' on the word around point."
7110 "*File name for `pod2man'."
7114 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
7116 "Create a virtual manpage in Emacs from the Perl Online Documentation."
7125 ;; Prevent any attempt to use display terminal fanciness.
7132 ;;; Updated version by him too
7134 "Create a virtual manpage in Emacs from the POD in the file."
7146 "Builds the entire background manpage and cleaning command."
7157 phrase)
7160 command))
7174 "Switches on Auto-Help on Perl constructs (put in the message area).
7175 Delay of auto-help controlled by `cperl-lazy-help-time'."
7184 t
7189 "Switches off Auto-Help on Perl constructs (put in the message area).
7190 Delay of auto-help controlled by `cperl-lazy-help-time'."
7207 ;;; Plug for wrong font-lock:
7212 before-change-functions after-change-functions
7213 deactivate-mark buffer-file-name buffer-file-truename)
7220 ;; Some vars for debugging only
7221 ;; (message "Syntaxifying...")
7224 start)
7233 ;; Need to forget what is after `start'
7235 ;; Fontification without a change
7242 dbg iend
7243 start end cperl-syntax-done-to
7258 cperl-syntaxify-by-font-lock
7274 ;;; cperl-mode.el ends here