blob: 0b6383b32f1d9ad27e3e983d52785ca81f036689 [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
5;; Author: 1995 Barry A. Warsaw <bwarsaw@cnri.reston.va.us>
6;; 1992-1994 Tim Peters <tim@ksr.com>
7;; Maintainer: bwarsaw@cnri.reston.va.us
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$
11;; Keywords: python editing language major-mode
12
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 Warsawcfec3591995-03-10 15:58:16 +000024;; 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
28;; mode works exceedingly well.
29
30;; The following statements, placed in your .emacs file or
31;; site-init.el, will cause this file to be autoloaded, and
32;; python-mode invoked, when visiting .py files (assuming this file is
33;; in your load-path):
Barry Warsaw7ae77681994-12-12 20:38:05 +000034;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +000035;; (autoload 'python-mode "python-mode" "Python editing mode." t)
Barry Warsaw7ae77681994-12-12 20:38:05 +000036;; (setq auto-mode-alist
37;; (cons '("\\.py$" . python-mode) auto-mode-alist))
38
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000039;; Here's a brief list of recent additions/improvements:
40;;
41;; - Wrapping and indentation within triple quote strings should work
42;; properly now.
43;; - `Standard' bug reporting mechanism (use C-c C-b)
44;; - py-mark-block was moved to C-c C-m
45;; - C-c C-v shows you the python-mode version
46;; - a basic python-font-lock-keywords has been added for Emacs 19
47;; font-lock colorizations.
48;; - proper interaction with pending-del and del-sel modes.
49;; - New py-electric-colon (:) command for improved outdenting. Also
50;; py-indent-line (TAB) should handle outdented lines better.
Barry Warsaw1a6c82f1995-03-15 16:23:59 +000051;; - New commands py-outdent-left (C-c C-l) and py-indent-right (C-c C-r)
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000052
Barry Warsaw7b0f5681995-03-08 21:33:04 +000053;; Here's a brief to do list:
54;;
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000055;; - Better integration with gud-mode for debugging.
56;; - Rewrite according to GNU Emacs Lisp standards.
57;; - py-delete-char should obey numeric arguments.
58;; - even better support for outdenting. Guido suggests outdents of
59;; at least one level after a return, raise, break, or continue
60;; statement.
Barry Warsaw7a1f6f41995-05-08 21:36:20 +000061;; - de-electrify colon inside literals (e.g. comments and strings)
Barry Warsaw7ae77681994-12-12 20:38:05 +000062
Barry Warsaw7b0f5681995-03-08 21:33:04 +000063;; If you can think of more things you'd like to see, drop me a line.
64;; If you want to report bugs, use py-submit-bug-report (C-c C-b).
65;;
66;; Note that I only test things on XEmacs (currently 19.11). If you
67;; port stuff to FSF Emacs 19, or Emacs 18, please send me your
68;; patches.
Barry Warsaw7ae77681994-12-12 20:38:05 +000069
Barry Warsaw7b0f5681995-03-08 21:33:04 +000070;; LCD Archive Entry:
71;; python-mode|Barry A. Warsaw|bwarsaw@cnri.reston.va.us
72;; |Major mode for editing Python programs
73;; |$Date$|$Revision$|
Barry Warsaw7ae77681994-12-12 20:38:05 +000074
Barry Warsaw7b0f5681995-03-08 21:33:04 +000075;;; Code:
76
77
78;; user definable variables
79;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
Barry Warsaw7ae77681994-12-12 20:38:05 +000080
81(defvar py-python-command "python"
82 "*Shell command used to start Python interpreter.")
83
84(defvar py-indent-offset 8 ; argue with Guido <grin>
85 "*Indentation increment.
Barry Warsaw7b0f5681995-03-08 21:33:04 +000086Note that `\\[py-guess-indent-offset]' can usually guess a good value
87when you're editing someone else's Python code.")
Barry Warsaw7ae77681994-12-12 20:38:05 +000088
89(defvar py-block-comment-prefix "##"
Barry Warsaw7b0f5681995-03-08 21:33:04 +000090 "*String used by `py-comment-region' to comment out a block of code.
Barry Warsaw7ae77681994-12-12 20:38:05 +000091This should follow the convention for non-indenting comment lines so
92that the indentation commands won't get confused (i.e., the string
93should be of the form `#x...' where `x' is not a blank or a tab, and
94`...' is arbitrary).")
95
96(defvar py-scroll-process-buffer t
97 "*Scroll Python process buffer as output arrives.
98If nil, the Python process buffer acts, with respect to scrolling, like
99Shell-mode buffers normally act. This is surprisingly complicated and
100so won't be explained here; in fact, you can't get the whole story
101without studying the Emacs C code.
102
103If non-nil, the behavior is different in two respects (which are
104slightly inaccurate in the interest of brevity):
105
106 - If the buffer is in a window, and you left point at its end, the
107 window will scroll as new output arrives, and point will move to the
108 buffer's end, even if the window is not the selected window (that
109 being the one the cursor is in). The usual behavior for shell-mode
110 windows is not to scroll, and to leave point where it was, if the
111 buffer is in a window other than the selected window.
112
113 - If the buffer is not visible in any window, and you left point at
114 its end, the buffer will be popped into a window as soon as more
115 output arrives. This is handy if you have a long-running
116 computation and don't want to tie up screen area waiting for the
117 output. The usual behavior for a shell-mode buffer is to stay
118 invisible until you explicitly visit it.
119
120Note the `and if you left point at its end' clauses in both of the
121above: you can `turn off' the special behaviors while output is in
122progress, by visiting the Python buffer and moving point to anywhere
123besides the end. Then the buffer won't scroll, point will remain where
124you leave it, and if you hide the buffer it will stay hidden until you
125visit it again. You can enable and disable the special behaviors as
126often as you like, while output is in progress, by (respectively) moving
127point to, or away from, the end of the buffer.
128
129Warning: If you expect a large amount of output, you'll probably be
130happier setting this option to nil.
131
132Obscure: `End of buffer' above should really say `at or beyond the
133process mark', but if you know what that means you didn't need to be
134told <grin>.")
135
136(defvar py-temp-directory
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000137 (let ((ok '(lambda (x)
138 (and x
139 (setq x (expand-file-name x)) ; always true
140 (file-directory-p x)
141 (file-writable-p x)
142 x))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000143 (or (funcall ok (getenv "TMPDIR"))
144 (funcall ok "/usr/tmp")
145 (funcall ok "/tmp")
146 (funcall ok ".")
147 (error
148 "Couldn't find a usable temp directory -- set py-temp-directory")))
149 "*Directory used for temp files created by a *Python* process.
150By default, the first directory from this list that exists and that you
151can write into: the value (if any) of the environment variable TMPDIR,
152/usr/tmp, /tmp, or the current directory.")
153
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000154(defvar py-beep-if-tab-change t
155 "*Ring the bell if tab-width is changed.
156If a comment of the form
157
158 \t# vi:set tabsize=<number>:
159
160is found before the first code line when the file is entered, and the
161current value of (the general Emacs variable) `tab-width' does not
162equal <number>, `tab-width' is set to <number>, a message saying so is
163displayed in the echo area, and if `py-beep-if-tab-change' is non-nil
164the Emacs bell is also rung as a warning.")
165
Barry Warsaw4f005cf1995-03-08 22:02:44 +0000166(defvar python-font-lock-keywords
Barry Warsaw65bc7a71995-03-08 22:25:47 +0000167 (list
168 (cons
169 (concat
170 "\\<\\("
171 (mapconcat
172 'identity
173 '("access" "and" "break" "continue"
174 "del" "elif" "else" "except"
175 "exec" "finally" "for" "from"
176 "global" "if" "import" "in"
177 "is" "lambda" "not" "or"
178 "pass" "print" "raise" "return"
179 "try" "while" "def" "class"
180 )
181 "\\|")
182 "\\)\\>")
183 1)
184 ;; functions
185 '("\\bdef\\s +\\(\\sw+\\)(" 1 font-lock-function-name-face)
186 ;; classes
187 '("\\bclass\\s +\\(\\sw+\\)[(:]" 1 font-lock-function-name-face)
188 )
Barry Warsawc723b751995-03-08 22:03:16 +0000189 "*Additional keywords to highlight `python-mode' buffers.")
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000190
Barry Warsawb01b4fa1995-06-20 18:55:34 +0000191;; These are taken from XEmacs 19.12's font-lock.el file. I prefer
192;; these myself, but which do you think are better?
193;;
194;;(defconst python-font-lock-keywords
195;; (purecopy
196;; (list
197;; (cons (concat "\\b\\("
198;; (mapconcat 'identity
199;; '("access" "del" "from"
200;; "lambda" "return" "and"
201;; "elif" "global" "not"
202;; "try:" "break " "else:"
203;; "if" "or" "while"
204;; "except" "except:" "import"
205;; "pass" "continue" "finally:"
206;; "in" "print" "for"
207;; "is" "raise")
208;; "\\|")
209;; "\\)[ \n\t(]")
210;; 1)
211;; '("\\bclass[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)"
212;; 1 font-lock-type-face)
213;; '("\\bdef[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)"
214;; 1 font-lock-function-name-face)
215;; ))
216;; "Additional expressions to highlight in Python mode.")
217
218;; R Lindsay Todd <toddr@rpi.edu> suggests these changes to the
219;; original keywords, which wouldn't be necessary if we go with the
220;; XEmacs defaults, but which I agree makes sense without them.
221;;
222;; functions
223;; '("\\bdef\\s +\\(\\sw+\\)\\s *(" 1 font-lock-function-name-face)
224;; classes
225;; '("\\bclass\\s +\\(\\sw+\\)\\s *[(:]" 1 font-lock-type-face)
226
227
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000228
229;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
230;; NO USER DEFINABLE VARIABLES BEYOND THIS POINT
231
232;; Differentiate between Emacs 18, Lucid Emacs, and Emacs 19. This
233;; seems to be the standard way of checking this.
234;; BAW - This is *not* the right solution. When at all possible,
235;; instead of testing for the version of Emacs, use feature tests.
236
237(setq py-this-is-lucid-emacs-p (string-match "Lucid\\|XEmacs" emacs-version))
238(setq py-this-is-emacs-19-p
239 (and
240 (not py-this-is-lucid-emacs-p)
241 (string-match "^19\\." emacs-version)))
242
Barry Warsaw7ae77681994-12-12 20:38:05 +0000243;; have to bind py-file-queue before installing the kill-emacs hook
244(defvar py-file-queue nil
245 "Queue of Python temp files awaiting execution.
246Currently-active file is at the head of the list.")
247
248;; define a mode-specific abbrev table for those who use such things
249(defvar python-mode-abbrev-table nil
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000250 "Abbrev table in use in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000251(define-abbrev-table 'python-mode-abbrev-table nil)
252
Barry Warsaw7ae77681994-12-12 20:38:05 +0000253(defvar python-mode-hook nil
254 "*Hook called by `python-mode'.")
255
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000256;; in previous version of python-mode.el, the hook was incorrectly
257;; called py-mode-hook, and was not defvar'd. deprecate its use.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000258(and (fboundp 'make-obsolete-variable)
259 (make-obsolete-variable 'py-mode-hook 'python-mode-hook))
260
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000261(defvar py-mode-map ()
262 "Keymap used in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000263
Barry Warsaw7ae77681994-12-12 20:38:05 +0000264(if py-mode-map
265 ()
266 (setq py-mode-map (make-sparse-keymap))
267
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000268 ;; shadow global bindings for newline-and-indent w/ the py- version.
269 ;; BAW - this is extremely bad form, but I'm not going to change it
270 ;; for now.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000271 (mapcar (function (lambda (key)
272 (define-key
273 py-mode-map key 'py-newline-and-indent)))
274 (where-is-internal 'newline-and-indent))
275
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000276 ;; BAW - you could do it this way, but its not considered proper
277 ;; major-mode form.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000278 (mapcar (function
279 (lambda (x)
280 (define-key py-mode-map (car x) (cdr x))))
Barry Warsawb91b7431995-03-14 15:55:20 +0000281 '((":" . py-electric-colon)
282 ("\C-c\C-c" . py-execute-buffer)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000283 ("\C-c|" . py-execute-region)
284 ("\C-c!" . py-shell)
285 ("\177" . py-delete-char)
286 ("\n" . py-newline-and-indent)
287 ("\C-c:" . py-guess-indent-offset)
288 ("\C-c\t" . py-indent-region)
Barry Warsaw1a6c82f1995-03-15 16:23:59 +0000289 ("\C-c\C-l" . py-outdent-left)
290 ("\C-c\C-r" . py-indent-right)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000291 ("\C-c<" . py-shift-region-left)
292 ("\C-c>" . py-shift-region-right)
293 ("\C-c\C-n" . py-next-statement)
294 ("\C-c\C-p" . py-previous-statement)
295 ("\C-c\C-u" . py-goto-block-up)
Barry Warsaw850437a1995-03-08 21:50:28 +0000296 ("\C-c\C-m" . py-mark-block)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000297 ("\C-c#" . py-comment-region)
298 ("\C-c?" . py-describe-mode)
299 ("\C-c\C-hm" . py-describe-mode)
300 ("\e\C-a" . beginning-of-python-def-or-class)
301 ("\e\C-e" . end-of-python-def-or-class)
Barry Warsaw850437a1995-03-08 21:50:28 +0000302 ( "\e\C-h" . mark-python-def-or-class)))
303 ;; should do all keybindings this way
304 (define-key py-mode-map "\C-c\C-b" 'py-submit-bug-report)
305 (define-key py-mode-map "\C-c\C-v" 'py-version)
306 )
Barry Warsaw7ae77681994-12-12 20:38:05 +0000307
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000308(defvar py-mode-syntax-table nil
309 "Syntax table used in `python-mode' buffers.")
310
Barry Warsaw7ae77681994-12-12 20:38:05 +0000311(if py-mode-syntax-table
312 ()
313 (setq py-mode-syntax-table (make-syntax-table))
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000314 ;; BAW - again, blech.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000315 (mapcar (function
316 (lambda (x) (modify-syntax-entry
317 (car x) (cdr x) py-mode-syntax-table)))
318 '(( ?\( . "()" ) ( ?\) . ")(" )
319 ( ?\[ . "(]" ) ( ?\] . ")[" )
320 ( ?\{ . "(}" ) ( ?\} . "){" )
321 ;; fix operator symbols misassigned in the std table
322 ( ?\$ . "." ) ( ?\% . "." ) ( ?\& . "." )
323 ( ?\* . "." ) ( ?\+ . "." ) ( ?\- . "." )
324 ( ?\/ . "." ) ( ?\< . "." ) ( ?\= . "." )
325 ( ?\> . "." ) ( ?\| . "." )
326 ( ?\_ . "w" ) ; underscore is legit in names
327 ( ?\' . "\"") ; single quote is string quote
328 ( ?\" . "\"" ) ; double quote is string quote too
329 ( ?\` . "$") ; backquote is open and close paren
330 ( ?\# . "<") ; hash starts comment
331 ( ?\n . ">")))) ; newline ends comment
332
333(defconst py-stringlit-re
334 (concat
335 "'\\([^'\n\\]\\|\\\\.\\)*'" ; single-quoted
336 "\\|" ; or
337 "\"\\([^\"\n\\]\\|\\\\.\\)*\"") ; double-quoted
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000338 "Regexp matching a Python string literal.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000339
340;; this is tricky because a trailing backslash does not mean
341;; continuation if it's in a comment
342(defconst py-continued-re
343 (concat
344 "\\(" "[^#'\"\n\\]" "\\|" py-stringlit-re "\\)*"
345 "\\\\$")
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000346 "Regexp matching Python lines that are continued via backslash.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000347
348(defconst py-blank-or-comment-re "[ \t]*\\($\\|#\\)"
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000349 "Regexp matching blank or comment lines.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000350
Barry Warsaw0012c1e1995-03-14 16:32:55 +0000351(defconst py-outdent-re
352 (concat "\\(" (mapconcat 'identity
353 '("else:"
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000354 "except\\(\\s +.*\\)?:"
Barry Warsaw0012c1e1995-03-14 16:32:55 +0000355 "finally:"
356 "elif\\s +.*:")
357 "\\|")
358 "\\)")
359 "Regexp matching clauses to be outdented one level.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000360
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000361(defconst py-no-outdent-re
362 (concat "\\(" (mapconcat 'identity
Barry Warsaw464c94a1995-03-14 23:25:44 +0000363 '("try:"
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000364 "except\\(\\s +.*\\)?:"
365 "while\\s +.*:"
366 "for\\s +.*:"
367 "if\\s +.*:"
368 "elif\\s +.*:")
369 "\\|")
370 "\\)")
371 "Regexp matching lines to not outdent after.")
372
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000373
374;;;###autoload
Barry Warsaw7ae77681994-12-12 20:38:05 +0000375(defun python-mode ()
376 "Major mode for editing Python files.
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000377To submit a problem report, enter `\\[py-submit-bug-report]' from a
378`python-mode' buffer. Do `\\[py-describe-mode]' for detailed
379documentation. To see what version of `python-mode' you are running,
380enter `\\[py-version]'.
381
382This mode knows about Python indentation, tokens, comments and
383continuation lines. Paragraphs are separated by blank lines only.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000384
385COMMANDS
386\\{py-mode-map}
387VARIABLES
388
389py-indent-offset\tindentation increment
390py-block-comment-prefix\tcomment string used by py-comment-region
391py-python-command\tshell command to invoke Python interpreter
392py-scroll-process-buffer\talways scroll Python process buffer
393py-temp-directory\tdirectory used for temp files (if needed)
394py-beep-if-tab-change\tring the bell if tab-width is changed"
395 (interactive)
396 (kill-all-local-variables)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000397 (set-syntax-table py-mode-syntax-table)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000398 (setq major-mode 'python-mode
399 mode-name "Python"
400 local-abbrev-table python-mode-abbrev-table)
401 (use-local-map py-mode-map)
402 ;; BAW -- style...
Barry Warsaw7ae77681994-12-12 20:38:05 +0000403 (mapcar (function (lambda (x)
404 (make-local-variable (car x))
405 (set (car x) (cdr x))))
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000406 '((paragraph-separate . "^[ \t]*$")
407 (paragraph-start . "^[ \t]*$")
408 (require-final-newline . t)
409 (comment-start . "# ")
410 (comment-start-skip . "# *")
411 (comment-column . 40)
412 (indent-region-function . py-indent-region)
413 (indent-line-function . py-indent-line)))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000414 ;; hack to allow overriding the tabsize in the file (see tokenizer.c)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000415 ;;
416 ;; not sure where the magic comment has to be; to save time
417 ;; searching for a rarity, we give up if it's not found prior to the
418 ;; first executable statement.
419 ;;
420 ;; BAW - on first glance, this seems like complete hackery. Why was
421 ;; this necessary, and is it still necessary?
422 (let ((case-fold-search nil)
423 (start (point))
424 new-tab-width)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000425 (if (re-search-forward
426 "^[ \t]*#[ \t]*vi:set[ \t]+tabsize=\\([0-9]+\\):"
427 (prog2 (py-next-statement 1) (point) (goto-char 1))
428 t)
429 (progn
430 (setq new-tab-width
431 (string-to-int
432 (buffer-substring (match-beginning 1) (match-end 1))))
433 (if (= tab-width new-tab-width)
434 nil
435 (setq tab-width new-tab-width)
436 (message "Caution: tab-width changed to %d" new-tab-width)
437 (if py-beep-if-tab-change (beep)))))
438 (goto-char start))
439
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000440 ;; run the mode hook. py-mode-hook use is deprecated
Barry Warsaw7ae77681994-12-12 20:38:05 +0000441 (if python-mode-hook
442 (run-hooks 'python-mode-hook)
443 (run-hooks 'py-mode-hook)))
444
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000445
Barry Warsawb91b7431995-03-14 15:55:20 +0000446;; electric characters
Barry Warsaw3874a3d1995-03-14 22:05:53 +0000447(defun py-outdent-p ()
448 ;; returns non-nil if the current line should outdent one level
449 (save-excursion
450 (and (progn (back-to-indentation)
451 (looking-at py-outdent-re))
452 (progn (backward-to-indentation 1)
453 (while (or (looking-at py-blank-or-comment-re)
454 (bobp))
455 (backward-to-indentation 1))
456 (not (looking-at py-no-outdent-re)))
457 )))
458
459
Barry Warsawb91b7431995-03-14 15:55:20 +0000460(defun py-electric-colon (arg)
461 "Insert a colon.
462In certain cases the line is outdented appropriately. If a numeric
463argument is provided, that many colons are inserted non-electrically."
464 (interactive "P")
465 (self-insert-command (prefix-numeric-value arg))
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000466 (save-excursion
467 (let ((here (point))
468 (outdent 0)
469 (indent (py-compute-indentation)))
470 (if (and (not arg)
Barry Warsaw3874a3d1995-03-14 22:05:53 +0000471 (py-outdent-p)
Barry Warsaw3aca2a11995-03-20 18:32:14 +0000472 (= indent (save-excursion
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000473 (forward-line -1)
474 (py-compute-indentation)))
475 )
476 (setq outdent py-indent-offset))
Barry Warsawd865bc51995-03-15 18:23:16 +0000477 ;; Don't indent, only outdent. This assumes that any lines that
478 ;; are already outdented relative to py-compute-indentation were
479 ;; put there on purpose. Its highly annoying to have `:' indent
480 ;; for you. Use TAB, C-c C-l or C-c C-r to adjust. TBD: Is
481 ;; there a better way to determine this???
Barry Warsawa6a714e1995-03-15 18:19:15 +0000482 (if (< (current-indentation) indent) nil
Barry Warsaw9b623b31995-03-14 23:59:07 +0000483 (goto-char here)
484 (beginning-of-line)
485 (delete-horizontal-space)
486 (indent-to (- indent outdent))
487 ))))
Barry Warsawb91b7431995-03-14 15:55:20 +0000488
Barry Warsaw1a6c82f1995-03-15 16:23:59 +0000489(defun py-indent-right (arg)
490 "Indent the line by one `py-indent-offset' level.
491With numeric arg, indent by that many levels. You cannot indent
492farther right than the distance the line would be indented by
493\\[py-indent-line]."
494 (interactive "p")
495 (let ((col (current-indentation))
496 (want (* arg py-indent-offset))
497 (indent (py-compute-indentation))
498 (pos (- (point-max) (point)))
499 (bol (save-excursion (beginning-of-line) (point))))
500 (if (<= (+ col want) indent)
501 (progn
502 (beginning-of-line)
503 (delete-horizontal-space)
504 (indent-to (+ col want))
505 (if (> (- (point-max) pos) (point))
506 (goto-char (- (point-max) pos)))
507 ))))
508
509(defun py-outdent-left (arg)
510 "Outdent the line by one `py-indent-offset' level.
511With numeric arg, outdent by that many levels. You cannot outdent
512farther left than column zero."
513 (interactive "p")
514 (let ((col (current-indentation))
515 (want (* arg py-indent-offset))
516 (pos (- (point-max) (point)))
517 (bol (save-excursion (beginning-of-line) (point))))
518 (if (<= 0 (- col want))
519 (progn
520 (beginning-of-line)
521 (delete-horizontal-space)
522 (indent-to (- col want))
523 (if (> (- (point-max) pos) (point))
524 (goto-char (- (point-max) pos)))
525 ))))
526
Barry Warsawb91b7431995-03-14 15:55:20 +0000527
Barry Warsaw7ae77681994-12-12 20:38:05 +0000528;;; Functions that execute Python commands in a subprocess
Barry Warsaw7ae77681994-12-12 20:38:05 +0000529(defun py-shell ()
530 "Start an interactive Python interpreter in another window.
531This is like Shell mode, except that Python is running in the window
532instead of a shell. See the `Interactive Shell' and `Shell Mode'
533sections of the Emacs manual for details, especially for the key
534bindings active in the `*Python*' buffer.
535
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000536See the docs for variable `py-scroll-buffer' for info on scrolling
Barry Warsaw7ae77681994-12-12 20:38:05 +0000537behavior in the process window.
538
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000539Warning: Don't use an interactive Python if you change sys.ps1 or
540sys.ps2 from their default values, or if you're running code that
541prints `>>> ' or `... ' at the start of a line. `python-mode' can't
542distinguish your output from Python's output, and assumes that `>>> '
543at the start of a line is a prompt from Python. Similarly, the Emacs
544Shell mode code assumes that both `>>> ' and `... ' at the start of a
545line are Python prompts. Bad things can happen if you fool either
546mode.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000547
548Warning: If you do any editing *in* the process buffer *while* the
549buffer is accepting output from Python, do NOT attempt to `undo' the
550changes. Some of the output (nowhere near the parts you changed!) may
551be lost if you do. This appears to be an Emacs bug, an unfortunate
552interaction between undo and process filters; the same problem exists in
553non-Python process buffers using the default (Emacs-supplied) process
554filter."
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000555 ;; BAW - should undo be disabled in the python process buffer, if
556 ;; this bug still exists?
Barry Warsaw7ae77681994-12-12 20:38:05 +0000557 (interactive)
558 (if py-this-is-emacs-19-p
559 (progn
560 (require 'comint)
561 (switch-to-buffer-other-window
562 (make-comint "Python" py-python-command)))
563 (progn
564 (require 'shell)
565 (switch-to-buffer-other-window
Barry Warsaw6e98f331995-07-05 22:06:50 +0000566 (apply (if (boundp 'make-shell) 'make-shell 'make-comint)
567 "Python" py-python-command nil))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000568 (make-local-variable 'shell-prompt-pattern)
569 (setq shell-prompt-pattern "^>>> \\|^\\.\\.\\. ")
570 (set-process-filter (get-buffer-process (current-buffer))
571 'py-process-filter)
572 (set-syntax-table py-mode-syntax-table))
573
574(defun py-execute-region (start end)
575 "Send the region between START and END to a Python interpreter.
576If there is a *Python* process it is used.
577
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000578Hint: If you want to execute part of a Python file several times
579\(e.g., perhaps you're developing a function and want to flesh it out
580a bit at a time), use `\\[narrow-to-region]' to restrict the buffer to
581the region of interest, and send the code to a *Python* process via
582`\\[py-execute-buffer]' instead.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000583
584Following are subtleties to note when using a *Python* process:
585
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000586If a *Python* process is used, the region is copied into a temporary
587file (in directory `py-temp-directory'), and an `execfile' command is
588sent to Python naming that file. If you send regions faster than
589Python can execute them, `python-mode' will save them into distinct
590temp files, and execute the next one in the queue the next time it
591sees a `>>> ' prompt from Python. Each time this happens, the process
592buffer is popped into a window (if it's not already in some window) so
593you can see it, and a comment of the form
Barry Warsaw7ae77681994-12-12 20:38:05 +0000594
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000595 \t## working on region in file <name> ...
Barry Warsaw7ae77681994-12-12 20:38:05 +0000596
597is inserted at the end.
598
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000599Caution: No more than 26 regions can be pending at any given time.
600This limit is (indirectly) inherited from libc's mktemp(3).
601`python-mode' does not try to protect you from exceeding the limit.
602It's extremely unlikely that you'll get anywhere close to the limit in
603practice, unless you're trying to be a jerk <grin>.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000604
605See the `\\[py-shell]' docs for additional warnings."
606 (interactive "r")
607 (or (< start end) (error "Region is empty"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000608 (let ((pyproc (get-process "Python"))
609 fname)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000610 (if (null pyproc)
611 (shell-command-on-region start end py-python-command)
612 ;; else feed it thru a temp file
613 (setq fname (py-make-temp-name))
614 (write-region start end fname nil 'no-msg)
615 (setq py-file-queue (append py-file-queue (list fname)))
616 (if (cdr py-file-queue)
617 (message "File %s queued for execution" fname)
618 ;; else
619 (py-execute-file pyproc fname)))))
620
621(defun py-execute-file (pyproc fname)
622 (py-append-to-process-buffer
623 pyproc
624 (format "## working on region in file %s ...\n" fname))
625 (process-send-string pyproc (format "execfile('%s')\n" fname)))
626
627(defun py-process-filter (pyproc string)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000628 (let ((curbuf (current-buffer))
629 (pbuf (process-buffer pyproc))
630 (pmark (process-mark pyproc))
631 file-finished)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000632
633 ;; make sure we switch to a different buffer at least once. if we
634 ;; *don't* do this, then if the process buffer is in the selected
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000635 ;; window, and point is before the end, and lots of output is
636 ;; coming at a fast pace, then (a) simple cursor-movement commands
637 ;; like C-p, C-n, C-f, C-b, C-a, C-e take an incredibly long time
638 ;; to have a visible effect (the window just doesn't get updated,
639 ;; sometimes for minutes(!)), and (b) it takes about 5x longer to
640 ;; get all the process output (until the next python prompt).
Barry Warsaw7ae77681994-12-12 20:38:05 +0000641 ;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000642 ;; #b makes no sense to me at all. #a almost makes sense: unless
643 ;; we actually change buffers, set_buffer_internal in buffer.c
644 ;; doesn't set windows_or_buffers_changed to 1, & that in turn
645 ;; seems to make the Emacs command loop reluctant to update the
646 ;; display. Perhaps the default process filter in process.c's
647 ;; read_process_output has update_mode_lines++ for a similar
648 ;; reason? beats me ...
649
650 ;; BAW - we want to check to see if this still applies
Barry Warsaw7ae77681994-12-12 20:38:05 +0000651 (if (eq curbuf pbuf) ; mysterious ugly hack
652 (set-buffer (get-buffer-create "*scratch*")))
653
654 (set-buffer pbuf)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000655 (let* ((start (point))
656 (goback (< start pmark))
657 (buffer-read-only nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000658 (goto-char pmark)
659 (insert string)
660 (move-marker pmark (point))
661 (setq file-finished
662 (and py-file-queue
663 (equal ">>> "
664 (buffer-substring
665 (prog2 (beginning-of-line) (point)
666 (goto-char pmark))
667 (point)))))
668 (if goback (goto-char start)
669 ;; else
670 (if py-scroll-process-buffer
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000671 (let* ((pop-up-windows t)
672 (pwin (display-buffer pbuf)))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000673 (set-window-point pwin (point))))))
674 (set-buffer curbuf)
675 (if file-finished
676 (progn
677 (py-delete-file-silently (car py-file-queue))
678 (setq py-file-queue (cdr py-file-queue))
679 (if py-file-queue
680 (py-execute-file pyproc (car py-file-queue)))))))
681
682(defun py-execute-buffer ()
683 "Send the contents of the buffer to a Python interpreter.
684If there is a *Python* process buffer it is used. If a clipping
685restriction is in effect, only the accessible portion of the buffer is
686sent. A trailing newline will be supplied if needed.
687
688See the `\\[py-execute-region]' docs for an account of some subtleties."
689 (interactive)
690 (py-execute-region (point-min) (point-max)))
691
692
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000693
694;; Functions for Python style indentation
Barry Warsaw7ae77681994-12-12 20:38:05 +0000695(defun py-delete-char ()
696 "Reduce indentation or delete character.
697If point is at the leftmost column, deletes the preceding newline.
698
699Else if point is at the leftmost non-blank character of a line that is
700neither a continuation line nor a non-indenting comment line, or if
701point is at the end of a blank line, reduces the indentation to match
702that of the line that opened the current block of code. The line that
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000703opened the block is displayed in the echo area to help you keep track
704of where you are.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000705
706Else the preceding character is deleted, converting a tab to spaces if
707needed so that only a single column position is deleted."
708 (interactive "*")
709 (if (or (/= (current-indentation) (current-column))
710 (bolp)
711 (py-continuation-line-p)
712 (looking-at "#[^ \t\n]")) ; non-indenting #
713 (backward-delete-char-untabify 1)
714 ;; else indent the same as the colon line that opened the block
715
716 ;; force non-blank so py-goto-block-up doesn't ignore it
717 (insert-char ?* 1)
718 (backward-char)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000719 (let ((base-indent 0) ; indentation of base line
720 (base-text "") ; and text of base line
721 (base-found-p nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000722 (condition-case nil ; in case no enclosing block
723 (save-excursion
724 (py-goto-block-up 'no-mark)
725 (setq base-indent (current-indentation)
726 base-text (py-suck-up-leading-text)
727 base-found-p t))
728 (error nil))
729 (delete-char 1) ; toss the dummy character
730 (delete-horizontal-space)
731 (indent-to base-indent)
732 (if base-found-p
733 (message "Closes block: %s" base-text)))))
734
Barry Warsawfc8a01f1995-03-09 16:07:29 +0000735;; required for pending-del and delsel modes
736(put 'py-delete-char 'delete-selection 'supersede)
737(put 'py-delete-char 'pending-delete 'supersede)
738
Barry Warsaw7ae77681994-12-12 20:38:05 +0000739(defun py-indent-line ()
740 "Fix the indentation of the current line according to Python rules."
741 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000742 (let* ((ci (current-indentation))
743 (move-to-indentation-p (<= (current-column) ci))
Barry Warsawb86bbad1995-03-14 15:56:35 +0000744 (need (py-compute-indentation)))
Barry Warsaw4f009fb1995-03-14 20:53:08 +0000745 ;; see if we need to outdent
Barry Warsaw3874a3d1995-03-14 22:05:53 +0000746 (if (py-outdent-p)
Barry Warsaw0012c1e1995-03-14 16:32:55 +0000747 (setq need (- need py-indent-offset)))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000748 (if (/= ci need)
749 (save-excursion
750 (beginning-of-line)
751 (delete-horizontal-space)
752 (indent-to need)))
753 (if move-to-indentation-p (back-to-indentation))))
754
755(defun py-newline-and-indent ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000756 "Strives to act like the Emacs `newline-and-indent'.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000757This is just `strives to' because correct indentation can't be computed
758from scratch for Python code. In general, deletes the whitespace before
759point, inserts a newline, and takes an educated guess as to how you want
760the new line indented."
761 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000762 (let ((ci (current-indentation)))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000763 (if (< ci (current-column)) ; if point beyond indentation
764 (newline-and-indent)
765 ;; else try to act like newline-and-indent "normally" acts
766 (beginning-of-line)
767 (insert-char ?\n 1)
768 (move-to-column ci))))
769
770(defun py-compute-indentation ()
771 (save-excursion
772 (beginning-of-line)
773 (cond
774 ;; are we on a continuation line?
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000775 ((py-continuation-line-p)
776 (let ((startpos (point))
777 (open-bracket-pos (py-nesting-level))
778 endpos searching found)
779 (if open-bracket-pos
780 (progn
781 ;; align with first item in list; else a normal
782 ;; indent beyond the line with the open bracket
783 (goto-char (1+ open-bracket-pos)) ; just beyond bracket
784 ;; is the first list item on the same line?
785 (skip-chars-forward " \t")
786 (if (null (memq (following-char) '(?\n ?# ?\\)))
787 ; yes, so line up with it
788 (current-column)
789 ;; first list item on another line, or doesn't exist yet
790 (forward-line 1)
791 (while (and (< (point) startpos)
792 (looking-at "[ \t]*[#\n\\\\]")) ; skip noise
793 (forward-line 1))
794 (if (< (point) startpos)
795 ;; again mimic the first list item
796 (current-indentation)
797 ;; else they're about to enter the first item
798 (goto-char open-bracket-pos)
799 (+ (current-indentation) py-indent-offset))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000800
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000801 ;; else on backslash continuation line
802 (forward-line -1)
803 (if (py-continuation-line-p) ; on at least 3rd line in block
804 (current-indentation) ; so just continue the pattern
805 ;; else started on 2nd line in block, so indent more.
806 ;; if base line is an assignment with a start on a RHS,
807 ;; indent to 2 beyond the leftmost "="; else skip first
808 ;; chunk of non-whitespace characters on base line, + 1 more
809 ;; column
810 (end-of-line)
811 (setq endpos (point) searching t)
812 (back-to-indentation)
813 (setq startpos (point))
814 ;; look at all "=" from left to right, stopping at first
815 ;; one not nested in a list or string
816 (while searching
817 (skip-chars-forward "^=" endpos)
818 (if (= (point) endpos)
819 (setq searching nil)
820 (forward-char 1)
821 (setq state (parse-partial-sexp startpos (point)))
822 (if (and (zerop (car state)) ; not in a bracket
823 (null (nth 3 state))) ; & not in a string
824 (progn
825 (setq searching nil) ; done searching in any case
826 (setq found
827 (not (or
828 (eq (following-char) ?=)
829 (memq (char-after (- (point) 2))
830 '(?< ?> ?!)))))))))
831 (if (or (not found) ; not an assignment
832 (looking-at "[ \t]*\\\\")) ; <=><spaces><backslash>
833 (progn
834 (goto-char startpos)
835 (skip-chars-forward "^ \t\n")))
836 (1+ (current-column))))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000837
838 ;; not on a continuation line
839
840 ;; if at start of restriction, or on a non-indenting comment line,
841 ;; assume they intended whatever's there
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000842 ((or (bobp) (looking-at "[ \t]*#[^ \t\n]"))
843 (current-indentation))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000844
845 ;; else indentation based on that of the statement that precedes
846 ;; us; use the first line of that statement to establish the base,
847 ;; in case the user forced a non-std indentation for the
848 ;; continuation lines (if any)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000849 (t
850 ;; skip back over blank & non-indenting comment lines
851 ;; note: will skip a blank or non-indenting comment line that
852 ;; happens to be a continuation line too
853 (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#[ \t\n]\\)"
854 nil 'move)
855 ;; if we landed inside a string, go to the beginning of that
856 ;; string. this handles triple quoted, multi-line spanning
857 ;; strings.
858 (let ((state (parse-partial-sexp
859 (save-excursion (beginning-of-python-def-or-class)
860 (point))
861 (point))))
862 (if (nth 3 state)
863 (goto-char (nth 2 state))))
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
941many columns."
942 (interactive "*r\nP") ; region; raw prefix arg
943 (py-shift-region start end
944 (- (prefix-numeric-value
945 (or count py-indent-offset)))))
946
947(defun py-shift-region-right (start end &optional count)
948 "Shift region of Python code to the right.
949The lines from the line containing the start of the current region up
950to (but not including) the line containing the end of the region are
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000951shifted to the right, by `py-indent-offset' columns.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000952
953If a prefix argument is given, the region is instead shifted by that
954many columns."
955 (interactive "*r\nP") ; region; raw prefix arg
956 (py-shift-region start end (prefix-numeric-value
957 (or count py-indent-offset))))
958
959(defun py-indent-region (start end &optional indent-offset)
960 "Reindent a region of Python code.
961The lines from the line containing the start of the current region up
962to (but not including) the line containing the end of the region are
963reindented. If the first line of the region has a non-whitespace
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000964character in the first column, the first line is left alone and the
965rest of the region is reindented with respect to it. Else the entire
966region is reindented with respect to the (closest code or
967indenting-comment) statement immediately preceding the region.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000968
969This is useful when code blocks are moved or yanked, when enclosing
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000970control structures are introduced or removed, or to reformat code
971using a new value for the indentation offset.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000972
973If a numeric prefix argument is given, it will be used as the value of
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000974the indentation offset. Else the value of `py-indent-offset' will be
Barry Warsaw7ae77681994-12-12 20:38:05 +0000975used.
976
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000977Warning: The region must be consistently indented before this function
Barry Warsaw7ae77681994-12-12 20:38:05 +0000978is called! This function does not compute proper indentation from
979scratch (that's impossible in Python), it merely adjusts the existing
980indentation to be correct in context.
981
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000982Warning: This function really has no idea what to do with
983non-indenting comment lines, and shifts them as if they were indenting
984comment lines. Fixing this appears to require telepathy.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000985
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000986Special cases: whitespace is deleted from blank lines; continuation
987lines are shifted by the same amount their initial line was shifted,
988in order to preserve their relative indentation with respect to their
Barry Warsaw7ae77681994-12-12 20:38:05 +0000989initial line; and comment lines beginning in column 1 are ignored."
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000990 (interactive "*r\nP") ; region; raw prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +0000991 (save-excursion
992 (goto-char end) (beginning-of-line) (setq end (point-marker))
993 (goto-char start) (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000994 (let ((py-indent-offset (prefix-numeric-value
995 (or indent-offset py-indent-offset)))
996 (indents '(-1)) ; stack of active indent levels
997 (target-column 0) ; column to which to indent
998 (base-shifted-by 0) ; amount last base line was shifted
999 (indent-base (if (looking-at "[ \t\n]")
1000 (py-compute-indentation)
1001 0))
1002 ci)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001003 (while (< (point) end)
1004 (setq ci (current-indentation))
1005 ;; figure out appropriate target column
1006 (cond
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001007 ((or (eq (following-char) ?#) ; comment in column 1
1008 (looking-at "[ \t]*$")) ; entirely blank
1009 (setq target-column 0))
1010 ((py-continuation-line-p) ; shift relative to base line
1011 (setq target-column (+ ci base-shifted-by)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001012 (t ; new base line
1013 (if (> ci (car indents)) ; going deeper; push it
1014 (setq indents (cons ci indents))
1015 ;; else we should have seen this indent before
1016 (setq indents (memq ci indents)) ; pop deeper indents
1017 (if (null indents)
1018 (error "Bad indentation in region, at line %d"
1019 (save-restriction
1020 (widen)
1021 (1+ (count-lines 1 (point)))))))
1022 (setq target-column (+ indent-base
1023 (* py-indent-offset
1024 (- (length indents) 2))))
1025 (setq base-shifted-by (- target-column ci))))
1026 ;; shift as needed
1027 (if (/= ci target-column)
1028 (progn
1029 (delete-horizontal-space)
1030 (indent-to target-column)))
1031 (forward-line 1))))
1032 (set-marker end nil))
1033
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001034
1035;; Functions for moving point
Barry Warsaw7ae77681994-12-12 20:38:05 +00001036(defun py-previous-statement (count)
1037 "Go to the start of previous Python statement.
1038If the statement at point is the i'th Python statement, goes to the
1039start of statement i-COUNT. If there is no such statement, goes to the
1040first statement. Returns count of statements left to move.
1041`Statements' do not include blank, comment, or continuation lines."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001042 (interactive "p") ; numeric prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00001043 (if (< count 0) (py-next-statement (- count))
1044 (py-goto-initial-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001045 (let (start)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001046 (while (and
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001047 (setq start (point)) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00001048 (> count 0)
1049 (zerop (forward-line -1))
1050 (py-goto-statement-at-or-above))
1051 (setq count (1- count)))
1052 (if (> count 0) (goto-char start)))
1053 count))
1054
1055(defun py-next-statement (count)
1056 "Go to the start of next Python statement.
1057If the statement at point is the i'th Python statement, goes to the
1058start of statement i+COUNT. If there is no such statement, goes to the
1059last statement. Returns count of statements left to move. `Statements'
1060do not include blank, comment, or continuation lines."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001061 (interactive "p") ; numeric prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00001062 (if (< count 0) (py-previous-statement (- count))
1063 (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001064 (let (start)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001065 (while (and
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001066 (setq start (point)) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00001067 (> count 0)
1068 (py-goto-statement-below))
1069 (setq count (1- count)))
1070 (if (> count 0) (goto-char start)))
1071 count))
1072
1073(defun py-goto-block-up (&optional nomark)
1074 "Move up to start of current block.
1075Go to the statement that starts the smallest enclosing block; roughly
1076speaking, this will be the closest preceding statement that ends with a
1077colon and is indented less than the statement you started on. If
1078successful, also sets the mark to the starting point.
1079
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001080`\\[py-mark-block]' can be used afterward to mark the whole code
1081block, if desired.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001082
1083If called from a program, the mark will not be set if optional argument
1084NOMARK is not nil."
1085 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001086 (let ((start (point))
1087 (found nil)
1088 initial-indent)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001089 (py-goto-initial-line)
1090 ;; if on blank or non-indenting comment line, use the preceding stmt
1091 (if (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)")
1092 (progn
1093 (py-goto-statement-at-or-above)
1094 (setq found (py-statement-opens-block-p))))
1095 ;; search back for colon line indented less
1096 (setq initial-indent (current-indentation))
1097 (if (zerop initial-indent)
1098 ;; force fast exit
1099 (goto-char (point-min)))
1100 (while (not (or found (bobp)))
1101 (setq found
1102 (and
1103 (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
1104 (or (py-goto-initial-line) t) ; always true -- side effect
1105 (< (current-indentation) initial-indent)
1106 (py-statement-opens-block-p))))
1107 (if found
1108 (progn
1109 (or nomark (push-mark start))
1110 (back-to-indentation))
1111 (goto-char start)
1112 (error "Enclosing block not found"))))
1113
1114(defun beginning-of-python-def-or-class (&optional class)
1115 "Move point to start of def (or class, with prefix arg).
1116
1117Searches back for the closest preceding `def'. If you supply a prefix
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001118arg, looks for a `class' instead. The docs assume the `def' case;
1119just substitute `class' for `def' for the other case.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001120
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001121If point is in a def statement already, and after the `d', simply
1122moves point to the start of the statement.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001123
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001124Else (point is not in a def statement, or at or before the `d' of a
1125def statement), searches for the closest preceding def statement, and
1126leaves point at its start. If no such statement can be found, leaves
1127point at the start of the buffer.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001128
1129Returns t iff a def statement is found by these rules.
1130
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001131Note that doing this command repeatedly will take you closer to the
1132start of the buffer each time.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001133
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001134If you want to mark the current def/class, see
1135`\\[mark-python-def-or-class]'."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001136 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001137 (let ((at-or-before-p (<= (current-column) (current-indentation)))
1138 (start-of-line (progn (beginning-of-line) (point)))
1139 (start-of-stmt (progn (py-goto-initial-line) (point))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001140 (if (or (/= start-of-stmt start-of-line)
1141 (not at-or-before-p))
1142 (end-of-line)) ; OK to match on this line
1143 (re-search-backward (if class "^[ \t]*class\\>" "^[ \t]*def\\>")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001144 nil 'move)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001145
1146(defun end-of-python-def-or-class (&optional class)
1147 "Move point beyond end of def (or class, with prefix arg) body.
1148
1149By default, looks for an appropriate `def'. If you supply a prefix arg,
1150looks for a `class' instead. The docs assume the `def' case; just
1151substitute `class' for `def' for the other case.
1152
1153If point is in a def statement already, this is the def we use.
1154
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001155Else if the def found by `\\[beginning-of-python-def-or-class]'
1156contains the statement you started on, that's the def we use.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001157
1158Else we search forward for the closest following def, and use that.
1159
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001160If a def can be found by these rules, point is moved to the start of
1161the line immediately following the def block, and the position of the
1162start of the def is returned.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001163
1164Else point is moved to the end of the buffer, and nil is returned.
1165
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001166Note that doing this command repeatedly will take you closer to the
1167end of the buffer each time.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001168
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001169If you want to mark the current def/class, see
1170`\\[mark-python-def-or-class]'."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001171 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001172 (let ((start (progn (py-goto-initial-line) (point)))
1173 (which (if class "class" "def"))
1174 (state 'not-found))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001175 ;; move point to start of appropriate def/class
1176 (if (looking-at (concat "[ \t]*" which "\\>")) ; already on one
1177 (setq state 'at-beginning)
1178 ;; else see if beginning-of-python-def-or-class hits container
1179 (if (and (beginning-of-python-def-or-class class)
1180 (progn (py-goto-beyond-block)
1181 (> (point) start)))
1182 (setq state 'at-end)
1183 ;; else search forward
1184 (goto-char start)
1185 (if (re-search-forward (concat "^[ \t]*" which "\\>") nil 'move)
1186 (progn (setq state 'at-beginning)
1187 (beginning-of-line)))))
1188 (cond
1189 ((eq state 'at-beginning) (py-goto-beyond-block) t)
1190 ((eq state 'at-end) t)
1191 ((eq state 'not-found) nil)
1192 (t (error "internal error in end-of-python-def-or-class")))))
1193
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001194
1195;; Functions for marking regions
Barry Warsaw7ae77681994-12-12 20:38:05 +00001196(defun py-mark-block (&optional extend just-move)
1197 "Mark following block of lines. With prefix arg, mark structure.
1198Easier to use than explain. It sets the region to an `interesting'
1199block of succeeding lines. If point is on a blank line, it goes down to
1200the next non-blank line. That will be the start of the region. The end
1201of the region depends on the kind of line at the start:
1202
1203 - If a comment, the region will include all succeeding comment lines up
1204 to (but not including) the next non-comment line (if any).
1205
1206 - Else if a prefix arg is given, and the line begins one of these
1207 structures:
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001208
1209 if elif else try except finally for while def class
1210
Barry Warsaw7ae77681994-12-12 20:38:05 +00001211 the region will be set to the body of the structure, including
1212 following blocks that `belong' to it, but excluding trailing blank
1213 and comment lines. E.g., if on a `try' statement, the `try' block
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001214 and all (if any) of the following `except' and `finally' blocks
1215 that belong to the `try' structure will be in the region. Ditto
1216 for if/elif/else, for/else and while/else structures, and (a bit
1217 degenerate, since they're always one-block structures) def and
1218 class blocks.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001219
1220 - Else if no prefix argument is given, and the line begins a Python
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001221 block (see list above), and the block is not a `one-liner' (i.e.,
1222 the statement ends with a colon, not with code), the region will
1223 include all succeeding lines up to (but not including) the next
1224 code statement (if any) that's indented no more than the starting
1225 line, except that trailing blank and comment lines are excluded.
1226 E.g., if the starting line begins a multi-statement `def'
1227 structure, the region will be set to the full function definition,
1228 but without any trailing `noise' lines.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001229
1230 - Else the region will include all succeeding lines up to (but not
1231 including) the next blank line, or code or indenting-comment line
1232 indented strictly less than the starting line. Trailing indenting
1233 comment lines are included in this case, but not trailing blank
1234 lines.
1235
1236A msg identifying the location of the mark is displayed in the echo
1237area; or do `\\[exchange-point-and-mark]' to flip down to the end.
1238
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001239If called from a program, optional argument EXTEND plays the role of
1240the prefix arg, and if optional argument JUST-MOVE is not nil, just
1241moves to the end of the block (& does not set mark or display a msg)."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001242 (interactive "P") ; raw prefix arg
1243 (py-goto-initial-line)
1244 ;; skip over blank lines
1245 (while (and
1246 (looking-at "[ \t]*$") ; while blank line
1247 (not (eobp))) ; & somewhere to go
1248 (forward-line 1))
1249 (if (eobp)
1250 (error "Hit end of buffer without finding a non-blank stmt"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001251 (let ((initial-pos (point))
1252 (initial-indent (current-indentation))
1253 last-pos ; position of last stmt in region
1254 (followers
1255 '((if elif else) (elif elif else) (else)
1256 (try except finally) (except except) (finally)
1257 (for else) (while else)
1258 (def) (class) ) )
1259 first-symbol next-symbol)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001260
1261 (cond
1262 ;; if comment line, suck up the following comment lines
1263 ((looking-at "[ \t]*#")
1264 (re-search-forward "^[ \t]*[^ \t#]" nil 'move) ; look for non-comment
1265 (re-search-backward "^[ \t]*#") ; and back to last comment in block
1266 (setq last-pos (point)))
1267
1268 ;; else if line is a block line and EXTEND given, suck up
1269 ;; the whole structure
1270 ((and extend
1271 (setq first-symbol (py-suck-up-first-keyword) )
1272 (assq first-symbol followers))
1273 (while (and
1274 (or (py-goto-beyond-block) t) ; side effect
1275 (forward-line -1) ; side effect
1276 (setq last-pos (point)) ; side effect
1277 (py-goto-statement-below)
1278 (= (current-indentation) initial-indent)
1279 (setq next-symbol (py-suck-up-first-keyword))
1280 (memq next-symbol (cdr (assq first-symbol followers))))
1281 (setq first-symbol next-symbol)))
1282
1283 ;; else if line *opens* a block, search for next stmt indented <=
1284 ((py-statement-opens-block-p)
1285 (while (and
1286 (setq last-pos (point)) ; always true -- side effect
1287 (py-goto-statement-below)
1288 (> (current-indentation) initial-indent))
1289 nil))
1290
1291 ;; else plain code line; stop at next blank line, or stmt or
1292 ;; indenting comment line indented <
1293 (t
1294 (while (and
1295 (setq last-pos (point)) ; always true -- side effect
1296 (or (py-goto-beyond-final-line) t)
1297 (not (looking-at "[ \t]*$")) ; stop at blank line
1298 (or
1299 (>= (current-indentation) initial-indent)
1300 (looking-at "[ \t]*#[^ \t\n]"))) ; ignore non-indenting #
1301 nil)))
1302
1303 ;; skip to end of last stmt
1304 (goto-char last-pos)
1305 (py-goto-beyond-final-line)
1306
1307 ;; set mark & display
1308 (if just-move
1309 () ; just return
1310 (push-mark (point) 'no-msg)
1311 (forward-line -1)
1312 (message "Mark set after: %s" (py-suck-up-leading-text))
1313 (goto-char initial-pos))))
1314
1315(defun mark-python-def-or-class (&optional class)
1316 "Set region to body of def (or class, with prefix arg) enclosing point.
1317Pushes the current mark, then point, on the mark ring (all language
1318modes do this, but although it's handy it's never documented ...).
1319
1320In most Emacs language modes, this function bears at least a
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001321hallucinogenic resemblance to `\\[end-of-python-def-or-class]' and
1322`\\[beginning-of-python-def-or-class]'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001323
1324And in earlier versions of Python mode, all 3 were tightly connected.
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001325Turned out that was more confusing than useful: the `goto start' and
1326`goto end' commands are usually used to search through a file, and
1327people expect them to act a lot like `search backward' and `search
1328forward' string-search commands. But because Python `def' and `class'
1329can nest to arbitrary levels, finding the smallest def containing
1330point cannot be done via a simple backward search: the def containing
1331point may not be the closest preceding def, or even the closest
1332preceding def that's indented less. The fancy algorithm required is
1333appropriate for the usual uses of this `mark' command, but not for the
1334`goto' variations.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001335
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001336So the def marked by this command may not be the one either of the
1337`goto' commands find: If point is on a blank or non-indenting comment
1338line, moves back to start of the closest preceding code statement or
1339indenting comment line. If this is a `def' statement, that's the def
1340we use. Else searches for the smallest enclosing `def' block and uses
1341that. Else signals an error.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001342
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001343When an enclosing def is found: The mark is left immediately beyond
1344the last line of the def block. Point is left at the start of the
1345def, except that: if the def is preceded by a number of comment lines
1346followed by (at most) one optional blank line, point is left at the
1347start of the comments; else if the def is preceded by a blank line,
1348point is left at its start.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001349
1350The intent is to mark the containing def/class and its associated
1351documentation, to make moving and duplicating functions and classes
1352pleasant."
1353 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001354 (let ((start (point))
1355 (which (if class "class" "def")))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001356 (push-mark start)
1357 (if (not (py-go-up-tree-to-keyword which))
1358 (progn (goto-char start)
1359 (error "Enclosing %s not found" which))
1360 ;; else enclosing def/class found
1361 (setq start (point))
1362 (py-goto-beyond-block)
1363 (push-mark (point))
1364 (goto-char start)
1365 (if (zerop (forward-line -1)) ; if there is a preceding line
1366 (progn
1367 (if (looking-at "[ \t]*$") ; it's blank
1368 (setq start (point)) ; so reset start point
1369 (goto-char start)) ; else try again
1370 (if (zerop (forward-line -1))
1371 (if (looking-at "[ \t]*#") ; a comment
1372 ;; look back for non-comment line
1373 ;; tricky: note that the regexp matches a blank
1374 ;; line, cuz \n is in the 2nd character class
1375 (and
1376 (re-search-backward "^[ \t]*[^ \t#]" nil 'move)
1377 (forward-line 1))
1378 ;; no comment, so go back
1379 (goto-char start))))))))
1380
1381(defun py-comment-region (start end &optional uncomment-p)
1382 "Comment out region of code; with prefix arg, uncomment region.
1383The lines from the line containing the start of the current region up
1384to (but not including) the line containing the end of the region are
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001385commented out, by inserting the string `py-block-comment-prefix' at
1386the start of each line. With a prefix arg, removes
1387`py-block-comment-prefix' from the start of each line instead."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001388 (interactive "*r\nP") ; region; raw prefix arg
1389 (goto-char end) (beginning-of-line) (setq end (point))
1390 (goto-char start) (beginning-of-line) (setq start (point))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001391 (let ((prefix-len (length py-block-comment-prefix)) )
Barry Warsaw7ae77681994-12-12 20:38:05 +00001392 (save-excursion
1393 (save-restriction
1394 (narrow-to-region start end)
1395 (while (not (eobp))
1396 (if uncomment-p
1397 (and (string= py-block-comment-prefix
1398 (buffer-substring
1399 (point) (+ (point) prefix-len)))
1400 (delete-char prefix-len))
1401 (insert py-block-comment-prefix))
1402 (forward-line 1))))))
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 Warsaw7b0f5681995-03-08 21:33:04 +00001711 (let ((here (point)) )
Barry Warsaw7ae77681994-12-12 20:38:05 +00001712 ;; back up to the first preceding line (if any; else start of
1713 ;; buffer) that begins with a popular Python keyword, or a non-
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001714 ;; whitespace and non-comment character. These are good places
1715 ;; to start parsing to see whether where we started is at a
1716 ;; non-zero nesting level. It may be slow for people who write
1717 ;; huge code blocks or huge lists ... tough beans.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001718 (re-search-backward py-parse-state-re nil 'move)
1719 (beginning-of-line)
1720 (parse-partial-sexp (point) here))))
1721
1722;; if point is at a non-zero nesting level, returns the number of the
1723;; character that opens the smallest enclosing unclosed list; else
1724;; returns nil.
1725(defun py-nesting-level ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001726 (let ((status (py-parse-state)) )
Barry Warsaw7ae77681994-12-12 20:38:05 +00001727 (if (zerop (car status))
1728 nil ; not in a nest
1729 (car (cdr status))))) ; char# of open bracket
1730
1731;; t iff preceding line ends with backslash that's not in a comment
1732(defun py-backslash-continuation-line-p ()
1733 (save-excursion
1734 (beginning-of-line)
1735 (and
1736 ;; use a cheap test first to avoid the regexp if possible
1737 ;; use 'eq' because char-after may return nil
1738 (eq (char-after (- (point) 2)) ?\\ )
1739 ;; make sure; since eq test passed, there is a preceding line
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001740 (forward-line -1) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00001741 (looking-at py-continued-re))))
1742
1743;; t iff current line is a continuation line
1744(defun py-continuation-line-p ()
1745 (save-excursion
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001746 (beginning-of-line)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001747 (or (py-backslash-continuation-line-p)
1748 (py-nesting-level))))
1749
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001750;; go to initial line of current statement; usually this is the line
1751;; we're on, but if we're on the 2nd or following lines of a
1752;; continuation block, we need to go up to the first line of the
1753;; block.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001754;;
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001755;; Tricky: We want to avoid quadratic-time behavior for long continued
1756;; blocks, whether of the backslash or open-bracket varieties, or a
1757;; mix of the two. The following manages to do that in the usual
1758;; cases.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001759(defun py-goto-initial-line ()
1760 (let ( open-bracket-pos )
1761 (while (py-continuation-line-p)
1762 (beginning-of-line)
1763 (if (py-backslash-continuation-line-p)
1764 (while (py-backslash-continuation-line-p)
1765 (forward-line -1))
1766 ;; else zip out of nested brackets/braces/parens
1767 (while (setq open-bracket-pos (py-nesting-level))
1768 (goto-char open-bracket-pos)))))
1769 (beginning-of-line))
1770
1771;; go to point right beyond final line of current statement; usually
1772;; this is the start of the next line, but if this is a multi-line
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001773;; statement we need to skip over the continuation lines. Tricky:
1774;; Again we need to be clever to avoid quadratic time behavior.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001775(defun py-goto-beyond-final-line ()
1776 (forward-line 1)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001777 (let (state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001778 (while (and (py-continuation-line-p)
1779 (not (eobp)))
1780 ;; skip over the backslash flavor
1781 (while (and (py-backslash-continuation-line-p)
1782 (not (eobp)))
1783 (forward-line 1))
1784 ;; if in nest, zip to the end of the nest
1785 (setq state (py-parse-state))
1786 (if (and (not (zerop (car state)))
1787 (not (eobp)))
1788 (progn
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001789 ;; BUG ALERT: I could swear, from reading the docs, that
Barry Warsaw7ae77681994-12-12 20:38:05 +00001790 ;; the 3rd argument should be plain 0
1791 (parse-partial-sexp (point) (point-max) (- 0 (car state))
1792 nil state)
1793 (forward-line 1))))))
1794
1795;; t iff statement opens a block == iff it ends with a colon that's
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001796;; not in a comment. point should be at the start of a statement
Barry Warsaw7ae77681994-12-12 20:38:05 +00001797(defun py-statement-opens-block-p ()
1798 (save-excursion
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001799 (let ((start (point))
1800 (finish (progn (py-goto-beyond-final-line) (1- (point))))
1801 (searching t)
1802 (answer nil)
1803 state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001804 (goto-char start)
1805 (while searching
1806 ;; look for a colon with nothing after it except whitespace, and
1807 ;; maybe a comment
1808 (if (re-search-forward ":\\([ \t]\\|\\\\\n\\)*\\(#.*\\)?$"
1809 finish t)
1810 (if (eq (point) finish) ; note: no `else' clause; just
1811 ; keep searching if we're not at
1812 ; the end yet
1813 ;; sure looks like it opens a block -- but it might
1814 ;; be in a comment
1815 (progn
1816 (setq searching nil) ; search is done either way
1817 (setq state (parse-partial-sexp start
1818 (match-beginning 0)))
1819 (setq answer (not (nth 4 state)))))
1820 ;; search failed: couldn't find another interesting colon
1821 (setq searching nil)))
1822 answer)))
1823
1824;; go to point right beyond final line of block begun by the current
1825;; line. This is the same as where py-goto-beyond-final-line goes
1826;; unless we're on colon line, in which case we go to the end of the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001827;; block. assumes point is at bolp
Barry Warsaw7ae77681994-12-12 20:38:05 +00001828(defun py-goto-beyond-block ()
1829 (if (py-statement-opens-block-p)
1830 (py-mark-block nil 'just-move)
1831 (py-goto-beyond-final-line)))
1832
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001833;; go to start of first statement (not blank or comment or
1834;; continuation line) at or preceding point. returns t if there is
1835;; one, else nil
Barry Warsaw7ae77681994-12-12 20:38:05 +00001836(defun py-goto-statement-at-or-above ()
1837 (py-goto-initial-line)
1838 (if (looking-at py-blank-or-comment-re)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001839 ;; skip back over blank & comment lines
1840 ;; note: will skip a blank or comment line that happens to be
1841 ;; a continuation line too
1842 (if (re-search-backward "^[ \t]*[^ \t#\n]" nil t)
1843 (progn (py-goto-initial-line) t)
1844 nil)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001845 t))
1846
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001847;; go to start of first statement (not blank or comment or
1848;; continuation line) following the statement containing point returns
1849;; t if there is one, else nil
Barry Warsaw7ae77681994-12-12 20:38:05 +00001850(defun py-goto-statement-below ()
1851 (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001852 (let ((start (point)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001853 (py-goto-beyond-final-line)
1854 (while (and
1855 (looking-at py-blank-or-comment-re)
1856 (not (eobp)))
1857 (forward-line 1))
1858 (if (eobp)
1859 (progn (goto-char start) nil)
1860 t)))
1861
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001862;; go to start of statement, at or preceding point, starting with
1863;; keyword KEY. Skips blank lines and non-indenting comments upward
1864;; first. If that statement starts with KEY, done, else go back to
1865;; first enclosing block starting with KEY. If successful, leaves
1866;; point at the start of the KEY line & returns t. Else leaves point
1867;; at an undefined place & returns nil.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001868(defun py-go-up-tree-to-keyword (key)
1869 ;; skip blanks and non-indenting #
1870 (py-goto-initial-line)
1871 (while (and
1872 (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)")
1873 (zerop (forward-line -1))) ; go back
1874 nil)
1875 (py-goto-initial-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001876 (let* ((re (concat "[ \t]*" key "\\b"))
1877 (case-fold-search nil) ; let* so looking-at sees this
1878 (found (looking-at re))
1879 (dead nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001880 (while (not (or found dead))
1881 (condition-case nil ; in case no enclosing block
1882 (py-goto-block-up 'no-mark)
1883 (error (setq dead t)))
1884 (or dead (setq found (looking-at re))))
1885 (beginning-of-line)
1886 found))
1887
1888;; return string in buffer from start of indentation to end of line;
1889;; prefix "..." if leading whitespace was skipped
1890(defun py-suck-up-leading-text ()
1891 (save-excursion
1892 (back-to-indentation)
1893 (concat
1894 (if (bolp) "" "...")
1895 (buffer-substring (point) (progn (end-of-line) (point))))))
1896
1897;; assuming point at bolp, return first keyword ([a-z]+) on the line,
1898;; as a Lisp symbol; return nil if none
1899(defun py-suck-up-first-keyword ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001900 (let ((case-fold-search nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001901 (if (looking-at "[ \t]*\\([a-z]+\\)\\b")
1902 (intern (buffer-substring (match-beginning 1) (match-end 1)))
1903 nil)))
1904
1905(defun py-make-temp-name ()
1906 (make-temp-name
1907 (concat (file-name-as-directory py-temp-directory) "python")))
1908
1909(defun py-delete-file-silently (fname)
1910 (condition-case nil
1911 (delete-file fname)
1912 (error nil)))
1913
1914(defun py-kill-emacs-hook ()
1915 ;; delete our temp files
1916 (while py-file-queue
1917 (py-delete-file-silently (car py-file-queue))
1918 (setq py-file-queue (cdr py-file-queue)))
1919 (if (not (or py-this-is-lucid-emacs-p py-this-is-emacs-19-p))
1920 ;; run the hook we inherited, if any
1921 (and py-inherited-kill-emacs-hook
1922 (funcall py-inherited-kill-emacs-hook))))
1923
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001924;; make PROCESS's buffer visible, append STRING to it, and force
1925;; display; also make shell-mode believe the user typed this string,
1926;; so that kill-output-from-shell and show-output-from-shell work
1927;; "right"
Barry Warsaw7ae77681994-12-12 20:38:05 +00001928(defun py-append-to-process-buffer (process string)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001929 (let ((cbuf (current-buffer))
1930 (pbuf (process-buffer process))
1931 (py-scroll-process-buffer t))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001932 (set-buffer pbuf)
1933 (goto-char (point-max))
1934 (move-marker (process-mark process) (point))
1935 (if (not py-this-is-emacs-19-p)
1936 (move-marker last-input-start (point))) ; muck w/ shell-mode
1937 (funcall (process-filter process) process string)
1938 (if (not py-this-is-emacs-19-p)
1939 (move-marker last-input-end (point))) ; muck w/ shell-mode
1940 (set-buffer cbuf))
1941 (sit-for 0))
1942
Barry Warsaw74d9cc51995-03-08 22:05:16 +00001943(defun py-keep-region-active ()
1944 ;; do whatever is necessary to keep the region active in XEmacs.
1945 ;; Ignore byte-compiler warnings you might see. Also note that
1946 ;; FSF's Emacs 19 does it differently and doesn't its policy doesn't
1947 ;; require us to take explicit action.
1948 (and (boundp 'zmacs-region-stays)
1949 (setq zmacs-region-stays t)))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001950
1951
Barry Warsaw850437a1995-03-08 21:50:28 +00001952(defconst py-version "$Revision$"
1953 "`python-mode' version number.")
1954(defconst py-help-address "bwarsaw@cnri.reston.va.us"
1955 "Address accepting submission of bug reports.")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001956
Barry Warsaw850437a1995-03-08 21:50:28 +00001957(defun py-version ()
1958 "Echo the current version of `python-mode' in the minibuffer."
1959 (interactive)
1960 (message "Using `python-mode' version %s" py-version)
1961 (py-keep-region-active))
1962
1963;; only works under Emacs 19
1964;(eval-when-compile
1965; (require 'reporter))
1966
1967(defun py-submit-bug-report (enhancement-p)
1968 "Submit via mail a bug report on `python-mode'.
1969With \\[universal-argument] just submit an enhancement request."
1970 (interactive
1971 (list (not (y-or-n-p
1972 "Is this a bug report? (hit `n' to send other comments) "))))
Barry Warsawb5e0ecb1995-03-14 18:32:54 +00001973 (let ((reporter-prompt-for-summary-p (if enhancement-p
1974 "(Very) brief summary: "
1975 t)))
Barry Warsaw850437a1995-03-08 21:50:28 +00001976 (require 'reporter)
1977 (reporter-submit-bug-report
1978 py-help-address ;address
Barry Warsawb5e0ecb1995-03-14 18:32:54 +00001979 (concat "python-mode " py-version) ;pkgname
Barry Warsaw850437a1995-03-08 21:50:28 +00001980 ;; varlist
1981 (if enhancement-p nil
1982 '(py-python-command
1983 py-indent-offset
1984 py-block-comment-prefix
1985 py-scroll-process-buffer
1986 py-temp-directory
1987 py-beep-if-tab-change))
1988 nil ;pre-hooks
1989 nil ;post-hooks
1990 "Dear Barry,") ;salutation
1991 (if enhancement-p nil
1992 (set-mark (point))
1993 (insert
1994"Please replace this text with a sufficiently large code sample\n\
1995and an exact recipe so that I can reproduce your problem. Failure\n\
1996to do so may mean a greater delay in fixing your bug.\n\n")
1997 (exchange-point-and-mark)
1998 (py-keep-region-active))))
1999
2000
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002001;; arrange to kill temp files when Emacs exists
2002(if (or py-this-is-emacs-19-p py-this-is-lucid-emacs-p)
2003 (add-hook 'kill-emacs-hook 'py-kill-emacs-hook)
2004 ;; have to trust that other people are as respectful of our hook
2005 ;; fiddling as we are of theirs
2006 (if (boundp 'py-inherited-kill-emacs-hook)
2007 ;; we were loaded before -- trust others not to have screwed us
2008 ;; in the meantime (no choice, really)
2009 nil
2010 ;; else arrange for our hook to run theirs
2011 (setq py-inherited-kill-emacs-hook kill-emacs-hook)
2012 (setq kill-emacs-hook 'py-kill-emacs-hook)))
2013
2014
2015
2016(provide 'python-mode)
2017;;; python-mode.el ends here