blob: 7b69745c12e252a8747edd7ee13c1333d1b0d0c8 [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 Warsaw4669d7e1996-03-22 16:13:24 +00005;; Author: 1995-1996 Barry A. Warsaw
Barry Warsawfec75d61995-07-05 23:26:15 +00006;; 1992-1994 Tim Peters
7;; Maintainer: python-mode@python.org
Barry Warsawcfec3591995-03-10 15:58:16 +00008;; Created: Feb 1992
Barry Warsaw7b0f5681995-03-08 21:33:04 +00009;; Version: $Revision$
10;; Last Modified: $Date$
Barry Warsaw4669d7e1996-03-22 16:13:24 +000011;; Keywords: python languages oop
Barry Warsaw7b0f5681995-03-08 21:33:04 +000012
Barry Warsawcfec3591995-03-10 15:58:16 +000013;; This software is provided as-is, without express or implied
14;; warranty. Permission to use, copy, modify, distribute or sell this
15;; software, without fee, for any purpose and by any individual or
16;; organization, is hereby granted, provided that the above copyright
17;; notice and this paragraph appear in all copies.
Barry Warsaw7b0f5681995-03-08 21:33:04 +000018
19;;; Commentary:
Barry Warsaw7ae77681994-12-12 20:38:05 +000020;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +000021;; This is a major mode for editing Python programs. It was developed
22;; by Tim Peters <tim@ksr.com> after an original idea by Michael
23;; A. Guravage. Tim doesn't appear to be on the 'net any longer so I
Barry Warsaw4669d7e1996-03-22 16:13:24 +000024;; (Barry) have undertaken maintenance of the mode.
Barry Warsaw7b0f5681995-03-08 21:33:04 +000025
26;; At some point this mode will undergo a rewrite to bring it more in
27;; line with GNU Emacs Lisp coding standards. But all in all, the
Barry Warsaw03970731996-07-03 23:12:52 +000028;; mode works exceedingly well, and I've simply been tweaking it as I
Barry Warsaw4669d7e1996-03-22 16:13:24 +000029;; go along. Ain't it wonderful that Python has a much more sane
Barry Warsaw03970731996-07-03 23:12:52 +000030;; syntax than C? (or <shudder> C++?! :-). I can say that; I maintain
31;; cc-mode!
Barry Warsaw7b0f5681995-03-08 21:33:04 +000032
33;; The following statements, placed in your .emacs file or
34;; site-init.el, will cause this file to be autoloaded, and
35;; python-mode invoked, when visiting .py files (assuming this file is
36;; in your load-path):
Barry Warsaw7ae77681994-12-12 20:38:05 +000037;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +000038;; (autoload 'python-mode "python-mode" "Python editing mode." t)
Barry Warsaw7ae77681994-12-12 20:38:05 +000039;; (setq auto-mode-alist
40;; (cons '("\\.py$" . python-mode) auto-mode-alist))
41
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000042;; Here's a brief list of recent additions/improvements:
43;;
44;; - Wrapping and indentation within triple quote strings should work
45;; properly now.
46;; - `Standard' bug reporting mechanism (use C-c C-b)
47;; - py-mark-block was moved to C-c C-m
48;; - C-c C-v shows you the python-mode version
49;; - a basic python-font-lock-keywords has been added for Emacs 19
50;; font-lock colorizations.
51;; - proper interaction with pending-del and del-sel modes.
52;; - New py-electric-colon (:) command for improved outdenting. Also
53;; py-indent-line (TAB) should handle outdented lines better.
Barry Warsaw03970731996-07-03 23:12:52 +000054;; - improved (I think) C-c > and C-c <
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000055
Barry Warsaw7b0f5681995-03-08 21:33:04 +000056;; Here's a brief to do list:
57;;
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000058;; - Better integration with gud-mode for debugging.
59;; - Rewrite according to GNU Emacs Lisp standards.
60;; - py-delete-char should obey numeric arguments.
61;; - even better support for outdenting. Guido suggests outdents of
62;; at least one level after a return, raise, break, or continue
63;; statement.
Barry Warsaw7a1f6f41995-05-08 21:36:20 +000064;; - de-electrify colon inside literals (e.g. comments and strings)
Barry Warsaw7ae77681994-12-12 20:38:05 +000065
Barry Warsaw7b0f5681995-03-08 21:33:04 +000066;; If you can think of more things you'd like to see, drop me a line.
67;; If you want to report bugs, use py-submit-bug-report (C-c C-b).
68;;
Barry Warsaw4669d7e1996-03-22 16:13:24 +000069;; Note that I only test things on XEmacs. If you port stuff to FSF
70;; Emacs 19, or Emacs 18, please send me your patches. Byte compiler
71;; complaints can probably be safely ignored.
Barry Warsaw7ae77681994-12-12 20:38:05 +000072
Barry Warsaw7b0f5681995-03-08 21:33:04 +000073;; LCD Archive Entry:
Barry Warsawfec75d61995-07-05 23:26:15 +000074;; python-mode|Barry A. Warsaw|python-mode@python.org
Barry Warsaw7b0f5681995-03-08 21:33:04 +000075;; |Major mode for editing Python programs
76;; |$Date$|$Revision$|
Barry Warsaw7ae77681994-12-12 20:38:05 +000077
Barry Warsaw7b0f5681995-03-08 21:33:04 +000078;;; Code:
79
80
81;; user definable variables
82;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
Barry Warsaw7ae77681994-12-12 20:38:05 +000083
84(defvar py-python-command "python"
85 "*Shell command used to start Python interpreter.")
86
Barry Warsaw17914f41995-11-03 18:25:15 +000087(defvar py-indent-offset 4
Barry Warsaw7ae77681994-12-12 20:38:05 +000088 "*Indentation increment.
Barry Warsaw7b0f5681995-03-08 21:33:04 +000089Note that `\\[py-guess-indent-offset]' can usually guess a good value
90when you're editing someone else's Python code.")
Barry Warsaw7ae77681994-12-12 20:38:05 +000091
Barry Warsaw095e9c61995-09-19 20:01:42 +000092(defvar py-align-multiline-strings-p t
93 "*Flag describing how multiline triple quoted strings are aligned.
94When this flag is non-nil, continuation lines are lined up under the
95preceding line's indentation. When this flag is nil, continuation
96lines are aligned to column zero.")
97
Barry Warsaw7ae77681994-12-12 20:38:05 +000098(defvar py-block-comment-prefix "##"
Barry Warsaw867a32a1996-03-07 18:30:26 +000099 "*String used by \\[comment-region] to comment out a block of code.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000100This should follow the convention for non-indenting comment lines so
101that the indentation commands won't get confused (i.e., the string
102should be of the form `#x...' where `x' is not a blank or a tab, and
103`...' is arbitrary).")
104
Barry Warsaw33d6ec01996-03-05 16:28:07 +0000105(defvar py-honor-comment-indentation t
Barry Warsaw6d627751996-03-06 18:41:38 +0000106 "*Controls how comment lines influence subsequent indentation.
Barry Warsaw33d6ec01996-03-05 16:28:07 +0000107
Barry Warsaw6d627751996-03-06 18:41:38 +0000108When nil, all comment lines are skipped for indentation purposes, and
109in Emacs 19, a faster algorithm is used.
110
111When t, lines that begin with a single `#' are a hint to subsequent
112line indentation. If the previous line is such a comment line (as
113opposed to one that starts with `py-block-comment-prefix'), then it's
114indentation is used as a hint for this line's indentation. Lines that
115begin with `py-block-comment-prefix' are ignored for indentation
116purposes.
117
118When not nil or t, comment lines that begin with a `#' are used as
119indentation hints, unless the comment character is in column zero.")
Barry Warsaw33d6ec01996-03-05 16:28:07 +0000120
Barry Warsaw7ae77681994-12-12 20:38:05 +0000121(defvar py-scroll-process-buffer t
122 "*Scroll Python process buffer as output arrives.
123If nil, the Python process buffer acts, with respect to scrolling, like
124Shell-mode buffers normally act. This is surprisingly complicated and
125so won't be explained here; in fact, you can't get the whole story
126without studying the Emacs C code.
127
128If non-nil, the behavior is different in two respects (which are
129slightly inaccurate in the interest of brevity):
130
131 - If the buffer is in a window, and you left point at its end, the
132 window will scroll as new output arrives, and point will move to the
133 buffer's end, even if the window is not the selected window (that
134 being the one the cursor is in). The usual behavior for shell-mode
135 windows is not to scroll, and to leave point where it was, if the
136 buffer is in a window other than the selected window.
137
138 - If the buffer is not visible in any window, and you left point at
139 its end, the buffer will be popped into a window as soon as more
140 output arrives. This is handy if you have a long-running
141 computation and don't want to tie up screen area waiting for the
142 output. The usual behavior for a shell-mode buffer is to stay
143 invisible until you explicitly visit it.
144
145Note the `and if you left point at its end' clauses in both of the
146above: you can `turn off' the special behaviors while output is in
147progress, by visiting the Python buffer and moving point to anywhere
148besides the end. Then the buffer won't scroll, point will remain where
149you leave it, and if you hide the buffer it will stay hidden until you
150visit it again. You can enable and disable the special behaviors as
151often as you like, while output is in progress, by (respectively) moving
152point to, or away from, the end of the buffer.
153
154Warning: If you expect a large amount of output, you'll probably be
155happier setting this option to nil.
156
157Obscure: `End of buffer' above should really say `at or beyond the
158process mark', but if you know what that means you didn't need to be
159told <grin>.")
160
161(defvar py-temp-directory
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000162 (let ((ok '(lambda (x)
163 (and x
164 (setq x (expand-file-name x)) ; always true
165 (file-directory-p x)
166 (file-writable-p x)
167 x))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000168 (or (funcall ok (getenv "TMPDIR"))
169 (funcall ok "/usr/tmp")
170 (funcall ok "/tmp")
171 (funcall ok ".")
172 (error
173 "Couldn't find a usable temp directory -- set py-temp-directory")))
174 "*Directory used for temp files created by a *Python* process.
175By default, the first directory from this list that exists and that you
176can write into: the value (if any) of the environment variable TMPDIR,
177/usr/tmp, /tmp, or the current directory.")
178
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000179(defvar py-beep-if-tab-change t
180 "*Ring the bell if tab-width is changed.
181If a comment of the form
182
183 \t# vi:set tabsize=<number>:
184
185is found before the first code line when the file is entered, and the
186current value of (the general Emacs variable) `tab-width' does not
187equal <number>, `tab-width' is set to <number>, a message saying so is
188displayed in the echo area, and if `py-beep-if-tab-change' is non-nil
189the Emacs bell is also rung as a warning.")
190
Barry Warsaw62d9d6e1996-03-06 20:32:27 +0000191(defconst python-font-lock-keywords
Barry Warsaw33ab6e41996-03-05 00:44:31 +0000192 (let* ((keywords '("access" "and" "break" "continue"
193 "del" "elif" "else:" "except"
194 "except:" "exec" "finally:" "for"
195 "from" "global" "if" "import"
196 "in" "is" "lambda" "not"
197 "or" "pass" "print" "raise"
198 "return" "try:" "while"
199 ))
200 (kwregex (mapconcat 'identity keywords "\\|")))
201 (list
202 ;; keywords not at beginning of line
203 (cons (concat "\\s-\\(" kwregex "\\)[ \n\t(]") 1)
204 ;; keywords at beginning of line. i don't think regexps are
205 ;; powerful enough to handle these two cases in one regexp.
206 ;; prove me wrong!
207 (cons (concat "^\\(" kwregex "\\)[ \n\t(]") 1)
208 ;; classes
209 '("\\bclass[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)"
210 1 font-lock-type-face)
211 ;; functions
212 '("\\bdef[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)"
213 1 font-lock-function-name-face)
214 ))
Barry Warsaw62d9d6e1996-03-06 20:32:27 +0000215 "Additional expressions to highlight in Python mode.")
Barry Warsawb01b4fa1995-06-20 18:55:34 +0000216
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000217
218;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
219;; NO USER DEFINABLE VARIABLES BEYOND THIS POINT
220
Barry Warsaw52bc17c1995-10-12 21:15:49 +0000221(make-variable-buffer-local 'py-indent-offset)
222
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000223;; Differentiate between Emacs 18, Lucid Emacs, and Emacs 19. This
224;; seems to be the standard way of checking this.
225;; BAW - This is *not* the right solution. When at all possible,
226;; instead of testing for the version of Emacs, use feature tests.
227
228(setq py-this-is-lucid-emacs-p (string-match "Lucid\\|XEmacs" emacs-version))
229(setq py-this-is-emacs-19-p
230 (and
231 (not py-this-is-lucid-emacs-p)
232 (string-match "^19\\." emacs-version)))
233
Barry Warsaw7ae77681994-12-12 20:38:05 +0000234;; have to bind py-file-queue before installing the kill-emacs hook
235(defvar py-file-queue nil
236 "Queue of Python temp files awaiting execution.
237Currently-active file is at the head of the list.")
238
239;; define a mode-specific abbrev table for those who use such things
240(defvar python-mode-abbrev-table nil
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000241 "Abbrev table in use in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000242(define-abbrev-table 'python-mode-abbrev-table nil)
243
Barry Warsaw7ae77681994-12-12 20:38:05 +0000244(defvar python-mode-hook nil
245 "*Hook called by `python-mode'.")
246
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000247;; in previous version of python-mode.el, the hook was incorrectly
248;; called py-mode-hook, and was not defvar'd. deprecate its use.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000249(and (fboundp 'make-obsolete-variable)
250 (make-obsolete-variable 'py-mode-hook 'python-mode-hook))
251
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000252(defvar py-mode-map ()
253 "Keymap used in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000254
Barry Warsaw7ae77681994-12-12 20:38:05 +0000255(if py-mode-map
256 ()
257 (setq py-mode-map (make-sparse-keymap))
258
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000259 ;; shadow global bindings for newline-and-indent w/ the py- version.
260 ;; BAW - this is extremely bad form, but I'm not going to change it
261 ;; for now.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000262 (mapcar (function (lambda (key)
263 (define-key
264 py-mode-map key 'py-newline-and-indent)))
265 (where-is-internal 'newline-and-indent))
266
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000267 ;; BAW - you could do it this way, but its not considered proper
268 ;; major-mode form.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000269 (mapcar (function
270 (lambda (x)
271 (define-key py-mode-map (car x) (cdr x))))
Barry Warsawb91b7431995-03-14 15:55:20 +0000272 '((":" . py-electric-colon)
273 ("\C-c\C-c" . py-execute-buffer)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000274 ("\C-c|" . py-execute-region)
275 ("\C-c!" . py-shell)
276 ("\177" . py-delete-char)
277 ("\n" . py-newline-and-indent)
278 ("\C-c:" . py-guess-indent-offset)
279 ("\C-c\t" . py-indent-region)
Barry Warsawdea4a291996-07-03 22:59:12 +0000280 ("\C-c\C-l" . py-shift-region-left)
281 ("\C-c\C-r" . py-shift-region-right)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000282 ("\C-c<" . py-shift-region-left)
283 ("\C-c>" . py-shift-region-right)
284 ("\C-c\C-n" . py-next-statement)
285 ("\C-c\C-p" . py-previous-statement)
286 ("\C-c\C-u" . py-goto-block-up)
Barry Warsaw850437a1995-03-08 21:50:28 +0000287 ("\C-c\C-m" . py-mark-block)
Barry Warsaw867a32a1996-03-07 18:30:26 +0000288 ("\C-c#" . comment-region)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000289 ("\C-c?" . py-describe-mode)
290 ("\C-c\C-hm" . py-describe-mode)
291 ("\e\C-a" . beginning-of-python-def-or-class)
292 ("\e\C-e" . end-of-python-def-or-class)
Barry Warsaw850437a1995-03-08 21:50:28 +0000293 ( "\e\C-h" . mark-python-def-or-class)))
294 ;; should do all keybindings this way
295 (define-key py-mode-map "\C-c\C-b" 'py-submit-bug-report)
296 (define-key py-mode-map "\C-c\C-v" 'py-version)
297 )
Barry Warsaw7ae77681994-12-12 20:38:05 +0000298
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000299(defvar py-mode-syntax-table nil
300 "Syntax table used in `python-mode' buffers.")
301
Barry Warsaw7ae77681994-12-12 20:38:05 +0000302(if py-mode-syntax-table
303 ()
304 (setq py-mode-syntax-table (make-syntax-table))
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000305 ;; BAW - again, blech.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000306 (mapcar (function
307 (lambda (x) (modify-syntax-entry
308 (car x) (cdr x) py-mode-syntax-table)))
309 '(( ?\( . "()" ) ( ?\) . ")(" )
310 ( ?\[ . "(]" ) ( ?\] . ")[" )
311 ( ?\{ . "(}" ) ( ?\} . "){" )
312 ;; fix operator symbols misassigned in the std table
313 ( ?\$ . "." ) ( ?\% . "." ) ( ?\& . "." )
314 ( ?\* . "." ) ( ?\+ . "." ) ( ?\- . "." )
315 ( ?\/ . "." ) ( ?\< . "." ) ( ?\= . "." )
316 ( ?\> . "." ) ( ?\| . "." )
Barry Warsaw2bbe49b1995-10-18 14:41:12 +0000317 ( ?\_ . "_" ) ; underscore is legit in symbols, but not words
Barry Warsaw7ae77681994-12-12 20:38:05 +0000318 ( ?\' . "\"") ; single quote is string quote
319 ( ?\" . "\"" ) ; double quote is string quote too
320 ( ?\` . "$") ; backquote is open and close paren
321 ( ?\# . "<") ; hash starts comment
322 ( ?\n . ">")))) ; newline ends comment
323
324(defconst py-stringlit-re
325 (concat
326 "'\\([^'\n\\]\\|\\\\.\\)*'" ; single-quoted
327 "\\|" ; or
328 "\"\\([^\"\n\\]\\|\\\\.\\)*\"") ; double-quoted
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000329 "Regexp matching a Python string literal.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000330
331;; this is tricky because a trailing backslash does not mean
332;; continuation if it's in a comment
333(defconst py-continued-re
334 (concat
335 "\\(" "[^#'\"\n\\]" "\\|" py-stringlit-re "\\)*"
336 "\\\\$")
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000337 "Regexp matching Python lines that are continued via backslash.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000338
339(defconst py-blank-or-comment-re "[ \t]*\\($\\|#\\)"
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000340 "Regexp matching blank or comment lines.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000341
Barry Warsaw0012c1e1995-03-14 16:32:55 +0000342(defconst py-outdent-re
343 (concat "\\(" (mapconcat 'identity
344 '("else:"
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000345 "except\\(\\s +.*\\)?:"
Barry Warsaw0012c1e1995-03-14 16:32:55 +0000346 "finally:"
347 "elif\\s +.*:")
348 "\\|")
349 "\\)")
350 "Regexp matching clauses to be outdented one level.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000351
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000352(defconst py-no-outdent-re
353 (concat "\\(" (mapconcat 'identity
Barry Warsaw464c94a1995-03-14 23:25:44 +0000354 '("try:"
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000355 "except\\(\\s +.*\\)?:"
356 "while\\s +.*:"
357 "for\\s +.*:"
358 "if\\s +.*:"
359 "elif\\s +.*:")
360 "\\|")
361 "\\)")
362 "Regexp matching lines to not outdent after.")
363
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000364
365;;;###autoload
Barry Warsaw7ae77681994-12-12 20:38:05 +0000366(defun python-mode ()
367 "Major mode for editing Python files.
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000368To submit a problem report, enter `\\[py-submit-bug-report]' from a
369`python-mode' buffer. Do `\\[py-describe-mode]' for detailed
370documentation. To see what version of `python-mode' you are running,
371enter `\\[py-version]'.
372
373This mode knows about Python indentation, tokens, comments and
374continuation lines. Paragraphs are separated by blank lines only.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000375
376COMMANDS
377\\{py-mode-map}
378VARIABLES
379
380py-indent-offset\tindentation increment
381py-block-comment-prefix\tcomment string used by py-comment-region
382py-python-command\tshell command to invoke Python interpreter
383py-scroll-process-buffer\talways scroll Python process buffer
384py-temp-directory\tdirectory used for temp files (if needed)
385py-beep-if-tab-change\tring the bell if tab-width is changed"
386 (interactive)
387 (kill-all-local-variables)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000388 (set-syntax-table py-mode-syntax-table)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000389 (setq major-mode 'python-mode
390 mode-name "Python"
391 local-abbrev-table python-mode-abbrev-table)
392 (use-local-map py-mode-map)
Barry Warsaw57697af1995-09-14 20:01:14 +0000393 ;; Emacs 19 requires this
394 (if (or py-this-is-lucid-emacs-p py-this-is-emacs-19-p)
395 (setq comment-multi-line nil))
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000396 ;; BAW -- style...
Barry Warsaw7ae77681994-12-12 20:38:05 +0000397 (mapcar (function (lambda (x)
398 (make-local-variable (car x))
399 (set (car x) (cdr x))))
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000400 '((paragraph-separate . "^[ \t]*$")
401 (paragraph-start . "^[ \t]*$")
402 (require-final-newline . t)
Barry Warsaw867a32a1996-03-07 18:30:26 +0000403 (comment-start . "## ")
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000404 (comment-start-skip . "# *")
405 (comment-column . 40)
406 (indent-region-function . py-indent-region)
407 (indent-line-function . py-indent-line)))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000408 ;; hack to allow overriding the tabsize in the file (see tokenizer.c)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000409 ;;
410 ;; not sure where the magic comment has to be; to save time
411 ;; searching for a rarity, we give up if it's not found prior to the
412 ;; first executable statement.
413 ;;
414 ;; BAW - on first glance, this seems like complete hackery. Why was
415 ;; this necessary, and is it still necessary?
416 (let ((case-fold-search nil)
417 (start (point))
418 new-tab-width)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000419 (if (re-search-forward
420 "^[ \t]*#[ \t]*vi:set[ \t]+tabsize=\\([0-9]+\\):"
421 (prog2 (py-next-statement 1) (point) (goto-char 1))
422 t)
423 (progn
424 (setq new-tab-width
425 (string-to-int
426 (buffer-substring (match-beginning 1) (match-end 1))))
427 (if (= tab-width new-tab-width)
428 nil
429 (setq tab-width new-tab-width)
430 (message "Caution: tab-width changed to %d" new-tab-width)
431 (if py-beep-if-tab-change (beep)))))
432 (goto-char start))
433
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000434 ;; run the mode hook. py-mode-hook use is deprecated
Barry Warsaw7ae77681994-12-12 20:38:05 +0000435 (if python-mode-hook
436 (run-hooks 'python-mode-hook)
437 (run-hooks 'py-mode-hook)))
438
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000439
Barry Warsaw826255b1996-03-22 16:09:34 +0000440(defun py-keep-region-active ()
441 ;; Do whatever is necessary to keep the region active in
442 ;; XEmacs 19. This is unnecessary, but no-op in Emacs 19, so just
443 ;; ignore byte-compiler warnings you might see.
444 (and (boundp 'zmacs-region-stays)
445 (setq zmacs-region-stays t)))
446
Barry Warsawb91b7431995-03-14 15:55:20 +0000447;; electric characters
Barry Warsaw3874a3d1995-03-14 22:05:53 +0000448(defun py-outdent-p ()
449 ;; returns non-nil if the current line should outdent one level
450 (save-excursion
451 (and (progn (back-to-indentation)
452 (looking-at py-outdent-re))
453 (progn (backward-to-indentation 1)
454 (while (or (looking-at py-blank-or-comment-re)
455 (bobp))
456 (backward-to-indentation 1))
457 (not (looking-at py-no-outdent-re)))
458 )))
459
460
Barry Warsawb91b7431995-03-14 15:55:20 +0000461(defun py-electric-colon (arg)
462 "Insert a colon.
463In certain cases the line is outdented appropriately. If a numeric
Barry Warsaw0c6563f1995-09-14 20:57:02 +0000464argument is provided, that many colons are inserted non-electrically.
465Electric behavior is inhibited inside a string or comment."
Barry Warsawb91b7431995-03-14 15:55:20 +0000466 (interactive "P")
467 (self-insert-command (prefix-numeric-value arg))
Barry Warsaw0c6563f1995-09-14 20:57:02 +0000468 ;; are we in a string or comment?
469 (if (save-excursion
470 (let ((pps (parse-partial-sexp (save-excursion
471 (beginning-of-python-def-or-class)
472 (point))
473 (point))))
474 (not (or (nth 3 pps) (nth 4 pps)))))
475 (save-excursion
476 (let ((here (point))
477 (outdent 0)
478 (indent (py-compute-indentation)))
479 (if (and (not arg)
480 (py-outdent-p)
481 (= indent (save-excursion
482 (forward-line -1)
483 (py-compute-indentation)))
484 )
485 (setq outdent py-indent-offset))
486 ;; Don't indent, only outdent. This assumes that any lines that
487 ;; are already outdented relative to py-compute-indentation were
488 ;; put there on purpose. Its highly annoying to have `:' indent
489 ;; for you. Use TAB, C-c C-l or C-c C-r to adjust. TBD: Is
490 ;; there a better way to determine this???
491 (if (< (current-indentation) indent) nil
492 (goto-char here)
493 (beginning-of-line)
494 (delete-horizontal-space)
495 (indent-to (- indent outdent))
496 )))))
Barry Warsawb91b7431995-03-14 15:55:20 +0000497
498
Barry Warsaw7ae77681994-12-12 20:38:05 +0000499;;; Functions that execute Python commands in a subprocess
Barry Warsaw7ae77681994-12-12 20:38:05 +0000500(defun py-shell ()
501 "Start an interactive Python interpreter in another window.
502This is like Shell mode, except that Python is running in the window
503instead of a shell. See the `Interactive Shell' and `Shell Mode'
504sections of the Emacs manual for details, especially for the key
505bindings active in the `*Python*' buffer.
506
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000507See the docs for variable `py-scroll-buffer' for info on scrolling
Barry Warsaw7ae77681994-12-12 20:38:05 +0000508behavior in the process window.
509
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000510Warning: Don't use an interactive Python if you change sys.ps1 or
511sys.ps2 from their default values, or if you're running code that
512prints `>>> ' or `... ' at the start of a line. `python-mode' can't
513distinguish your output from Python's output, and assumes that `>>> '
514at the start of a line is a prompt from Python. Similarly, the Emacs
515Shell mode code assumes that both `>>> ' and `... ' at the start of a
516line are Python prompts. Bad things can happen if you fool either
517mode.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000518
519Warning: If you do any editing *in* the process buffer *while* the
520buffer is accepting output from Python, do NOT attempt to `undo' the
521changes. Some of the output (nowhere near the parts you changed!) may
522be lost if you do. This appears to be an Emacs bug, an unfortunate
523interaction between undo and process filters; the same problem exists in
524non-Python process buffers using the default (Emacs-supplied) process
525filter."
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000526 ;; BAW - should undo be disabled in the python process buffer, if
527 ;; this bug still exists?
Barry Warsaw7ae77681994-12-12 20:38:05 +0000528 (interactive)
529 (if py-this-is-emacs-19-p
530 (progn
531 (require 'comint)
532 (switch-to-buffer-other-window
533 (make-comint "Python" py-python-command)))
534 (progn
535 (require 'shell)
536 (switch-to-buffer-other-window
Barry Warsaw9fbcc6a1996-01-23 22:52:02 +0000537 (apply (if (fboundp 'make-shell) 'make-shell 'make-comint)
Barry Warsaw6e98f331995-07-05 22:06:50 +0000538 "Python" py-python-command nil))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000539 (make-local-variable 'shell-prompt-pattern)
540 (setq shell-prompt-pattern "^>>> \\|^\\.\\.\\. ")
541 (set-process-filter (get-buffer-process (current-buffer))
542 'py-process-filter)
543 (set-syntax-table py-mode-syntax-table))
544
545(defun py-execute-region (start end)
546 "Send the region between START and END to a Python interpreter.
547If there is a *Python* process it is used.
548
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000549Hint: If you want to execute part of a Python file several times
550\(e.g., perhaps you're developing a function and want to flesh it out
551a bit at a time), use `\\[narrow-to-region]' to restrict the buffer to
552the region of interest, and send the code to a *Python* process via
553`\\[py-execute-buffer]' instead.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000554
555Following are subtleties to note when using a *Python* process:
556
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000557If a *Python* process is used, the region is copied into a temporary
558file (in directory `py-temp-directory'), and an `execfile' command is
559sent to Python naming that file. If you send regions faster than
560Python can execute them, `python-mode' will save them into distinct
561temp files, and execute the next one in the queue the next time it
562sees a `>>> ' prompt from Python. Each time this happens, the process
563buffer is popped into a window (if it's not already in some window) so
564you can see it, and a comment of the form
Barry Warsaw7ae77681994-12-12 20:38:05 +0000565
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000566 \t## working on region in file <name> ...
Barry Warsaw7ae77681994-12-12 20:38:05 +0000567
568is inserted at the end.
569
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000570Caution: No more than 26 regions can be pending at any given time.
571This limit is (indirectly) inherited from libc's mktemp(3).
572`python-mode' does not try to protect you from exceeding the limit.
573It's extremely unlikely that you'll get anywhere close to the limit in
574practice, unless you're trying to be a jerk <grin>.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000575
576See the `\\[py-shell]' docs for additional warnings."
577 (interactive "r")
578 (or (< start end) (error "Region is empty"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000579 (let ((pyproc (get-process "Python"))
580 fname)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000581 (if (null pyproc)
582 (shell-command-on-region start end py-python-command)
583 ;; else feed it thru a temp file
584 (setq fname (py-make-temp-name))
585 (write-region start end fname nil 'no-msg)
586 (setq py-file-queue (append py-file-queue (list fname)))
587 (if (cdr py-file-queue)
588 (message "File %s queued for execution" fname)
589 ;; else
590 (py-execute-file pyproc fname)))))
591
592(defun py-execute-file (pyproc fname)
593 (py-append-to-process-buffer
594 pyproc
595 (format "## working on region in file %s ...\n" fname))
596 (process-send-string pyproc (format "execfile('%s')\n" fname)))
597
598(defun py-process-filter (pyproc string)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000599 (let ((curbuf (current-buffer))
600 (pbuf (process-buffer pyproc))
601 (pmark (process-mark pyproc))
602 file-finished)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000603
604 ;; make sure we switch to a different buffer at least once. if we
605 ;; *don't* do this, then if the process buffer is in the selected
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000606 ;; window, and point is before the end, and lots of output is
607 ;; coming at a fast pace, then (a) simple cursor-movement commands
608 ;; like C-p, C-n, C-f, C-b, C-a, C-e take an incredibly long time
609 ;; to have a visible effect (the window just doesn't get updated,
610 ;; sometimes for minutes(!)), and (b) it takes about 5x longer to
611 ;; get all the process output (until the next python prompt).
Barry Warsaw7ae77681994-12-12 20:38:05 +0000612 ;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000613 ;; #b makes no sense to me at all. #a almost makes sense: unless
614 ;; we actually change buffers, set_buffer_internal in buffer.c
615 ;; doesn't set windows_or_buffers_changed to 1, & that in turn
616 ;; seems to make the Emacs command loop reluctant to update the
617 ;; display. Perhaps the default process filter in process.c's
618 ;; read_process_output has update_mode_lines++ for a similar
619 ;; reason? beats me ...
620
621 ;; BAW - we want to check to see if this still applies
Barry Warsaw7ae77681994-12-12 20:38:05 +0000622 (if (eq curbuf pbuf) ; mysterious ugly hack
623 (set-buffer (get-buffer-create "*scratch*")))
624
625 (set-buffer pbuf)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000626 (let* ((start (point))
627 (goback (< start pmark))
Barry Warsawe64bfee1995-07-05 22:27:23 +0000628 (goend (and (not goback) (= start (point-max))))
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000629 (buffer-read-only nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000630 (goto-char pmark)
631 (insert string)
632 (move-marker pmark (point))
633 (setq file-finished
634 (and py-file-queue
635 (equal ">>> "
636 (buffer-substring
637 (prog2 (beginning-of-line) (point)
638 (goto-char pmark))
639 (point)))))
640 (if goback (goto-char start)
641 ;; else
642 (if py-scroll-process-buffer
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000643 (let* ((pop-up-windows t)
644 (pwin (display-buffer pbuf)))
Barry Warsawe64bfee1995-07-05 22:27:23 +0000645 (set-window-point pwin (point)))))
646 (set-buffer curbuf)
647 (if file-finished
648 (progn
649 (py-delete-file-silently (car py-file-queue))
650 (setq py-file-queue (cdr py-file-queue))
651 (if py-file-queue
652 (py-execute-file pyproc (car py-file-queue)))))
653 (and goend
654 (progn (set-buffer pbuf)
655 (goto-char (point-max))))
656 )))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000657
658(defun py-execute-buffer ()
659 "Send the contents of the buffer to a Python interpreter.
660If there is a *Python* process buffer it is used. If a clipping
661restriction is in effect, only the accessible portion of the buffer is
662sent. A trailing newline will be supplied if needed.
663
664See the `\\[py-execute-region]' docs for an account of some subtleties."
665 (interactive)
666 (py-execute-region (point-min) (point-max)))
667
668
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000669
670;; Functions for Python style indentation
Barry Warsaw03970731996-07-03 23:12:52 +0000671(defun py-delete-char (count)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000672 "Reduce indentation or delete character.
673If point is at the leftmost column, deletes the preceding newline.
674
675Else if point is at the leftmost non-blank character of a line that is
676neither a continuation line nor a non-indenting comment line, or if
677point is at the end of a blank line, reduces the indentation to match
678that of the line that opened the current block of code. The line that
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000679opened the block is displayed in the echo area to help you keep track
Barry Warsaw03970731996-07-03 23:12:52 +0000680of where you are. With numeric count, outdents that many blocks (but
681not past column zero).
Barry Warsaw7ae77681994-12-12 20:38:05 +0000682
683Else the preceding character is deleted, converting a tab to spaces if
Barry Warsaw03970731996-07-03 23:12:52 +0000684needed so that only a single column position is deleted. Numeric
685argument delets that many characters."
686 (interactive "*p")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000687 (if (or (/= (current-indentation) (current-column))
688 (bolp)
689 (py-continuation-line-p)
690 (looking-at "#[^ \t\n]")) ; non-indenting #
Barry Warsaw03970731996-07-03 23:12:52 +0000691 (backward-delete-char-untabify count)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000692 ;; else indent the same as the colon line that opened the block
693
694 ;; force non-blank so py-goto-block-up doesn't ignore it
695 (insert-char ?* 1)
696 (backward-char)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000697 (let ((base-indent 0) ; indentation of base line
698 (base-text "") ; and text of base line
699 (base-found-p nil))
Barry Warsaw03970731996-07-03 23:12:52 +0000700 (save-excursion
701 (while (< 0 count)
702 (condition-case nil ; in case no enclosing block
703 (progn
704 (py-goto-block-up 'no-mark)
705 (setq base-indent (current-indentation)
706 base-text (py-suck-up-leading-text)
707 base-found-p t))
708 (error nil))
709 (setq count (1- count))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000710 (delete-char 1) ; toss the dummy character
711 (delete-horizontal-space)
712 (indent-to base-indent)
713 (if base-found-p
714 (message "Closes block: %s" base-text)))))
715
Barry Warsawfc8a01f1995-03-09 16:07:29 +0000716;; required for pending-del and delsel modes
717(put 'py-delete-char 'delete-selection 'supersede)
718(put 'py-delete-char 'pending-delete 'supersede)
719
Barry Warsaw7ae77681994-12-12 20:38:05 +0000720(defun py-indent-line ()
721 "Fix the indentation of the current line according to Python rules."
722 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000723 (let* ((ci (current-indentation))
724 (move-to-indentation-p (<= (current-column) ci))
Barry Warsawb86bbad1995-03-14 15:56:35 +0000725 (need (py-compute-indentation)))
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000726 ;; see if we need to outdent
Barry Warsaw3874a3d1995-03-14 22:05:53 +0000727 (if (py-outdent-p)
Barry Warsaw0012c1e1995-03-14 16:32:55 +0000728 (setq need (- need py-indent-offset)))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000729 (if (/= ci need)
730 (save-excursion
731 (beginning-of-line)
732 (delete-horizontal-space)
733 (indent-to need)))
734 (if move-to-indentation-p (back-to-indentation))))
735
736(defun py-newline-and-indent ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000737 "Strives to act like the Emacs `newline-and-indent'.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000738This is just `strives to' because correct indentation can't be computed
739from scratch for Python code. In general, deletes the whitespace before
740point, inserts a newline, and takes an educated guess as to how you want
741the new line indented."
742 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000743 (let ((ci (current-indentation)))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000744 (if (< ci (current-column)) ; if point beyond indentation
745 (newline-and-indent)
746 ;; else try to act like newline-and-indent "normally" acts
747 (beginning-of-line)
748 (insert-char ?\n 1)
749 (move-to-column ci))))
750
751(defun py-compute-indentation ()
752 (save-excursion
Barry Warsaw095e9c61995-09-19 20:01:42 +0000753 (let ((pps (parse-partial-sexp (save-excursion
754 (beginning-of-python-def-or-class)
755 (point))
756 (point))))
757 (beginning-of-line)
758 (cond
759 ;; are we inside a string or comment?
760 ((or (nth 3 pps) (nth 4 pps))
761 (save-excursion
762 (if (not py-align-multiline-strings-p) 0
763 ;; skip back over blank & non-indenting comment lines
764 ;; note: will skip a blank or non-indenting comment line
765 ;; that happens to be a continuation line too
766 (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#[ \t\n]\\)" nil 'move)
767 (back-to-indentation)
768 (current-column))))
769 ;; are we on a continuation line?
770 ((py-continuation-line-p)
771 (let ((startpos (point))
772 (open-bracket-pos (py-nesting-level))
773 endpos searching found)
774 (if open-bracket-pos
775 (progn
776 ;; align with first item in list; else a normal
777 ;; indent beyond the line with the open bracket
778 (goto-char (1+ open-bracket-pos)) ; just beyond bracket
779 ;; is the first list item on the same line?
780 (skip-chars-forward " \t")
781 (if (null (memq (following-char) '(?\n ?# ?\\)))
782 ; yes, so line up with it
783 (current-column)
784 ;; first list item on another line, or doesn't exist yet
785 (forward-line 1)
786 (while (and (< (point) startpos)
787 (looking-at "[ \t]*[#\n\\\\]")) ; skip noise
788 (forward-line 1))
789 (if (< (point) startpos)
790 ;; again mimic the first list item
791 (current-indentation)
792 ;; else they're about to enter the first item
793 (goto-char open-bracket-pos)
794 (+ (current-indentation) py-indent-offset))))
795
796 ;; else on backslash continuation line
797 (forward-line -1)
798 (if (py-continuation-line-p) ; on at least 3rd line in block
799 (current-indentation) ; so just continue the pattern
800 ;; else started on 2nd line in block, so indent more.
801 ;; if base line is an assignment with a start on a RHS,
802 ;; indent to 2 beyond the leftmost "="; else skip first
803 ;; chunk of non-whitespace characters on base line, + 1 more
804 ;; column
805 (end-of-line)
806 (setq endpos (point) searching t)
807 (back-to-indentation)
808 (setq startpos (point))
809 ;; look at all "=" from left to right, stopping at first
810 ;; one not nested in a list or string
811 (while searching
812 (skip-chars-forward "^=" endpos)
813 (if (= (point) endpos)
814 (setq searching nil)
815 (forward-char 1)
816 (setq state (parse-partial-sexp startpos (point)))
817 (if (and (zerop (car state)) ; not in a bracket
818 (null (nth 3 state))) ; & not in a string
819 (progn
820 (setq searching nil) ; done searching in any case
821 (setq found
822 (not (or
823 (eq (following-char) ?=)
824 (memq (char-after (- (point) 2))
825 '(?< ?> ?!)))))))))
826 (if (or (not found) ; not an assignment
827 (looking-at "[ \t]*\\\\")) ; <=><spaces><backslash>
828 (progn
829 (goto-char startpos)
830 (skip-chars-forward "^ \t\n")))
831 (1+ (current-column))))))
832
833 ;; not on a continuation line
834
835 ;; if at start of restriction, or on a non-indenting comment
836 ;; line, assume they intended whatever's there
837 ((or (bobp) (looking-at "[ \t]*#[^ \t\n]"))
838 (current-indentation))
839
840 ;; else indentation based on that of the statement that
841 ;; precedes us; use the first line of that statement to
842 ;; establish the base, in case the user forced a non-std
843 ;; indentation for the continuation lines (if any)
844 (t
Barry Warsawc01c5c81995-09-14 18:49:11 +0000845 ;; skip back over blank & non-indenting comment lines note:
846 ;; will skip a blank or non-indenting comment line that
Barry Warsawfd0fb381996-03-04 17:15:40 +0000847 ;; happens to be a continuation line too. use fast Emacs 19
848 ;; function if it's there.
Barry Warsaw6d627751996-03-06 18:41:38 +0000849 (if (and (eq py-honor-comment-indentation nil)
Barry Warsaw33d6ec01996-03-05 16:28:07 +0000850 (fboundp 'forward-comment))
Barry Warsawfd0fb381996-03-04 17:15:40 +0000851 (forward-comment (- (point-max)))
Barry Warsaw6d627751996-03-06 18:41:38 +0000852 (let (done)
853 (while (not done)
854 (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#[ \t\n]\\)"
855 nil 'move)
856 (setq done (or (eq py-honor-comment-indentation t)
857 (bobp)
858 (/= (following-char) ?#)
859 (not (zerop (current-column)))))
860 )))
Barry Warsaw095e9c61995-09-19 20:01:42 +0000861 ;; if we landed inside a string, go to the beginning of that
862 ;; string. this handles triple quoted, multi-line spanning
863 ;; strings.
864 (py-goto-initial-line)
865 (if (py-statement-opens-block-p)
866 (+ (current-indentation) py-indent-offset)
867 (current-indentation)))))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000868
869(defun py-guess-indent-offset (&optional global)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000870 "Guess a good value for, and change, `py-indent-offset'.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000871By default (without a prefix arg), makes a buffer-local copy of
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000872`py-indent-offset' with the new value. This will not affect any other
Barry Warsaw7ae77681994-12-12 20:38:05 +0000873Python buffers. With a prefix arg, changes the global value of
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000874`py-indent-offset'. This affects all Python buffers (that don't have
Barry Warsaw7ae77681994-12-12 20:38:05 +0000875their own buffer-local copy), both those currently existing and those
876created later in the Emacs session.
877
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000878Some people use a different value for `py-indent-offset' than you use.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000879There's no excuse for such foolishness, but sometimes you have to deal
880with their ugly code anyway. This function examines the file and sets
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000881`py-indent-offset' to what it thinks it was when they created the
882mess.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000883
884Specifically, it searches forward from the statement containing point,
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000885looking for a line that opens a block of code. `py-indent-offset' is
886set to the difference in indentation between that line and the Python
Barry Warsaw7ae77681994-12-12 20:38:05 +0000887statement following it. If the search doesn't succeed going forward,
888it's tried again going backward."
889 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000890 (let (new-value
891 (start (point))
892 restart
893 (found nil)
894 colon-indent)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000895 (py-goto-initial-line)
896 (while (not (or found (eobp)))
897 (if (re-search-forward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
898 (progn
899 (setq restart (point))
900 (py-goto-initial-line)
901 (if (py-statement-opens-block-p)
902 (setq found t)
903 (goto-char restart)))))
904 (if found
905 ()
906 (goto-char start)
907 (py-goto-initial-line)
908 (while (not (or found (bobp)))
909 (setq found
910 (and
911 (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
912 (or (py-goto-initial-line) t) ; always true -- side effect
913 (py-statement-opens-block-p)))))
914 (setq colon-indent (current-indentation)
915 found (and found (zerop (py-next-statement 1)))
916 new-value (- (current-indentation) colon-indent))
917 (goto-char start)
918 (if found
919 (progn
920 (funcall (if global 'kill-local-variable 'make-local-variable)
921 'py-indent-offset)
922 (setq py-indent-offset new-value)
923 (message "%s value of py-indent-offset set to %d"
924 (if global "Global" "Local")
925 py-indent-offset))
926 (error "Sorry, couldn't guess a value for py-indent-offset"))))
927
928(defun py-shift-region (start end count)
929 (save-excursion
930 (goto-char end) (beginning-of-line) (setq end (point))
931 (goto-char start) (beginning-of-line) (setq start (point))
932 (indent-rigidly start end count)))
933
934(defun py-shift-region-left (start end &optional count)
935 "Shift region of Python code to the left.
936The lines from the line containing the start of the current region up
937to (but not including) the line containing the end of the region are
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000938shifted to the left, by `py-indent-offset' columns.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000939
940If a prefix argument is given, the region is instead shifted by that
Barry Warsawdea4a291996-07-03 22:59:12 +0000941many columns. With no active region, outdent only the current line.
942You cannot outdent the region if any line is already at column zero."
943 (interactive
944 (let ((p (point))
945 (m (mark))
946 (arg current-prefix-arg))
947 (if m
948 (list (min p m) (max p m) arg)
949 (list p (save-excursion (forward-line 1) (point)) arg))))
950 ;; if any line is at column zero, don't shift the region
951 (save-excursion
952 (goto-char start)
953 (while (< (point) end)
954 (back-to-indentation)
955 (if (zerop (current-column))
956 (error "Region is at left edge."))
957 (forward-line 1)))
958 (py-shift-region start end (- (prefix-numeric-value
959 (or count py-indent-offset))))
960 (py-keep-region-active))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000961
962(defun py-shift-region-right (start end &optional count)
963 "Shift region of Python code to the right.
964The lines from the line containing the start of the current region up
965to (but not including) the line containing the end of the region are
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000966shifted to the right, by `py-indent-offset' columns.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000967
968If a prefix argument is given, the region is instead shifted by that
Barry Warsawdea4a291996-07-03 22:59:12 +0000969many columns. With no active region, indent only the current line."
970 (interactive
971 (let ((p (point))
972 (m (mark))
973 (arg current-prefix-arg))
974 (if m
975 (list (min p m) (max p m) arg)
976 (list p (save-excursion (forward-line 1) (point)) arg))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000977 (py-shift-region start end (prefix-numeric-value
Barry Warsawdea4a291996-07-03 22:59:12 +0000978 (or count py-indent-offset)))
979 (py-keep-region-active))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000980
981(defun py-indent-region (start end &optional indent-offset)
982 "Reindent a region of Python code.
Barry Warsaw867a32a1996-03-07 18:30:26 +0000983
Barry Warsaw7ae77681994-12-12 20:38:05 +0000984The lines from the line containing the start of the current region up
985to (but not including) the line containing the end of the region are
986reindented. If the first line of the region has a non-whitespace
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000987character in the first column, the first line is left alone and the
988rest of the region is reindented with respect to it. Else the entire
Barry Warsaw867a32a1996-03-07 18:30:26 +0000989region is reindented with respect to the (closest code or indenting
990comment) statement immediately preceding the region.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000991
992This is useful when code blocks are moved or yanked, when enclosing
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000993control structures are introduced or removed, or to reformat code
994using a new value for the indentation offset.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000995
996If a numeric prefix argument is given, it will be used as the value of
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000997the indentation offset. Else the value of `py-indent-offset' will be
Barry Warsaw7ae77681994-12-12 20:38:05 +0000998used.
999
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001000Warning: The region must be consistently indented before this function
Barry Warsaw7ae77681994-12-12 20:38:05 +00001001is called! This function does not compute proper indentation from
1002scratch (that's impossible in Python), it merely adjusts the existing
1003indentation to be correct in context.
1004
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001005Warning: This function really has no idea what to do with
1006non-indenting comment lines, and shifts them as if they were indenting
1007comment lines. Fixing this appears to require telepathy.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001008
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001009Special cases: whitespace is deleted from blank lines; continuation
1010lines are shifted by the same amount their initial line was shifted,
1011in order to preserve their relative indentation with respect to their
Barry Warsaw7ae77681994-12-12 20:38:05 +00001012initial line; and comment lines beginning in column 1 are ignored."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001013 (interactive "*r\nP") ; region; raw prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00001014 (save-excursion
1015 (goto-char end) (beginning-of-line) (setq end (point-marker))
1016 (goto-char start) (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001017 (let ((py-indent-offset (prefix-numeric-value
1018 (or indent-offset py-indent-offset)))
1019 (indents '(-1)) ; stack of active indent levels
1020 (target-column 0) ; column to which to indent
1021 (base-shifted-by 0) ; amount last base line was shifted
1022 (indent-base (if (looking-at "[ \t\n]")
1023 (py-compute-indentation)
1024 0))
1025 ci)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001026 (while (< (point) end)
1027 (setq ci (current-indentation))
1028 ;; figure out appropriate target column
1029 (cond
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001030 ((or (eq (following-char) ?#) ; comment in column 1
1031 (looking-at "[ \t]*$")) ; entirely blank
1032 (setq target-column 0))
1033 ((py-continuation-line-p) ; shift relative to base line
1034 (setq target-column (+ ci base-shifted-by)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001035 (t ; new base line
1036 (if (> ci (car indents)) ; going deeper; push it
1037 (setq indents (cons ci indents))
1038 ;; else we should have seen this indent before
1039 (setq indents (memq ci indents)) ; pop deeper indents
1040 (if (null indents)
1041 (error "Bad indentation in region, at line %d"
1042 (save-restriction
1043 (widen)
1044 (1+ (count-lines 1 (point)))))))
1045 (setq target-column (+ indent-base
1046 (* py-indent-offset
1047 (- (length indents) 2))))
1048 (setq base-shifted-by (- target-column ci))))
1049 ;; shift as needed
1050 (if (/= ci target-column)
1051 (progn
1052 (delete-horizontal-space)
1053 (indent-to target-column)))
1054 (forward-line 1))))
1055 (set-marker end nil))
1056
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001057
1058;; Functions for moving point
Barry Warsaw7ae77681994-12-12 20:38:05 +00001059(defun py-previous-statement (count)
1060 "Go to the start of previous Python statement.
1061If the statement at point is the i'th Python statement, goes to the
1062start of statement i-COUNT. If there is no such statement, goes to the
1063first statement. Returns count of statements left to move.
1064`Statements' do not include blank, comment, or continuation lines."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001065 (interactive "p") ; numeric prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00001066 (if (< count 0) (py-next-statement (- count))
1067 (py-goto-initial-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001068 (let (start)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001069 (while (and
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001070 (setq start (point)) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00001071 (> count 0)
1072 (zerop (forward-line -1))
1073 (py-goto-statement-at-or-above))
1074 (setq count (1- count)))
1075 (if (> count 0) (goto-char start)))
1076 count))
1077
1078(defun py-next-statement (count)
1079 "Go to the start of next Python statement.
1080If the statement at point is the i'th Python statement, goes to the
1081start of statement i+COUNT. If there is no such statement, goes to the
1082last statement. Returns count of statements left to move. `Statements'
1083do not include blank, comment, or continuation lines."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001084 (interactive "p") ; numeric prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00001085 (if (< count 0) (py-previous-statement (- count))
1086 (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001087 (let (start)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001088 (while (and
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001089 (setq start (point)) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00001090 (> count 0)
1091 (py-goto-statement-below))
1092 (setq count (1- count)))
1093 (if (> count 0) (goto-char start)))
1094 count))
1095
1096(defun py-goto-block-up (&optional nomark)
1097 "Move up to start of current block.
1098Go to the statement that starts the smallest enclosing block; roughly
1099speaking, this will be the closest preceding statement that ends with a
1100colon and is indented less than the statement you started on. If
1101successful, also sets the mark to the starting point.
1102
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001103`\\[py-mark-block]' can be used afterward to mark the whole code
1104block, if desired.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001105
1106If called from a program, the mark will not be set if optional argument
1107NOMARK is not nil."
1108 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001109 (let ((start (point))
1110 (found nil)
1111 initial-indent)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001112 (py-goto-initial-line)
1113 ;; if on blank or non-indenting comment line, use the preceding stmt
1114 (if (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)")
1115 (progn
1116 (py-goto-statement-at-or-above)
1117 (setq found (py-statement-opens-block-p))))
1118 ;; search back for colon line indented less
1119 (setq initial-indent (current-indentation))
1120 (if (zerop initial-indent)
1121 ;; force fast exit
1122 (goto-char (point-min)))
1123 (while (not (or found (bobp)))
1124 (setq found
1125 (and
1126 (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
1127 (or (py-goto-initial-line) t) ; always true -- side effect
1128 (< (current-indentation) initial-indent)
1129 (py-statement-opens-block-p))))
1130 (if found
1131 (progn
1132 (or nomark (push-mark start))
1133 (back-to-indentation))
1134 (goto-char start)
1135 (error "Enclosing block not found"))))
1136
1137(defun beginning-of-python-def-or-class (&optional class)
1138 "Move point to start of def (or class, with prefix arg).
1139
1140Searches back for the closest preceding `def'. If you supply a prefix
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001141arg, looks for a `class' instead. The docs assume the `def' case;
1142just substitute `class' for `def' for the other case.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001143
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001144If point is in a def statement already, and after the `d', simply
1145moves point to the start of the statement.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001146
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001147Else (point is not in a def statement, or at or before the `d' of a
1148def statement), searches for the closest preceding def statement, and
1149leaves point at its start. If no such statement can be found, leaves
1150point at the start of the buffer.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001151
1152Returns t iff a def statement is found by these rules.
1153
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001154Note that doing this command repeatedly will take you closer to the
1155start of the buffer each time.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001156
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001157If you want to mark the current def/class, see
1158`\\[mark-python-def-or-class]'."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001159 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001160 (let ((at-or-before-p (<= (current-column) (current-indentation)))
1161 (start-of-line (progn (beginning-of-line) (point)))
1162 (start-of-stmt (progn (py-goto-initial-line) (point))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001163 (if (or (/= start-of-stmt start-of-line)
1164 (not at-or-before-p))
1165 (end-of-line)) ; OK to match on this line
1166 (re-search-backward (if class "^[ \t]*class\\>" "^[ \t]*def\\>")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001167 nil 'move)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001168
1169(defun end-of-python-def-or-class (&optional class)
1170 "Move point beyond end of def (or class, with prefix arg) body.
1171
1172By default, looks for an appropriate `def'. If you supply a prefix arg,
1173looks for a `class' instead. The docs assume the `def' case; just
1174substitute `class' for `def' for the other case.
1175
1176If point is in a def statement already, this is the def we use.
1177
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001178Else if the def found by `\\[beginning-of-python-def-or-class]'
1179contains the statement you started on, that's the def we use.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001180
1181Else we search forward for the closest following def, and use that.
1182
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001183If a def can be found by these rules, point is moved to the start of
1184the line immediately following the def block, and the position of the
1185start of the def is returned.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001186
1187Else point is moved to the end of the buffer, and nil is returned.
1188
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001189Note that doing this command repeatedly will take you closer to the
1190end of the buffer each time.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001191
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001192If you want to mark the current def/class, see
1193`\\[mark-python-def-or-class]'."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001194 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001195 (let ((start (progn (py-goto-initial-line) (point)))
1196 (which (if class "class" "def"))
1197 (state 'not-found))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001198 ;; move point to start of appropriate def/class
1199 (if (looking-at (concat "[ \t]*" which "\\>")) ; already on one
1200 (setq state 'at-beginning)
1201 ;; else see if beginning-of-python-def-or-class hits container
1202 (if (and (beginning-of-python-def-or-class class)
1203 (progn (py-goto-beyond-block)
1204 (> (point) start)))
1205 (setq state 'at-end)
1206 ;; else search forward
1207 (goto-char start)
1208 (if (re-search-forward (concat "^[ \t]*" which "\\>") nil 'move)
1209 (progn (setq state 'at-beginning)
1210 (beginning-of-line)))))
1211 (cond
1212 ((eq state 'at-beginning) (py-goto-beyond-block) t)
1213 ((eq state 'at-end) t)
1214 ((eq state 'not-found) nil)
1215 (t (error "internal error in end-of-python-def-or-class")))))
1216
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001217
1218;; Functions for marking regions
Barry Warsaw7ae77681994-12-12 20:38:05 +00001219(defun py-mark-block (&optional extend just-move)
1220 "Mark following block of lines. With prefix arg, mark structure.
1221Easier to use than explain. It sets the region to an `interesting'
1222block of succeeding lines. If point is on a blank line, it goes down to
1223the next non-blank line. That will be the start of the region. The end
1224of the region depends on the kind of line at the start:
1225
1226 - If a comment, the region will include all succeeding comment lines up
1227 to (but not including) the next non-comment line (if any).
1228
1229 - Else if a prefix arg is given, and the line begins one of these
1230 structures:
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001231
1232 if elif else try except finally for while def class
1233
Barry Warsaw7ae77681994-12-12 20:38:05 +00001234 the region will be set to the body of the structure, including
1235 following blocks that `belong' to it, but excluding trailing blank
1236 and comment lines. E.g., if on a `try' statement, the `try' block
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001237 and all (if any) of the following `except' and `finally' blocks
1238 that belong to the `try' structure will be in the region. Ditto
1239 for if/elif/else, for/else and while/else structures, and (a bit
1240 degenerate, since they're always one-block structures) def and
1241 class blocks.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001242
1243 - Else if no prefix argument is given, and the line begins a Python
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001244 block (see list above), and the block is not a `one-liner' (i.e.,
1245 the statement ends with a colon, not with code), the region will
1246 include all succeeding lines up to (but not including) the next
1247 code statement (if any) that's indented no more than the starting
1248 line, except that trailing blank and comment lines are excluded.
1249 E.g., if the starting line begins a multi-statement `def'
1250 structure, the region will be set to the full function definition,
1251 but without any trailing `noise' lines.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001252
1253 - Else the region will include all succeeding lines up to (but not
1254 including) the next blank line, or code or indenting-comment line
1255 indented strictly less than the starting line. Trailing indenting
1256 comment lines are included in this case, but not trailing blank
1257 lines.
1258
1259A msg identifying the location of the mark is displayed in the echo
1260area; or do `\\[exchange-point-and-mark]' to flip down to the end.
1261
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001262If called from a program, optional argument EXTEND plays the role of
1263the prefix arg, and if optional argument JUST-MOVE is not nil, just
1264moves to the end of the block (& does not set mark or display a msg)."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001265 (interactive "P") ; raw prefix arg
1266 (py-goto-initial-line)
1267 ;; skip over blank lines
1268 (while (and
1269 (looking-at "[ \t]*$") ; while blank line
1270 (not (eobp))) ; & somewhere to go
1271 (forward-line 1))
1272 (if (eobp)
1273 (error "Hit end of buffer without finding a non-blank stmt"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001274 (let ((initial-pos (point))
1275 (initial-indent (current-indentation))
1276 last-pos ; position of last stmt in region
1277 (followers
1278 '((if elif else) (elif elif else) (else)
1279 (try except finally) (except except) (finally)
1280 (for else) (while else)
1281 (def) (class) ) )
1282 first-symbol next-symbol)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001283
1284 (cond
1285 ;; if comment line, suck up the following comment lines
1286 ((looking-at "[ \t]*#")
1287 (re-search-forward "^[ \t]*[^ \t#]" nil 'move) ; look for non-comment
1288 (re-search-backward "^[ \t]*#") ; and back to last comment in block
1289 (setq last-pos (point)))
1290
1291 ;; else if line is a block line and EXTEND given, suck up
1292 ;; the whole structure
1293 ((and extend
1294 (setq first-symbol (py-suck-up-first-keyword) )
1295 (assq first-symbol followers))
1296 (while (and
1297 (or (py-goto-beyond-block) t) ; side effect
1298 (forward-line -1) ; side effect
1299 (setq last-pos (point)) ; side effect
1300 (py-goto-statement-below)
1301 (= (current-indentation) initial-indent)
1302 (setq next-symbol (py-suck-up-first-keyword))
1303 (memq next-symbol (cdr (assq first-symbol followers))))
1304 (setq first-symbol next-symbol)))
1305
1306 ;; else if line *opens* a block, search for next stmt indented <=
1307 ((py-statement-opens-block-p)
1308 (while (and
1309 (setq last-pos (point)) ; always true -- side effect
1310 (py-goto-statement-below)
1311 (> (current-indentation) initial-indent))
1312 nil))
1313
1314 ;; else plain code line; stop at next blank line, or stmt or
1315 ;; indenting comment line indented <
1316 (t
1317 (while (and
1318 (setq last-pos (point)) ; always true -- side effect
1319 (or (py-goto-beyond-final-line) t)
1320 (not (looking-at "[ \t]*$")) ; stop at blank line
1321 (or
1322 (>= (current-indentation) initial-indent)
1323 (looking-at "[ \t]*#[^ \t\n]"))) ; ignore non-indenting #
1324 nil)))
1325
1326 ;; skip to end of last stmt
1327 (goto-char last-pos)
1328 (py-goto-beyond-final-line)
1329
1330 ;; set mark & display
1331 (if just-move
1332 () ; just return
1333 (push-mark (point) 'no-msg)
1334 (forward-line -1)
1335 (message "Mark set after: %s" (py-suck-up-leading-text))
1336 (goto-char initial-pos))))
1337
1338(defun mark-python-def-or-class (&optional class)
1339 "Set region to body of def (or class, with prefix arg) enclosing point.
1340Pushes the current mark, then point, on the mark ring (all language
1341modes do this, but although it's handy it's never documented ...).
1342
1343In most Emacs language modes, this function bears at least a
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001344hallucinogenic resemblance to `\\[end-of-python-def-or-class]' and
1345`\\[beginning-of-python-def-or-class]'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001346
1347And in earlier versions of Python mode, all 3 were tightly connected.
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001348Turned out that was more confusing than useful: the `goto start' and
1349`goto end' commands are usually used to search through a file, and
1350people expect them to act a lot like `search backward' and `search
1351forward' string-search commands. But because Python `def' and `class'
1352can nest to arbitrary levels, finding the smallest def containing
1353point cannot be done via a simple backward search: the def containing
1354point may not be the closest preceding def, or even the closest
1355preceding def that's indented less. The fancy algorithm required is
1356appropriate for the usual uses of this `mark' command, but not for the
1357`goto' variations.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001358
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001359So the def marked by this command may not be the one either of the
1360`goto' commands find: If point is on a blank or non-indenting comment
1361line, moves back to start of the closest preceding code statement or
1362indenting comment line. If this is a `def' statement, that's the def
1363we use. Else searches for the smallest enclosing `def' block and uses
1364that. Else signals an error.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001365
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001366When an enclosing def is found: The mark is left immediately beyond
1367the last line of the def block. Point is left at the start of the
1368def, except that: if the def is preceded by a number of comment lines
1369followed by (at most) one optional blank line, point is left at the
1370start of the comments; else if the def is preceded by a blank line,
1371point is left at its start.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001372
1373The intent is to mark the containing def/class and its associated
1374documentation, to make moving and duplicating functions and classes
1375pleasant."
1376 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001377 (let ((start (point))
1378 (which (if class "class" "def")))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001379 (push-mark start)
1380 (if (not (py-go-up-tree-to-keyword which))
1381 (progn (goto-char start)
1382 (error "Enclosing %s not found" which))
1383 ;; else enclosing def/class found
1384 (setq start (point))
1385 (py-goto-beyond-block)
1386 (push-mark (point))
1387 (goto-char start)
1388 (if (zerop (forward-line -1)) ; if there is a preceding line
1389 (progn
1390 (if (looking-at "[ \t]*$") ; it's blank
1391 (setq start (point)) ; so reset start point
1392 (goto-char start)) ; else try again
1393 (if (zerop (forward-line -1))
1394 (if (looking-at "[ \t]*#") ; a comment
1395 ;; look back for non-comment line
1396 ;; tricky: note that the regexp matches a blank
1397 ;; line, cuz \n is in the 2nd character class
1398 (and
1399 (re-search-backward "^[ \t]*[^ \t#]" nil 'move)
1400 (forward-line 1))
1401 ;; no comment, so go back
1402 (goto-char start))))))))
1403
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001404
1405;; Documentation functions
Barry Warsaw7ae77681994-12-12 20:38:05 +00001406
1407;; dump the long form of the mode blurb; does the usual doc escapes,
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001408;; plus lines of the form ^[vc]:name$ to suck variable & command docs
1409;; out of the right places, along with the keys they're on & current
1410;; values
Barry Warsaw7ae77681994-12-12 20:38:05 +00001411(defun py-dump-help-string (str)
1412 (with-output-to-temp-buffer "*Help*"
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001413 (let ((locals (buffer-local-variables))
1414 funckind funcname func funcdoc
1415 (start 0) mstart end
1416 keys )
Barry Warsaw7ae77681994-12-12 20:38:05 +00001417 (while (string-match "^%\\([vc]\\):\\(.+\\)\n" str start)
1418 (setq mstart (match-beginning 0) end (match-end 0)
1419 funckind (substring str (match-beginning 1) (match-end 1))
1420 funcname (substring str (match-beginning 2) (match-end 2))
1421 func (intern funcname))
1422 (princ (substitute-command-keys (substring str start mstart)))
1423 (cond
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001424 ((equal funckind "c") ; command
1425 (setq funcdoc (documentation func)
1426 keys (concat
1427 "Key(s): "
1428 (mapconcat 'key-description
1429 (where-is-internal func py-mode-map)
1430 ", "))))
1431 ((equal funckind "v") ; variable
1432 (setq funcdoc (substitute-command-keys
1433 (get func 'variable-documentation))
1434 keys (if (assq func locals)
1435 (concat
1436 "Local/Global values: "
1437 (prin1-to-string (symbol-value func))
1438 " / "
1439 (prin1-to-string (default-value func)))
1440 (concat
1441 "Value: "
1442 (prin1-to-string (symbol-value func))))))
1443 (t ; unexpected
1444 (error "Error in py-dump-help-string, tag `%s'" funckind)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001445 (princ (format "\n-> %s:\t%s\t%s\n\n"
1446 (if (equal funckind "c") "Command" "Variable")
1447 funcname keys))
1448 (princ funcdoc)
1449 (terpri)
1450 (setq start end))
1451 (princ (substitute-command-keys (substring str start))))
1452 (print-help-return-message)))
1453
1454(defun py-describe-mode ()
1455 "Dump long form of Python-mode docs."
1456 (interactive)
1457 (py-dump-help-string "Major mode for editing Python files.
1458Knows about Python indentation, tokens, comments and continuation lines.
1459Paragraphs are separated by blank lines only.
1460
1461Major sections below begin with the string `@'; specific function and
1462variable docs begin with `->'.
1463
1464@EXECUTING PYTHON CODE
1465
1466\\[py-execute-buffer]\tsends the entire buffer to the Python interpreter
1467\\[py-execute-region]\tsends the current region
1468\\[py-shell]\tstarts a Python interpreter window; this will be used by
1469\tsubsequent \\[py-execute-buffer] or \\[py-execute-region] commands
1470%c:py-execute-buffer
1471%c:py-execute-region
1472%c:py-shell
1473
1474@VARIABLES
1475
1476py-indent-offset\tindentation increment
1477py-block-comment-prefix\tcomment string used by py-comment-region
1478
1479py-python-command\tshell command to invoke Python interpreter
1480py-scroll-process-buffer\talways scroll Python process buffer
1481py-temp-directory\tdirectory used for temp files (if needed)
1482
1483py-beep-if-tab-change\tring the bell if tab-width is changed
1484%v:py-indent-offset
1485%v:py-block-comment-prefix
1486%v:py-python-command
1487%v:py-scroll-process-buffer
1488%v:py-temp-directory
1489%v:py-beep-if-tab-change
1490
1491@KINDS OF LINES
1492
1493Each physical line in the file is either a `continuation line' (the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001494preceding line ends with a backslash that's not part of a comment, or
1495the paren/bracket/brace nesting level at the start of the line is
1496non-zero, or both) or an `initial line' (everything else).
Barry Warsaw7ae77681994-12-12 20:38:05 +00001497
1498An initial line is in turn a `blank line' (contains nothing except
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001499possibly blanks or tabs), a `comment line' (leftmost non-blank
1500character is `#'), or a `code line' (everything else).
Barry Warsaw7ae77681994-12-12 20:38:05 +00001501
1502Comment Lines
1503
1504Although all comment lines are treated alike by Python, Python mode
1505recognizes two kinds that act differently with respect to indentation.
1506
1507An `indenting comment line' is a comment line with a blank, tab or
1508nothing after the initial `#'. The indentation commands (see below)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001509treat these exactly as if they were code lines: a line following an
Barry Warsaw7ae77681994-12-12 20:38:05 +00001510indenting comment line will be indented like the comment line. All
1511other comment lines (those with a non-whitespace character immediately
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001512following the initial `#') are `non-indenting comment lines', and
1513their indentation is ignored by the indentation commands.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001514
1515Indenting comment lines are by far the usual case, and should be used
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001516whenever possible. Non-indenting comment lines are useful in cases
1517like these:
Barry Warsaw7ae77681994-12-12 20:38:05 +00001518
1519\ta = b # a very wordy single-line comment that ends up being
1520\t #... continued onto another line
1521
1522\tif a == b:
1523##\t\tprint 'panic!' # old code we've `commented out'
1524\t\treturn a
1525
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001526Since the `#...' and `##' comment lines have a non-whitespace
1527character following the initial `#', Python mode ignores them when
1528computing the proper indentation for the next line.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001529
1530Continuation Lines and Statements
1531
1532The Python-mode commands generally work on statements instead of on
1533individual lines, where a `statement' is a comment or blank line, or a
1534code line and all of its following continuation lines (if any)
1535considered as a single logical unit. The commands in this mode
1536generally (when it makes sense) automatically move to the start of the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001537statement containing point, even if point happens to be in the middle
1538of some continuation line.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001539
1540
1541@INDENTATION
1542
1543Primarily for entering new code:
1544\t\\[indent-for-tab-command]\t indent line appropriately
1545\t\\[py-newline-and-indent]\t insert newline, then indent
1546\t\\[py-delete-char]\t reduce indentation, or delete single character
1547
1548Primarily for reindenting existing code:
1549\t\\[py-guess-indent-offset]\t guess py-indent-offset from file content; change locally
1550\t\\[universal-argument] \\[py-guess-indent-offset]\t ditto, but change globally
1551
1552\t\\[py-indent-region]\t reindent region to match its context
1553\t\\[py-shift-region-left]\t shift region left by py-indent-offset
1554\t\\[py-shift-region-right]\t shift region right by py-indent-offset
1555
1556Unlike most programming languages, Python uses indentation, and only
1557indentation, to specify block structure. Hence the indentation supplied
1558automatically by Python-mode is just an educated guess: only you know
1559the block structure you intend, so only you can supply correct
1560indentation.
1561
1562The \\[indent-for-tab-command] and \\[py-newline-and-indent] keys try to suggest plausible indentation, based on
1563the indentation of preceding statements. E.g., assuming
1564py-indent-offset is 4, after you enter
1565\tif a > 0: \\[py-newline-and-indent]
1566the cursor will be moved to the position of the `_' (_ is not a
1567character in the file, it's just used here to indicate the location of
1568the cursor):
1569\tif a > 0:
1570\t _
1571If you then enter `c = d' \\[py-newline-and-indent], the cursor will move
1572to
1573\tif a > 0:
1574\t c = d
1575\t _
1576Python-mode cannot know whether that's what you intended, or whether
1577\tif a > 0:
1578\t c = d
1579\t_
1580was your intent. In general, Python-mode either reproduces the
1581indentation of the (closest code or indenting-comment) preceding
1582statement, or adds an extra py-indent-offset blanks if the preceding
1583statement has `:' as its last significant (non-whitespace and non-
1584comment) character. If the suggested indentation is too much, use
1585\\[py-delete-char] to reduce it.
1586
1587Continuation lines are given extra indentation. If you don't like the
1588suggested indentation, change it to something you do like, and Python-
1589mode will strive to indent later lines of the statement in the same way.
1590
1591If a line is a continuation line by virtue of being in an unclosed
1592paren/bracket/brace structure (`list', for short), the suggested
1593indentation depends on whether the current line contains the first item
1594in the list. If it does, it's indented py-indent-offset columns beyond
1595the indentation of the line containing the open bracket. If you don't
1596like that, change it by hand. The remaining items in the list will mimic
1597whatever indentation you give to the first item.
1598
1599If a line is a continuation line because the line preceding it ends with
1600a backslash, the third and following lines of the statement inherit their
1601indentation from the line preceding them. The indentation of the second
1602line in the statement depends on the form of the first (base) line: if
1603the base line is an assignment statement with anything more interesting
1604than the backslash following the leftmost assigning `=', the second line
1605is indented two columns beyond that `='. Else it's indented to two
1606columns beyond the leftmost solid chunk of non-whitespace characters on
1607the base line.
1608
1609Warning: indent-region should not normally be used! It calls \\[indent-for-tab-command]
1610repeatedly, and as explained above, \\[indent-for-tab-command] can't guess the block
1611structure you intend.
1612%c:indent-for-tab-command
1613%c:py-newline-and-indent
1614%c:py-delete-char
1615
1616
1617The next function may be handy when editing code you didn't write:
1618%c:py-guess-indent-offset
1619
1620
1621The remaining `indent' functions apply to a region of Python code. They
1622assume the block structure (equals indentation, in Python) of the region
1623is correct, and alter the indentation in various ways while preserving
1624the block structure:
1625%c:py-indent-region
1626%c:py-shift-region-left
1627%c:py-shift-region-right
1628
1629@MARKING & MANIPULATING REGIONS OF CODE
1630
1631\\[py-mark-block]\t mark block of lines
1632\\[mark-python-def-or-class]\t mark smallest enclosing def
1633\\[universal-argument] \\[mark-python-def-or-class]\t mark smallest enclosing class
1634\\[py-comment-region]\t comment out region of code
1635\\[universal-argument] \\[py-comment-region]\t uncomment region of code
1636%c:py-mark-block
1637%c:mark-python-def-or-class
1638%c:py-comment-region
1639
1640@MOVING POINT
1641
1642\\[py-previous-statement]\t move to statement preceding point
1643\\[py-next-statement]\t move to statement following point
1644\\[py-goto-block-up]\t move up to start of current block
1645\\[beginning-of-python-def-or-class]\t move to start of def
1646\\[universal-argument] \\[beginning-of-python-def-or-class]\t move to start of class
1647\\[end-of-python-def-or-class]\t move to end of def
1648\\[universal-argument] \\[end-of-python-def-or-class]\t move to end of class
1649
1650The first two move to one statement beyond the statement that contains
1651point. A numeric prefix argument tells them to move that many
1652statements instead. Blank lines, comment lines, and continuation lines
1653do not count as `statements' for these commands. So, e.g., you can go
1654to the first code statement in a file by entering
1655\t\\[beginning-of-buffer]\t to move to the top of the file
1656\t\\[py-next-statement]\t to skip over initial comments and blank lines
1657Or do `\\[py-previous-statement]' with a huge prefix argument.
1658%c:py-previous-statement
1659%c:py-next-statement
1660%c:py-goto-block-up
1661%c:beginning-of-python-def-or-class
1662%c:end-of-python-def-or-class
1663
1664@LITTLE-KNOWN EMACS COMMANDS PARTICULARLY USEFUL IN PYTHON MODE
1665
1666`\\[indent-new-comment-line]' is handy for entering a multi-line comment.
1667
1668`\\[set-selective-display]' with a `small' prefix arg is ideally suited for viewing the
1669overall class and def structure of a module.
1670
1671`\\[back-to-indentation]' moves point to a line's first non-blank character.
1672
1673`\\[indent-relative]' is handy for creating odd indentation.
1674
1675@OTHER EMACS HINTS
1676
1677If you don't like the default value of a variable, change its value to
1678whatever you do like by putting a `setq' line in your .emacs file.
1679E.g., to set the indentation increment to 4, put this line in your
1680.emacs:
1681\t(setq py-indent-offset 4)
1682To see the value of a variable, do `\\[describe-variable]' and enter the variable
1683name at the prompt.
1684
1685When entering a key sequence like `C-c C-n', it is not necessary to
1686release the CONTROL key after doing the `C-c' part -- it suffices to
1687press the CONTROL key, press and release `c' (while still holding down
1688CONTROL), press and release `n' (while still holding down CONTROL), &
1689then release CONTROL.
1690
1691Entering Python mode calls with no arguments the value of the variable
1692`python-mode-hook', if that value exists and is not nil; for backward
1693compatibility it also tries `py-mode-hook'; see the `Hooks' section of
1694the Elisp manual for details.
1695
1696Obscure: When python-mode is first loaded, it looks for all bindings
1697to newline-and-indent in the global keymap, and shadows them with
1698local bindings to py-newline-and-indent."))
1699
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001700
1701;; Helper functions
Barry Warsaw7ae77681994-12-12 20:38:05 +00001702(defvar py-parse-state-re
1703 (concat
1704 "^[ \t]*\\(if\\|elif\\|else\\|while\\|def\\|class\\)\\>"
1705 "\\|"
1706 "^[^ #\t\n]"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001707
Barry Warsaw7ae77681994-12-12 20:38:05 +00001708;; returns the parse state at point (see parse-partial-sexp docs)
1709(defun py-parse-state ()
1710 (save-excursion
Barry Warsaw43ecf8e1996-04-06 00:00:19 +00001711 (let ((here (point))
1712 pps done)
1713 (while (not done)
1714 ;; back up to the first preceding line (if any; else start of
1715 ;; buffer) that begins with a popular Python keyword, or a
1716 ;; non- whitespace and non-comment character. These are good
1717 ;; places to start parsing to see whether where we started is
1718 ;; at a non-zero nesting level. It may be slow for people who
1719 ;; write huge code blocks or huge lists ... tough beans.
1720 (re-search-backward py-parse-state-re nil 'move)
1721 (beginning-of-line)
1722 (save-excursion
1723 (setq pps (parse-partial-sexp (point) here)))
1724 ;; make sure we don't land inside a triple-quoted string
1725 (setq done (or (not (nth 3 pps)) (bobp))))
1726 pps)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001727
1728;; if point is at a non-zero nesting level, returns the number of the
1729;; character that opens the smallest enclosing unclosed list; else
1730;; returns nil.
1731(defun py-nesting-level ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001732 (let ((status (py-parse-state)) )
Barry Warsaw7ae77681994-12-12 20:38:05 +00001733 (if (zerop (car status))
1734 nil ; not in a nest
1735 (car (cdr status))))) ; char# of open bracket
1736
1737;; t iff preceding line ends with backslash that's not in a comment
1738(defun py-backslash-continuation-line-p ()
1739 (save-excursion
1740 (beginning-of-line)
1741 (and
1742 ;; use a cheap test first to avoid the regexp if possible
1743 ;; use 'eq' because char-after may return nil
1744 (eq (char-after (- (point) 2)) ?\\ )
1745 ;; make sure; since eq test passed, there is a preceding line
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001746 (forward-line -1) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00001747 (looking-at py-continued-re))))
1748
1749;; t iff current line is a continuation line
1750(defun py-continuation-line-p ()
1751 (save-excursion
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001752 (beginning-of-line)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001753 (or (py-backslash-continuation-line-p)
1754 (py-nesting-level))))
1755
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001756;; go to initial line of current statement; usually this is the line
1757;; we're on, but if we're on the 2nd or following lines of a
1758;; continuation block, we need to go up to the first line of the
1759;; block.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001760;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001761;; Tricky: We want to avoid quadratic-time behavior for long continued
1762;; blocks, whether of the backslash or open-bracket varieties, or a
1763;; mix of the two. The following manages to do that in the usual
1764;; cases.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001765(defun py-goto-initial-line ()
1766 (let ( open-bracket-pos )
1767 (while (py-continuation-line-p)
1768 (beginning-of-line)
1769 (if (py-backslash-continuation-line-p)
1770 (while (py-backslash-continuation-line-p)
1771 (forward-line -1))
1772 ;; else zip out of nested brackets/braces/parens
1773 (while (setq open-bracket-pos (py-nesting-level))
1774 (goto-char open-bracket-pos)))))
1775 (beginning-of-line))
1776
1777;; go to point right beyond final line of current statement; usually
1778;; this is the start of the next line, but if this is a multi-line
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001779;; statement we need to skip over the continuation lines. Tricky:
1780;; Again we need to be clever to avoid quadratic time behavior.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001781(defun py-goto-beyond-final-line ()
1782 (forward-line 1)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001783 (let (state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001784 (while (and (py-continuation-line-p)
1785 (not (eobp)))
1786 ;; skip over the backslash flavor
1787 (while (and (py-backslash-continuation-line-p)
1788 (not (eobp)))
1789 (forward-line 1))
1790 ;; if in nest, zip to the end of the nest
1791 (setq state (py-parse-state))
1792 (if (and (not (zerop (car state)))
1793 (not (eobp)))
1794 (progn
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001795 ;; BUG ALERT: I could swear, from reading the docs, that
Barry Warsaw7ae77681994-12-12 20:38:05 +00001796 ;; the 3rd argument should be plain 0
1797 (parse-partial-sexp (point) (point-max) (- 0 (car state))
1798 nil state)
1799 (forward-line 1))))))
1800
1801;; t iff statement opens a block == iff it ends with a colon that's
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001802;; not in a comment. point should be at the start of a statement
Barry Warsaw7ae77681994-12-12 20:38:05 +00001803(defun py-statement-opens-block-p ()
1804 (save-excursion
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001805 (let ((start (point))
1806 (finish (progn (py-goto-beyond-final-line) (1- (point))))
1807 (searching t)
1808 (answer nil)
1809 state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001810 (goto-char start)
1811 (while searching
1812 ;; look for a colon with nothing after it except whitespace, and
1813 ;; maybe a comment
1814 (if (re-search-forward ":\\([ \t]\\|\\\\\n\\)*\\(#.*\\)?$"
1815 finish t)
1816 (if (eq (point) finish) ; note: no `else' clause; just
1817 ; keep searching if we're not at
1818 ; the end yet
1819 ;; sure looks like it opens a block -- but it might
1820 ;; be in a comment
1821 (progn
1822 (setq searching nil) ; search is done either way
1823 (setq state (parse-partial-sexp start
1824 (match-beginning 0)))
1825 (setq answer (not (nth 4 state)))))
1826 ;; search failed: couldn't find another interesting colon
1827 (setq searching nil)))
1828 answer)))
1829
1830;; go to point right beyond final line of block begun by the current
1831;; line. This is the same as where py-goto-beyond-final-line goes
1832;; unless we're on colon line, in which case we go to the end of the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001833;; block. assumes point is at bolp
Barry Warsaw7ae77681994-12-12 20:38:05 +00001834(defun py-goto-beyond-block ()
1835 (if (py-statement-opens-block-p)
1836 (py-mark-block nil 'just-move)
1837 (py-goto-beyond-final-line)))
1838
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001839;; go to start of first statement (not blank or comment or
1840;; continuation line) at or preceding point. returns t if there is
1841;; one, else nil
Barry Warsaw7ae77681994-12-12 20:38:05 +00001842(defun py-goto-statement-at-or-above ()
1843 (py-goto-initial-line)
1844 (if (looking-at py-blank-or-comment-re)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001845 ;; skip back over blank & comment lines
1846 ;; note: will skip a blank or comment line that happens to be
1847 ;; a continuation line too
1848 (if (re-search-backward "^[ \t]*[^ \t#\n]" nil t)
1849 (progn (py-goto-initial-line) t)
1850 nil)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001851 t))
1852
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001853;; go to start of first statement (not blank or comment or
1854;; continuation line) following the statement containing point returns
1855;; t if there is one, else nil
Barry Warsaw7ae77681994-12-12 20:38:05 +00001856(defun py-goto-statement-below ()
1857 (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001858 (let ((start (point)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001859 (py-goto-beyond-final-line)
1860 (while (and
1861 (looking-at py-blank-or-comment-re)
1862 (not (eobp)))
1863 (forward-line 1))
1864 (if (eobp)
1865 (progn (goto-char start) nil)
1866 t)))
1867
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001868;; go to start of statement, at or preceding point, starting with
1869;; keyword KEY. Skips blank lines and non-indenting comments upward
1870;; first. If that statement starts with KEY, done, else go back to
1871;; first enclosing block starting with KEY. If successful, leaves
1872;; point at the start of the KEY line & returns t. Else leaves point
1873;; at an undefined place & returns nil.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001874(defun py-go-up-tree-to-keyword (key)
1875 ;; skip blanks and non-indenting #
1876 (py-goto-initial-line)
1877 (while (and
1878 (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)")
1879 (zerop (forward-line -1))) ; go back
1880 nil)
1881 (py-goto-initial-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001882 (let* ((re (concat "[ \t]*" key "\\b"))
1883 (case-fold-search nil) ; let* so looking-at sees this
1884 (found (looking-at re))
1885 (dead nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001886 (while (not (or found dead))
1887 (condition-case nil ; in case no enclosing block
1888 (py-goto-block-up 'no-mark)
1889 (error (setq dead t)))
1890 (or dead (setq found (looking-at re))))
1891 (beginning-of-line)
1892 found))
1893
1894;; return string in buffer from start of indentation to end of line;
1895;; prefix "..." if leading whitespace was skipped
1896(defun py-suck-up-leading-text ()
1897 (save-excursion
1898 (back-to-indentation)
1899 (concat
1900 (if (bolp) "" "...")
1901 (buffer-substring (point) (progn (end-of-line) (point))))))
1902
1903;; assuming point at bolp, return first keyword ([a-z]+) on the line,
1904;; as a Lisp symbol; return nil if none
1905(defun py-suck-up-first-keyword ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001906 (let ((case-fold-search nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001907 (if (looking-at "[ \t]*\\([a-z]+\\)\\b")
1908 (intern (buffer-substring (match-beginning 1) (match-end 1)))
1909 nil)))
1910
1911(defun py-make-temp-name ()
1912 (make-temp-name
1913 (concat (file-name-as-directory py-temp-directory) "python")))
1914
1915(defun py-delete-file-silently (fname)
1916 (condition-case nil
1917 (delete-file fname)
1918 (error nil)))
1919
1920(defun py-kill-emacs-hook ()
1921 ;; delete our temp files
1922 (while py-file-queue
1923 (py-delete-file-silently (car py-file-queue))
1924 (setq py-file-queue (cdr py-file-queue)))
1925 (if (not (or py-this-is-lucid-emacs-p py-this-is-emacs-19-p))
1926 ;; run the hook we inherited, if any
1927 (and py-inherited-kill-emacs-hook
1928 (funcall py-inherited-kill-emacs-hook))))
1929
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001930;; make PROCESS's buffer visible, append STRING to it, and force
1931;; display; also make shell-mode believe the user typed this string,
1932;; so that kill-output-from-shell and show-output-from-shell work
1933;; "right"
Barry Warsaw7ae77681994-12-12 20:38:05 +00001934(defun py-append-to-process-buffer (process string)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001935 (let ((cbuf (current-buffer))
1936 (pbuf (process-buffer process))
1937 (py-scroll-process-buffer t))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001938 (set-buffer pbuf)
1939 (goto-char (point-max))
1940 (move-marker (process-mark process) (point))
Barry Warsaw4dba7e21995-07-05 23:01:43 +00001941 (if (not (or py-this-is-emacs-19-p
1942 py-this-is-lucid-emacs-p))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001943 (move-marker last-input-start (point))) ; muck w/ shell-mode
1944 (funcall (process-filter process) process string)
Barry Warsaw4dba7e21995-07-05 23:01:43 +00001945 (if (not (or py-this-is-emacs-19-p
1946 py-this-is-lucid-emacs-p))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001947 (move-marker last-input-end (point))) ; muck w/ shell-mode
1948 (set-buffer cbuf))
1949 (sit-for 0))
1950
Barry Warsaw74d9cc51995-03-08 22:05:16 +00001951(defun py-keep-region-active ()
1952 ;; do whatever is necessary to keep the region active in XEmacs.
1953 ;; Ignore byte-compiler warnings you might see. Also note that
1954 ;; FSF's Emacs 19 does it differently and doesn't its policy doesn't
1955 ;; require us to take explicit action.
1956 (and (boundp 'zmacs-region-stays)
1957 (setq zmacs-region-stays t)))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001958
1959
Barry Warsaw850437a1995-03-08 21:50:28 +00001960(defconst py-version "$Revision$"
1961 "`python-mode' version number.")
Barry Warsawfec75d61995-07-05 23:26:15 +00001962(defconst py-help-address "python-mode@python.org"
Barry Warsaw850437a1995-03-08 21:50:28 +00001963 "Address accepting submission of bug reports.")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001964
Barry Warsaw850437a1995-03-08 21:50:28 +00001965(defun py-version ()
1966 "Echo the current version of `python-mode' in the minibuffer."
1967 (interactive)
1968 (message "Using `python-mode' version %s" py-version)
1969 (py-keep-region-active))
1970
1971;; only works under Emacs 19
1972;(eval-when-compile
1973; (require 'reporter))
1974
1975(defun py-submit-bug-report (enhancement-p)
1976 "Submit via mail a bug report on `python-mode'.
1977With \\[universal-argument] just submit an enhancement request."
1978 (interactive
1979 (list (not (y-or-n-p
1980 "Is this a bug report? (hit `n' to send other comments) "))))
Barry Warsawb5e0ecb1995-03-14 18:32:54 +00001981 (let ((reporter-prompt-for-summary-p (if enhancement-p
1982 "(Very) brief summary: "
1983 t)))
Barry Warsaw850437a1995-03-08 21:50:28 +00001984 (require 'reporter)
1985 (reporter-submit-bug-report
1986 py-help-address ;address
Barry Warsawb5e0ecb1995-03-14 18:32:54 +00001987 (concat "python-mode " py-version) ;pkgname
Barry Warsaw850437a1995-03-08 21:50:28 +00001988 ;; varlist
1989 (if enhancement-p nil
1990 '(py-python-command
1991 py-indent-offset
1992 py-block-comment-prefix
1993 py-scroll-process-buffer
1994 py-temp-directory
1995 py-beep-if-tab-change))
1996 nil ;pre-hooks
1997 nil ;post-hooks
1998 "Dear Barry,") ;salutation
1999 (if enhancement-p nil
2000 (set-mark (point))
2001 (insert
2002"Please replace this text with a sufficiently large code sample\n\
2003and an exact recipe so that I can reproduce your problem. Failure\n\
2004to do so may mean a greater delay in fixing your bug.\n\n")
2005 (exchange-point-and-mark)
2006 (py-keep-region-active))))
2007
2008
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002009;; arrange to kill temp files when Emacs exists
2010(if (or py-this-is-emacs-19-p py-this-is-lucid-emacs-p)
2011 (add-hook 'kill-emacs-hook 'py-kill-emacs-hook)
2012 ;; have to trust that other people are as respectful of our hook
2013 ;; fiddling as we are of theirs
2014 (if (boundp 'py-inherited-kill-emacs-hook)
2015 ;; we were loaded before -- trust others not to have screwed us
2016 ;; in the meantime (no choice, really)
2017 nil
2018 ;; else arrange for our hook to run theirs
2019 (setq py-inherited-kill-emacs-hook kill-emacs-hook)
2020 (setq kill-emacs-hook 'py-kill-emacs-hook)))
2021
2022
2023
2024(provide 'python-mode)
2025;;; python-mode.el ends here