comparison lisp/progmodes/cperl-mode.el @ 89909:68c22ea6027c

Sync to HEAD

89908:ee1402f7b568

;;; cperl-mode.el --- Perl code editing commands for Emacs

;; Copyright (C) 1985, 86, 87, 91, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2003
;;     Free Software Foundation, Inc.

;; Author: Ilya Zakharevich and Bob Olson
;; Maintainer: Ilya Zakharevich <[e-mail]>
;; Keywords: languages, Perl

	(cperl-define-key "\e\C-\\" 'cperl-indent-region))
    (substitute-key-definition
     'indent-sexp 'cperl-indent-exp
     cperl-mode-map global-map)
    (substitute-key-definition
     'fill-paragraph 'cperl-fill-paragraph
     cperl-mode-map global-map)
    (substitute-key-definition
     'indent-region 'cperl-indent-region
     cperl-mode-map global-map)
    (substitute-key-definition
     'indent-for-comment 'cperl-indent-for-comment
     cperl-mode-map global-map)))

	'("Perl"
	  ["Beginning of function" beginning-of-defun t]
	  ["End of function" end-of-defun t]
	  ["Mark function" mark-defun t]
	  ["Indent expression" cperl-indent-exp t]
	  ["Fill paragraph/comment" cperl-fill-paragraph t]
	  "----"
	  ["Line up a construction" cperl-lineup (cperl-use-region-p)]
	  ["Invert if/unless/while etc" cperl-invert-if-unless t]
	  ("Regexp"
	   ["Beautify" cperl-beautify-regexp

  (setq paragraph-start (concat "^$\\|" page-delimiter))
  (make-local-variable 'paragraph-separate)
  (setq paragraph-separate paragraph-start)
  (make-local-variable 'paragraph-ignore-fill-prefix)
  (setq paragraph-ignore-fill-prefix t)
  (make-local-variable 'indent-line-function)
  (setq indent-line-function 'cperl-indent-line)
  (make-local-variable 'require-final-newline)
  (setq require-final-newline t)
  (make-local-variable 'comment-start)

				 ;; Do not move `parse-data', this should
				 ;; be quick anyway:
				 (cperl-calculate-indent))
			     (current-indentation))))))))))))))

(defvar cperl-indent-alist
  '((string nil)
    (comment nil)
    (toplevel 0)
    (toplevel-after-parenth 2)
    (toplevel-continued 2)
    (expression 1))
  "Alist of indentation rules for CPerl mode.
The values mean:
  nil: do not indent;
  number: add this amount of indentation.

Not finished, not used.")

(defun cperl-where-am-i (&optional parse-start start-state)
  ;; Unfinished
  "Return a list of lists ((TYPE POS)...) of good points before the point.
POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.

Not finished, not used."
  (save-excursion
    (let* ((start-point (point))
	   (s-s (cperl-get-state))
	   (start (nth 0 s-s))
	   (state (nth 1 s-s))
	   (prestart (nth 3 s-s))
	   (containing-sexp (car (cdr state)))
	   (case-fold-search nil)
	   (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
      (cond ((nth 3 state)		; In string
	     (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
	    ((nth 4 state)		; In comment
	     (setq res (cons '(comment) res)))
	    ((null containing-sexp)
	     ;; Line is at top level.
	     ;; Indent like the previous top level line
	     ;; unless that ends in a closeparen without semicolon,
	     ;; in which case this line is the first argument decl.
	     (cperl-backward-to-noncomment (or parse-start (point-min)))
	     ;;(skip-chars-backward " \t\f\n")
	     (cond
	      ((or (bobp)
		   (memq (preceding-char) (append ";}" nil)))
	       (setq res (cons (list 'toplevel start) res)))
	      ((eq (preceding-char) ?\) )
	       (setq res (cons (list 'toplevel-after-parenth start) res)))
	      (t
	       (setq res (cons (list 'toplevel-continued start) res)))))
	    ((/= (char-after containing-sexp) ?{)
	     ;; line is expression, not statement:
	     ;; indent to just after the surrounding open.
	     ;; skip blanks if we do not close the expression.
	     (setq res (cons (list 'expression-blanks
				   (progn
				     (goto-char (1+ containing-sexp))
				     (or (looking-at "[ \t]*\\(#\\|$\\)")
					 (skip-chars-forward " \t"))
				     (point)))
			     (cons (list 'expression containing-sexp) res))))
	    ((progn
	       ;; Containing-expr starts with \{.  Check whether it is a hash.
	       (goto-char containing-sexp)
	       (not (cperl-block-p)))
	     (setq res (cons (list 'expression-blanks
				   (progn
				     (goto-char (1+ containing-sexp))
				     (or (looking-at "[ \t]*\\(#\\|$\\)")
					 (skip-chars-forward " \t"))
				     (point)))
			     (cons (list 'expression containing-sexp) res))))
	    (t
	     ;; Statement level.
	     (setq res (cons (list 'in-block containing-sexp) res))
	     ;; Is it a continuation or a new statement?
	     ;; Find previous non-comment character.
	     (cperl-backward-to-noncomment containing-sexp)
	     ;; Back up over label lines, since they don't
	     ;; affect whether our line is a continuation.
	     ;; Back up comma-delimited lines too ?????
	     (while (or (eq (preceding-char) ?\,)
			(save-excursion (cperl-after-label)))
	       (if (eq (preceding-char) ?\,)
		   ;; Will go to beginning of line, essentially
		   ;; Will ignore embedded sexpr XXXX.
		   (cperl-backward-to-start-of-continued-exp containing-sexp))
	       (beginning-of-line)
	       (cperl-backward-to-noncomment containing-sexp))
	     ;; Now we get the answer.
	     (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
		 ;; This line is continuation of preceding line's statement.
		 (list (list 'statement-continued containing-sexp))
	       ;; This line starts a new statement.
	       ;; Position following last unclosed open.
	       (goto-char containing-sexp)
	       ;; Is line first statement after an open-brace?
	       (or
		;; If no, find that first statement and indent like
		;; it.  If the first statement begins with label, do
		;; not believe when the indentation of the label is too
		;; small.
		(save-excursion
		  (forward-char 1)
		  (let ((colon-line-end 0))
		    (while (progn (skip-chars-forward " \t\n" start-point)
				  (and (< (point) start-point)
				       (looking-at
					"#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
		      ;; Skip over comments and labels following openbrace.
		      (cond ((= (following-char) ?\#)
			     ;;(forward-line 1)
			     (end-of-line))
			    ;; label:
			    (t
			     (save-excursion (end-of-line)
					     (setq colon-line-end (point)))
			     (search-forward ":"))))
		    ;; Now at the point, after label, or at start
		    ;; of first statement in the block.
		    (and (< (point) start-point)
			 (if (> colon-line-end (point))
			     ;; Before statement after label
			     (if (> (current-indentation)
				    cperl-min-label-indent)
				 (list (list 'label-in-block (point)))
			       ;; Do not believe: `max' is involved
			       (list
				(list 'label-in-block-min-indent (point))))
			   ;; Before statement
			   (list 'statement-in-block (point))))))
		;; If no previous statement,
		;; indent it relative to line brace is on.
		;; For open brace in column zero, don't let statement
		;; start there too.  If cperl-indent-level is zero,
		;; use cperl-brace-offset + cperl-continued-statement-offset instead.
		;; For open-braces not the first thing in a line,
		;; add in cperl-brace-imaginary-offset.

		;; If first thing on a line:  ?????
		(+ (if (and (bolp) (zerop cperl-indent-level))
		       (+ cperl-brace-offset cperl-continued-statement-offset)
		     cperl-indent-level)
		   ;; Move back over whitespace before the openbrace.
		   ;; If openbrace is not first nonwhite thing on the line,
		   ;; add the cperl-brace-imaginary-offset.
		   (progn (skip-chars-backward " \t")
			  (if (bolp) 0 cperl-brace-imaginary-offset))
		   ;; If the openbrace is preceded by a parenthesized exp,
		   ;; move to the beginning of that;
		   ;; possibly a different line
		   (progn
		     (if (eq (preceding-char) ?\))
			 (forward-sexp -1))
		     ;; Get initial indentation of the line we are on.
		     ;; If line starts with label, calculate label indentation
		     (if (save-excursion
			   (beginning-of-line)
			   (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
			 (if (> (current-indentation) cperl-min-label-indent)
			     (- (current-indentation) cperl-label-offset)
			   (cperl-calculate-indent))
		       (current-indentation))))))))
      res)))

(defun cperl-calculate-indent-within-comment ()
  "Return the indentation amount for line, assuming that
the current line is to be regarded as part of a block comment."
  (let (end star-start)

	     (delete-char -1))))))

;; Stolen from lisp-mode with a lot of improvements

(defun cperl-fill-paragraph (&optional justify iteration)
  "Like \\[fill-paragraph], but handle CPerl comments.
If any of the current line is a comment, fill the comment or the
block of it that point is in, preserving the comment's initial
indentation and initial hashes.  Behaves usually outside of comment."
  (interactive "P")
  (let (;; Non-nil if the current line contains a comment.
	has-comment

	;; If has-comment, the appropriate fill-prefix for the comment.
	comment-fill-prefix

	 (save-excursion
	   (while (progn (forward-line 1)
			 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
	   (point)))
	;; Remove existing hashes
	(goto-char (point-min))
	(while (progn (forward-line 1) (< (point) (point-max)))
	  (skip-chars-forward " \t")
	  (and (looking-at "#+")
	       (delete-char (- (match-end 0) (match-beginning 0)))))

	;; Lines with only hashes on them can be paragraph boundaries.
	(let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
	      (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
	      (fill-prefix comment-fill-prefix))

	   (current-column))
	 fill-column)
      (let ((c (save-excursion (beginning-of-line)
			       (cperl-to-comment-or-eol) (point)))
	    (s (memq (following-char) '(?\ ?\t))) marker)
	(if (>= c (point)) nil
	  (setq marker (point-marker))
	  (cperl-fill-paragraph)
	  (goto-char marker)
	  ;; Is not enough, sometimes marker is a start of line
	  (if (bolp) (progn (re-search-forward "#+[ \t]*")
			    (goto-char (match-end 0))))
	  ;; Following space could have gone:

    (substring v (match-beginning 1) (match-end 1)))
  "Version of IZ-supported CPerl package this file is based on.")

(provide 'cperl-mode)

;;; cperl-mode.el ends here

89909:68c22ea6027c

;;; cperl-mode.el --- Perl code editing commands for Emacs

;; Copyright (C) 1985,86,87,91,92,93,94,95,96,97,98,99,2000,03,2004
;;     Free Software Foundation, Inc.

;; Author: Ilya Zakharevich and Bob Olson
;; Maintainer: Ilya Zakharevich <[e-mail]>
;; Keywords: languages, Perl

	(cperl-define-key "\e\C-\\" 'cperl-indent-region))
    (substitute-key-definition
     'indent-sexp 'cperl-indent-exp
     cperl-mode-map global-map)
    (substitute-key-definition
     'indent-region 'cperl-indent-region
     cperl-mode-map global-map)
    (substitute-key-definition
     'indent-for-comment 'cperl-indent-for-comment
     cperl-mode-map global-map)))

	'("Perl"
	  ["Beginning of function" beginning-of-defun t]
	  ["End of function" end-of-defun t]
	  ["Mark function" mark-defun t]
	  ["Indent expression" cperl-indent-exp t]
	  ["Fill paragraph/comment" fill-paragraph t]
	  "----"
	  ["Line up a construction" cperl-lineup (cperl-use-region-p)]
	  ["Invert if/unless/while etc" cperl-invert-if-unless t]
	  ("Regexp"
	   ["Beautify" cperl-beautify-regexp

  (setq paragraph-start (concat "^$\\|" page-delimiter))
  (make-local-variable 'paragraph-separate)
  (setq paragraph-separate paragraph-start)
  (make-local-variable 'paragraph-ignore-fill-prefix)
  (setq paragraph-ignore-fill-prefix t)
  (set (make-local-variable 'fill-paragraph-function) 'cperl-fill-paragraph)
  (make-local-variable 'indent-line-function)
  (setq indent-line-function 'cperl-indent-line)
  (make-local-variable 'require-final-newline)
  (setq require-final-newline t)
  (make-local-variable 'comment-start)

				 ;; Do not move `parse-data', this should
				 ;; be quick anyway:
				 (cperl-calculate-indent))
			     (current-indentation))))))))))))))

;; (defvar cperl-indent-alist
;;   '((string nil)
;;     (comment nil)
;;     (toplevel 0)
;;     (toplevel-after-parenth 2)
;;     (toplevel-continued 2)
;;     (expression 1))
;;   "Alist of indentation rules for CPerl mode.
;; The values mean:
;;   nil: do not indent;
;;   number: add this amount of indentation.

;; Not finished, not used.")

;; (defun cperl-where-am-i (&optional parse-start start-state)
;;   ;; Unfinished
;;   "Return a list of lists ((TYPE POS)...) of good points before the point.
;; ;; POS may be nil if it is hard to find, say, when TYPE is `string' or `comment'.

;; ;; Not finished, not used."
;;   (save-excursion
;;     (let* ((start-point (point))
;; 	   (s-s (cperl-get-state))
;; 	   (start (nth 0 s-s))
;; 	   (state (nth 1 s-s))
;; 	   (prestart (nth 3 s-s))
;; 	   (containing-sexp (car (cdr state)))
;; 	   (case-fold-search nil)
;; 	   (res (list (list 'parse-start start) (list 'parse-prestart prestart))))
;;       (cond ((nth 3 state)		; In string
;; 	     (setq res (cons (list 'string nil (nth 3 state)) res))) ; What started string
;; 	    ((nth 4 state)		; In comment
;; 	     (setq res (cons '(comment) res)))
;; 	    ((null containing-sexp)
;; 	     ;; Line is at top level.
;; 	     ;; Indent like the previous top level line
;; 	     ;; unless that ends in a closeparen without semicolon,
;; 	     ;; in which case this line is the first argument decl.
;; 	     (cperl-backward-to-noncomment (or parse-start (point-min)))
;; 	     ;;(skip-chars-backward " \t\f\n")
;; 	     (cond
;; 	      ((or (bobp)
;; 		   (memq (preceding-char) (append ";}" nil)))
;; 	       (setq res (cons (list 'toplevel start) res)))
;; 	      ((eq (preceding-char) ?\) )
;; 	       (setq res (cons (list 'toplevel-after-parenth start) res)))
;; 	      (t
;; 	       (setq res (cons (list 'toplevel-continued start) res)))))
;; 	    ((/= (char-after containing-sexp) ?{)
;; 	     ;; line is expression, not statement:
;; 	     ;; indent to just after the surrounding open.
;; 	     ;; skip blanks if we do not close the expression.
;; 	     (setq res (cons (list 'expression-blanks
;; 				   (progn
;; 				     (goto-char (1+ containing-sexp))
;; 				     (or (looking-at "[ \t]*\\(#\\|$\\)")
;; 					 (skip-chars-forward " \t"))
;; 				     (point)))
;; 			     (cons (list 'expression containing-sexp) res))))
;; 	    ((progn
;; 	       ;; Containing-expr starts with \{.  Check whether it is a hash.
;; 	       (goto-char containing-sexp)
;; 	       (not (cperl-block-p)))
;; 	     (setq res (cons (list 'expression-blanks
;; 				   (progn
;; 				     (goto-char (1+ containing-sexp))
;; 				     (or (looking-at "[ \t]*\\(#\\|$\\)")
;; 					 (skip-chars-forward " \t"))
;; 				     (point)))
;; 			     (cons (list 'expression containing-sexp) res))))
;; 	    (t
;; 	     ;; Statement level.
;; 	     (setq res (cons (list 'in-block containing-sexp) res))
;; 	     ;; Is it a continuation or a new statement?
;; 	     ;; Find previous non-comment character.
;; 	     (cperl-backward-to-noncomment containing-sexp)
;; 	     ;; Back up over label lines, since they don't
;; 	     ;; affect whether our line is a continuation.
;; 	     ;; Back up comma-delimited lines too ?????
;; 	     (while (or (eq (preceding-char) ?\,)
;; 			(save-excursion (cperl-after-label)))
;; 	       (if (eq (preceding-char) ?\,)
;; 		   ;; Will go to beginning of line, essentially
;; 		   ;; Will ignore embedded sexpr XXXX.
;; 		   (cperl-backward-to-start-of-continued-exp containing-sexp))
;; 	       (beginning-of-line)
;; 	       (cperl-backward-to-noncomment containing-sexp))
;; 	     ;; Now we get the answer.
;; 	     (if (not (memq (preceding-char) (append ";}{" '(nil)))) ; Was ?\,
;; 		 ;; This line is continuation of preceding line's statement.
;; 		 (list (list 'statement-continued containing-sexp))
;; 	       ;; This line starts a new statement.
;; 	       ;; Position following last unclosed open.
;; 	       (goto-char containing-sexp)
;; 	       ;; Is line first statement after an open-brace?
;; 	       (or
;; 		;; If no, find that first statement and indent like
;; 		;; it.  If the first statement begins with label, do
;; 		;; not believe when the indentation of the label is too
;; 		;; small.
;; 		(save-excursion
;; 		  (forward-char 1)
;; 		  (let ((colon-line-end 0))
;; 		    (while (progn (skip-chars-forward " \t\n" start-point)
;; 				  (and (< (point) start-point)
;; 				       (looking-at
;; 					"#\\|[a-zA-Z_][a-zA-Z0-9_]*:[^:]")))
;; 		      ;; Skip over comments and labels following openbrace.
;; 		      (cond ((= (following-char) ?\#)
;; 			     ;;(forward-line 1)
;; 			     (end-of-line))
;; 			    ;; label:
;; 			    (t
;; 			     (save-excursion (end-of-line)
;; 					     (setq colon-line-end (point)))
;; 			     (search-forward ":"))))
;; 		    ;; Now at the point, after label, or at start
;; 		    ;; of first statement in the block.
;; 		    (and (< (point) start-point)
;; 			 (if (> colon-line-end (point))
;; 			     ;; Before statement after label
;; 			     (if (> (current-indentation)
;; 				    cperl-min-label-indent)
;; 				 (list (list 'label-in-block (point)))
;; 			       ;; Do not believe: `max' is involved
;; 			       (list
;; 				(list 'label-in-block-min-indent (point))))
;; 			   ;; Before statement
;; 			   (list 'statement-in-block (point))))))
;; 		;; If no previous statement,
;; 		;; indent it relative to line brace is on.
;; 		;; For open brace in column zero, don't let statement
;; 		;; start there too.  If cperl-indent-level is zero,
;; 		;; use cperl-brace-offset + cperl-continued-statement-offset instead.
;; 		;; For open-braces not the first thing in a line,
;; 		;; add in cperl-brace-imaginary-offset.

;; 		;; If first thing on a line:  ?????
;; 		(+ (if (and (bolp) (zerop cperl-indent-level))
;; 		       (+ cperl-brace-offset cperl-continued-statement-offset)
;; 		     cperl-indent-level)
;; 		   ;; Move back over whitespace before the openbrace.
;; 		   ;; If openbrace is not first nonwhite thing on the line,
;; 		   ;; add the cperl-brace-imaginary-offset.
;; 		   (progn (skip-chars-backward " \t")
;; 			  (if (bolp) 0 cperl-brace-imaginary-offset))
;; 		   ;; If the openbrace is preceded by a parenthesized exp,
;; 		   ;; move to the beginning of that;
;; 		   ;; possibly a different line
;; 		   (progn
;; 		     (if (eq (preceding-char) ?\))
;; 			 (forward-sexp -1))
;; 		     ;; Get initial indentation of the line we are on.
;; 		     ;; If line starts with label, calculate label indentation
;; 		     (if (save-excursion
;; 			   (beginning-of-line)
;; 			   (looking-at "[ \t]*[a-zA-Z_][a-zA-Z_0-9]*:[^:]"))
;; 			 (if (> (current-indentation) cperl-min-label-indent)
;; 			     (- (current-indentation) cperl-label-offset)
;; 			   (cperl-calculate-indent))
;; 		       (current-indentation))))))))
;;       res)))

(defun cperl-calculate-indent-within-comment ()
  "Return the indentation amount for line, assuming that
the current line is to be regarded as part of a block comment."
  (let (end star-start)

	     (delete-char -1))))))

;; Stolen from lisp-mode with a lot of improvements

(defun cperl-fill-paragraph (&optional justify iteration)
  "Like `fill-paragraph', but handle CPerl comments.
If any of the current line is a comment, fill the comment or the
block of it that point is in, preserving the comment's initial
indentation and initial hashes.  Behaves usually outside of comment."
  ;; (interactive "P") ; Only works when called from fill-paragraph.  -stef
  (let (;; Non-nil if the current line contains a comment.
	has-comment

	;; If has-comment, the appropriate fill-prefix for the comment.
	comment-fill-prefix

	 (save-excursion
	   (while (progn (forward-line 1)
			 (looking-at "^[ \t]*#+[ \t]*[^ \t\n#]")))
	   (point)))
	;; Remove existing hashes
	(save-excursion
	  (goto-char (point-min))
	  (while (progn (forward-line 1) (< (point) (point-max)))
	    (skip-chars-forward " \t")
	    (and (looking-at "#+")
		 (delete-char (- (match-end 0) (match-beginning 0))))))

	;; Lines with only hashes on them can be paragraph boundaries.
	(let ((paragraph-start (concat paragraph-start "\\|^[ \t#]*$"))
	      (paragraph-separate (concat paragraph-start "\\|^[ \t#]*$"))
	      (fill-prefix comment-fill-prefix))

	   (current-column))
	 fill-column)
      (let ((c (save-excursion (beginning-of-line)
			       (cperl-to-comment-or-eol) (point)))
	    (s (memq (following-char) '(?\ ?\t))) marker)
	(if (>= c (point))
	    ;; Don't break line inside code: only inside comment.
	    nil
	  (setq marker (point-marker))
	  (fill-paragraph nil)
	  (goto-char marker)
	  ;; Is not enough, sometimes marker is a start of line
	  (if (bolp) (progn (re-search-forward "#+[ \t]*")
			    (goto-char (match-end 0))))
	  ;; Following space could have gone:

    (substring v (match-beginning 1) (match-end 1)))
  "Version of IZ-supported CPerl package this file is based on.")

(provide 'cperl-mode)

;;; arch-tag: 42e5b19b-e187-4537-929f-1a7408980ce6
;;; cperl-mode.el ends here