| blob | 13c3d37b79b1f5630b613ed1c9f951f4f52b7566 |
1 ;;; cperl-mode.el --- Perl code editing commands for Emacs
3 ;; Copyright (C) 1985, 1986, 1987, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
5 ;; Free Software Foundation, Inc.
7 ;; Author: Ilya Zakharevich and Bob Olson
8 ;; Maintainer: Ilya Zakharevich <ilyaz@cpan.org>
9 ;; Keywords: languages, Perl
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
26 ;;; Corrections made by Ilya Zakharevich ilyaz@cpan.org
28 ;;; Commentary:
30 ;; You can either fine-tune the bells and whistles of this mode or
31 ;; bulk enable them by putting
33 ;; (setq cperl-hairy t)
35 ;; in your .emacs file. (Emacs rulers do not consider it politically
36 ;; correct to make whistles enabled by default.)
38 ;; DO NOT FORGET to read micro-docs (available from `Perl' menu) <<<<<<
39 ;; or as help on variables `cperl-tips', `cperl-problems', <<<<<<
40 ;; `cperl-praise', `cperl-speed'. <<<<<<
42 ;; The mode information (on C-h m) provides some customization help.
43 ;; If you use font-lock feature of this mode, it is advisable to use
44 ;; either lazy-lock-mode or fast-lock-mode. I prefer lazy-lock.
46 ;; Faces used now: three faces for first-class and second-class keywords
47 ;; and control flow words, one for each: comments, string, labels,
48 ;; functions definitions and packages, arrays, hashes, and variable
49 ;; definitions. If you do not see all these faces, your font-lock does
50 ;; not define them, so you need to define them manually.
52 ;; This mode supports font-lock, imenu and mode-compile. In the
53 ;; hairy version font-lock is on, but you should activate imenu
54 ;; yourself (note that mode-compile is not standard yet). Well, you
55 ;; can use imenu from keyboard anyway (M-x imenu), but it is better
56 ;; to bind it like that:
58 ;; (define-key global-map [M-S-down-mouse-3] 'imenu)
60 ;;; Font lock bugs as of v4.32:
62 ;; The following kinds of Perl code erroneously start strings:
63 ;; \$` \$' \$"
64 ;; $opt::s $opt_s $opt{s} (s => ...) /\s+.../
65 ;; likewise with m, tr, y, q, qX instead of s
67 ;;; Code:
68 \f
93 nil))
100 nil))
101 ;; Avoid warning (tmp definitions)
105 ;; XEmacs >= 19.12
107 ;; XEmacs 19.11
114 ;; (face-list))
140 ;;(progn
141 ;; (switch-to-buffer (get-file-buffer (elt ,elt 0)))
142 ;; (set-buffer (get-file-buffer (elt ,elt 0)))
143 ;; Probably will not work due to some save-excursion???
144 ;; Or save-file-position?
145 ;; (message "Did I get to line %s?" (elt ,elt 1))
147 ;;)
165 answer))
168 "Major mode for editing Perl code."
174 "Indentation."
179 "Variables affected by `cperl-hairy'."
184 "Auto-insert tuneup."
189 "Fontification colors."
195 "Speed vs. validity tuneup."
200 "Help system tuneup."
204 \f
206 "*Non-nil means that if, elsif, while, until, else, for, foreach
207 and do constructs look like:
209 if ()
210 {
211 }
213 instead of:
215 if () {
216 }"
221 cperl-extra-newline-before-brace
222 "*Non-nil means the same as `cperl-extra-newline-before-brace', but
223 for constructs with multiline if/unless/while/until/for/foreach condition."
228 "*Indentation of CPerl statements with respect to containing block."
232 ;; Is is not unusual to put both things like perl-indent-level and
233 ;; cperl-indent-level in the local variable section of a file. If only
234 ;; one of perl-mode and cperl-mode is in use, a warning will be issued
235 ;; about the variable. Autoload these here, so that no warning is
236 ;; issued when using either perl-mode or cperl-mode.
237 ;;;###autoload(put 'cperl-indent-level 'safe-local-variable 'integerp)
238 ;;;###autoload(put 'cperl-brace-offset 'safe-local-variable 'integerp)
239 ;;;###autoload(put 'cperl-continued-brace-offset 'safe-local-variable 'integerp)
240 ;;;###autoload(put 'cperl-label-offset 'safe-local-variable 'integerp)
241 ;;;###autoload(put 'cperl-continued-statement-offset 'safe-local-variable 'integerp)
242 ;;;###autoload(put 'cperl-extra-newline-before-brace 'safe-local-variable 'booleanp)
243 ;;;###autoload(put 'cperl-merge-trailing-else 'safe-local-variable 'booleanp)
246 "*`cperl-lineup' will always lineup at multiple of this number.
247 If nil, the value of `cperl-indent-level' will be used."
252 "*Imagined indentation of a Perl open brace that actually follows a statement.
253 An open brace following other text is treated as if it were this far
254 to the right of the start of its line."
259 "*Extra indentation for braces, compared with other text in same context."
263 "*Offset of CPerl label lines relative to usual indentation."
267 "*Minimal offset of CPerl label lines."
271 "*Extra indent for lines not starting new statements."
275 "*Extra indent for substatements that start with open-braces.
276 This is in addition to cperl-continued-statement-offset."
280 "*Extra indent for substatements that start with close-parenthesis."
285 "*Non-nil means indent statements in if/etc block relative brace, not if/etc.
286 Versions 5.2 ... 5.20 behaved as if this were `nil'."
291 "*Non-nil means automatically newline before and after braces,
292 and after colons and semicolons, inserted in CPerl code. The following
294 Insertion after colons requires both this variable and
295 `cperl-auto-newline-after-colon' set."
300 "*Non-nil means automatically indent after insertion of (semi)colon.
301 Active if `cperl-auto-newline' is false."
306 "*Non-nil means automatically newline even after colons.
307 Subject to `cperl-auto-newline' setting."
312 "*Non-nil means TAB in CPerl mode should always reindent the current line,
313 regardless of where in the line point is when the TAB command is used."
318 "*Non-nil (and non-null) means CPerl buffers will use `font-lock-mode'.
319 Can be overwritten by `cperl-hairy' if nil."
324 "*Non-nil (and non-null) means { after $ should be preceded by ` '.
325 Can be overwritten by `cperl-hairy' if nil."
330 "*String of parentheses that should be electric in CPerl.
331 Closing ones are electric only if the region is highlighted."
336 "*Non-nil (and non-null) means parentheses should be electric in CPerl.
337 Can be overwritten by `cperl-hairy' if nil."
346 transient-mark-mode)
348 zmacs-regions)))
349 "*Not-nil means that electric parens look for active mark.
350 Default is yes if there is visual feedback on mark."
355 "*If true, LFD should be hairy in CPerl, otherwise C-c LFD is hairy.
356 In any case these two mean plain and hairy linefeeds together.
357 Can be overwritten by `cperl-hairy' if nil."
362 "*Not-nil (and non-null) means keywords are electric in CPerl.
363 Can be overwritten by `cperl-hairy' if nil.
365 Uses `abbrev-mode' to do the expansion. If you want to use your
366 own abbrevs in cperl-mode, but do not want keywords to be
367 electric, you must redefine `cperl-mode-abbrev-table': do
369 that paragraph, delete the words that appear at the ends of lines and
371 "
376 "*Not-nil means electric-backspace will untabify in CPerl."
381 "*Not-nil means most of the bells and whistles are enabled in CPerl.
382 Affects: `cperl-font-lock', `cperl-electric-lbrace-space',
383 `cperl-electric-parens', `cperl-electric-linefeed', `cperl-electric-keywords',
384 `cperl-info-on-command-no-prompt', `cperl-clobber-lisp-bindings',
385 `cperl-lazy-help-time'."
395 "*Non-nil means that comment started at column 0 should be indentable."
400 "*Special version of `vc-sccs-header' that is used in CPerl mode buffers."
405 "*Special version of `vc-rcs-header' that is used in CPerl mode buffers."
409 ;; This became obsolete...
412 'cperl-vc-header-alist
421 "*Whether to install us into `interpreter-' and `extension' mode lists."
426 "*Not-nil (and non-null) means not to prompt on C-h f.
427 The opposite behavior is always available if prefixed with C-c.
428 Can be overwritten by `cperl-hairy' if nil."
433 "*Not-nil (and non-null) means not overwrite C-h f.
435 Can be overwritten by `cperl-hairy' if nil."
440 "*Not-nil (and non-null) means to show lazy help after given idle time.
441 Can be overwritten by `cperl-hairy' to be 5 sec if nil."
446 "*Face for POD highlighting."
451 "*Face for POD highlighting.
452 Font for POD headers."
457 "*Face for here-docs highlighting."
461 ;;; Some double-evaluation happened with font-locks... Needed with 21.2...
465 "*Face for highlighting trailing whitespace."
471 "*Not-nil after evaluation means to highlight POD and here-docs sections."
476 "*Not-nil means highlight 1arg regular expressions operators same as 2arg."
481 "*Non-nil means perform additional highlighting on variables.
482 Currently only changes how scalar variables are highlighted.
483 Note that that variable is only read at initialization time for
484 the variable `cperl-font-lock-keywords-2', so changing it after you've
485 entered CPerl mode the first time will have no effect."
490 "*Not-nil means look for POD and here-docs sections during startup.
496 "*Not-nil means make marking of regular expression more thorough.
497 Effective only with `cperl-pod-here-scan'."
502 "*Not-nil means install hook to know which regions of buffer are changed.
503 May significantly speed up delayed fontification. Changes take effect
504 after reload."
509 "*Not-nil means add backreferences to generated `imenu's.
510 May require patched `imenu' and `imenu-go'. Obsolete."
515 "*Non-nil means shrink-wrapping of info-buffer allowed up to these percents."
520 "*Non-nil means shrink-wrapping of info-buffer-frame allowed."
525 "*Name of the info page containing perl docs.
526 Older version of this page was called `perl5', newer `perl'."
532 "*Non-nil means CPerl sets up and uses `syntax-table' text property."
537 cperl-use-syntax-table-text-property
538 "*Non-nil means: set up and use `syntax-table' text property generating TAGS."
543 "*Regexp to match files to scan when generating TAGS."
549 "*Regexp to match files/dirs to skip when generating TAGS."
554 "*Indentation used when beautifying regexps.
555 If nil, the value of `cperl-indent-level' will be used."
560 "*Non-nil means that the comment starting in leftmost column should indent."
565 "*Non-nil means that the _ (underline) should be treated as word char."
570 "*Extra arguments to use when starting Perl.
571 Currently used with `cperl-check-syntax' only."
576 "*Non-nil means that the `cperl-electric-keyword' prints a help message."
581 "*Amount of space to insert between `}' and `else' or `elsif'
582 in `cperl-indent-region'. Set to nil to leave as is. Values other
583 than 1 and nil will probably not work."
588 "*Non-nil means that one-line if/unless/while/until/for/foreach BLOCKs
589 need to be reformatted into multiline ones when indenting a region."
594 "*Non-nil means that BLOCK-end `}' may be put on a separate line
595 when indenting a region.
596 Braces followed by else/elsif/while/until are excepted."
601 "*Non-nil means that BLOCK-end `}' followed by else/elsif/continue
602 may be merged to be on the same line when indenting a region."
607 "*Non-nil means that non-block ()-, {}- and []-groups are indented as blocks,
609 One should tune up `cperl-close-paren-offset' as well."
616 "*Non-nil means that CPerl uses `font-lock's routines for syntaxification."
621 t
622 "*Non-nil means that CPerl unwinds to a start of a long construction
623 when syntaxifying a chunk of buffer."
628 t
629 "*Non-nil means that CPerl syntaxifies up to the point before showing menu.
630 This way enabling/disabling of menu items is more correct."
647 "List given as an argument to `ps-extend-face-list' in `cperl-ps-print'."
669 "Font Lock mode face used non-overridable keywords and modifiers of regexps."
682 "Font Lock mode face used to highlight array names."
695 "Font Lock mode face used to highlight hash names."
698 \f
700 ;;; Short extra-docs.
703 "Get maybe newer version of this package from
704 http://ilyaz.org/software/emacs
705 Subdirectory `cperl-mode' may contain yet newer development releases and/or
706 patches to related files.
708 For best results apply to an older Emacs the patches from
709 ftp://ftp.math.ohio-state.edu/pub/users/ilya/cperl-mode/patches
710 \(this upgrades syntax-parsing abilities of Emacsen v19.34 and
711 v20.2 up to the level of Emacs v20.3 - a must for a good Perl
712 mode.) As of beginning of 2003, XEmacs may provide a similar ability.
714 Get support packages choose-color.el (or font-lock-extra.el before
715 19.30), imenu-go.el from the same place. \(Look for other files there
716 too... ;-). Get a patch for imenu.el in 19.29. Note that for 19.30 and
717 later you should use choose-color.el *instead* of font-lock-extra.el
718 \(and you will not get smart highlighting in C :-().
720 Note that to enable Compile choices in the menu you need to install
721 mode-compile.el.
723 If your Emacs does not default to `cperl-mode' on Perl files, and you
724 want it to: put the following into your .emacs file:
726 (defalias 'perl-mode 'cperl-mode)
728 Get perl5-info from
729 $CPAN/doc/manual/info/perl5-old/perl5-info.tar.gz
730 Also, one can generate a newer documentation running `pod2texi' converter
731 $CPAN/doc/manual/info/perl5/pod2texi-0.1.tar.gz
733 If you use imenu-go, run imenu on perl5-info buffer (you can do it
734 from Perl menu). If many files are related, generate TAGS files from
735 Tools/Tags submenu in Perl menu.
737 If some class structure is too complicated, use Tools/Hierarchy-view
738 from Perl menu, or hierarchic view of imenu. The second one uses the
739 current buffer only, the first one requires generation of TAGS from
740 Perl/Tools/Tags menu beforehand.
742 Run Perl/Tools/Insert-spaces-if-needed to fix your lazy typing.
744 Switch auto-help on/off with Perl/Tools/Auto-help.
746 Though with contemporary Emaxen CPerl mode should maintain the correct
747 parsing of Perl even when editing, sometimes it may be lost. Fix this by
751 In cases of more severe confusion sometimes it is helpful to do
756 Before reporting (non-)problems look in the problem section of online
760 "Description of problems in CPerl mode.
761 Some faces will not be shown on some versions of Emacs unless you
762 install choose-color.el, available from
763 http://ilyaz.org/software/emacs
765 `fill-paragraph' on a comment may leave the point behind the
766 paragraph. It also triggers a bug in some versions of Emacs (CPerl tries
767 to detect it and bulk out).
769 See documentation of a variable `cperl-problems-old-emaxen' for the
770 problems which disappear if you upgrade Emacs to a reasonably new
774 "Description of problems in CPerl mode specific for older Emacs versions.
776 Emacs had a _very_ restricted syntax parsing engine until version
777 20.1. Most problems below are corrected starting from this version of
778 Emacs, and all of them should be fixed in version 20.3. (Or apply
779 patches to Emacs 19.33/34 - see tips.) XEmacs was very backward in
780 this respect (until 2003).
782 Note that even with newer Emacsen in some very rare cases the details
783 of interaction of `font-lock' and syntaxification may be not cleaned
784 up yet. You may get slightly different colors basing on the order of
785 fontification and syntaxification. Say, the initial faces is correct,
786 but editing the buffer breaks this.
788 Even with older Emacsen CPerl mode tries to corrects some Emacs
789 misunderstandings, however, for efficiency reasons the degree of
790 correction is different for different operations. The partially
791 corrected problems are: POD sections, here-documents, regexps. The
792 operations are: highlighting, indentation, electric keywords, electric
793 braces.
795 This may be confusing, since the regexp s#//#/#\; may be highlighted
796 as a comment, but it will be recognized as a regexp by the indentation
797 code. Or the opposite case, when a POD section is highlighted, but
798 may break the indentation of the following code (though indentation
799 should work if the balance of delimiters is not broken by POD).
802 ${aaa} look like unbalanced braces. The only trick I can think of is
803 to insert it as $ {aaa} (valid in perl5, not in perl4).
808 The solution is to upgrade your Emacs or patch an older one. Note
809 that Emacs 20.2 has some bugs related to `syntax-table' text
810 properties. Patches are available on the main CPerl download site,
811 and on CPAN.
813 If these bugs cannot be fixed on your machine (say, you have an inferior
814 environment and cannot recompile), you may still disable all the fancy stuff
818 "Advantages of CPerl mode.
820 0) It uses the newest `syntax-table' property ;-);
822 1) It does 99% of Perl syntax correct (as opposed to 80-90% in Perl
823 mode - but the latter number may have improved too in last years) even
824 with old Emaxen which do not support `syntax-table' property.
826 When using `syntax-table' property for syntax assist hints, it should
827 handle 99.995% of lines correct - or somesuch. It automatically
828 updates syntax assist hints when you edit your script.
832 things tried _all_ the rest of Emacs ;-), but this was not a lonely
833 voice);
835 3) Everything is customizable, one-by-one or in a big sweep;
838 a) Can run program, check syntax, start debugger;
840 a = b;
841 cc = d;
842 c) Can insert spaces where this impoves readability (in one
843 interactive sweep over the buffer);
844 d) Has support for imenu, including:
846 2) Separate TOC of POD sections;
847 3) Separate list of packages;
848 4) Hierarchical view of methods in (sub)packages;
849 5) and functions (by the full name - with package);
850 e) Has an interface to INFO docs for Perl; The interface is
851 very flexible, including shrink-wrapping of
852 documentation buffer/frame;
853 f) Has a builtin list of one-line explanations for perl constructs.
854 g) Can show these explanations if you stay long enough at the
855 corresponding place (or on demand);
856 h) Has an enhanced fontification (using 3 or 4 additional faces
857 comparing to font-lock - basically, different
858 namespaces in Perl have different colors);
859 i) Can construct TAGS basing on its knowledge of Perl syntax,
860 the standard menu has 6 different way to generate
862 bindings - are included in the scan);
863 j) Can build a hierarchical view of classes (via imenu) basing
864 on generated TAGS file;
865 k) Has electric parentheses, electric newlines, uses Abbrev
866 for electric logical constructs
867 while () {}
868 with different styles of expansion (context sensitive
869 to be not so bothering). Electric parentheses behave
872 m) Can convert from
873 if (A) { B }
874 to
875 B if A;
877 n) Highlights (by user-choice) either 3-delimiters constructs
878 (such as tr/a/b/), or regular expressions and `y/tr';
879 o) Highlights trailing whitespace;
880 p) Is able to manipulate Perl Regular Expressions to ease
881 conversion to a more readable form.
882 q) Can ispell POD sections and HERE-DOCs.
883 r) Understands comments and character classes inside regular
884 expressions; can find matching () and [] in a regular expression.
885 s) Allows indentation of //x-style regular expressions;
886 t) Highlights different symbols in regular expressions according
887 to their function; much less problems with backslashitis;
888 u) Allows to find regular expressions which contain interpolated parts.
890 5) The indentation engine was very smart, but most of tricks may be
891 not needed anymore with the support for `syntax-table' property. Has
892 progress indicator for indentation (with `imenu' loaded).
894 6) Indent-region improves inline-comments as well; also corrects
895 whitespace *inside* the conditional/loop constructs.
897 7) Fill-paragraph correctly handles multi-line comments;
899 8) Can switch to different indentation styles by one command, and restore
900 the settings present before the switch.
902 9) When doing indentation of control constructs, may correct
903 line-breaks/spacing between elements of the construct.
905 10) Uses a linear-time algorith for indentation of regions (on Emaxen with
906 capable syntax engines).
908 11) Syntax-highlight, indentation, sexp-recognition inside regular expressions.
912 "This is an incomplete compendium of what is available in other parts
913 of CPerl documentation. (Please inform me if I skept anything.)
915 There is a perception that CPerl is slower than alternatives. This part
916 of documentation is designed to overcome this misconception.
918 *By default* CPerl tries to enable the most comfortable settings.
919 From most points of view, correctly working package is infinitely more
920 comfortable than a non-correctly working one, thus by default CPerl
921 prefers correctness over speed. Below is the guide how to change
922 settings if your preferences are different.
924 A) Speed of loading the file. When loading file, CPerl may perform a
925 scan which indicates places which cannot be parsed by primitive Emacs
926 syntax-parsing routines, and marks them up so that either
928 A1) CPerl may work around these deficiencies (for big chunks, mostly
929 PODs and HERE-documents), or
930 A2) On capable Emaxen CPerl will use improved syntax-handlings
931 which reads mark-up hints directly.
933 The scan in case A2 is much more comprehensive, thus may be slower.
935 User can disable syntax-engine-helping scan of A2 by setting
936 `cperl-use-syntax-table-text-property'
937 variable to nil (if it is set to t).
939 One can disable the scan altogether (both A1 and A2) by setting
940 `cperl-pod-here-scan'
941 to nil.
943 B) Speed of editing operations.
945 One can add a (minor) speedup to editing operations by setting
946 `cperl-use-syntax-table-text-property'
947 variable to nil (if it is set to t). This will disable
948 syntax-engine-helping scan, thus will make many more Perl
949 constructs be wrongly recognized by CPerl, thus may lead to
950 wrongly matched parentheses, wrong indentation, etc.
952 One can unset `cperl-syntaxify-unwind'. This might speed up editing
956 "CPerl mode uses following faces for highlighting:
958 `cperl-array-face' Array names
959 `cperl-hash-face' Hash names
960 `font-lock-comment-face' Comments, PODs and whatever is considered
961 syntaxically to be not code
962 `font-lock-constant-face' HERE-doc delimiters, labels, delimiters of
963 2-arg operators s/y/tr/ or of RExen,
964 `font-lock-warning-face' Special-cased m// and s//foo/,
965 `font-lock-function-name-face' _ as a target of a file tests, file tests,
966 subroutine names at the moment of definition
967 (except those conflicting with Perl operators),
968 package names (when recognized), format names
969 `font-lock-keyword-face' Control flow switch constructs, declarators
970 `cperl-nonoverridable-face' Non-overridable keywords, modifiers of RExen
971 `font-lock-string-face' Strings, qw() constructs, RExen, POD sections,
972 literal parts and the terminator of formats
973 and whatever is syntaxically considered
974 as string literals
975 `font-lock-type-face' Overridable keywords
976 `font-lock-variable-name-face' Variable declarations, indirect array and
977 hash names, POD headers/item names
978 `cperl-invalid' Trailing whitespace
980 Note that in several situations the highlighting tries to inform about
981 possible confusion, such as different colors for function names in
982 declarations depending on what they (do not) override, or special cases
983 m// and s/// which do not do what one would expect them to do.
985 Help with best setup of these faces for printout requested (for each of
986 the faces: please specify bold, italic, underline, shadow and box.)
988 In regular expressions (except character classes):
990 `font-lock-constant-face': Delimiters
991 `font-lock-warning-face' Special-cased m// and s//foo/,
992 Mismatched closing delimiters, parens
993 we couldn't match, misplaced quantifiers,
994 unrecognized escape sequences
995 `cperl-nonoverridable-face' Modifiers, as gism in m/REx/gism
996 `font-lock-type-face' POSIX classes inside charclasses,
997 escape sequences with arguments (\x \23 \p \N)
998 and others match-a-char escape sequences
999 `font-lock-keyword-face' Capturing parens, and |
1000 `font-lock-function-name-face' Special symbols: $ ^ . [ ] [^ ] (?{ }) (??{ })
1002 parts of a REx, not-capturing parens
1003 `font-lock-variable-name-face' Interpolated constructs, embedded code
1004 `font-lock-comment-face' Embedded comments
1008 \f
1010 ;;; Portability stuff:
1016 emacs-key)
1030 ;; "Active regions" are on: use region only if active
1031 ;; "Active regions" are off: use region unconditionally
1039 cperl-can-font-lock)
1055 'fontified
1060 ;; If POST, do not do it with postponed fontification
1062 nil
1064 to cperl-do-not-fontify t)))
1067 "Hook run by CPerl mode."
1075 \f
1076 ;; Make customization possible "in reverse"
1082 \f
1085 "Makes indent of the current line the requested amount.
1086 Unless KEEP, removes the old indentation. Works around a bug in ancient
1087 versions of Emacs."
1092 ;; In old versions (e.g., 19.33) `indent-to' would not inherit properties
1102 ;;; Probably it is too late to set these guys already, but it can help later:
1104 ;;;(and cperl-clobber-mode-lists
1105 ;;;(setq auto-mode-alist
1106 ;;; (append '(("\\.\\([pP][Llm]\\|al\\)$" . perl-mode)) auto-mode-alist ))
1107 ;;;(and (boundp 'interpreter-mode-alist)
1108 ;;; (setq interpreter-mode-alist (append interpreter-mode-alist
1109 ;;; '(("miniperl" . perl-mode))))))
1121 ;; Calling `cperl-enable-font-lock' below doesn't compile on XEmacs,
1122 ;; macros instead of defsubsts don't work on Emacs, so we do the
1123 ;; expansion manually. Any other suggestions?
1165 ;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1166 ;;(cperl-define-key "\e;" 'cperl-indent-for-comment)
1169 ;; don't clobber the backspace binding:
1175 ;;(concat (char-to-string help-char) "f") ; does not work
1176 'cperl-info-on-command
1179 ;;(concat (char-to-string help-char) "v") ; does not work
1180 'cperl-get-help
1183 ;;(concat (char-to-string help-char) "f") ; does not work
1187 ;;(concat (char-to-string help-char) "v") ; does not work
1193 ;;(concat (char-to-string help-char) "v") ; does not work
1194 'cperl-get-help
1199 ;; substitute-key-definition is usefulness-deenhanced...
1200 ;;;;;(cperl-define-key "\M-q" 'cperl-fill-paragraph)
1206 cperl-mode-map global-map))
1209 cperl-mode-map global-map)
1212 cperl-mode-map global-map)
1215 cperl-mode-map global-map)))
1224 cperl-menu cperl-mode-map "Menu for CPerl mode"
1231 "----"
1236 cperl-use-syntax-table-text-property]
1238 cperl-use-syntax-table-text-property]
1240 cperl-use-syntax-table-text-property]
1242 cperl-use-syntax-table-text-property]
1244 cperl-use-syntax-table-text-property]
1246 cperl-use-syntax-table-text-property]
1247 "----"
1251 cperl-next-interpolated-REx-0
1255 cperl-next-interpolated-REx-1
1259 "----"
1263 "----"
1269 "----"
1271 "----"
1275 "----"
1277 ;; Better not to update syntaxification here:
1278 ;; debugging syntaxificatio can be broken by this???
1298 cperl-select-this-pod-or-here-doc
1304 "----"
1307 "----"
1315 "----"
1317 ;;["Update classes" (cperl-tags-hier-init t) tags-table-list]
1319 ;;; ["Create tags for current file" cperl-etags t]
1320 ;;; ["Add tags for current file" (cperl-etags t) t]
1321 ;;; ["Create tags for Perl files in directory" (cperl-etags nil t) t]
1322 ;;; ["Add tags for Perl files in directory" (cperl-etags t t) t]
1323 ;;; ["Create tags for Perl files in (sub)directories"
1324 ;;; (cperl-etags nil 'recursive) t]
1325 ;;; ["Add tags for Perl files in (sub)directories"
1326 ;;; (cperl-etags t 'recursive) t])
1327 ;;;; cperl-write-tags (&optional file erase recurse dir inbuffer)
1352 cperl-lazy-installed)])
1383 "Display the result of expanding all C macros occurring in the region.
1384 The expansion is entirely correct because it uses the C preprocessor."
1385 t)
1387 ;;; These two must be unwound, otherwise take exponential time
1389 "Regular expression to match optional whitespace with interpspersed comments.
1392 ;;; This one is tricky to unwind; still very inefficient...
1394 "Regular expression to match whitespace with interpspersed comments.
1398 ;;; Is incorporated in `cperl-imenu--function-name-regexp-perl'
1399 ;;; `cperl-outline-regexp', `defun-prompt-regexp'.
1400 ;;; Details of groups in this may be used in several functions; see comments
1401 ;;; near mentioned above variable(s)...
1402 ;;; sub($$):lvalue{} sub:lvalue{} Both allowed...
1404 "Match the text after `sub' in a subroutine declaration.
1406 of attributes (if present), or end of the name or prototype (whatever is
1407 the last)."
1410 cperl-white-and-comment-rex ; n+2=pre-name
1415 cperl-maybe-white-and-comment-rex ; n+5=pre-proto
1419 cperl-maybe-white-and-comment-rex ; n+8=pre-attr
1421 ":"
1424 cperl-maybe-white-and-comment-rex ; whitespace-comments
1426 ;; attr-arg (1 level of internal parens allowed!)
1429 cperl-maybe-white-and-comment-rex ; whitespace-comments
1435 ))
1437 ;;; Details of groups in this are used in `cperl-imenu--create-perl-index'
1438 ;;; and `cperl-outline-level'.
1439 ;;;; Was: 2=sub|package; now 2=package-group, 5=package-name 8=sub-name (+3)
1445 cperl-white-and-comment-rex ; 4 = pre-package-name
1450 cperl-maybe-white-and-comment-rex ; 15=pre-block
1472 ()
1500 \f
1502 ;; Fix for msb.el
1509 ;; NB as it stands the code in cperl-mode assumes this only has one
1510 ;; element. If Xemacs 19 support were dropped, this could all be simplified.
1512 ;; This look like a paranoiac regexp: could anybody find a better one? (which WORKS).
1519 ;;;###autoload
1521 "Major mode for editing Perl code.
1522 Expression and list commands understand all C brackets.
1523 Tab indents for Perl code.
1524 Paragraphs are separated by blank lines only.
1525 Delete converts tabs to spaces as it moves back.
1527 Various characters in Perl almost always come in pairs: {}, (), [],
1528 sometimes <>. When the user types the first, she gets the second as
1529 well, with optional special formatting done on {}. (Disabled by
1533 whether you want to type pair <>, and inserts is if it
1534 appropriate. You can set `cperl-electric-parens-string' to the string that
1535 contains the parenths from the above list you want to be electrical.
1536 Electricity of parenths is controlled by `cperl-electric-parens'.
1537 You may also set `cperl-electric-parens-mark' to have electric parens
1540 CPerl mode provides expansion of the Perl control constructs:
1542 if, else, elsif, unless, while, until, continue, do,
1543 for, foreach, formy and foreachmy.
1545 and POD directives (Disabled by default, see `cperl-electric-keywords'.)
1547 The user types the keyword immediately followed by a space, which
1548 causes the construct to be expanded, and the point is positioned where
1549 she is most likely to want to be. eg. when the user types a space
1551 } { } and the cursor is between the parentheses. The user can then
1552 type some boolean expression within the parens. Having done that,
1555 directive line, then appropriate number of new lines is inserted).
1559 bite if angry;
1561 it will not do any expansion. See also help on variable
1562 `cperl-extra-newline-before-brace'. (Note that one can switch the
1563 help message on expansion by setting `cperl-message-electric-keyword'
1564 to nil.)
1567 return. It places you in the next line with proper indentation, or if
1568 you type it inside the inline block of control construct, like
1570 foreach (@lines) {print; print}
1572 and you are on a boundary of a statement inside braces, it will
1573 transform the construct into a multiline and will place you into an
1574 appropriately indented blank line. If you need a usual
1576 see documentation on `cperl-electric-linefeed'.
1580 if (A) { B }
1582 into
1584 B if A;
1588 Setting the variable `cperl-font-lock' to t switches on font-lock-mode
1589 \(even with older Emacsen), `cperl-electric-lbrace-space' to t switches
1590 on electric space between $ and {, `cperl-electric-parens-string' is
1591 the string that contains parentheses that should be electric in CPerl
1592 \(see also `cperl-electric-parens-mark' and `cperl-electric-parens'),
1593 setting `cperl-electric-keywords' enables electric expansion of
1594 control structures in CPerl. `cperl-electric-linefeed' governs which
1595 one of two linefeed behavior is preferable. You can enable all these
1596 options simultaneously (recommended mode of use) by setting
1597 `cperl-hairy' to t. In this case you can switch separate options off
1598 by setting them to `null'. Note that one may undo the extra
1599 whitespace inserted by semis and braces in `auto-newline'-mode by
1602 If your site has perl5 documentation in info format, you can use commands
1604 These keys run commands `cperl-info-on-current-command' and
1605 `cperl-info-on-command', which one is which is controlled by variable
1606 `cperl-info-on-command-no-prompt' and `cperl-clobber-lisp-bindings'
1607 \(in turn affected by `cperl-hairy').
1609 Even if you have no info-format documentation, short one-liner-style
1611 man via menu.
1613 It is possible to show this help automatically after some idle time.
1614 This is regulated by variable `cperl-lazy-help-time'. Default with
1615 `cperl-hairy' (if the value of `cperl-lazy-help-time' is nil) is 5
1616 secs idle time . It is also possible to switch this on/off from the
1620 beginning of the region at the start of construction, and make region
1621 span the needed amount of lines.
1623 Variables `cperl-pod-here-scan', `cperl-pod-here-fontify',
1624 `cperl-pod-face', `cperl-pod-head-face' control processing of POD and
1625 here-docs sections. With capable Emaxen results of scan are used
1626 for indentation too, otherwise they are used for highlighting only.
1628 Variables controlling indentation style:
1629 `cperl-tab-always-indent'
1630 Non-nil means TAB in CPerl mode should always reindent the current line,
1631 regardless of where in the line point is when the TAB command is used.
1632 `cperl-indent-left-aligned-comments'
1633 Non-nil means that the comment starting in leftmost column should indent.
1634 `cperl-auto-newline'
1635 Non-nil means automatically newline before and after braces,
1636 and after colons and semicolons, inserted in Perl code. The following
1638 Insertion after colons requires both this variable and
1639 `cperl-auto-newline-after-colon' set.
1640 `cperl-auto-newline-after-colon'
1641 Non-nil means automatically newline even after colons.
1642 Subject to `cperl-auto-newline' setting.
1643 `cperl-indent-level'
1644 Indentation of Perl statements within surrounding block.
1645 The surrounding block's indentation is the indentation
1646 of the line on which the open-brace appears.
1647 `cperl-continued-statement-offset'
1648 Extra indentation given to a substatement, such as the
1649 then-clause of an if, or body of a while, or just a statement continuation.
1650 `cperl-continued-brace-offset'
1651 Extra indentation given to a brace that starts a substatement.
1652 This is in addition to `cperl-continued-statement-offset'.
1653 `cperl-brace-offset'
1654 Extra indentation for line if it starts with an open brace.
1655 `cperl-brace-imaginary-offset'
1656 An open brace following other text is treated as if it the line started
1657 this far to the right of the actual line indentation.
1658 `cperl-label-offset'
1659 Extra indentation for line that is a label.
1660 `cperl-min-label-indent'
1661 Minimal indentation for line that is a label.
1663 Settings for classic indent-styles: K&R BSD=C++ GNU PerlStyle=Whitesmith
1664 `cperl-indent-level' 5 4 2 4
1665 `cperl-brace-offset' 0 0 0 0
1666 `cperl-continued-brace-offset' -5 -4 0 0
1667 `cperl-label-offset' -5 -4 -2 -4
1668 `cperl-continued-statement-offset' 5 4 2 4
1670 CPerl knows several indentation styles, and may bulk set the
1673 \(both available from menu). See examples in `cperl-style-examples'.
1675 Part of the indentation style is how different parts of if/elsif/else
1676 statements are broken into lines; in CPerl, this is reflected on how
1677 templates for these constructs are created (controlled by
1678 `cperl-extra-newline-before-brace'), and how reflow-logic should treat \"continuation\" blocks of else/elsif/continue, controlled by the same variable,
1679 and by `cperl-extra-newline-before-brace-multiline',
1680 `cperl-merge-trailing-else', `cperl-indent-region-fix-constructs'.
1682 If `cperl-indent-level' is 0, the statement after opening brace in
1683 column 0 is indented on
1684 `cperl-brace-offset'+`cperl-continued-statement-offset'.
1686 Turning on CPerl mode calls the hooks in the variable `cperl-mode-hook'
1687 with no args.
1689 DO NOT FORGET to read micro-docs (available from `Perl' menu)
1690 or as help on variables `cperl-tips', `cperl-problems',
1691 `cperl-praise', `cperl-speed'."
1703 ;; don't clobber the backspace binding:
1736 ;; Until Emacs is multi-threaded, we do not actually need it local:
1740 ;; (setq outline-regexp imenu-example--function-name-regexp-perl)
1767 ;;; "[ \t]*sub"
1768 ;;; (cperl-after-sub-regexp 'named nil) ; 8=name 11=proto 14=attr-start
1769 ;;; cperl-maybe-white-and-comment-rex ; 15=pre-block
1776 cperl-maybe-white-and-comment-rex))
1787 ;;(setq auto-fill-function 'cperl-do-auto-fill) ; Need to switch on and off!
1797 ;; This one is obsolete...
1803 )
1826 cperl-font-lock-keywords-1
1830 cperl-load-font-lock-keywords-1
1837 ;; Do not introduce variable if not needed, we check it!
1839 ;; Fix broken font-lock:
1853 ;; unless font-lock-syntactic-keywords, font-lock (pre-22.1)
1854 ;; used to ignore syntax-table text-properties. (t) is a hack
1855 ;; to make font-lock think that font-lock-syntactic-keywords
1856 ;; are defined.
1894 ;; After hooks since fontification will break this
1899 \f
1900 ;; Fix for perldb - make default reasonable
1908 ;; I have problems
1909 ;; in OS/2
1910 ;; otherwise
1912 nil nil
1914 \f
1916 ;; Adds perl files to msb menu, supposes that msb is already loaded
1925 handle
1927 last))))
1928 \f
1929 ;; This is used by indent-for-comment
1930 ;; to decide how much to indent a comment in CPerl code
1931 ;; based on its context. Do fallback if comment is found wrong.
1947 ;; Wrong comment found
1951 cperl-st-cfence))
1963 comment-column
1965 comment-column)))
1966 ;; No, the caller found a random place; we need to edit ourselves
1972 c)))))
1974 ;;;(defun cperl-comment-indent-fallback ()
1975 ;;; "Is called if the standard comment-search procedure fails.
1976 ;;;Point is at start of real comment."
1977 ;;; (let ((c (current-column)) target cnt prevc)
1978 ;;; (if (= c comment-column) nil
1979 ;;; (setq cnt (skip-chars-backward "[ \t]"))
1980 ;;; (setq target (max (1+ (setq prevc
1981 ;;; (current-column))) ; Else indent at comment column
1982 ;;; comment-column))
1983 ;;; (if (= c comment-column) nil
1984 ;;; (delete-backward-char cnt)
1985 ;;; (while (< prevc target)
1986 ;;; (insert "\t")
1987 ;;; (setq prevc (current-column)))
1988 ;;; (if (> prevc target) (progn (delete-char -1) (setq prevc (current-column))))
1989 ;;; (while (< prevc target)
1990 ;;; (insert " ")
1991 ;;; (setq prevc (current-column)))))))
1994 "Substitute for `indent-for-comment' in CPerl."
2003 "Comment or uncomment each line in the region in CPerl mode.
2004 See `comment-region'."
2010 "Uncomment or comment each line in the region in CPerl mode.
2011 See `comment-region'."
2019 "Insert character and correct line's indentation.
2020 If ONLY-BEFORE and `cperl-auto-newline', will insert newline before the
2023 `cperl-extra-newline-before-brace'."
2030 nil)))
2035 ;; Need to insert a matching pair
2043 ;; Check whether we close something "usual" with `}'
2049 ;;(cperl-after-block-p (point-min))
2051 ;; after sub, else, continue
2054 ;; Just insert the guy
2063 ;; if after ")" and `cperl-extra-newline-before-brace'
2064 ;; is nil, do not insert extra newline.
2093 "Insert character, correct line's indentation, correct quoting by space."
2104 nil)))
2105 pos after)
2112 ;; Check whether we are in comment
2118 nil
2126 t)
2132 "Insert an opening parenthesis or a matching pair of parentheses.
2133 See `cperl-electric-parens'."
2142 nil)))
2147 ;;(not (save-excursion (search-backward "#" beg t)))
2167 "Insert a matching pair of parentheses if marking is active.
2168 If not, or if we are not at the end of marking range, would self-insert.
2169 Affected by `cperl-electric-parens'."
2179 nil))
2180 p)
2185 ;;(not (save-excursion (search-backward "#" beg t)))
2186 )
2201 "Insert a construction appropriate after a keyword.
2202 Help message may be switched off by setting `cperl-message-electric-keyword'
2203 to nil."
2209 my do)
2221 beg t)))
2238 delete
2242 ;;(insert " () {\n}")
2271 "Make sure there are N newlines after the point."
2281 "Insert a POD chunk appropriate after a =POD directive."
2284 head1 notlast name p really-delete over)
2344 "Insert a construction appropriate after a keyword.
2345 Help message may be switched off by setting `cperl-message-electric-keyword'
2346 to nil."
2355 beg t)))
2364 ;;(insert " {\n\n}")
2383 "Go to end of line, open a new line and indent appropriately.
2384 If in POD, insert appropriate lines."
2390 ; i.e., on a boundary and inside "{...}"
2402 ; Leave the level of parens
2404 ; Are at end
2410 ; start of parens group.
2420 ; before, move it to separate line
2429 ; after, move it to separate line
2448 ; with an extra newline.
2453 ;; (re-search-backward "\\(\\`\n?\\|\n\n\\)=head1\\b")
2454 ;; We are after \n now, so look for the rest
2459 t)))
2475 res))
2476 nil
2489 "Insert character and correct line's indentation."
2498 "Insert character and correct line's indentation."
2503 cperl-auto-newline-after-colon)))
2504 insertpos)
2511 ;; Ignore in comment lines
2513 ;; Colon is special only after a label
2514 ;; So quickly rule out most other uses of colon
2515 ;; and do no indentation for them.
2529 ;;(forward-char -1)
2531 ;;(forward-char 1)
2548 "Backspace, or remove the whitespace around the point inserted by an electric
2549 key. Will untabify if `cperl-electric-backspace-untabify' is non-nil."
2553 cperl-electric-terminator
2554 cperl-electric-lbrace))
2563 ;; We are removing the whitespace *inside* cperl-electric-else
2588 \f
2590 "Indent current line as Perl code, or in some cases insert a tab character.
2591 If `cperl-tab-always-indent' is non-nil (the default), always indent current
2592 line. Otherwise, indent the current line only if point is at the left margin
2593 or in the line's indentation; otherwise insert a tab.
2595 A numeric argument, regardless of its value,
2596 means indent rigidly all the lines of the expression starting after point
2597 so that this line becomes properly indented.
2598 The relative indentation among the lines of the expression are preserved."
2602 ;; If arg, always indent this line as Perl
2603 ;; and shift remaining lines of expression the same amount.
2605 beg end)
2625 "Indent current line as Perl code.
2626 Return the amount the indentation changed by."
2629 indent i beg shift-amt)
2631 i indent)
2636 ;;((eq indent t) ; Never?
2637 ;; (setq indent (cperl-calculate-indent-within-comment)))
2638 ;;((looking-at "[ \t]*#")
2639 ;; (setq indent 0))
2660 ;;;(delete-region beg (point))
2661 ;;;(indent-to indent)
2663 ;; If initial point was within line's indentation,
2664 ;; position after the indentation. Else stay at same point in text.
2667 shift-amt))
2670 ;; Returns true if the point is after label. Does not do save-excursion.
2679 ;; returns list (START STATE DEPTH PRESTART),
2680 ;; START is a good place to start parsing, or equal to
2681 ;; PARSE-START if preset,
2682 ;; STATE is what is returned by `parse-partial-sexp'.
2683 ;; DEPTH is true is we are immediately after end of block
2684 ;; which contains START.
2685 ;; PRESTART is the position basing on which START was found.
2695 ;; Try to go out, if sub is not on the outermost level
2700 ;; The current line could start like }}}, so the indentation
2701 ;; corresponds to a different level than what we reached
2712 "Given that P has a property PROP, find where the property starts.
2713 Will not look before LIM."
2714 ;;; XXXX What to do at point-max???
2717 ;;; (cond ((eq p (point-min))
2718 ;;; p)
2719 ;;; ((and lim (<= p lim))
2720 ;;; p)
2721 ;;; ((not (get-text-property (1- p) prop))
2722 ;;; p)
2723 ;;; (t (or (previous-single-property-change p look-prop lim)
2724 ;;; (point-min))))
2725 )
2728 ;; Old workhorse for calculation of indentation; the major problem
2729 ;; is that it mixes the sniffer logic to understand what the current line
2730 ;; MEANS with the logic to actually calculate where to indent it.
2731 ;; The latter part should be eventually moved to `cperl-calculate-indent';
2732 ;; actually, this is mostly done now...
2740 ;; before start of POD - whitespace found since do not have 'pod!
2756 p prop look-prop is-block delim)
2775 old-indent)
2777 ;;containing-sexp ;; We are buggy at toplevel :-(
2778 parse-data)
2784 ;; Before this point: end of statement
2787 ;; indent to "after" the surrounding open
2788 ;; (same offset as `cperl-beautify-regexp-piece'),
2789 ;; skip blanks if we do not close the expression.
2795 is-block ; misused for: preceeding line in REx
2805 nil ; Can't use intentation of this line...
2814 is-block char-after p))
2820 [comment])
2821 ((nth 3 state)
2822 [string])
2823 ;; XXXX Do we need to special-case this?
2824 ((null containing-sexp)
2825 ;; Line is at top level. May be data or function definition,
2826 ;; or may be function argument declaration.
2827 ;; Indent like the previous top level line
2828 ;; unless that ends in a closeparen without semicolon,
2829 ;; in which case this line is the first argument decl.
2831 (cperl-backward-to-noncomment (or old-indent (point-min)))
2832 (setq state
2833 (or (bobp)
2834 (eq (point) old-indent) ; old-indent was at comment
2835 (eq (preceding-char) ?\;)
2836 ;; Had ?\) too
2837 (and (eq (preceding-char) ?\})
2838 (cperl-after-block-and-statement-beg
2839 (point-min))) ; Was start - too close
2840 (memq char-after (append ")]}" nil))
2841 (and (eq (preceding-char) ?\:) ; label
2842 (progn
2843 (forward-sexp -1)
2846 (get-text-property (point) 'first-format-line)))
2848 ;; Look at previous line that's at column 0
2849 ;; to determine whether we are in top-level decls
2850 ;; or function's arg decls. Set basic-indent accordingly.
2851 ;; Now add a little if this is a continuation line.
2852 (and state
2853 parse-data
2854 (not (eq char-after ?\C-j))
2855 (setcdr (cddr parse-data)
2856 (list pre-indent-point)))
2857 (vector 'toplevel start char-after state (nth 2 s-s)))
2858 ((not
2859 (or (setq is-block
2860 (and (setq delim (= (char-after containing-sexp) ?{))
2861 (save-excursion ; Is it a hash?
2862 (goto-char containing-sexp)
2863 (cperl-block-p))))
2864 cperl-indent-parens-as-block))
2865 ;; group is an expression, not a block:
2866 ;; indent to just after the surrounding open parens,
2867 ;; skip blanks if we do not close the expression.
2868 (goto-char (1+ containing-sexp))
2869 (or (memq char-after
2870 (append (if delim "}" ")]}") nil))
2873 (setq old-indent (point)) ; delim=is-brace
2874 (vector 'in-parens char-after (point) delim containing-sexp))
2875 (t
2876 ;; Statement level. Is it a continuation or a new statement?
2877 ;; Find previous non-comment character.
2878 (goto-char pre-indent-point) ; Skip one level of POD/etc
2879 (cperl-backward-to-noncomment containing-sexp)
2880 ;; Back up over label lines, since they don't
2881 ;; affect whether our line is a continuation.
2882 ;; (Had \, too)
2883 (while;;(or (eq (preceding-char) ?\,)
2884 (and (eq (preceding-char) ?:)
2886 (memq (char-syntax (char-after (- (point) 2)))
2887 '(?w ?_))))
2888 ;;)
2889 ;; This is always FALSE?
2890 (if (eq (preceding-char) ?\,)
2891 ;; Will go to beginning of line, essentially.
2892 ;; Will ignore embedded sexpr XXXX.
2893 (cperl-backward-to-start-of-continued-exp containing-sexp))
2894 (beginning-of-line)
2895 (cperl-backward-to-noncomment containing-sexp))
2896 ;; Now we get non-label preceeding the indent point
2897 (if (not (or (eq (1- (point)) containing-sexp)
2898 (memq (preceding-char)
2899 (append (if is-block " ;{" " ,;{") '(nil)))
2900 (and (eq (preceding-char) ?\})
2901 (cperl-after-block-and-statement-beg
2902 containing-sexp))
2903 (get-text-property (point) 'first-format-line)))
2904 ;; This line is continuation of preceding line's statement;
2905 ;; indent `cperl-continued-statement-offset' more than the
2906 ;; previous line of the statement.
2907 ;;
2908 ;; There might be a label on this line, just
2909 ;; consider it bad style and ignore it.
2910 (progn
2911 (cperl-backward-to-start-of-continued-exp containing-sexp)
2912 (vector 'continuation (point) char-after is-block delim))
2913 ;; This line starts a new statement.
2914 ;; Position following last unclosed open brace
2915 (goto-char containing-sexp)
2916 ;; Is line first statement after an open-brace?
2917 (or
2918 ;; If no, find that first statement and indent like
2919 ;; it. If the first statement begins with label, do
2920 ;; not believe when the indentation of the label is too
2921 ;; small.
2922 (save-excursion
2923 (forward-char 1)
2924 (let ((colon-line-end 0))
2925 (while
2927 ;; s: foo : bar :x is NOT label
2930 ;; Skip over comments and labels following openbrace.
2931 (cond ((= (following-char) ?\#)
2932 (forward-line 1))
2933 ((= (following-char) ?\=)
2934 (goto-char
2935 (or (next-single-property-change (point) 'in-pod)
2936 (point-max)))) ; do not loop if no syntaxification
2937 ;; label:
2938 (t
2939 (save-excursion (end-of-line)
2940 (setq colon-line-end (point)))
2941 (search-forward ":"))))
2942 ;; We are at beginning of code (NOT label or comment)
2943 ;; First, the following code counts
2944 ;; if it is before the line we want to indent.
2945 (and (< (point) indent-point)
2946 (vector 'have-prev-sibling (point) colon-line-end
2947 containing-sexp))))
2948 (progn
2949 ;; If no previous statement,
2950 ;; indent it relative to line brace is on.
2952 ;; For open-braces not the first thing in a line,
2953 ;; add in cperl-brace-imaginary-offset.
2955 ;; If first thing on a line: ?????
2956 ;; Move back over whitespace before the openbrace.
2957 (setq ; brace first thing on a line
2959 ;; Should we indent w.r.t. earlier than start?
2960 ;; Move to start of control group, possibly on a different line
2961 (or cperl-indent-wrt-brace
2962 (cperl-backward-to-noncomment (point-min)))
2963 ;; If the openbrace is preceded by a parenthesized exp,
2964 ;; move to the beginning of that;
2965 (if (eq (preceding-char) ?\))
2966 (progn
2967 (forward-sexp -1)
2968 (cperl-backward-to-noncomment (point-min))))
2969 ;; In the case it starts a subroutine, indent with
2970 ;; respect to `sub', not with respect to the
2971 ;; first thing on the line, say in the case of
2972 ;; anonymous sub in a hash.
2973 (if (and;; Is it a sub in group starting on this line?
2974 (cond ((get-text-property (point) 'attrib-group)
2975 (goto-char (cperl-beginning-of-property
2976 (point) 'attrib-group)))
2977 ((eq (preceding-char) ?b)
2978 (forward-sexp -1)
2980 (setq p (nth 1 ; start of innermost containing list
2981 (parse-partial-sexp
2982 (save-excursion (beginning-of-line)
2983 (point))
2984 (point)))))
2985 (progn
2986 (goto-char (1+ p)) ; enclosing block on the same line
2988 (vector 'code-start-in-block containing-sexp char-after
2989 (and delim (not is-block)) ; is a HASH
2990 old-indent ; brace first thing on a line
2991 t (point) ; have something before...
2992 )
2993 ;;(current-column)
2994 )
2995 ;; Get initial indentation of the line we are on.
2996 ;; If line starts with label, calculate label indentation
2997 (vector 'code-start-in-block containing-sexp char-after
2998 (and delim (not is-block)) ; is a HASH
2999 old-indent ; brace first thing on a line
3000 nil (point))))))))))))))) ; nothing interesting before
3002 (defvar cperl-indent-rules-alist
3003 '((pod nil) ; via `syntax-type' property
3004 (here-doc nil) ; via `syntax-type' property
3005 (here-doc-delim nil) ; via `syntax-type' property
3006 (format nil) ; via `syntax-type' property
3007 (in-pod nil) ; via `in-pod' property
3008 (comment-special:at-beginning-of-line nil)
3009 (string t)
3010 (comment nil))
3011 "Alist of indentation rules for CPerl mode.
3012 The values mean:
3013 nil: do not indent;
3014 number: add this amount of indentation.")
3016 (defun cperl-calculate-indent (&optional parse-data) ; was parse-start
3017 "Return appropriate indentation for current line as Perl code.
3018 In usual case returns an integer: the column to indent to.
3019 Returns nil if line starts inside a string, t if in a comment.
3021 Will not correct the indentation for labels, but will correct it for braces
3022 and closing parentheses and brackets."
3023 ;; This code is still a broken architecture: in some cases we need to
3024 ;; compensate for some modifications which `cperl-indent-line' will add later
3025 (save-excursion
3026 (let ((i (cperl-sniff-for-indent parse-data)) what p)
3027 (cond
3028 ;;((or (null i) (eq i t) (numberp i))
3029 ;; i)
3030 ((vectorp i)
3031 (setq what (assoc (elt i 0) cperl-indent-rules-alist))
3032 (cond
3033 (what (cadr what)) ; Load from table
3034 ;;
3035 ;; Indenters for regular expressions with //x and qw()
3036 ;;
3037 ((eq 'REx-part2 (elt i 0)) ;; [self start] start of /REP in s//REP/x
3038 (goto-char (elt i 1))
3039 (condition-case nil ; Use indentation of the 1st part
3040 (forward-sexp -1))
3041 (current-column))
3042 ((eq 'indentable (elt i 0)) ; Indenter for REGEXP qw() etc
3043 (cond ;;; [indentable terminator start-pos is-block]
3044 ((eq 'terminator (elt i 1)) ; Lone terminator of "indentable string"
3045 (goto-char (elt i 2)) ; After opening parens
3046 (1- (current-column)))
3047 ((eq 'first-line (elt i 1)); [indentable first-line start-pos]
3048 (goto-char (elt i 2))
3049 (+ (or cperl-regexp-indent-step cperl-indent-level)
3050 -1
3051 (current-column)))
3052 ((eq 'cont-line (elt i 1)); [indentable cont-line pos prev-pos first-char start-pos]
3053 ;; Indent as the level after closing parens
3054 (goto-char (elt i 2)) ; indent line
3056 (setq p (point))
3057 (goto-char (elt i 3)) ; previous line
3059 ;; Number of parens in between:
3060 (setq p (nth 0 (parse-partial-sexp (point) p))
3061 what (elt i 4)) ; First char on current line
3062 (goto-char (elt i 3)) ; previous line
3063 (+ (* p (or cperl-regexp-indent-step cperl-indent-level))
3064 (cond ((eq what ?\) )
3065 (- cperl-close-paren-offset)) ; compensate
3066 ((eq what ?\| )
3067 (- (or cperl-regexp-indent-step cperl-indent-level)))
3068 (t 0))
3069 (if (eq (following-char) ?\| )
3070 (or cperl-regexp-indent-step cperl-indent-level)
3071 0)
3072 (current-column)))
3073 (t
3074 (error "Unrecognized value of indent: %s" i))))
3075 ;;
3076 ;; Indenter for stuff at toplevel
3077 ;;
3078 ((eq 'toplevel (elt i 0)) ;; [toplevel start char-after state immed-after-block]
3079 (+ (save-excursion ; To beg-of-defun, or end of last sexp
3080 (goto-char (elt i 1)) ; start = Good place to start parsing
3081 (- (current-indentation) ;
3082 (if (elt i 4) cperl-indent-level 0))) ; immed-after-block
3083 (if (eq (elt i 2) ?{) cperl-continued-brace-offset 0) ; char-after
3084 ;; Look at previous line that's at column 0
3085 ;; to determine whether we are in top-level decls
3086 ;; or function's arg decls. Set basic-indent accordingly.
3087 ;; Now add a little if this is a continuation line.
3088 (if (elt i 3) ; state (XXX What is the semantic???)
3089 0
3090 cperl-continued-statement-offset)))
3091 ;;
3092 ;; Indenter for stuff in "parentheses" (or brackets, braces-as-hash)
3093 ;;
3094 ((eq 'in-parens (elt i 0))
3095 ;; in-parens char-after old-indent-point is-brace containing-sexp
3097 ;; group is an expression, not a block:
3098 ;; indent to just after the surrounding open parens,
3099 ;; skip blanks if we do not close the expression.
3100 (+ (progn
3101 (goto-char (elt i 2)) ; old-indent-point
3102 (current-column))
3103 (if (and (elt i 3) ; is-brace
3104 (eq (elt i 1) ?\})) ; char-after
3105 ;; Correct indentation of trailing ?\}
3106 (+ cperl-indent-level cperl-close-paren-offset)
3107 0)))
3108 ;;
3109 ;; Indenter for continuation lines
3110 ;;
3111 ((eq 'continuation (elt i 0))
3112 ;; [continuation statement-start char-after is-block is-brace]
3113 (goto-char (elt i 1)) ; statement-start
3114 (+ (if (memq (elt i 2) (append "}])" nil)) ; char-after
3115 0 ; Closing parenth
3116 cperl-continued-statement-offset)
3117 (if (or (elt i 3) ; is-block
3118 (not (elt i 4)) ; is-brace
3119 (not (eq (elt i 2) ?\}))) ; char-after
3120 0
3121 ;; Now it is a hash reference
3122 (+ cperl-indent-level cperl-close-paren-offset))
3123 ;; Labels do not take :: ...
3125 (if (> (current-indentation) cperl-min-label-indent)
3126 (- (current-indentation) cperl-label-offset)
3127 ;; Do not move `parse-data', this should
3128 ;; be quick anyway (this comment comes
3129 ;; from different location):
3130 (cperl-calculate-indent))
3131 (current-column))
3132 (if (eq (elt i 2) ?\{) ; char-after
3133 cperl-continued-brace-offset 0)))
3134 ;;
3135 ;; Indenter for lines in a block which are not leading lines
3136 ;;
3137 ((eq 'have-prev-sibling (elt i 0))
3138 ;; [have-prev-sibling sibling-beg colon-line-end block-start]
3139 (goto-char (elt i 1)) ; sibling-beg
3140 (if (> (elt i 2) (point)) ; colon-line-end; have label before point
3141 (if (> (current-indentation)
3142 cperl-min-label-indent)
3143 (- (current-indentation) cperl-label-offset)
3144 ;; Do not believe: `max' was involved in calculation of indent
3145 (+ cperl-indent-level
3146 (save-excursion
3147 (goto-char (elt i 3)) ; block-start
3148 (current-indentation))))
3149 (current-column)))
3150 ;;
3151 ;; Indenter for the first line in a block
3152 ;;
3153 ((eq 'code-start-in-block (elt i 0))
3154 ;;[code-start-in-block before-brace char-after
3155 ;; is-a-HASH-ref brace-is-first-thing-on-a-line
3156 ;; group-starts-before-start-of-sub start-of-control-group]
3157 (goto-char (elt i 1))
3158 ;; For open brace in column zero, don't let statement
3159 ;; start there too. If cperl-indent-level=0,
3160 ;; use cperl-brace-offset + cperl-continued-statement-offset instead.
3161 (+ (if (and (bolp) (zerop cperl-indent-level))
3162 (+ cperl-brace-offset cperl-continued-statement-offset)
3163 cperl-indent-level)
3164 (if (and (elt i 3) ; is-a-HASH-ref
3165 (eq (elt i 2) ?\})) ; char-after: End of a hash reference
3166 (+ cperl-indent-level cperl-close-paren-offset)
3167 0)
3168 ;; Unless openbrace is the first nonwhite thing on the line,
3169 ;; add the cperl-brace-imaginary-offset.
3170 (if (elt i 4) 0 ; brace-is-first-thing-on-a-line
3171 cperl-brace-imaginary-offset)
3172 (progn
3173 (goto-char (elt i 6)) ; start-of-control-group
3174 (if (elt i 5) ; group-starts-before-start-of-sub
3175 (current-column)
3176 ;; Get initial indentation of the line we are on.
3177 ;; If line starts with label, calculate label indentation
3178 (if (save-excursion
3179 (beginning-of-line)
3181 (if (> (current-indentation) cperl-min-label-indent)
3182 (- (current-indentation) cperl-label-offset)
3183 ;; Do not move `parse-data', this should
3184 ;; be quick anyway:
3185 (cperl-calculate-indent))
3186 (current-indentation))))))
3187 (t
3188 (error "Unrecognized value of indent: %s" i))))
3189 (t
3190 (error "Got strange value of indent: %s" i))))))
3192 (defun cperl-calculate-indent-within-comment ()
3193 "Return the indentation amount for line, assuming that
3194 the current line is to be regarded as part of a block comment."
3195 (let (end star-start)
3196 (save-excursion
3197 (beginning-of-line)
3199 (setq end (point))
3200 (and (= (following-char) ?#)
3201 (forward-line -1)
3202 (cperl-to-comment-or-eol)
3203 (setq end (point)))
3204 (goto-char end)
3205 (current-column))))
3208 (defun cperl-to-comment-or-eol ()
3209 "Go to position before comment on the current line, or to end of line.
3210 Returns true if comment is found. In POD will not move the point."
3211 ;; If the line is inside other syntax groups (qq-style strings, HERE-docs)
3212 ;; then looks for literal # or end-of-line.
3213 (let (state stop-in cpoint (lim (progn (end-of-line) (point))) pr e)
3214 (or cperl-font-locking
3215 (cperl-update-syntaxification lim lim))
3216 (beginning-of-line)
3217 (if (setq pr (get-text-property (point) 'syntax-type))
3218 (setq e (next-single-property-change (point) 'syntax-type nil (point-max))))
3219 (if (or (eq pr 'pod)
3220 (if (or (not e) (> e lim)) ; deep inside a group
3222 (if (eq (preceding-char) ?\#) (progn (backward-char 1) t))
3223 ;; Else - need to do it the hard way
3224 (and (and e (<= e lim))
3225 (goto-char e))
3226 (while (not stop-in)
3227 (setq state (parse-partial-sexp (point) lim nil nil nil t))
3228 ; stop at comment
3229 ;; If fails (beginning-of-line inside sexp), then contains not-comment
3230 (if (nth 4 state) ; After `#';
3231 ; (nth 2 state) can be
3232 ; beginning of m,s,qq and so
3233 ; on
3234 (if (nth 2 state)
3235 (progn
3236 (setq cpoint (point))
3237 (goto-char (nth 2 state))
3238 (cond
3240 (or (re-search-forward
3242 lim 'move)
3243 (setq stop-in t)))
3245 (or (re-search-forward
3247 lim 'move)
3248 (setq stop-in t)))
3249 (t ; It was fair comment
3250 (setq stop-in t) ; Finish
3251 (goto-char (1- cpoint)))))
3252 (setq stop-in t) ; Finish
3253 (forward-char -1))
3254 (setq stop-in t))) ; Finish
3255 (nth 4 state))))
3257 (defsubst cperl-modify-syntax-type (at how)
3258 (if (< at (point-max))
3259 (progn
3260 (put-text-property at (1+ at) 'syntax-table how)
3261 (put-text-property at (1+ at) 'rear-nonsticky '(syntax-table)))))
3263 (defun cperl-protect-defun-start (s e)
3265 (save-excursion
3266 (goto-char s)
3268 (put-text-property (1- (point)) (point) 'syntax-table cperl-st-punct))))
3270 (defun cperl-commentify (bb e string &optional noface)
3271 (if cperl-use-syntax-table-text-property
3272 (if (eq noface 'n) ; Only immediate
3273 nil
3274 ;; We suppose that e is _after_ the end of construction, as after eol.
3275 (setq string (if string cperl-st-sfence cperl-st-cfence))
3276 (if (> bb (- e 2))
3277 ;; one-char string/comment?!
3278 (cperl-modify-syntax-type bb cperl-st-punct)
3279 (cperl-modify-syntax-type bb string)
3280 (cperl-modify-syntax-type (1- e) string))
3281 (if (and (eq string cperl-st-sfence) (> (- e 2) bb))
3282 (put-text-property (1+ bb) (1- e)
3283 'syntax-table cperl-string-syntax-table))
3284 (cperl-protect-defun-start bb e))
3285 ;; Fontify
3286 (or noface
3287 (not cperl-pod-here-fontify)
3288 (put-text-property bb e 'face (if string 'font-lock-string-face
3289 'font-lock-comment-face)))))
3291 (defvar cperl-starters '(( ?\( . ?\) )
3292 ( ?\[ . ?\] )
3293 ( ?\{ . ?\} )
3294 ( ?\< . ?\> )))
3296 (defun cperl-cached-syntax-table (st)
3297 "Get a syntax table cached in ST, or create and cache into ST a syntax table.
3299 is quoting."
3300 (if (car-safe st)
3301 (car st)
3302 (setcar st (make-syntax-table))
3303 (setq st (car st))
3304 (let ((i 0))
3305 (while (< i 256)
3306 (modify-syntax-entry i "." st)
3307 (setq i (1+ i))))
3309 st))
3311 (defun cperl-forward-re (lim end is-2arg st-l err-l argument
3312 &optional ostart oend)
3313 "Find the end of a regular expression or a stringish construct (q[] etc).
3314 The point should be before the starting delimiter.
3316 Goes to LIM if none is found. If IS-2ARG is non-nil, assumes that it
3317 is s/// or tr/// like expression. If END is nil, generates an error
3318 message if needed. If SET-ST is non-nil, will use (or generate) a
3319 cached syntax table in ST-L. If ERR-L is non-nil, will store the
3320 error message in its CAR (unless it already contains some error
3321 message). ARGUMENT should be the name of the construct (used in error
3322 messages). OSTART, OEND may be set in recursive calls when processing
3323 the second argument of 2ARG construct.
3325 Works *before* syntax recognition is done. In IS-2ARG situation may
3326 modify syntax-type text property if the situation is too hard."
3327 (let (b starter ender st i i2 go-forward reset-st set-st)
3329 ;; ender means matching-char matcher.
3330 (setq b (point)
3331 starter (if (eobp) 0 (char-after b))
3332 ender (cdr (assoc starter cperl-starters)))
3334 (setq st (cperl-cached-syntax-table st-l))
3335 (setq set-st t)
3336 ;; Whether we have an intermediate point
3337 (setq i nil)
3338 ;; Prepare the syntax table:
3339 (if (not ender) ; m/blah/, s/x//, s/x/y/
3340 (modify-syntax-entry starter "$" st)
3341 (modify-syntax-entry starter (concat "(" (list ender)) st)
3342 (modify-syntax-entry ender (concat ")" (list starter)) st))
3343 (condition-case bb
3344 (progn
3345 ;; We use `$' syntax class to find matching stuff, but $$
3346 ;; is recognized the same as $, so we need to check this manually.
3347 (if (and (eq starter (char-after (cperl-1+ b)))
3348 (not ender))
3349 ;; $ has TeXish matching rules, so $$ equiv $...
3350 (forward-char 2)
3351 (setq reset-st (syntax-table))
3352 (set-syntax-table st)
3353 (forward-sexp 1)
3354 (if (<= (point) (1+ b))
3355 (error "Unfinished regular expression"))
3356 (set-syntax-table reset-st)
3357 (setq reset-st nil)
3358 ;; Now the problem is with m;blah;;
3359 (and (not ender)
3360 (eq (preceding-char)
3361 (char-after (- (point) 2)))
3362 (save-excursion
3363 (forward-char -2)
3365 (forward-char -1)))
3366 ;; Now we are after the first part.
3367 (and is-2arg ; Have trailing part
3368 (not ender)
3369 (eq (following-char) starter) ; Empty trailing part
3370 (progn
3371 (or (eq (char-syntax (following-char)) ?.)
3372 ;; Make trailing letter into punctuation
3373 (cperl-modify-syntax-type (point) cperl-st-punct))
3374 (setq is-2arg nil go-forward t))) ; Ignore the tail
3375 (if is-2arg ; Not number => have second part
3376 (progn
3377 (setq i (point) i2 i)
3378 (if ender
3380 (progn
3382 (goto-char (match-end 0))
3384 (setq i2 (point))))
3385 (forward-char -1))
3387 (if ender (modify-syntax-entry ender "." st))
3388 (setq set-st nil)
3389 (setq ender (cperl-forward-re lim end nil st-l err-l
3390 argument starter ender)
3391 ender (nth 2 ender)))))
3392 (error (goto-char lim)
3393 (setq set-st nil)
3394 (if reset-st
3395 (set-syntax-table reset-st))
3396 (or end
3397 (message
3398 "End of `%s%s%c ... %c' string/RE not found: %s"
3399 argument
3400 (if ostart (format "%c ... %c" ostart (or oend ostart)) "")
3401 starter (or ender starter) bb)
3402 (or (car err-l) (setcar err-l b)))))
3403 (if set-st
3404 (progn
3406 (if ender (modify-syntax-entry ender "." st))))
3407 ;; i: have 2 args, after end of the first arg
3408 ;; i2: start of the second arg, if any (before delim if `ender').
3409 ;; ender: the last arg bounded by parens-like chars, the second one of them
3410 ;; starter: the starting delimiter of the first arg
3411 ;; go-forward: has 2 args, and the second part is empty
3412 (list i i2 ender starter go-forward)))
3414 (defun cperl-forward-group-in-re (&optional st-l)
3415 "Find the end of a group in a REx.
3416 Return the error message (if any). Does not work if delimiter is `)'.
3417 Works before syntax recognition is done."
3418 ;; Works *before* syntax recognition is done
3419 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3420 (let (st b reset-st)
3421 (condition-case b
3422 (progn
3423 (setq st (cperl-cached-syntax-table st-l))
3424 (modify-syntax-entry ?\( "()" st)
3425 (modify-syntax-entry ?\) ")(" st)
3426 (setq reset-st (syntax-table))
3427 (set-syntax-table st)
3428 (forward-sexp 1))
3429 (error (message
3430 "cperl-forward-group-in-re: error %s" b)))
3431 ;; now restore the initial state
3432 (if st
3433 (progn
3434 (modify-syntax-entry ?\( "." st)
3435 (modify-syntax-entry ?\) "." st)))
3436 (if reset-st
3437 (set-syntax-table reset-st))
3438 b))
3441 (defvar font-lock-string-face)
3442 ;;(defvar font-lock-reference-face)
3443 (defvar font-lock-constant-face)
3444 (defsubst cperl-postpone-fontification (b e type val &optional now)
3445 ;; Do after syntactic fontification?
3446 (if cperl-syntaxify-by-font-lock
3447 (or now (put-text-property b e 'cperl-postpone (cons type val)))
3448 (put-text-property b e type val)))
3450 ;;; Here is how the global structures (those which cannot be
3451 ;;; recognized locally) are marked:
3452 ;; a) PODs:
3453 ;; Start-to-end is marked `in-pod' ==> t
3454 ;; Each non-literal part is marked `syntax-type' ==> `pod'
3455 ;; Each literal part is marked `syntax-type' ==> `in-pod'
3456 ;; b) HEREs:
3457 ;; Start-to-end is marked `here-doc-group' ==> t
3458 ;; The body is marked `syntax-type' ==> `here-doc'
3459 ;; The delimiter is marked `syntax-type' ==> `here-doc-delim'
3460 ;; c) FORMATs:
3461 ;; First line (to =) marked `first-format-line' ==> t
3462 ;; After-this--to-end is marked `syntax-type' ==> `format'
3463 ;; d) 'Q'uoted string:
3464 ;; part between markers inclusive is marked `syntax-type' ==> `string'
3465 ;; part between `q' and the first marker is marked `syntax-type' ==> `prestring'
3466 ;; second part of s///e is marked `syntax-type' ==> `multiline'
3467 ;; e) Attributes of subroutines: `attrib-group' ==> t
3468 ;; (or 0 if declaration); up to `{' or ';': `syntax-type' => `sub-decl'.
3469 ;; f) Multiline my/our declaration lists etc: `syntax-type' => `multiline'
3471 ;;; In addition, some parts of RExes may be marked as `REx-interpolated'
3472 ;;; (value: 0 in //o, 1 if "interpolated variable" is whole-REx, t otherwise).
3474 (defun cperl-unwind-to-safe (before &optional end)
3475 ;; if BEFORE, go to the previous start-of-line on each step of unwinding
3476 (let ((pos (point)) opos)
3477 (while (and pos (progn
3478 (beginning-of-line)
3479 (get-text-property (setq pos (point)) 'syntax-type)))
3480 (setq opos pos
3481 pos (cperl-beginning-of-property pos 'syntax-type))
3482 (if (eq pos (point-min))
3483 (setq pos nil))
3484 (if pos
3485 (if before
3486 (progn
3487 (goto-char (cperl-1- pos))
3488 (beginning-of-line)
3489 (setq pos (point)))
3490 (goto-char (setq pos (cperl-1- pos))))
3491 ;; Up to the start
3492 (goto-char (point-min))))
3493 ;; Skip empty lines
3496 (forward-char))
3497 (setq pos (point))
3498 (if end
3499 ;; Do the same for end, going small steps
3500 (save-excursion
3501 (while (and end (get-text-property end 'syntax-type))
3502 (setq pos end
3503 end (next-single-property-change end 'syntax-type nil (point-max)))
3504 (if end (progn (goto-char end)
3505 (or (bolp) (forward-line 1))
3506 (setq end (point)))))
3507 (or end pos)))))
3509 ;;; These are needed for byte-compile (at least with v19)
3510 (defvar cperl-nonoverridable-face)
3511 (defvar font-lock-variable-name-face)
3512 (defvar font-lock-function-name-face)
3513 (defvar font-lock-keyword-face)
3514 (defvar font-lock-builtin-face)
3515 (defvar font-lock-type-face)
3516 (defvar font-lock-comment-face)
3517 (defvar font-lock-warning-face)
3519 (defun cperl-find-sub-attrs (&optional st-l b-fname e-fname pos)
3520 "Syntaxically mark (and fontify) attributes of a subroutine.
3521 Should be called with the point before leading colon of an attribute."
3522 ;; Works *before* syntax recognition is done
3523 (or st-l (setq st-l (list nil))) ; Avoid overwriting '()
3524 (let (st b p reset-st after-first (start (point)) start1 end1)
3525 (condition-case b
3526 (while (looking-at
3527 (concat
3529 ":" cperl-maybe-white-and-comment-rex ; 2=whitespace/comment?
3531 (if after-first "?" "")
3532 ;; No space between name and paren allowed...
3535 (and (match-beginning 1)
3536 (cperl-postpone-fontification
3537 (match-beginning 0) (cperl-1+ (match-beginning 0))
3538 'face font-lock-constant-face))
3539 (setq start1 (match-beginning 3) end1 (match-end 3))
3540 (cperl-postpone-fontification start1 end1
3541 'face font-lock-constant-face)
3542 (goto-char end1) ; end or before `('
3543 (if (match-end 4) ; Have attribute arguments...
3544 (progn
3545 (if st nil
3546 (setq st (cperl-cached-syntax-table st-l))
3547 (modify-syntax-entry ?\( "()" st)
3548 (modify-syntax-entry ?\) ")(" st))
3549 (setq reset-st (syntax-table) p (point))
3550 (set-syntax-table st)
3551 (forward-sexp 1)
3552 (set-syntax-table reset-st)
3553 (setq reset-st nil)
3554 (cperl-commentify p (point) t))) ; mark as string
3555 (forward-comment (buffer-size))
3556 (setq after-first t))
3557 (error (message
3558 "L%d: attribute `%s': %s"
3559 (count-lines (point-min) (point))
3560 (and start1 end1 (buffer-substring start1 end1)) b)
3561 (setq start nil)))
3562 (and start
3563 (progn
3564 (put-text-property start (point)
3565 'attrib-group (if (looking-at "{") t 0))
3566 (and pos
3567 (< 1 (count-lines (+ 3 pos) (point))) ; end of `sub'
3568 ;; Apparently, we do not need `multiline': faces added now
3569 (put-text-property (+ 3 pos) (cperl-1+ (point))
3570 'syntax-type 'sub-decl))
3571 (and b-fname ; Fontify here: the following condition
3572 (cperl-postpone-fontification ; is too hard to determine by
3573 b-fname e-fname 'face ; a REx, so do it here
3574 (if (looking-at "{")
3575 font-lock-function-name-face
3576 font-lock-variable-name-face)))))
3577 ;; now restore the initial state
3578 (if st
3579 (progn
3580 (modify-syntax-entry ?\( "." st)
3581 (modify-syntax-entry ?\) "." st)))
3582 (if reset-st
3583 (set-syntax-table reset-st))))
3585 (defsubst cperl-look-at-leading-count (is-x-REx e)
3586 (if (and
3587 (< (point) e)
3589 (1- e) t)) ; return nil on failure, no moving
3590 (if (eq ?\{ (preceding-char)) nil
3591 (cperl-postpone-fontification
3592 (1- (point)) (point)
3593 'face font-lock-warning-face))))
3595 ;;; Debugging this may require (setq max-specpdl-size 2000)...
3596 (defun cperl-find-pods-heres (&optional min max non-inter end ignore-max end-of-here-doc)
3597 "Scans the buffer for hard-to-parse Perl constructions.
3598 If `cperl-pod-here-fontify' is not-nil after evaluation, will fontify
3599 the sections using `cperl-pod-head-face', `cperl-pod-face',
3600 `cperl-here-face'."
3601 (interactive)
3602 (or min (setq min (point-min)
3603 cperl-syntax-state nil
3604 cperl-syntax-done-to min))
3605 (or max (setq max (point-max)))
3606 (let* ((cperl-pod-here-fontify (eval cperl-pod-here-fontify)) go tmpend
3607 face head-face here-face b e bb tag qtag b1 e1 argument i c tail tb
3608 is-REx is-x-REx REx-subgr-start REx-subgr-end was-subgr i2 hairy-RE
3609 (case-fold-search nil) (inhibit-read-only t) (buffer-undo-list t)
3610 (modified (buffer-modified-p)) overshoot is-o-REx
3611 (after-change-functions nil)
3612 (cperl-font-locking t)
3613 (use-syntax-state (and cperl-syntax-state
3614 (>= min (car cperl-syntax-state))))
3615 (state-point (if use-syntax-state
3616 (car cperl-syntax-state)
3617 (point-min)))
3618 (state (if use-syntax-state
3619 (cdr cperl-syntax-state)))
3620 ;; (st-l '(nil)) (err-l '(nil)) ; Would overwrite - propagates from a function call to a function call!
3621 (st-l (list nil)) (err-l (list nil))
3622 ;; Somehow font-lock may be not loaded yet...
3623 ;; (e.g., when building TAGS via command-line call)
3624 (font-lock-string-face (if (boundp 'font-lock-string-face)
3625 font-lock-string-face
3626 'font-lock-string-face))
3627 (my-cperl-delimiters-face (if (boundp 'font-lock-constant-face)
3628 font-lock-constant-face
3629 'font-lock-constant-face))
3630 (my-cperl-REx-spec-char-face ; [] ^.$ and wrapper-of ({})
3631 (if (boundp 'font-lock-function-name-face)
3632 font-lock-function-name-face
3633 'font-lock-function-name-face))
3634 (font-lock-variable-name-face ; interpolated vars and ({})-code
3635 (if (boundp 'font-lock-variable-name-face)
3636 font-lock-variable-name-face
3637 'font-lock-variable-name-face))
3638 (font-lock-function-name-face ; used in `cperl-find-sub-attrs'
3639 (if (boundp 'font-lock-function-name-face)
3640 font-lock-function-name-face
3641 'font-lock-function-name-face))
3642 (font-lock-constant-face ; used in `cperl-find-sub-attrs'
3643 (if (boundp 'font-lock-constant-face)
3644 font-lock-constant-face
3645 'font-lock-constant-face))
3646 (my-cperl-REx-0length-face ; 0-length, (?:)etc, non-literal \
3647 (if (boundp 'font-lock-builtin-face)
3648 font-lock-builtin-face
3649 'font-lock-builtin-face))
3650 (font-lock-comment-face
3651 (if (boundp 'font-lock-comment-face)
3652 font-lock-comment-face
3653 'font-lock-comment-face))
3654 (font-lock-warning-face
3655 (if (boundp 'font-lock-warning-face)
3656 font-lock-warning-face
3657 'font-lock-warning-face))
3658 (my-cperl-REx-ctl-face ; (|)
3659 (if (boundp 'font-lock-keyword-face)
3660 font-lock-keyword-face
3661 'font-lock-keyword-face))
3662 (my-cperl-REx-modifiers-face ; //gims
3663 (if (boundp 'cperl-nonoverridable-face)
3664 cperl-nonoverridable-face
3665 'cperl-nonoverridable-face))
3666 (my-cperl-REx-length1-face ; length=1 escaped chars, POSIX classes
3667 (if (boundp 'font-lock-type-face)
3668 font-lock-type-face
3669 'font-lock-type-face))
3670 (stop-point (if ignore-max
3671 (point-max)
3672 max))
3673 (search
3674 (concat
3677 ;; One extra () before this:
3678 "<<" ; HERE-DOC
3680 ;; First variant "BLAH" or just ``.
3686 ;; Second variant: Identifier or \ID (same as 'ID') or empty
3688 ;; Do not have <<= or << 30 or <<30 or << $blah.
3693 ;; 1+6 extra () before this:
3695 (if cperl-use-syntax-table-text-property
3696 (concat
3698 ;; 1+6+2=9 extra () before this:
3701 ;; 1+6+2+1=10 extra () before this:
3704 ;; 1+6+2+1+1=11 extra () before this
3707 cperl-white-and-comment-rex
3710 cperl-maybe-white-and-comment-rex
3713 ;; 1+6+2+1+1+6=17 extra () before this:
3716 ;; 1+6+2+1+1+6+1=18 extra () before this (old pack'var syntax;
3717 ;; we do not support intervening comments...):
3719 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
3722 ;; 1+6+2+1+1+6+1+1+1=20 extra () before this:
3725 ""))))
3726 (unwind-protect
3727 (progn
3728 (save-excursion
3729 (or non-inter
3731 ;;(message "find: %s --> %s" min max)
3732 (and cperl-pod-here-fontify
3733 ;; We had evals here, do not know why...
3734 (setq face cperl-pod-face
3735 head-face cperl-pod-head-face
3736 here-face cperl-here-face))
3737 (remove-text-properties min max
3738 '(syntax-type t in-pod t syntax-table t
3739 attrib-group t
3740 REx-interpolated t
3741 cperl-postpone t
3742 syntax-subtype t
3743 rear-nonsticky t
3744 front-sticky t
3745 here-doc-group t
3746 first-format-line t
3747 REx-part2 t
3748 indentable t))
3749 ;; Need to remove face as well...
3750 (goto-char min)
3751 (and (eq system-type 'emx)
3752 (eq (point) 1)
3753 (let ((case-fold-search t))
3755 (cperl-commentify min
3756 (save-excursion (end-of-line) (point))
3757 nil))
3758 (while (and
3759 (< (point) max)
3760 (re-search-forward search max t))
3761 (setq tmpend nil) ; Valid for most cases
3762 (setq b (match-beginning 0)
3763 state (save-excursion (parse-partial-sexp
3764 state-point b nil nil state))
3765 state-point b)
3766 (cond
3767 ;; 1+6+2+1+1+6=17 extra () before this:
3769 ((match-beginning 18) ; $' or ${foo}
3771 (progn
3772 (setq b (1- (point))
3773 state (parse-partial-sexp
3774 state-point (1- b) nil nil state)
3775 state-point (1- b))
3776 (if (nth 3 state) ; in string
3777 (cperl-modify-syntax-type (1- b) cperl-st-punct))
3778 (goto-char (1+ b)))
3779 ;; else: ${
3780 (setq bb (match-beginning 0))
3781 (cperl-modify-syntax-type bb cperl-st-punct)))
3782 ;; No processing in strings/comments beyond this point:
3783 ((or (nth 3 state) (nth 4 state))
3784 t) ; Do nothing in comment/string
3785 ((match-beginning 1) ; POD section
3787 (setq b (match-beginning 0)
3788 state (parse-partial-sexp
3789 state-point b nil nil state)
3790 state-point b)
3791 (if (or (nth 3 state) (nth 4 state)
3793 (if (or (nth 3 state) (nth 4 state) ignore-max)
3794 nil ; Doing a chunk only
3795 (message "=cut is not preceded by a POD section")
3796 (or (car err-l) (setcar err-l (point))))
3797 (beginning-of-line)
3799 (setq b (point)
3800 bb b
3801 tb (match-beginning 0)
3802 b1 nil) ; error condition
3803 ;; We do not search to max, since we may be called from
3804 ;; some hook of fontification, and max is random
3806 (progn
3807 (goto-char b)
3809 (progn
3810 (message "=cut is not preceded by an empty line")
3811 (setq b1 t)
3812 (or (car err-l) (setcar err-l b))))))
3813 (beginning-of-line 2) ; An empty line after =cut is not POD!
3814 (setq e (point))
3815 (and (> e max)
3816 (progn
3817 (remove-text-properties
3818 max e '(syntax-type t in-pod t syntax-table t
3819 attrib-group t
3820 REx-interpolated t
3821 cperl-postpone t
3822 syntax-subtype t
3823 here-doc-group t
3824 rear-nonsticky t
3825 front-sticky t
3826 first-format-line t
3827 REx-part2 t
3828 indentable t))
3829 (setq tmpend tb)))
3830 (put-text-property b e 'in-pod t)
3831 (put-text-property b e 'syntax-type 'in-pod)
3832 (goto-char b)
3834 ;; We start 'pod 1 char earlier to include the preceding line
3835 (beginning-of-line)
3836 (put-text-property (cperl-1- b) (point) 'syntax-type 'pod)
3837 (cperl-put-do-not-fontify b (point) t)
3838 ;; mark the non-literal parts as PODs
3839 (if cperl-pod-here-fontify
3840 (cperl-postpone-fontification b (point) 'face face t))
3842 (beginning-of-line)
3843 (setq b (point)))
3844 (put-text-property (cperl-1- (point)) e 'syntax-type 'pod)
3845 (cperl-put-do-not-fontify (point) e t)
3846 (if cperl-pod-here-fontify
3847 (progn
3848 ;; mark the non-literal parts as PODs
3849 (cperl-postpone-fontification (point) e 'face face t)
3850 (goto-char bb)
3851 (if (looking-at
3853 ;; mark the headers
3854 (cperl-postpone-fontification
3855 (match-beginning 1) (match-end 1)
3856 'face head-face))
3857 (while (re-search-forward
3858 ;; One paragraph
3860 e 'toend)
3861 ;; mark the headers
3862 (cperl-postpone-fontification
3863 (match-beginning 1) (match-end 1)
3864 'face head-face))))
3865 (cperl-commentify bb e nil)
3866 (goto-char e)
3867 (or (eq e (point-max))
3868 (forward-char -1)))) ; Prepare for immediate POD start.
3869 ;; Here document
3870 ;; We can do many here-per-line;
3871 ;; but multiline quote on the same line as <<HERE confuses us...
3872 ;; ;; One extra () before this:
3873 ;;"<<"
3875 ;; ;; First variant "BLAH" or just ``.
3881 ;; ;; Second variant: Identifier or \ID or empty
3883 ;; ;; Do not have <<= or << 30 or <<30 or << $blah.
3887 ((match-beginning 2) ; 1 + 1
3888 (setq b (point)
3889 tb (match-beginning 0)
3890 c (and ; not HERE-DOC
3891 (match-beginning 5)
3892 (save-match-data
3894 (save-excursion ; 1 << func_name, or $foo << 10
3895 (condition-case nil
3896 (progn
3897 (goto-char tb)
3898 ;;; XXX What to do: foo <<bar ???
3899 ;;; XXX Need to support print {a} <<B ???
3900 (forward-sexp -1)
3901 (save-match-data
3902 ; $foo << b; $f .= <<B;
3903 ; ($f+1) << b; a($f) . <<B;
3904 ; foo 1, <<B; $x{a} <<b;
3905 (cond
3906 ((looking-at "[0-9$({]")
3907 (forward-sexp 1)
3908 (and
3910 (condition-case nil
3911 ;; print $foo <<EOF
3912 (progn
3913 (forward-sexp -2)
3914 (not
3916 (error t)))))))
3917 (error nil))) ; func(<<EOF)
3918 (and (not (match-beginning 6)) ; Empty
3919 (looking-at
3921 (if c ; Not here-doc
3922 nil ; Skip it.
3923 (setq c (match-end 2)) ; 1 + 1
3924 (if (match-beginning 5) ;4 + 1
3925 (setq b1 (match-beginning 5) ; 4 + 1
3926 e1 (match-end 5)) ; 4 + 1
3927 (setq b1 (match-beginning 4) ; 3 + 1
3928 e1 (match-end 4))) ; 3 + 1
3929 (setq tag (buffer-substring b1 e1)
3930 qtag (regexp-quote tag))
3931 (cond (cperl-pod-here-fontify
3932 ;; Highlight the starting delimiter
3933 (cperl-postpone-fontification
3934 b1 e1 'face my-cperl-delimiters-face)
3935 (cperl-put-do-not-fontify b1 e1 t)))
3936 (forward-line)
3937 (setq i (point))
3938 (if end-of-here-doc
3939 (goto-char end-of-here-doc))
3940 (setq b (point))
3941 ;; We do not search to max, since we may be called from
3942 ;; some hook of fontification, and max is random
3943 (or (and (re-search-forward (concat "^" qtag "$")
3944 stop-point 'toend)
3946 )
3947 (progn ; Pretend we matched at the end
3948 (goto-char (point-max))
3950 (message "End of here-document `%s' not found." tag)
3951 (or (car err-l) (setcar err-l b))))
3952 (if cperl-pod-here-fontify
3953 (progn
3954 ;; Highlight the ending delimiter
3955 (cperl-postpone-fontification
3956 (match-beginning 0) (match-end 0)
3957 'face my-cperl-delimiters-face)
3958 (cperl-put-do-not-fontify b (match-end 0) t)
3959 ;; Highlight the HERE-DOC
3960 (cperl-postpone-fontification b (match-beginning 0)
3961 'face here-face)))
3962 (setq e1 (cperl-1+ (match-end 0)))
3963 (put-text-property b (match-beginning 0)
3964 'syntax-type 'here-doc)
3965 (put-text-property (match-beginning 0) e1
3966 'syntax-type 'here-doc-delim)
3967 (put-text-property b e1 'here-doc-group t)
3968 ;; This makes insertion at the start of HERE-DOC update
3969 ;; the whole construct:
3970 (put-text-property b (cperl-1+ b) 'front-sticky '(syntax-type))
3971 (cperl-commentify b e1 nil)
3972 (cperl-put-do-not-fontify b (match-end 0) t)
3973 ;; Cache the syntax info...
3974 (setq cperl-syntax-state (cons state-point state))
3975 ;; ... and process the rest of the line...
3976 (setq overshoot
3977 (elt ; non-inter ignore-max
3978 (cperl-find-pods-heres c i t end t e1) 1))
3979 (if (and overshoot (> overshoot (point)))
3980 (goto-char overshoot)
3981 (setq overshoot e1))
3982 (if (> e1 max)
3983 (setq tmpend tb))))
3984 ;; format
3985 ((match-beginning 8)
3986 ;; 1+6=7 extra () before this:
3988 (setq b (point)
3989 name (if (match-beginning 8) ; 7 + 1
3990 (buffer-substring (match-beginning 8) ; 7 + 1
3991 (match-end 8)) ; 7 + 1
3992 "")
3993 tb (match-beginning 0))
3994 (setq argument nil)
3995 (put-text-property (save-excursion
3996 (beginning-of-line)
3997 (point))
3998 b 'first-format-line 't)
3999 (if cperl-pod-here-fontify
4000 (while (and (eq (forward-line) 0)
4001 (not (looking-at "^[.;]$")))
4002 (cond
4003 ((looking-at "^#")) ; Skip comments
4004 ((and argument ; Skip argument multi-lines
4006 (forward-sexp 1)
4007 (setq argument nil))
4008 (argument ; Skip argument lines
4009 (setq argument nil))
4010 (t ; Format line
4011 (setq b1 (point))
4013 (end-of-line)
4014 ;; Highlight the format line
4015 (cperl-postpone-fontification b1 (point)
4016 'face font-lock-string-face)
4017 (cperl-commentify b1 (point) nil)
4018 (cperl-put-do-not-fontify b1 (point) t))))
4019 ;; We do not search to max, since we may be called from
4020 ;; some hook of fontification, and max is random
4021 (re-search-forward "^[.;]$" stop-point 'toend))
4022 (beginning-of-line)
4024 (progn
4025 ;; Highlight the ending delimiter
4026 (cperl-postpone-fontification (point) (+ (point) 2)
4027 'face font-lock-string-face)
4028 (cperl-commentify (point) (+ (point) 2) nil)
4029 (cperl-put-do-not-fontify (point) (+ (point) 2) t))
4030 (message "End of format `%s' not found." name)
4031 (or (car err-l) (setcar err-l b)))
4032 (forward-line)
4033 (if (> (point) max)
4034 (setq tmpend tb))
4035 (put-text-property b (point) 'syntax-type 'format))
4036 ;; qq-like String or Regexp:
4037 ((or (match-beginning 10) (match-beginning 11))
4038 ;; 1+6+2=9 extra () before this:
4042 (setq b1 (if (match-beginning 10) 10 11)
4043 argument (buffer-substring
4044 (match-beginning b1) (match-end b1))
4045 b (point) ; end of qq etc
4046 i b
4047 c (char-after (match-beginning b1))
4048 bb (char-after (1- (match-beginning b1))) ; tmp holder
4049 ;; bb == "Not a stringy"
4050 bb (if (eq b1 10) ; user variables/whatever
4051 (and (memq bb (append "$@%*#_:-&>" nil)) ; $#y)
4052 (cond ((eq bb ?-) (eq c ?s)) ; -s file test
4053 ((eq bb ?\:) ; $opt::s
4054 (eq (char-after
4055 (- (match-beginning b1) 2))
4056 ?\:))
4057 ((eq bb ?\>) ; $foo->s
4058 (eq (char-after
4059 (- (match-beginning b1) 2))
4060 ?\-))
4061 ((eq bb ?\&)
4062 (not (eq (char-after ; &&m/blah/
4063 (- (match-beginning b1) 2))
4064 ?\&)))
4065 (t t)))
4066 ;; <file> or <$file>
4067 (and (eq c ?\<)
4068 ;; Do not stringify <FH>, <$fh> :
4069 (save-match-data
4070 (looking-at
4072 tb (match-beginning 0))
4073 (goto-char (match-beginning b1))
4074 (cperl-backward-to-noncomment (point-min))
4075 (or bb
4076 (if (eq b1 11) ; bare /blah/ or ?blah? or <foo>
4077 (setq argument ""
4078 b1 nil
4079 bb ; Not a regexp?
4080 (not
4081 ;; What is below: regexp-p?
4082 (and
4083 (or (memq (preceding-char)
4085 ;; $a++ ? 1 : 2
4086 "~{(=|&*!,;:["
4087 "~{(=|&+-*!,;:[") nil))
4088 (and (eq (preceding-char) ?\})
4089 (cperl-after-block-p (point-min)))
4090 (and (eq (char-syntax (preceding-char)) ?w)
4091 (progn
4092 (forward-sexp -1)
4093 ;; After these keywords `/' starts a RE. One should add all the
4094 ;; functions/builtins which expect an argument, but ...
4095 (if (eq (preceding-char) ?-)
4096 ;; -d ?foo? is a RE
4098 (and
4099 (not (memq (preceding-char)
4100 '(?$ ?@ ?& ?%)))
4101 (looking-at
4102 "\\(while\\|if\\|unless\\|until\\|and\\|or\\|not\\|xor\\|split\\|grep\\|map\\|print\\)\\>")))))
4103 (and (eq (preceding-char) ?.)
4104 (eq (char-after (- (point) 2)) ?.))
4105 (bobp))
4106 ;; m|blah| ? foo : bar;
4107 (not
4109 cperl-use-syntax-table-text-property
4110 (not (bobp))
4111 (progn
4112 (forward-char -1)
4114 b (1- b))
4115 ;; s y tr m
4116 ;; Check for $a -> y
4117 (setq b1 (preceding-char)
4118 go (point))
4119 (if (and (eq b1 ?>)
4120 (eq (char-after (- go 2)) ?-))
4121 ;; Not a regexp
4122 (setq bb t))))
4123 (or bb
4124 (progn
4125 (goto-char b)
4127 (goto-char (match-end 0))
4129 (cond ((and (eq (following-char) ?\})
4130 (eq b1 ?\{))
4131 ;; Check for $a[23]->{ s }, @{s} and *{s::foo}
4132 (goto-char (1- go))
4134 (if (memq (preceding-char) (append "$@%&*" nil))
4135 (setq bb t) ; @{y}
4136 (condition-case nil
4137 (forward-sexp -1)
4138 (error nil)))
4139 (if (or bb
4140 (looking-at ; $foo -> {s}
4142 (and ; $foo[12] -> {s}
4143 (memq (following-char) '(?\{ ?\[))
4144 (progn
4145 (forward-sexp 1)
4147 (setq bb t)
4148 (goto-char b)))
4149 ((and (eq (following-char) ?=)
4150 (eq (char-after (1+ (point))) ?\>))
4151 ;; Check for { foo => 1, s => 2 }
4152 ;; Apparently s=> is never a substitution...
4153 (setq bb t))
4154 ((and (eq (following-char) ?:)
4155 (eq b1 ?\{) ; Check for $ { s::bar }
4157 (progn
4158 (goto-char (1- go))
4160 (memq (preceding-char)
4161 (append "$@%&*" nil))))
4162 (setq bb t))
4163 ((eobp)
4164 (setq bb t)))))
4165 (if bb
4166 (goto-char i)
4167 ;; Skip whitespace and comments...
4169 (goto-char (match-end 0))
4171 (if (> (point) b)
4172 (put-text-property b (point) 'syntax-type 'prestring))
4173 ;; qtag means two-arg matcher, may be reset to
4174 ;; 2 or 3 later if some special quoting is needed.
4175 ;; e1 means matching-char matcher.
4176 (setq b (point) ; before the first delimiter
4177 ;; has 2 args
4179 ;; We do not search to max, since we may be called from
4180 ;; some hook of fontification, and max is random
4181 i (cperl-forward-re stop-point end
4182 i2
4183 st-l err-l argument)
4184 ;; If `go', then it is considered as 1-arg, `b1' is nil
4185 ;; as in s/foo//x; the point is before final "slash"
4186 b1 (nth 1 i) ; start of the second part
4187 tag (nth 2 i) ; ender-char, true if second part
4188 ; is with matching chars []
4189 go (nth 4 i) ; There is a 1-char part after the end
4190 i (car i) ; intermediate point
4191 e1 (point) ; end
4192 ;; Before end of the second part if non-matching: ///
4193 tail (if (and i (not tag))
4194 (1- e1))
4195 e (if i i e1) ; end of the first part
4196 qtag nil ; need to preserve backslashitis
4197 is-x-REx nil is-o-REx nil); REx has //x //o modifiers
4198 ;; If s{} (), then b/b1 are at "{", "(", e1/i after ")", "}"
4200 (and i tail
4202 (setq qtag t))
4205 (setq is-x-REx t))
4208 (setq is-o-REx t))
4209 (if (null i)
4210 ;; Considered as 1arg form
4211 (progn
4212 (cperl-commentify b (point) t)
4213 (put-text-property b (point) 'syntax-type 'string)
4214 (if (or is-x-REx
4215 ;; ignore other text properties:
4216 (string-match "^qw$" argument))
4217 (put-text-property b (point) 'indentable t))
4218 (and go
4219 (setq e1 (cperl-1+ e1))
4220 (or (eobp)
4221 (forward-char 1))))
4222 (cperl-commentify b i t)
4224 (progn
4225 ;; Cache the syntax info...
4226 (setq cperl-syntax-state (cons state-point state))
4227 (and
4228 ;; silent:
4229 (car (cperl-find-pods-heres b1 (1- (point)) t end))
4230 ;; Error
4231 (goto-char (1+ max)))
4232 (if (and tag (eq (preceding-char) ?\>))
4233 (progn
4234 (cperl-modify-syntax-type (1- (point)) cperl-st-ket)
4235 (cperl-modify-syntax-type i cperl-st-bra)))
4236 (put-text-property b i 'syntax-type 'string)
4237 (put-text-property i (point) 'syntax-type 'multiline)
4238 (if is-x-REx
4239 (put-text-property b i 'indentable t)))
4240 (cperl-commentify b1 (point) t)
4241 (put-text-property b (point) 'syntax-type 'string)
4242 (if is-x-REx
4243 (put-text-property b i 'indentable t))
4244 (if qtag
4245 (cperl-modify-syntax-type (1+ i) cperl-st-punct))
4246 (setq tail nil)))
4247 ;; Now: tail: if the second part is non-matching without ///e
4248 (if (eq (char-syntax (following-char)) ?w)
4249 (progn
4250 (forward-word 1) ; skip modifiers s///s
4251 (if tail (cperl-commentify tail (point) t))
4252 (cperl-postpone-fontification
4253 e1 (point) 'face my-cperl-REx-modifiers-face)))
4254 ;; Check whether it is m// which means "previous match"
4255 ;; and highlight differently
4256 (setq is-REx
4258 (or (not (= (length argument) 0))
4259 (not (eq c ?\<)))))
4260 (if (and is-REx
4261 (eq e (+ 2 b))
4262 ;; split // *is* using zero-pattern
4263 (save-excursion
4264 (condition-case nil
4265 (progn
4266 (goto-char tb)
4267 (forward-sexp -1)
4269 (error t))))
4270 (cperl-postpone-fontification
4271 b e 'face font-lock-warning-face)
4272 (if (or i2 ; Has 2 args
4273 (and cperl-fontify-m-as-s
4274 (or
4276 (and (eq 0 (length argument))
4277 (not (eq ?\< (char-after b)))))))
4278 (progn
4279 (cperl-postpone-fontification
4280 b (cperl-1+ b) 'face my-cperl-delimiters-face)
4281 (cperl-postpone-fontification
4282 (1- e) e 'face my-cperl-delimiters-face)))
4283 (if (and is-REx cperl-regexp-scan)
4284 ;; Process RExen: embedded comments, charclasses and ]
4286 ;;;/a\.b[^a[:ff:]b]x$ab->$[|$,$ab->[cd]->[ef]|$ab[xy].|^${a,b}{c,d}/;
4289 ;;;m$(^ab[c]\$)$ + m+(^ab[c]\$\+)+ + m](^ab[c\]$|.+)] + m)(^ab[c]$|.+\));
4290 ;;;m^a[\^b]c^ + m.a[^b]\.c.;
4291 (save-excursion
4292 (goto-char (1+ b))
4293 ;; First
4294 (cperl-look-at-leading-count is-x-REx e)
4295 (setq hairy-RE
4296 (concat
4297 (if is-x-REx
4298 (if (eq (char-after b) ?\#)
4301 ;; keep the same count: add a fake group
4302 (if (eq (char-after b) ?\#)
4310 ;; XXXX Will not be able to use it in s)))
4311 (if (eq (char-after b) ?\) )
4313 (if (eq (char-after b) ?? )
4319 "[$@]"
4321 "[_a-zA-Z:][_a-zA-Z0-9:]*"
4323 "{[^{}]*}" ; only one-level allowed
4331 "{[^{}]*}"
4333 ;; XXXX: what if u is delim?
4335 "[)^|$.*?+]"
4337 "{[0-9]+}"
4339 "{[0-9]+,[0-9]*}"
4343 "(" ; Group opener
4360 ))
4361 (while
4362 (and (< (point) (1- e))
4363 (re-search-forward hairy-RE (1- e) 'to-end))
4364 (goto-char (match-beginning 0))
4365 (setq REx-subgr-start (point)
4366 was-subgr (following-char))
4367 (cond
4368 ((match-beginning 6) ; 0-length builtins, groups
4369 (goto-char (match-end 0))
4370 (if (match-beginning 11)
4371 (goto-char (match-beginning 11)))
4372 (if (>= (point) e)
4373 (goto-char (1- e)))
4374 (cperl-postpone-fontification
4375 (match-beginning 0) (point)
4376 'face
4377 (cond
4378 ((eq was-subgr ?\) )
4379 (condition-case nil
4380 (save-excursion
4381 (forward-sexp -1)
4382 (if (> (point) b)
4383 (if (if (eq (char-after b) ?? )
4386 my-cperl-REx-0length-face
4387 my-cperl-REx-ctl-face)
4388 font-lock-warning-face))
4389 (error font-lock-warning-face)))
4390 ((eq was-subgr ?\| )
4391 my-cperl-REx-ctl-face)
4392 ((eq was-subgr ?\$ )
4393 (if (> (point) (1+ REx-subgr-start))
4394 (progn
4395 (put-text-property
4396 (match-beginning 0) (point)
4397 'REx-interpolated
4398 (if is-o-REx 0
4399 (if (and (eq (match-beginning 0)
4400 (1+ b))
4401 (eq (point)
4402 (1- e))) 1 t)))
4403 font-lock-variable-name-face)
4404 my-cperl-REx-spec-char-face))
4405 ((memq was-subgr (append "^." nil) )
4406 my-cperl-REx-spec-char-face)
4407 ((eq was-subgr ?\( )
4408 (if (not (match-beginning 10))
4409 my-cperl-REx-ctl-face
4410 my-cperl-REx-0length-face))
4411 (t my-cperl-REx-0length-face)))
4412 (if (and (memq was-subgr (append "(|" nil))
4414 (match-string 0))))
4415 (cperl-look-at-leading-count is-x-REx e))
4416 (setq was-subgr nil)) ; We do stuff here
4417 ((match-beginning 12) ; \SYMBOL
4418 (forward-char 2)
4419 (if (>= (point) e)
4420 (goto-char (1- e))
4421 ;; How many chars to not highlight:
4422 ;; 0-len special-alnums in other branch =>
4425 (setq REx-subgr-start (point)
4426 qtag (preceding-char))
4427 (cperl-postpone-fontification
4428 (- (point) 2) (- (point) 1) 'face
4429 (if (memq qtag
4430 (append "ghijkmoqvFHIJKMORTVY" nil))
4431 font-lock-warning-face
4432 my-cperl-REx-0length-face))
4433 (if (and (eq (char-after b) qtag)
4434 (memq qtag (append ".])^$|*?+" nil)))
4435 (progn
4436 (if (and cperl-use-syntax-table-text-property
4437 (eq qtag ?\) ))
4438 (put-text-property
4439 REx-subgr-start (1- (point))
4440 'syntax-table cperl-st-punct))
4441 (cperl-postpone-fontification
4442 (1- (point)) (point) 'face
4443 ; \] can't appear below
4444 (if (memq qtag (append ".]^$" nil))
4445 'my-cperl-REx-spec-char-face
4446 (if (memq qtag (append "*?+" nil))
4447 'my-cperl-REx-0length-face
4448 'my-cperl-REx-ctl-face))))) ; )|
4449 ;; Test for arguments:
4450 (cond
4451 ;; This is not pretty: the 5.8.7 logic:
4452 ;; \0numx -> octal (up to total 3 dig)
4453 ;; \DIGIT -> backref unless \0
4454 ;; \DIGITs -> backref if valid
4455 ;; otherwise up to 3 -> octal
4456 ;; Do not try to distinguish, we guess
4457 ((or (and (memq qtag (append "01234567" nil))
4458 (re-search-forward
4460 (1- e) 'to-end))
4461 (and (memq qtag (append "89" nil))
4462 (re-search-forward
4464 (and (eq qtag ?x)
4465 (re-search-forward
4467 (1- e) 'to-end))
4468 (and (memq qtag (append "pPN" nil))
4470 (1- e) 'to-end))
4471 (eq (char-syntax qtag) ?w))
4472 (cperl-postpone-fontification
4473 (1- REx-subgr-start) (point)
4474 'face my-cperl-REx-length1-face))))
4475 (setq was-subgr nil)) ; We do stuff here
4476 ((match-beginning 3) ; [charclass]
4477 (forward-char 1)
4478 (if (eq (char-after b) ?^ )
4480 (eq (char-after (cperl-1+ (point)))
4481 ?^ )
4482 (forward-char 2))
4483 (and (eq (following-char) ?^ )
4484 (forward-char 1)))
4485 (setq argument b ; continue?
4486 tag nil ; list of POSIX classes
4487 qtag (point))
4488 (if (eq (char-after b) ?\] )
4490 (eq (char-after (cperl-1+ (point)))
4491 ?\] )
4492 (setq qtag (1+ qtag))
4493 (forward-char 2))
4494 (and (eq (following-char) ?\] )
4495 (forward-char 1)))
4496 ;; Apparently, I can't put \] into a charclass
4498 ;;; POSIX? [:word:] [:^word:] only inside []
4500 (while
4501 (and argument
4502 (re-search-forward
4503 (if (eq (char-after b) ?\] )
4506 (1- e) 'toend))
4507 ;; Is this ] an end of POSIX class?
4508 (if (save-excursion
4509 (and
4510 (search-backward "[" argument t)
4511 (< REx-subgr-start (point))
4512 (not
4513 (and ; Should work with delim = \
4515 (= (% (skip-chars-backward
4517 (looking-at
4518 (cond
4519 ((eq (char-after b) ?\] )
4521 ((eq (char-after b) ?\: )
4523 ((eq (char-after b) ?^ )
4525 ((eq (char-syntax (char-after b))
4526 ?w)
4527 (concat
4529 (char-to-string (char-after b))
4532 (setq argument (point))))
4533 (setq tag (cons (cons argument (point))
4534 tag)
4535 argument (point)) ; continue
4536 (setq argument nil)))
4537 (and argument
4538 (message "Couldn't find end of charclass in a REx, pos=%s"
4539 REx-subgr-start))
4540 (if (and cperl-use-syntax-table-text-property
4541 (> (- (point) 2) REx-subgr-start))
4542 (put-text-property
4543 (1+ REx-subgr-start) (1- (point))
4544 'syntax-table cperl-st-punct))
4545 (cperl-postpone-fontification
4546 REx-subgr-start qtag
4547 'face my-cperl-REx-spec-char-face)
4548 (cperl-postpone-fontification
4549 (1- (point)) (point) 'face
4550 my-cperl-REx-spec-char-face)
4551 (if (eq (char-after b) ?\] )
4552 (cperl-postpone-fontification
4553 (- (point) 2) (1- (point))
4554 'face my-cperl-REx-0length-face))
4555 (while tag
4556 (cperl-postpone-fontification
4557 (car (car tag)) (cdr (car tag))
4558 'face my-cperl-REx-length1-face)
4559 (setq tag (cdr tag)))
4560 (setq was-subgr nil)) ; did facing already
4561 ;; Now rare stuff:
4562 ((and (match-beginning 2) ; #-comment
4563 (/= (match-beginning 2) (match-end 2)))
4564 (beginning-of-line 2)
4565 (if (> (point) e)
4566 (goto-char (1- e))))
4567 ((match-beginning 4) ; character "]"
4568 (setq was-subgr nil) ; We do stuff here
4569 (goto-char (match-end 0))
4570 (if cperl-use-syntax-table-text-property
4571 (put-text-property
4572 (1- (point)) (point)
4573 'syntax-table cperl-st-punct))
4574 (cperl-postpone-fontification
4575 (1- (point)) (point)
4576 'face font-lock-warning-face))
4577 ((match-beginning 5) ; before (?{}) (??{})
4578 (setq tag (match-end 0))
4579 (if (or (setq qtag
4580 (cperl-forward-group-in-re st-l))
4581 (and (>= (point) e)
4582 (setq qtag "no matching `)' found"))
4583 (and (not (eq (char-after (- (point) 2))
4584 ?\} ))
4585 (setq qtag "Can't find })")))
4586 (progn
4587 (goto-char (1- e))
4588 (message "%s" qtag))
4589 (cperl-postpone-fontification
4590 (1- tag) (1- (point))
4591 'face font-lock-variable-name-face)
4592 (cperl-postpone-fontification
4593 REx-subgr-start (1- tag)
4594 'face my-cperl-REx-spec-char-face)
4595 (cperl-postpone-fontification
4596 (1- (point)) (point)
4597 'face my-cperl-REx-spec-char-face)
4598 (if cperl-use-syntax-table-text-property
4599 (progn
4600 (put-text-property
4601 (- (point) 2) (1- (point))
4602 'syntax-table cperl-st-cfence)
4603 (put-text-property
4604 (+ REx-subgr-start 2)
4605 (+ REx-subgr-start 3)
4606 'syntax-table cperl-st-cfence))))
4607 (setq was-subgr nil))
4608 (t ; (?#)-comment
4610 ;; Works also if the outside delimiters are ().
4611 (or;;(if (eq (char-after b) ?\) )
4612 ;;(re-search-forward
4614 ;; (1- e) 'toend)
4615 (search-forward ")" (1- e) 'toend)
4616 ;;)
4617 (message
4618 "Couldn't find end of (?#...)-comment in a REx, pos=%s"
4619 REx-subgr-start))))
4620 (if (>= (point) e)
4621 (goto-char (1- e)))
4622 (cond
4623 (was-subgr
4624 (setq REx-subgr-end (point))
4625 (cperl-commentify
4626 REx-subgr-start REx-subgr-end nil)
4627 (cperl-postpone-fontification
4628 REx-subgr-start REx-subgr-end
4629 'face font-lock-comment-face))))))
4630 (if (and is-REx is-x-REx)
4631 (put-text-property (1+ b) (1- e)
4632 'syntax-subtype 'x-REx)))
4633 (if (and i2 e1 b1 (> e1 b1))
4634 (progn ; No errors finding the second part...
4635 (cperl-postpone-fontification
4636 (1- e1) e1 'face my-cperl-delimiters-face)
4637 (if (and (not (eobp))
4638 (assoc (char-after b) cperl-starters))
4639 (progn
4640 (cperl-postpone-fontification
4641 b1 (1+ b1) 'face my-cperl-delimiters-face)
4642 (put-text-property b1 (1+ b1)
4643 'REx-part2 t)))))
4644 (if (> (point) max)
4645 (setq tmpend tb))))
4646 ((match-beginning 17) ; sub with prototype or attribute
4647 ;; 1+6+2+1+1=11 extra () before this (sub with proto/attr):
4649 ;; cperl-white-and-comment-rex ;13
4653 (setq b1 (match-beginning 14) e1 (match-end 14))
4654 (if (memq (char-after (1- b))
4655 '(?\$ ?\@ ?\% ?\& ?\*))
4656 nil
4657 (goto-char b)
4658 (if (eq (char-after (match-beginning 17)) ?\( )
4659 (progn
4660 (cperl-commentify ; Prototypes; mark as string
4661 (match-beginning 17) (match-end 17) t)
4662 (goto-char (match-end 0))
4663 ;; Now look for attributes after prototype:
4664 (forward-comment (buffer-size))
4665 (and (looking-at ":[^:]")
4666 (cperl-find-sub-attrs st-l b1 e1 b)))
4667 ;; treat attributes without prototype
4668 (goto-char (match-beginning 17))
4669 (cperl-find-sub-attrs st-l b1 e1 b))))
4670 ;; 1+6+2+1+1+6+1=18 extra () before this:
4672 ((match-beginning 19) ; old $abc'efg syntax
4673 (setq bb (match-end 0))
4674 ;;;(if (nth 3 state) nil ; in string
4675 (put-text-property (1- bb) bb 'syntax-table cperl-st-word)
4676 (goto-char bb))
4677 ;; 1+6+2+1+1+6+1+1=19 extra () before this:
4679 ((match-beginning 20) ; __END__, __DATA__
4680 (setq bb (match-end 0))
4681 ;; (put-text-property b (1+ bb) 'syntax-type 'pod) ; Cheat
4682 (cperl-commentify b bb nil)
4683 (setq end t))
4685 ((match-beginning 21)
4686 ;; Trailing backslash; make non-quoting outside string/comment
4687 (setq bb (match-end 0))
4688 (goto-char b)
4691 (cperl-modify-syntax-type b cperl-st-punct)
4692 (goto-char bb))
4693 (t (error "Error in regexp of the sniffer")))
4694 (if (> (point) stop-point)
4695 (progn
4696 (if end
4697 (message "Garbage after __END__/__DATA__ ignored")
4698 (message "Unbalanced syntax found while scanning")
4699 (or (car err-l) (setcar err-l b)))
4700 (goto-char stop-point))))
4701 (setq cperl-syntax-state (cons state-point state)
4702 ;; Do not mark syntax as done past tmpend???
4703 cperl-syntax-done-to (or tmpend (max (point) max)))
4704 ;;(message "state-at=%s, done-to=%s" state-point cperl-syntax-done-to)
4705 )
4706 (if (car err-l) (goto-char (car err-l))
4707 (or non-inter
4709 (and (buffer-modified-p)
4710 (not modified)
4711 (set-buffer-modified-p nil))
4712 ;; I do not understand what this is doing here. It breaks font-locking
4713 ;; because it resets the syntax-table from font-lock-syntax-table to
4714 ;; cperl-mode-syntax-table.
4715 ;; (set-syntax-table cperl-mode-syntax-table)
4716 )
4717 (list (car err-l) overshoot)))
4719 (defun cperl-find-pods-heres-region (min max)
4720 (interactive "r")
4721 (cperl-find-pods-heres min max))
4723 (defun cperl-backward-to-noncomment (lim)
4724 ;; Stops at lim or after non-whitespace that is not in comment
4725 ;; XXXX Wrongly understands end-of-multiline strings with # as comment
4726 (let (stop p pr)
4727 (while (and (not stop) (> (point) (or lim (point-min))))
4729 (setq p (point))
4730 (beginning-of-line)
4731 (if (memq (setq pr (get-text-property (point) 'syntax-type))
4732 '(pod here-doc here-doc-delim))
4733 (progn
4734 (cperl-unwind-to-safe nil)
4735 (setq pr (get-text-property (point) 'syntax-type))))
4737 (not (memq pr '(string prestring))))
4738 (progn (cperl-to-comment-or-eol) (bolp))
4739 (progn
4741 (if (< p (point)) (goto-char p))
4742 (setq stop t))))))
4744 ;; Used only in `cperl-calculate-indent'...
4745 (defun cperl-block-p () ; Do not C-M-q ! One string contains ";" !
4746 ;; Positions is before ?\{. Checks whether it starts a block.
4747 ;; No save-excursion! This is more a distinguisher of a block/hash ref...
4748 (cperl-backward-to-noncomment (point-min))
4749 (or (memq (preceding-char) (append ";){}$@&%\C-@" nil)) ; Or label! \C-@ at bobp
4750 ; Label may be mixed up with `$blah :'
4751 (save-excursion (cperl-after-label))
4752 (get-text-property (cperl-1- (point)) 'attrib-group)
4753 (and (memq (char-syntax (preceding-char)) '(?w ?_))
4754 (progn
4755 (backward-sexp)
4756 ;; sub {BLK}, print {BLK} $data, but NOT `bless', `return', `tr'
4759 ;; sub bless::foo {}
4760 (progn
4761 (cperl-backward-to-noncomment (point-min))
4762 (and (eq (preceding-char) ?b)
4763 (progn
4764 (forward-sexp -1)
4767 ;;; What is the difference of (cperl-after-block-p lim t) and (cperl-block-p)?
4768 ;;; No save-excursion; condition-case ... In (cperl-block-p) the block
4769 ;;; may be a part of an in-statement construct, such as
4770 ;;; ${something()}, print {FH} $data.
4771 ;;; Moreover, one takes positive approach (looks for else,grep etc)
4772 ;;; another negative (looks for bless,tr etc)
4773 (defun cperl-after-block-p (lim &optional pre-block)
4774 "Return true if the preceeding } (if PRE-BLOCK, following {) delimits a block.
4775 Would not look before LIM. Assumes that LIM is a good place to begin a
4776 statement. The kind of block we treat here is one after which a new
4777 statement would start; thus the block in ${func()} does not count."
4778 (save-excursion
4779 (condition-case nil
4780 (progn
4781 (or pre-block (forward-sexp -1))
4782 (cperl-backward-to-noncomment lim)
4783 (or (eq (point) lim)
4784 ;; if () {} // sub f () {} // sub f :a(') {}
4785 (eq (preceding-char) ?\) )
4786 ;; label: {}
4787 (save-excursion (cperl-after-label))
4788 ;; sub :attr {}
4789 (get-text-property (cperl-1- (point)) 'attrib-group)
4790 (if (memq (char-syntax (preceding-char)) '(?w ?_)) ; else {}
4791 (save-excursion
4792 (forward-sexp -1)
4793 ;; else {} but not else::func {}
4796 ;; sub f {}
4797 (progn
4798 (cperl-backward-to-noncomment lim)
4799 (and (eq (preceding-char) ?b)
4800 (progn
4801 (forward-sexp -1)
4803 ;; What preceeds is not word... XXXX Last statement in sub???
4804 (cperl-after-expr-p lim))))
4805 (error nil))))
4807 (defun cperl-after-expr-p (&optional lim chars test)
4808 "Return true if the position is good for start of expression.
4809 TEST is the expression to evaluate at the found position. If absent,
4810 CHARS is a string that contains good characters to have before us (however,
4812 (let ((lim (or lim (point-min)))
4813 stop p pr)
4814 (cperl-update-syntaxification (point) (point))
4815 (save-excursion
4816 (while (and (not stop) (> (point) lim))
4818 (setq p (point))
4819 (beginning-of-line)
4820 ;;(memq (setq pr (get-text-property (point) 'syntax-type))
4821 ;; '(pod here-doc here-doc-delim))
4822 (if (get-text-property (point) 'here-doc-group)
4823 (progn
4824 (goto-char
4825 (cperl-beginning-of-property (point) 'here-doc-group))
4826 (beginning-of-line 0)))
4827 (if (get-text-property (point) 'in-pod)
4828 (progn
4829 (goto-char
4830 (cperl-beginning-of-property (point) 'in-pod))
4831 (beginning-of-line 0)))
4833 ;; Else: last iteration, or a label
4834 (cperl-to-comment-or-eol) ; Will not move past "." after a format
4836 (if (< p (point)) (goto-char p))
4837 (setq p (point))
4838 (if (and (eq (preceding-char) ?:)
4839 (progn
4840 (forward-char -1)
4842 (memq (char-syntax (preceding-char)) '(?w ?_))))
4843 (forward-sexp -1) ; Possibly label. Skip it
4844 (goto-char p)
4845 (setq stop t))))
4846 (or (bobp) ; ???? Needed
4847 (eq (point) lim)
4849 (progn
4850 (if test (eval test)
4851 (or (memq (preceding-char) (append (or chars "{;") nil))
4852 (and (eq (preceding-char) ?\})
4853 (cperl-after-block-p lim))
4854 (and (eq (following-char) ?.) ; in format: see comment above
4855 (eq (get-text-property (point) 'syntax-type)
4856 'format)))))))))
4858 (defun cperl-backward-to-start-of-expr (&optional lim)
4859 (condition-case nil
4860 (progn
4861 (while (and (or (not lim)
4862 (> (point) lim))
4863 (not (cperl-after-expr-p lim)))
4864 (forward-sexp -1)
4865 ;; May be after $, @, $# etc of a variable
4866 (skip-chars-backward "$@%#")))
4867 (error nil)))
4869 (defun cperl-at-end-of-expr (&optional lim)
4870 ;; Since the SEXP approach below is very fragile, do some overengineering
4871 (or (looking-at (concat cperl-maybe-white-and-comment-rex "[;}]"))
4872 (condition-case nil
4873 (save-excursion
4874 ;; If nothing interesting after, does as (forward-sexp -1);
4875 ;; otherwise fails, or ends at a start of following sexp.
4876 ;; XXXX PROBLEMS: if what follows (after ";") @FOO, or ${bar}
4877 ;; may be stuck after @ or $; just put some stupid workaround now:
4878 (let ((p (point)))
4879 (forward-sexp 1)
4880 (forward-sexp -1)
4881 (while (memq (preceding-char) (append "%&@$*" nil))
4882 (forward-char -1))
4883 (or (< (point) p)
4884 (cperl-after-expr-p lim))))
4885 (error t))))
4887 (defun cperl-forward-to-end-of-expr (&optional lim)
4888 (let ((p (point))))
4889 (condition-case nil
4890 (progn
4891 (while (and (< (point) (or lim (point-max)))
4892 (not (cperl-at-end-of-expr)))
4893 (forward-sexp 1)))
4894 (error nil)))
4896 (defun cperl-backward-to-start-of-continued-exp (lim)
4898 (forward-sexp -1))
4899 (beginning-of-line)
4900 (if (<= (point) lim)
4901 (goto-char (1+ lim)))
4904 (defun cperl-after-block-and-statement-beg (lim)
4905 ;; We assume that we are after ?\}
4906 (and
4907 (cperl-after-block-p lim)
4908 (save-excursion
4909 (forward-sexp -1)
4910 (cperl-backward-to-noncomment (point-min))
4911 (or (bobp)
4912 (eq (point) lim)
4913 (not (= (char-syntax (preceding-char)) ?w))
4914 (progn
4915 (forward-sexp -1)
4916 (not
4917 (looking-at
4920 \f
4921 (defun cperl-indent-exp ()
4922 "Simple variant of indentation of continued-sexp.
4924 Will not indent comment if it starts at `comment-indent' or looks like
4925 continuation of the comment on the previous line.
4927 If `cperl-indent-region-fix-constructs', will improve spacing on
4928 conditional/loop constructs."
4929 (interactive)
4930 (save-excursion
4931 (let ((tmp-end (progn (end-of-line) (point))) top done)
4932 (save-excursion
4933 (beginning-of-line)
4934 (while (null done)
4935 (setq top (point))
4936 ;; Plan A: if line has an unfinished paren-group, go to end-of-group
4937 (while (= -1 (nth 0 (parse-partial-sexp (point) tmp-end -1)))
4938 (setq top (point))) ; Get the outermost parenths in line
4939 (goto-char top)
4940 (while (< (point) tmp-end)
4941 (parse-partial-sexp (point) tmp-end nil t) ; To start-sexp or eol
4942 (or (eolp) (forward-sexp 1)))
4943 (if (> (point) tmp-end) ; Yes, there an unfinished block
4944 nil
4945 (if (eq ?\) (preceding-char))
4946 (progn ;; Plan B: find by REGEXP block followup this line
4947 (setq top (point))
4948 (condition-case nil
4949 (progn
4950 (forward-sexp -2)
4951 (if (eq (following-char) ?$ ) ; for my $var (list)
4952 (progn
4953 (forward-sexp -1)
4955 (forward-sexp -1))))
4956 (if (looking-at
4959 cperl-maybe-white-and-comment-rex
4961 cperl-maybe-white-and-comment-rex
4963 (progn
4964 (goto-char top)
4965 (forward-sexp 1)
4966 (setq top (point)))))
4967 (error (setq done t)))
4968 (goto-char top))
4969 (if (looking-at ; Try Plan C: continuation block
4970 (concat cperl-maybe-white-and-comment-rex
4972 (progn
4973 (goto-char (match-end 0))
4974 (save-excursion
4975 (end-of-line)
4976 (setq tmp-end (point))))
4977 (setq done t))))
4978 (save-excursion
4979 (end-of-line)
4980 (setq tmp-end (point))))
4981 (goto-char tmp-end)
4982 (setq tmp-end (point-marker)))
4983 (if cperl-indent-region-fix-constructs
4984 (cperl-fix-line-spacing tmp-end))
4985 (cperl-indent-region (point) tmp-end))))
4987 (defun cperl-fix-line-spacing (&optional end parse-data)
4988 "Improve whitespace in a conditional/loop construct.
4989 Returns some position at the last line."
4990 (interactive)
4991 (or end
4992 (setq end (point-max)))
4993 (let ((ee (save-excursion (end-of-line) (point)))
4994 (cperl-indent-region-fix-constructs
4995 (or cperl-indent-region-fix-constructs 1))
4996 p pp ml have-brace ret)
4997 (save-excursion
4998 (beginning-of-line)
4999 (setq ret (point))
5000 ;; }? continue
5001 ;; blah; }
5002 (if (not
5003 (or (looking-at "[ \t]*\\(els\\(e\\|if\\)\\|continue\\|if\\|while\\|for\\(each\\)?\\|until\\)")
5004 (setq have-brace (save-excursion (search-forward "}" ee t)))))
5005 nil ; Do not need to do anything
5006 ;; Looking at:
5007 ;; }
5008 ;; else
5009 (if cperl-merge-trailing-else
5010 (if (looking-at
5012 (progn
5013 (search-forward "}")
5014 (setq p (point))
5016 (delete-region p (point))
5017 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5018 (beginning-of-line)))
5020 (save-excursion
5021 (search-forward "}")
5022 (delete-horizontal-space)
5024 (setq ret (point))
5025 (if (cperl-indent-line parse-data)
5026 (progn
5027 (cperl-fix-line-spacing end parse-data)
5028 (setq ret (point)))))))
5029 ;; Looking at:
5030 ;; } else
5032 (progn
5033 (search-forward "}")
5034 (delete-horizontal-space)
5035 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5036 (beginning-of-line)))
5037 ;; Looking at:
5038 ;; else {
5039 (if (looking-at
5040 "[ \t]*}?[ \t]*\\<\\(\\els\\(e\\|if\\)\\|continue\\|unless\\|if\\|while\\|for\\(each\\)?\\|until\\)\\>\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5041 (progn
5042 (forward-word 1)
5043 (delete-horizontal-space)
5044 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5045 (beginning-of-line)))
5046 ;; Looking at:
5047 ;; foreach my $var
5048 (if (looking-at
5050 (progn
5051 (forward-word 2)
5052 (delete-horizontal-space)
5053 (insert (make-string cperl-indent-region-fix-constructs ?\s))
5054 (beginning-of-line)))
5055 ;; Looking at:
5056 ;; foreach my $var (
5057 (if (looking-at
5058 "[ \t]*\\<for\\(each\\)?[ \t]+\\(my\\|local\\|our\\)[ \t]*\\$[_a-zA-Z0-9]+\\(\t*\\|[ \t][ \t]+\\)[^ \t\n#]")
5059 (progn
5060 (forward-sexp 3)
5061 (delete-horizontal-space)
5062 (insert
5063 (make-string cperl-indent-region-fix-constructs ?\s))
5064 (beginning-of-line)))
5065 ;; Looking at (with or without "}" at start, ending after "({"):
5066 ;; } foreach my $var () OR {
5067 (if (looking-at
5068 "[ \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]*{")
5069 (progn
5070 (setq ml (match-beginning 8)) ; "(" or "{" after control word
5071 (re-search-forward "[({]")
5072 (forward-char -1)
5073 (setq p (point))
5074 (if (eq (following-char) ?\( )
5075 (progn
5076 (forward-sexp 1)
5077 (setq pp (point))) ; past parenth-group
5078 ;; after `else' or nothing
5079 (if ml ; after `else'
5081 (beginning-of-line))
5082 (setq pp nil))
5083 ;; Now after the sexp before the brace
5084 ;; Multiline expr should be special
5085 (setq ml (and pp (save-excursion (goto-char p)
5087 (if (and (or (not pp) (< pp end)) ; Do not go too far...
5089 (progn
5090 (cond
5091 ((bolp) ; Were before `{', no if/else/etc
5092 nil)
5094 (delete-horizontal-space)
5095 (if (if ml
5096 cperl-extra-newline-before-brace-multiline
5097 cperl-extra-newline-before-brace)
5098 (progn
5099 (delete-horizontal-space)
5101 (setq ret (point))
5102 (if (cperl-indent-line parse-data)
5103 (progn
5104 (cperl-fix-line-spacing end parse-data)
5105 (setq ret (point)))))
5106 (insert
5107 (make-string cperl-indent-region-fix-constructs ?\s))))
5109 (not (if ml
5110 cperl-extra-newline-before-brace-multiline
5111 cperl-extra-newline-before-brace)))
5112 (setq pp (point))
5114 (delete-region pp (point))
5115 (insert
5116 (make-string cperl-indent-region-fix-constructs ?\ )))
5118 (if ml cperl-extra-newline-before-brace-multiline
5119 cperl-extra-newline-before-brace))
5120 (delete-horizontal-space)
5122 (setq ret (point))
5123 (if (cperl-indent-line parse-data)
5124 (progn
5125 (cperl-fix-line-spacing end parse-data)
5126 (setq ret (point))))))
5127 ;; Now we are before `{'
5129 (progn
5131 (setq pp (point))
5132 (forward-sexp 1)
5133 (setq p (point))
5134 (goto-char pp)
5136 (if (or cperl-break-one-line-blocks-when-indent ml)
5137 ;; not good: multi-line BLOCK
5138 (progn
5139 (goto-char (1+ pp))
5140 (delete-horizontal-space)
5142 (setq ret (point))
5143 (if (cperl-indent-line parse-data)
5144 (setq ret (cperl-fix-line-spacing end parse-data)))))))))))
5145 (beginning-of-line)
5146 (setq p (point) pp (save-excursion (end-of-line) (point))) ; May be different from ee.
5147 ;; Now check whether there is a hanging `}'
5148 ;; Looking at:
5149 ;; } blah
5150 (if (and
5151 cperl-fix-hanging-brace-when-indent
5152 have-brace
5153 (not (looking-at "[ \t]*}[ \t]*\\(\\<\\(els\\(if\\|e\\)\\|continue\\|while\\|until\\)\\>\\|$\\|#\\)"))
5154 (condition-case nil
5155 (progn
5156 (up-list 1)
5157 (if (and (<= (point) pp)
5158 (eq (preceding-char) ?\} )
5159 (cperl-after-block-and-statement-beg (point-min)))
5160 t
5161 (goto-char p)
5162 nil))
5163 (error nil)))
5164 (progn
5165 (forward-char -1)
5167 (if (bolp)
5168 ;; `}' was the first thing on the line, insert NL *after* it.
5169 (progn
5170 (cperl-indent-line parse-data)
5171 (search-forward "}")
5172 (delete-horizontal-space)
5174 (delete-horizontal-space)
5175 (or (eq (preceding-char) ?\;)
5176 (bolp)
5177 (and (eq (preceding-char) ?\} )
5178 (cperl-after-block-p (point-min)))
5179 (insert ";"))
5181 (setq ret (point)))
5182 (if (cperl-indent-line parse-data)
5183 (setq ret (cperl-fix-line-spacing end parse-data)))
5184 (beginning-of-line)))))
5185 ret))
5187 (defvar cperl-update-start) ; Do not need to make them local
5188 (defvar cperl-update-end)
5189 (defun cperl-delay-update-hook (beg end old-len)
5190 (setq cperl-update-start (min beg (or cperl-update-start (point-max))))
5191 (setq cperl-update-end (max end (or cperl-update-end (point-min)))))
5193 (defun cperl-indent-region (start end)
5194 "Simple variant of indentation of region in CPerl mode.
5195 Should be slow. Will not indent comment if it starts at `comment-indent'
5196 or looks like continuation of the comment on the previous line.
5197 Indents all the lines whose first character is between START and END
5198 inclusive.
5200 If `cperl-indent-region-fix-constructs', will improve spacing on
5201 conditional/loop constructs."
5202 (interactive "r")
5203 (cperl-update-syntaxification end end)
5204 (save-excursion
5205 (let (cperl-update-start cperl-update-end (h-a-c after-change-functions))
5206 (let ((indent-info (if cperl-emacs-can-parse
5207 (list nil nil nil) ; Cannot use '(), since will modify
5208 nil))
5209 (pm 0)
5210 after-change-functions ; Speed it up!
5211 st comm old-comm-indent new-comm-indent p pp i empty)
5212 (if h-a-c (add-hook 'after-change-functions 'cperl-delay-update-hook))
5213 (goto-char start)
5214 (setq old-comm-indent (and (cperl-to-comment-or-eol)
5215 (current-column))
5216 new-comm-indent old-comm-indent)
5217 (goto-char start)
5218 (setq end (set-marker (make-marker) end)) ; indentation changes pos
5219 (or (bolp) (beginning-of-line 2))
5220 (while (and (<= (point) end) (not (eobp))) ; bol to check start
5221 (setq st (point))
5222 (if (or
5225 (or (eq (current-indentation) (or old-comm-indent
5226 comment-column))
5227 (setq old-comm-indent nil))))
5228 (if (and old-comm-indent
5229 (not empty)
5230 (= (current-indentation) old-comm-indent)
5231 (not (eq (get-text-property (point) 'syntax-type) 'pod))
5232 (not (eq (get-text-property (point) 'syntax-table)
5233 cperl-st-cfence)))
5234 (let ((comment-column new-comm-indent))
5235 (indent-for-comment)))
5236 (progn
5237 (setq i (cperl-indent-line indent-info))
5238 (or comm
5239 (not i)
5240 (progn
5241 (if cperl-indent-region-fix-constructs
5242 (goto-char (cperl-fix-line-spacing end indent-info)))
5243 (if (setq old-comm-indent
5244 (and (cperl-to-comment-or-eol)
5245 (not (memq (get-text-property (point)
5246 'syntax-type)
5247 '(pod here-doc)))
5248 (not (eq (get-text-property (point)
5249 'syntax-table)
5250 cperl-st-cfence))
5251 (current-column)))
5252 (progn (indent-for-comment)
5254 (skip-chars-backward "#")
5255 (setq new-comm-indent (current-column))))))))
5256 (beginning-of-line 2)))
5257 ;; Now run the update hooks
5258 (and after-change-functions
5259 cperl-update-end
5260 (save-excursion
5261 (goto-char cperl-update-end)
5262 (insert " ")
5263 (delete-char -1)
5264 (goto-char cperl-update-start)
5265 (insert " ")
5266 (delete-char -1))))))
5268 ;; Stolen from lisp-mode with a lot of improvements
5270 (defun cperl-fill-paragraph (&optional justify iteration)
5271 "Like `fill-paragraph', but handle CPerl comments.
5272 If any of the current line is a comment, fill the comment or the
5273 block of it that point is in, preserving the comment's initial
5274 indentation and initial hashes. Behaves usually outside of comment."
5275 ;; (interactive "P") ; Only works when called from fill-paragraph. -stef
5276 (let (;; Non-nil if the current line contains a comment.
5277 has-comment
5278 fill-paragraph-function ; do not recurse
5279 ;; If has-comment, the appropriate fill-prefix for the comment.
5280 comment-fill-prefix
5281 ;; Line that contains code and comment (or nil)
5282 start
5283 c spaces len dc (comment-column comment-column))
5284 ;; Figure out what kind of comment we are looking at.
5285 (save-excursion
5286 (beginning-of-line)
5287 (cond
5289 ;; A line with nothing but a comment on it?
5291 (setq has-comment t
5292 comment-fill-prefix (buffer-substring (match-beginning 0)
5293 (match-end 0))))
5295 ;; A line with some code, followed by a comment? Remember that the
5296 ;; semi which starts the comment shouldn't be part of a string or
5297 ;; character.
5298 ((cperl-to-comment-or-eol)
5299 (setq has-comment t)
5301 (setq start (point) c (current-column)
5302 comment-fill-prefix
5303 (concat (make-string (current-column) ?\s)
5304 (buffer-substring (match-beginning 0) (match-end 0)))
5306 (buffer-substring (point) start))
5307 dc (- c (current-column)) len (- start (point))
5308 start (point-marker))
5309 (delete-char len)
5310 (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???)
5311 (if (not has-comment)
5312 (fill-paragraph justify) ; Do the usual thing outside of comment
5313 ;; Narrow to include only the comment, and then fill the region.
5314 (save-restriction
5315 (narrow-to-region
5316 ;; Find the first line we should include in the region to fill.
5317 (if start (progn (beginning-of-line) (point))
5318 (save-excursion
5319 (while (and (zerop (forward-line -1))
5321 ;; We may have gone to far. Go forward again.
5323 (forward-line 1))
5324 (point)))
5325 ;; Find the beginning of the first line past the region to fill.
5326 (save-excursion
5327 (while (progn (forward-line 1)
5329 (point)))
5330 ;; Remove existing hashes
5331 (save-excursion
5332 (goto-char (point-min))
5333 (while (progn (forward-line 1) (< (point) (point-max)))
5335 (if (looking-at "#+")
5336 (progn
5337 (if (and (eq (point) (match-beginning 0))
5338 (not (eq (point) (match-end 0)))) nil
5339 (error
5340 "Bug in Emacs: `looking-at' in `narrow-to-region': match-data is garbage"))
5341 (delete-char (- (match-end 0) (match-beginning 0)))))))
5343 ;; Lines with only hashes on them can be paragraph boundaries.
5346 (fill-prefix comment-fill-prefix))
5347 (fill-paragraph justify)))
5348 (if (and start)
5349 (progn
5350 (goto-char start)
5351 (if (> dc 0)
5352 (progn (delete-char dc) (insert spaces)))
5353 (if (or (= (current-column) c) iteration) nil
5354 (setq comment-column c)
5355 (indent-for-comment)
5356 ;; Repeat once more, flagging as iteration
5357 (cperl-fill-paragraph justify t))))))
5358 t)
5360 (defun cperl-do-auto-fill ()
5361 ;; Break out if the line is short enough
5362 (if (> (save-excursion
5363 (end-of-line)
5364 (current-column))
5365 fill-column)
5366 (let ((c (save-excursion (beginning-of-line)
5367 (cperl-to-comment-or-eol) (point)))
5369 (if (>= c (point))
5370 ;; Don't break line inside code: only inside comment.
5371 nil
5372 (setq marker (point-marker))
5373 (fill-paragraph nil)
5374 (goto-char marker)
5375 ;; Is not enough, sometimes marker is a start of line
5377 (goto-char (match-end 0))))
5378 ;; Following space could have gone:
5380 (insert " ")
5381 (backward-char 1))
5382 ;; Previous space could have gone:
5385 (defun cperl-imenu-addback (lst &optional isback name)
5386 ;; We suppose that the lst is a DAG, unless the first element only
5387 ;; loops back, and ISBACK is set. Thus this function cannot be
5388 ;; applied twice without ISBACK set.
5389 (cond ((not cperl-imenu-addback) lst)
5390 (t
5391 (or name
5392 (setq name "+++BACK+++"))
5393 (mapc (lambda (elt)
5394 (if (and (listp elt) (listp (cdr elt)))
5395 (progn
5396 ;; In the other order it goes up
5397 ;; one level only ;-(
5398 (setcdr elt (cons (cons name lst)
5399 (cdr elt)))
5400 (cperl-imenu-addback (cdr elt) t name))))
5401 (if isback (cdr lst) lst))
5402 lst)))
5404 (defun cperl-imenu--create-perl-index (&optional regexp)
5405 (require 'imenu) ; May be called from TAGS creator
5406 (let ((index-alist '()) (index-pack-alist '()) (index-pod-alist '())
5407 (index-unsorted-alist '()) (i-s-f (default-value 'imenu-sort-function))
5408 (index-meth-alist '()) meth
5409 packages ends-ranges p marker is-proto
5410 (prev-pos 0) is-pack index index1 name (end-range 0) package)
5411 (goto-char (point-min))
5412 (cperl-update-syntaxification (point-max) (point-max))
5413 ;; Search for the function
5414 (progn ;;save-match-data
5415 (while (re-search-forward
5416 (or regexp cperl-imenu--function-name-regexp-perl)
5417 nil t)
5418 ;; 2=package-group, 5=package-name 8=sub-name
5419 (cond
5420 ((and ; Skip some noise if building tags
5421 (match-beginning 5) ; package name
5422 ;;(eq (char-after (match-beginning 2)) ?p) ; package
5423 (not (save-match-data
5425 nil)
5426 ((and
5427 (or (match-beginning 2)
5428 (match-beginning 8)) ; package or sub
5429 ;; Skip if quoted (will not skip multi-line ''-strings :-():
5430 (null (get-text-property (match-beginning 1) 'syntax-table))
5431 (null (get-text-property (match-beginning 1) 'syntax-type))
5432 (null (get-text-property (match-beginning 1) 'in-pod)))
5433 (setq is-pack (match-beginning 2))
5435 ;; (goto-char (match-end 0))) ; Messes what follows
5436 (setq meth nil
5437 p (point))
5438 (while (and ends-ranges (>= p (car ends-ranges)))
5439 ;; delete obsolete entries
5440 (setq ends-ranges (cdr ends-ranges) packages (cdr packages)))
5441 (setq package (or (car packages) "")
5442 end-range (or (car ends-ranges) 0))
5443 (if is-pack ; doing "package"
5444 (progn
5445 (if (match-beginning 5) ; named package
5446 (setq name (buffer-substring (match-beginning 5)
5447 (match-end 5))
5448 name (progn
5449 (set-text-properties 0 (length name) nil name)
5450 name)
5451 package (concat name "::")
5452 name (concat "package " name))
5453 ;; Support nameless packages
5454 (setq name "package;" package ""))
5455 (setq end-range
5456 (save-excursion
5457 (parse-partial-sexp (point) (point-max) -1) (point))
5458 ends-ranges (cons end-range ends-ranges)
5459 packages (cons package packages)))
5460 (setq is-proto
5461 (or (eq (following-char) ?\;)
5462 (eq 0 (get-text-property (point) 'attrib-group)))))
5463 ;; Skip this function name if it is a prototype declaration.
5464 (if (and is-proto (not is-pack)) nil
5465 (or is-pack
5466 (setq name
5467 (buffer-substring (match-beginning 8) (match-end 8)))
5468 (set-text-properties 0 (length name) nil name))
5469 (setq marker (make-marker))
5470 (set-marker marker (match-end (if is-pack 2 8)))
5471 (cond (is-pack nil)
5472 ((string-match "[:']" name)
5473 (setq meth t))
5474 ((> p end-range) nil)
5475 (t
5476 (setq name (concat package name) meth t)))
5477 (setq index (cons name marker))
5478 (if is-pack
5479 (push index index-pack-alist)
5480 (push index index-alist))
5481 (if meth (push index index-meth-alist))
5482 (push index index-unsorted-alist)))
5483 ((match-beginning 16) ; POD section
5484 (setq name (buffer-substring (match-beginning 17) (match-end 17))
5485 marker (make-marker))
5486 (set-marker marker (match-beginning 17))
5487 (set-text-properties 0 (length name) nil name)
5488 (setq name (concat (make-string
5489 (* 3 (- (char-after (match-beginning 16)) ?1))
5490 ?\ )
5491 name)
5492 index (cons name marker))
5493 (setq index1 (cons (concat "=" name) (cdr index)))
5494 (push index index-pod-alist)
5495 (push index1 index-unsorted-alist)))))
5496 (setq index-alist
5497 (if (default-value 'imenu-sort-function)
5498 (sort index-alist (default-value 'imenu-sort-function))
5499 (nreverse index-alist)))
5500 (and index-pod-alist
5501 (push (cons "+POD headers+..."
5502 (nreverse index-pod-alist))
5503 index-alist))
5504 (and (or index-pack-alist index-meth-alist)
5505 (let ((lst index-pack-alist) hier-list pack elt group name)
5506 ;; Remove "package ", reverse and uniquify.
5507 (while lst
5508 (setq elt (car lst) lst (cdr lst) name (substring (car elt) 8))
5509 (if (assoc name hier-list) nil
5510 (setq hier-list (cons (cons name (cdr elt)) hier-list))))
5511 (setq lst index-meth-alist)
5512 (while lst
5513 (setq elt (car lst) lst (cdr lst))
5515 (setq pack (substring (car elt) 0 (match-beginning 0)))
5516 (if (setq group (assoc pack hier-list))
5517 (if (listp (cdr group))
5518 ;; Have some functions already
5519 (setcdr group
5520 (cons (cons (substring
5521 (car elt)
5522 (+ 2 (match-beginning 0)))
5523 (cdr elt))
5524 (cdr group)))
5525 (setcdr group (list (cons (substring
5526 (car elt)
5527 (+ 2 (match-beginning 0)))
5528 (cdr elt)))))
5529 (setq hier-list
5530 (cons (cons pack
5531 (list (cons (substring
5532 (car elt)
5533 (+ 2 (match-beginning 0)))
5534 (cdr elt))))
5535 hier-list))))))
5536 (push (cons "+Hierarchy+..."
5537 hier-list)
5538 index-alist)))
5539 (and index-pack-alist
5540 (push (cons "+Packages+..."
5541 (nreverse index-pack-alist))
5542 index-alist))
5543 (and (or index-pack-alist index-pod-alist
5544 (default-value 'imenu-sort-function))
5545 index-unsorted-alist
5546 (push (cons "+Unsorted List+..."
5547 (nreverse index-unsorted-alist))
5548 index-alist))
5549 (cperl-imenu-addback index-alist)))
5551 \f
5552 ;; Suggested by Mark A. Hershberger
5553 (defun cperl-outline-level ()
5554 (looking-at outline-regexp)
5555 (cond ((not (match-beginning 1)) 0) ; beginning-of-file
5556 ;;;; 2=package-group, 5=package-name 8=sub-name 16=head-level
5557 ((match-beginning 2) 0) ; package
5558 ((match-beginning 8) 1) ; sub
5559 ((match-beginning 16)
5560 (- (char-after (match-beginning 16)) ?0)) ; headN ==> N
5561 (t 5))) ; should not happen
5563 \f
5564 (defun cperl-windowed-init ()
5565 "Initialization under windowed version."
5566 (cond ((featurep 'ps-print)
5567 (or cperl-faces-init
5568 (progn
5569 (and (boundp 'font-lock-multiline)
5570 (setq cperl-font-lock-multiline t))
5571 (cperl-init-faces))))
5572 ((not cperl-faces-init)
5573 (add-hook 'font-lock-mode-hook
5574 (function
5575 (lambda ()
5576 (if (memq major-mode '(perl-mode cperl-mode))
5577 (progn
5578 (or cperl-faces-init (cperl-init-faces)))))))
5579 (if (fboundp 'eval-after-load)
5580 (eval-after-load
5581 "ps-print"
5582 '(or cperl-faces-init (cperl-init-faces)))))))
5584 (defvar cperl-font-lock-keywords-1 nil
5585 "Additional expressions to highlight in Perl mode. Minimal set.")
5586 (defvar cperl-font-lock-keywords nil
5587 "Additional expressions to highlight in Perl mode. Default set.")
5588 (defvar cperl-font-lock-keywords-2 nil
5589 "Additional expressions to highlight in Perl mode. Maximal set")
5591 (defun cperl-load-font-lock-keywords ()
5592 (or cperl-faces-init (cperl-init-faces))
5593 cperl-font-lock-keywords)
5595 (defun cperl-load-font-lock-keywords-1 ()
5596 (or cperl-faces-init (cperl-init-faces))
5597 cperl-font-lock-keywords-1)
5599 (defun cperl-load-font-lock-keywords-2 ()
5600 (or cperl-faces-init (cperl-init-faces))
5601 cperl-font-lock-keywords-2)
5603 (defun cperl-init-faces-weak ()
5604 ;; Allow `cperl-find-pods-heres' to run.
5605 (or (boundp 'font-lock-constant-face)
5606 (cperl-force-face font-lock-constant-face
5607 "Face for constant and label names"))
5608 (or (boundp 'font-lock-warning-face)
5609 (cperl-force-face font-lock-warning-face
5610 "Face for things which should stand out"))
5611 ;;(setq font-lock-constant-face 'font-lock-constant-face)
5612 )
5614 (defun cperl-init-faces ()
5615 (condition-case errs
5616 (progn
5617 (require 'font-lock)
5618 (and (fboundp 'font-lock-fontify-anchored-keywords)
5619 (featurep 'font-lock-extra)
5620 (message "You have an obsolete package `font-lock-extra'. Install `choose-color'."))
5621 (let (t-font-lock-keywords t-font-lock-keywords-1 font-lock-anchored)
5622 (if (fboundp 'font-lock-fontify-anchored-keywords)
5623 (setq font-lock-anchored t))
5624 (setq
5625 t-font-lock-keywords
5626 (list
5628 (cons
5629 (concat
5631 (mapconcat
5632 'identity
5633 '("if" "until" "while" "elsif" "else" "unless" "for"
5634 "foreach" "continue" "exit" "die" "last" "goto" "next"
5635 "redo" "return" "local" "exec" "sub" "do" "dump" "use" "our"
5636 "require" "package" "eval" "my" "BEGIN" "END" "CHECK" "INIT")
5639 ; In what follows we use `type' style
5640 ; for overwritable builtins
5641 (list
5642 (concat
5644 ;; "CORE" "__FILE__" "__LINE__" "abs" "accept" "alarm"
5645 ;; "and" "atan2" "bind" "binmode" "bless" "caller"
5646 ;; "chdir" "chmod" "chown" "chr" "chroot" "close"
5647 ;; "closedir" "cmp" "connect" "continue" "cos" "crypt"
5648 ;; "dbmclose" "dbmopen" "die" "dump" "endgrent"
5649 ;; "endhostent" "endnetent" "endprotoent" "endpwent"
5650 ;; "endservent" "eof" "eq" "exec" "exit" "exp" "fcntl"
5651 ;; "fileno" "flock" "fork" "formline" "ge" "getc"
5652 ;; "getgrent" "getgrgid" "getgrnam" "gethostbyaddr"
5653 ;; "gethostbyname" "gethostent" "getlogin"
5654 ;; "getnetbyaddr" "getnetbyname" "getnetent"
5655 ;; "getpeername" "getpgrp" "getppid" "getpriority"
5656 ;; "getprotobyname" "getprotobynumber" "getprotoent"
5657 ;; "getpwent" "getpwnam" "getpwuid" "getservbyname"
5658 ;; "getservbyport" "getservent" "getsockname"
5659 ;; "getsockopt" "glob" "gmtime" "gt" "hex" "index" "int"
5660 ;; "ioctl" "join" "kill" "lc" "lcfirst" "le" "length"
5661 ;; "link" "listen" "localtime" "lock" "log" "lstat" "lt"
5662 ;; "mkdir" "msgctl" "msgget" "msgrcv" "msgsnd" "ne"
5663 ;; "not" "oct" "open" "opendir" "or" "ord" "pack" "pipe"
5664 ;; "quotemeta" "rand" "read" "readdir" "readline"
5665 ;; "readlink" "readpipe" "recv" "ref" "rename" "require"
5666 ;; "reset" "reverse" "rewinddir" "rindex" "rmdir" "seek"
5667 ;; "seekdir" "select" "semctl" "semget" "semop" "send"
5668 ;; "setgrent" "sethostent" "setnetent" "setpgrp"
5669 ;; "setpriority" "setprotoent" "setpwent" "setservent"
5670 ;; "setsockopt" "shmctl" "shmget" "shmread" "shmwrite"
5671 ;; "shutdown" "sin" "sleep" "socket" "socketpair"
5672 ;; "sprintf" "sqrt" "srand" "stat" "substr" "symlink"
5673 ;; "syscall" "sysopen" "sysread" "system" "syswrite" "tell"
5674 ;; "telldir" "time" "times" "truncate" "uc" "ucfirst"
5675 ;; "umask" "unlink" "unpack" "utime" "values" "vec"
5676 ;; "wait" "waitpid" "wantarray" "warn" "write" "x" "xor"
5709 ;; In what follows we use `other' style
5710 ;; for nonoverwritable builtins
5711 ;; Somehow 's', 'm' are not auto-generated???
5712 (list
5713 (concat
5715 ;; "AUTOLOAD" "BEGIN" "CHECK" "DESTROY" "END" "INIT" "__END__" "chomp"
5716 ;; "chop" "defined" "delete" "do" "each" "else" "elsif"
5717 ;; "eval" "exists" "for" "foreach" "format" "goto"
5718 ;; "grep" "if" "keys" "last" "local" "map" "my" "next"
5719 ;; "no" "our" "package" "pop" "pos" "print" "printf" "push"
5720 ;; "q" "qq" "qw" "qx" "redo" "return" "scalar" "shift"
5721 ;; "sort" "splice" "split" "study" "sub" "tie" "tr"
5722 ;; "undef" "unless" "unshift" "untie" "until" "use"
5723 ;; "while" "y"
5735 ;; (mapconcat 'identity
5736 ;; '("#endif" "#else" "#ifdef" "#ifndef" "#if"
5737 ;; "#include" "#define" "#undef")
5740 font-lock-function-name-face keep) ; Not very good, triggers at "[a-z]"
5741 ;; This highlights declarations and definitions differenty.
5742 ;; We do not try to highlight in the case of attributes:
5743 ;; it is already done by `cperl-find-pods-heres'
5745 cperl-white-and-comment-rex ; whitespace/comments
5748 cperl-maybe-white-and-comment-rex ;whitespace/comments?
5750 cperl-maybe-white-and-comment-rex ; whitespace/comments?
5751 "[{;]")
5752 2 (if cperl-font-lock-multiline
5753 '(if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5754 'font-lock-function-name-face
5755 'font-lock-variable-name-face)
5756 ;; need to manually set 'multiline' for older font-locks
5757 '(progn
5758 (if (< 1 (count-lines (match-beginning 0)
5759 (match-end 0)))
5760 (put-text-property
5761 (+ 3 (match-beginning 0)) (match-end 0)
5762 'syntax-type 'multiline))
5763 (if (eq (char-after (cperl-1- (match-end 0))) ?\{ )
5764 'font-lock-function-name-face
5765 'font-lock-variable-name-face))))
5766 '("\\<\\(package\\|require\\|use\\|import\\|no\\|bootstrap\\)[ \t]+\\([a-zA-z_][a-zA-z_0-9:]*\\)[ \t;]" ; require A if B;
5767 2 font-lock-function-name-face)
5769 1 font-lock-function-name-face)
5770 (cond ((featurep 'font-lock-extra)
5772 (2 font-lock-string-face t)
5773 (0 '(restart 2 t)))) ; To highlight $a{bc}{ef}
5774 (font-lock-anchored
5776 (2 font-lock-string-face t)
5778 nil nil
5779 (1 font-lock-string-face t))))
5781 2 font-lock-string-face t)))
5783 font-lock-string-face t)
5784 '("^[ \t]*\\([a-zA-Z0-9_]+[ \t]*:\\)[ \t]*\\($\\|{\\|\\<\\(until\\|while\\|for\\(each\\)?\\|do\\)\\>\\)" 1
5785 font-lock-constant-face) ; labels
5786 '("\\<\\(continue\\|next\\|last\\|redo\\|goto\\)\\>[ \t]+\\([a-zA-Z0-9_:]+\\)" ; labels as targets
5787 2 font-lock-constant-face)
5788 ;; Uncomment to get perl-mode-like vars
5791 ;;; (2 (cons font-lock-variable-name-face '(underline))))
5792 (cond ((featurep 'font-lock-extra)
5794 (3 font-lock-variable-name-face)
5795 (4 '(another 4 nil
5797 (1 font-lock-variable-name-face)
5798 (2 '(restart 2 nil) nil t)))
5799 nil t))) ; local variables, multiple
5800 (font-lock-anchored
5801 ;; 1=my_etc, 2=white? 3=(+white? 4=white? 5=var
5803 cperl-maybe-white-and-comment-rex
5805 cperl-maybe-white-and-comment-rex
5807 (5 ,(if cperl-font-lock-multiline
5808 'font-lock-variable-name-face
5809 '(progn (setq cperl-font-lock-multiline-start
5810 (match-beginning 0))
5811 'font-lock-variable-name-face)))
5813 cperl-maybe-white-and-comment-rex
5814 ","
5815 cperl-maybe-white-and-comment-rex
5817 ;; Bug in font-lock: limit is used not only to limit
5818 ;; searches, but to set the "extend window for
5819 ;; facification" property. Thus we need to minimize.
5820 ,(if cperl-font-lock-multiline
5821 '(if (match-beginning 3)
5822 (save-excursion
5823 (goto-char (match-beginning 3))
5824 (condition-case nil
5825 (forward-sexp 1)
5826 (error
5827 (condition-case nil
5828 (forward-char 200)
5829 (error nil)))) ; typeahead
5830 (1- (point))) ; report limit
5831 (forward-char -2)) ; disable continued expr
5832 '(if (match-beginning 3)
5833 (point-max) ; No limit for continuation
5834 (forward-char -2))) ; disable continued expr
5835 ,(if cperl-font-lock-multiline
5836 nil
5837 '(progn ; Do at end
5838 ;; "my" may be already fontified (POD),
5839 ;; so cperl-font-lock-multiline-start is nil
5840 (if (or (not cperl-font-lock-multiline-start)
5841 (> 2 (count-lines
5842 cperl-font-lock-multiline-start
5843 (point))))
5844 nil
5845 (put-text-property
5846 (1+ cperl-font-lock-multiline-start) (point)
5847 'syntax-type 'multiline))
5848 (setq cperl-font-lock-multiline-start nil)))
5849 (3 font-lock-variable-name-face))))
5851 3 font-lock-variable-name-face)))
5852 '("\\<for\\(each\\)?\\([ \t]+\\(my\\|local\\|our\\)\\)?[ \t]*\\(\\$[a-zA-Z_][a-zA-Z_0-9]*\\)[ \t]*("
5853 4 font-lock-variable-name-face)
5854 ;; Avoid $!, and s!!, qq!! etc. when not fontifying syntaxically
5857 (setq
5858 t-font-lock-keywords-1
5859 (and (fboundp 'turn-on-font-lock) ; Check for newer font-lock
5860 ;; not yet as of XEmacs 19.12, works with 21.1.11
5861 (or
5862 (not (featurep 'xemacs))
5863 (string< "21.1.9" emacs-version)
5864 (and (string< "21.1.10" emacs-version)
5865 (string< emacs-version "21.1.2")))
5866 '(
5868 (if (eq (char-after (match-beginning 2)) ?%)
5869 'cperl-hash-face
5870 'cperl-array-face)
5871 t) ; arrays and hashes
5873 1
5874 (if (= (- (match-end 2) (match-beginning 2)) 1)
5875 (if (eq (char-after (match-beginning 3)) ?{)
5876 'cperl-hash-face
5877 'cperl-array-face) ; arrays and hashes
5878 font-lock-variable-name-face) ; Just to put something
5879 t)
5881 (1 cperl-array-face)
5882 (2 font-lock-variable-name-face))
5884 (1 cperl-hash-face)
5885 (2 font-lock-variable-name-face))
5887 ;;; Too much noise from \s* @s[ and friends
5889 ;;(3 font-lock-function-name-face t t)
5890 ;;(4
5891 ;; (if (cperl-slash-is-regexp)
5892 ;; font-lock-function-name-face 'default) nil t))
5893 )))
5894 (if cperl-highlight-variables-indiscriminately
5895 (setq t-font-lock-keywords-1
5896 (append t-font-lock-keywords-1
5898 font-lock-variable-name-face)))))
5899 (setq cperl-font-lock-keywords-1
5900 (if cperl-syntaxify-by-font-lock
5901 (cons 'cperl-fontify-update
5902 t-font-lock-keywords)
5903 t-font-lock-keywords)
5904 cperl-font-lock-keywords cperl-font-lock-keywords-1
5905 cperl-font-lock-keywords-2 (append
5906 cperl-font-lock-keywords-1
5907 t-font-lock-keywords-1)))
5908 (if (fboundp 'ps-print-buffer) (cperl-ps-print-init))
5909 (if (or (featurep 'choose-color) (featurep 'font-lock-extra))
5910 (eval ; Avoid a warning
5911 '(font-lock-require-faces
5912 (list
5913 ;; Color-light Color-dark Gray-light Gray-dark Mono
5914 (list 'font-lock-comment-face
5915 ["Firebrick" "OrangeRed" "DimGray" "Gray80"]
5916 nil
5917 [nil nil t t t]
5918 [nil nil t t t]
5919 nil)
5920 (list 'font-lock-string-face
5921 ["RosyBrown" "LightSalmon" "Gray50" "LightGray"]
5922 nil
5923 nil
5924 [nil nil t t t]
5925 nil)
5926 (list 'font-lock-function-name-face
5927 (vector
5928 "Blue" "LightSkyBlue" "Gray50" "LightGray"
5929 (cdr (assq 'background-color ; if mono
5930 (frame-parameters))))
5931 (vector
5932 nil nil nil nil
5933 (cdr (assq 'foreground-color ; if mono
5934 (frame-parameters))))
5935 [nil nil t t t]
5936 nil
5937 nil)
5938 (list 'font-lock-variable-name-face
5939 ["DarkGoldenrod" "LightGoldenrod" "DimGray" "Gray90"]
5940 nil
5941 [nil nil t t t]
5942 [nil nil t t t]
5943 nil)
5944 (list 'font-lock-type-face
5945 ["DarkOliveGreen" "PaleGreen" "DimGray" "Gray80"]
5946 nil
5947 [nil nil t t t]
5948 nil
5949 [nil nil t t t])
5950 (list 'font-lock-warning-face
5951 ["Pink" "Red" "Gray50" "LightGray"]
5952 ["gray20" "gray90"
5953 "gray80" "gray20"]
5954 [nil nil t t t]
5955 nil
5956 [nil nil t t t]
5957 )
5958 (list 'font-lock-constant-face
5959 ["CadetBlue" "Aquamarine" "Gray50" "LightGray"]
5960 nil
5961 [nil nil t t t]
5962 nil
5963 [nil nil t t t])
5964 (list 'cperl-nonoverridable-face
5965 ["chartreuse3" ("orchid1" "orange")
5966 nil "Gray80"]
5967 [nil nil "gray90"]
5968 [nil nil nil t t]
5969 [nil nil t t]
5970 [nil nil t t t])
5971 (list 'cperl-array-face
5972 ["blue" "yellow" nil "Gray80"]
5973 ["lightyellow2" ("navy" "os2blue" "darkgreen")
5974 "gray90"]
5975 t
5976 nil
5977 nil)
5978 (list 'cperl-hash-face
5979 ["red" "red" nil "Gray80"]
5980 ["lightyellow2" ("navy" "os2blue" "darkgreen")
5981 "gray90"]
5982 t
5983 t
5984 nil))))
5985 ;; Do it the dull way, without choose-color
5986 (defvar cperl-guessed-background nil
5987 "Display characteristics as guessed by cperl.")
5988 ;; (or (fboundp 'x-color-defined-p)
5989 ;; (defalias 'x-color-defined-p
5990 ;; (cond ((fboundp 'color-defined-p) 'color-defined-p)
5991 ;; ;; XEmacs >= 19.12
5992 ;; ((fboundp 'valid-color-name-p) 'valid-color-name-p)
5993 ;; ;; XEmacs 19.11
5994 ;; (t 'x-valid-color-name-p))))
5995 (cperl-force-face font-lock-constant-face
5996 "Face for constant and label names")
5997 (cperl-force-face font-lock-variable-name-face
5998 "Face for variable names")
5999 (cperl-force-face font-lock-type-face
6000 "Face for data types")
6001 (cperl-force-face cperl-nonoverridable-face
6002 "Face for data types from another group")
6003 (cperl-force-face font-lock-warning-face
6004 "Face for things which should stand out")
6005 (cperl-force-face font-lock-comment-face
6006 "Face for comments")
6007 (cperl-force-face font-lock-function-name-face
6008 "Face for function names")
6009 (cperl-force-face cperl-hash-face
6010 "Face for hashes")
6011 (cperl-force-face cperl-array-face
6012 "Face for arrays")
6013 ;;(defvar font-lock-constant-face 'font-lock-constant-face)
6014 ;;(defvar font-lock-variable-name-face 'font-lock-variable-name-face)
6015 ;;(or (boundp 'font-lock-type-face)
6016 ;; (defconst font-lock-type-face
6017 ;; 'font-lock-type-face
6018 ;; "Face to use for data types."))
6019 ;;(or (boundp 'cperl-nonoverridable-face)
6020 ;; (defconst cperl-nonoverridable-face
6021 ;; 'cperl-nonoverridable-face
6022 ;; "Face to use for data types from another group."))
6023 ;;(if (not (featurep 'xemacs)) nil
6024 ;; (or (boundp 'font-lock-comment-face)
6025 ;; (defconst font-lock-comment-face
6026 ;; 'font-lock-comment-face
6027 ;; "Face to use for comments."))
6028 ;; (or (boundp 'font-lock-keyword-face)
6029 ;; (defconst font-lock-keyword-face
6030 ;; 'font-lock-keyword-face
6031 ;; "Face to use for keywords."))
6032 ;; (or (boundp 'font-lock-function-name-face)
6033 ;; (defconst font-lock-function-name-face
6034 ;; 'font-lock-function-name-face
6035 ;; "Face to use for function names.")))
6036 (if (and
6037 (not (cperl-is-face 'cperl-array-face))
6038 (cperl-is-face 'font-lock-emphasized-face))
6039 (copy-face 'font-lock-emphasized-face 'cperl-array-face))
6040 (if (and
6041 (not (cperl-is-face 'cperl-hash-face))
6042 (cperl-is-face 'font-lock-other-emphasized-face))
6043 (copy-face 'font-lock-other-emphasized-face 'cperl-hash-face))
6044 (if (and
6045 (not (cperl-is-face 'cperl-nonoverridable-face))
6046 (cperl-is-face 'font-lock-other-type-face))
6047 (copy-face 'font-lock-other-type-face 'cperl-nonoverridable-face))
6048 ;;(or (boundp 'cperl-hash-face)
6049 ;; (defconst cperl-hash-face
6050 ;; 'cperl-hash-face
6051 ;; "Face to use for hashes."))
6052 ;;(or (boundp 'cperl-array-face)
6053 ;; (defconst cperl-array-face
6054 ;; 'cperl-array-face
6055 ;; "Face to use for arrays."))
6056 ;; Here we try to guess background
6057 (let ((background
6058 (if (boundp 'font-lock-background-mode)
6059 font-lock-background-mode
6060 'light))
6061 (face-list (and (fboundp 'face-list) (face-list))))
6062 ;;;; (fset 'cperl-is-face
6063 ;;;; (cond ((fboundp 'find-face)
6064 ;;;; (symbol-function 'find-face))
6065 ;;;; (face-list
6066 ;;;; (function (lambda (face) (member face face-list))))
6067 ;;;; (t
6068 ;;;; (function (lambda (face) (boundp face))))))
6069 (defvar cperl-guessed-background
6070 (if (and (boundp 'font-lock-display-type)
6071 (eq font-lock-display-type 'grayscale))
6072 'gray
6073 background)
6074 "Background as guessed by CPerl mode")
6075 (and (not (cperl-is-face 'font-lock-constant-face))
6076 (cperl-is-face 'font-lock-reference-face)
6077 (copy-face 'font-lock-reference-face 'font-lock-constant-face))
6078 (if (cperl-is-face 'font-lock-type-face) nil
6079 (copy-face 'default 'font-lock-type-face)
6080 (cond
6081 ((eq background 'light)
6082 (set-face-foreground 'font-lock-type-face
6083 (if (x-color-defined-p "seagreen")
6084 "seagreen"
6085 "sea green")))
6086 ((eq background 'dark)
6087 (set-face-foreground 'font-lock-type-face
6088 (if (x-color-defined-p "os2pink")
6089 "os2pink"
6090 "pink")))
6091 (t
6092 (set-face-background 'font-lock-type-face "gray90"))))
6093 (if (cperl-is-face 'cperl-nonoverridable-face)
6094 nil
6095 (copy-face 'font-lock-type-face 'cperl-nonoverridable-face)
6096 (cond
6097 ((eq background 'light)
6098 (set-face-foreground 'cperl-nonoverridable-face
6099 (if (x-color-defined-p "chartreuse3")
6100 "chartreuse3"
6101 "chartreuse")))
6102 ((eq background 'dark)
6103 (set-face-foreground 'cperl-nonoverridable-face
6104 (if (x-color-defined-p "orchid1")
6105 "orchid1"
6106 "orange")))))
6107 ;;; (if (cperl-is-face 'font-lock-other-emphasized-face) nil
6108 ;;; (copy-face 'bold-italic 'font-lock-other-emphasized-face)
6109 ;;; (cond
6110 ;;; ((eq background 'light)
6111 ;;; (set-face-background 'font-lock-other-emphasized-face
6112 ;;; (if (x-color-defined-p "lightyellow2")
6113 ;;; "lightyellow2"
6114 ;;; (if (x-color-defined-p "lightyellow")
6115 ;;; "lightyellow"
6116 ;;; "light yellow"))))
6117 ;;; ((eq background 'dark)
6118 ;;; (set-face-background 'font-lock-other-emphasized-face
6119 ;;; (if (x-color-defined-p "navy")
6120 ;;; "navy"
6121 ;;; (if (x-color-defined-p "darkgreen")
6122 ;;; "darkgreen"
6123 ;;; "dark green"))))
6124 ;;; (t (set-face-background 'font-lock-other-emphasized-face "gray90"))))
6125 ;;; (if (cperl-is-face 'font-lock-emphasized-face) nil
6126 ;;; (copy-face 'bold 'font-lock-emphasized-face)
6127 ;;; (cond
6128 ;;; ((eq background 'light)
6129 ;;; (set-face-background 'font-lock-emphasized-face
6130 ;;; (if (x-color-defined-p "lightyellow2")
6131 ;;; "lightyellow2"
6132 ;;; "lightyellow")))
6133 ;;; ((eq background 'dark)
6134 ;;; (set-face-background 'font-lock-emphasized-face
6135 ;;; (if (x-color-defined-p "navy")
6136 ;;; "navy"
6137 ;;; (if (x-color-defined-p "darkgreen")
6138 ;;; "darkgreen"
6139 ;;; "dark green"))))
6140 ;;; (t (set-face-background 'font-lock-emphasized-face "gray90"))))
6141 (if (cperl-is-face 'font-lock-variable-name-face) nil
6142 (copy-face 'italic 'font-lock-variable-name-face))
6143 (if (cperl-is-face 'font-lock-constant-face) nil
6144 (copy-face 'italic 'font-lock-constant-face))))
6145 (setq cperl-faces-init t))
6146 (error (message "cperl-init-faces (ignored): %s" errs))))
6149 (defun cperl-ps-print-init ()
6150 "Initialization of `ps-print' components for faces used in CPerl."
6151 (eval-after-load "ps-print"
6152 '(setq ps-bold-faces
6153 ;; font-lock-variable-name-face
6154 ;; font-lock-constant-face
6155 (append '(cperl-array-face cperl-hash-face)
6156 ps-bold-faces)
6157 ps-italic-faces
6158 ;; font-lock-constant-face
6159 (append '(cperl-nonoverridable-face cperl-hash-face)
6160 ps-italic-faces)
6161 ps-underlined-faces
6162 ;; font-lock-type-face
6163 (append '(cperl-array-face cperl-hash-face underline cperl-nonoverridable-face)
6164 ps-underlined-faces))))
6166 (defvar ps-print-face-extension-alist)
6168 (defun cperl-ps-print (&optional file)
6169 "Pretty-print in CPerl style.
6170 If optional argument FILE is an empty string, prints to printer, otherwise
6171 to the file FILE. If FILE is nil, prompts for a file name.
6173 Style of printout regulated by the variable `cperl-ps-print-face-properties'."
6174 (interactive)
6175 (or file
6176 (setq file (read-from-minibuffer
6177 "Print to file (if empty - to printer): "
6178 (concat (buffer-file-name) ".ps")
6179 nil nil 'file-name-history)))
6180 (or (> (length file) 0)
6181 (setq file nil))
6182 (require 'ps-print) ; To get ps-print-face-extension-alist
6183 (let ((ps-print-color-p t)
6184 (ps-print-face-extension-alist ps-print-face-extension-alist))
6185 (cperl-ps-extend-face-list cperl-ps-print-face-properties)
6186 (ps-print-buffer-with-faces file)))
6188 ;;; (defun cperl-ps-print-init ()
6189 ;;; "Initialization of `ps-print' components for faces used in CPerl."
6190 ;;; ;; Guard against old versions
6191 ;;; (defvar ps-underlined-faces nil)
6192 ;;; (defvar ps-bold-faces nil)
6193 ;;; (defvar ps-italic-faces nil)
6194 ;;; (setq ps-bold-faces
6195 ;;; (append '(font-lock-emphasized-face
6196 ;;; cperl-array-face
6197 ;;; font-lock-keyword-face
6198 ;;; font-lock-variable-name-face
6199 ;;; font-lock-constant-face
6200 ;;; font-lock-reference-face
6201 ;;; font-lock-other-emphasized-face
6202 ;;; cperl-hash-face)
6203 ;;; ps-bold-faces))
6204 ;;; (setq ps-italic-faces
6205 ;;; (append '(cperl-nonoverridable-face
6206 ;;; font-lock-constant-face
6207 ;;; font-lock-reference-face
6208 ;;; font-lock-other-emphasized-face
6209 ;;; cperl-hash-face)
6210 ;;; ps-italic-faces))
6211 ;;; (setq ps-underlined-faces
6212 ;;; (append '(font-lock-emphasized-face
6213 ;;; cperl-array-face
6214 ;;; font-lock-other-emphasized-face
6215 ;;; cperl-hash-face
6216 ;;; cperl-nonoverridable-face font-lock-type-face)
6217 ;;; ps-underlined-faces))
6218 ;;; (cons 'font-lock-type-face ps-underlined-faces))
6221 (if (cperl-enable-font-lock) (cperl-windowed-init))
6223 (defconst cperl-styles-entries
6224 '(cperl-indent-level cperl-brace-offset cperl-continued-brace-offset
6225 cperl-label-offset cperl-extra-newline-before-brace
6226 cperl-extra-newline-before-brace-multiline
6227 cperl-merge-trailing-else
6228 cperl-continued-statement-offset))
6230 (defconst cperl-style-examples
6231 "##### Numbers etc are: cperl-indent-level cperl-brace-offset
6232 ##### cperl-continued-brace-offset cperl-label-offset
6233 ##### cperl-continued-statement-offset
6234 ##### cperl-merge-trailing-else cperl-extra-newline-before-brace
6236 ########### (Do not forget cperl-extra-newline-before-brace-multiline)
6238 ### CPerl (=GNU - extra-newline-before-brace + merge-trailing-else) 2/0/0/-2/2/t/nil
6239 if (foo) {
6240 bar
6241 baz;
6242 label:
6243 {
6244 boon;
6245 }
6246 } else {
6247 stop;
6248 }
6250 ### PerlStyle (=CPerl with 4 as indent) 4/0/0/-4/4/t/nil
6251 if (foo) {
6252 bar
6253 baz;
6254 label:
6255 {
6256 boon;
6257 }
6258 } else {
6259 stop;
6260 }
6262 ### GNU 2/0/0/-2/2/nil/t
6263 if (foo)
6264 {
6265 bar
6266 baz;
6267 label:
6268 {
6269 boon;
6270 }
6271 }
6272 else
6273 {
6274 stop;
6275 }
6277 ### C++ (=PerlStyle with braces aligned with control words) 4/0/-4/-4/4/nil/t
6278 if (foo)
6279 {
6280 bar
6281 baz;
6282 label:
6283 {
6284 boon;
6285 }
6286 }
6287 else
6288 {
6289 stop;
6290 }
6292 ### BSD (=C++, but will not change preexisting merge-trailing-else
6293 ### and extra-newline-before-brace ) 4/0/-4/-4/4
6294 if (foo)
6295 {
6296 bar
6297 baz;
6298 label:
6299 {
6300 boon;
6301 }
6302 }
6303 else
6304 {
6305 stop;
6306 }
6308 ### K&R (=C++ with indent 5 - merge-trailing-else, but will not
6309 ### change preexisting extra-newline-before-brace) 5/0/-5/-5/5/nil
6310 if (foo)
6311 {
6312 bar
6313 baz;
6314 label:
6315 {
6316 boon;
6317 }
6318 }
6319 else
6320 {
6321 stop;
6322 }
6324 ### Whitesmith (=PerlStyle, but will not change preexisting
6325 ### extra-newline-before-brace and merge-trailing-else) 4/0/0/-4/4
6326 if (foo)
6327 {
6328 bar
6329 baz;
6330 label:
6331 {
6332 boon;
6333 }
6334 }
6335 else
6336 {
6337 stop;
6338 }
6339 "
6340 "Examples of if/else with different indent styles (with v4.23).")
6342 (defconst cperl-style-alist
6343 '(("CPerl" ;; =GNU - extra-newline-before-brace + cperl-merge-trailing-else
6344 (cperl-indent-level . 2)
6345 (cperl-brace-offset . 0)
6346 (cperl-continued-brace-offset . 0)
6347 (cperl-label-offset . -2)
6348 (cperl-continued-statement-offset . 2)
6349 (cperl-extra-newline-before-brace . nil)
6350 (cperl-extra-newline-before-brace-multiline . nil)
6351 (cperl-merge-trailing-else . t))
6353 ("PerlStyle" ; CPerl with 4 as indent
6354 (cperl-indent-level . 4)
6355 (cperl-brace-offset . 0)
6356 (cperl-continued-brace-offset . 0)
6357 (cperl-label-offset . -4)
6358 (cperl-continued-statement-offset . 4)
6359 (cperl-extra-newline-before-brace . nil)
6360 (cperl-extra-newline-before-brace-multiline . nil)
6361 (cperl-merge-trailing-else . t))
6363 ("GNU"
6364 (cperl-indent-level . 2)
6365 (cperl-brace-offset . 0)
6366 (cperl-continued-brace-offset . 0)
6367 (cperl-label-offset . -2)
6368 (cperl-continued-statement-offset . 2)
6369 (cperl-extra-newline-before-brace . t)
6370 (cperl-extra-newline-before-brace-multiline . t)
6371 (cperl-merge-trailing-else . nil))
6373 ("K&R"
6374 (cperl-indent-level . 5)
6375 (cperl-brace-offset . 0)
6376 (cperl-continued-brace-offset . -5)
6377 (cperl-label-offset . -5)
6378 (cperl-continued-statement-offset . 5)
6379 ;;(cperl-extra-newline-before-brace . nil) ; ???
6380 ;;(cperl-extra-newline-before-brace-multiline . nil)
6381 (cperl-merge-trailing-else . nil))
6383 ("BSD"
6384 (cperl-indent-level . 4)
6385 (cperl-brace-offset . 0)
6386 (cperl-continued-brace-offset . -4)
6387 (cperl-label-offset . -4)
6388 (cperl-continued-statement-offset . 4)
6389 ;;(cperl-extra-newline-before-brace . nil) ; ???
6390 ;;(cperl-extra-newline-before-brace-multiline . nil)
6391 ;;(cperl-merge-trailing-else . nil) ; ???
6392 )
6394 ("C++"
6395 (cperl-indent-level . 4)
6396 (cperl-brace-offset . 0)
6397 (cperl-continued-brace-offset . -4)
6398 (cperl-label-offset . -4)
6399 (cperl-continued-statement-offset . 4)
6400 (cperl-extra-newline-before-brace . t)
6401 (cperl-extra-newline-before-brace-multiline . t)
6402 (cperl-merge-trailing-else . nil))
6404 ("Whitesmith"
6405 (cperl-indent-level . 4)
6406 (cperl-brace-offset . 0)
6407 (cperl-continued-brace-offset . 0)
6408 (cperl-label-offset . -4)
6409 (cperl-continued-statement-offset . 4)
6410 ;;(cperl-extra-newline-before-brace . nil) ; ???
6411 ;;(cperl-extra-newline-before-brace-multiline . nil)
6412 ;;(cperl-merge-trailing-else . nil) ; ???
6413 )
6414 ("Current"))
6415 "List of variables to set to get a particular indentation style.
6416 Should be used via `cperl-set-style' or via Perl menu.
6418 See examples in `cperl-style-examples'.")
6420 (defun cperl-set-style (style)
6421 "Set CPerl mode variables to use one of several different indentation styles.
6422 The arguments are a string representing the desired style.
6423 The list of styles is in `cperl-style-alist', available styles
6424 are CPerl, PerlStyle, GNU, K&R, BSD, C++ and Whitesmith.
6426 The current value of style is memorized (unless there is a memorized
6427 data already), may be restored by `cperl-set-style-back'.
6430 side-effect of memorizing only. Examples in `cperl-style-examples'."
6431 (interactive
6432 (let ((list (mapcar (function (lambda (elt) (list (car elt))))
6433 cperl-style-alist)))
6434 (list (completing-read "Enter style: " list nil 'insist))))
6435 (or cperl-old-style
6436 (setq cperl-old-style
6437 (mapcar (function
6438 (lambda (name)
6439 (cons name (eval name))))
6440 cperl-styles-entries)))
6441 (let ((style (cdr (assoc style cperl-style-alist))) setting str sym)
6442 (while style
6443 (setq setting (car style) style (cdr style))
6444 (set (car setting) (cdr setting)))))
6446 (defun cperl-set-style-back ()
6447 "Restore a style memorized by `cperl-set-style'."
6448 (interactive)
6449 (or cperl-old-style (error "The style was not changed"))
6450 (let (setting)
6451 (while cperl-old-style
6452 (setq setting (car cperl-old-style)
6453 cperl-old-style (cdr cperl-old-style))
6454 (set (car setting) (cdr setting)))))
6456 (defun cperl-check-syntax ()
6457 (interactive)
6458 (require 'mode-compile)
6459 (let ((perl-dbg-flags (concat cperl-extra-perl-args " -wc")))
6460 (eval '(mode-compile)))) ; Avoid a warning
6462 (defun cperl-info-buffer (type)
6463 ;; Returns buffer with documentation. Creates if missing.
6464 ;; If TYPE, this vars buffer.
6465 ;; Special care is taken to not stomp over an existing info buffer
6466 (let* ((bname (if type "*info-perl-var*" "*info-perl*"))
6467 (info (get-buffer bname))
6468 (oldbuf (get-buffer "*info*")))
6469 (if info info
6470 (save-window-excursion
6471 ;; Get Info running
6472 (require 'info)
6473 (cond (oldbuf
6474 (set-buffer oldbuf)
6475 (rename-buffer "*info-perl-tmp*")))
6476 (save-window-excursion
6477 (info))
6478 (Info-find-node cperl-info-page (if type "perlvar" "perlfunc"))
6479 (set-buffer "*info*")
6480 (rename-buffer bname)
6481 (cond (oldbuf
6482 (set-buffer "*info-perl-tmp*")
6483 (rename-buffer "*info*")
6484 (set-buffer bname)))
6485 (make-local-variable 'window-min-height)
6486 (setq window-min-height 2)
6487 (current-buffer)))))
6489 (defun cperl-word-at-point (&optional p)
6490 "Return the word at point or at P."
6491 (save-excursion
6492 (if p (goto-char p))
6493 (or (cperl-word-at-point-hard)
6494 (progn
6495 (require 'etags)
6496 (funcall (or (and (boundp 'find-tag-default-function)
6497 find-tag-default-function)
6498 (get major-mode 'find-tag-default-function)
6499 ;; XEmacs 19.12 has `find-tag-default-hook'; it is
6500 ;; automatically used within `find-tag-default':
6501 'find-tag-default))))))
6503 (defun cperl-info-on-command (command)
6504 "Show documentation for Perl command COMMAND in other window.
6505 If perl-info buffer is shown in some frame, uses this frame.
6506 Customized by setting variables `cperl-shrink-wrap-info-frame',
6507 `cperl-max-help-size'."
6508 (interactive
6509 (let* ((default (cperl-word-at-point))
6510 (read (read-string
6511 (format "Find doc for Perl function (default %s): "
6512 default))))
6513 (list (if (equal read "")
6514 default
6515 read))))
6517 (let ((buffer (current-buffer))
6518 (cmd-desc (concat "^" (regexp-quote command) "[^a-zA-Z_0-9]")) ; "tr///"
6519 pos isvar height iniheight frheight buf win fr1 fr2 iniwin not-loner
6520 max-height char-height buf-list)
6521 (if (string-match "^-[a-zA-Z]$" command)
6523 (setq isvar (string-match "^[$@%]" command)
6524 buf (cperl-info-buffer isvar)
6525 iniwin (selected-window)
6526 fr1 (window-frame iniwin))
6527 (set-buffer buf)
6528 (goto-char (point-min))
6529 (or isvar
6531 (forward-line -1)))
6532 (if (re-search-forward cmd-desc nil t)
6533 (progn
6534 ;; Go back to beginning of the group (ex, for qq)
6536 (forward-line 1))
6537 (beginning-of-line)
6538 ;; Get some of
6539 (setq pos (point)
6540 buf-list (list buf "*info-perl-var*" "*info-perl*"))
6541 (while (and (not win) buf-list)
6542 (setq win (get-buffer-window (car buf-list) t))
6543 (setq buf-list (cdr buf-list)))
6544 (or (not win)
6545 (eq (window-buffer win) buf)
6546 (set-window-buffer win buf))
6547 (and win (setq fr2 (window-frame win)))
6548 (if (or (not fr2) (eq fr1 fr2))
6549 (pop-to-buffer buf)
6550 (special-display-popup-frame buf) ; Make it visible
6551 (select-window win))
6552 (goto-char pos) ; Needed (?!).
6553 ;; Resize
6554 (setq iniheight (window-height)
6555 frheight (frame-height)
6556 not-loner (< iniheight (1- frheight))) ; Are not alone
6557 (cond ((if not-loner cperl-max-help-size
6558 cperl-shrink-wrap-info-frame)
6559 (setq height
6560 (+ 2
6561 (count-lines
6562 pos
6563 (save-excursion
6564 (if (re-search-forward
6566 (match-beginning 0) (point-max)))))
6567 max-height
6568 (if not-loner
6569 (/ (* (- frheight 3) cperl-max-help-size) 100)
6570 (setq char-height (frame-char-height))
6571 ;; Non-functioning under OS/2:
6572 (if (eq char-height 1) (setq char-height 18))
6573 ;; Title, menubar, + 2 for slack
6574 (- (/ (display-pixel-height) char-height) 4)))
6575 (if (> height max-height) (setq height max-height))
6576 ;;(message "was %s doing %s" iniheight height)
6577 (if not-loner
6578 (enlarge-window (- height iniheight))
6579 (set-frame-height (window-frame win) (1+ height)))))
6580 (set-window-start (selected-window) pos))
6581 (message "No entry for %s found." command))
6582 ;;(pop-to-buffer buffer)
6583 (select-window iniwin)))
6585 (defun cperl-info-on-current-command ()
6586 "Show documentation for Perl command at point in other window."
6587 (interactive)
6588 (cperl-info-on-command (cperl-word-at-point)))
6590 (defun cperl-imenu-info-imenu-search ()
6592 (re-search-backward
6594 (forward-line 1)))
6596 (defun cperl-imenu-info-imenu-name ()
6597 (buffer-substring
6598 (match-beginning 1) (match-end 1)))
6600 (defun cperl-imenu-on-info ()
6601 "Shows imenu for Perl Info Buffer.
6602 Opens Perl Info buffer if needed."
6603 (interactive)
6604 (let* ((buffer (current-buffer))
6605 imenu-create-index-function
6606 imenu-prev-index-position-function
6607 imenu-extract-index-name-function
6608 (index-item (save-restriction
6609 (save-window-excursion
6610 (set-buffer (cperl-info-buffer nil))
6611 (setq imenu-create-index-function
6612 'imenu-default-create-index-function
6613 imenu-prev-index-position-function
6614 'cperl-imenu-info-imenu-search
6615 imenu-extract-index-name-function
6616 'cperl-imenu-info-imenu-name)
6617 (imenu-choose-buffer-index)))))
6618 (and index-item
6619 (progn
6620 (push-mark)
6621 (pop-to-buffer "*info-perl*")
6622 (cond
6623 ((markerp (cdr index-item))
6624 (goto-char (marker-position (cdr index-item))))
6625 (t
6626 (goto-char (cdr index-item))))
6627 (set-window-start (selected-window) (point))
6628 (pop-to-buffer buffer)))))
6630 (defun cperl-lineup (beg end &optional step minshift)
6631 "Lineup construction in a region.
6632 Beginning of region should be at the start of a construction.
6633 All first occurrences of this construction in the lines that are
6634 partially contained in the region are lined up at the same column.
6636 MINSHIFT is the minimal amount of space to insert before the construction.
6637 STEP is the tabwidth to position constructions.
6638 If STEP is nil, `cperl-lineup-step' will be used
6639 \(or `cperl-indent-level', if `cperl-lineup-step' is nil).
6640 Will not move the position at the start to the left."
6641 (interactive "r")
6642 (let (search col tcol seen b)
6643 (save-excursion
6644 (goto-char end)
6645 (end-of-line)
6646 (setq end (point-marker))
6647 (goto-char beg)
6649 (setq beg (point-marker))
6650 (indent-region beg end nil)
6651 (goto-char beg)
6652 (setq col (current-column))
6653 (if (looking-at "[a-zA-Z0-9_]")
6655 (setq search
6657 (regexp-quote
6658 (buffer-substring (match-beginning 0)
6660 (error "Cannot line up in a middle of the word"))
6661 (if (looking-at "$")
6662 (error "Cannot line up end of line"))
6663 (setq search (regexp-quote (char-to-string (following-char)))))
6664 (setq step (or step cperl-lineup-step cperl-indent-level))
6665 (or minshift (setq minshift 1))
6666 (while (progn
6667 (beginning-of-line 2)
6668 (and (< (point) end)
6669 (re-search-forward search end t)
6670 (goto-char (match-beginning 0))))
6671 (setq tcol (current-column) seen t)
6672 (if (> tcol col) (setq col tcol)))
6673 (or seen
6674 (error "The construction to line up occurred only once"))
6675 (goto-char beg)
6676 (setq col (+ col minshift))
6677 (if (/= (% col step) 0) (setq step (* step (1+ (/ col step)))))
6678 (while
6679 (progn
6680 (cperl-make-indent col)
6681 (beginning-of-line 2)
6682 (and (< (point) end)
6683 (re-search-forward search end t)
6684 (goto-char (match-beginning 0)))))))) ; No body
6686 (defun cperl-etags (&optional add all files) ;; NOT USED???
6687 "Run etags with appropriate options for Perl files.
6688 If optional argument ALL is `recursive', will process Perl files
6689 in subdirectories too."
6690 (interactive)
6691 (let ((cmd "etags")
6692 (args '("-l" "none" "-r"
6693 ;; 1=fullname 2=package? 3=name 4=proto? 5=attrs? (VERY APPROX!)
6694 "/\\<sub[ \\t]+\\(\\([a-zA-Z0-9:_]*::\\)?\\([a-zA-Z0-9_]+\\)\\)[ \\t]*\\(([^()]*)[ \t]*\\)?\\([ \t]*:[^#{;]*\\)?\\([{#]\\|$\\)/\\3/"
6695 "-r"
6697 "-r"
6699 res)
6700 (if add (setq args (cons "-a" args)))
6701 (or files (setq files (list buffer-file-name)))
6702 (cond
6703 ((eq all 'recursive)
6704 ;;(error "Not implemented: recursive")
6705 (setq args (append (list "-e"
6707 use File::Find;
6709 exec @ARGV;"
6710 cmd) args)
6711 cmd "perl"))
6712 (all
6713 ;;(error "Not implemented: all")
6714 (setq args (append (list "-e"
6715 "push @ARGV, <*.PL *.pl *.pm>;
6716 exec @ARGV;"
6717 cmd) args)
6718 cmd "perl"))
6719 (t
6720 (setq args (append args files))))
6721 (setq res (apply 'call-process cmd nil nil nil args))
6722 (or (eq res 0)
6725 (defun cperl-toggle-auto-newline ()
6726 "Toggle the state of `cperl-auto-newline'."
6727 (interactive)
6728 (setq cperl-auto-newline (not cperl-auto-newline))
6729 (message "Newlines will %sbe auto-inserted now."
6730 (if cperl-auto-newline "" "not ")))
6732 (defun cperl-toggle-abbrev ()
6733 "Toggle the state of automatic keyword expansion in CPerl mode."
6734 (interactive)
6735 (abbrev-mode (if abbrev-mode 0 1))
6736 (message "Perl control structure will %sbe auto-inserted now."
6737 (if abbrev-mode "" "not ")))
6740 (defun cperl-toggle-electric ()
6741 "Toggle the state of parentheses doubling in CPerl mode."
6742 (interactive)
6743 (setq cperl-electric-parens (if (cperl-val 'cperl-electric-parens) 'null t))
6744 (message "Parentheses will %sbe auto-doubled now."
6745 (if (cperl-val 'cperl-electric-parens) "" "not ")))
6747 (defun cperl-toggle-autohelp ()
6748 "Toggle the state of Auto-Help on Perl constructs (put in the message area).
6749 Delay of auto-help controlled by `cperl-lazy-help-time'."
6750 (interactive)
6751 (if (fboundp 'run-with-idle-timer)
6752 (progn
6753 (if cperl-lazy-installed
6754 (cperl-lazy-unstall)
6755 (cperl-lazy-install))
6756 (message "Perl help messages will %sbe automatically shown now."
6757 (if cperl-lazy-installed "" "not ")))
6758 (message "Cannot automatically show Perl help messages - run-with-idle-timer missing.")))
6760 (defun cperl-toggle-construct-fix ()
6761 "Toggle whether `indent-region'/`indent-sexp' fix whitespace too."
6762 (interactive)
6763 (setq cperl-indent-region-fix-constructs
6764 (if cperl-indent-region-fix-constructs
6765 nil
6766 1))
6767 (message "indent-region/indent-sexp will %sbe automatically fix whitespace."
6768 (if cperl-indent-region-fix-constructs "" "not ")))
6770 (defun cperl-toggle-set-debug-unwind (arg &optional backtrace)
6771 "Toggle (or, with numeric argument, set) debugging state of syntaxification.
6772 Nonpositive numeric argument disables debugging messages. The message
6773 summarizes which regions it was decided to rescan for syntactic constructs.
6775 The message looks like this:
6777 Syxify req=123..138 actual=101..146 done-to: 112=>146 statepos: 73=>117
6779 Numbers are character positions in the buffer. REQ provides the range to
6780 rescan requested by `font-lock'. ACTUAL is the range actually resyntaxified;
6781 for correct operation it should start and end outside any special syntactic
6782 construct. DONE-TO and STATEPOS indicate changes to internal caches maintained
6783 by CPerl."
6784 (interactive "P")
6785 (or arg
6786 (setq arg (if (eq cperl-syntaxify-by-font-lock
6787 (if backtrace 'backtrace 'message)) 0 1)))
6788 (setq arg (if (> arg 0) (if backtrace 'backtrace 'message) t))
6789 (setq cperl-syntaxify-by-font-lock arg)
6790 (message "Debugging messages of syntax unwind %sabled."
6791 (if (eq arg t) "dis" "en")))
6793 ;;;; Tags file creation.
6795 (defvar cperl-tmp-buffer " *cperl-tmp*")
6797 (defun cperl-setup-tmp-buf ()
6798 (set-buffer (get-buffer-create cperl-tmp-buffer))
6799 (set-syntax-table cperl-mode-syntax-table)
6800 (buffer-disable-undo)
6801 (auto-fill-mode 0)
6802 (if cperl-use-syntax-table-text-property-for-tags
6803 (progn
6804 (make-local-variable 'parse-sexp-lookup-properties)
6805 ;; Do not introduce variable if not needed, we check it!
6806 (set 'parse-sexp-lookup-properties t))))
6808 (defun cperl-xsub-scan ()
6809 (require 'imenu)
6810 (let ((index-alist '())
6811 (prev-pos 0) index index1 name package prefix)
6812 (goto-char (point-min))
6813 ;; Search for the function
6814 (progn ;;save-match-data
6815 (while (re-search-forward
6816 "^\\([ \t]*MODULE\\>[^\n]*\\<PACKAGE[ \t]*=[ \t]*\\([a-zA-Z_][a-zA-Z_0-9:]*\\)\\>\\|\\([a-zA-Z_][a-zA-Z_0-9]*\\)(\\|[ \t]*BOOT:\\)"
6817 nil t)
6818 (cond
6819 ((match-beginning 2) ; SECTION
6820 (setq package (buffer-substring (match-beginning 2) (match-end 2)))
6821 (goto-char (match-beginning 0))
6823 (forward-char 1)
6825 (setq prefix (buffer-substring (match-beginning 1) (match-end 1)))
6826 (setq prefix nil)))
6827 ((not package) nil) ; C language section
6828 ((match-beginning 3) ; XSUB
6829 (goto-char (1+ (match-beginning 3)))
6830 (setq index (imenu-example--name-and-position))
6831 (setq name (buffer-substring (match-beginning 3) (match-end 3)))
6832 (if (and prefix (string-match (concat "^" prefix) name))
6833 (setq name (substring name (length prefix))))
6834 (cond ((string-match "::" name) nil)
6835 (t
6836 (setq index1 (cons (concat package "::" name) (cdr index)))
6837 (push index1 index-alist)))
6838 (setcar index name)
6839 (push index index-alist))
6840 (t ; BOOT: section
6841 ;; (beginning-of-line)
6842 (setq index (imenu-example--name-and-position))
6843 (setcar index (concat package "::BOOT:"))
6844 (push index index-alist)))))
6845 index-alist))
6847 (defvar cperl-unreadable-ok nil)
6849 (defun cperl-find-tags (ifile xs topdir)
6850 (let ((b (get-buffer cperl-tmp-buffer)) ind lst elt pos ret rel
6851 (cperl-pod-here-fontify nil) f file)
6852 (save-excursion
6853 (if b (set-buffer b)
6854 (cperl-setup-tmp-buf))
6855 (erase-buffer)
6856 (condition-case err
6857 (setq file (car (insert-file-contents ifile)))
6858 (error (if cperl-unreadable-ok nil
6859 (if (y-or-n-p
6860 (format "File %s unreadable. Continue? " ifile))
6861 (setq cperl-unreadable-ok t)
6862 (error "Aborting: unreadable file %s" ifile)))))
6863 (if (not file)
6864 (message "Unreadable file %s" ifile)
6865 (message "Scanning file %s ..." file)
6866 (if (and cperl-use-syntax-table-text-property-for-tags
6867 (not xs))
6868 (condition-case err ; after __END__ may have garbage
6869 (cperl-find-pods-heres nil nil noninteractive)
6870 (error (message "While scanning for syntax: %s" err))))
6871 (if xs
6872 (setq lst (cperl-xsub-scan))
6873 (setq ind (cperl-imenu--create-perl-index))
6874 (setq lst (cdr (assoc "+Unsorted List+..." ind))))
6875 (setq lst
6876 (mapcar
6877 (function
6878 (lambda (elt)
6879 (cond ((string-match "^[_a-zA-Z]" (car elt))
6880 (goto-char (cdr elt))
6881 (beginning-of-line) ; pos should be of the start of the line
6882 (list (car elt)
6883 (point)
6884 (1+ (count-lines 1 (point))) ; 1+ since at beg-o-l
6885 (buffer-substring (progn
6886 (goto-char (cdr elt))
6887 ;; After name now...
6888 (or (eolp) (forward-char 1))
6889 (point))
6890 (progn
6891 (beginning-of-line)
6892 (point))))))))
6893 lst))
6894 (erase-buffer)
6895 (while lst
6896 (setq elt (car lst) lst (cdr lst))
6897 (if elt
6898 (progn
6899 (insert (elt elt 3)
6900 127
6901 (if (string-match "^package " (car elt))
6902 (substring (car elt) 8)
6903 (car elt) )
6904 1
6905 (number-to-string (elt elt 2)) ; Line
6906 ","
6907 (number-to-string (1- (elt elt 1))) ; Char pos 0-based
6909 (if (and (string-match "^[_a-zA-Z]+::" (car elt))
6911 (elt elt 3)))
6912 ;; Need to insert the name without package as well
6913 (setq lst (cons (cons (substring (elt elt 3)
6914 (match-beginning 1)
6915 (match-end 1))
6916 (cdr elt))
6917 lst))))))
6918 (setq pos (point))
6919 (goto-char 1)
6920 (setq rel file)
6921 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
6922 (set-text-properties 0 (length rel) nil rel)
6923 (and (equal topdir (substring rel 0 (length topdir)))
6924 (setq rel (substring file (length topdir))))
6926 (setq ret (buffer-substring 1 (point-max)))
6927 (erase-buffer)
6928 (or noninteractive
6929 (message "Scanning file %s finished" file))
6930 ret))))
6932 (defun cperl-add-tags-recurse-noxs ()
6934 Use as
6935 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
6936 -f cperl-add-tags-recurse-noxs
6937 "
6938 (cperl-write-tags nil nil t t nil t))
6940 (defun cperl-add-tags-recurse-noxs-fullpath ()
6942 Writes down fullpath, so TAGS is relocatable (but if the build directory
6943 is relocated, the file TAGS inside it breaks). Use as
6944 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
6945 -f cperl-add-tags-recurse-noxs-fullpath
6946 "
6947 (cperl-write-tags nil nil t t nil t ""))
6949 (defun cperl-add-tags-recurse ()
6950 "Add to TAGS file data for Perl files in the current directory and kids.
6951 Use as
6952 emacs -batch -q -no-site-file -l emacs/cperl-mode.el \
6953 -f cperl-add-tags-recurse
6954 "
6955 (cperl-write-tags nil nil t t))
6957 (defun cperl-write-tags (&optional file erase recurse dir inbuffer noxs topdir)
6958 ;; If INBUFFER, do not select buffer, and do not save
6959 ;; If ERASE is `ignore', do not erase, and do not try to delete old info.
6960 (require 'etags)
6961 (if file nil
6962 (setq file (if dir default-directory (buffer-file-name)))
6963 (if (and (not dir) (buffer-modified-p)) (error "Save buffer first!")))
6964 (or topdir
6965 (setq topdir default-directory))
6966 (let ((tags-file-name "TAGS")
6967 (case-fold-search (eq system-type 'emx))
6968 xs rel tm)
6969 (save-excursion
6970 (cond (inbuffer nil) ; Already there
6971 ((file-exists-p tags-file-name)
6972 (if (featurep 'xemacs)
6973 (visit-tags-table-buffer)
6974 (visit-tags-table-buffer tags-file-name)))
6975 (t (set-buffer (find-file-noselect tags-file-name))))
6976 (cond
6977 (dir
6978 (cond ((eq erase 'ignore))
6979 (erase
6980 (erase-buffer)
6981 (setq erase 'ignore)))
6982 (let ((files
6983 (condition-case err
6984 (directory-files file t
6985 (if recurse nil cperl-scan-files-regexp)
6986 t)
6987 (error
6988 (if cperl-unreadable-ok nil
6989 (if (y-or-n-p
6990 (format "Directory %s unreadable. Continue? " file))
6991 (setq cperl-unreadable-ok t
6992 tm nil) ; Return empty list
6993 (error "Aborting: unreadable directory %s" file)))))))
6994 (mapc (function
6995 (lambda (file)
6996 (cond
6997 ((string-match cperl-noscan-files-regexp file)
6998 nil)
6999 ((not (file-directory-p file))
7000 (if (string-match cperl-scan-files-regexp file)
7001 (cperl-write-tags file erase recurse nil t noxs topdir)))
7002 ((not recurse) nil)
7003 (t (cperl-write-tags file erase recurse t t noxs topdir)))))
7004 files)))
7005 (t
7007 (if (not (and xs noxs))
7008 (progn
7009 (cond ((eq erase 'ignore) (goto-char (point-max)))
7010 (erase (erase-buffer))
7011 (t
7012 (goto-char 1)
7013 (setq rel file)
7014 ;; On case-preserving filesystems (EMX on OS/2) case might be encoded in properties
7015 (set-text-properties 0 (length rel) nil rel)
7016 (and (equal topdir (substring rel 0 (length topdir)))
7017 (setq rel (substring file (length topdir))))
7019 (progn
7021 (delete-region (point)
7022 (save-excursion
7023 (forward-char 1)
7025 nil 'toend)
7026 (- (point) 2)
7027 (point-max)))))
7028 (goto-char (point-max)))))
7029 (insert (cperl-find-tags file xs topdir))))))
7030 (if inbuffer nil ; Delegate to the caller
7031 (save-buffer 0) ; No backup
7032 (if (fboundp 'initialize-new-tags-table) ; Do we need something special in XEmacs?
7033 (initialize-new-tags-table))))))
7035 (defvar cperl-tags-hier-regexp-list
7036 (concat
7047 (defvar cperl-hierarchy '(() ())
7048 "Global hierarchy of classes.")
7050 (defun cperl-tags-hier-fill ()
7051 ;; Suppose we are in a tag table cooked by cperl.
7052 (goto-char 1)
7053 (let (type pack name pos line chunk ord cons1 file str info fileind)
7054 (while (re-search-forward cperl-tags-hier-regexp-list nil t)
7055 (setq pos (match-beginning 0)
7056 pack (match-beginning 2))
7057 (beginning-of-line)
7058 (if (looking-at (concat
7060 "\C-?"
7062 "\C-a"
7064 ","
7066 (progn
7067 (setq ;;str (buffer-substring (match-beginning 1) (match-end 1))
7068 name (buffer-substring (match-beginning 2) (match-end 2))
7069 ;;pos (buffer-substring (match-beginning 3) (match-end 3))
7070 line (buffer-substring (match-beginning 3) (match-end 3))
7071 ord (if pack 1 0)
7072 file (file-of-tag)
7073 fileind (format "%s:%s" file line)
7074 ;; Moves to beginning of the next line:
7075 info (cperl-etags-snarf-tag file line))
7076 ;; Move back
7077 (forward-char -1)
7078 ;; Make new member of hierarchy name ==> file ==> pos if needed
7079 (if (setq cons1 (assoc name (nth ord cperl-hierarchy)))
7080 ;; Name known
7081 (setcdr cons1 (cons (cons fileind (vector file info))
7082 (cdr cons1)))
7083 ;; First occurrence of the name, start alist
7084 (setq cons1 (cons name (list (cons fileind (vector file info)))))
7085 (if pack
7086 (setcar (cdr cperl-hierarchy)
7087 (cons cons1 (nth 1 cperl-hierarchy)))
7088 (setcar cperl-hierarchy
7089 (cons cons1 (car cperl-hierarchy)))))))
7090 (end-of-line))))
7092 (defun cperl-tags-hier-init (&optional update)
7093 "Show hierarchical menu of classes and methods.
7094 Finds info about classes by a scan of loaded TAGS files.
7095 Supposes that the TAGS files contain fully qualified function names.
7096 One may build such TAGS files from CPerl mode menu."
7097 (interactive)
7098 (require 'etags)
7099 (require 'imenu)
7100 (if (or update (null (nth 2 cperl-hierarchy)))
7101 (let ((remover (function (lambda (elt) ; (name (file1...) (file2..))
7102 (or (nthcdr 2 elt)
7103 ;; Only in one file
7104 (setcdr elt (cdr (nth 1 elt)))))))
7105 pack name cons1 to l1 l2 l3 l4 b)
7106 ;; (setq cperl-hierarchy '(() () ())) ; Would write into '() later!
7107 (setq cperl-hierarchy (list l1 l2 l3))
7108 (if (featurep 'xemacs) ; Not checked
7109 (progn
7110 (or tags-file-name
7111 ;; Does this work in XEmacs?
7112 (call-interactively 'visit-tags-table))
7113 (message "Updating list of classes...")
7114 (set-buffer (get-file-buffer tags-file-name))
7115 (cperl-tags-hier-fill))
7116 (or tags-table-list
7117 (call-interactively 'visit-tags-table))
7118 (mapc
7119 (function
7120 (lambda (tagsfile)
7121 (message "Updating list of classes... %s" tagsfile)
7122 (set-buffer (get-file-buffer tagsfile))
7123 (cperl-tags-hier-fill)))
7124 tags-table-list)
7125 (message "Updating list of classes... postprocessing..."))
7126 (mapc remover (car cperl-hierarchy))
7127 (mapc remover (nth 1 cperl-hierarchy))
7128 (setq to (list nil (cons "Packages: " (nth 1 cperl-hierarchy))
7129 (cons "Methods: " (car cperl-hierarchy))))
7130 (cperl-tags-treeify to 1)
7131 (setcar (nthcdr 2 cperl-hierarchy)
7132 (cperl-menu-to-keymap (cons '("+++UPDATE+++" . -999) (cdr to))))
7133 (message "Updating list of classes: done, requesting display...")
7134 ;;(cperl-imenu-addback (nth 2 cperl-hierarchy))
7135 ))
7136 (or (nth 2 cperl-hierarchy)
7137 (error "No items found"))
7138 (setq update
7139 ;;; (imenu-choose-buffer-index "Packages: " (nth 2 cperl-hierarchy))
7140 (if (if (fboundp 'display-popup-menus-p)
7141 (let ((f 'display-popup-menus-p))
7142 (funcall f))
7143 window-system)
7144 (x-popup-menu t (nth 2 cperl-hierarchy))
7145 (require 'tmm)
7146 (tmm-prompt (nth 2 cperl-hierarchy))))
7147 (if (and update (listp update))
7148 (progn (while (cdr update) (setq update (cdr update)))
7149 (setq update (car update)))) ; Get the last from the list
7150 (if (vectorp update)
7151 (progn
7152 (find-file (elt update 0))
7153 (cperl-etags-goto-tag-location (elt update 1))))
7154 (if (eq update -999) (cperl-tags-hier-init t)))
7156 (defun cperl-tags-treeify (to level)
7157 ;; cadr of `to' is read-write. On start it is a cons
7159 'identity
7160 (make-list level "[_a-zA-Z0-9]+")
7161 "::")
7163 (packages (cdr (nth 1 to)))
7164 (methods (cdr (nth 2 to)))
7165 l1 head tail cons1 cons2 ord writeto packs recurse
7166 root-packages root-functions ms many_ms same_name ps
7167 (move-deeper
7168 (function
7169 (lambda (elt)
7170 (cond ((and (string-match regexp (car elt))
7171 (or (eq ord 1) (match-end 2)))
7172 (setq head (substring (car elt) 0 (match-end 1))
7173 tail (if (match-end 2) (substring (car elt)
7174 (match-end 2)))
7175 recurse t)
7176 (if (setq cons1 (assoc head writeto)) nil
7177 ;; Need to init new head
7178 (setcdr writeto (cons (list head (list "Packages: ")
7179 (list "Methods: "))
7180 (cdr writeto)))
7181 (setq cons1 (nth 1 writeto)))
7182 (setq cons2 (nth ord cons1)) ; Either packs or meths
7183 (setcdr cons2 (cons elt (cdr cons2))))
7184 ((eq ord 2)
7185 (setq root-functions (cons elt root-functions)))
7186 (t
7187 (setq root-packages (cons elt root-packages))))))))
7188 (setcdr to l1) ; Init to dynamic space
7189 (setq writeto to)
7190 (setq ord 1)
7191 (mapc move-deeper packages)
7192 (setq ord 2)
7193 (mapc move-deeper methods)
7194 (if recurse
7195 (mapc (function (lambda (elt)
7196 (cperl-tags-treeify elt (1+ level))))
7197 (cdr to)))
7198 ;;Now clean up leaders with one child only
7199 (mapc (function (lambda (elt)
7200 (if (not (and (listp (cdr elt))
7201 (eq (length elt) 2))) nil
7202 (setcar elt (car (nth 1 elt)))
7203 (setcdr elt (cdr (nth 1 elt))))))
7204 (cdr to))
7205 ;; Sort the roots of subtrees
7206 (if (default-value 'imenu-sort-function)
7207 (setcdr to
7208 (sort (cdr to) (default-value 'imenu-sort-function))))
7209 ;; Now add back functions removed from display
7210 (mapc (function (lambda (elt)
7211 (setcdr to (cons elt (cdr to)))))
7212 (if (default-value 'imenu-sort-function)
7213 (nreverse
7214 (sort root-functions (default-value 'imenu-sort-function)))
7215 root-functions))
7216 ;; Now add back packages removed from display
7217 (mapc (function (lambda (elt)
7218 (setcdr to (cons (cons (concat "package " (car elt))
7219 (cdr elt))
7220 (cdr to)))))
7221 (if (default-value 'imenu-sort-function)
7222 (nreverse
7223 (sort root-packages (default-value 'imenu-sort-function)))
7224 root-packages))))
7226 ;;;(x-popup-menu t
7227 ;;; '(keymap "Name1"
7228 ;;; ("Ret1" "aa")
7229 ;;; ("Head1" "ab"
7230 ;;; keymap "Name2"
7231 ;;; ("Tail1" "x") ("Tail2" "y"))))
7233 (defun cperl-list-fold (list name limit)
7234 (let (list1 list2 elt1 (num 0))
7235 (if (<= (length list) limit) list
7236 (setq list1 nil list2 nil)
7237 (while list
7238 (setq num (1+ num)
7239 elt1 (car list)
7240 list (cdr list))
7241 (if (<= num imenu-max-items)
7242 (setq list2 (cons elt1 list2))
7243 (setq list1 (cons (cons name
7244 (nreverse list2))
7245 list1)
7246 list2 (list elt1)
7247 num 1)))
7248 (nreverse (cons (cons name
7249 (nreverse list2))
7250 list1)))))
7252 (defun cperl-menu-to-keymap (menu &optional name)
7253 (let (list)
7254 (cons 'keymap
7255 (mapcar
7256 (function
7257 (lambda (elt)
7258 (cond ((listp (cdr elt))
7259 (setq list (cperl-list-fold
7260 (cdr elt) (car elt) imenu-max-items))
7261 (cons nil
7262 (cons (car elt)
7263 (cperl-menu-to-keymap list))))
7264 (t
7265 (list (cdr elt) (car elt) t))))) ; t is needed in 19.34
7266 (cperl-list-fold menu "Root" imenu-max-items)))))
7268 \f
7269 (defvar cperl-bad-style-regexp
7270 (mapconcat 'identity
7274 "Finds places such that insertion of a whitespace may help a lot.")
7276 (defvar cperl-not-bad-style-regexp
7277 (mapconcat
7278 'identity
7280 "[a-zA-Z0-9_][|&][a-zA-Z0-9_$]" ; abc|def abc&def are often used.
7281 "&[(a-zA-Z0-9_$]" ; &subroutine &(var->field)
7284 "-[0-9]" ; -5
7286 "--" ; --var
7287 ".->" ; a->b
7288 "->" ; a SPACE ->b
7291 "^=" ; =head
7294 "||"
7295 "&&"
7298 ;; Unaddressed trouble spots: = -abc, f(56, -abc) --- specialcased below
7299 ;;"[*/+-|&<.]+="
7300 )
7302 "If matches at the start of match found by `my-bad-c-style-regexp',
7303 insertion of a whitespace will not help.")
7305 (defvar found-bad)
7307 (defun cperl-find-bad-style ()
7308 "Find places in the buffer where insertion of a whitespace may help.
7309 Prompts user for insertion of spaces.
7310 Currently it is tuned to C and Perl syntax."
7311 (interactive)
7312 (let (found-bad (p (point)))
7313 (setq last-nonmenu-event 13) ; To disable popup
7314 (goto-char (point-min))
7315 (map-y-or-n-p "Insert space here? "
7316 (lambda (arg) (insert " "))
7317 'cperl-next-bad-style
7318 '("location" "locations" "insert a space into")
7319 '((?\C-r (lambda (arg)
7320 (let ((buffer-quit-function
7321 'exit-recursive-edit))
7322 (message "Exit with Esc Esc")
7323 (recursive-edit)
7324 t)) ; Consider acted upon
7325 "edit, exit with Esc Esc")
7326 (?e (lambda (arg)
7327 (let ((buffer-quit-function
7328 'exit-recursive-edit))
7329 (message "Exit with Esc Esc")
7330 (recursive-edit)
7331 t)) ; Consider acted upon
7332 "edit, exit with Esc Esc"))
7333 t)
7334 (if found-bad (goto-char found-bad)
7335 (goto-char p)
7336 (message "No appropriate place found"))))
7338 (defun cperl-next-bad-style ()
7339 (let (p (not-found t) (point (point)) found)
7340 (while (and not-found
7341 (re-search-forward cperl-bad-style-regexp nil 'to-end))
7342 (setq p (point))
7343 (goto-char (match-beginning 0))
7344 (if (or
7345 (looking-at cperl-not-bad-style-regexp)
7346 ;; Check for a < -b and friends
7347 (and (eq (following-char) ?\-)
7348 (save-excursion
7350 (memq (preceding-char) '(?\= ?\> ?\< ?\, ?\( ?\[ ?\{))))
7351 ;; Now check for syntax type
7352 (save-match-data
7353 (setq found (point))
7354 (beginning-of-defun)
7355 (let ((pps (parse-partial-sexp (point) found)))
7356 (or (nth 3 pps) (nth 4 pps) (nth 5 pps)))))
7357 (goto-char (match-end 0))
7358 (goto-char (1- p))
7359 (setq not-found nil
7360 found-bad found)))
7361 (not not-found)))
7363 \f
7364 ;;; Getting help
7365 (defvar cperl-have-help-regexp
7367 (mapconcat
7368 'identity
7372 "-[a-zA-Z]" ; File test
7374 "^=[a-z][a-zA-Z0-9_]*" ; POD sections
7376 "[a-zA-Z_0-9:]+" ; symbol or number
7377 "x="
7378 "#!")
7382 ;;)
7383 "Matches places in the buffer we can find help for.")
7385 (defvar cperl-message-on-help-error t)
7386 (defvar cperl-help-from-timer nil)
7388 (defun cperl-word-at-point-hard ()
7389 ;; Does not save-excursion
7390 ;; Get to the something meaningful
7391 (or (eobp) (eolp) (forward-char 1))
7393 (save-excursion (beginning-of-line) (point))
7394 'to-beg)
7395 ;; (cond
7398 ;; (or (bobp) (backward-char 1))))
7399 ;; Try to backtrace
7400 (cond
7401 ((looking-at "[a-zA-Z0-9_:]") ; symbol
7402 (skip-chars-backward "a-zA-Z0-9_:")
7403 (cond
7404 ((and (eq (preceding-char) ?^) ; $^I
7405 (eq (char-after (- (point) 2)) ?\$))
7406 (forward-char -2))
7408 (forward-char -1))
7409 ((and (eq (preceding-char) ?\=)
7410 (eq (current-column) 1))
7411 (forward-char -1))) ; =head1
7412 (if (and (eq (preceding-char) ?\<)
7414 (forward-char -1)))
7415 ((and (looking-at "=") (eq (preceding-char) ?x)) ; x=
7416 (forward-char -1))
7418 (forward-char -1))
7421 (cond
7422 ((and (eq (preceding-char) ?\$)
7423 (not (eq (char-after (- (point) 2)) ?\$))) ; $-
7424 (forward-char -1))
7425 ((and (eq (following-char) ?\>)
7426 (string-match "[a-zA-Z0-9_]" (char-to-string (preceding-char)))
7427 (save-excursion
7428 (forward-sexp -1)
7429 (and (eq (preceding-char) ?\<)
7431 (search-backward "<"))))
7432 ((and (eq (following-char) ?\$)
7433 (eq (preceding-char) ?\<)
7435 (forward-char -1)))
7436 (if (looking-at cperl-have-help-regexp)
7437 (buffer-substring (match-beginning 0) (match-end 0))))
7439 (defun cperl-get-help ()
7440 "Get one-line docs on the symbol at the point.
7441 The data for these docs is a little bit obsolete and may be in fact longer
7442 than a line. Your contribution to update/shorten it is appreciated."
7443 (interactive)
7444 (save-match-data ; May be called "inside" query-replace
7445 (save-excursion
7446 (let ((word (cperl-word-at-point-hard)))
7447 (if word
7448 (if (and cperl-help-from-timer ; Bail out if not in mainland
7450 (or (memq (get-text-property (point) 'face)
7451 '(font-lock-comment-face font-lock-string-face))
7452 (memq (get-text-property (point) 'syntax-type)
7453 '(pod here-doc format))))
7454 nil
7455 (cperl-describe-perl-symbol word))
7456 (if cperl-message-on-help-error
7457 (message "Nothing found for %s..."
7458 (buffer-substring (point) (min (+ 5 (point)) (point-max))))))))))
7460 ;;; Stolen from perl-descr.el by Johan Vromans:
7462 (defvar cperl-doc-buffer " *perl-doc*"
7463 "Where the documentation can be found.")
7465 (defun cperl-describe-perl-symbol (val)
7466 "Display the documentation of symbol at point, a Perl operator."
7467 (let ((enable-recursive-minibuffers t)
7468 args-file regexp)
7469 (cond
7470 ((string-match "^[&*][a-zA-Z_]" val)
7471 (setq val (concat (substring val 0 1) "NAME")))
7473 (setq val (concat "@" (substring val 1 (match-end 1)))))
7475 (setq val (concat "%" (substring val 1 (match-end 1)))))
7476 ((and (string= val "x") (string-match "^x=" val))
7477 (setq val "x="))
7479 (setq val (concat "$^" (char-to-string (+ ?A -1 (aref val 1))))))
7480 ((string-match "^CORE::" val)
7481 (setq val "CORE::"))
7482 ((string-match "^SUPER::" val)
7483 (setq val "SUPER::"))
7485 (setq val "<NAME>")))
7486 (setq regexp (concat "^"
7488 (regexp-quote val)
7491 ;; get the buffer with the documentation text
7492 (cperl-switch-to-doc-buffer)
7494 ;; lookup in the doc
7495 (goto-char (point-min))
7496 (let ((case-fold-search nil))
7497 (list
7498 (if (re-search-forward regexp (point-max) t)
7499 (save-excursion
7500 (beginning-of-line 1)
7501 (let ((lnstart (point)))
7502 (end-of-line)
7503 (message "%s" (buffer-substring lnstart (point)))))
7504 (if cperl-message-on-help-error
7505 (message "No definition for %s" val)))))))
7507 (defvar cperl-short-docs 'please-ignore-this-line
7508 ;; Perl4 version was written by Johan Vromans (jvromans@squirrel.nl)
7509 "# based on '@(#)@ perl-descr.el 1.9 - describe-perl-symbol' [Perl 5]
7510 ... Range (list context); flip/flop [no flop when flip] (scalar context).
7511 ! ... Logical negation.
7512 ... != ... Numeric inequality.
7513 ... !~ ... Search pattern, substitution, or translation (negated).
7514 $! In numeric context: errno. In a string context: error string.
7516 $# The output format for printed numbers. Default is %.15g or close.
7517 $$ Process number of this script. Changes in the fork()ed child process.
7518 $% The current page number of the currently selected output channel.
7520 The following variables are always local to the current block:
7522 $1 Match of the 1st set of parentheses in the last match (auto-local).
7523 $2 Match of the 2nd set of parentheses in the last match (auto-local).
7524 $3 Match of the 3rd set of parentheses in the last match (auto-local).
7525 $4 Match of the 4th set of parentheses in the last match (auto-local).
7526 $5 Match of the 5th set of parentheses in the last match (auto-local).
7527 $6 Match of the 6th set of parentheses in the last match (auto-local).
7528 $7 Match of the 7th set of parentheses in the last match (auto-local).
7529 $8 Match of the 8th set of parentheses in the last match (auto-local).
7530 $9 Match of the 9th set of parentheses in the last match (auto-local).
7531 $& The string matched by the last pattern match (auto-local).
7532 $' The string after what was matched by the last match (auto-local).
7533 $` The string before what was matched by the last match (auto-local).
7535 $( The real gid of this process.
7536 $) The effective gid of this process.
7537 $* Deprecated: Set to 1 to do multiline matching within a string.
7538 $+ The last bracket matched by the last search pattern.
7539 $, The output field separator for the print operator.
7540 $- The number of lines left on the page.
7541 $. The current input line number of the last filehandle that was read.
7542 $/ The input record separator, newline by default.
7543 $0 Name of the file containing the current perl script (read/write).
7544 $: String may be broken after these characters to fill ^-lines in a format.
7546 $< The real uid of this process.
7547 $= The page length of the current output channel. Default is 60 lines.
7548 $> The effective uid of this process.
7549 $? The status returned by the last ``, pipe close or `system'.
7550 $@ The perl error message from the last eval or do @var{EXPR} command.
7551 $ARGV The name of the current file used with <> .
7552 $[ Deprecated: The index of the first element/char in an array/string.
7554 $] The perl version string as displayed with perl -v.
7555 $^ The name of the current top-of-page format.
7556 $^A The current value of the write() accumulator for format() lines.
7557 $^D The value of the perl debug (-D) flags.
7558 $^E Information about the last system error other than that provided by $!.
7559 $^F The highest system file descriptor, ordinarily 2.
7560 $^H The current set of syntax checks enabled by `use strict'.
7561 $^I The value of the in-place edit extension (perl -i option).
7563 $^M A buffer for emergency memory allocation when running out of memory.
7564 $^O The operating system name under which this copy of Perl was built.
7565 $^P Internal debugging flag.
7566 $^T The time the script was started. Used by -A/-M/-C file tests.
7567 $^W True if warnings are requested (perl -w flag).
7568 $^X The name under which perl was invoked (argv[0] in C-speech).
7569 $_ The default input and pattern-searching space.
7570 $| Auto-flush after write/print on current output channel? Default 0.
7571 $~ The name of the current report format.
7572 ... % ... Modulo division.
7573 ... %= ... Modulo division assignment.
7574 %ENV Contains the current environment.
7575 %INC List of files that have been require-d or do-ne.
7576 %SIG Used to set signal handlers for various signals.
7577 ... & ... Bitwise and.
7578 ... && ... Logical and.
7579 ... &&= ... Logical and assignment.
7580 ... &= ... Bitwise and assignment.
7581 ... * ... Multiplication.
7582 ... ** ... Exponentiation.
7583 *NAME Glob: all objects refered by NAME. *NAM1 = *NAM2 aliases NAM1 to NAM2.
7584 &NAME(arg0, ...) Subroutine call. Arguments go to @_.
7585 ... + ... Addition. +EXPR Makes EXPR into scalar context.
7586 ++ Auto-increment (magical on strings). ++EXPR EXPR++
7587 ... += ... Addition assignment.
7588 , Comma operator.
7589 ... - ... Subtraction.
7590 -- Auto-decrement (NOT magical on strings). --EXPR EXPR--
7591 ... -= ... Subtraction assignment.
7592 -A Access time in days since script started.
7593 -B File is a non-text (binary) file.
7594 -C Inode change time in days since script started.
7595 -M Age in days since script started.
7596 -O File is owned by real uid.
7597 -R File is readable by real uid.
7598 -S File is a socket .
7599 -T File is a text file.
7600 -W File is writable by real uid.
7601 -X File is executable by real uid.
7602 -b File is a block special file.
7603 -c File is a character special file.
7604 -d File is a directory.
7605 -e File exists .
7606 -f File is a plain file.
7607 -g File has setgid bit set.
7608 -k File has sticky bit set.
7609 -l File is a symbolic link.
7610 -o File is owned by effective uid.
7611 -p File is a named pipe (FIFO).
7612 -r File is readable by effective uid.
7613 -s File has non-zero size.
7614 -t Tests if filehandle (STDIN by default) is opened to a tty.
7615 -u File has setuid bit set.
7616 -w File is writable by effective uid.
7617 -x File is executable by effective uid.
7618 -z File has zero size.
7619 . Concatenate strings.
7620 .. Range (list context); flip/flop (scalar context) operator.
7621 .= Concatenate assignment strings
7622 ... / ... Division. /PATTERN/ioxsmg Pattern match
7623 ... /= ... Division assignment.
7624 /PATTERN/ioxsmg Pattern match.
7625 ... < ... Numeric less than. <pattern> Glob. See <NAME>, <> as well.
7626 <NAME> Reads line from filehandle NAME (a bareword or dollar-bareword).
7627 <pattern> Glob (Unless pattern is bareword/dollar-bareword - see <NAME>).
7628 <> Reads line from union of files in @ARGV (= command line) and STDIN.
7629 ... << ... Bitwise shift left. << start of HERE-DOCUMENT.
7630 ... <= ... Numeric less than or equal to.
7631 ... <=> ... Numeric compare.
7632 ... = ... Assignment.
7633 ... == ... Numeric equality.
7634 ... =~ ... Search pattern, substitution, or translation
7635 ... > ... Numeric greater than.
7636 ... >= ... Numeric greater than or equal to.
7637 ... >> ... Bitwise shift right.
7638 ... >>= ... Bitwise shift right assignment.
7639 ... ? ... : ... Condition=if-then-else operator. ?PAT? One-time pattern match.
7640 ?PATTERN? One-time pattern match.
7641 @ARGV Command line arguments (not including the command name - see $0).
7642 @INC List of places to look for perl scripts during do/include/use.
7643 @_ Parameter array for subroutines; result of split() unless in list context.
7661 ... ^ ... Bitwise exclusive or.
7662 __END__ Ends program source.
7663 __DATA__ Ends program source.
7664 __FILE__ Current (source) filename.
7665 __LINE__ Current line in current source.
7666 __PACKAGE__ Current package.
7667 ARGV Default multi-file input filehandle. <ARGV> is a synonym for <>.
7668 ARGVOUT Output filehandle with -i flag.
7669 BEGIN { ... } Immediately executed (during compilation) piece of code.
7670 END { ... } Pseudo-subroutine executed after the script finishes.
7671 CHECK { ... } Pseudo-subroutine executed after the script is compiled.
7672 INIT { ... } Pseudo-subroutine executed before the script starts running.
7673 DATA Input filehandle for what follows after __END__ or __DATA__.
7674 accept(NEWSOCKET,GENERICSOCKET)
7675 alarm(SECONDS)
7676 atan2(X,Y)
7677 bind(SOCKET,NAME)
7678 binmode(FILEHANDLE)
7679 caller[(LEVEL)]
7680 chdir(EXPR)
7681 chmod(LIST)
7682 chop[(LIST|VAR)]
7683 chown(LIST)
7684 chroot(FILENAME)
7685 close(FILEHANDLE)
7686 closedir(DIRHANDLE)
7687 ... cmp ... String compare.
7688 connect(SOCKET,NAME)
7689 continue of { block } continue { block }. Is executed after `next' or at end.
7690 cos(EXPR)
7691 crypt(PLAINTEXT,SALT)
7692 dbmclose(%HASH)
7693 dbmopen(%HASH,DBNAME,MODE)
7694 defined(EXPR)
7695 delete($HASH{KEY})
7696 die(LIST)
7697 do { ... }|SUBR while|until EXPR executes at least once
7698 do(EXPR|SUBR([LIST])) (with while|until executes at least once)
7699 dump LABEL
7700 each(%HASH)
7701 endgrent
7702 endhostent
7703 endnetent
7704 endprotoent
7705 endpwent
7706 endservent
7707 eof[([FILEHANDLE])]
7708 ... eq ... String equality.
7709 eval(EXPR) or eval { BLOCK }
7710 exec([TRUENAME] ARGV0, ARGVs) or exec(SHELL_COMMAND_LINE)
7711 exit(EXPR)
7712 exp(EXPR)
7713 fcntl(FILEHANDLE,FUNCTION,SCALAR)
7714 fileno(FILEHANDLE)
7715 flock(FILEHANDLE,OPERATION)
7716 for (EXPR;EXPR;EXPR) { ... }
7717 foreach [VAR] (@ARRAY) { ... }
7718 fork
7719 ... ge ... String greater than or equal.
7720 getc[(FILEHANDLE)]
7721 getgrent
7722 getgrgid(GID)
7723 getgrnam(NAME)
7724 gethostbyaddr(ADDR,ADDRTYPE)
7725 gethostbyname(NAME)
7726 gethostent
7727 getlogin
7728 getnetbyaddr(ADDR,ADDRTYPE)
7729 getnetbyname(NAME)
7730 getnetent
7731 getpeername(SOCKET)
7732 getpgrp(PID)
7733 getppid
7734 getpriority(WHICH,WHO)
7735 getprotobyname(NAME)
7736 getprotobynumber(NUMBER)
7737 getprotoent
7738 getpwent
7739 getpwnam(NAME)
7740 getpwuid(UID)
7741 getservbyname(NAME,PROTO)
7742 getservbyport(PORT,PROTO)
7743 getservent
7744 getsockname(SOCKET)
7745 getsockopt(SOCKET,LEVEL,OPTNAME)
7746 gmtime(EXPR)
7747 goto LABEL
7748 ... gt ... String greater than.
7749 hex(EXPR)
7750 if (EXPR) { ... } [ elsif (EXPR) { ... } ... ] [ else { ... } ] or EXPR if EXPR
7751 index(STR,SUBSTR[,OFFSET])
7752 int(EXPR)
7753 ioctl(FILEHANDLE,FUNCTION,SCALAR)
7754 join(EXPR,LIST)
7755 keys(%HASH)
7756 kill(LIST)
7757 last [LABEL]
7758 ... le ... String less than or equal.
7759 length(EXPR)
7760 link(OLDFILE,NEWFILE)
7761 listen(SOCKET,QUEUESIZE)
7762 local(LIST)
7763 localtime(EXPR)
7764 log(EXPR)
7765 lstat(EXPR|FILEHANDLE|VAR)
7766 ... lt ... String less than.
7767 m/PATTERN/iogsmx
7768 mkdir(FILENAME,MODE)
7769 msgctl(ID,CMD,ARG)
7770 msgget(KEY,FLAGS)
7771 msgrcv(ID,VAR,SIZE,TYPE.FLAGS)
7772 msgsnd(ID,MSG,FLAGS)
7773 my VAR or my (VAR1,...) Introduces a lexical variable ($VAR, @ARR, or %HASH).
7774 our VAR or our (VAR1,...) Lexically enable a global variable ($V, @A, or %H).
7775 ... ne ... String inequality.
7776 next [LABEL]
7777 oct(EXPR)
7778 open(FILEHANDLE[,EXPR])
7779 opendir(DIRHANDLE,EXPR)
7780 ord(EXPR) ASCII value of the first char of the string.
7781 pack(TEMPLATE,LIST)
7782 package NAME Introduces package context.
7783 pipe(READHANDLE,WRITEHANDLE) Create a pair of filehandles on ends of a pipe.
7784 pop(ARRAY)
7785 print [FILEHANDLE] [(LIST)]
7786 printf [FILEHANDLE] (FORMAT,LIST)
7787 push(ARRAY,LIST)
7788 q/STRING/ Synonym for 'STRING'
7790 qx/STRING/ Synonym for `STRING`
7791 rand[(EXPR)]
7792 read(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7793 readdir(DIRHANDLE)
7794 readlink(EXPR)
7795 recv(SOCKET,SCALAR,LEN,FLAGS)
7796 redo [LABEL]
7797 rename(OLDNAME,NEWNAME)
7798 require [FILENAME | PERL_VERSION]
7799 reset[(EXPR)]
7800 return(LIST)
7801 reverse(LIST)
7802 rewinddir(DIRHANDLE)
7803 rindex(STR,SUBSTR[,OFFSET])
7804 rmdir(FILENAME)
7805 s/PATTERN/REPLACEMENT/gieoxsm
7806 scalar(EXPR)
7807 seek(FILEHANDLE,POSITION,WHENCE)
7808 seekdir(DIRHANDLE,POS)
7809 select(FILEHANDLE | RBITS,WBITS,EBITS,TIMEOUT)
7810 semctl(ID,SEMNUM,CMD,ARG)
7811 semget(KEY,NSEMS,SIZE,FLAGS)
7812 semop(KEY,...)
7813 send(SOCKET,MSG,FLAGS[,TO])
7814 setgrent
7815 sethostent(STAYOPEN)
7816 setnetent(STAYOPEN)
7817 setpgrp(PID,PGRP)
7818 setpriority(WHICH,WHO,PRIORITY)
7819 setprotoent(STAYOPEN)
7820 setpwent
7821 setservent(STAYOPEN)
7822 setsockopt(SOCKET,LEVEL,OPTNAME,OPTVAL)
7823 shift[(ARRAY)]
7824 shmctl(ID,CMD,ARG)
7825 shmget(KEY,SIZE,FLAGS)
7826 shmread(ID,VAR,POS,SIZE)
7827 shmwrite(ID,STRING,POS,SIZE)
7828 shutdown(SOCKET,HOW)
7829 sin(EXPR)
7830 sleep[(EXPR)]
7831 socket(SOCKET,DOMAIN,TYPE,PROTOCOL)
7832 socketpair(SOCKET1,SOCKET2,DOMAIN,TYPE,PROTOCOL)
7833 sort [SUBROUTINE] (LIST)
7834 splice(ARRAY,OFFSET[,LENGTH[,LIST]])
7835 split[(/PATTERN/[,EXPR[,LIMIT]])]
7836 sprintf(FORMAT,LIST)
7837 sqrt(EXPR)
7838 srand(EXPR)
7839 stat(EXPR|FILEHANDLE|VAR)
7840 study[(SCALAR)]
7841 sub [NAME [(format)]] { BODY } sub NAME [(format)]; sub [(format)] {...}
7842 substr(EXPR,OFFSET[,LEN])
7843 symlink(OLDFILE,NEWFILE)
7844 syscall(LIST)
7845 sysread(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7846 system([TRUENAME] ARGV0 [,ARGV]) or system(SHELL_COMMAND_LINE)
7847 syswrite(FILEHANDLE,SCALAR,LENGTH[,OFFSET])
7848 tell[(FILEHANDLE)]
7849 telldir(DIRHANDLE)
7850 time
7851 times
7852 tr/SEARCHLIST/REPLACEMENTLIST/cds
7853 truncate(FILE|EXPR,LENGTH)
7854 umask[(EXPR)]
7855 undef[(EXPR)]
7856 unless (EXPR) { ... } [ else { ... } ] or EXPR unless EXPR
7857 unlink(LIST)
7858 unpack(TEMPLATE,EXPR)
7859 unshift(ARRAY,LIST)
7860 until (EXPR) { ... } EXPR until EXPR
7861 utime(LIST)
7862 values(%HASH)
7863 vec(EXPR,OFFSET,BITS)
7864 wait
7865 waitpid(PID,FLAGS)
7866 wantarray Returns true if the sub/eval is called in list context.
7867 warn(LIST)
7868 while (EXPR) { ... } EXPR while EXPR
7869 write[(EXPR|FILEHANDLE)]
7870 ... x ... Repeat string or array.
7871 x= ... Repetition assignment.
7872 y/SEARCHLIST/REPLACEMENTLIST/
7873 ... | ... Bitwise or.
7874 ... || ... Logical or.
7875 ~ ... Unary bitwise complement.
7876 #! OS interpreter indicator. If contains `perl', used for options, and -x.
7877 AUTOLOAD {...} Shorthand for `sub AUTOLOAD {...}'.
7878 CORE:: Prefix to access builtin function if imported sub obscures it.
7879 SUPER:: Prefix to lookup for a method in @ISA classes.
7880 DESTROY Shorthand for `sub DESTROY {...}'.
7881 ... EQ ... Obsolete synonym of `eq'.
7882 ... GE ... Obsolete synonym of `ge'.
7883 ... GT ... Obsolete synonym of `gt'.
7884 ... LE ... Obsolete synonym of `le'.
7885 ... LT ... Obsolete synonym of `lt'.
7886 ... NE ... Obsolete synonym of `ne'.
7887 abs [ EXPR ] absolute value
7888 ... and ... Low-precedence synonym for &&.
7889 bless REFERENCE [, PACKAGE] Makes reference into an object of a package.
7890 chomp [LIST] Strips $/ off LIST/$_. Returns count. Special if $/ eq ''!
7891 chr Converts a number to char with the same ordinal.
7892 else Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7893 elsif Part of if/unless {BLOCK} elsif {BLOCK} else {BLOCK}.
7894 exists $HASH{KEY} True if the key exists.
7895 format [NAME] = Start of output format. Ended by a single dot (.) on a line.
7897 glob EXPR Synonym of <EXPR>.
7898 lc [ EXPR ] Returns lowercased EXPR.
7899 lcfirst [ EXPR ] Returns EXPR with lower-cased first letter.
7900 grep EXPR,LIST or grep {BLOCK} LIST Filters LIST via EXPR/BLOCK.
7901 map EXPR, LIST or map {BLOCK} LIST Applies EXPR/BLOCK to elts of LIST.
7902 no PACKAGE [SYMBOL1, ...] Partial reverse for `use'. Runs `unimport' method.
7903 not ... Low-precedence synonym for ! - negation.
7904 ... or ... Low-precedence synonym for ||.
7906 quotemeta [ EXPR ] Quote regexp metacharacters.
7907 qw/WORD1 .../ Synonym of split('', 'WORD1 ...')
7908 readline FH Synonym of <FH>.
7909 readpipe CMD Synonym of `CMD`.
7910 ref [ EXPR ] Type of EXPR when dereferenced.
7911 sysopen FH, FILENAME, MODE [, PERM] (MODE is numeric, see Fcntl.)
7912 tie VAR, PACKAGE, LIST Hide an object behind a simple Perl variable.
7913 tied Returns internal object for a tied data.
7914 uc [ EXPR ] Returns upcased EXPR.
7915 ucfirst [ EXPR ] Returns EXPR with upcased first letter.
7916 untie VAR Unlink an object from a simple Perl variable.
7917 use PACKAGE [SYMBOL1, ...] Compile-time `require' with consequent `import'.
7918 ... xor ... Low-precedence synonym for exclusive or.
7920 =head1 Top-level heading.
7921 =head2 Second-level heading.
7922 =head3 Third-level heading (is there such?).
7923 =over [ NUMBER ] Start list.
7924 =item [ TITLE ] Start new item in the list.
7925 =back End list.
7926 =cut Switch from POD to Perl.
7927 =pod Switch from Perl to POD.
7928 ")
7930 (defun cperl-switch-to-doc-buffer (&optional interactive)
7931 "Go to the perl documentation buffer and insert the documentation."
7932 (interactive "p")
7933 (let ((buf (get-buffer-create cperl-doc-buffer)))
7934 (if interactive
7935 (switch-to-buffer-other-window buf)
7936 (set-buffer buf))
7937 (if (= (buffer-size) 0)
7938 (progn
7939 (insert (documentation-property 'cperl-short-docs
7940 'variable-documentation))
7941 (setq buffer-read-only t)))))
7943 (defun cperl-beautify-regexp-piece (b e embed level)
7944 ;; b is before the starting delimiter, e before the ending
7945 ;; e should be a marker, may be changed, but remains "correct".
7946 ;; EMBED is nil if we process the whole REx.
7947 ;; The REx is guaranteed to have //x
7948 ;; LEVEL shows how many levels deep to go
7949 ;; position at enter and at leave is not defined
7950 (let (s c tmp (m (make-marker)) (m1 (make-marker)) c1 spaces inline code pos)
7951 (if (not embed)
7952 (goto-char (1+ b))
7953 (goto-char b)
7955 (forward-char 2)
7956 (delete-char 1)
7957 (forward-char 1))
7959 (forward-char 3))
7961 (forward-char 2))
7962 (t
7963 (forward-char 1))))
7964 (setq c (if embed (current-indentation) (1- (current-column)))
7965 c1 (+ c (or cperl-regexp-indent-step cperl-indent-level)))
7967 (progn
7969 (goto-char e)
7970 (beginning-of-line)
7972 (progn ; Something before the ending delimiter
7973 (goto-char e)
7974 (delete-horizontal-space)
7976 (cperl-make-indent c)
7977 (set-marker e (point))))
7978 (goto-char b)
7979 (end-of-line 2)
7980 (while (< (point) (marker-position e))
7981 (beginning-of-line)
7982 (setq s (point)
7983 inline t)
7985 (delete-region s (point))
7986 (cperl-make-indent c1)
7987 (while (and
7988 inline
7989 (looking-at
7994 "[$^]"
8003 (goto-char (match-end 0))
8004 (setq spaces t)
8005 (cond ((match-beginning 1) ; Alphanum word + junk
8006 (forward-char -1))
8007 ((or (match-beginning 3) ; $ab[12]
8008 (and (match-beginning 5) ; X* X+ X{2,3}
8009 (eq (preceding-char) ?\{)))
8010 (forward-char -1)
8011 (forward-sexp 1))
8012 ((and ; [], already syntaxified
8013 (match-beginning 6)
8014 cperl-regexp-scan
8015 cperl-use-syntax-table-text-property)
8016 (forward-char -1)
8017 (forward-sexp 1)
8018 (or (eq (preceding-char) ?\])
8019 (error "[]-group not terminated"))
8020 (re-search-forward
8022 ((match-beginning 6) ; []
8023 (setq tmp (point))
8025 (goto-char (match-end 0)))
8026 ;; XXXX POSIX classes?!
8027 (while (and (not pos)
8029 (if (eq (preceding-char) ?:)
8031 (error "[:POSIX:]-group in []-group not terminated"))
8032 (setq pos t)))
8033 (or (eq (preceding-char) ?\])
8034 (error "[]-group not terminated"))
8035 (re-search-forward
8037 ((match-beginning 7) ; ()
8038 (goto-char (match-beginning 0))
8039 (setq pos (current-column))
8040 (or (eq pos c1)
8041 (progn
8042 (delete-horizontal-space)
8044 (cperl-make-indent c1)))
8045 (setq tmp (point))
8046 (forward-sexp 1)
8047 ;; (or (forward-sexp 1)
8048 ;; (progn
8049 ;; (goto-char tmp)
8050 ;; (error "()-group not terminated")))
8051 (set-marker m (1- (point)))
8052 (set-marker m1 (point))
8053 (if (= level 1)
8054 (if (progn ; indent rigidly if multiline
8055 ;; In fact does not make a lot of sense, since
8056 ;; the starting position can be already lost due
8058 (goto-char tmp)
8060 (indent-rigidly (point) m1 (- c1 pos)))
8061 (setq level (1- level))
8062 (cond
8063 ((not (match-beginning 8))
8064 (cperl-beautify-regexp-piece tmp m t level))
8065 ((eq (char-after (+ 2 tmp)) ?\{) ; Code
8066 t)
8067 ((eq (char-after (+ 2 tmp)) ?\() ; Conditional
8068 (goto-char (+ 2 tmp))
8069 (forward-sexp 1)
8070 (cperl-beautify-regexp-piece (point) m t level))
8071 ((eq (char-after (+ 2 tmp)) ?<) ; Lookbehind
8072 (goto-char (+ 3 tmp))
8073 (cperl-beautify-regexp-piece (point) m t level))
8074 (t
8075 (cperl-beautify-regexp-piece tmp m t level))))
8076 (goto-char m1)
8078 (goto-char (match-end 0)))
8079 ((eq (following-char) ?\{)
8080 (forward-sexp 1)
8082 (forward-char))))
8084 (setq spaces nil)
8086 (progn
8087 (or (eolp) (indent-for-comment))
8088 (beginning-of-line 2))
8089 (delete-horizontal-space)
8091 (end-of-line)
8092 (setq inline nil))
8093 ((match-beginning 9) ; |
8094 (forward-char -1)
8095 (setq tmp (point))
8096 (beginning-of-line)
8098 (progn
8099 (goto-char tmp)
8100 (delete-horizontal-space)
8102 ;; first at line
8103 (delete-region (point) tmp))
8104 (cperl-make-indent c)
8105 (forward-char 1)
8107 (setq spaces nil)
8109 (beginning-of-line 2)
8110 (delete-horizontal-space)
8112 (end-of-line)
8113 (setq inline nil)))
8115 (not spaces)
8116 (insert " "))
8119 (error "Unknown code `%s' in a regexp"
8120 (buffer-substring (point) (1+ (point)))))
8121 (and inline (end-of-line 2)))
8122 ;; Special-case the last line of group
8123 (if (and (>= (point) (marker-position e))
8124 (/= (current-indentation) c))
8125 (progn
8126 (beginning-of-line)
8127 (cperl-make-indent c)))))
8129 (defun cperl-make-regexp-x ()
8130 ;; Returns position of the start
8131 ;; XXX this is called too often! Need to cache the result!
8132 (save-excursion
8133 (or cperl-use-syntax-table-text-property
8134 (error "I need to have a regexp marked!"))
8135 ;; Find the start
8137 nil ; good already
8139 (forward-char 1)
8141 ;;(forward-char 1)
8142 (let ((b (point)) (e (make-marker)) have-x delim (c (current-column))
8143 (sub-p (eq (preceding-char) ?s)) s)
8144 (forward-sexp 1)
8145 (set-marker e (1- (point)))
8146 (setq delim (preceding-char))
8147 (if (and sub-p (eq delim (char-after (- (point) 2))))
8148 (error "Possible s/blah// - do not know how to deal with"))
8149 (if sub-p (forward-sexp 1))
8151 (setq have-x t)
8152 (insert "x"))
8153 ;; Protect fragile " ", "#"
8154 (if have-x nil
8155 (goto-char (1+ b))
8156 (while (re-search-forward "\\(\\=\\|[^\\\\]\\)\\(\\\\\\\\\\)*[ \t\n#]" e t) ; Need to include (?#) too?
8157 (forward-char -1)
8159 (forward-char 1)))
8160 b)))
8162 (defun cperl-beautify-regexp (&optional deep)
8163 "Do it. (Experimental, may change semantics, recheck the result.)
8164 We suppose that the regexp is scanned already."
8165 (interactive "P")
8166 (setq deep (if deep (prefix-numeric-value deep) -1))
8167 (save-excursion
8168 (goto-char (cperl-make-regexp-x))
8169 (let ((b (point)) (e (make-marker)))
8170 (forward-sexp 1)
8171 (set-marker e (1- (point)))
8172 (cperl-beautify-regexp-piece b e nil deep))))
8174 (defun cperl-regext-to-level-start ()
8175 "Goto start of an enclosing group in regexp.
8176 We suppose that the regexp is scanned already."
8177 (interactive)
8178 (let ((limit (cperl-make-regexp-x)) done)
8179 (while (not done)
8180 (or (eq (following-char) ?\()
8181 (search-backward "(" (1+ limit) t)
8182 (error "Cannot find `(' which starts a group"))
8183 (setq done
8184 (save-excursion
8187 (or done (forward-char -1)))))
8189 (defun cperl-contract-level ()
8190 "Find an enclosing group in regexp and contract it.
8191 \(Experimental, may change semantics, recheck the result.)
8192 We suppose that the regexp is scanned already."
8193 (interactive)
8194 ;; (save-excursion ; Can't, breaks `cperl-contract-levels'
8195 (cperl-regext-to-level-start)
8196 (let ((b (point)) (e (make-marker)) c)
8197 (forward-sexp 1)
8198 (set-marker e (1- (point)))
8199 (goto-char b)
8201 (cond
8202 ((match-beginning 1) ; #-comment
8203 (or c (setq c (current-indentation)))
8204 (beginning-of-line 2) ; Skip
8205 (cperl-make-indent c))
8206 (t
8207 (delete-char -1)
8208 (just-one-space))))))
8210 (defun cperl-contract-levels ()
8211 "Find an enclosing group in regexp and contract all the kids.
8212 \(Experimental, may change semantics, recheck the result.)
8213 We suppose that the regexp is scanned already."
8214 (interactive)
8215 (save-excursion
8216 (condition-case nil
8217 (cperl-regext-to-level-start)
8218 (error ; We are outside outermost group
8219 (goto-char (cperl-make-regexp-x))))
8220 (let ((b (point)) (e (make-marker)) s c)
8221 (forward-sexp 1)
8222 (set-marker e (1- (point)))
8223 (goto-char (1+ b))
8225 (cond
8226 ((match-beginning 1) ; Skip
8227 nil)
8228 (t ; Group
8229 (cperl-contract-level)))))))
8231 (defun cperl-beautify-level (&optional deep)
8232 "Find an enclosing group in regexp and beautify it.
8233 \(Experimental, may change semantics, recheck the result.)
8234 We suppose that the regexp is scanned already."
8235 (interactive "P")
8236 (setq deep (if deep (prefix-numeric-value deep) -1))
8237 (save-excursion
8238 (cperl-regext-to-level-start)
8239 (let ((b (point)) (e (make-marker)))
8240 (forward-sexp 1)
8241 (set-marker e (1- (point)))
8242 (cperl-beautify-regexp-piece b e nil deep))))
8244 (defun cperl-invert-if-unless-modifiers ()
8245 "Change `B if A;' into `if (A) {B}' etc if possible.
8246 \(Unfinished.)"
8247 (interactive) ;
8248 (let (A B pre-B post-B pre-if post-if pre-A post-A if-string
8250 (and (= (char-syntax (preceding-char)) ?w)
8251 (forward-sexp -1))
8252 (setq pre-if (point))
8253 (cperl-backward-to-start-of-expr)
8254 (setq pre-B (point))
8255 (forward-sexp 1) ; otherwise forward-to-end-of-expr is NOP
8256 (cperl-forward-to-end-of-expr)
8257 (setq post-A (point))
8258 (goto-char pre-if)
8259 (or (looking-at w-rex)
8260 ;; Find the position
8261 (progn (goto-char post-A)
8262 (while (and
8263 (not (looking-at w-rex))
8264 (> (point) pre-B))
8265 (forward-sexp -1))
8266 (setq pre-if (point))))
8267 (or (looking-at w-rex)
8268 (error "Can't find `if', `unless', `while', `until', `for' or `foreach'"))
8269 ;; 1 B 2 ... 3 B-com ... 4 if 5 ... if-com 6 ... 7 A 8
8270 (setq if-string (buffer-substring (match-beginning 0) (match-end 0)))
8271 ;; First, simple part: find code boundaries
8272 (forward-sexp 1)
8273 (setq post-if (point))
8274 (forward-sexp -2)
8275 (forward-sexp 1)
8276 (setq post-B (point))
8277 (cperl-backward-to-start-of-expr)
8278 (setq pre-B (point))
8279 (setq B (buffer-substring pre-B post-B))
8280 (goto-char pre-if)
8281 (forward-sexp 2)
8282 (forward-sexp -1)
8283 ;; May be after $, @, $# etc of a variable
8284 (skip-chars-backward "$@%#")
8285 (setq pre-A (point))
8286 (cperl-forward-to-end-of-expr)
8287 (setq post-A (point))
8288 (setq A (buffer-substring pre-A post-A))
8289 ;; Now modify (from end, to not break the stuff)
8291 (delete-region pre-A (point)) ; we move to pre-A
8294 (delete-region pre-if post-if)
8295 (delete-region pre-B post-B)
8296 (goto-char pre-B)
8297 (insert if-string " (" A ") {")
8298 (setq post-B (point))
8300 (delete-horizontal-space)
8302 (cperl-indent-for-comment)
8303 (just-one-space)))
8304 (forward-line 1)
8306 (progn ; delete line
8307 (delete-horizontal-space)
8308 (delete-region (point) (1+ (point)))))
8309 (cperl-indent-line)
8310 (goto-char (1- post-B))
8311 (forward-sexp 1)
8312 (cperl-indent-line)
8313 (goto-char pre-B)))
8315 (defun cperl-invert-if-unless ()
8316 "Change `if (A) {B}' into `B if A;' etc (or visa versa) if possible.
8317 If the cursor is not on the leading keyword of the BLOCK flavor of
8318 construct, will assume it is the STATEMENT flavor, so will try to find
8319 the appropriate statement modifier."
8320 (interactive)
8321 (and (= (char-syntax (preceding-char)) ?w)
8322 (forward-sexp -1))
8324 (let ((pre-if (point))
8325 pre-A post-A pre-B post-B A B state p end-B-code is-block B-comment
8326 (if-string (buffer-substring (match-beginning 0) (match-end 0))))
8327 (forward-sexp 2)
8328 (setq post-A (point))
8329 (forward-sexp -1)
8330 (setq pre-A (point))
8331 (setq is-block (and (eq (following-char) ?\( )
8332 (save-excursion
8333 (condition-case nil
8334 (progn
8335 (forward-sexp 2)
8336 (forward-sexp -1)
8337 (eq (following-char) ?\{ ))
8338 (error nil)))))
8339 (if is-block
8340 (progn
8341 (goto-char post-A)
8342 (forward-sexp 1)
8343 (setq post-B (point))
8344 (forward-sexp -1)
8345 (setq pre-B (point))
8346 (if (and (eq (following-char) ?\{ )
8347 (progn
8348 (cperl-backward-to-noncomment post-A)
8349 (eq (preceding-char) ?\) )))
8350 (if (condition-case nil
8351 (progn
8352 (goto-char post-B)
8353 (forward-sexp 1)
8354 (forward-sexp -1)
8356 (error nil))
8357 (error
8358 "`%s' (EXPR) {BLOCK} with `else'/`elsif'" if-string)
8359 (goto-char (1- post-B))
8360 (cperl-backward-to-noncomment pre-B)
8361 (if (eq (preceding-char) ?\;)
8362 (forward-char -1))
8363 (setq end-B-code (point))
8364 (goto-char pre-B)
8365 (while (re-search-forward "\\<\\(for\\|foreach\\|if\\|unless\\|while\\|until\\)\\>\\|;" end-B-code t)
8366 (setq p (match-beginning 0)
8367 A (buffer-substring p (match-end 0))
8368 state (parse-partial-sexp pre-B p))
8369 (or (nth 3 state)
8370 (nth 4 state)
8371 (nth 5 state)
8372 (error "`%s' inside `%s' BLOCK" A if-string))
8373 (goto-char (match-end 0)))
8374 ;; Finally got it
8375 (goto-char (1+ pre-B))
8377 (setq B (buffer-substring (point) end-B-code))
8378 (goto-char end-B-code)
8380 (progn
8382 (setq B-comment
8383 (buffer-substring (point) (1- post-B)))))
8384 (and (equal B "")
8385 (setq B "1"))
8386 (goto-char (1- post-A))
8387 (cperl-backward-to-noncomment pre-A)
8389 (goto-char (1- post-A)))
8390 (setq p (point))
8391 (goto-char (1+ pre-A))
8393 (setq A (buffer-substring (point) p))
8394 (delete-region pre-B post-B)
8395 (delete-region pre-A post-A)
8396 (goto-char pre-if)
8397 (insert B " ")
8398 (and B-comment (insert B-comment " "))
8399 (just-one-space)
8400 (forward-word 1)
8401 (setq pre-A (point))
8402 (insert " " A ";")
8403 (delete-horizontal-space)
8404 (setq post-B (point))
8405 (if (looking-at "#")
8406 (indent-for-comment))
8407 (goto-char post-B)
8408 (forward-char -1)
8409 (delete-horizontal-space)
8410 (goto-char pre-A)
8411 (just-one-space)
8412 (goto-char pre-if)
8413 (setq pre-A (set-marker (make-marker) pre-A))
8414 (while (<= (point) (marker-position pre-A))
8415 (cperl-indent-line)
8416 (forward-line 1))
8417 (goto-char (marker-position pre-A))
8418 (if B-comment
8419 (progn
8420 (forward-line -1)
8421 (indent-for-comment)
8422 (goto-char (marker-position pre-A)))))
8423 (error "`%s' (EXPR) not with an {BLOCK}" if-string)))
8424 ;; (error "`%s' not with an (EXPR)" if-string)
8425 (forward-sexp -1)
8426 (cperl-invert-if-unless-modifiers)))
8427 ;;(error "Not at `if', `unless', `while', `until', `for' or `foreach'")
8428 (cperl-invert-if-unless-modifiers)))
8430 ;;; By Anthony Foiani <afoiani@uswest.com>
8431 ;;; Getting help on modules in C-h f ?
8432 ;;; This is a modified version of `man'.
8433 ;;; Need to teach it how to lookup functions
8434 ;;;###autoload
8435 (defun cperl-perldoc (word)
8436 "Run `perldoc' on WORD."
8437 (interactive
8438 (list (let* ((default-entry (cperl-word-at-point))
8439 (input (read-string
8440 (format "perldoc entry%s: "
8441 (if (string= default-entry "")
8442 ""
8443 (format " (default %s)" default-entry))))))
8444 (if (string= input "")
8445 (if (string= default-entry "")
8446 (error "No perldoc args given")
8447 default-entry)
8448 input))))
8449 (require 'man)
8450 (let* ((case-fold-search nil)
8451 (is-func (and
8452 (string-match "^[a-z]+$" word)
8454 (documentation-property
8455 'cperl-short-docs
8456 'variable-documentation))))
8457 (manual-program (if is-func "perldoc -f" "perldoc")))
8458 (cond
8459 ((featurep 'xemacs)
8460 (let ((Manual-program "perldoc")
8461 (Manual-switches (if is-func (list "-f"))))
8462 (manual-entry word)))
8463 (t
8464 (Man-getpage-in-background word)))))
8466 ;;;###autoload
8467 (defun cperl-perldoc-at-point ()
8468 "Run a `perldoc' on the word around point."
8469 (interactive)
8470 (cperl-perldoc (cperl-word-at-point)))
8472 (defcustom pod2man-program "pod2man"
8473 "*File name for `pod2man'."
8474 :type 'file
8475 :group 'cperl)
8477 ;;; By Nick Roberts <Nick.Roberts@src.bae.co.uk> (with changes)
8478 (defun cperl-pod-to-manpage ()
8479 "Create a virtual manpage in Emacs from the Perl Online Documentation."
8480 (interactive)
8481 (require 'man)
8482 (let* ((pod2man-args (concat buffer-file-name " | nroff -man "))
8483 (bufname (concat "Man " buffer-file-name))
8484 (buffer (generate-new-buffer bufname)))
8485 (save-excursion
8486 (set-buffer buffer)
8487 (let ((process-environment (copy-sequence process-environment)))
8488 ;; Prevent any attempt to use display terminal fanciness.
8489 (setenv "TERM" "dumb")
8490 (set-process-sentinel
8491 (start-process pod2man-program buffer "sh" "-c"
8492 (format (cperl-pod2man-build-command) pod2man-args))
8493 'Man-bgproc-sentinel)))))
8495 ;;; Updated version by him too
8496 (defun cperl-build-manpage ()
8497 "Create a virtual manpage in Emacs from the POD in the file."
8498 (interactive)
8499 (require 'man)
8500 (cond
8501 ((featurep 'xemacs)
8502 (let ((Manual-program "perldoc"))
8503 (manual-entry buffer-file-name)))
8504 (t
8505 (let* ((manual-program "perldoc"))
8506 (Man-getpage-in-background buffer-file-name)))))
8508 (defun cperl-pod2man-build-command ()
8509 "Builds the entire background manpage and cleaning command."
8510 (let ((command (concat pod2man-program " %s 2>/dev/null"))
8511 (flist (and (boundp 'Man-filter-list) Man-filter-list)))
8512 (while (and flist (car flist))
8513 (let ((pcom (car (car flist)))
8514 (pargs (cdr (car flist))))
8515 (setq command
8516 (concat command " | " pcom " "
8517 (mapconcat '(lambda (phrase)
8518 (if (not (stringp phrase))
8519 (error "Malformed Man-filter-list"))
8520 phrase)
8521 pargs " ")))
8522 (setq flist (cdr flist))))
8523 command))
8526 (defun cperl-next-interpolated-REx-1 ()
8527 "Move point to next REx which has interpolated parts without //o.
8528 Skips RExes consisting of one interpolated variable.
8530 Note that skipped RExen are not performance hits."
8531 (interactive "")
8532 (cperl-next-interpolated-REx 1))
8534 (defun cperl-next-interpolated-REx-0 ()
8535 "Move point to next REx which has interpolated parts without //o."
8536 (interactive "")
8537 (cperl-next-interpolated-REx 0))
8539 (defun cperl-next-interpolated-REx (&optional skip beg limit)
8540 "Move point to next REx which has interpolated parts.
8541 SKIP is a list of possible types to skip, BEG and LIMIT are the starting
8542 point and the limit of search (default to point and end of buffer).
8544 SKIP may be a number, then it behaves as list of numbers up to SKIP; this
8545 semantic may be used as a numeric argument.
8547 Types are 0 for / $rex /o (interpolated once), 1 for /$rex/ (if $rex is
8548 a result of qr//, this is not a performance hit), t for the rest."
8549 (interactive "P")
8550 (if (numberp skip) (setq skip (list 0 skip)))
8551 (or beg (setq beg (point)))
8552 (or limit (setq limit (point-max))) ; needed for n-s-p-c
8553 (let (pp)
8554 (and (eq (get-text-property beg 'syntax-type) 'string)
8555 (setq beg (next-single-property-change beg 'syntax-type nil limit)))
8556 (cperl-map-pods-heres
8557 (function (lambda (s e p)
8558 (if (memq (get-text-property s 'REx-interpolated) skip)
8559 t
8560 (setq pp s)
8561 nil))) ; nil stops
8562 'REx-interpolated beg limit)
8563 (if pp (goto-char pp)
8564 (message "No more interpolated REx"))))
8566 ;;; Initial version contributed by Trey Belew
8567 (defun cperl-here-doc-spell (&optional beg end)
8568 "Spell-check HERE-documents in the Perl buffer.
8569 If a region is highlighted, restricts to the region."
8570 (interactive "")
8571 (cperl-pod-spell t beg end))
8573 (defun cperl-pod-spell (&optional do-heres beg end)
8574 "Spell-check POD documentation.
8575 If invoked with prefix argument, will do HERE-DOCs instead.
8576 If a region is highlighted, restricts to the region."
8577 (interactive "P")
8578 (save-excursion
8579 (let (beg end)
8580 (if (cperl-mark-active)
8581 (setq beg (min (mark) (point))
8582 end (max (mark) (point)))
8583 (setq beg (point-min)
8584 end (point-max)))
8585 (cperl-map-pods-heres (function
8586 (lambda (s e p)
8587 (if do-heres
8588 (setq e (save-excursion
8589 (goto-char e)
8590 (forward-line -1)
8591 (point))))
8592 (ispell-region s e)
8593 t))
8594 (if do-heres 'here-doc-group 'in-pod)
8595 beg end))))
8597 (defun cperl-map-pods-heres (func &optional prop s end)
8598 "Executes a function over regions of pods or here-documents.
8599 PROP is the text-property to search for; default to `in-pod'. Stop when
8600 function returns nil."
8601 (let (pos posend has-prop (cont t))
8602 (or prop (setq prop 'in-pod))
8603 (or s (setq s (point-min)))
8604 (or end (setq end (point-max)))
8605 (cperl-update-syntaxification end end)
8606 (save-excursion
8607 (goto-char (setq pos s))
8608 (while (and cont (< pos end))
8609 (setq has-prop (get-text-property pos prop))
8610 (setq posend (next-single-property-change pos prop nil end))
8611 (and has-prop
8612 (setq cont (funcall func pos posend prop)))
8613 (setq pos posend)))))
8615 ;;; Based on code by Masatake YAMATO:
8616 (defun cperl-get-here-doc-region (&optional pos pod)
8617 "Return HERE document region around the point.
8618 Return nil if the point is not in a HERE document region. If POD is non-nil,
8619 will return a POD section if point is in a POD section."
8620 (or pos (setq pos (point)))
8621 (cperl-update-syntaxification pos pos)
8622 (if (or (eq 'here-doc (get-text-property pos 'syntax-type))
8623 (and pod
8624 (eq 'pod (get-text-property pos 'syntax-type))))
8625 (let ((b (cperl-beginning-of-property pos 'syntax-type))
8626 (e (next-single-property-change pos 'syntax-type)))
8627 (cons b (or e (point-max))))))
8629 (defun cperl-narrow-to-here-doc (&optional pos)
8630 "Narrows editing region to the HERE-DOC at POS.
8631 POS defaults to the point."
8632 (interactive "d")
8633 (or pos (setq pos (point)))
8634 (let ((p (cperl-get-here-doc-region pos)))
8635 (or p (error "Not inside a HERE document"))
8636 (narrow-to-region (car p) (cdr p))
8637 (message
8638 "When you are finished with narrow editing, type C-x n w")))
8640 (defun cperl-select-this-pod-or-here-doc (&optional pos)
8641 "Select the HERE-DOC (or POD section) at POS.
8642 POS defaults to the point."
8643 (interactive "d")
8644 (let ((p (cperl-get-here-doc-region pos t)))
8645 (if p
8646 (progn
8647 (goto-char (car p))
8648 (push-mark (cdr p) nil t)) ; Message, activate in transient-mode
8649 (message "I do not think POS is in POD or a HERE-doc..."))))
8651 (defun cperl-facemenu-add-face-function (face end)
8652 "A callback to process user-initiated font-change requests.
8653 Translates `bold', `italic', and `bold-italic' requests to insertion of
8654 corresponding POD directives, and `underline' to C<> POD directive.
8656 Such requests are usually bound to M-o LETTER."
8657 (or (get-text-property (point) 'in-pod)
8658 (error "Faces can only be set within POD"))
8659 (setq facemenu-end-add-face (if (eq face 'bold-italic) ">>" ">"))
8660 (cdr (or (assq face '((bold . "B<")
8661 (italic . "I<")
8662 (bold-italic . "B<I<")
8663 (underline . "C<")))
8664 (error "Face %s not configured for cperl-mode"
8665 face))))
8666 \f
8667 (defun cperl-time-fontification (&optional l step lim)
8668 "Times how long it takes to do incremental fontification in a region.
8669 L is the line to start at, STEP is the number of lines to skip when
8670 doing next incremental fontification, LIM is the maximal number of
8671 incremental fontification to perform. Messages are accumulated in
8672 *Messages* buffer.
8674 May be used for pinpointing which construct slows down buffer fontification:
8675 start with default arguments, then refine the slowdown regions."
8677 (or l (setq l 1))
8678 (or step (setq step 500))
8679 (or lim (setq lim 40))
8680 (let* ((timems (function (lambda ()
8681 (let ((tt (current-time)))
8682 (+ (* 1000 (nth 1 tt)) (/ (nth 2 tt) 1000))))))
8683 (tt (funcall timems)) (c 0) delta tot)
8684 (goto-line l)
8685 (cperl-mode)
8686 (setq tot (- (- tt (setq tt (funcall timems)))))
8687 (message "cperl-mode at %s: %s" l tot)
8688 (while (and (< c lim) (not (eobp)))
8689 (forward-line step)
8690 (setq l (+ l step))
8691 (setq c (1+ c))
8692 (cperl-update-syntaxification (point) (point))
8693 (setq delta (- (- tt (setq tt (funcall timems)))) tot (+ tot delta))
8694 (message "to %s:%6s,%7s" l delta tot))
8695 tot))
8697 (defvar font-lock-cache-position)
8699 (defun cperl-emulate-lazy-lock (&optional window-size)
8700 "Emulate `lazy-lock' without `condition-case', so `debug-on-error' works.
8701 Start fontifying the buffer from the start (or end) using the given
8702 WINDOW-SIZE (units is lines). Negative WINDOW-SIZE starts at end, and
8703 goes backwards; default is -50. This function is not CPerl-specific; it
8704 may be used to debug problems with delayed incremental fontification."
8705 (interactive
8706 "nSize of window for incremental fontification, negative goes backwards: ")
8707 (or window-size (setq window-size -50))
8708 (let ((pos (if (> window-size 0)
8709 (point-min)
8710 (point-max)))
8711 p)
8712 (goto-char pos)
8713 (normal-mode)
8714 ;; Why needed??? With older font-locks???
8715 (set (make-local-variable 'font-lock-cache-position) (make-marker))
8716 (while (if (> window-size 0)
8717 (< pos (point-max))
8718 (> pos (point-min)))
8719 (setq p (progn
8720 (forward-line window-size)
8721 (point)))
8722 (font-lock-fontify-region (min p pos) (max p pos))
8723 (setq pos p))))
8725 \f
8726 (defun cperl-lazy-install ()) ; Avoid a warning
8727 (defun cperl-lazy-unstall ()) ; Avoid a warning
8729 (if (fboundp 'run-with-idle-timer)
8730 (progn
8731 (defvar cperl-help-shown nil
8732 "Non-nil means that the help was already shown now.")
8734 (defvar cperl-lazy-installed nil
8735 "Non-nil means that the lazy-help handlers are installed now.")
8737 (defun cperl-lazy-install ()
8738 "Switches on Auto-Help on Perl constructs (put in the message area).
8739 Delay of auto-help controlled by `cperl-lazy-help-time'."
8740 (interactive)
8741 (make-local-variable 'cperl-help-shown)
8742 (if (and (cperl-val 'cperl-lazy-help-time)
8743 (not cperl-lazy-installed))
8744 (progn
8745 (add-hook 'post-command-hook 'cperl-lazy-hook)
8746 (run-with-idle-timer
8747 (cperl-val 'cperl-lazy-help-time 1000000 5)
8748 t
8749 'cperl-get-help-defer)
8750 (setq cperl-lazy-installed t))))
8752 (defun cperl-lazy-unstall ()
8753 "Switches off Auto-Help on Perl constructs (put in the message area).
8754 Delay of auto-help controlled by `cperl-lazy-help-time'."
8755 (interactive)
8756 (remove-hook 'post-command-hook 'cperl-lazy-hook)
8757 (cancel-function-timers 'cperl-get-help-defer)
8758 (setq cperl-lazy-installed nil))
8760 (defun cperl-lazy-hook ()
8761 (setq cperl-help-shown nil))
8763 (defun cperl-get-help-defer ()
8764 (if (not (memq major-mode '(perl-mode cperl-mode))) nil
8765 (let ((cperl-message-on-help-error nil) (cperl-help-from-timer t))
8766 (cperl-get-help)
8767 (setq cperl-help-shown t))))
8768 (cperl-lazy-install)))
8771 ;;; Plug for wrong font-lock:
8773 (defun cperl-font-lock-unfontify-region-function (beg end)
8774 (let* ((modified (buffer-modified-p)) (buffer-undo-list t)
8775 (inhibit-read-only t) (inhibit-point-motion-hooks t)
8776 before-change-functions after-change-functions
8777 deactivate-mark buffer-file-name buffer-file-truename)
8778 (remove-text-properties beg end '(face nil))
8779 (if (and (not modified) (buffer-modified-p))
8780 (set-buffer-modified-p nil))))
8782 (defun cperl-font-lock-fontify-region-function (beg end loudly)
8783 "Extends the region to safe positions, then calls the default function.
8784 Newer `font-lock's can do it themselves.
8785 We unwind only as far as needed for fontification. Syntaxification may
8786 do extra unwind via `cperl-unwind-to-safe'."
8787 (save-excursion
8788 (goto-char beg)
8789 (while (and beg
8790 (progn
8791 (beginning-of-line)
8792 (eq (get-text-property (setq beg (point)) 'syntax-type)
8793 'multiline)))
8794 (if (setq beg (cperl-beginning-of-property beg 'syntax-type))
8795 (goto-char beg)))
8796 (setq beg (point))
8797 (goto-char end)
8798 (while (and end
8799 (progn
8800 (or (bolp) (condition-case nil
8801 (forward-line 1)
8802 (error nil)))
8803 (eq (get-text-property (setq end (point)) 'syntax-type)
8804 'multiline)))
8805 (setq end (next-single-property-change end 'syntax-type nil (point-max)))
8806 (goto-char end))
8807 (setq end (point)))
8808 (font-lock-default-fontify-region beg end loudly))
8810 (defvar cperl-d-l nil)
8811 (defun cperl-fontify-syntaxically (end)
8812 ;; Some vars for debugging only
8813 ;; (message "Syntaxifying...")
8814 (let ((dbg (point)) (iend end) (idone cperl-syntax-done-to)
8815 (istate (car cperl-syntax-state))
8816 start from-start edebug-backtrace-buffer)
8817 (if (eq cperl-syntaxify-by-font-lock 'backtrace)
8818 (progn
8819 (require 'edebug)
8820 (let ((f 'edebug-backtrace))
8821 (funcall f)))) ; Avoid compile-time warning
8822 (or cperl-syntax-done-to
8823 (setq cperl-syntax-done-to (point-min)
8824 from-start t))
8825 (setq start (if (and cperl-hook-after-change
8826 (not from-start))
8827 cperl-syntax-done-to ; Fontify without change; ignore start
8828 ;; Need to forget what is after `start'
8829 (min cperl-syntax-done-to (point))))
8830 (goto-char start)
8831 (beginning-of-line)
8832 (setq start (point))
8833 (and cperl-syntaxify-unwind
8834 (setq end (cperl-unwind-to-safe t end)
8835 start (point)))
8836 (and (> end start)
8837 (setq cperl-syntax-done-to start) ; In case what follows fails
8838 (cperl-find-pods-heres start end t nil t))
8839 (if (memq cperl-syntaxify-by-font-lock '(backtrace message))
8840 (message "Syxify req=%s..%s actual=%s..%s done-to: %s=>%s statepos: %s=>%s"
8841 dbg iend start end idone cperl-syntax-done-to
8842 istate (car cperl-syntax-state))) ; For debugging
8843 nil)) ; Do not iterate
8845 (defun cperl-fontify-update (end)
8846 (let ((pos (point-min)) prop posend)
8847 (setq end (point-max))
8848 (while (< pos end)
8849 (setq prop (get-text-property pos 'cperl-postpone)
8850 posend (next-single-property-change pos 'cperl-postpone nil end))
8851 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8852 (setq pos posend)))
8853 nil) ; Do not iterate
8855 (defun cperl-fontify-update-bad (end)
8856 ;; Since fontification happens with different region than syntaxification,
8857 ;; do to the end of buffer, not to END;;; likewise, start earlier if needed
8858 (let* ((pos (point)) (prop (get-text-property pos 'cperl-postpone)) posend)
8859 (if prop
8860 (setq pos (or (cperl-beginning-of-property
8861 (cperl-1+ pos) 'cperl-postpone)
8862 (point-min))))
8863 (while (< pos end)
8864 (setq posend (next-single-property-change pos 'cperl-postpone))
8865 (and prop (put-text-property pos posend (car prop) (cdr prop)))
8866 (setq pos posend)
8867 (setq prop (get-text-property pos 'cperl-postpone))))
8868 nil) ; Do not iterate
8870 ;; Called when any modification is made to buffer text.
8871 (defun cperl-after-change-function (beg end old-len)
8872 ;; We should have been informed about changes by `font-lock'. Since it
8873 ;; does not inform as which calls are defered, do it ourselves
8874 (if cperl-syntax-done-to
8875 (setq cperl-syntax-done-to (min cperl-syntax-done-to beg))))
8877 (defun cperl-update-syntaxification (from to)
8878 (if (and cperl-use-syntax-table-text-property
8879 cperl-syntaxify-by-font-lock
8880 (or (null cperl-syntax-done-to)
8881 (< cperl-syntax-done-to to)))
8882 (progn
8883 (save-excursion
8884 (goto-char from)
8885 (cperl-fontify-syntaxically to)))))
8887 (defvar cperl-version
8888 (let ((v "Revision: 5.23"))
8890 (substring v (match-beginning 1) (match-end 1)))
8891 "Version of IZ-supported CPerl package this file is based on.")
8893 (provide 'cperl-mode)
8895 ;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
8896 ;;; cperl-mode.el ends here