blob: 624af01986383d4283599691e175947fdaafb57c [file] [log] [blame]
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001;;; python-mode.el --- Major mode for editing Python programs
2
3;; Copyright (C) 1992,1993,1994 Tim Peters
4
Barry Warsaw2ccda501997-01-30 19:50:39 +00005;; Author: 1995-1997 Barry A. Warsaw
Barry Warsawfec75d61995-07-05 23:26:15 +00006;; 1992-1994 Tim Peters
Barry Warsawa97a3f31997-11-04 18:47:06 +00007;; Maintainer: python-mode@python.org
8;; Created: Feb 1992
9;; Keywords: python languages oop
Barry Warsaw7b0f5681995-03-08 21:33:04 +000010
Barry Warsaw5e21cb01997-11-05 18:41:11 +000011(defconst py-version "$Revision$"
Barry Warsawc72c11c1997-08-09 06:42:08 +000012 "`python-mode' version number.")
13
Barry Warsawcfec3591995-03-10 15:58:16 +000014;; This software is provided as-is, without express or implied
15;; warranty. Permission to use, copy, modify, distribute or sell this
16;; software, without fee, for any purpose and by any individual or
17;; organization, is hereby granted, provided that the above copyright
18;; notice and this paragraph appear in all copies.
Barry Warsaw7b0f5681995-03-08 21:33:04 +000019
20;;; Commentary:
Barry Warsaw755c6711996-08-01 20:02:55 +000021
Barry Warsaw7b0f5681995-03-08 21:33:04 +000022;; This is a major mode for editing Python programs. It was developed
Barry Warsaw261f87d1996-08-20 19:57:34 +000023;; by Tim Peters after an original idea by Michael A. Guravage. Tim
24;; subsequently left the net; in 1995, Barry Warsaw inherited the
25;; mode and is the current maintainer.
Barry Warsaw7b0f5681995-03-08 21:33:04 +000026
Barry Warsawaffc0ca1997-11-03 16:59:38 +000027;; Note: this version of python-mode.el is no longer compatible with
28;; Emacs 18. For a gabazillion reasons, I highly recommend upgrading
29;; to X/Emacs 19 or X/Emacs 20. For older versions of the 19 series,
Barry Warsawa0ee8cd1997-11-26 01:04:44 +000030;; you may need to acquire the Custom library. Please see
31;; <http://www.python.org/ftp/emacs/> for details.
Barry Warsaw7b0f5681995-03-08 21:33:04 +000032
Barry Warsawaffc0ca1997-11-03 16:59:38 +000033;; python-mode.el is currently distributed with XEmacs 19 and XEmacs
34;; 20. Since this file is not GPL'd it is not distributed with Emacs,
Barry Warsawa97a3f31997-11-04 18:47:06 +000035;; but it is compatible with 19.34 and the current 20 series Emacsen.
36;; By default, in XEmacs when you visit a .py file, it is put in
37;; Python mode. In Emacs, you need to add the following to your
38;; .emacs file (you don't need this for XEmacs):
Barry Warsaw7ae77681994-12-12 20:38:05 +000039;;
Barry Warsawaffc0ca1997-11-03 16:59:38 +000040;; (autoload 'python-mode "python-mode" "Python editing mode." t)
41;; (setq auto-mode-alist
42;; (cons '("\\.py$" . python-mode) auto-mode-alist))
43;; (setq interpreter-mode-alist
44;; (cons '("python" . python-mode) interpreter-mode-alist))
Barry Warsaw44b72201996-07-05 20:11:35 +000045;;
Barry Warsawaffc0ca1997-11-03 16:59:38 +000046;; Assuming python-mode.el is on your load-path, it will be invoked
47;; when you visit a .py file, or a file with a first line that looks
48;; like:
49;;
50;; #! /usr/bin/env python
51
Barry Warsaw44b72201996-07-05 20:11:35 +000052;; If you want font-lock support for Python source code (a.k.a. syntax
53;; coloring, highlighting), add this to your .emacs file:
54;;
55;; (add-hook 'python-mode-hook 'turn-on-font-lock)
Barry Warsawc08a9491996-07-31 22:27:58 +000056;;
Barry Warsawaffc0ca1997-11-03 16:59:38 +000057;; Again, this should not be necessary for XEmacs, since it Just Works.
Barry Warsaw7ae77681994-12-12 20:38:05 +000058
Barry Warsawaffc0ca1997-11-03 16:59:38 +000059;; To submit bug reports, use C-c C-b. Please include a complete, but
60;; concise code sample and a recipe for reproducing the bug. Send
61;; suggestions and other comments to python-mode@python.org.
62
63;; When in a Python mode buffer, do a C-h m for more help. It's
64;; doubtful that a texinfo manual would be very useful.
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000065
Barry Warsaw7b0f5681995-03-08 21:33:04 +000066;; Here's a brief to do list:
67;;
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000068;; - Better integration with gud-mode for debugging.
69;; - Rewrite according to GNU Emacs Lisp standards.
Barry Warsaw5c0d00f1996-07-31 21:30:21 +000070;; - possibly force indent-tabs-mode == nil, and add a
71;; write-file-hooks that runs untabify on the whole buffer (to work
72;; around potential tab/space mismatch problems). In practice this
73;; hasn't been a problem... yet.
Barry Warsaw9e277db1996-07-31 22:33:40 +000074;; - have py-execute-region on indented code act as if the region is
75;; left justified. Avoids syntax errors.
Barry Warsaw01af4011996-09-04 14:57:22 +000076;; - Add a py-goto-error or some such that would scan an exception in
77;; the py-shell buffer, and pop you to that line in the file.
Barry Warsaw7ae77681994-12-12 20:38:05 +000078
Barry Warsaw7b0f5681995-03-08 21:33:04 +000079;;; Code:
80
Barry Warsawc72c11c1997-08-09 06:42:08 +000081(require 'custom)
82
Barry Warsaw7b0f5681995-03-08 21:33:04 +000083
84;; user definable variables
85;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
Barry Warsaw7ae77681994-12-12 20:38:05 +000086
Barry Warsawc72c11c1997-08-09 06:42:08 +000087(defgroup python nil
88 "Support for the Python programming language, <http://www.python.org/>"
89 :group 'languages)
Barry Warsaw7ae77681994-12-12 20:38:05 +000090
Barry Warsawc72c11c1997-08-09 06:42:08 +000091(defcustom py-python-command "python"
92 "*Shell command used to start Python interpreter."
93 :type 'string
94 :group 'python)
95
96(defcustom py-indent-offset 4
97 "*Amount of offset per level of indentation
Barry Warsaw7b0f5681995-03-08 21:33:04 +000098Note that `\\[py-guess-indent-offset]' can usually guess a good value
Barry Warsawc72c11c1997-08-09 06:42:08 +000099when you're editing someone else's Python code."
100 :type 'integer
101 :group 'python)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000102
Barry Warsawc72c11c1997-08-09 06:42:08 +0000103(defcustom py-align-multiline-strings-p t
104 "*Flag describing how multi-line triple quoted strings are aligned.
Barry Warsaw095e9c61995-09-19 20:01:42 +0000105When this flag is non-nil, continuation lines are lined up under the
106preceding line's indentation. When this flag is nil, continuation
Barry Warsawc72c11c1997-08-09 06:42:08 +0000107lines are aligned to column zero."
108 :type '(choice (const :tag "Align under preceding line" t)
109 (const :tag "Align to column zero" nil))
110 :group 'python)
Barry Warsaw095e9c61995-09-19 20:01:42 +0000111
Barry Warsawc72c11c1997-08-09 06:42:08 +0000112(defcustom py-block-comment-prefix "## "
Barry Warsaw867a32a1996-03-07 18:30:26 +0000113 "*String used by \\[comment-region] to comment out a block of code.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000114This should follow the convention for non-indenting comment lines so
115that the indentation commands won't get confused (i.e., the string
116should be of the form `#x...' where `x' is not a blank or a tab, and
Barry Warsawc72c11c1997-08-09 06:42:08 +0000117`...' is arbitrary)."
118 :type 'string
119 :group 'python)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000120
Barry Warsawc72c11c1997-08-09 06:42:08 +0000121(defcustom py-honor-comment-indentation t
Barry Warsaw6d627751996-03-06 18:41:38 +0000122 "*Controls how comment lines influence subsequent indentation.
Barry Warsaw33d6ec01996-03-05 16:28:07 +0000123
Barry Warsaw6d627751996-03-06 18:41:38 +0000124When nil, all comment lines are skipped for indentation purposes, and
Barry Warsawc72c11c1997-08-09 06:42:08 +0000125if possible, a faster algorithm is used (i.e. X/Emacs 19 and beyond).
Barry Warsaw6d627751996-03-06 18:41:38 +0000126
127When t, lines that begin with a single `#' are a hint to subsequent
128line indentation. If the previous line is such a comment line (as
129opposed to one that starts with `py-block-comment-prefix'), then it's
130indentation is used as a hint for this line's indentation. Lines that
131begin with `py-block-comment-prefix' are ignored for indentation
132purposes.
133
134When not nil or t, comment lines that begin with a `#' are used as
Barry Warsawc72c11c1997-08-09 06:42:08 +0000135indentation hints, unless the comment character is in column zero."
136 :type '(choice
137 (const :tag "Skip all comment lines (fast)" nil)
138 (const :tag "Single # `sets' indentation for next line" t)
Barry Warsawaffc0ca1997-11-03 16:59:38 +0000139 (const :tag "Single # `sets' indentation except at column zero"
140 other)
Barry Warsawc72c11c1997-08-09 06:42:08 +0000141 )
142 :group 'python)
Barry Warsaw33d6ec01996-03-05 16:28:07 +0000143
Barry Warsawc72c11c1997-08-09 06:42:08 +0000144(defcustom py-scroll-process-buffer t
Barry Warsaw7ae77681994-12-12 20:38:05 +0000145 "*Scroll Python process buffer as output arrives.
146If nil, the Python process buffer acts, with respect to scrolling, like
147Shell-mode buffers normally act. This is surprisingly complicated and
148so won't be explained here; in fact, you can't get the whole story
149without studying the Emacs C code.
150
151If non-nil, the behavior is different in two respects (which are
152slightly inaccurate in the interest of brevity):
153
154 - If the buffer is in a window, and you left point at its end, the
155 window will scroll as new output arrives, and point will move to the
156 buffer's end, even if the window is not the selected window (that
157 being the one the cursor is in). The usual behavior for shell-mode
158 windows is not to scroll, and to leave point where it was, if the
159 buffer is in a window other than the selected window.
160
161 - If the buffer is not visible in any window, and you left point at
162 its end, the buffer will be popped into a window as soon as more
163 output arrives. This is handy if you have a long-running
164 computation and don't want to tie up screen area waiting for the
165 output. The usual behavior for a shell-mode buffer is to stay
166 invisible until you explicitly visit it.
167
168Note the `and if you left point at its end' clauses in both of the
169above: you can `turn off' the special behaviors while output is in
170progress, by visiting the Python buffer and moving point to anywhere
171besides the end. Then the buffer won't scroll, point will remain where
172you leave it, and if you hide the buffer it will stay hidden until you
173visit it again. You can enable and disable the special behaviors as
174often as you like, while output is in progress, by (respectively) moving
175point to, or away from, the end of the buffer.
176
177Warning: If you expect a large amount of output, you'll probably be
178happier setting this option to nil.
179
180Obscure: `End of buffer' above should really say `at or beyond the
181process mark', but if you know what that means you didn't need to be
Barry Warsawc72c11c1997-08-09 06:42:08 +0000182told <grin>."
183 :type 'boolean
184 :group 'python)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000185
Barry Warsaw516b6201997-08-09 06:43:20 +0000186(defcustom py-temp-directory
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000187 (let ((ok '(lambda (x)
188 (and x
189 (setq x (expand-file-name x)) ; always true
190 (file-directory-p x)
191 (file-writable-p x)
192 x))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000193 (or (funcall ok (getenv "TMPDIR"))
194 (funcall ok "/usr/tmp")
195 (funcall ok "/tmp")
196 (funcall ok ".")
197 (error
198 "Couldn't find a usable temp directory -- set py-temp-directory")))
199 "*Directory used for temp files created by a *Python* process.
200By default, the first directory from this list that exists and that you
201can write into: the value (if any) of the environment variable TMPDIR,
Barry Warsawc72c11c1997-08-09 06:42:08 +0000202/usr/tmp, /tmp, or the current directory."
203 :type 'string
204 :group 'python)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000205
Barry Warsaw516b6201997-08-09 06:43:20 +0000206(defcustom py-beep-if-tab-change t
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000207 "*Ring the bell if tab-width is changed.
208If a comment of the form
209
210 \t# vi:set tabsize=<number>:
211
212is found before the first code line when the file is entered, and the
213current value of (the general Emacs variable) `tab-width' does not
214equal <number>, `tab-width' is set to <number>, a message saying so is
215displayed in the echo area, and if `py-beep-if-tab-change' is non-nil
Barry Warsawc72c11c1997-08-09 06:42:08 +0000216the Emacs bell is also rung as a warning."
217 :type 'boolean
218 :group 'python)
219
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000220(defcustom py-backspace-function 'backward-delete-char-untabify
221 "*Function called by `py-electric-backspace' when deleting backwards."
222 :type 'function
223 :group 'python)
224
225(defcustom py-delete-function 'delete-char
226 "*Function called by `py-electric-delete' when deleting forwards."
227 :type 'function
228 :group 'python)
229
230
Barry Warsawc72c11c1997-08-09 06:42:08 +0000231
232;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
233;; NO USER DEFINABLE VARIABLES BEYOND THIS POINT
234
Barry Warsaw5e21cb01997-11-05 18:41:11 +0000235(defconst py-emacs-features
236 (let (features)
237 ;; NTEmacs 19.34.6 has a broken make-temp-name; it always returns
238 ;; the same string.
239 (let ((tmp1 (make-temp-name ""))
240 (tmp2 (make-temp-name "")))
241 (if (string-equal tmp1 tmp2)
242 (push 'broken-temp-names features)))
243 ;; return the features
244 features)
Barry Warsawc12c62e1997-09-04 04:18:07 +0000245 "A list of features extant in the Emacs you are using.
Barry Warsaw6ae21ad1997-11-06 14:36:49 +0000246There are many flavors of Emacs out there, with different levels of
247support for features needed by `python-mode'.")
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000248
Barry Warsawfb07f401997-02-24 03:37:22 +0000249(defvar python-font-lock-keywords
Barry Warsawb8f11661997-11-06 14:35:15 +0000250 (let ((kw1 (mapconcat 'identity
251 '("and" "assert" "break" "class"
252 "continue" "def" "del" "elif"
253 "else" "except" "exec" "for"
254 "from" "global" "if" "import"
255 "in" "is" "lambda" "not"
256 "or" "pass" "print" "raise"
257 "return" "while"
258 )
259 "\\|"))
260 (kw2 (mapconcat 'identity
261 '("else:" "except:" "finally:" "try:")
262 "\\|"))
263 )
Barry Warsaw33ab6e41996-03-05 00:44:31 +0000264 (list
Barry Warsawef3c8911997-11-05 18:55:50 +0000265 ;; keywords
Barry Warsawb8f11661997-11-06 14:35:15 +0000266 (cons (concat "\\b\\(" kw1 "\\)\\b[ \n\t(]") 1)
267 ;; block introducing keywords with immediately following colons.
268 ;; Yes "except" is in both lists.
269 (cons (concat "\\b\\(" kw2 "\\)[ \n\t(]") 1)
Barry Warsaw33ab6e41996-03-05 00:44:31 +0000270 ;; classes
271 '("\\bclass[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)"
272 1 font-lock-type-face)
273 ;; functions
274 '("\\bdef[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)"
275 1 font-lock-function-name-face)
276 ))
Barry Warsaw62d9d6e1996-03-06 20:32:27 +0000277 "Additional expressions to highlight in Python mode.")
Barry Warsawfb07f401997-02-24 03:37:22 +0000278(put 'python-mode 'font-lock-defaults '(python-font-lock-keywords))
279
Barry Warsawb01b4fa1995-06-20 18:55:34 +0000280
Barry Warsaw81437461996-08-01 19:48:02 +0000281(defvar imenu-example--python-show-method-args-p nil
282 "*Controls echoing of arguments of functions & methods in the imenu buffer.
283When non-nil, arguments are printed.")
284
Barry Warsaw52bc17c1995-10-12 21:15:49 +0000285(make-variable-buffer-local 'py-indent-offset)
286
Barry Warsawe467bfb1997-11-26 05:40:58 +0000287;; have to bind py-file-queue before installing the kill-emacs-hook
Barry Warsaw7ae77681994-12-12 20:38:05 +0000288(defvar py-file-queue nil
289 "Queue of Python temp files awaiting execution.
290Currently-active file is at the head of the list.")
291
Barry Warsawc72c11c1997-08-09 06:42:08 +0000292
293;; Constants
294
295;; Regexp matching a Python string literal
296(defconst py-stringlit-re
297 (concat
298 "'\\([^'\n\\]\\|\\\\.\\)*'" ; single-quoted
299 "\\|" ; or
300 "\"\\([^\"\n\\]\\|\\\\.\\)*\"")) ; double-quoted
301
302;; Regexp matching Python lines that are continued via backslash.
303;; This is tricky because a trailing backslash does not mean
304;; continuation if it's in a comment
305(defconst py-continued-re
306 (concat
307 "\\(" "[^#'\"\n\\]" "\\|" py-stringlit-re "\\)*"
308 "\\\\$"))
309
310;; Regexp matching blank or comment lines.
311(defconst py-blank-or-comment-re "[ \t]*\\($\\|#\\)")
312
313;; Regexp matching clauses to be outdented one level.
314(defconst py-outdent-re
315 (concat "\\(" (mapconcat 'identity
316 '("else:"
317 "except\\(\\s +.*\\)?:"
318 "finally:"
319 "elif\\s +.*:")
320 "\\|")
321 "\\)"))
322
323
Barry Warsawaffc0ca1997-11-03 16:59:38 +0000324;; Regexp matching keywords which typically close a block
325(defconst py-block-closing-keywords-re
326 "\\(return\\|raise\\|break\\|continue\\|pass\\)")
327
Barry Warsawc72c11c1997-08-09 06:42:08 +0000328;; Regexp matching lines to not outdent after.
329(defconst py-no-outdent-re
Barry Warsawaffc0ca1997-11-03 16:59:38 +0000330 (concat
331 "\\("
332 (mapconcat 'identity
333 (list "try:"
334 "except\\(\\s +.*\\)?:"
335 "while\\s +.*:"
336 "for\\s +.*:"
337 "if\\s +.*:"
338 "elif\\s +.*:"
339 (concat py-block-closing-keywords-re "[ \t\n]")
340 )
341 "\\|")
Barry Warsawc72c11c1997-08-09 06:42:08 +0000342 "\\)"))
343
344;; Regexp matching a function, method or variable assignment. If you
345;; change this, you probably have to change `py-current-defun' as
346;; well. This is only used by `py-current-defun' to find the name for
347;; add-log.el.
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000348(defconst py-defun-start-re
Barry Warsawc72c11c1997-08-09 06:42:08 +0000349 "^\\([ \t]*\\)def[ \t]+\\([a-zA-Z_0-9]+\\)\\|\\(^[a-zA-Z_0-9]+\\)[ \t]*=")
350
351;; Regexp for finding a class name. If you change this, you probably
352;; have to change `py-current-defun' as well. This is only used by
353;; `py-current-defun' to find the name for add-log.el.
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000354(defconst py-class-start-re "^class[ \t]*\\([a-zA-Z_0-9]+\\)")
355
356;; Regexp that describes tracebacks
357(defconst py-traceback-line-re
358 "[ \t]+File \"\\([^\"]+\\)\", line \\([0-9]+\\), in ")
Barry Warsawc72c11c1997-08-09 06:42:08 +0000359
360
361
362;; Utilities
363
364(defmacro py-safe (&rest body)
365 ;; safely execute BODY, return nil if an error occurred
366 (` (condition-case nil
367 (progn (,@ body))
368 (error nil))))
369
370(defsubst py-keep-region-active ()
371 ;; Do whatever is necessary to keep the region active in XEmacs.
372 ;; Ignore byte-compiler warnings you might see. Also note that
373 ;; FSF's Emacs 19 does it differently; its policy doesn't require us
374 ;; to take explicit action.
375 (and (boundp 'zmacs-region-stays)
376 (setq zmacs-region-stays t)))
377
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000378(defsubst py-point (position)
379 ;; Returns the value of point at certain commonly referenced POSITIONs.
380 ;; POSITION can be one of the following symbols:
381 ;;
382 ;; bol -- beginning of line
383 ;; eol -- end of line
384 ;; bod -- beginning of defun
385 ;; boi -- back to indentation
386 ;;
387 ;; This function does not modify point or mark.
388 (let ((here (point)))
389 (cond
390 ((eq position 'bol) (beginning-of-line))
391 ((eq position 'eol) (end-of-line))
392 ((eq position 'bod) (beginning-of-python-def-or-class))
393 ((eq position 'bob) (beginning-of-buffer))
394 ((eq position 'eob) (end-of-buffer))
395 ((eq position 'boi) (back-to-indentation))
396 (t (error "unknown buffer position requested: %s" position))
397 )
398 (prog1
399 (point)
400 (goto-char here))))
401
402(defsubst py-highlight-line (from to file line)
403 (cond
404 ((fboundp 'make-extent)
405 ;; XEmacs
406 (let ((e (make-extent from to)))
407 (set-extent-property e 'mouse-face 'highlight)
408 (set-extent-property e 'py-exc-info (cons file line))
409 (set-extent-property e 'keymap py-mode-output-map)))
410 (t
411 ;; Emacs -- Please port this!
412 )
413 ))
414
Barry Warsawc72c11c1997-08-09 06:42:08 +0000415
416;; Major mode boilerplate
417
Barry Warsaw7ae77681994-12-12 20:38:05 +0000418;; define a mode-specific abbrev table for those who use such things
419(defvar python-mode-abbrev-table nil
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000420 "Abbrev table in use in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000421(define-abbrev-table 'python-mode-abbrev-table nil)
422
Barry Warsaw7ae77681994-12-12 20:38:05 +0000423(defvar python-mode-hook nil
424 "*Hook called by `python-mode'.")
425
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000426;; in previous version of python-mode.el, the hook was incorrectly
427;; called py-mode-hook, and was not defvar'd. deprecate its use.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000428(and (fboundp 'make-obsolete-variable)
429 (make-obsolete-variable 'py-mode-hook 'python-mode-hook))
430
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000431(defvar py-mode-map ()
432 "Keymap used in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000433(if py-mode-map
Barry Warsawc72c11c1997-08-09 06:42:08 +0000434 nil
Barry Warsaw7ae77681994-12-12 20:38:05 +0000435 (setq py-mode-map (make-sparse-keymap))
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000436 ;; electric keys
437 (define-key py-mode-map ":" 'py-electric-colon)
438 ;; indentation level modifiers
439 (define-key py-mode-map "\C-c\C-l" 'py-shift-region-left)
440 (define-key py-mode-map "\C-c\C-r" 'py-shift-region-right)
441 (define-key py-mode-map "\C-c<" 'py-shift-region-left)
442 (define-key py-mode-map "\C-c>" 'py-shift-region-right)
443 ;; subprocess commands
444 (define-key py-mode-map "\C-c\C-c" 'py-execute-buffer)
445 (define-key py-mode-map "\C-c|" 'py-execute-region)
446 (define-key py-mode-map "\C-c!" 'py-shell)
447 ;; Caution! Enter here at your own risk. We are trying to support
448 ;; several behaviors and it gets disgusting. :-( This logic ripped
449 ;; largely from CC Mode.
450 ;;
451 ;; In XEmacs 19, Emacs 19, and Emacs 20, we use this to bind
452 ;; backwards deletion behavior to DEL, which both Delete and
453 ;; Backspace get translated to. There's no way to separate this
454 ;; behavior in a clean way, so deal with it! Besides, it's been
455 ;; this way since the dawn of time.
456 (if (not (boundp 'delete-key-deletes-forward))
457 (define-key py-mode-map "\177" 'py-electric-backspace)
458 ;; However, XEmacs 20 actually achieved enlightenment. It is
459 ;; possible to sanely define both backward and forward deletion
460 ;; behavior under X separately (TTYs are forever beyond hope, but
461 ;; who cares? XEmacs 20 does the right thing with these too).
462 (define-key py-mode-map [delete] 'py-electric-delete)
463 (define-key py-mode-map [backspace] 'py-electric-backspace))
Barry Warsaw2518c671997-11-05 00:51:08 +0000464 ;; marking interesting locations
Barry Warsaw4da6bd51997-11-26 06:00:26 +0000465 (define-key py-mode-map "\e\C-h" 'py-mark-def-or-class)
Barry Warsaw2518c671997-11-05 00:51:08 +0000466 (define-key py-mode-map "\C-c\C-k" 'py-mark-block)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000467 ;; Miscellaneous
468 (define-key py-mode-map "\C-c:" 'py-guess-indent-offset)
469 (define-key py-mode-map "\C-c\t" 'py-indent-region)
470 (define-key py-mode-map "\C-c\C-n" 'py-next-statement)
471 (define-key py-mode-map "\C-c\C-p" 'py-previous-statement)
472 (define-key py-mode-map "\C-c\C-u" 'py-goto-block-up)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000473 (define-key py-mode-map "\C-c#" 'py-comment-region)
474 (define-key py-mode-map "\C-c?" 'py-describe-mode)
475 (define-key py-mode-map "\C-c\C-hm" 'py-describe-mode)
476 (define-key py-mode-map "\e\C-a" 'beginning-of-python-def-or-class)
477 (define-key py-mode-map "\e\C-e" 'end-of-python-def-or-class)
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000478 (define-key py-mode-map "\C-c-" 'py-up-exception)
479 (define-key py-mode-map "\C-c=" 'py-down-exception)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000480 ;; information
481 (define-key py-mode-map "\C-c\C-b" 'py-submit-bug-report)
482 (define-key py-mode-map "\C-c\C-v" 'py-version)
483 ;; py-newline-and-indent mappings
484 (define-key py-mode-map "\n" 'py-newline-and-indent)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000485 ;; shadow global bindings for newline-and-indent w/ the py- version.
486 ;; BAW - this is extremely bad form, but I'm not going to change it
487 ;; for now.
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000488 (mapcar #'(lambda (key)
489 (define-key py-mode-map key 'py-newline-and-indent))
490 (where-is-internal 'newline-and-indent))
491 )
492
493(defvar py-mode-output-map nil
494 "Keymap used in *Python Output* buffers*")
495(if py-mode-output-map
496 nil
497 (setq py-mode-output-map (make-sparse-keymap))
498 (define-key py-mode-output-map [button2] 'py-mouseto-exception)
499 (define-key py-mode-output-map "\C-c\C-c" 'py-goto-exception)
500 ;; TBD: Disable all self-inserting keys. This is bogus, we should
501 ;; really implement this as *Python Output* buffer being read-only
502 (mapcar #' (lambda (key)
503 (define-key py-mode-output-map key
504 #'(lambda () (interactive) (beep))))
505 (where-is-internal 'self-insert-command))
Barry Warsaw850437a1995-03-08 21:50:28 +0000506 )
Barry Warsaw7ae77681994-12-12 20:38:05 +0000507
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000508(defvar py-mode-syntax-table nil
509 "Syntax table used in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000510(if py-mode-syntax-table
Barry Warsawc72c11c1997-08-09 06:42:08 +0000511 nil
Barry Warsaw7ae77681994-12-12 20:38:05 +0000512 (setq py-mode-syntax-table (make-syntax-table))
Barry Warsawc72c11c1997-08-09 06:42:08 +0000513 (modify-syntax-entry ?\( "()" py-mode-syntax-table)
514 (modify-syntax-entry ?\) ")(" py-mode-syntax-table)
515 (modify-syntax-entry ?\[ "(]" py-mode-syntax-table)
516 (modify-syntax-entry ?\] ")[" py-mode-syntax-table)
517 (modify-syntax-entry ?\{ "(}" py-mode-syntax-table)
518 (modify-syntax-entry ?\} "){" py-mode-syntax-table)
519 ;; Add operator symbols misassigned in the std table
520 (modify-syntax-entry ?\$ "." py-mode-syntax-table)
521 (modify-syntax-entry ?\% "." py-mode-syntax-table)
522 (modify-syntax-entry ?\& "." py-mode-syntax-table)
523 (modify-syntax-entry ?\* "." py-mode-syntax-table)
524 (modify-syntax-entry ?\+ "." py-mode-syntax-table)
525 (modify-syntax-entry ?\- "." py-mode-syntax-table)
526 (modify-syntax-entry ?\/ "." py-mode-syntax-table)
527 (modify-syntax-entry ?\< "." py-mode-syntax-table)
528 (modify-syntax-entry ?\= "." py-mode-syntax-table)
529 (modify-syntax-entry ?\> "." py-mode-syntax-table)
530 (modify-syntax-entry ?\| "." py-mode-syntax-table)
531 ;; For historical reasons, underscore is word class instead of
532 ;; symbol class. GNU conventions say it should be symbol class, but
533 ;; there's a natural conflict between what major mode authors want
534 ;; and what users expect from `forward-word' and `backward-word'.
535 ;; Guido and I have hashed this out and have decided to keep
536 ;; underscore in word class. If you're tempted to change it, try
537 ;; binding M-f and M-b to py-forward-into-nomenclature and
538 ;; py-backward-into-nomenclature instead.
539 (modify-syntax-entry ?\_ "w" py-mode-syntax-table)
540 ;; Both single quote and double quote are string delimiters
541 (modify-syntax-entry ?\' "\"" py-mode-syntax-table)
542 (modify-syntax-entry ?\" "\"" py-mode-syntax-table)
543 ;; backquote is open and close paren
544 (modify-syntax-entry ?\` "$" py-mode-syntax-table)
545 ;; comment delimiters
546 (modify-syntax-entry ?\# "<" py-mode-syntax-table)
547 (modify-syntax-entry ?\n ">" py-mode-syntax-table)
548 )
Barry Warsaw7ae77681994-12-12 20:38:05 +0000549
Barry Warsawb3e81d51996-09-04 15:12:42 +0000550
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000551
Barry Warsaw42f707f1996-07-29 21:05:05 +0000552;; Menu definitions, only relevent if you have the easymenu.el package
553;; (standard in the latest Emacs 19 and XEmacs 19 distributions).
Barry Warsaw5490a061996-08-06 15:43:33 +0000554(defvar py-menu nil
555 "Menu for Python Mode.
Barry Warsawc72c11c1997-08-09 06:42:08 +0000556This menu will get created automatically if you have the `easymenu'
557package. Note that the latest X/Emacs releases contain this package.")
Barry Warsaw5490a061996-08-06 15:43:33 +0000558
Barry Warsawc72c11c1997-08-09 06:42:08 +0000559(and (py-safe (require 'easymenu) t)
560 (easy-menu-define
561 py-menu py-mode-map "Python Mode menu"
562 '("Python"
563 ["Comment Out Region" py-comment-region (mark)]
564 ["Uncomment Region" (py-comment-region (point) (mark) '(4)) (mark)]
565 "-"
566 ["Mark current block" py-mark-block t]
Barry Warsaw2518c671997-11-05 00:51:08 +0000567 ["Mark current def" py-mark-def-or-class t]
568 ["Mark current class" (py-mark-def-or-class t) t]
Barry Warsawc72c11c1997-08-09 06:42:08 +0000569 "-"
570 ["Shift region left" py-shift-region-left (mark)]
571 ["Shift region right" py-shift-region-right (mark)]
572 "-"
573 ["Execute buffer" py-execute-buffer t]
574 ["Execute region" py-execute-region (mark)]
575 ["Start interpreter..." py-shell t]
576 "-"
577 ["Go to start of block" py-goto-block-up t]
578 ["Go to start of class" (beginning-of-python-def-or-class t) t]
579 ["Move to end of class" (end-of-python-def-or-class t) t]
580 ["Move to start of def" beginning-of-python-def-or-class t]
581 ["Move to end of def" end-of-python-def-or-class t]
582 "-"
583 ["Describe mode" py-describe-mode t]
584 )))
Barry Warsaw42f707f1996-07-29 21:05:05 +0000585
Barry Warsaw81437461996-08-01 19:48:02 +0000586
587
588;; imenu definitions, courtesy of Perry A. Stoll <stoll@atr-sw.atr.co.jp>
589(defvar imenu-example--python-class-regexp
590 (concat ; <<classes>>
591 "\\(" ;
592 "^[ \t]*" ; newline and maybe whitespace
593 "\\(class[ \t]+[a-zA-Z0-9_]+\\)" ; class name
594 ; possibly multiple superclasses
595 "\\([ \t]*\\((\\([a-zA-Z0-9_, \t\n]\\)*)\\)?\\)"
596 "[ \t]*:" ; and the final :
597 "\\)" ; >>classes<<
598 )
599 "Regexp for Python classes for use with the imenu package."
600 )
601
602(defvar imenu-example--python-method-regexp
603 (concat ; <<methods and functions>>
604 "\\(" ;
605 "^[ \t]*" ; new line and maybe whitespace
606 "\\(def[ \t]+" ; function definitions start with def
607 "\\([a-zA-Z0-9_]+\\)" ; name is here
608 ; function arguments...
609 "[ \t]*(\\([a-zA-Z0-9_=,\* \t\n]*\\))"
610 "\\)" ; end of def
611 "[ \t]*:" ; and then the :
612 "\\)" ; >>methods and functions<<
613 )
614 "Regexp for Python methods/functions for use with the imenu package."
615 )
616
617(defvar imenu-example--python-method-no-arg-parens '(2 8)
618 "Indicies into groups of the Python regexp for use with imenu.
619
620Using these values will result in smaller imenu lists, as arguments to
621functions are not listed.
622
623See the variable `imenu-example--python-show-method-args-p' for more
624information.")
625
626(defvar imenu-example--python-method-arg-parens '(2 7)
627 "Indicies into groups of the Python regexp for use with imenu.
628Using these values will result in large imenu lists, as arguments to
629functions are listed.
630
631See the variable `imenu-example--python-show-method-args-p' for more
632information.")
633
634;; Note that in this format, this variable can still be used with the
635;; imenu--generic-function. Otherwise, there is no real reason to have
636;; it.
637(defvar imenu-example--generic-python-expression
638 (cons
639 (concat
640 imenu-example--python-class-regexp
641 "\\|" ; or...
642 imenu-example--python-method-regexp
643 )
644 imenu-example--python-method-no-arg-parens)
645 "Generic Python expression which may be used directly with imenu.
646Used by setting the variable `imenu-generic-expression' to this value.
647Also, see the function \\[imenu-example--create-python-index] for a
648better alternative for finding the index.")
649
650;; These next two variables are used when searching for the python
651;; class/definitions. Just saving some time in accessing the
652;; generic-python-expression, really.
Barry Warsaw01af4011996-09-04 14:57:22 +0000653(defvar imenu-example--python-generic-regexp nil)
654(defvar imenu-example--python-generic-parens nil)
Barry Warsaw81437461996-08-01 19:48:02 +0000655
656
657;;;###autoload
658(eval-when-compile
659 ;; Imenu isn't used in XEmacs, so just ignore load errors
660 (condition-case ()
661 (progn
662 (require 'cl)
663 (require 'imenu))
664 (error nil)))
665
666(defun imenu-example--create-python-index ()
667 "Python interface function for imenu package.
668Finds all python classes and functions/methods. Calls function
669\\[imenu-example--create-python-index-engine]. See that function for
670the details of how this works."
671 (setq imenu-example--python-generic-regexp
672 (car imenu-example--generic-python-expression))
673 (setq imenu-example--python-generic-parens
674 (if imenu-example--python-show-method-args-p
675 imenu-example--python-method-arg-parens
676 imenu-example--python-method-no-arg-parens))
677 (goto-char (point-min))
678 (imenu-example--create-python-index-engine nil))
679
680(defun imenu-example--create-python-index-engine (&optional start-indent)
681 "Function for finding imenu definitions in Python.
682
683Finds all definitions (classes, methods, or functions) in a Python
684file for the imenu package.
685
686Returns a possibly nested alist of the form
687
688 (INDEX-NAME . INDEX-POSITION)
689
690The second element of the alist may be an alist, producing a nested
691list as in
692
693 (INDEX-NAME . INDEX-ALIST)
694
695This function should not be called directly, as it calls itself
696recursively and requires some setup. Rather this is the engine for
697the function \\[imenu-example--create-python-index].
698
699It works recursively by looking for all definitions at the current
700indention level. When it finds one, it adds it to the alist. If it
701finds a definition at a greater indentation level, it removes the
702previous definition from the alist. In it's place it adds all
703definitions found at the next indentation level. When it finds a
704definition that is less indented then the current level, it retuns the
705alist it has created thus far.
706
707The optional argument START-INDENT indicates the starting indentation
708at which to continue looking for Python classes, methods, or
709functions. If this is not supplied, the function uses the indentation
710of the first definition found."
711 (let ((index-alist '())
712 (sub-method-alist '())
713 looking-p
714 def-name prev-name
715 cur-indent def-pos
716 (class-paren (first imenu-example--python-generic-parens))
717 (def-paren (second imenu-example--python-generic-parens)))
718 (setq looking-p
719 (re-search-forward imenu-example--python-generic-regexp
720 (point-max) t))
721 (while looking-p
722 (save-excursion
723 ;; used to set def-name to this value but generic-extract-name is
724 ;; new to imenu-1.14. this way it still works with imenu-1.11
725 ;;(imenu--generic-extract-name imenu-example--python-generic-parens))
726 (let ((cur-paren (if (match-beginning class-paren)
727 class-paren def-paren)))
728 (setq def-name
729 (buffer-substring (match-beginning cur-paren)
730 (match-end cur-paren))))
731 (beginning-of-line)
732 (setq cur-indent (current-indentation)))
733
734 ;; HACK: want to go to the next correct definition location. we
735 ;; explicitly list them here. would be better to have them in a
736 ;; list.
737 (setq def-pos
738 (or (match-beginning class-paren)
739 (match-beginning def-paren)))
740
741 ;; if we don't have a starting indent level, take this one
742 (or start-indent
743 (setq start-indent cur-indent))
744
745 ;; if we don't have class name yet, take this one
746 (or prev-name
747 (setq prev-name def-name))
748
749 ;; what level is the next definition on? must be same, deeper
750 ;; or shallower indentation
751 (cond
752 ;; at the same indent level, add it to the list...
753 ((= start-indent cur-indent)
754
755 ;; if we don't have push, use the following...
756 ;;(setf index-alist (cons (cons def-name def-pos) index-alist))
757 (push (cons def-name def-pos) index-alist))
758
759 ;; deeper indented expression, recur...
760 ((< start-indent cur-indent)
761
762 ;; the point is currently on the expression we're supposed to
763 ;; start on, so go back to the last expression. The recursive
764 ;; call will find this place again and add it to the correct
765 ;; list
766 (re-search-backward imenu-example--python-generic-regexp
767 (point-min) 'move)
768 (setq sub-method-alist (imenu-example--create-python-index-engine
769 cur-indent))
770
771 (if sub-method-alist
772 ;; we put the last element on the index-alist on the start
773 ;; of the submethod alist so the user can still get to it.
774 (let ((save-elmt (pop index-alist)))
775 (push (cons (imenu-create-submenu-name prev-name)
776 (cons save-elmt sub-method-alist))
777 index-alist))))
778
779 ;; found less indented expression, we're done.
780 (t
781 (setq looking-p nil)
782 (re-search-backward imenu-example--python-generic-regexp
783 (point-min) t)))
784 (setq prev-name def-name)
785 (and looking-p
786 (setq looking-p
787 (re-search-forward imenu-example--python-generic-regexp
788 (point-max) 'move))))
789 (nreverse index-alist)))
790
Barry Warsaw42f707f1996-07-29 21:05:05 +0000791
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000792;;;###autoload
Barry Warsaw7ae77681994-12-12 20:38:05 +0000793(defun python-mode ()
794 "Major mode for editing Python files.
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000795To submit a problem report, enter `\\[py-submit-bug-report]' from a
796`python-mode' buffer. Do `\\[py-describe-mode]' for detailed
797documentation. To see what version of `python-mode' you are running,
798enter `\\[py-version]'.
799
800This mode knows about Python indentation, tokens, comments and
801continuation lines. Paragraphs are separated by blank lines only.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000802
803COMMANDS
804\\{py-mode-map}
805VARIABLES
806
Barry Warsaw42f707f1996-07-29 21:05:05 +0000807py-indent-offset\t\tindentation increment
808py-block-comment-prefix\t\tcomment string used by comment-region
809py-python-command\t\tshell command to invoke Python interpreter
810py-scroll-process-buffer\t\talways scroll Python process buffer
811py-temp-directory\t\tdirectory used for temp files (if needed)
812py-beep-if-tab-change\t\tring the bell if tab-width is changed"
Barry Warsaw7ae77681994-12-12 20:38:05 +0000813 (interactive)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000814 ;; set up local variables
Barry Warsaw7ae77681994-12-12 20:38:05 +0000815 (kill-all-local-variables)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000816 (make-local-variable 'font-lock-defaults)
817 (make-local-variable 'paragraph-separate)
818 (make-local-variable 'paragraph-start)
819 (make-local-variable 'require-final-newline)
820 (make-local-variable 'comment-start)
Barry Warsaw5c8bef11996-12-17 21:56:10 +0000821 (make-local-variable 'comment-end)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000822 (make-local-variable 'comment-start-skip)
823 (make-local-variable 'comment-column)
824 (make-local-variable 'indent-region-function)
825 (make-local-variable 'indent-line-function)
Barry Warsawb3e81d51996-09-04 15:12:42 +0000826 (make-local-variable 'add-log-current-defun-function)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000827 ;;
Barry Warsaw7ae77681994-12-12 20:38:05 +0000828 (set-syntax-table py-mode-syntax-table)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000829 (setq major-mode 'python-mode
830 mode-name "Python"
831 local-abbrev-table python-mode-abbrev-table
Barry Warsaw615d4a41996-09-04 14:14:10 +0000832 paragraph-separate "^[ \t]*$"
833 paragraph-start "^[ \t]*$"
834 require-final-newline t
835 comment-start "# "
Barry Warsaw5c8bef11996-12-17 21:56:10 +0000836 comment-end ""
Barry Warsaw615d4a41996-09-04 14:14:10 +0000837 comment-start-skip "# *"
838 comment-column 40
Barry Warsaw550a02e1996-09-04 14:23:00 +0000839 indent-region-function 'py-indent-region
840 indent-line-function 'py-indent-line
Barry Warsawb3e81d51996-09-04 15:12:42 +0000841 ;; tell add-log.el how to find the current function/method/variable
842 add-log-current-defun-function 'py-current-defun
Barry Warsawb1f89511996-09-03 16:38:30 +0000843 )
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000844 (use-local-map py-mode-map)
Barry Warsaw42f707f1996-07-29 21:05:05 +0000845 ;; add the menu
846 (if py-menu
847 (easy-menu-add py-menu))
Barry Warsaw57697af1995-09-14 20:01:14 +0000848 ;; Emacs 19 requires this
Barry Warsawc72c11c1997-08-09 06:42:08 +0000849 (if (boundp 'comment-multi-line)
Barry Warsaw57697af1995-09-14 20:01:14 +0000850 (setq comment-multi-line nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000851 ;; hack to allow overriding the tabsize in the file (see tokenizer.c)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000852 ;;
853 ;; not sure where the magic comment has to be; to save time
854 ;; searching for a rarity, we give up if it's not found prior to the
855 ;; first executable statement.
856 ;;
857 ;; BAW - on first glance, this seems like complete hackery. Why was
858 ;; this necessary, and is it still necessary?
859 (let ((case-fold-search nil)
860 (start (point))
861 new-tab-width)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000862 (if (re-search-forward
863 "^[ \t]*#[ \t]*vi:set[ \t]+tabsize=\\([0-9]+\\):"
864 (prog2 (py-next-statement 1) (point) (goto-char 1))
865 t)
866 (progn
867 (setq new-tab-width
868 (string-to-int
869 (buffer-substring (match-beginning 1) (match-end 1))))
870 (if (= tab-width new-tab-width)
871 nil
872 (setq tab-width new-tab-width)
873 (message "Caution: tab-width changed to %d" new-tab-width)
874 (if py-beep-if-tab-change (beep)))))
875 (goto-char start))
876
Barry Warsaw755c6711996-08-01 20:02:55 +0000877 ;; install imenu
878 (setq imenu-create-index-function
879 (function imenu-example--create-python-index))
Barry Warsawe467bfb1997-11-26 05:40:58 +0000880 (setq imenu-generic-expression
881 imenu-example--generic-python-expression)
Barry Warsaw755c6711996-08-01 20:02:55 +0000882 (if (fboundp 'imenu-add-to-menubar)
883 (imenu-add-to-menubar (format "%s-%s" "IM" mode-name)))
884
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000885 ;; run the mode hook. py-mode-hook use is deprecated
Barry Warsaw7ae77681994-12-12 20:38:05 +0000886 (if python-mode-hook
887 (run-hooks 'python-mode-hook)
888 (run-hooks 'py-mode-hook)))
889
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000890
Barry Warsawb91b7431995-03-14 15:55:20 +0000891;; electric characters
Barry Warsaw3874a3d1995-03-14 22:05:53 +0000892(defun py-outdent-p ()
893 ;; returns non-nil if the current line should outdent one level
894 (save-excursion
895 (and (progn (back-to-indentation)
896 (looking-at py-outdent-re))
897 (progn (backward-to-indentation 1)
898 (while (or (looking-at py-blank-or-comment-re)
899 (bobp))
900 (backward-to-indentation 1))
901 (not (looking-at py-no-outdent-re)))
902 )))
903
Barry Warsawb91b7431995-03-14 15:55:20 +0000904(defun py-electric-colon (arg)
905 "Insert a colon.
906In certain cases the line is outdented appropriately. If a numeric
Barry Warsaw0c6563f1995-09-14 20:57:02 +0000907argument is provided, that many colons are inserted non-electrically.
908Electric behavior is inhibited inside a string or comment."
Barry Warsawb91b7431995-03-14 15:55:20 +0000909 (interactive "P")
910 (self-insert-command (prefix-numeric-value arg))
Barry Warsaw0c6563f1995-09-14 20:57:02 +0000911 ;; are we in a string or comment?
912 (if (save-excursion
913 (let ((pps (parse-partial-sexp (save-excursion
914 (beginning-of-python-def-or-class)
915 (point))
916 (point))))
917 (not (or (nth 3 pps) (nth 4 pps)))))
918 (save-excursion
919 (let ((here (point))
920 (outdent 0)
Barry Warsaw7cb505c1996-10-23 20:44:59 +0000921 (indent (py-compute-indentation t)))
Barry Warsaw0c6563f1995-09-14 20:57:02 +0000922 (if (and (not arg)
923 (py-outdent-p)
924 (= indent (save-excursion
Barry Warsawa7661821996-08-02 16:22:43 +0000925 (py-next-statement -1)
Barry Warsaw7cb505c1996-10-23 20:44:59 +0000926 (py-compute-indentation t)))
Barry Warsaw0c6563f1995-09-14 20:57:02 +0000927 )
928 (setq outdent py-indent-offset))
929 ;; Don't indent, only outdent. This assumes that any lines that
930 ;; are already outdented relative to py-compute-indentation were
931 ;; put there on purpose. Its highly annoying to have `:' indent
932 ;; for you. Use TAB, C-c C-l or C-c C-r to adjust. TBD: Is
933 ;; there a better way to determine this???
934 (if (< (current-indentation) indent) nil
935 (goto-char here)
936 (beginning-of-line)
937 (delete-horizontal-space)
938 (indent-to (- indent outdent))
939 )))))
Barry Warsawb91b7431995-03-14 15:55:20 +0000940
941
Barry Warsawa97a3f31997-11-04 18:47:06 +0000942;; Python subprocess utilities and filters
943(defun py-execute-file (proc filename)
944 ;; Send a properly formatted execfile('FILENAME') to the underlying
945 ;; Python interpreter process FILENAME. Make that process's buffer
946 ;; visible and force display. Also make comint believe the user
947 ;; typed this string so that kill-output-from-shell does The Right
948 ;; Thing.
949 (let ((curbuf (current-buffer))
950 (procbuf (process-buffer proc))
951 (comint-scroll-to-bottom-on-output t)
952 (msg (format "## working on region in file %s...\n" filename))
953 (cmd (format "execfile('%s')\n" filename)))
954 (unwind-protect
955 (progn
956 (set-buffer procbuf)
957 (goto-char (point-max))
958 (move-marker (process-mark proc) (point))
959 (funcall (process-filter proc) proc msg))
960 (set-buffer curbuf))
961 (process-send-string proc cmd)))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000962
963(defun py-process-filter (pyproc string)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000964 (let ((curbuf (current-buffer))
965 (pbuf (process-buffer pyproc))
966 (pmark (process-mark pyproc))
967 file-finished)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000968 ;; make sure we switch to a different buffer at least once. if we
969 ;; *don't* do this, then if the process buffer is in the selected
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000970 ;; window, and point is before the end, and lots of output is
971 ;; coming at a fast pace, then (a) simple cursor-movement commands
972 ;; like C-p, C-n, C-f, C-b, C-a, C-e take an incredibly long time
973 ;; to have a visible effect (the window just doesn't get updated,
974 ;; sometimes for minutes(!)), and (b) it takes about 5x longer to
975 ;; get all the process output (until the next python prompt).
Barry Warsaw7ae77681994-12-12 20:38:05 +0000976 ;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000977 ;; #b makes no sense to me at all. #a almost makes sense: unless
978 ;; we actually change buffers, set_buffer_internal in buffer.c
979 ;; doesn't set windows_or_buffers_changed to 1, & that in turn
980 ;; seems to make the Emacs command loop reluctant to update the
981 ;; display. Perhaps the default process filter in process.c's
982 ;; read_process_output has update_mode_lines++ for a similar
983 ;; reason? beats me ...
984
Barry Warsaw7a73ef81996-09-30 23:00:40 +0000985 (unwind-protect
986 ;; make sure current buffer is restored
987 ;; BAW - we want to check to see if this still applies
988 (progn
989 ;; mysterious ugly hack
990 (if (eq curbuf pbuf)
991 (set-buffer (get-buffer-create "*scratch*")))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000992
Barry Warsaw7a73ef81996-09-30 23:00:40 +0000993 (set-buffer pbuf)
994 (let* ((start (point))
995 (goback (< start pmark))
996 (goend (and (not goback) (= start (point-max))))
997 (buffer-read-only nil))
998 (goto-char pmark)
999 (insert string)
1000 (move-marker pmark (point))
1001 (setq file-finished
1002 (and py-file-queue
1003 (equal ">>> "
1004 (buffer-substring
1005 (prog2 (beginning-of-line) (point)
1006 (goto-char pmark))
1007 (point)))))
1008 (if goback (goto-char start)
1009 ;; else
1010 (if py-scroll-process-buffer
1011 (let* ((pop-up-windows t)
1012 (pwin (display-buffer pbuf)))
1013 (set-window-point pwin (point)))))
1014 (set-buffer curbuf)
1015 (if file-finished
1016 (progn
1017 (py-delete-file-silently (car py-file-queue))
1018 (setq py-file-queue (cdr py-file-queue))
1019 (if py-file-queue
1020 (py-execute-file pyproc (car py-file-queue)))))
1021 (and goend
1022 (progn (set-buffer pbuf)
1023 (goto-char (point-max))))
1024 ))
1025 (set-buffer curbuf))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001026
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001027(defun py-postprocess-output-buffer (buf)
1028 (save-excursion
1029 (set-buffer buf)
1030 (beginning-of-buffer)
1031 (while (re-search-forward py-traceback-line-re nil t)
1032 (let ((file (match-string 1))
1033 (line (string-to-int (match-string 2))))
1034 (py-highlight-line (py-point 'bol) (py-point 'eol) file line))
1035 )))
1036
Barry Warsawa97a3f31997-11-04 18:47:06 +00001037
1038;;; Subprocess commands
1039
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001040;; only used when (memq 'broken-temp-names py-emacs-features)
1041(defvar py-serial-number 0)
1042(defvar py-exception-buffer nil)
1043(defconst py-output-buffer "*Python Output*")
1044
Barry Warsawa97a3f31997-11-04 18:47:06 +00001045;;;###autoload
1046(defun py-shell ()
1047 "Start an interactive Python interpreter in another window.
1048This is like Shell mode, except that Python is running in the window
1049instead of a shell. See the `Interactive Shell' and `Shell Mode'
1050sections of the Emacs manual for details, especially for the key
1051bindings active in the `*Python*' buffer.
1052
1053See the docs for variable `py-scroll-buffer' for info on scrolling
1054behavior in the process window.
1055
1056Warning: Don't use an interactive Python if you change sys.ps1 or
1057sys.ps2 from their default values, or if you're running code that
1058prints `>>> ' or `... ' at the start of a line. `python-mode' can't
1059distinguish your output from Python's output, and assumes that `>>> '
1060at the start of a line is a prompt from Python. Similarly, the Emacs
1061Shell mode code assumes that both `>>> ' and `... ' at the start of a
1062line are Python prompts. Bad things can happen if you fool either
1063mode.
1064
1065Warning: If you do any editing *in* the process buffer *while* the
1066buffer is accepting output from Python, do NOT attempt to `undo' the
1067changes. Some of the output (nowhere near the parts you changed!) may
1068be lost if you do. This appears to be an Emacs bug, an unfortunate
1069interaction between undo and process filters; the same problem exists in
1070non-Python process buffers using the default (Emacs-supplied) process
1071filter."
1072 ;; BAW - should undo be disabled in the python process buffer, if
1073 ;; this bug still exists?
1074 (interactive)
1075 (require 'comint)
Barry Warsaw2518c671997-11-05 00:51:08 +00001076 (switch-to-buffer-other-window
1077 (make-comint "Python" py-python-command nil "-i"))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001078 (make-local-variable 'comint-prompt-regexp)
1079 (setq comint-prompt-regexp "^>>> \\|^[.][.][.] ")
1080 (set-process-filter (get-buffer-process (current-buffer)) 'py-process-filter)
1081 (set-syntax-table py-mode-syntax-table)
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001082 ;; set up keybindings for this subshell
1083 (local-set-key [tab] 'self-insert-command)
1084 (local-set-key "\C-c-" 'py-up-exception)
1085 (local-set-key "\C-c=" 'py-down-exception)
1086 )
Barry Warsawa97a3f31997-11-04 18:47:06 +00001087
Barry Warsawa97a3f31997-11-04 18:47:06 +00001088(defun py-clear-queue ()
1089 "Clear the queue of temporary files waiting to execute."
1090 (interactive)
1091 (let ((n (length py-file-queue)))
1092 (mapcar 'delete-file py-file-queue)
1093 (setq py-file-queue nil)
1094 (message "%d pending files de-queued." n)))
1095
1096(defun py-execute-region (start end &optional async)
1097 "Execute the the region in a Python interpreter.
1098The region is first copied into a temporary file (in the directory
1099`py-temp-directory'). If there is no Python interpreter shell
1100running, this file is executed synchronously using
1101`shell-command-on-region'. If the program is long running, use an
1102optional \\[universal-argument] to run the command asynchronously in
1103its own buffer.
1104
1105If the Python interpreter shell is running, the region is execfile()'d
1106in that shell. If you try to execute regions too quickly,
1107`python-mode' will queue them up and execute them one at a time when
1108it sees a `>>> ' prompt from Python. Each time this happens, the
1109process buffer is popped into a window (if it's not already in some
1110window) so you can see it, and a comment of the form
1111
1112 \t## working on region in file <name>...
1113
1114is inserted at the end. See also the command `py-clear-queue'."
1115 (interactive "r\nP")
1116 (or (< start end)
1117 (error "Region is empty"))
1118 (let* ((proc (get-process "Python"))
Barry Warsaw5e21cb01997-11-05 18:41:11 +00001119 (temp (if (memq 'broken-temp-names py-emacs-features)
1120 (prog1
1121 (format "python-%d" py-serial-number)
1122 (setq py-serial-number (1+ py-serial-number)))
1123 (make-temp-name "python")))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001124 (file (concat (file-name-as-directory py-temp-directory) temp)))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001125 (write-region start end file nil 'nomsg)
1126 (cond
1127 ;; always run the code in it's own asynchronous subprocess
1128 (async
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001129 (let* ((buf (generate-new-buffer-name py-output-buffer)))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001130 (start-process "Python" buf py-python-command "-u" file)
1131 (pop-to-buffer buf)
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001132 (py-postprocess-output-buffer buf)
Barry Warsawa97a3f31997-11-04 18:47:06 +00001133 ))
1134 ;; if the Python interpreter shell is running, queue it up for
1135 ;; execution there.
1136 (proc
1137 ;; use the existing python shell
1138 (if (not py-file-queue)
1139 (py-execute-file proc file)
Barry Warsawa97a3f31997-11-04 18:47:06 +00001140 (message "File %s queued for execution" file))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001141 (push file py-file-queue)
1142 (setq py-exception-buffer (cons file (current-buffer))))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001143 (t
1144 ;; otherwise either run it synchronously in a subprocess
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001145 (shell-command-on-region start end py-python-command py-output-buffer)
1146 (setq py-exception-buffer (current-buffer))
1147 (py-postprocess-output-buffer py-output-buffer)
Barry Warsawa97a3f31997-11-04 18:47:06 +00001148 ))))
1149
1150;; Code execution command
1151(defun py-execute-buffer (&optional async)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001152 "Send the contents of the buffer to a Python interpreter.
1153If there is a *Python* process buffer it is used. If a clipping
1154restriction is in effect, only the accessible portion of the buffer is
1155sent. A trailing newline will be supplied if needed.
1156
1157See the `\\[py-execute-region]' docs for an account of some subtleties."
Barry Warsawa97a3f31997-11-04 18:47:06 +00001158 (interactive "P")
1159 (py-execute-region (point-min) (point-max) async))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001160
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001161
1162
1163(defun py-jump-to-exception (file line)
1164 (let ((buffer (cond ((string-equal file "<stdin>")
1165 py-exception-buffer)
1166 ((and (consp py-exception-buffer)
1167 (string-equal file (car py-exception-buffer)))
1168 (cdr py-exception-buffer))
1169 ((py-safe (find-file-noselect file)))
1170 ;; could not figure out what file the exception
1171 ;; is pointing to, so prompt for it
1172 (t (find-file (read-file-name "Exception file: "
1173 nil
1174 file t))))))
1175 (pop-to-buffer buffer)
1176 (goto-line line)
1177 (message "Jumping to exception in file %s on line %d" file line)))
1178
1179(defun py-mouseto-exception (event)
1180 (interactive "e")
1181 (cond
1182 ((fboundp 'event-point)
1183 ;; XEmacs
1184 (let* ((point (event-point event))
1185 (buffer (event-buffer event))
1186 (e (and point buffer (extent-at point buffer 'py-exc-info)))
1187 (info (and e (extent-property e 'py-exc-info))))
1188 (message "Event point: %d, info: %s" point info)
1189 (and info
1190 (py-jump-to-exception (car info) (cdr info)))
1191 ))
1192 ;; Emacs -- Please port this!
1193 ))
1194
1195(defun py-goto-exception ()
1196 "Go to the line indicated by the traceback."
1197 (interactive)
1198 (let (file line)
1199 (save-excursion
1200 (beginning-of-line)
1201 (if (looking-at py-traceback-line-re)
1202 (setq file (match-string 1)
1203 line (string-to-int (match-string 2)))))
1204 (if (not file)
1205 (error "Not on a traceback line."))
1206 (py-jump-to-exception file line)))
1207
1208(defun py-find-next-exception (start buffer searchdir errwhere)
1209 ;; Go to start position in buffer, search in the specified
1210 ;; direction, and jump to the exception found. If at the end of the
1211 ;; exception, print error message
1212 (let (file line)
1213 (save-excursion
1214 (set-buffer buffer)
1215 (goto-char (py-point start))
1216 (if (funcall searchdir py-traceback-line-re nil t)
1217 (setq file (match-string 1)
1218 line (string-to-int (match-string 2)))))
1219 (if (and file line)
1220 (py-jump-to-exception file line)
1221 (error "%s of traceback" errwhere))))
1222
1223(defun py-down-exception (&optional bottom)
1224 "Go to the next line down in the traceback.
1225With optional \\[universal-argument], jump to the bottom (innermost)
1226exception in the exception stack."
1227 (interactive "P")
1228 (let* ((proc (get-process "Python"))
1229 (buffer (if proc "*Python*" py-output-buffer)))
1230 (if bottom
1231 (py-find-next-exception 'eob buffer 're-search-backward "Bottom")
1232 (py-find-next-exception 'eol buffer 're-search-forward "Bottom"))))
1233
1234(defun py-up-exception (&optional top)
1235 "Go to the previous line up in the traceback.
1236With optional \\[universal-argument], jump to the top (outermost)
1237exception in the exception stack."
1238 (interactive "P")
1239 (let* ((proc (get-process "Python"))
1240 (buffer (if proc "*Python*" py-output-buffer)))
1241 (if top
1242 (py-find-next-exception 'bob buffer 're-search-forward "Top")
1243 (py-find-next-exception 'boi buffer 're-search-backward "Top"))))
1244
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001245
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001246;; Electric deletion
1247(defun py-electric-backspace (arg)
1248 "Deletes preceding character or levels of indentation.
1249Deletion is performed by calling the function in `py-backspace-function'
Barry Warsawb0539931996-12-17 22:05:07 +00001250with a single argument (the number of characters to delete).
Barry Warsaw7ae77681994-12-12 20:38:05 +00001251
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001252If point is at the leftmost column, deletes the preceding newline.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001253
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001254Otherwise, if point is at the leftmost non-whitespace character of a
1255line that is neither a continuation line nor a non-indenting comment
1256line, or if point is at the end of a blank line, this command reduces
1257the indentation to match that of the line that opened the current
1258block of code. The line that opened the block is displayed in the
1259echo area to help you keep track of where you are. With numeric arg,
1260outdents that many blocks (but not past column zero).
1261
1262Otherwise the preceding character is deleted, converting a tab to
1263spaces if needed so that only a single column position is deleted.
1264Numeric argument deletes that many preceding characters."
Barry Warsaw03970731996-07-03 23:12:52 +00001265 (interactive "*p")
Barry Warsaw7ae77681994-12-12 20:38:05 +00001266 (if (or (/= (current-indentation) (current-column))
1267 (bolp)
1268 (py-continuation-line-p)
Barry Warsaw6e527d21996-08-01 15:57:48 +00001269 (not py-honor-comment-indentation)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001270 (looking-at "#[^ \t\n]")) ; non-indenting #
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001271 (funcall py-backspace-function arg)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001272 ;; else indent the same as the colon line that opened the block
Barry Warsaw7ae77681994-12-12 20:38:05 +00001273 ;; force non-blank so py-goto-block-up doesn't ignore it
1274 (insert-char ?* 1)
1275 (backward-char)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001276 (let ((base-indent 0) ; indentation of base line
1277 (base-text "") ; and text of base line
1278 (base-found-p nil))
Barry Warsaw03970731996-07-03 23:12:52 +00001279 (save-excursion
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001280 (while (< 0 arg)
Barry Warsaw03970731996-07-03 23:12:52 +00001281 (condition-case nil ; in case no enclosing block
1282 (progn
1283 (py-goto-block-up 'no-mark)
1284 (setq base-indent (current-indentation)
1285 base-text (py-suck-up-leading-text)
1286 base-found-p t))
1287 (error nil))
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001288 (setq arg (1- arg))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001289 (delete-char 1) ; toss the dummy character
1290 (delete-horizontal-space)
1291 (indent-to base-indent)
1292 (if base-found-p
1293 (message "Closes block: %s" base-text)))))
1294
Barry Warsawfc8a01f1995-03-09 16:07:29 +00001295
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001296(defun py-electric-delete (arg)
1297 "Deletes preceding or following character or levels of whitespace.
1298
1299The behavior of this function depends on the variable
1300`delete-key-deletes-forward'. If this variable is nil (or does not
1301exist, as in older Emacsen), then this function behaves identical to
1302\\[c-electric-backspace].
1303
1304If `delete-key-deletes-forward' is non-nil and is supported in your
1305Emacs, then deletion occurs in the forward direction, by calling the
1306function in `py-delete-function'."
1307 (interactive "*p")
1308 (if (and (boundp 'delete-key-deletes-forward)
1309 delete-key-deletes-forward)
1310 (funcall py-delete-function arg)
1311 ;; else
1312 (py-electric-backspace arg)))
1313
1314;; required for pending-del and delsel modes
1315(put 'py-electric-backspace 'delete-selection 'supersede) ;delsel
1316(put 'py-electric-backspace 'pending-delete 'supersede) ;pending-del
1317(put 'py-electric-delete 'delete-selection 'supersede) ;delsel
1318(put 'py-electric-delete 'pending-delete 'supersede) ;pending-del
1319
1320
1321
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001322(defun py-indent-line (&optional arg)
1323 "Fix the indentation of the current line according to Python rules.
1324With \\[universal-argument], ignore outdenting rules for block
1325closing statements (e.g. return, raise, break, continue, pass)
1326
1327This function is normally bound to `indent-line-function' so
1328\\[indent-for-tab-command] will call it."
1329 (interactive "P")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001330 (let* ((ci (current-indentation))
1331 (move-to-indentation-p (<= (current-column) ci))
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001332 (need (py-compute-indentation (not arg))))
Barry Warsaw4f009fb1995-03-14 20:53:08 +00001333 ;; see if we need to outdent
Barry Warsaw3874a3d1995-03-14 22:05:53 +00001334 (if (py-outdent-p)
Barry Warsaw0012c1e1995-03-14 16:32:55 +00001335 (setq need (- need py-indent-offset)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001336 (if (/= ci need)
1337 (save-excursion
1338 (beginning-of-line)
1339 (delete-horizontal-space)
1340 (indent-to need)))
1341 (if move-to-indentation-p (back-to-indentation))))
1342
1343(defun py-newline-and-indent ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001344 "Strives to act like the Emacs `newline-and-indent'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001345This is just `strives to' because correct indentation can't be computed
1346from scratch for Python code. In general, deletes the whitespace before
1347point, inserts a newline, and takes an educated guess as to how you want
1348the new line indented."
1349 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001350 (let ((ci (current-indentation)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001351 (if (< ci (current-column)) ; if point beyond indentation
1352 (newline-and-indent)
1353 ;; else try to act like newline-and-indent "normally" acts
1354 (beginning-of-line)
1355 (insert-char ?\n 1)
1356 (move-to-column ci))))
1357
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001358(defun py-compute-indentation (honor-block-close-p)
1359 ;; implements all the rules for indentation computation. when
1360 ;; honor-block-close-p is non-nil, statements such as return, raise,
1361 ;; break, continue, and pass force one level of outdenting.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001362 (save-excursion
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001363 (let* ((bod (py-point 'bod))
1364 (pps (parse-partial-sexp bod (point))))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001365 (beginning-of-line)
1366 (cond
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001367 ;; are we inside a multi-line string or comment?
1368 ((or (and (nth 3 pps)
1369 (nth 3 (parse-partial-sexp bod (py-point 'boi))))
1370 (nth 4 pps))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001371 (save-excursion
1372 (if (not py-align-multiline-strings-p) 0
1373 ;; skip back over blank & non-indenting comment lines
1374 ;; note: will skip a blank or non-indenting comment line
1375 ;; that happens to be a continuation line too
1376 (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#[ \t\n]\\)" nil 'move)
1377 (back-to-indentation)
1378 (current-column))))
1379 ;; are we on a continuation line?
1380 ((py-continuation-line-p)
1381 (let ((startpos (point))
1382 (open-bracket-pos (py-nesting-level))
Barry Warsawce60bc71996-08-01 18:17:14 +00001383 endpos searching found state)
Barry Warsaw095e9c61995-09-19 20:01:42 +00001384 (if open-bracket-pos
1385 (progn
1386 ;; align with first item in list; else a normal
1387 ;; indent beyond the line with the open bracket
1388 (goto-char (1+ open-bracket-pos)) ; just beyond bracket
1389 ;; is the first list item on the same line?
1390 (skip-chars-forward " \t")
1391 (if (null (memq (following-char) '(?\n ?# ?\\)))
1392 ; yes, so line up with it
1393 (current-column)
1394 ;; first list item on another line, or doesn't exist yet
1395 (forward-line 1)
1396 (while (and (< (point) startpos)
1397 (looking-at "[ \t]*[#\n\\\\]")) ; skip noise
1398 (forward-line 1))
1399 (if (< (point) startpos)
1400 ;; again mimic the first list item
1401 (current-indentation)
1402 ;; else they're about to enter the first item
1403 (goto-char open-bracket-pos)
1404 (+ (current-indentation) py-indent-offset))))
1405
1406 ;; else on backslash continuation line
1407 (forward-line -1)
1408 (if (py-continuation-line-p) ; on at least 3rd line in block
1409 (current-indentation) ; so just continue the pattern
1410 ;; else started on 2nd line in block, so indent more.
1411 ;; if base line is an assignment with a start on a RHS,
1412 ;; indent to 2 beyond the leftmost "="; else skip first
1413 ;; chunk of non-whitespace characters on base line, + 1 more
1414 ;; column
1415 (end-of-line)
1416 (setq endpos (point) searching t)
1417 (back-to-indentation)
1418 (setq startpos (point))
1419 ;; look at all "=" from left to right, stopping at first
1420 ;; one not nested in a list or string
1421 (while searching
1422 (skip-chars-forward "^=" endpos)
1423 (if (= (point) endpos)
1424 (setq searching nil)
1425 (forward-char 1)
1426 (setq state (parse-partial-sexp startpos (point)))
1427 (if (and (zerop (car state)) ; not in a bracket
1428 (null (nth 3 state))) ; & not in a string
1429 (progn
1430 (setq searching nil) ; done searching in any case
1431 (setq found
1432 (not (or
1433 (eq (following-char) ?=)
1434 (memq (char-after (- (point) 2))
1435 '(?< ?> ?!)))))))))
1436 (if (or (not found) ; not an assignment
1437 (looking-at "[ \t]*\\\\")) ; <=><spaces><backslash>
1438 (progn
1439 (goto-char startpos)
1440 (skip-chars-forward "^ \t\n")))
1441 (1+ (current-column))))))
1442
1443 ;; not on a continuation line
Barry Warsawa7891711996-08-01 15:53:09 +00001444 ((bobp) (current-indentation))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001445
Barry Warsawa7891711996-08-01 15:53:09 +00001446 ;; Dfn: "Indenting comment line". A line containing only a
1447 ;; comment, but which is treated like a statement for
1448 ;; indentation calculation purposes. Such lines are only
1449 ;; treated specially by the mode; they are not treated
1450 ;; specially by the Python interpreter.
1451
1452 ;; The rules for indenting comment lines are a line where:
1453 ;; - the first non-whitespace character is `#', and
1454 ;; - the character following the `#' is whitespace, and
1455 ;; - the line is outdented with respect to (i.e. to the left
1456 ;; of) the indentation of the preceding non-blank line.
1457
1458 ;; The first non-blank line following an indenting comment
1459 ;; line is given the same amount of indentation as the
1460 ;; indenting comment line.
1461
1462 ;; All other comment-only lines are ignored for indentation
1463 ;; purposes.
1464
1465 ;; Are we looking at a comment-only line which is *not* an
1466 ;; indenting comment line? If so, we assume that its been
1467 ;; placed at the desired indentation, so leave it alone.
1468 ;; Indenting comment lines are aligned as statements down
1469 ;; below.
1470 ((and (looking-at "[ \t]*#[^ \t\n]")
1471 ;; NOTE: this test will not be performed in older Emacsen
1472 (fboundp 'forward-comment)
1473 (<= (current-indentation)
1474 (save-excursion
1475 (forward-comment (- (point-max)))
1476 (current-indentation))))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001477 (current-indentation))
1478
1479 ;; else indentation based on that of the statement that
1480 ;; precedes us; use the first line of that statement to
1481 ;; establish the base, in case the user forced a non-std
1482 ;; indentation for the continuation lines (if any)
1483 (t
Barry Warsawc01c5c81995-09-14 18:49:11 +00001484 ;; skip back over blank & non-indenting comment lines note:
1485 ;; will skip a blank or non-indenting comment line that
Barry Warsawfd0fb381996-03-04 17:15:40 +00001486 ;; happens to be a continuation line too. use fast Emacs 19
1487 ;; function if it's there.
Barry Warsaw6d627751996-03-06 18:41:38 +00001488 (if (and (eq py-honor-comment-indentation nil)
Barry Warsaw33d6ec01996-03-05 16:28:07 +00001489 (fboundp 'forward-comment))
Barry Warsawfd0fb381996-03-04 17:15:40 +00001490 (forward-comment (- (point-max)))
Barry Warsaw6d627751996-03-06 18:41:38 +00001491 (let (done)
1492 (while (not done)
1493 (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#[ \t\n]\\)"
1494 nil 'move)
1495 (setq done (or (eq py-honor-comment-indentation t)
1496 (bobp)
1497 (/= (following-char) ?#)
1498 (not (zerop (current-column)))))
1499 )))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001500 ;; if we landed inside a string, go to the beginning of that
1501 ;; string. this handles triple quoted, multi-line spanning
1502 ;; strings.
1503 (py-goto-initial-line)
Barry Warsawf831d811996-07-31 20:42:59 +00001504 (+ (current-indentation)
1505 (if (py-statement-opens-block-p)
1506 py-indent-offset
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001507 (if (and honor-block-close-p (py-statement-closes-block-p))
Barry Warsawf831d811996-07-31 20:42:59 +00001508 (- py-indent-offset)
1509 0)))
1510 )))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001511
1512(defun py-guess-indent-offset (&optional global)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001513 "Guess a good value for, and change, `py-indent-offset'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001514By default (without a prefix arg), makes a buffer-local copy of
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001515`py-indent-offset' with the new value. This will not affect any other
Barry Warsaw7ae77681994-12-12 20:38:05 +00001516Python buffers. With a prefix arg, changes the global value of
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001517`py-indent-offset'. This affects all Python buffers (that don't have
Barry Warsaw7ae77681994-12-12 20:38:05 +00001518their own buffer-local copy), both those currently existing and those
1519created later in the Emacs session.
1520
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001521Some people use a different value for `py-indent-offset' than you use.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001522There's no excuse for such foolishness, but sometimes you have to deal
1523with their ugly code anyway. This function examines the file and sets
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001524`py-indent-offset' to what it thinks it was when they created the
1525mess.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001526
1527Specifically, it searches forward from the statement containing point,
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001528looking for a line that opens a block of code. `py-indent-offset' is
1529set to the difference in indentation between that line and the Python
Barry Warsaw7ae77681994-12-12 20:38:05 +00001530statement following it. If the search doesn't succeed going forward,
1531it's tried again going backward."
1532 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001533 (let (new-value
1534 (start (point))
1535 restart
1536 (found nil)
1537 colon-indent)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001538 (py-goto-initial-line)
1539 (while (not (or found (eobp)))
1540 (if (re-search-forward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
1541 (progn
1542 (setq restart (point))
1543 (py-goto-initial-line)
1544 (if (py-statement-opens-block-p)
1545 (setq found t)
1546 (goto-char restart)))))
1547 (if found
1548 ()
1549 (goto-char start)
1550 (py-goto-initial-line)
1551 (while (not (or found (bobp)))
1552 (setq found
1553 (and
1554 (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
1555 (or (py-goto-initial-line) t) ; always true -- side effect
1556 (py-statement-opens-block-p)))))
1557 (setq colon-indent (current-indentation)
1558 found (and found (zerop (py-next-statement 1)))
1559 new-value (- (current-indentation) colon-indent))
1560 (goto-char start)
1561 (if found
1562 (progn
1563 (funcall (if global 'kill-local-variable 'make-local-variable)
1564 'py-indent-offset)
1565 (setq py-indent-offset new-value)
1566 (message "%s value of py-indent-offset set to %d"
1567 (if global "Global" "Local")
1568 py-indent-offset))
1569 (error "Sorry, couldn't guess a value for py-indent-offset"))))
1570
1571(defun py-shift-region (start end count)
1572 (save-excursion
1573 (goto-char end) (beginning-of-line) (setq end (point))
1574 (goto-char start) (beginning-of-line) (setq start (point))
1575 (indent-rigidly start end count)))
1576
1577(defun py-shift-region-left (start end &optional count)
1578 "Shift region of Python code to the left.
1579The lines from the line containing the start of the current region up
1580to (but not including) the line containing the end of the region are
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001581shifted to the left, by `py-indent-offset' columns.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001582
1583If a prefix argument is given, the region is instead shifted by that
Barry Warsawdea4a291996-07-03 22:59:12 +00001584many columns. With no active region, outdent only the current line.
1585You cannot outdent the region if any line is already at column zero."
1586 (interactive
1587 (let ((p (point))
1588 (m (mark))
1589 (arg current-prefix-arg))
1590 (if m
1591 (list (min p m) (max p m) arg)
1592 (list p (save-excursion (forward-line 1) (point)) arg))))
1593 ;; if any line is at column zero, don't shift the region
1594 (save-excursion
1595 (goto-char start)
1596 (while (< (point) end)
1597 (back-to-indentation)
Barry Warsaw71e315b1996-07-23 15:03:16 +00001598 (if (and (zerop (current-column))
1599 (not (looking-at "\\s *$")))
Barry Warsawdea4a291996-07-03 22:59:12 +00001600 (error "Region is at left edge."))
1601 (forward-line 1)))
1602 (py-shift-region start end (- (prefix-numeric-value
1603 (or count py-indent-offset))))
1604 (py-keep-region-active))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001605
1606(defun py-shift-region-right (start end &optional count)
1607 "Shift region of Python code to the right.
1608The lines from the line containing the start of the current region up
1609to (but not including) the line containing the end of the region are
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001610shifted to the right, by `py-indent-offset' columns.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001611
1612If a prefix argument is given, the region is instead shifted by that
Barry Warsawdea4a291996-07-03 22:59:12 +00001613many columns. With no active region, indent only the current line."
1614 (interactive
1615 (let ((p (point))
1616 (m (mark))
1617 (arg current-prefix-arg))
1618 (if m
1619 (list (min p m) (max p m) arg)
1620 (list p (save-excursion (forward-line 1) (point)) arg))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001621 (py-shift-region start end (prefix-numeric-value
Barry Warsawdea4a291996-07-03 22:59:12 +00001622 (or count py-indent-offset)))
1623 (py-keep-region-active))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001624
1625(defun py-indent-region (start end &optional indent-offset)
1626 "Reindent a region of Python code.
Barry Warsaw867a32a1996-03-07 18:30:26 +00001627
Barry Warsaw7ae77681994-12-12 20:38:05 +00001628The lines from the line containing the start of the current region up
1629to (but not including) the line containing the end of the region are
1630reindented. If the first line of the region has a non-whitespace
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001631character in the first column, the first line is left alone and the
1632rest of the region is reindented with respect to it. Else the entire
Barry Warsaw867a32a1996-03-07 18:30:26 +00001633region is reindented with respect to the (closest code or indenting
1634comment) statement immediately preceding the region.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001635
1636This is useful when code blocks are moved or yanked, when enclosing
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001637control structures are introduced or removed, or to reformat code
1638using a new value for the indentation offset.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001639
1640If a numeric prefix argument is given, it will be used as the value of
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001641the indentation offset. Else the value of `py-indent-offset' will be
Barry Warsaw7ae77681994-12-12 20:38:05 +00001642used.
1643
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001644Warning: The region must be consistently indented before this function
Barry Warsaw7ae77681994-12-12 20:38:05 +00001645is called! This function does not compute proper indentation from
1646scratch (that's impossible in Python), it merely adjusts the existing
1647indentation to be correct in context.
1648
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001649Warning: This function really has no idea what to do with
1650non-indenting comment lines, and shifts them as if they were indenting
1651comment lines. Fixing this appears to require telepathy.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001652
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001653Special cases: whitespace is deleted from blank lines; continuation
1654lines are shifted by the same amount their initial line was shifted,
1655in order to preserve their relative indentation with respect to their
Barry Warsaw7ae77681994-12-12 20:38:05 +00001656initial line; and comment lines beginning in column 1 are ignored."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001657 (interactive "*r\nP") ; region; raw prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00001658 (save-excursion
1659 (goto-char end) (beginning-of-line) (setq end (point-marker))
1660 (goto-char start) (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001661 (let ((py-indent-offset (prefix-numeric-value
1662 (or indent-offset py-indent-offset)))
1663 (indents '(-1)) ; stack of active indent levels
1664 (target-column 0) ; column to which to indent
1665 (base-shifted-by 0) ; amount last base line was shifted
1666 (indent-base (if (looking-at "[ \t\n]")
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001667 (py-compute-indentation t)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001668 0))
1669 ci)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001670 (while (< (point) end)
1671 (setq ci (current-indentation))
1672 ;; figure out appropriate target column
1673 (cond
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001674 ((or (eq (following-char) ?#) ; comment in column 1
1675 (looking-at "[ \t]*$")) ; entirely blank
1676 (setq target-column 0))
1677 ((py-continuation-line-p) ; shift relative to base line
1678 (setq target-column (+ ci base-shifted-by)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001679 (t ; new base line
1680 (if (> ci (car indents)) ; going deeper; push it
1681 (setq indents (cons ci indents))
1682 ;; else we should have seen this indent before
1683 (setq indents (memq ci indents)) ; pop deeper indents
1684 (if (null indents)
1685 (error "Bad indentation in region, at line %d"
1686 (save-restriction
1687 (widen)
1688 (1+ (count-lines 1 (point)))))))
1689 (setq target-column (+ indent-base
1690 (* py-indent-offset
1691 (- (length indents) 2))))
1692 (setq base-shifted-by (- target-column ci))))
1693 ;; shift as needed
1694 (if (/= ci target-column)
1695 (progn
1696 (delete-horizontal-space)
1697 (indent-to target-column)))
1698 (forward-line 1))))
1699 (set-marker end nil))
1700
Barry Warsawa7891711996-08-01 15:53:09 +00001701(defun py-comment-region (beg end &optional arg)
1702 "Like `comment-region' but uses double hash (`#') comment starter."
1703 (interactive "r\nP")
Barry Warsaw3fcaf611996-08-01 20:11:51 +00001704 (let ((comment-start py-block-comment-prefix))
Barry Warsawa7891711996-08-01 15:53:09 +00001705 (comment-region beg end arg)))
1706
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001707
1708;; Functions for moving point
Barry Warsaw7ae77681994-12-12 20:38:05 +00001709(defun py-previous-statement (count)
1710 "Go to the start of previous Python statement.
1711If the statement at point is the i'th Python statement, goes to the
1712start of statement i-COUNT. If there is no such statement, goes to the
1713first statement. Returns count of statements left to move.
1714`Statements' do not include blank, comment, or continuation lines."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001715 (interactive "p") ; numeric prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00001716 (if (< count 0) (py-next-statement (- count))
1717 (py-goto-initial-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001718 (let (start)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001719 (while (and
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001720 (setq start (point)) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00001721 (> count 0)
1722 (zerop (forward-line -1))
1723 (py-goto-statement-at-or-above))
1724 (setq count (1- count)))
1725 (if (> count 0) (goto-char start)))
1726 count))
1727
1728(defun py-next-statement (count)
1729 "Go to the start of next Python statement.
1730If the statement at point is the i'th Python statement, goes to the
1731start of statement i+COUNT. If there is no such statement, goes to the
1732last statement. Returns count of statements left to move. `Statements'
1733do not include blank, comment, or continuation lines."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001734 (interactive "p") ; numeric prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00001735 (if (< count 0) (py-previous-statement (- count))
1736 (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001737 (let (start)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001738 (while (and
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001739 (setq start (point)) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00001740 (> count 0)
1741 (py-goto-statement-below))
1742 (setq count (1- count)))
1743 (if (> count 0) (goto-char start)))
1744 count))
1745
1746(defun py-goto-block-up (&optional nomark)
1747 "Move up to start of current block.
1748Go to the statement that starts the smallest enclosing block; roughly
1749speaking, this will be the closest preceding statement that ends with a
1750colon and is indented less than the statement you started on. If
1751successful, also sets the mark to the starting point.
1752
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001753`\\[py-mark-block]' can be used afterward to mark the whole code
1754block, if desired.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001755
1756If called from a program, the mark will not be set if optional argument
1757NOMARK is not nil."
1758 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001759 (let ((start (point))
1760 (found nil)
1761 initial-indent)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001762 (py-goto-initial-line)
1763 ;; if on blank or non-indenting comment line, use the preceding stmt
1764 (if (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)")
1765 (progn
1766 (py-goto-statement-at-or-above)
1767 (setq found (py-statement-opens-block-p))))
1768 ;; search back for colon line indented less
1769 (setq initial-indent (current-indentation))
1770 (if (zerop initial-indent)
1771 ;; force fast exit
1772 (goto-char (point-min)))
1773 (while (not (or found (bobp)))
1774 (setq found
1775 (and
1776 (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
1777 (or (py-goto-initial-line) t) ; always true -- side effect
1778 (< (current-indentation) initial-indent)
1779 (py-statement-opens-block-p))))
1780 (if found
1781 (progn
1782 (or nomark (push-mark start))
1783 (back-to-indentation))
1784 (goto-char start)
1785 (error "Enclosing block not found"))))
1786
1787(defun beginning-of-python-def-or-class (&optional class)
1788 "Move point to start of def (or class, with prefix arg).
1789
1790Searches back for the closest preceding `def'. If you supply a prefix
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001791arg, looks for a `class' instead. The docs assume the `def' case;
1792just substitute `class' for `def' for the other case.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001793
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001794If point is in a def statement already, and after the `d', simply
1795moves point to the start of the statement.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001796
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001797Else (point is not in a def statement, or at or before the `d' of a
1798def statement), searches for the closest preceding def statement, and
1799leaves point at its start. If no such statement can be found, leaves
1800point at the start of the buffer.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001801
1802Returns t iff a def statement is found by these rules.
1803
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001804Note that doing this command repeatedly will take you closer to the
1805start of the buffer each time.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001806
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001807If you want to mark the current def/class, see
Barry Warsaw2518c671997-11-05 00:51:08 +00001808`\\[py-mark-def-or-class]'."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001809 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001810 (let ((at-or-before-p (<= (current-column) (current-indentation)))
1811 (start-of-line (progn (beginning-of-line) (point)))
1812 (start-of-stmt (progn (py-goto-initial-line) (point))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001813 (if (or (/= start-of-stmt start-of-line)
1814 (not at-or-before-p))
1815 (end-of-line)) ; OK to match on this line
1816 (re-search-backward (if class "^[ \t]*class\\>" "^[ \t]*def\\>")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001817 nil 'move)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001818
1819(defun end-of-python-def-or-class (&optional class)
1820 "Move point beyond end of def (or class, with prefix arg) body.
1821
1822By default, looks for an appropriate `def'. If you supply a prefix arg,
1823looks for a `class' instead. The docs assume the `def' case; just
1824substitute `class' for `def' for the other case.
1825
1826If point is in a def statement already, this is the def we use.
1827
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001828Else if the def found by `\\[beginning-of-python-def-or-class]'
1829contains the statement you started on, that's the def we use.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001830
1831Else we search forward for the closest following def, and use that.
1832
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001833If a def can be found by these rules, point is moved to the start of
1834the line immediately following the def block, and the position of the
1835start of the def is returned.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001836
1837Else point is moved to the end of the buffer, and nil is returned.
1838
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001839Note that doing this command repeatedly will take you closer to the
1840end of the buffer each time.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001841
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001842If you want to mark the current def/class, see
Barry Warsaw2518c671997-11-05 00:51:08 +00001843`\\[py-mark-def-or-class]'."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001844 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001845 (let ((start (progn (py-goto-initial-line) (point)))
1846 (which (if class "class" "def"))
1847 (state 'not-found))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001848 ;; move point to start of appropriate def/class
1849 (if (looking-at (concat "[ \t]*" which "\\>")) ; already on one
1850 (setq state 'at-beginning)
1851 ;; else see if beginning-of-python-def-or-class hits container
1852 (if (and (beginning-of-python-def-or-class class)
1853 (progn (py-goto-beyond-block)
1854 (> (point) start)))
1855 (setq state 'at-end)
1856 ;; else search forward
1857 (goto-char start)
1858 (if (re-search-forward (concat "^[ \t]*" which "\\>") nil 'move)
1859 (progn (setq state 'at-beginning)
1860 (beginning-of-line)))))
1861 (cond
1862 ((eq state 'at-beginning) (py-goto-beyond-block) t)
1863 ((eq state 'at-end) t)
1864 ((eq state 'not-found) nil)
1865 (t (error "internal error in end-of-python-def-or-class")))))
1866
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001867
1868;; Functions for marking regions
Barry Warsaw7ae77681994-12-12 20:38:05 +00001869(defun py-mark-block (&optional extend just-move)
1870 "Mark following block of lines. With prefix arg, mark structure.
1871Easier to use than explain. It sets the region to an `interesting'
1872block of succeeding lines. If point is on a blank line, it goes down to
1873the next non-blank line. That will be the start of the region. The end
1874of the region depends on the kind of line at the start:
1875
1876 - If a comment, the region will include all succeeding comment lines up
1877 to (but not including) the next non-comment line (if any).
1878
1879 - Else if a prefix arg is given, and the line begins one of these
1880 structures:
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001881
1882 if elif else try except finally for while def class
1883
Barry Warsaw7ae77681994-12-12 20:38:05 +00001884 the region will be set to the body of the structure, including
1885 following blocks that `belong' to it, but excluding trailing blank
1886 and comment lines. E.g., if on a `try' statement, the `try' block
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001887 and all (if any) of the following `except' and `finally' blocks
1888 that belong to the `try' structure will be in the region. Ditto
1889 for if/elif/else, for/else and while/else structures, and (a bit
1890 degenerate, since they're always one-block structures) def and
1891 class blocks.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001892
1893 - Else if no prefix argument is given, and the line begins a Python
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001894 block (see list above), and the block is not a `one-liner' (i.e.,
1895 the statement ends with a colon, not with code), the region will
1896 include all succeeding lines up to (but not including) the next
1897 code statement (if any) that's indented no more than the starting
1898 line, except that trailing blank and comment lines are excluded.
1899 E.g., if the starting line begins a multi-statement `def'
1900 structure, the region will be set to the full function definition,
1901 but without any trailing `noise' lines.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001902
1903 - Else the region will include all succeeding lines up to (but not
1904 including) the next blank line, or code or indenting-comment line
1905 indented strictly less than the starting line. Trailing indenting
1906 comment lines are included in this case, but not trailing blank
1907 lines.
1908
1909A msg identifying the location of the mark is displayed in the echo
1910area; or do `\\[exchange-point-and-mark]' to flip down to the end.
1911
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001912If called from a program, optional argument EXTEND plays the role of
1913the prefix arg, and if optional argument JUST-MOVE is not nil, just
1914moves to the end of the block (& does not set mark or display a msg)."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001915 (interactive "P") ; raw prefix arg
1916 (py-goto-initial-line)
1917 ;; skip over blank lines
1918 (while (and
1919 (looking-at "[ \t]*$") ; while blank line
1920 (not (eobp))) ; & somewhere to go
1921 (forward-line 1))
1922 (if (eobp)
1923 (error "Hit end of buffer without finding a non-blank stmt"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001924 (let ((initial-pos (point))
1925 (initial-indent (current-indentation))
1926 last-pos ; position of last stmt in region
1927 (followers
1928 '((if elif else) (elif elif else) (else)
1929 (try except finally) (except except) (finally)
1930 (for else) (while else)
1931 (def) (class) ) )
1932 first-symbol next-symbol)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001933
1934 (cond
1935 ;; if comment line, suck up the following comment lines
1936 ((looking-at "[ \t]*#")
1937 (re-search-forward "^[ \t]*[^ \t#]" nil 'move) ; look for non-comment
1938 (re-search-backward "^[ \t]*#") ; and back to last comment in block
1939 (setq last-pos (point)))
1940
1941 ;; else if line is a block line and EXTEND given, suck up
1942 ;; the whole structure
1943 ((and extend
1944 (setq first-symbol (py-suck-up-first-keyword) )
1945 (assq first-symbol followers))
1946 (while (and
1947 (or (py-goto-beyond-block) t) ; side effect
1948 (forward-line -1) ; side effect
1949 (setq last-pos (point)) ; side effect
1950 (py-goto-statement-below)
1951 (= (current-indentation) initial-indent)
1952 (setq next-symbol (py-suck-up-first-keyword))
1953 (memq next-symbol (cdr (assq first-symbol followers))))
1954 (setq first-symbol next-symbol)))
1955
1956 ;; else if line *opens* a block, search for next stmt indented <=
1957 ((py-statement-opens-block-p)
1958 (while (and
1959 (setq last-pos (point)) ; always true -- side effect
1960 (py-goto-statement-below)
1961 (> (current-indentation) initial-indent))
1962 nil))
1963
1964 ;; else plain code line; stop at next blank line, or stmt or
1965 ;; indenting comment line indented <
1966 (t
1967 (while (and
1968 (setq last-pos (point)) ; always true -- side effect
1969 (or (py-goto-beyond-final-line) t)
1970 (not (looking-at "[ \t]*$")) ; stop at blank line
1971 (or
1972 (>= (current-indentation) initial-indent)
1973 (looking-at "[ \t]*#[^ \t\n]"))) ; ignore non-indenting #
1974 nil)))
1975
1976 ;; skip to end of last stmt
1977 (goto-char last-pos)
1978 (py-goto-beyond-final-line)
1979
1980 ;; set mark & display
1981 (if just-move
1982 () ; just return
1983 (push-mark (point) 'no-msg)
1984 (forward-line -1)
1985 (message "Mark set after: %s" (py-suck-up-leading-text))
1986 (goto-char initial-pos))))
1987
Barry Warsaw2518c671997-11-05 00:51:08 +00001988(defun py-mark-def-or-class (&optional class)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001989 "Set region to body of def (or class, with prefix arg) enclosing point.
1990Pushes the current mark, then point, on the mark ring (all language
1991modes do this, but although it's handy it's never documented ...).
1992
1993In most Emacs language modes, this function bears at least a
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001994hallucinogenic resemblance to `\\[end-of-python-def-or-class]' and
1995`\\[beginning-of-python-def-or-class]'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001996
1997And in earlier versions of Python mode, all 3 were tightly connected.
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001998Turned out that was more confusing than useful: the `goto start' and
1999`goto end' commands are usually used to search through a file, and
2000people expect them to act a lot like `search backward' and `search
2001forward' string-search commands. But because Python `def' and `class'
2002can nest to arbitrary levels, finding the smallest def containing
2003point cannot be done via a simple backward search: the def containing
2004point may not be the closest preceding def, or even the closest
2005preceding def that's indented less. The fancy algorithm required is
2006appropriate for the usual uses of this `mark' command, but not for the
2007`goto' variations.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002008
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002009So the def marked by this command may not be the one either of the
2010`goto' commands find: If point is on a blank or non-indenting comment
2011line, moves back to start of the closest preceding code statement or
2012indenting comment line. If this is a `def' statement, that's the def
2013we use. Else searches for the smallest enclosing `def' block and uses
2014that. Else signals an error.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002015
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002016When an enclosing def is found: The mark is left immediately beyond
2017the last line of the def block. Point is left at the start of the
2018def, except that: if the def is preceded by a number of comment lines
2019followed by (at most) one optional blank line, point is left at the
2020start of the comments; else if the def is preceded by a blank line,
2021point is left at its start.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002022
2023The intent is to mark the containing def/class and its associated
2024documentation, to make moving and duplicating functions and classes
2025pleasant."
2026 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002027 (let ((start (point))
2028 (which (if class "class" "def")))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002029 (push-mark start)
2030 (if (not (py-go-up-tree-to-keyword which))
2031 (progn (goto-char start)
2032 (error "Enclosing %s not found" which))
2033 ;; else enclosing def/class found
2034 (setq start (point))
2035 (py-goto-beyond-block)
2036 (push-mark (point))
2037 (goto-char start)
2038 (if (zerop (forward-line -1)) ; if there is a preceding line
2039 (progn
2040 (if (looking-at "[ \t]*$") ; it's blank
2041 (setq start (point)) ; so reset start point
2042 (goto-char start)) ; else try again
2043 (if (zerop (forward-line -1))
2044 (if (looking-at "[ \t]*#") ; a comment
2045 ;; look back for non-comment line
2046 ;; tricky: note that the regexp matches a blank
2047 ;; line, cuz \n is in the 2nd character class
2048 (and
2049 (re-search-backward "^[ \t]*[^ \t#]" nil 'move)
2050 (forward-line 1))
2051 ;; no comment, so go back
Barry Warsaw4da6bd51997-11-26 06:00:26 +00002052 (goto-char start)))))))
2053 (exchange-point-and-mark)
2054 (py-keep-region-active))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002055
Barry Warsaw9e5a9c81996-07-24 18:26:53 +00002056;; ripped from cc-mode
2057(defun py-forward-into-nomenclature (&optional arg)
2058 "Move forward to end of a nomenclature section or word.
2059With arg, to it arg times.
2060
2061A `nomenclature' is a fancy way of saying AWordWithMixedCaseNotUnderscores."
2062 (interactive "p")
2063 (let ((case-fold-search nil))
2064 (if (> arg 0)
Barry Warsawc5a8cbd1996-08-05 21:53:02 +00002065 (re-search-forward
2066 "\\(\\W\\|[_]\\)*\\([A-Z]*[a-z0-9]*\\)"
2067 (point-max) t arg)
Barry Warsaw9e5a9c81996-07-24 18:26:53 +00002068 (while (and (< arg 0)
2069 (re-search-backward
Barry Warsawc5a8cbd1996-08-05 21:53:02 +00002070 "\\(\\W\\|[a-z0-9]\\)[A-Z]+\\|\\(\\W\\|[_]\\)\\w+"
Barry Warsaw9e5a9c81996-07-24 18:26:53 +00002071 (point-min) 0))
2072 (forward-char 1)
2073 (setq arg (1+ arg)))))
2074 (py-keep-region-active))
2075
2076(defun py-backward-into-nomenclature (&optional arg)
2077 "Move backward to beginning of a nomenclature section or word.
2078With optional ARG, move that many times. If ARG is negative, move
2079forward.
2080
2081A `nomenclature' is a fancy way of saying AWordWithMixedCaseNotUnderscores."
2082 (interactive "p")
2083 (py-forward-into-nomenclature (- arg))
2084 (py-keep-region-active))
2085
2086
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002087
2088;; Documentation functions
Barry Warsaw7ae77681994-12-12 20:38:05 +00002089
2090;; dump the long form of the mode blurb; does the usual doc escapes,
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002091;; plus lines of the form ^[vc]:name$ to suck variable & command docs
2092;; out of the right places, along with the keys they're on & current
2093;; values
Barry Warsaw7ae77681994-12-12 20:38:05 +00002094(defun py-dump-help-string (str)
2095 (with-output-to-temp-buffer "*Help*"
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002096 (let ((locals (buffer-local-variables))
2097 funckind funcname func funcdoc
2098 (start 0) mstart end
2099 keys )
Barry Warsaw7ae77681994-12-12 20:38:05 +00002100 (while (string-match "^%\\([vc]\\):\\(.+\\)\n" str start)
2101 (setq mstart (match-beginning 0) end (match-end 0)
2102 funckind (substring str (match-beginning 1) (match-end 1))
2103 funcname (substring str (match-beginning 2) (match-end 2))
2104 func (intern funcname))
2105 (princ (substitute-command-keys (substring str start mstart)))
2106 (cond
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002107 ((equal funckind "c") ; command
2108 (setq funcdoc (documentation func)
2109 keys (concat
2110 "Key(s): "
2111 (mapconcat 'key-description
2112 (where-is-internal func py-mode-map)
2113 ", "))))
2114 ((equal funckind "v") ; variable
Barry Warsaw604cefa1996-09-03 18:17:04 +00002115 (setq funcdoc (documentation-property func 'variable-documentation)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002116 keys (if (assq func locals)
2117 (concat
2118 "Local/Global values: "
2119 (prin1-to-string (symbol-value func))
2120 " / "
2121 (prin1-to-string (default-value func)))
2122 (concat
2123 "Value: "
2124 (prin1-to-string (symbol-value func))))))
2125 (t ; unexpected
2126 (error "Error in py-dump-help-string, tag `%s'" funckind)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002127 (princ (format "\n-> %s:\t%s\t%s\n\n"
2128 (if (equal funckind "c") "Command" "Variable")
2129 funcname keys))
2130 (princ funcdoc)
2131 (terpri)
2132 (setq start end))
2133 (princ (substitute-command-keys (substring str start))))
2134 (print-help-return-message)))
2135
2136(defun py-describe-mode ()
2137 "Dump long form of Python-mode docs."
2138 (interactive)
2139 (py-dump-help-string "Major mode for editing Python files.
2140Knows about Python indentation, tokens, comments and continuation lines.
2141Paragraphs are separated by blank lines only.
2142
2143Major sections below begin with the string `@'; specific function and
2144variable docs begin with `->'.
2145
2146@EXECUTING PYTHON CODE
2147
2148\\[py-execute-buffer]\tsends the entire buffer to the Python interpreter
2149\\[py-execute-region]\tsends the current region
2150\\[py-shell]\tstarts a Python interpreter window; this will be used by
2151\tsubsequent \\[py-execute-buffer] or \\[py-execute-region] commands
2152%c:py-execute-buffer
2153%c:py-execute-region
2154%c:py-shell
2155
2156@VARIABLES
2157
2158py-indent-offset\tindentation increment
Barry Warsaw42f707f1996-07-29 21:05:05 +00002159py-block-comment-prefix\tcomment string used by comment-region
Barry Warsaw7ae77681994-12-12 20:38:05 +00002160
2161py-python-command\tshell command to invoke Python interpreter
2162py-scroll-process-buffer\talways scroll Python process buffer
2163py-temp-directory\tdirectory used for temp files (if needed)
2164
2165py-beep-if-tab-change\tring the bell if tab-width is changed
2166%v:py-indent-offset
2167%v:py-block-comment-prefix
2168%v:py-python-command
2169%v:py-scroll-process-buffer
2170%v:py-temp-directory
2171%v:py-beep-if-tab-change
2172
2173@KINDS OF LINES
2174
2175Each physical line in the file is either a `continuation line' (the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002176preceding line ends with a backslash that's not part of a comment, or
2177the paren/bracket/brace nesting level at the start of the line is
2178non-zero, or both) or an `initial line' (everything else).
Barry Warsaw7ae77681994-12-12 20:38:05 +00002179
2180An initial line is in turn a `blank line' (contains nothing except
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002181possibly blanks or tabs), a `comment line' (leftmost non-blank
2182character is `#'), or a `code line' (everything else).
Barry Warsaw7ae77681994-12-12 20:38:05 +00002183
2184Comment Lines
2185
2186Although all comment lines are treated alike by Python, Python mode
2187recognizes two kinds that act differently with respect to indentation.
2188
2189An `indenting comment line' is a comment line with a blank, tab or
2190nothing after the initial `#'. The indentation commands (see below)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002191treat these exactly as if they were code lines: a line following an
Barry Warsaw7ae77681994-12-12 20:38:05 +00002192indenting comment line will be indented like the comment line. All
2193other comment lines (those with a non-whitespace character immediately
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002194following the initial `#') are `non-indenting comment lines', and
2195their indentation is ignored by the indentation commands.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002196
2197Indenting comment lines are by far the usual case, and should be used
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002198whenever possible. Non-indenting comment lines are useful in cases
2199like these:
Barry Warsaw7ae77681994-12-12 20:38:05 +00002200
2201\ta = b # a very wordy single-line comment that ends up being
2202\t #... continued onto another line
2203
2204\tif a == b:
2205##\t\tprint 'panic!' # old code we've `commented out'
2206\t\treturn a
2207
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002208Since the `#...' and `##' comment lines have a non-whitespace
2209character following the initial `#', Python mode ignores them when
2210computing the proper indentation for the next line.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002211
2212Continuation Lines and Statements
2213
2214The Python-mode commands generally work on statements instead of on
2215individual lines, where a `statement' is a comment or blank line, or a
2216code line and all of its following continuation lines (if any)
2217considered as a single logical unit. The commands in this mode
2218generally (when it makes sense) automatically move to the start of the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002219statement containing point, even if point happens to be in the middle
2220of some continuation line.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002221
2222
2223@INDENTATION
2224
2225Primarily for entering new code:
2226\t\\[indent-for-tab-command]\t indent line appropriately
2227\t\\[py-newline-and-indent]\t insert newline, then indent
2228\t\\[py-delete-char]\t reduce indentation, or delete single character
2229
2230Primarily for reindenting existing code:
2231\t\\[py-guess-indent-offset]\t guess py-indent-offset from file content; change locally
2232\t\\[universal-argument] \\[py-guess-indent-offset]\t ditto, but change globally
2233
2234\t\\[py-indent-region]\t reindent region to match its context
2235\t\\[py-shift-region-left]\t shift region left by py-indent-offset
2236\t\\[py-shift-region-right]\t shift region right by py-indent-offset
2237
2238Unlike most programming languages, Python uses indentation, and only
2239indentation, to specify block structure. Hence the indentation supplied
2240automatically by Python-mode is just an educated guess: only you know
2241the block structure you intend, so only you can supply correct
2242indentation.
2243
2244The \\[indent-for-tab-command] and \\[py-newline-and-indent] keys try to suggest plausible indentation, based on
2245the indentation of preceding statements. E.g., assuming
2246py-indent-offset is 4, after you enter
2247\tif a > 0: \\[py-newline-and-indent]
2248the cursor will be moved to the position of the `_' (_ is not a
2249character in the file, it's just used here to indicate the location of
2250the cursor):
2251\tif a > 0:
2252\t _
2253If you then enter `c = d' \\[py-newline-and-indent], the cursor will move
2254to
2255\tif a > 0:
2256\t c = d
2257\t _
2258Python-mode cannot know whether that's what you intended, or whether
2259\tif a > 0:
2260\t c = d
2261\t_
2262was your intent. In general, Python-mode either reproduces the
2263indentation of the (closest code or indenting-comment) preceding
2264statement, or adds an extra py-indent-offset blanks if the preceding
2265statement has `:' as its last significant (non-whitespace and non-
2266comment) character. If the suggested indentation is too much, use
2267\\[py-delete-char] to reduce it.
2268
2269Continuation lines are given extra indentation. If you don't like the
2270suggested indentation, change it to something you do like, and Python-
2271mode will strive to indent later lines of the statement in the same way.
2272
2273If a line is a continuation line by virtue of being in an unclosed
2274paren/bracket/brace structure (`list', for short), the suggested
2275indentation depends on whether the current line contains the first item
2276in the list. If it does, it's indented py-indent-offset columns beyond
2277the indentation of the line containing the open bracket. If you don't
2278like that, change it by hand. The remaining items in the list will mimic
2279whatever indentation you give to the first item.
2280
2281If a line is a continuation line because the line preceding it ends with
2282a backslash, the third and following lines of the statement inherit their
2283indentation from the line preceding them. The indentation of the second
2284line in the statement depends on the form of the first (base) line: if
2285the base line is an assignment statement with anything more interesting
2286than the backslash following the leftmost assigning `=', the second line
2287is indented two columns beyond that `='. Else it's indented to two
2288columns beyond the leftmost solid chunk of non-whitespace characters on
2289the base line.
2290
2291Warning: indent-region should not normally be used! It calls \\[indent-for-tab-command]
2292repeatedly, and as explained above, \\[indent-for-tab-command] can't guess the block
2293structure you intend.
2294%c:indent-for-tab-command
2295%c:py-newline-and-indent
2296%c:py-delete-char
2297
2298
2299The next function may be handy when editing code you didn't write:
2300%c:py-guess-indent-offset
2301
2302
2303The remaining `indent' functions apply to a region of Python code. They
2304assume the block structure (equals indentation, in Python) of the region
2305is correct, and alter the indentation in various ways while preserving
2306the block structure:
2307%c:py-indent-region
2308%c:py-shift-region-left
2309%c:py-shift-region-right
2310
2311@MARKING & MANIPULATING REGIONS OF CODE
2312
2313\\[py-mark-block]\t mark block of lines
Barry Warsaw2518c671997-11-05 00:51:08 +00002314\\[py-mark-def-or-class]\t mark smallest enclosing def
2315\\[universal-argument] \\[py-mark-def-or-class]\t mark smallest enclosing class
Barry Warsaw42f707f1996-07-29 21:05:05 +00002316\\[comment-region]\t comment out region of code
2317\\[universal-argument] \\[comment-region]\t uncomment region of code
Barry Warsaw7ae77681994-12-12 20:38:05 +00002318%c:py-mark-block
Barry Warsaw2518c671997-11-05 00:51:08 +00002319%c:py-mark-def-or-class
Barry Warsaw42f707f1996-07-29 21:05:05 +00002320%c:comment-region
Barry Warsaw7ae77681994-12-12 20:38:05 +00002321
2322@MOVING POINT
2323
2324\\[py-previous-statement]\t move to statement preceding point
2325\\[py-next-statement]\t move to statement following point
2326\\[py-goto-block-up]\t move up to start of current block
2327\\[beginning-of-python-def-or-class]\t move to start of def
2328\\[universal-argument] \\[beginning-of-python-def-or-class]\t move to start of class
2329\\[end-of-python-def-or-class]\t move to end of def
2330\\[universal-argument] \\[end-of-python-def-or-class]\t move to end of class
2331
2332The first two move to one statement beyond the statement that contains
2333point. A numeric prefix argument tells them to move that many
2334statements instead. Blank lines, comment lines, and continuation lines
2335do not count as `statements' for these commands. So, e.g., you can go
2336to the first code statement in a file by entering
2337\t\\[beginning-of-buffer]\t to move to the top of the file
2338\t\\[py-next-statement]\t to skip over initial comments and blank lines
2339Or do `\\[py-previous-statement]' with a huge prefix argument.
2340%c:py-previous-statement
2341%c:py-next-statement
2342%c:py-goto-block-up
2343%c:beginning-of-python-def-or-class
2344%c:end-of-python-def-or-class
2345
2346@LITTLE-KNOWN EMACS COMMANDS PARTICULARLY USEFUL IN PYTHON MODE
2347
2348`\\[indent-new-comment-line]' is handy for entering a multi-line comment.
2349
2350`\\[set-selective-display]' with a `small' prefix arg is ideally suited for viewing the
2351overall class and def structure of a module.
2352
2353`\\[back-to-indentation]' moves point to a line's first non-blank character.
2354
2355`\\[indent-relative]' is handy for creating odd indentation.
2356
2357@OTHER EMACS HINTS
2358
2359If you don't like the default value of a variable, change its value to
2360whatever you do like by putting a `setq' line in your .emacs file.
2361E.g., to set the indentation increment to 4, put this line in your
2362.emacs:
2363\t(setq py-indent-offset 4)
2364To see the value of a variable, do `\\[describe-variable]' and enter the variable
2365name at the prompt.
2366
2367When entering a key sequence like `C-c C-n', it is not necessary to
2368release the CONTROL key after doing the `C-c' part -- it suffices to
2369press the CONTROL key, press and release `c' (while still holding down
2370CONTROL), press and release `n' (while still holding down CONTROL), &
2371then release CONTROL.
2372
2373Entering Python mode calls with no arguments the value of the variable
2374`python-mode-hook', if that value exists and is not nil; for backward
2375compatibility it also tries `py-mode-hook'; see the `Hooks' section of
2376the Elisp manual for details.
2377
2378Obscure: When python-mode is first loaded, it looks for all bindings
2379to newline-and-indent in the global keymap, and shadows them with
2380local bindings to py-newline-and-indent."))
2381
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002382
2383;; Helper functions
Barry Warsaw7ae77681994-12-12 20:38:05 +00002384(defvar py-parse-state-re
2385 (concat
2386 "^[ \t]*\\(if\\|elif\\|else\\|while\\|def\\|class\\)\\>"
2387 "\\|"
2388 "^[^ #\t\n]"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002389
Barry Warsaw7ae77681994-12-12 20:38:05 +00002390;; returns the parse state at point (see parse-partial-sexp docs)
2391(defun py-parse-state ()
2392 (save-excursion
Barry Warsaw43ecf8e1996-04-06 00:00:19 +00002393 (let ((here (point))
Barry Warsaw170ffa71996-07-31 20:57:22 +00002394 pps done ci)
Barry Warsaw43ecf8e1996-04-06 00:00:19 +00002395 (while (not done)
2396 ;; back up to the first preceding line (if any; else start of
2397 ;; buffer) that begins with a popular Python keyword, or a
2398 ;; non- whitespace and non-comment character. These are good
2399 ;; places to start parsing to see whether where we started is
2400 ;; at a non-zero nesting level. It may be slow for people who
2401 ;; write huge code blocks or huge lists ... tough beans.
2402 (re-search-backward py-parse-state-re nil 'move)
Barry Warsaw170ffa71996-07-31 20:57:22 +00002403 (setq ci (current-indentation))
Barry Warsaw43ecf8e1996-04-06 00:00:19 +00002404 (beginning-of-line)
2405 (save-excursion
2406 (setq pps (parse-partial-sexp (point) here)))
2407 ;; make sure we don't land inside a triple-quoted string
Barry Warsaw170ffa71996-07-31 20:57:22 +00002408 (setq done (or (zerop ci)
2409 (not (nth 3 pps))
2410 (bobp)))
2411 )
Barry Warsaw43ecf8e1996-04-06 00:00:19 +00002412 pps)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002413
2414;; if point is at a non-zero nesting level, returns the number of the
2415;; character that opens the smallest enclosing unclosed list; else
2416;; returns nil.
2417(defun py-nesting-level ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002418 (let ((status (py-parse-state)) )
Barry Warsaw7ae77681994-12-12 20:38:05 +00002419 (if (zerop (car status))
2420 nil ; not in a nest
2421 (car (cdr status))))) ; char# of open bracket
2422
2423;; t iff preceding line ends with backslash that's not in a comment
2424(defun py-backslash-continuation-line-p ()
2425 (save-excursion
2426 (beginning-of-line)
2427 (and
2428 ;; use a cheap test first to avoid the regexp if possible
2429 ;; use 'eq' because char-after may return nil
2430 (eq (char-after (- (point) 2)) ?\\ )
2431 ;; make sure; since eq test passed, there is a preceding line
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002432 (forward-line -1) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00002433 (looking-at py-continued-re))))
2434
2435;; t iff current line is a continuation line
2436(defun py-continuation-line-p ()
2437 (save-excursion
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002438 (beginning-of-line)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002439 (or (py-backslash-continuation-line-p)
2440 (py-nesting-level))))
2441
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002442;; go to initial line of current statement; usually this is the line
2443;; we're on, but if we're on the 2nd or following lines of a
2444;; continuation block, we need to go up to the first line of the
2445;; block.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002446;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002447;; Tricky: We want to avoid quadratic-time behavior for long continued
2448;; blocks, whether of the backslash or open-bracket varieties, or a
2449;; mix of the two. The following manages to do that in the usual
2450;; cases.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002451(defun py-goto-initial-line ()
2452 (let ( open-bracket-pos )
2453 (while (py-continuation-line-p)
2454 (beginning-of-line)
2455 (if (py-backslash-continuation-line-p)
2456 (while (py-backslash-continuation-line-p)
2457 (forward-line -1))
2458 ;; else zip out of nested brackets/braces/parens
2459 (while (setq open-bracket-pos (py-nesting-level))
2460 (goto-char open-bracket-pos)))))
2461 (beginning-of-line))
2462
2463;; go to point right beyond final line of current statement; usually
2464;; this is the start of the next line, but if this is a multi-line
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002465;; statement we need to skip over the continuation lines. Tricky:
2466;; Again we need to be clever to avoid quadratic time behavior.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002467(defun py-goto-beyond-final-line ()
2468 (forward-line 1)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002469 (let (state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002470 (while (and (py-continuation-line-p)
2471 (not (eobp)))
2472 ;; skip over the backslash flavor
2473 (while (and (py-backslash-continuation-line-p)
2474 (not (eobp)))
2475 (forward-line 1))
2476 ;; if in nest, zip to the end of the nest
2477 (setq state (py-parse-state))
2478 (if (and (not (zerop (car state)))
2479 (not (eobp)))
2480 (progn
Barry Warsawaffc0ca1997-11-03 16:59:38 +00002481 (parse-partial-sexp (point) (point-max) 0 nil state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002482 (forward-line 1))))))
2483
2484;; t iff statement opens a block == iff it ends with a colon that's
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002485;; not in a comment. point should be at the start of a statement
Barry Warsaw7ae77681994-12-12 20:38:05 +00002486(defun py-statement-opens-block-p ()
2487 (save-excursion
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002488 (let ((start (point))
2489 (finish (progn (py-goto-beyond-final-line) (1- (point))))
2490 (searching t)
2491 (answer nil)
2492 state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002493 (goto-char start)
2494 (while searching
2495 ;; look for a colon with nothing after it except whitespace, and
2496 ;; maybe a comment
2497 (if (re-search-forward ":\\([ \t]\\|\\\\\n\\)*\\(#.*\\)?$"
2498 finish t)
2499 (if (eq (point) finish) ; note: no `else' clause; just
2500 ; keep searching if we're not at
2501 ; the end yet
2502 ;; sure looks like it opens a block -- but it might
2503 ;; be in a comment
2504 (progn
2505 (setq searching nil) ; search is done either way
2506 (setq state (parse-partial-sexp start
2507 (match-beginning 0)))
2508 (setq answer (not (nth 4 state)))))
2509 ;; search failed: couldn't find another interesting colon
2510 (setq searching nil)))
2511 answer)))
2512
Barry Warsawf831d811996-07-31 20:42:59 +00002513(defun py-statement-closes-block-p ()
2514 ;; true iff the current statement `closes' a block == the line
Barry Warsaw7cb505c1996-10-23 20:44:59 +00002515 ;; starts with `return', `raise', `break', `continue', and `pass'.
2516 ;; doesn't catch embedded statements
Barry Warsawf831d811996-07-31 20:42:59 +00002517 (let ((here (point)))
2518 (back-to-indentation)
2519 (prog1
Barry Warsawaffc0ca1997-11-03 16:59:38 +00002520 (looking-at (concat py-block-closing-keywords-re "\\>"))
Barry Warsawf831d811996-07-31 20:42:59 +00002521 (goto-char here))))
2522
Barry Warsaw7ae77681994-12-12 20:38:05 +00002523;; go to point right beyond final line of block begun by the current
2524;; line. This is the same as where py-goto-beyond-final-line goes
2525;; unless we're on colon line, in which case we go to the end of the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002526;; block. assumes point is at bolp
Barry Warsaw7ae77681994-12-12 20:38:05 +00002527(defun py-goto-beyond-block ()
2528 (if (py-statement-opens-block-p)
2529 (py-mark-block nil 'just-move)
2530 (py-goto-beyond-final-line)))
2531
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002532;; go to start of first statement (not blank or comment or
2533;; continuation line) at or preceding point. returns t if there is
2534;; one, else nil
Barry Warsaw7ae77681994-12-12 20:38:05 +00002535(defun py-goto-statement-at-or-above ()
2536 (py-goto-initial-line)
2537 (if (looking-at py-blank-or-comment-re)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002538 ;; skip back over blank & comment lines
2539 ;; note: will skip a blank or comment line that happens to be
2540 ;; a continuation line too
2541 (if (re-search-backward "^[ \t]*[^ \t#\n]" nil t)
2542 (progn (py-goto-initial-line) t)
2543 nil)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002544 t))
2545
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002546;; go to start of first statement (not blank or comment or
2547;; continuation line) following the statement containing point returns
2548;; t if there is one, else nil
Barry Warsaw7ae77681994-12-12 20:38:05 +00002549(defun py-goto-statement-below ()
2550 (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002551 (let ((start (point)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002552 (py-goto-beyond-final-line)
2553 (while (and
2554 (looking-at py-blank-or-comment-re)
2555 (not (eobp)))
2556 (forward-line 1))
2557 (if (eobp)
2558 (progn (goto-char start) nil)
2559 t)))
2560
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002561;; go to start of statement, at or preceding point, starting with
2562;; keyword KEY. Skips blank lines and non-indenting comments upward
2563;; first. If that statement starts with KEY, done, else go back to
2564;; first enclosing block starting with KEY. If successful, leaves
2565;; point at the start of the KEY line & returns t. Else leaves point
2566;; at an undefined place & returns nil.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002567(defun py-go-up-tree-to-keyword (key)
2568 ;; skip blanks and non-indenting #
2569 (py-goto-initial-line)
2570 (while (and
2571 (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)")
2572 (zerop (forward-line -1))) ; go back
2573 nil)
2574 (py-goto-initial-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002575 (let* ((re (concat "[ \t]*" key "\\b"))
2576 (case-fold-search nil) ; let* so looking-at sees this
2577 (found (looking-at re))
2578 (dead nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002579 (while (not (or found dead))
2580 (condition-case nil ; in case no enclosing block
2581 (py-goto-block-up 'no-mark)
2582 (error (setq dead t)))
2583 (or dead (setq found (looking-at re))))
2584 (beginning-of-line)
2585 found))
2586
2587;; return string in buffer from start of indentation to end of line;
2588;; prefix "..." if leading whitespace was skipped
2589(defun py-suck-up-leading-text ()
2590 (save-excursion
2591 (back-to-indentation)
2592 (concat
2593 (if (bolp) "" "...")
2594 (buffer-substring (point) (progn (end-of-line) (point))))))
2595
2596;; assuming point at bolp, return first keyword ([a-z]+) on the line,
2597;; as a Lisp symbol; return nil if none
2598(defun py-suck-up-first-keyword ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002599 (let ((case-fold-search nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002600 (if (looking-at "[ \t]*\\([a-z]+\\)\\b")
2601 (intern (buffer-substring (match-beginning 1) (match-end 1)))
2602 nil)))
2603
Barry Warsawb3e81d51996-09-04 15:12:42 +00002604(defun py-current-defun ()
2605 ;; tell add-log.el how to find the current function/method/variable
2606 (save-excursion
2607 (if (re-search-backward py-defun-start-re nil t)
2608 (or (match-string 3)
2609 (let ((method (match-string 2)))
2610 (if (and (not (zerop (length (match-string 1))))
2611 (re-search-backward py-class-start-re nil t))
2612 (concat (match-string 1) "." method)
2613 method)))
2614 nil)))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002615
2616
Barry Warsawfec75d61995-07-05 23:26:15 +00002617(defconst py-help-address "python-mode@python.org"
Barry Warsaw850437a1995-03-08 21:50:28 +00002618 "Address accepting submission of bug reports.")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002619
Barry Warsaw850437a1995-03-08 21:50:28 +00002620(defun py-version ()
2621 "Echo the current version of `python-mode' in the minibuffer."
2622 (interactive)
2623 (message "Using `python-mode' version %s" py-version)
2624 (py-keep-region-active))
2625
2626;; only works under Emacs 19
2627;(eval-when-compile
2628; (require 'reporter))
2629
2630(defun py-submit-bug-report (enhancement-p)
2631 "Submit via mail a bug report on `python-mode'.
2632With \\[universal-argument] just submit an enhancement request."
2633 (interactive
2634 (list (not (y-or-n-p
2635 "Is this a bug report? (hit `n' to send other comments) "))))
Barry Warsawb5e0ecb1995-03-14 18:32:54 +00002636 (let ((reporter-prompt-for-summary-p (if enhancement-p
2637 "(Very) brief summary: "
2638 t)))
Barry Warsaw850437a1995-03-08 21:50:28 +00002639 (require 'reporter)
2640 (reporter-submit-bug-report
2641 py-help-address ;address
Barry Warsawb5e0ecb1995-03-14 18:32:54 +00002642 (concat "python-mode " py-version) ;pkgname
Barry Warsaw850437a1995-03-08 21:50:28 +00002643 ;; varlist
2644 (if enhancement-p nil
2645 '(py-python-command
2646 py-indent-offset
2647 py-block-comment-prefix
2648 py-scroll-process-buffer
2649 py-temp-directory
2650 py-beep-if-tab-change))
2651 nil ;pre-hooks
2652 nil ;post-hooks
2653 "Dear Barry,") ;salutation
2654 (if enhancement-p nil
2655 (set-mark (point))
2656 (insert
2657"Please replace this text with a sufficiently large code sample\n\
2658and an exact recipe so that I can reproduce your problem. Failure\n\
2659to do so may mean a greater delay in fixing your bug.\n\n")
2660 (exchange-point-and-mark)
2661 (py-keep-region-active))))
2662
2663
Barry Warsaw47384781997-11-26 05:27:45 +00002664(defun py-kill-emacs-hook ()
2665 (mapcar #'(lambda (filename)
2666 (py-safe (delete-file filename)))
2667 py-file-queue))
2668
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002669;; arrange to kill temp files when Emacs exists
Barry Warsawc72c11c1997-08-09 06:42:08 +00002670(add-hook 'kill-emacs-hook 'py-kill-emacs-hook)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002671
2672
2673
2674(provide 'python-mode)
2675;;; python-mode.el ends here