blob: 02784ab1921804c01fc5d949ce3bba8f60aceffe [file] [log] [blame]
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001;;; python-mode.el --- Major mode for editing Python programs
2
3;; Copyright (C) 1992,1993,1994 Tim Peters
4
Barry Warsawb2d5e622002-04-22 15:29:27 +00005;; Author: 1995-2002 Barry A. Warsaw
Barry Warsawfec75d61995-07-05 23:26:15 +00006;; 1992-1994 Tim Peters
Barry Warsawa97a3f31997-11-04 18:47:06 +00007;; Maintainer: python-mode@python.org
8;; Created: Feb 1992
9;; Keywords: python languages oop
Barry Warsaw7b0f5681995-03-08 21:33:04 +000010
Barry Warsaw19b1c612001-07-06 20:27:29 +000011(defconst py-version "$Revision$"
Barry Warsawc72c11c1997-08-09 06:42:08 +000012 "`python-mode' version number.")
13
Barry Warsawcfec3591995-03-10 15:58:16 +000014;; This software is provided as-is, without express or implied
15;; warranty. Permission to use, copy, modify, distribute or sell this
16;; software, without fee, for any purpose and by any individual or
17;; organization, is hereby granted, provided that the above copyright
18;; notice and this paragraph appear in all copies.
Barry Warsaw7b0f5681995-03-08 21:33:04 +000019
20;;; Commentary:
Barry Warsaw755c6711996-08-01 20:02:55 +000021
Barry Warsaw7b0f5681995-03-08 21:33:04 +000022;; This is a major mode for editing Python programs. It was developed
Barry Warsaw261f87d1996-08-20 19:57:34 +000023;; by Tim Peters after an original idea by Michael A. Guravage. Tim
Barry Warsawf7039e21998-08-20 22:10:46 +000024;; subsequently left the net; in 1995, Barry Warsaw inherited the mode
Barry Warsaw38e21e71998-10-27 22:09:25 +000025;; and is the current maintainer. Tim's now back but disavows all
26;; responsibility for the mode. Smart Tim :-)
Barry Warsaw7b0f5681995-03-08 21:33:04 +000027
Barry Warsaw4f577d22001-04-11 20:23:17 +000028;; pdbtrack support contributed by Ken Manheimer, April 2001.
29
Barry Warsawb2d5e622002-04-22 15:29:27 +000030;; Please use the SourceForge Python project to submit bugs or
31;; patches:
Barry Warsaw4f577d22001-04-11 20:23:17 +000032;;
33;; http://sourceforge.net/projects/python
Barry Warsaw37231521997-12-11 17:23:13 +000034
35;; FOR MORE INFORMATION:
36
Barry Warsaw4f577d22001-04-11 20:23:17 +000037;; There is some information on python-mode.el at
38
Barry Warsawf7039e21998-08-20 22:10:46 +000039;; http://www.python.org/emacs/python-mode/
40;;
Barry Warsawb2d5e622002-04-22 15:29:27 +000041;; It does contain links to other packages that you might find useful,
42;; such as pdb interfaces, OO-Browser links, etc.
Barry Warsaw37231521997-12-11 17:23:13 +000043
44;; BUG REPORTING:
Barry Warsaw7ae77681994-12-12 20:38:05 +000045
Barry Warsaw4f577d22001-04-11 20:23:17 +000046;; As mentioned above, please use the SourceForge Python project for
47;; submitting bug reports or patches. The old recommendation, to use
48;; C-c C-b will still work, but those reports have a higher chance of
49;; getting buried in my mailbox. Please include a complete, but
Barry Warsawaffc0ca1997-11-03 16:59:38 +000050;; concise code sample and a recipe for reproducing the bug. Send
51;; suggestions and other comments to python-mode@python.org.
52
53;; When in a Python mode buffer, do a C-h m for more help. It's
Barry Warsaw37231521997-12-11 17:23:13 +000054;; doubtful that a texinfo manual would be very useful, but if you
55;; want to contribute one, I'll certainly accept it!
Barry Warsawb5e0ecb1995-03-14 18:32:54 +000056
Barry Warsaw7b0f5681995-03-08 21:33:04 +000057;;; Code:
58
Barry Warsaw6dfbe5d1998-08-20 21:51:27 +000059(require 'comint)
Barry Warsawc72c11c1997-08-09 06:42:08 +000060(require 'custom)
Barry Warsaw4f577d22001-04-11 20:23:17 +000061(require 'cl)
Barry Warsawc72c11c1997-08-09 06:42:08 +000062
Barry Warsaw7b0f5681995-03-08 21:33:04 +000063
64;; user definable variables
65;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
Barry Warsaw7ae77681994-12-12 20:38:05 +000066
Barry Warsawc72c11c1997-08-09 06:42:08 +000067(defgroup python nil
68 "Support for the Python programming language, <http://www.python.org/>"
Barry Warsaw5ed843f1999-07-28 22:06:06 +000069 :group 'languages
70 :prefix "py-")
Barry Warsaw7ae77681994-12-12 20:38:05 +000071
Barry Warsawc72c11c1997-08-09 06:42:08 +000072(defcustom py-python-command "python"
73 "*Shell command used to start Python interpreter."
74 :type 'string
75 :group 'python)
76
Barry Warsawa2398801998-04-09 23:28:20 +000077(defcustom py-jpython-command "jpython"
78 "*Shell command used to start the JPython interpreter."
79 :type 'string
Barry Warsaw5ed843f1999-07-28 22:06:06 +000080 :group 'python
81 :tag "JPython Command")
Barry Warsawa2398801998-04-09 23:28:20 +000082
Barry Warsawaa384fd1999-02-16 23:36:16 +000083(defcustom py-default-interpreter 'cpython
84 "*Which Python interpreter is used by default.
85The value for this variable can be either `cpython' or `jpython'.
86
87When the value is `cpython', the variables `py-python-command' and
88`py-python-command-args' are consulted to determine the interpreter
89and arguments to use.
90
91When the value is `jpython', the variables `py-jpython-command' and
92`py-jpython-command-args' are consulted to determine the interpreter
93and arguments to use.
94
Barry Warsaw11f21561999-07-28 21:59:43 +000095Note that this variable is consulted only the first time that a Python
96mode buffer is visited during an Emacs session. After that, use
Barry Warsawaa384fd1999-02-16 23:36:16 +000097\\[py-toggle-shells] to change the interpreter shell."
98 :type '(choice (const :tag "Python (a.k.a. CPython)" cpython)
99 (const :tag "JPython" jpython))
100 :group 'python)
101
Barry Warsaw8f972b71998-02-05 20:45:49 +0000102(defcustom py-python-command-args '("-i")
103 "*List of string arguments to be used when starting a Python shell."
104 :type '(repeat string)
105 :group 'python)
106
Barry Warsawa2398801998-04-09 23:28:20 +0000107(defcustom py-jpython-command-args '("-i")
108 "*List of string arguments to be used when starting a JPython shell."
109 :type '(repeat string)
Barry Warsaw5ed843f1999-07-28 22:06:06 +0000110 :group 'python
111 :tag "JPython Command Args")
Barry Warsawa2398801998-04-09 23:28:20 +0000112
Barry Warsawc72c11c1997-08-09 06:42:08 +0000113(defcustom py-indent-offset 4
Barry Warsaw41a05c71998-08-10 16:33:12 +0000114 "*Amount of offset per level of indentation.
115`\\[py-guess-indent-offset]' can usually guess a good value when
116you're editing someone else's Python code."
Barry Warsawc72c11c1997-08-09 06:42:08 +0000117 :type 'integer
118 :group 'python)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000119
Barry Warsawfd4c9e82001-06-18 23:40:35 +0000120(defcustom py-continuation-offset 4
Barry Warsaw40fb4522001-07-06 20:07:13 +0000121 "*Additional amount of offset to give for some continuation lines.
Barry Warsawfd4c9e82001-06-18 23:40:35 +0000122Continuation lines are those that immediately follow a backslash
Barry Warsaw40fb4522001-07-06 20:07:13 +0000123terminated line. Only those continuation lines for a block opening
124statement are given this extra offset."
Barry Warsawfd4c9e82001-06-18 23:40:35 +0000125 :type 'integer
126 :group 'python)
127
Barry Warsaw742a5111998-03-13 17:29:15 +0000128(defcustom py-smart-indentation t
129 "*Should `python-mode' try to automagically set some indentation variables?
130When this variable is non-nil, two things happen when a buffer is set
131to `python-mode':
132
Barry Warsawc0d2d511999-06-03 22:18:59 +0000133 1. `py-indent-offset' is guessed from existing code in the buffer.
Barry Warsaw639eea61998-03-16 18:12:13 +0000134 Only guessed values between 2 and 8 are considered. If a valid
Barry Warsaw742a5111998-03-13 17:29:15 +0000135 guess can't be made (perhaps because you are visiting a new
Barry Warsaw639eea61998-03-16 18:12:13 +0000136 file), then the value in `py-indent-offset' is used.
Barry Warsaw742a5111998-03-13 17:29:15 +0000137
Barry Warsaw639eea61998-03-16 18:12:13 +0000138 2. `indent-tabs-mode' is turned off if `py-indent-offset' does not
139 equal `tab-width' (`indent-tabs-mode' is never turned on by
140 Python mode). This means that for newly written code, tabs are
141 only inserted in indentation if one tab is one indentation
142 level, otherwise only spaces are used.
Barry Warsaw742a5111998-03-13 17:29:15 +0000143
Barry Warsaw8046bef1998-03-13 20:04:52 +0000144Note that both these settings occur *after* `python-mode-hook' is run,
145so if you want to defeat the automagic configuration, you must also
146set `py-smart-indentation' to nil in your `python-mode-hook'."
Barry Warsaw742a5111998-03-13 17:29:15 +0000147 :type 'boolean
148 :group 'python)
149
Barry Warsawc72c11c1997-08-09 06:42:08 +0000150(defcustom py-align-multiline-strings-p t
151 "*Flag describing how multi-line triple quoted strings are aligned.
Barry Warsaw095e9c61995-09-19 20:01:42 +0000152When this flag is non-nil, continuation lines are lined up under the
153preceding line's indentation. When this flag is nil, continuation
Barry Warsawc72c11c1997-08-09 06:42:08 +0000154lines are aligned to column zero."
155 :type '(choice (const :tag "Align under preceding line" t)
156 (const :tag "Align to column zero" nil))
157 :group 'python)
Barry Warsaw095e9c61995-09-19 20:01:42 +0000158
Barry Warsaw218eb751998-09-22 19:51:47 +0000159(defcustom py-block-comment-prefix "##"
Barry Warsaw867a32a1996-03-07 18:30:26 +0000160 "*String used by \\[comment-region] to comment out a block of code.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000161This should follow the convention for non-indenting comment lines so
162that the indentation commands won't get confused (i.e., the string
163should be of the form `#x...' where `x' is not a blank or a tab, and
Barry Warsaw218eb751998-09-22 19:51:47 +0000164`...' is arbitrary). However, this string should not end in whitespace."
Barry Warsawc72c11c1997-08-09 06:42:08 +0000165 :type 'string
166 :group 'python)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000167
Barry Warsawc72c11c1997-08-09 06:42:08 +0000168(defcustom py-honor-comment-indentation t
Barry Warsaw6d627751996-03-06 18:41:38 +0000169 "*Controls how comment lines influence subsequent indentation.
Barry Warsaw33d6ec01996-03-05 16:28:07 +0000170
Barry Warsaw6d627751996-03-06 18:41:38 +0000171When nil, all comment lines are skipped for indentation purposes, and
Barry Warsawc72c11c1997-08-09 06:42:08 +0000172if possible, a faster algorithm is used (i.e. X/Emacs 19 and beyond).
Barry Warsaw6d627751996-03-06 18:41:38 +0000173
174When t, lines that begin with a single `#' are a hint to subsequent
175line indentation. If the previous line is such a comment line (as
Barry Warsaw145ab1c1998-05-19 14:49:49 +0000176opposed to one that starts with `py-block-comment-prefix'), then its
Barry Warsaw6d627751996-03-06 18:41:38 +0000177indentation is used as a hint for this line's indentation. Lines that
178begin with `py-block-comment-prefix' are ignored for indentation
179purposes.
180
Barry Warsawd36cfe42002-03-15 16:46:46 +0000181When not nil or t, comment lines that begin with a single `#' are used
182as indentation hints, unless the comment character is in column zero."
Barry Warsawc72c11c1997-08-09 06:42:08 +0000183 :type '(choice
184 (const :tag "Skip all comment lines (fast)" nil)
185 (const :tag "Single # `sets' indentation for next line" t)
Barry Warsawaffc0ca1997-11-03 16:59:38 +0000186 (const :tag "Single # `sets' indentation except at column zero"
187 other)
Barry Warsawc72c11c1997-08-09 06:42:08 +0000188 )
189 :group 'python)
Barry Warsaw33d6ec01996-03-05 16:28:07 +0000190
Barry Warsaw516b6201997-08-09 06:43:20 +0000191(defcustom py-temp-directory
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000192 (let ((ok '(lambda (x)
193 (and x
194 (setq x (expand-file-name x)) ; always true
195 (file-directory-p x)
196 (file-writable-p x)
197 x))))
Barry Warsaw7ae77681994-12-12 20:38:05 +0000198 (or (funcall ok (getenv "TMPDIR"))
199 (funcall ok "/usr/tmp")
200 (funcall ok "/tmp")
Barry Warsawd1648372002-03-18 18:53:56 +0000201 (funcall ok "/var/tmp")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000202 (funcall ok ".")
203 (error
Barry Warsaw6c6db0a1998-02-25 16:33:56 +0000204 "Couldn't find a usable temp directory -- set `py-temp-directory'")))
Barry Warsawd1648372002-03-18 18:53:56 +0000205 "*Directory used for temporary files created by a *Python* process.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000206By default, the first directory from this list that exists and that you
Barry Warsawd1648372002-03-18 18:53:56 +0000207can write into: the value (if any) of the environment variable TMPDIR,
208/usr/tmp, /tmp, /var/tmp, or the current directory."
Barry Warsawc72c11c1997-08-09 06:42:08 +0000209 :type 'string
210 :group 'python)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000211
Barry Warsaw516b6201997-08-09 06:43:20 +0000212(defcustom py-beep-if-tab-change t
Barry Warsaw41a05c71998-08-10 16:33:12 +0000213 "*Ring the bell if `tab-width' is changed.
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000214If a comment of the form
215
216 \t# vi:set tabsize=<number>:
217
218is found before the first code line when the file is entered, and the
219current value of (the general Emacs variable) `tab-width' does not
220equal <number>, `tab-width' is set to <number>, a message saying so is
221displayed in the echo area, and if `py-beep-if-tab-change' is non-nil
Barry Warsawc72c11c1997-08-09 06:42:08 +0000222the Emacs bell is also rung as a warning."
223 :type 'boolean
224 :group 'python)
225
Barry Warsaw9981d221997-12-03 05:25:48 +0000226(defcustom py-jump-on-exception t
227 "*Jump to innermost exception frame in *Python Output* buffer.
Barry Warsaw12c92941998-08-10 21:44:37 +0000228When this variable is non-nil and an exception occurs when running
Barry Warsaw9981d221997-12-03 05:25:48 +0000229Python code synchronously in a subprocess, jump immediately to the
Barry Warsaw12c92941998-08-10 21:44:37 +0000230source code of the innermost traceback frame."
Barry Warsaw3bfed5b1998-05-19 16:25:04 +0000231 :type 'boolean
232 :group 'python)
233
234(defcustom py-ask-about-save t
235 "If not nil, ask about which buffers to save before executing some code.
236Otherwise, all modified buffers are saved without asking."
237 :type 'boolean
238 :group 'python)
Barry Warsaw9981d221997-12-03 05:25:48 +0000239
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000240(defcustom py-backspace-function 'backward-delete-char-untabify
241 "*Function called by `py-electric-backspace' when deleting backwards."
242 :type 'function
243 :group 'python)
244
245(defcustom py-delete-function 'delete-char
246 "*Function called by `py-electric-delete' when deleting forwards."
247 :type 'function
248 :group 'python)
249
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000250(defcustom py-imenu-show-method-args-p nil
251 "*Controls echoing of arguments of functions & methods in the Imenu buffer.
252When non-nil, arguments are printed."
253 :type 'boolean
254 :group 'python)
255(make-variable-buffer-local 'py-indent-offset)
256
Barry Warsaw4f577d22001-04-11 20:23:17 +0000257(defcustom py-pdbtrack-do-tracking-p t
258 "*Controls whether the pdbtrack feature is enabled or not.
259When non-nil, pdbtrack is enabled in all comint-based buffers,
260e.g. shell buffers and the *Python* buffer. When using pdb to debug a
261Python program, pdbtrack notices the pdb prompt and displays the
262source file and line that the program is stopped at, much the same way
263as gud-mode does for debugging C programs with gdb."
264 :type 'boolean
265 :group 'python)
266(make-variable-buffer-local 'py-pdbtrack-do-tracking-p)
267
268(defcustom py-pdbtrack-minor-mode-string " PDB"
269 "*String to use in the minor mode list when pdbtrack is enabled."
270 :type 'string
271 :group 'python)
272
Barry Warsawc0ecb531998-01-20 21:43:34 +0000273;; Not customizable
274(defvar py-master-file nil
275 "If non-nil, execute the named file instead of the buffer's file.
Barry Warsaw50b3eb61998-02-25 15:57:47 +0000276The intent is to allow you to set this variable in the file's local
Barry Warsawc0ecb531998-01-20 21:43:34 +0000277variable section, e.g.:
278
279 # Local Variables:
280 # py-master-file: \"master.py\"
281 # End:
282
Barry Warsaw41a05c71998-08-10 16:33:12 +0000283so that typing \\[py-execute-buffer] in that buffer executes the named
Barry Warsaw1bbc0311998-10-27 21:54:56 +0000284master file instead of the buffer's file. If the file name has a
285relative path, the value of variable `default-directory' for the
286buffer is prepended to come up with a file name.")
Barry Warsawc0ecb531998-01-20 21:43:34 +0000287(make-variable-buffer-local 'py-master-file)
288
Barry Warsaw29a90f02002-04-22 21:48:20 +0000289(defcustom py-pychecker-command "pychecker"
290 "*Shell command used to run Pychecker."
291 :type 'string
292 :group 'python
293 :tag "Pychecker Command")
294
295(defcustom py-pychecker-command-args '("--stdlib")
296 "*List of string arguments to be passed to pychecker."
297 :type '(repeat string)
298 :group 'python
299 :tag "Pychecker Command Args")
300
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000301
Barry Warsawc72c11c1997-08-09 06:42:08 +0000302
303;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
304;; NO USER DEFINABLE VARIABLES BEYOND THIS POINT
305
Barry Warsaw5e21cb01997-11-05 18:41:11 +0000306(defconst py-emacs-features
307 (let (features)
Barry Warsaw5e21cb01997-11-05 18:41:11 +0000308 features)
Barry Warsawc12c62e1997-09-04 04:18:07 +0000309 "A list of features extant in the Emacs you are using.
Barry Warsaw6ae21ad1997-11-06 14:36:49 +0000310There are many flavors of Emacs out there, with different levels of
311support for features needed by `python-mode'.")
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000312
Barry Warsaw29a90f02002-04-22 21:48:20 +0000313;; Face for None, True, False, self, and Ellipsis
314(defvar py-pseudo-keyword-face 'py-pseudo-keyword-face
315 "Face for pseudo keywords in Python mode, like self, True, False, Ellipsis.")
316(make-face 'py-pseudo-keyword-face)
317
318(defun py-font-lock-mode-hook ()
319 (or (face-differs-from-default-p 'py-pseudo-keyword-face)
320 (copy-face 'font-lock-keyword-face 'py-pseudo-keyword-face)))
321(add-hook 'font-lock-mode-hook 'py-font-lock-mode-hook)
322
Barry Warsawfb07f401997-02-24 03:37:22 +0000323(defvar python-font-lock-keywords
Barry Warsawb8f11661997-11-06 14:35:15 +0000324 (let ((kw1 (mapconcat 'identity
325 '("and" "assert" "break" "class"
326 "continue" "def" "del" "elif"
327 "else" "except" "exec" "for"
328 "from" "global" "if" "import"
329 "in" "is" "lambda" "not"
330 "or" "pass" "print" "raise"
Barry Warsawe275c422001-06-19 18:24:42 +0000331 "return" "while" "yield"
Barry Warsawb8f11661997-11-06 14:35:15 +0000332 )
333 "\\|"))
334 (kw2 (mapconcat 'identity
335 '("else:" "except:" "finally:" "try:")
336 "\\|"))
337 )
Barry Warsaw33ab6e41996-03-05 00:44:31 +0000338 (list
Barry Warsawef3c8911997-11-05 18:55:50 +0000339 ;; keywords
Barry Warsawb8f11661997-11-06 14:35:15 +0000340 (cons (concat "\\b\\(" kw1 "\\)\\b[ \n\t(]") 1)
341 ;; block introducing keywords with immediately following colons.
342 ;; Yes "except" is in both lists.
343 (cons (concat "\\b\\(" kw2 "\\)[ \n\t(]") 1)
Barry Warsawe0c182f2000-12-27 17:41:47 +0000344 ;; `as' but only in "import foo as bar"
345 '("[ \t]*\\(\\bfrom\\b.*\\)?\\bimport\\b.*\\b\\(as\\)\\b" . 2)
Barry Warsaw33ab6e41996-03-05 00:44:31 +0000346 ;; classes
347 '("\\bclass[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)"
348 1 font-lock-type-face)
349 ;; functions
350 '("\\bdef[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)"
351 1 font-lock-function-name-face)
Barry Warsaw29a90f02002-04-22 21:48:20 +0000352 ;; pseudo-keywords
353 '("\\b\\(self\\|None\\|True\\|False\\|Ellipsis\\)\\b"
354 1 py-pseudo-keyword-face)
Barry Warsaw33ab6e41996-03-05 00:44:31 +0000355 ))
Barry Warsaw62d9d6e1996-03-06 20:32:27 +0000356 "Additional expressions to highlight in Python mode.")
Barry Warsawfb07f401997-02-24 03:37:22 +0000357(put 'python-mode 'font-lock-defaults '(python-font-lock-keywords))
358
Barry Warsawe467bfb1997-11-26 05:40:58 +0000359;; have to bind py-file-queue before installing the kill-emacs-hook
Barry Warsaw7ae77681994-12-12 20:38:05 +0000360(defvar py-file-queue nil
361 "Queue of Python temp files awaiting execution.
362Currently-active file is at the head of the list.")
363
Barry Warsaw4f577d22001-04-11 20:23:17 +0000364(defvar py-pdbtrack-is-tracking-p nil)
Barry Warsaw29a90f02002-04-22 21:48:20 +0000365(defvar py-pychecker-history nil)
Barry Warsaw4f577d22001-04-11 20:23:17 +0000366
367
Barry Warsawc72c11c1997-08-09 06:42:08 +0000368
369;; Constants
370
Barry Warsawc72c11c1997-08-09 06:42:08 +0000371(defconst py-stringlit-re
372 (concat
Barry Warsaw751f4931998-05-19 16:06:21 +0000373 ;; These fail if backslash-quote ends the string (not worth
374 ;; fixing?). They precede the short versions so that the first two
375 ;; quotes don't look like an empty short string.
376 ;;
377 ;; (maybe raw), long single quoted triple quoted strings (SQTQ),
378 ;; with potential embedded single quotes
379 "[rR]?'''[^']*\\(\\('[^']\\|''[^']\\)[^']*\\)*'''"
380 "\\|"
381 ;; (maybe raw), long double quoted triple quoted strings (DQTQ),
382 ;; with potential embedded double quotes
383 "[rR]?\"\"\"[^\"]*\\(\\(\"[^\"]\\|\"\"[^\"]\\)[^\"]*\\)*\"\"\""
384 "\\|"
385 "[rR]?'\\([^'\n\\]\\|\\\\.\\)*'" ; single-quoted
Barry Warsawc72c11c1997-08-09 06:42:08 +0000386 "\\|" ; or
Barry Warsaw751f4931998-05-19 16:06:21 +0000387 "[rR]?\"\\([^\"\n\\]\\|\\\\.\\)*\"" ; double-quoted
Barry Warsaw41a05c71998-08-10 16:33:12 +0000388 )
389 "Regular expression matching a Python string literal.")
Barry Warsaw751f4931998-05-19 16:06:21 +0000390
Barry Warsawc72c11c1997-08-09 06:42:08 +0000391(defconst py-continued-re
Barry Warsaw41a05c71998-08-10 16:33:12 +0000392 ;; This is tricky because a trailing backslash does not mean
393 ;; continuation if it's in a comment
Barry Warsawc72c11c1997-08-09 06:42:08 +0000394 (concat
395 "\\(" "[^#'\"\n\\]" "\\|" py-stringlit-re "\\)*"
Barry Warsaw41a05c71998-08-10 16:33:12 +0000396 "\\\\$")
397 "Regular expression matching Python backslash continuation lines.")
Barry Warsawc72c11c1997-08-09 06:42:08 +0000398
Barry Warsaw41a05c71998-08-10 16:33:12 +0000399(defconst py-blank-or-comment-re "[ \t]*\\($\\|#\\)"
Barry Warsaw71c3adb1998-08-10 16:34:33 +0000400 "Regular expression matching a blank or comment line.")
Barry Warsawc72c11c1997-08-09 06:42:08 +0000401
Barry Warsawc72c11c1997-08-09 06:42:08 +0000402(defconst py-outdent-re
403 (concat "\\(" (mapconcat 'identity
404 '("else:"
405 "except\\(\\s +.*\\)?:"
406 "finally:"
407 "elif\\s +.*:")
408 "\\|")
Barry Warsaw41a05c71998-08-10 16:33:12 +0000409 "\\)")
410 "Regular expression matching statements to be dedented one level.")
Barry Warsawc72c11c1997-08-09 06:42:08 +0000411
Barry Warsawaffc0ca1997-11-03 16:59:38 +0000412(defconst py-block-closing-keywords-re
Barry Warsaw41a05c71998-08-10 16:33:12 +0000413 "\\(return\\|raise\\|break\\|continue\\|pass\\)"
414 "Regular expression matching keywords which typically close a block.")
Barry Warsawaffc0ca1997-11-03 16:59:38 +0000415
Barry Warsawc72c11c1997-08-09 06:42:08 +0000416(defconst py-no-outdent-re
Barry Warsawaffc0ca1997-11-03 16:59:38 +0000417 (concat
418 "\\("
419 (mapconcat 'identity
420 (list "try:"
421 "except\\(\\s +.*\\)?:"
422 "while\\s +.*:"
423 "for\\s +.*:"
424 "if\\s +.*:"
425 "elif\\s +.*:"
426 (concat py-block-closing-keywords-re "[ \t\n]")
427 )
428 "\\|")
Barry Warsaw41a05c71998-08-10 16:33:12 +0000429 "\\)")
430 "Regular expression matching lines not to dedent after.")
Barry Warsawc72c11c1997-08-09 06:42:08 +0000431
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000432(defconst py-defun-start-re
Barry Warsaw41a05c71998-08-10 16:33:12 +0000433 "^\\([ \t]*\\)def[ \t]+\\([a-zA-Z_0-9]+\\)\\|\\(^[a-zA-Z_0-9]+\\)[ \t]*="
434 ;; If you change this, you probably have to change py-current-defun
435 ;; as well. This is only used by py-current-defun to find the name
436 ;; for add-log.el.
Barry Warsaw71c3adb1998-08-10 16:34:33 +0000437 "Regular expression matching a function, method, or variable assignment.")
Barry Warsawc72c11c1997-08-09 06:42:08 +0000438
Barry Warsaw41a05c71998-08-10 16:33:12 +0000439(defconst py-class-start-re "^class[ \t]*\\([a-zA-Z_0-9]+\\)"
440 ;; If you change this, you probably have to change py-current-defun
441 ;; as well. This is only used by py-current-defun to find the name
442 ;; for add-log.el.
443 "Regular expression for finding a class name.")
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000444
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000445(defconst py-traceback-line-re
Barry Warsaw41a05c71998-08-10 16:33:12 +0000446 "[ \t]+File \"\\([^\"]+\\)\", line \\([0-9]+\\)"
447 "Regular expression that describes tracebacks.")
Barry Warsawc72c11c1997-08-09 06:42:08 +0000448
Barry Warsaw4f577d22001-04-11 20:23:17 +0000449;; pdbtrack contants
450(defconst py-pdbtrack-stack-entry-regexp
451 "> \\([^(]+\\)(\\([0-9]+\\))[?a-zA-Z0-9_]+()"
452 "Regular expression pdbtrack uses to find a stack trace entry.")
453
454(defconst py-pdbtrack-input-prompt "\n[(<]?pdb[>)]? "
455 "Regular expression pdbtrack uses to recognize a pdb prompt.")
456
457(defconst py-pdbtrack-track-range 10000
458 "Max number of characters from end of buffer to search for stack entry.")
459
Barry Warsawc72c11c1997-08-09 06:42:08 +0000460
461
Barry Warsawc72c11c1997-08-09 06:42:08 +0000462;; Major mode boilerplate
463
Barry Warsaw7ae77681994-12-12 20:38:05 +0000464;; define a mode-specific abbrev table for those who use such things
465(defvar python-mode-abbrev-table nil
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000466 "Abbrev table in use in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000467(define-abbrev-table 'python-mode-abbrev-table nil)
468
Barry Warsaw7ae77681994-12-12 20:38:05 +0000469(defvar python-mode-hook nil
470 "*Hook called by `python-mode'.")
471
Barry Warsaw145ab1c1998-05-19 14:49:49 +0000472;; In previous version of python-mode.el, the hook was incorrectly
473;; called py-mode-hook, and was not defvar'd. Deprecate its use.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000474(and (fboundp 'make-obsolete-variable)
475 (make-obsolete-variable 'py-mode-hook 'python-mode-hook))
476
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000477(defvar py-mode-map ()
478 "Keymap used in `python-mode' buffers.")
Barry Warsaw7ae77681994-12-12 20:38:05 +0000479(if py-mode-map
Barry Warsawc72c11c1997-08-09 06:42:08 +0000480 nil
Barry Warsaw7ae77681994-12-12 20:38:05 +0000481 (setq py-mode-map (make-sparse-keymap))
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000482 ;; electric keys
483 (define-key py-mode-map ":" 'py-electric-colon)
484 ;; indentation level modifiers
485 (define-key py-mode-map "\C-c\C-l" 'py-shift-region-left)
486 (define-key py-mode-map "\C-c\C-r" 'py-shift-region-right)
487 (define-key py-mode-map "\C-c<" 'py-shift-region-left)
488 (define-key py-mode-map "\C-c>" 'py-shift-region-right)
489 ;; subprocess commands
490 (define-key py-mode-map "\C-c\C-c" 'py-execute-buffer)
Barry Warsaw820273d1998-05-19 15:54:45 +0000491 (define-key py-mode-map "\C-c\C-m" 'py-execute-import-or-reload)
Barry Warsaw1d0364b1998-05-19 16:15:26 +0000492 (define-key py-mode-map "\C-c\C-s" 'py-execute-string)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000493 (define-key py-mode-map "\C-c|" 'py-execute-region)
Barry Warsaw820273d1998-05-19 15:54:45 +0000494 (define-key py-mode-map "\e\C-x" 'py-execute-def-or-class)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000495 (define-key py-mode-map "\C-c!" 'py-shell)
Barry Warsawa2398801998-04-09 23:28:20 +0000496 (define-key py-mode-map "\C-c\C-t" 'py-toggle-shells)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000497 ;; Caution! Enter here at your own risk. We are trying to support
498 ;; several behaviors and it gets disgusting. :-( This logic ripped
499 ;; largely from CC Mode.
500 ;;
501 ;; In XEmacs 19, Emacs 19, and Emacs 20, we use this to bind
502 ;; backwards deletion behavior to DEL, which both Delete and
503 ;; Backspace get translated to. There's no way to separate this
504 ;; behavior in a clean way, so deal with it! Besides, it's been
505 ;; this way since the dawn of time.
506 (if (not (boundp 'delete-key-deletes-forward))
507 (define-key py-mode-map "\177" 'py-electric-backspace)
508 ;; However, XEmacs 20 actually achieved enlightenment. It is
509 ;; possible to sanely define both backward and forward deletion
510 ;; behavior under X separately (TTYs are forever beyond hope, but
511 ;; who cares? XEmacs 20 does the right thing with these too).
512 (define-key py-mode-map [delete] 'py-electric-delete)
513 (define-key py-mode-map [backspace] 'py-electric-backspace))
Barry Warsaw8c4a8de1997-11-26 20:30:33 +0000514 ;; Separate M-BS from C-M-h. The former should remain
515 ;; backward-kill-word.
516 (define-key py-mode-map [(control meta h)] 'py-mark-def-or-class)
Barry Warsaw2518c671997-11-05 00:51:08 +0000517 (define-key py-mode-map "\C-c\C-k" 'py-mark-block)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000518 ;; Miscellaneous
519 (define-key py-mode-map "\C-c:" 'py-guess-indent-offset)
520 (define-key py-mode-map "\C-c\t" 'py-indent-region)
Barry Warsaw4f577d22001-04-11 20:23:17 +0000521 (define-key py-mode-map "\C-c\C-d" 'py-pdbtrack-toggle-stack-tracking)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000522 (define-key py-mode-map "\C-c\C-n" 'py-next-statement)
523 (define-key py-mode-map "\C-c\C-p" 'py-previous-statement)
524 (define-key py-mode-map "\C-c\C-u" 'py-goto-block-up)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000525 (define-key py-mode-map "\C-c#" 'py-comment-region)
526 (define-key py-mode-map "\C-c?" 'py-describe-mode)
Barry Warsaw04949552002-04-22 22:05:49 +0000527 (define-key py-mode-map [f1] 'py-help-at-point)
Barry Warsawa7cc43b2002-04-22 17:15:19 +0000528 (define-key py-mode-map "\C-c\C-h" 'py-help-at-point)
Barry Warsawab0e86c1998-05-19 15:31:46 +0000529 (define-key py-mode-map "\e\C-a" 'py-beginning-of-def-or-class)
530 (define-key py-mode-map "\e\C-e" 'py-end-of-def-or-class)
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000531 (define-key py-mode-map "\C-c-" 'py-up-exception)
532 (define-key py-mode-map "\C-c=" 'py-down-exception)
Barry Warsawf8ddb6a1999-01-18 21:49:39 +0000533 ;; stuff that is `standard' but doesn't interface well with
534 ;; python-mode, which forces us to rebind to special commands
535 (define-key py-mode-map "\C-xnd" 'py-narrow-to-defun)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +0000536 ;; information
537 (define-key py-mode-map "\C-c\C-b" 'py-submit-bug-report)
538 (define-key py-mode-map "\C-c\C-v" 'py-version)
Barry Warsaw29a90f02002-04-22 21:48:20 +0000539 (define-key py-mode-map "\C-c\C-w" 'py-pychecker-run)
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000540 ;; shadow global bindings for newline-and-indent w/ the py- version.
541 ;; BAW - this is extremely bad form, but I'm not going to change it
542 ;; for now.
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000543 (mapcar #'(lambda (key)
544 (define-key py-mode-map key 'py-newline-and-indent))
545 (where-is-internal 'newline-and-indent))
Barry Warsawf19feb81999-01-21 17:06:11 +0000546 ;; Force RET to be py-newline-and-indent even if it didn't get
547 ;; mapped by the above code. motivation: Emacs' default binding for
548 ;; RET is `newline' and C-j is `newline-and-indent'. Most Pythoneers
549 ;; expect RET to do a `py-newline-and-indent' and any Emacsers who
550 ;; dislike this are probably knowledgeable enough to do a rebind.
551 ;; However, we do *not* change C-j since many Emacsers have already
552 ;; swapped RET and C-j and they don't want C-j bound to `newline' to
553 ;; change.
554 (define-key py-mode-map "\C-m" 'py-newline-and-indent)
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000555 )
556
557(defvar py-mode-output-map nil
Barry Warsaw41a05c71998-08-10 16:33:12 +0000558 "Keymap used in *Python Output* buffers.")
Barry Warsawa0ee8cd1997-11-26 01:04:44 +0000559(if py-mode-output-map
560 nil
561 (setq py-mode-output-map (make-sparse-keymap))
562 (define-key py-mode-output-map [button2] 'py-mouseto-exception)
563 (define-key py-mode-output-map "\C-c\C-c" 'py-goto-exception)
564 ;; TBD: Disable all self-inserting keys. This is bogus, we should
565 ;; really implement this as *Python Output* buffer being read-only
566 (mapcar #' (lambda (key)
567 (define-key py-mode-output-map key
568 #'(lambda () (interactive) (beep))))
569 (where-is-internal 'self-insert-command))
Barry Warsaw850437a1995-03-08 21:50:28 +0000570 )
Barry Warsaw7ae77681994-12-12 20:38:05 +0000571
Barry Warsaw6dfbe5d1998-08-20 21:51:27 +0000572(defvar py-shell-map nil
573 "Keymap used in *Python* shell buffers.")
574(if py-shell-map
575 nil
576 (setq py-shell-map (copy-keymap comint-mode-map))
577 (define-key py-shell-map [tab] 'tab-to-tab-stop)
578 (define-key py-shell-map "\C-c-" 'py-up-exception)
579 (define-key py-shell-map "\C-c=" 'py-down-exception)
580 )
581
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000582(defvar py-mode-syntax-table nil
583 "Syntax table used in `python-mode' buffers.")
Barry Warsawa7cc43b2002-04-22 17:15:19 +0000584(when (not py-mode-syntax-table)
Barry Warsaw7ae77681994-12-12 20:38:05 +0000585 (setq py-mode-syntax-table (make-syntax-table))
Barry Warsawc72c11c1997-08-09 06:42:08 +0000586 (modify-syntax-entry ?\( "()" py-mode-syntax-table)
587 (modify-syntax-entry ?\) ")(" py-mode-syntax-table)
588 (modify-syntax-entry ?\[ "(]" py-mode-syntax-table)
589 (modify-syntax-entry ?\] ")[" py-mode-syntax-table)
590 (modify-syntax-entry ?\{ "(}" py-mode-syntax-table)
591 (modify-syntax-entry ?\} "){" py-mode-syntax-table)
592 ;; Add operator symbols misassigned in the std table
593 (modify-syntax-entry ?\$ "." py-mode-syntax-table)
594 (modify-syntax-entry ?\% "." py-mode-syntax-table)
595 (modify-syntax-entry ?\& "." py-mode-syntax-table)
596 (modify-syntax-entry ?\* "." py-mode-syntax-table)
597 (modify-syntax-entry ?\+ "." py-mode-syntax-table)
598 (modify-syntax-entry ?\- "." py-mode-syntax-table)
599 (modify-syntax-entry ?\/ "." py-mode-syntax-table)
600 (modify-syntax-entry ?\< "." py-mode-syntax-table)
601 (modify-syntax-entry ?\= "." py-mode-syntax-table)
602 (modify-syntax-entry ?\> "." py-mode-syntax-table)
603 (modify-syntax-entry ?\| "." py-mode-syntax-table)
604 ;; For historical reasons, underscore is word class instead of
605 ;; symbol class. GNU conventions say it should be symbol class, but
606 ;; there's a natural conflict between what major mode authors want
607 ;; and what users expect from `forward-word' and `backward-word'.
608 ;; Guido and I have hashed this out and have decided to keep
609 ;; underscore in word class. If you're tempted to change it, try
610 ;; binding M-f and M-b to py-forward-into-nomenclature and
Barry Warsawaa384fd1999-02-16 23:36:16 +0000611 ;; py-backward-into-nomenclature instead. This doesn't help in all
612 ;; situations where you'd want the different behavior
613 ;; (e.g. backward-kill-word).
Barry Warsawc72c11c1997-08-09 06:42:08 +0000614 (modify-syntax-entry ?\_ "w" py-mode-syntax-table)
615 ;; Both single quote and double quote are string delimiters
616 (modify-syntax-entry ?\' "\"" py-mode-syntax-table)
617 (modify-syntax-entry ?\" "\"" py-mode-syntax-table)
618 ;; backquote is open and close paren
619 (modify-syntax-entry ?\` "$" py-mode-syntax-table)
620 ;; comment delimiters
621 (modify-syntax-entry ?\# "<" py-mode-syntax-table)
622 (modify-syntax-entry ?\n ">" py-mode-syntax-table)
623 )
Barry Warsaw7ae77681994-12-12 20:38:05 +0000624
Barry Warsawa7cc43b2002-04-22 17:15:19 +0000625;; An auxiliary syntax table which places underscore and dot in the
626;; symbol class for simplicity
627(defvar py-dotted-expression-syntax-table nil
628 "Syntax table used to identify Python dotted expressions.")
629(when (not py-dotted-expression-syntax-table)
630 (setq py-dotted-expression-syntax-table
631 (copy-syntax-table py-mode-syntax-table))
632 (modify-syntax-entry ?_ "_" py-dotted-expression-syntax-table)
633 (modify-syntax-entry ?. "_" py-dotted-expression-syntax-table))
634
Barry Warsawb3e81d51996-09-04 15:12:42 +0000635
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000636
Barry Warsawbc3760b1998-09-14 16:16:18 +0000637;; Utilities
Barry Warsawbc3760b1998-09-14 16:16:18 +0000638(defmacro py-safe (&rest body)
639 "Safely execute BODY, return nil if an error occurred."
640 (` (condition-case nil
641 (progn (,@ body))
642 (error nil))))
643
644(defsubst py-keep-region-active ()
645 "Keep the region active in XEmacs."
646 ;; Ignore byte-compiler warnings you might see. Also note that
647 ;; FSF's Emacs 19 does it differently; its policy doesn't require us
648 ;; to take explicit action.
649 (and (boundp 'zmacs-region-stays)
650 (setq zmacs-region-stays t)))
651
652(defsubst py-point (position)
653 "Returns the value of point at certain commonly referenced POSITIONs.
654POSITION can be one of the following symbols:
655
656 bol -- beginning of line
657 eol -- end of line
658 bod -- beginning of def or class
659 eod -- end of def or class
660 bob -- beginning of buffer
661 eob -- end of buffer
662 boi -- back to indentation
663 bos -- beginning of statement
664
665This function does not modify point or mark."
666 (let ((here (point)))
667 (cond
668 ((eq position 'bol) (beginning-of-line))
669 ((eq position 'eol) (end-of-line))
670 ((eq position 'bod) (py-beginning-of-def-or-class))
671 ((eq position 'eod) (py-end-of-def-or-class))
672 ;; Kind of funny, I know, but useful for py-up-exception.
673 ((eq position 'bob) (beginning-of-buffer))
674 ((eq position 'eob) (end-of-buffer))
675 ((eq position 'boi) (back-to-indentation))
676 ((eq position 'bos) (py-goto-initial-line))
677 (t (error "Unknown buffer position requested: %s" position))
678 )
679 (prog1
680 (point)
681 (goto-char here))))
682
683(defsubst py-highlight-line (from to file line)
684 (cond
685 ((fboundp 'make-extent)
686 ;; XEmacs
687 (let ((e (make-extent from to)))
688 (set-extent-property e 'mouse-face 'highlight)
689 (set-extent-property e 'py-exc-info (cons file line))
690 (set-extent-property e 'keymap py-mode-output-map)))
691 (t
692 ;; Emacs -- Please port this!
693 )
694 ))
695
696(defun py-in-literal (&optional lim)
697 "Return non-nil if point is in a Python literal (a comment or string).
698Optional argument LIM indicates the beginning of the containing form,
699i.e. the limit on how far back to scan."
700 ;; This is the version used for non-XEmacs, which has a nicer
701 ;; interface.
702 ;;
703 ;; WARNING: Watch out for infinite recursion.
704 (let* ((lim (or lim (py-point 'bod)))
705 (state (parse-partial-sexp lim (point))))
706 (cond
707 ((nth 3 state) 'string)
708 ((nth 4 state) 'comment)
709 (t nil))))
710
711;; XEmacs has a built-in function that should make this much quicker.
712;; In this case, lim is ignored
713(defun py-fast-in-literal (&optional lim)
714 "Fast version of `py-in-literal', used only by XEmacs.
715Optional LIM is ignored."
716 ;; don't have to worry about context == 'block-comment
717 (buffer-syntactic-context))
718
719(if (fboundp 'buffer-syntactic-context)
720 (defalias 'py-in-literal 'py-fast-in-literal))
721
722
723
Barry Warsaw42f707f1996-07-29 21:05:05 +0000724;; Menu definitions, only relevent if you have the easymenu.el package
725;; (standard in the latest Emacs 19 and XEmacs 19 distributions).
Barry Warsaw5490a061996-08-06 15:43:33 +0000726(defvar py-menu nil
727 "Menu for Python Mode.
Barry Warsawc72c11c1997-08-09 06:42:08 +0000728This menu will get created automatically if you have the `easymenu'
729package. Note that the latest X/Emacs releases contain this package.")
Barry Warsaw5490a061996-08-06 15:43:33 +0000730
Barry Warsawc72c11c1997-08-09 06:42:08 +0000731(and (py-safe (require 'easymenu) t)
732 (easy-menu-define
733 py-menu py-mode-map "Python Mode menu"
734 '("Python"
735 ["Comment Out Region" py-comment-region (mark)]
736 ["Uncomment Region" (py-comment-region (point) (mark) '(4)) (mark)]
737 "-"
738 ["Mark current block" py-mark-block t]
Barry Warsaw2518c671997-11-05 00:51:08 +0000739 ["Mark current def" py-mark-def-or-class t]
740 ["Mark current class" (py-mark-def-or-class t) t]
Barry Warsawc72c11c1997-08-09 06:42:08 +0000741 "-"
742 ["Shift region left" py-shift-region-left (mark)]
743 ["Shift region right" py-shift-region-right (mark)]
744 "-"
Barry Warsaw820273d1998-05-19 15:54:45 +0000745 ["Import/reload file" py-execute-import-or-reload t]
Barry Warsawc72c11c1997-08-09 06:42:08 +0000746 ["Execute buffer" py-execute-buffer t]
747 ["Execute region" py-execute-region (mark)]
Barry Warsaw820273d1998-05-19 15:54:45 +0000748 ["Execute def or class" py-execute-def-or-class (mark)]
Barry Warsaw1d0364b1998-05-19 16:15:26 +0000749 ["Execute string" py-execute-string t]
Barry Warsawc72c11c1997-08-09 06:42:08 +0000750 ["Start interpreter..." py-shell t]
751 "-"
752 ["Go to start of block" py-goto-block-up t]
Barry Warsawab0e86c1998-05-19 15:31:46 +0000753 ["Go to start of class" (py-beginning-of-def-or-class t) t]
754 ["Move to end of class" (py-end-of-def-or-class t) t]
755 ["Move to start of def" py-beginning-of-def-or-class t]
756 ["Move to end of def" py-end-of-def-or-class t]
Barry Warsawc72c11c1997-08-09 06:42:08 +0000757 "-"
758 ["Describe mode" py-describe-mode t]
759 )))
Barry Warsaw42f707f1996-07-29 21:05:05 +0000760
Barry Warsaw81437461996-08-01 19:48:02 +0000761
762
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000763;; Imenu definitions
764(defvar py-imenu-class-regexp
Barry Warsaw81437461996-08-01 19:48:02 +0000765 (concat ; <<classes>>
766 "\\(" ;
767 "^[ \t]*" ; newline and maybe whitespace
768 "\\(class[ \t]+[a-zA-Z0-9_]+\\)" ; class name
769 ; possibly multiple superclasses
Barry Warsaw3179fe01998-04-04 21:36:53 +0000770 "\\([ \t]*\\((\\([a-zA-Z0-9_,. \t\n]\\)*)\\)?\\)"
Barry Warsaw81437461996-08-01 19:48:02 +0000771 "[ \t]*:" ; and the final :
772 "\\)" ; >>classes<<
773 )
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000774 "Regexp for Python classes for use with the Imenu package."
Barry Warsaw81437461996-08-01 19:48:02 +0000775 )
776
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000777(defvar py-imenu-method-regexp
Barry Warsaw81437461996-08-01 19:48:02 +0000778 (concat ; <<methods and functions>>
779 "\\(" ;
780 "^[ \t]*" ; new line and maybe whitespace
781 "\\(def[ \t]+" ; function definitions start with def
782 "\\([a-zA-Z0-9_]+\\)" ; name is here
783 ; function arguments...
Barry Warsaw1d5f9881998-10-28 04:08:13 +0000784;; "[ \t]*(\\([-+/a-zA-Z0-9_=,\* \t\n.()\"'#]*\\))"
785 "[ \t]*(\\([^:#]*\\))"
Barry Warsaw81437461996-08-01 19:48:02 +0000786 "\\)" ; end of def
787 "[ \t]*:" ; and then the :
788 "\\)" ; >>methods and functions<<
789 )
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000790 "Regexp for Python methods/functions for use with the Imenu package."
Barry Warsaw81437461996-08-01 19:48:02 +0000791 )
792
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000793(defvar py-imenu-method-no-arg-parens '(2 8)
794 "Indices into groups of the Python regexp for use with Imenu.
Barry Warsaw81437461996-08-01 19:48:02 +0000795
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000796Using these values will result in smaller Imenu lists, as arguments to
Barry Warsaw81437461996-08-01 19:48:02 +0000797functions are not listed.
798
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000799See the variable `py-imenu-show-method-args-p' for more
Barry Warsaw81437461996-08-01 19:48:02 +0000800information.")
801
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000802(defvar py-imenu-method-arg-parens '(2 7)
Barry Warsaw1bbc0311998-10-27 21:54:56 +0000803 "Indices into groups of the Python regexp for use with imenu.
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000804Using these values will result in large Imenu lists, as arguments to
Barry Warsaw81437461996-08-01 19:48:02 +0000805functions are listed.
806
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000807See the variable `py-imenu-show-method-args-p' for more
Barry Warsaw81437461996-08-01 19:48:02 +0000808information.")
809
810;; Note that in this format, this variable can still be used with the
811;; imenu--generic-function. Otherwise, there is no real reason to have
812;; it.
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000813(defvar py-imenu-generic-expression
Barry Warsaw81437461996-08-01 19:48:02 +0000814 (cons
815 (concat
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000816 py-imenu-class-regexp
Barry Warsaw81437461996-08-01 19:48:02 +0000817 "\\|" ; or...
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000818 py-imenu-method-regexp
Barry Warsaw81437461996-08-01 19:48:02 +0000819 )
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000820 py-imenu-method-no-arg-parens)
821 "Generic Python expression which may be used directly with Imenu.
Barry Warsaw81437461996-08-01 19:48:02 +0000822Used by setting the variable `imenu-generic-expression' to this value.
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000823Also, see the function \\[py-imenu-create-index] for a better
824alternative for finding the index.")
Barry Warsaw81437461996-08-01 19:48:02 +0000825
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000826;; These next two variables are used when searching for the Python
Barry Warsaw81437461996-08-01 19:48:02 +0000827;; class/definitions. Just saving some time in accessing the
828;; generic-python-expression, really.
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000829(defvar py-imenu-generic-regexp nil)
830(defvar py-imenu-generic-parens nil)
Barry Warsaw81437461996-08-01 19:48:02 +0000831
832
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000833(defun py-imenu-create-index-function ()
834 "Python interface function for the Imenu package.
835Finds all Python classes and functions/methods. Calls function
836\\[py-imenu-create-index-engine]. See that function for the details
837of how this works."
838 (setq py-imenu-generic-regexp (car py-imenu-generic-expression)
839 py-imenu-generic-parens (if py-imenu-show-method-args-p
840 py-imenu-method-arg-parens
841 py-imenu-method-no-arg-parens))
Barry Warsaw81437461996-08-01 19:48:02 +0000842 (goto-char (point-min))
Barry Warsaw1d5f9881998-10-28 04:08:13 +0000843 ;; Warning: When the buffer has no classes or functions, this will
844 ;; return nil, which seems proper according to the Imenu API, but
845 ;; causes an error in the XEmacs port of Imenu. Sigh.
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000846 (py-imenu-create-index-engine nil))
Barry Warsaw81437461996-08-01 19:48:02 +0000847
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000848(defun py-imenu-create-index-engine (&optional start-indent)
849 "Function for finding Imenu definitions in Python.
Barry Warsaw81437461996-08-01 19:48:02 +0000850
851Finds all definitions (classes, methods, or functions) in a Python
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000852file for the Imenu package.
Barry Warsaw81437461996-08-01 19:48:02 +0000853
854Returns a possibly nested alist of the form
855
856 (INDEX-NAME . INDEX-POSITION)
857
858The second element of the alist may be an alist, producing a nested
859list as in
860
861 (INDEX-NAME . INDEX-ALIST)
862
863This function should not be called directly, as it calls itself
864recursively and requires some setup. Rather this is the engine for
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000865the function \\[py-imenu-create-index-function].
Barry Warsaw81437461996-08-01 19:48:02 +0000866
867It works recursively by looking for all definitions at the current
868indention level. When it finds one, it adds it to the alist. If it
869finds a definition at a greater indentation level, it removes the
Barry Warsaw145ab1c1998-05-19 14:49:49 +0000870previous definition from the alist. In its place it adds all
Barry Warsaw81437461996-08-01 19:48:02 +0000871definitions found at the next indentation level. When it finds a
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000872definition that is less indented then the current level, it returns
873the alist it has created thus far.
Barry Warsaw81437461996-08-01 19:48:02 +0000874
875The optional argument START-INDENT indicates the starting indentation
876at which to continue looking for Python classes, methods, or
877functions. If this is not supplied, the function uses the indentation
878of the first definition found."
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000879 (let (index-alist
880 sub-method-alist
Barry Warsaw81437461996-08-01 19:48:02 +0000881 looking-p
882 def-name prev-name
883 cur-indent def-pos
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000884 (class-paren (first py-imenu-generic-parens))
885 (def-paren (second py-imenu-generic-parens)))
Barry Warsaw81437461996-08-01 19:48:02 +0000886 (setq looking-p
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000887 (re-search-forward py-imenu-generic-regexp (point-max) t))
Barry Warsaw81437461996-08-01 19:48:02 +0000888 (while looking-p
889 (save-excursion
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000890 ;; used to set def-name to this value but generic-extract-name
891 ;; is new to imenu-1.14. this way it still works with
892 ;; imenu-1.11
893 ;;(imenu--generic-extract-name py-imenu-generic-parens))
Barry Warsaw81437461996-08-01 19:48:02 +0000894 (let ((cur-paren (if (match-beginning class-paren)
895 class-paren def-paren)))
896 (setq def-name
Barry Warsawc8520351997-11-26 06:14:40 +0000897 (buffer-substring-no-properties (match-beginning cur-paren)
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000898 (match-end cur-paren))))
Barry Warsaw93c88cc1998-08-18 02:00:44 +0000899 (save-match-data
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000900 (py-beginning-of-def-or-class 'either))
Barry Warsaw81437461996-08-01 19:48:02 +0000901 (beginning-of-line)
902 (setq cur-indent (current-indentation)))
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000903 ;; HACK: want to go to the next correct definition location. We
904 ;; explicitly list them here but it would be better to have them
905 ;; in a list.
Barry Warsaw81437461996-08-01 19:48:02 +0000906 (setq def-pos
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000907 (or (match-beginning class-paren)
908 (match-beginning def-paren)))
Barry Warsaw81437461996-08-01 19:48:02 +0000909 ;; if we don't have a starting indent level, take this one
910 (or start-indent
911 (setq start-indent cur-indent))
Barry Warsaw81437461996-08-01 19:48:02 +0000912 ;; if we don't have class name yet, take this one
913 (or prev-name
914 (setq prev-name def-name))
Barry Warsaw81437461996-08-01 19:48:02 +0000915 ;; what level is the next definition on? must be same, deeper
916 ;; or shallower indentation
917 (cond
918 ;; at the same indent level, add it to the list...
919 ((= start-indent cur-indent)
Barry Warsaw81437461996-08-01 19:48:02 +0000920 (push (cons def-name def-pos) index-alist))
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000921 ;; deeper indented expression, recurse
Barry Warsaw81437461996-08-01 19:48:02 +0000922 ((< start-indent cur-indent)
Barry Warsaw81437461996-08-01 19:48:02 +0000923 ;; the point is currently on the expression we're supposed to
924 ;; start on, so go back to the last expression. The recursive
925 ;; call will find this place again and add it to the correct
926 ;; list
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000927 (re-search-backward py-imenu-generic-regexp (point-min) 'move)
928 (setq sub-method-alist (py-imenu-create-index-engine cur-indent))
Barry Warsaw81437461996-08-01 19:48:02 +0000929 (if sub-method-alist
930 ;; we put the last element on the index-alist on the start
931 ;; of the submethod alist so the user can still get to it.
932 (let ((save-elmt (pop index-alist)))
Barry Warsawc8520351997-11-26 06:14:40 +0000933 (push (cons prev-name
Barry Warsaw81437461996-08-01 19:48:02 +0000934 (cons save-elmt sub-method-alist))
935 index-alist))))
Barry Warsaw81437461996-08-01 19:48:02 +0000936 ;; found less indented expression, we're done.
937 (t
938 (setq looking-p nil)
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000939 (re-search-backward py-imenu-generic-regexp (point-min) t)))
940 ;; end-cond
Barry Warsaw81437461996-08-01 19:48:02 +0000941 (setq prev-name def-name)
942 (and looking-p
943 (setq looking-p
Barry Warsaw6839d3a1998-10-28 00:10:45 +0000944 (re-search-forward py-imenu-generic-regexp
Barry Warsaw81437461996-08-01 19:48:02 +0000945 (point-max) 'move))))
946 (nreverse index-alist)))
947
Barry Warsaw42f707f1996-07-29 21:05:05 +0000948
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000949;;;###autoload
Barry Warsaw7ae77681994-12-12 20:38:05 +0000950(defun python-mode ()
951 "Major mode for editing Python files.
Barry Warsaw7b0f5681995-03-08 21:33:04 +0000952To submit a problem report, enter `\\[py-submit-bug-report]' from a
953`python-mode' buffer. Do `\\[py-describe-mode]' for detailed
954documentation. To see what version of `python-mode' you are running,
955enter `\\[py-version]'.
956
957This mode knows about Python indentation, tokens, comments and
958continuation lines. Paragraphs are separated by blank lines only.
Barry Warsaw7ae77681994-12-12 20:38:05 +0000959
960COMMANDS
961\\{py-mode-map}
962VARIABLES
963
Barry Warsaw42f707f1996-07-29 21:05:05 +0000964py-indent-offset\t\tindentation increment
Barry Warsaw41a05c71998-08-10 16:33:12 +0000965py-block-comment-prefix\t\tcomment string used by `comment-region'
Barry Warsaw42f707f1996-07-29 21:05:05 +0000966py-python-command\t\tshell command to invoke Python interpreter
Barry Warsaw42f707f1996-07-29 21:05:05 +0000967py-temp-directory\t\tdirectory used for temp files (if needed)
Barry Warsaw41a05c71998-08-10 16:33:12 +0000968py-beep-if-tab-change\t\tring the bell if `tab-width' is changed"
Barry Warsaw7ae77681994-12-12 20:38:05 +0000969 (interactive)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000970 ;; set up local variables
Barry Warsaw7ae77681994-12-12 20:38:05 +0000971 (kill-all-local-variables)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000972 (make-local-variable 'font-lock-defaults)
973 (make-local-variable 'paragraph-separate)
974 (make-local-variable 'paragraph-start)
975 (make-local-variable 'require-final-newline)
976 (make-local-variable 'comment-start)
Barry Warsaw5c8bef11996-12-17 21:56:10 +0000977 (make-local-variable 'comment-end)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000978 (make-local-variable 'comment-start-skip)
979 (make-local-variable 'comment-column)
Barry Warsaw003932a1998-07-07 15:11:24 +0000980 (make-local-variable 'comment-indent-function)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000981 (make-local-variable 'indent-region-function)
982 (make-local-variable 'indent-line-function)
Barry Warsawb3e81d51996-09-04 15:12:42 +0000983 (make-local-variable 'add-log-current-defun-function)
Barry Warsaw615d4a41996-09-04 14:14:10 +0000984 ;;
Barry Warsaw7ae77681994-12-12 20:38:05 +0000985 (set-syntax-table py-mode-syntax-table)
Barry Warsaw003932a1998-07-07 15:11:24 +0000986 (setq major-mode 'python-mode
987 mode-name "Python"
988 local-abbrev-table python-mode-abbrev-table
989 font-lock-defaults '(python-font-lock-keywords)
990 paragraph-separate "^[ \t]*$"
991 paragraph-start "^[ \t]*$"
992 require-final-newline t
993 comment-start "# "
994 comment-end ""
995 comment-start-skip "# *"
996 comment-column 40
997 comment-indent-function 'py-comment-indent-function
998 indent-region-function 'py-indent-region
999 indent-line-function 'py-indent-line
Barry Warsawb3e81d51996-09-04 15:12:42 +00001000 ;; tell add-log.el how to find the current function/method/variable
1001 add-log-current-defun-function 'py-current-defun
Barry Warsawb1f89511996-09-03 16:38:30 +00001002 )
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001003 (use-local-map py-mode-map)
Barry Warsaw42f707f1996-07-29 21:05:05 +00001004 ;; add the menu
1005 (if py-menu
1006 (easy-menu-add py-menu))
Barry Warsaw57697af1995-09-14 20:01:14 +00001007 ;; Emacs 19 requires this
Barry Warsawc72c11c1997-08-09 06:42:08 +00001008 (if (boundp 'comment-multi-line)
Barry Warsaw57697af1995-09-14 20:01:14 +00001009 (setq comment-multi-line nil))
Barry Warsaw6839d3a1998-10-28 00:10:45 +00001010 ;; Install Imenu if available
Barry Warsaw742a5111998-03-13 17:29:15 +00001011 (when (py-safe (require 'imenu))
Barry Warsaw6839d3a1998-10-28 00:10:45 +00001012 (setq imenu-create-index-function #'py-imenu-create-index-function)
1013 (setq imenu-generic-expression py-imenu-generic-expression)
Barry Warsaw742a5111998-03-13 17:29:15 +00001014 (if (fboundp 'imenu-add-to-menubar)
1015 (imenu-add-to-menubar (format "%s-%s" "IM" mode-name)))
1016 )
1017 ;; Run the mode hook. Note that py-mode-hook is deprecated.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001018 (if python-mode-hook
1019 (run-hooks 'python-mode-hook)
Barry Warsaw742a5111998-03-13 17:29:15 +00001020 (run-hooks 'py-mode-hook))
1021 ;; Now do the automagical guessing
1022 (if py-smart-indentation
1023 (let ((offset py-indent-offset))
Barry Warsaw145ab1c1998-05-19 14:49:49 +00001024 ;; It's okay if this fails to guess a good value
Barry Warsaw742a5111998-03-13 17:29:15 +00001025 (if (and (py-safe (py-guess-indent-offset))
1026 (<= py-indent-offset 8)
1027 (>= py-indent-offset 2))
1028 (setq offset py-indent-offset))
1029 (setq py-indent-offset offset)
Barry Warsaw639eea61998-03-16 18:12:13 +00001030 ;; Only turn indent-tabs-mode off if tab-width !=
1031 ;; py-indent-offset. Never turn it on, because the user must
1032 ;; have explicitly turned it off.
1033 (if (/= tab-width py-indent-offset)
1034 (setq indent-tabs-mode nil))
Barry Warsaw11f21561999-07-28 21:59:43 +00001035 ))
1036 ;; Set the default shell if not already set
1037 (when (null py-which-shell)
1038 (py-toggle-shells py-default-interpreter))
1039 )
Barry Warsaw7ae77681994-12-12 20:38:05 +00001040
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001041
Barry Warsawb91b7431995-03-14 15:55:20 +00001042;; electric characters
Barry Warsaw3874a3d1995-03-14 22:05:53 +00001043(defun py-outdent-p ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00001044 "Returns non-nil if the current line should dedent one level."
Barry Warsaw3874a3d1995-03-14 22:05:53 +00001045 (save-excursion
1046 (and (progn (back-to-indentation)
1047 (looking-at py-outdent-re))
Barry Warsaw1a1c6bb1999-01-09 17:22:38 +00001048 ;; short circuit infloop on illegal construct
1049 (not (bobp))
Barry Warsawf06777d1998-01-21 05:36:18 +00001050 (progn (forward-line -1)
1051 (py-goto-initial-line)
1052 (back-to-indentation)
Barry Warsaw3874a3d1995-03-14 22:05:53 +00001053 (while (or (looking-at py-blank-or-comment-re)
1054 (bobp))
1055 (backward-to-indentation 1))
1056 (not (looking-at py-no-outdent-re)))
1057 )))
1058
Barry Warsawb91b7431995-03-14 15:55:20 +00001059(defun py-electric-colon (arg)
1060 "Insert a colon.
Barry Warsaw41a05c71998-08-10 16:33:12 +00001061In certain cases the line is dedented appropriately. If a numeric
1062argument ARG is provided, that many colons are inserted
1063non-electrically. Electric behavior is inhibited inside a string or
1064comment."
Barry Warsawb91b7431995-03-14 15:55:20 +00001065 (interactive "P")
1066 (self-insert-command (prefix-numeric-value arg))
Barry Warsaw0c6563f1995-09-14 20:57:02 +00001067 ;; are we in a string or comment?
1068 (if (save-excursion
1069 (let ((pps (parse-partial-sexp (save-excursion
Barry Warsawab0e86c1998-05-19 15:31:46 +00001070 (py-beginning-of-def-or-class)
Barry Warsaw0c6563f1995-09-14 20:57:02 +00001071 (point))
1072 (point))))
1073 (not (or (nth 3 pps) (nth 4 pps)))))
1074 (save-excursion
1075 (let ((here (point))
1076 (outdent 0)
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001077 (indent (py-compute-indentation t)))
Barry Warsaw0c6563f1995-09-14 20:57:02 +00001078 (if (and (not arg)
1079 (py-outdent-p)
1080 (= indent (save-excursion
Barry Warsawa7661821996-08-02 16:22:43 +00001081 (py-next-statement -1)
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001082 (py-compute-indentation t)))
Barry Warsaw0c6563f1995-09-14 20:57:02 +00001083 )
1084 (setq outdent py-indent-offset))
Barry Warsaw41a05c71998-08-10 16:33:12 +00001085 ;; Don't indent, only dedent. This assumes that any lines
1086 ;; that are already dedented relative to
1087 ;; py-compute-indentation were put there on purpose. It's
1088 ;; highly annoying to have `:' indent for you. Use TAB, C-c
1089 ;; C-l or C-c C-r to adjust. TBD: Is there a better way to
1090 ;; determine this???
Barry Warsaw0c6563f1995-09-14 20:57:02 +00001091 (if (< (current-indentation) indent) nil
1092 (goto-char here)
1093 (beginning-of-line)
1094 (delete-horizontal-space)
1095 (indent-to (- indent outdent))
1096 )))))
Barry Warsawb91b7431995-03-14 15:55:20 +00001097
1098
Barry Warsawa97a3f31997-11-04 18:47:06 +00001099;; Python subprocess utilities and filters
1100(defun py-execute-file (proc filename)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001101 "Send to Python interpreter process PROC \"execfile('FILENAME')\".
1102Make that process's buffer visible and force display. Also make
1103comint believe the user typed this string so that
1104`kill-output-from-shell' does The Right Thing."
Barry Warsawa97a3f31997-11-04 18:47:06 +00001105 (let ((curbuf (current-buffer))
1106 (procbuf (process-buffer proc))
Barry Warsaw3c96f6f1998-08-20 19:44:51 +00001107; (comint-scroll-to-bottom-on-output t)
Barry Warsawa97a3f31997-11-04 18:47:06 +00001108 (msg (format "## working on region in file %s...\n" filename))
Barry Warsaw02e5f691998-09-24 23:48:40 +00001109 (cmd (format "execfile(r'%s')\n" filename)))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001110 (unwind-protect
Barry Warsaw3c96f6f1998-08-20 19:44:51 +00001111 (save-excursion
Barry Warsawa97a3f31997-11-04 18:47:06 +00001112 (set-buffer procbuf)
1113 (goto-char (point-max))
1114 (move-marker (process-mark proc) (point))
1115 (funcall (process-filter proc) proc msg))
1116 (set-buffer curbuf))
1117 (process-send-string proc cmd)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001118
Barry Warsaw3c96f6f1998-08-20 19:44:51 +00001119(defun py-comint-output-filter-function (string)
1120 "Watch output for Python prompt and exec next file waiting in queue.
1121This function is appropriate for `comint-output-filter-functions'."
Barry Warsaw014e0e21998-11-17 19:24:47 +00001122 ;; TBD: this should probably use split-string
Barry Warsaw4f94c731998-09-25 19:40:10 +00001123 (when (and (or (string-equal string ">>> ")
Barry Warsaw4f94c731998-09-25 19:40:10 +00001124 (and (>= (length string) 5)
1125 (string-equal (substring string -5) "\n>>> ")))
Barry Warsaw3c96f6f1998-08-20 19:44:51 +00001126 py-file-queue)
1127 (py-safe (delete-file (car py-file-queue)))
1128 (setq py-file-queue (cdr py-file-queue))
1129 (if py-file-queue
1130 (let ((pyproc (get-buffer-process (current-buffer))))
1131 (py-execute-file pyproc (car py-file-queue))))
1132 ))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001133
Barry Warsaw4f577d22001-04-11 20:23:17 +00001134(defun py-pdbtrack-overlay-arrow (activation)
1135 "Activate or de arrow at beginning-of-line in current buffer."
1136 ;; This was derived/simplified from edebug-overlay-arrow
1137 (cond (activation
1138 (setq overlay-arrow-position (make-marker))
1139 (setq overlay-arrow-string "=>")
1140 (set-marker overlay-arrow-position (py-point 'bol) (current-buffer))
1141 (setq py-pdbtrack-is-tracking-p t))
1142 (overlay-arrow-position
1143 (setq overlay-arrow-position nil)
1144 (setq py-pdbtrack-is-tracking-p nil))
1145 ))
1146
1147(defun py-pdbtrack-track-stack-file (text)
1148 "Show the file indicated by the pdb stack entry line, in a separate window.
1149
1150Activity is disabled if the buffer-local variable
1151`py-pdbtrack-do-tracking-p' is nil.
1152
1153We depend on the pdb input prompt matching `py-pdbtrack-input-prompt'
1154at the beginning of the line."
1155 ;; Instead of trying to piece things together from partial text
1156 ;; (which can be almost useless depending on Emacs version), we
1157 ;; monitor to the point where we have the next pdb prompt, and then
1158 ;; check all text from comint-last-input-end to process-mark.
1159 ;;
1160 ;; KLM: It might be nice to provide an optional override, so this
1161 ;; routine could be fed debugger output strings as the text
1162 ;; argument, for deliberate application elsewhere.
1163 ;;
1164 ;; KLM: We're very conservative about clearing the overlay arrow, to
1165 ;; minimize residue. This means, for instance, that executing other
1166 ;; pdb commands wipes out the highlight.
1167 (let* ((origbuf (current-buffer))
1168 (currproc (get-buffer-process origbuf)))
1169 (if (not (and currproc py-pdbtrack-do-tracking-p))
1170 (py-pdbtrack-overlay-arrow nil)
1171 (let* (;(origdir default-directory)
1172 (procmark (process-mark currproc))
1173 (block (buffer-substring (max comint-last-input-end
1174 (- procmark
1175 py-pdbtrack-track-range))
1176 procmark))
1177 fname lineno)
1178 (if (not (string-match (concat py-pdbtrack-input-prompt "$") block))
1179 (py-pdbtrack-overlay-arrow nil)
1180 (if (not (string-match
1181 (concat ".*" py-pdbtrack-stack-entry-regexp ".*")
1182 block))
1183 (py-pdbtrack-overlay-arrow nil)
1184 (setq fname (match-string 1 block)
1185 lineno (match-string 2 block))
1186 (if (file-exists-p fname)
1187 (progn
1188 (find-file-other-window fname)
1189 (goto-line (string-to-int lineno))
Barry Warsawc8c1a5b2001-04-11 22:27:41 +00001190 (message "pdbtrack: line %s, file %s" lineno fname)
Barry Warsaw4f577d22001-04-11 20:23:17 +00001191 (py-pdbtrack-overlay-arrow t)
1192 (pop-to-buffer origbuf t) )
1193 (if (= (elt fname 0) ?\<)
Barry Warsawc8c1a5b2001-04-11 22:27:41 +00001194 (message "pdbtrack: (Non-file source: '%s')" fname)
1195 (message "pdbtrack: File not found: %s" fname))
Barry Warsaw4f577d22001-04-11 20:23:17 +00001196 )))))))
1197
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001198(defun py-postprocess-output-buffer (buf)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001199 "Highlight exceptions found in BUF.
1200If an exception occurred return t, otherwise return nil. BUF must exist."
Barry Warsawf9b99f41998-03-26 16:08:59 +00001201 (let (line file bol err-p)
Barry Warsaw9981d221997-12-03 05:25:48 +00001202 (save-excursion
1203 (set-buffer buf)
1204 (beginning-of-buffer)
1205 (while (re-search-forward py-traceback-line-re nil t)
1206 (setq file (match-string 1)
1207 line (string-to-int (match-string 2))
1208 bol (py-point 'bol))
Barry Warsawf9b99f41998-03-26 16:08:59 +00001209 (py-highlight-line bol (py-point 'eol) file line)))
1210 (when (and py-jump-on-exception line)
1211 (beep)
1212 (py-jump-to-exception file line)
1213 (setq err-p t))
1214 err-p))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001215
Barry Warsaw9981d221997-12-03 05:25:48 +00001216
Barry Warsawa97a3f31997-11-04 18:47:06 +00001217
1218;;; Subprocess commands
1219
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001220;; only used when (memq 'broken-temp-names py-emacs-features)
1221(defvar py-serial-number 0)
1222(defvar py-exception-buffer nil)
1223(defconst py-output-buffer "*Python Output*")
Barry Warsawa2398801998-04-09 23:28:20 +00001224(make-variable-buffer-local 'py-output-buffer)
1225
1226;; for toggling between CPython and JPython
Barry Warsawaa384fd1999-02-16 23:36:16 +00001227(defvar py-which-shell nil)
Barry Warsawa2398801998-04-09 23:28:20 +00001228(defvar py-which-args py-python-command-args)
1229(defvar py-which-bufname "Python")
1230(make-variable-buffer-local 'py-which-shell)
1231(make-variable-buffer-local 'py-which-args)
1232(make-variable-buffer-local 'py-which-bufname)
1233
1234(defun py-toggle-shells (arg)
1235 "Toggles between the CPython and JPython shells.
Barry Warsaw11f21561999-07-28 21:59:43 +00001236
Barry Warsaw41a05c71998-08-10 16:33:12 +00001237With positive argument ARG (interactively \\[universal-argument]),
1238uses the CPython shell, with negative ARG uses the JPython shell, and
Barry Warsaw11f21561999-07-28 21:59:43 +00001239with a zero argument, toggles the shell.
1240
1241Programmatically, ARG can also be one of the symbols `cpython' or
1242`jpython', equivalent to positive arg and negative arg respectively."
Barry Warsawa2398801998-04-09 23:28:20 +00001243 (interactive "P")
1244 ;; default is to toggle
1245 (if (null arg)
1246 (setq arg 0))
Barry Warsaw11f21561999-07-28 21:59:43 +00001247 ;; preprocess arg
1248 (cond
1249 ((equal arg 0)
1250 ;; toggle
1251 (if (string-equal py-which-bufname "Python")
1252 (setq arg -1)
1253 (setq arg 1)))
1254 ((equal arg 'cpython) (setq arg 1))
1255 ((equal arg 'jpython) (setq arg -1)))
Barry Warsawa2398801998-04-09 23:28:20 +00001256 (let (msg)
1257 (cond
1258 ((< 0 arg)
1259 ;; set to CPython
1260 (setq py-which-shell py-python-command
1261 py-which-args py-python-command-args
1262 py-which-bufname "Python"
1263 msg "CPython"
1264 mode-name "Python"))
1265 ((> 0 arg)
1266 (setq py-which-shell py-jpython-command
1267 py-which-args py-jpython-command-args
1268 py-which-bufname "JPython"
1269 msg "JPython"
1270 mode-name "JPython"))
1271 )
Barry Warsawea609c11998-04-10 16:08:26 +00001272 (message "Using the %s shell" msg)
Barry Warsawa2398801998-04-09 23:28:20 +00001273 (setq py-output-buffer (format "*%s Output*" py-which-bufname))))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001274
Barry Warsawa97a3f31997-11-04 18:47:06 +00001275;;;###autoload
Barry Warsaw3b4e2f01999-02-16 23:52:46 +00001276(defun py-shell (&optional argprompt)
Barry Warsawa97a3f31997-11-04 18:47:06 +00001277 "Start an interactive Python interpreter in another window.
1278This is like Shell mode, except that Python is running in the window
1279instead of a shell. See the `Interactive Shell' and `Shell Mode'
1280sections of the Emacs manual for details, especially for the key
1281bindings active in the `*Python*' buffer.
1282
Barry Warsaw3b4e2f01999-02-16 23:52:46 +00001283With optional \\[universal-argument], the user is prompted for the
1284flags to pass to the Python interpreter. This has no effect when this
1285command is used to switch to an existing process, only when a new
1286process is started. If you use this, you will probably want to ensure
1287that the current arguments are retained (they will be included in the
1288prompt). This argument is ignored when this function is called
1289programmatically, or when running in Emacs 19.34 or older.
1290
Barry Warsawa2398801998-04-09 23:28:20 +00001291Note: You can toggle between using the CPython interpreter and the
1292JPython interpreter by hitting \\[py-toggle-shells]. This toggles
1293buffer local variables which control whether all your subshell
1294interactions happen to the `*JPython*' or `*Python*' buffers (the
1295latter is the name used for the CPython buffer).
1296
Barry Warsawa97a3f31997-11-04 18:47:06 +00001297Warning: Don't use an interactive Python if you change sys.ps1 or
1298sys.ps2 from their default values, or if you're running code that
1299prints `>>> ' or `... ' at the start of a line. `python-mode' can't
1300distinguish your output from Python's output, and assumes that `>>> '
1301at the start of a line is a prompt from Python. Similarly, the Emacs
1302Shell mode code assumes that both `>>> ' and `... ' at the start of a
1303line are Python prompts. Bad things can happen if you fool either
1304mode.
1305
1306Warning: If you do any editing *in* the process buffer *while* the
1307buffer is accepting output from Python, do NOT attempt to `undo' the
1308changes. Some of the output (nowhere near the parts you changed!) may
1309be lost if you do. This appears to be an Emacs bug, an unfortunate
1310interaction between undo and process filters; the same problem exists in
1311non-Python process buffers using the default (Emacs-supplied) process
1312filter."
Barry Warsaw3b4e2f01999-02-16 23:52:46 +00001313 (interactive "P")
Barry Warsaw50765ab1999-08-10 21:49:00 +00001314 ;; Set the default shell if not already set
1315 (when (null py-which-shell)
1316 (py-toggle-shells py-default-interpreter))
Barry Warsaw3b4e2f01999-02-16 23:52:46 +00001317 (let ((args py-which-args))
1318 (when (and argprompt
1319 (interactive-p)
1320 (fboundp 'split-string))
1321 ;; TBD: Perhaps force "-i" in the final list?
1322 (setq args (split-string
1323 (read-string (concat py-which-bufname
1324 " arguments: ")
1325 (concat
1326 (mapconcat 'identity py-which-args " ") " ")
1327 ))))
1328 (switch-to-buffer-other-window
1329 (apply 'make-comint py-which-bufname py-which-shell nil args))
1330 (make-local-variable 'comint-prompt-regexp)
1331 (setq comint-prompt-regexp "^>>> \\|^[.][.][.] \\|^(pdb) ")
1332 (add-hook 'comint-output-filter-functions
1333 'py-comint-output-filter-function)
Barry Warsaw4f577d22001-04-11 20:23:17 +00001334 ;; pdbtrack
1335 (add-hook 'comint-output-filter-functions 'py-pdbtrack-track-stack-file)
1336 (setq py-pdbtrack-do-tracking-p t)
Barry Warsaw3b4e2f01999-02-16 23:52:46 +00001337 (set-syntax-table py-mode-syntax-table)
1338 (use-local-map py-shell-map)
1339 ))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001340
Barry Warsawa97a3f31997-11-04 18:47:06 +00001341(defun py-clear-queue ()
1342 "Clear the queue of temporary files waiting to execute."
1343 (interactive)
1344 (let ((n (length py-file-queue)))
1345 (mapcar 'delete-file py-file-queue)
1346 (setq py-file-queue nil)
1347 (message "%d pending files de-queued." n)))
1348
Barry Warsaw820273d1998-05-19 15:54:45 +00001349
Barry Warsawa97a3f31997-11-04 18:47:06 +00001350(defun py-execute-region (start end &optional async)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001351 "Execute the region in a Python interpreter.
1352
Barry Warsawa97a3f31997-11-04 18:47:06 +00001353The region is first copied into a temporary file (in the directory
1354`py-temp-directory'). If there is no Python interpreter shell
1355running, this file is executed synchronously using
Barry Warsaw41a05c71998-08-10 16:33:12 +00001356`shell-command-on-region'. If the program is long running, use
1357\\[universal-argument] to run the command asynchronously in its own
1358buffer.
1359
1360When this function is used programmatically, arguments START and END
1361specify the region to execute, and optional third argument ASYNC, if
1362non-nil, specifies to run the command asynchronously in its own
1363buffer.
Barry Warsawa97a3f31997-11-04 18:47:06 +00001364
1365If the Python interpreter shell is running, the region is execfile()'d
1366in that shell. If you try to execute regions too quickly,
1367`python-mode' will queue them up and execute them one at a time when
1368it sees a `>>> ' prompt from Python. Each time this happens, the
1369process buffer is popped into a window (if it's not already in some
1370window) so you can see it, and a comment of the form
1371
1372 \t## working on region in file <name>...
1373
1374is inserted at the end. See also the command `py-clear-queue'."
1375 (interactive "r\nP")
1376 (or (< start end)
1377 (error "Region is empty"))
Barry Warsaw014e0e21998-11-17 19:24:47 +00001378 (let* ((proc (get-process py-which-bufname))
Barry Warsaw5e21cb01997-11-05 18:41:11 +00001379 (temp (if (memq 'broken-temp-names py-emacs-features)
Barry Warsaw1b344241998-08-07 22:24:16 +00001380 (let
1381 ((sn py-serial-number)
1382 (pid (and (fboundp 'emacs-pid) (emacs-pid))))
1383 (setq py-serial-number (1+ py-serial-number))
1384 (if pid
1385 (format "python-%d-%d" sn pid)
1386 (format "python-%d" sn)))
Barry Warsaw2f32fbb1998-02-25 16:45:43 +00001387 (make-temp-name "python-")))
Barry Warsawb2d5e622002-04-22 15:29:27 +00001388 (file (concat (expand-file-name temp py-temp-directory) ".py"))
Barry Warsawcaee2fe2000-05-23 05:47:43 +00001389 (cur (current-buffer))
Barry Warsawb2d5e622002-04-22 15:29:27 +00001390 (buf (get-buffer-create file))
1391 shell)
Barry Warsawcaee2fe2000-05-23 05:47:43 +00001392 ;; Write the contents of the buffer, watching out for indented regions.
1393 (save-excursion
1394 (goto-char start)
Barry Warsaw99eadf42000-06-23 20:24:25 +00001395 (let ((needs-if (/= (py-point 'bol) (py-point 'boi))))
Barry Warsawcaee2fe2000-05-23 05:47:43 +00001396 (set-buffer buf)
Barry Warsawb2d5e622002-04-22 15:29:27 +00001397 (python-mode)
Barry Warsaw99eadf42000-06-23 20:24:25 +00001398 (when needs-if
1399 (insert "if 1:\n"))
Barry Warsawa0113cd2002-04-22 16:23:29 +00001400 (insert-buffer-substring cur start end)
1401 ;; Set the shell either to the #! line command, or to the
1402 ;; py-which-shell buffer local variable.
1403 (goto-char (point-min))
1404 (if (looking-at "^#!\\s *\\(.*\\)$")
1405 (setq shell (match-string 1))
1406 ;; No useable #! line
1407 (setq shell py-which-shell))))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001408 (cond
Barry Warsaw145ab1c1998-05-19 14:49:49 +00001409 ;; always run the code in its own asynchronous subprocess
Barry Warsawa97a3f31997-11-04 18:47:06 +00001410 (async
Barry Warsawcaee2fe2000-05-23 05:47:43 +00001411 ;; User explicitly wants this to run in its own async subprocess
1412 (save-excursion
1413 (set-buffer buf)
1414 (write-region (point-min) (point-max) file nil 'nomsg))
Barry Warsaw34d83171998-11-20 03:04:07 +00001415 (let* ((buf (generate-new-buffer-name py-output-buffer))
1416 ;; TBD: a horrible hack, but why create new Custom variables?
1417 (arg (if (string-equal py-which-bufname "Python")
1418 "-u" "")))
Barry Warsawb2d5e622002-04-22 15:29:27 +00001419 (start-process py-which-bufname buf shell arg file)
Barry Warsawa97a3f31997-11-04 18:47:06 +00001420 (pop-to-buffer buf)
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001421 (py-postprocess-output-buffer buf)
Barry Warsawcaee2fe2000-05-23 05:47:43 +00001422 ;; TBD: clean up the temporary file!
Barry Warsawa97a3f31997-11-04 18:47:06 +00001423 ))
1424 ;; if the Python interpreter shell is running, queue it up for
1425 ;; execution there.
1426 (proc
1427 ;; use the existing python shell
Barry Warsawcaee2fe2000-05-23 05:47:43 +00001428 (save-excursion
1429 (set-buffer buf)
1430 (write-region (point-min) (point-max) file nil 'nomsg))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001431 (if (not py-file-queue)
1432 (py-execute-file proc file)
Barry Warsawa97a3f31997-11-04 18:47:06 +00001433 (message "File %s queued for execution" file))
Barry Warsaw3c96f6f1998-08-20 19:44:51 +00001434 (setq py-file-queue (append py-file-queue (list file)))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001435 (setq py-exception-buffer (cons file (current-buffer))))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001436 (t
Barry Warsawa0113cd2002-04-22 16:23:29 +00001437 ;; TBD: a horrible hack, but why create new Custom variables?
1438 (let ((cmd (concat shell (if (string-equal py-which-bufname "JPython")
1439 " -" ""))))
Barry Warsaw34d83171998-11-20 03:04:07 +00001440 ;; otherwise either run it synchronously in a subprocess
Barry Warsawcaee2fe2000-05-23 05:47:43 +00001441 (save-excursion
1442 (set-buffer buf)
1443 (shell-command-on-region (point-min) (point-max)
1444 cmd py-output-buffer))
Barry Warsaw34d83171998-11-20 03:04:07 +00001445 ;; shell-command-on-region kills the output buffer if it never
1446 ;; existed and there's no output from the command
1447 (if (not (get-buffer py-output-buffer))
1448 (message "No output.")
1449 (setq py-exception-buffer (current-buffer))
1450 (let ((err-p (py-postprocess-output-buffer py-output-buffer)))
1451 (pop-to-buffer py-output-buffer)
1452 (if err-p
1453 (pop-to-buffer py-exception-buffer)))
Barry Warsawcaee2fe2000-05-23 05:47:43 +00001454 ))
Barry Warsaw29a90f02002-04-22 21:48:20 +00001455 ))
Barry Warsaw71534602001-02-20 23:07:56 +00001456 ;; Clean up after ourselves.
1457 (kill-buffer buf)))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001458
Barry Warsaw820273d1998-05-19 15:54:45 +00001459
1460;; Code execution commands
Barry Warsawa97a3f31997-11-04 18:47:06 +00001461(defun py-execute-buffer (&optional async)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001462 "Send the contents of the buffer to a Python interpreter.
Barry Warsawc0ecb531998-01-20 21:43:34 +00001463If the file local variable `py-master-file' is non-nil, execute the
1464named file instead of the buffer's file.
1465
Barry Warsaw7ae77681994-12-12 20:38:05 +00001466If there is a *Python* process buffer it is used. If a clipping
1467restriction is in effect, only the accessible portion of the buffer is
1468sent. A trailing newline will be supplied if needed.
1469
Barry Warsaw41a05c71998-08-10 16:33:12 +00001470See the `\\[py-execute-region]' docs for an account of some
1471subtleties, including the use of the optional ASYNC argument."
Barry Warsawa97a3f31997-11-04 18:47:06 +00001472 (interactive "P")
Barry Warsawc0ecb531998-01-20 21:43:34 +00001473 (if py-master-file
1474 (let* ((filename (expand-file-name py-master-file))
1475 (buffer (or (get-file-buffer filename)
1476 (find-file-noselect filename))))
1477 (set-buffer buffer)))
Barry Warsawa97a3f31997-11-04 18:47:06 +00001478 (py-execute-region (point-min) (point-max) async))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001479
Barry Warsaw820273d1998-05-19 15:54:45 +00001480(defun py-execute-import-or-reload (&optional async)
1481 "Import the current buffer's file in a Python interpreter.
1482
1483If the file has already been imported, then do reload instead to get
Barry Warsaw7c29b231998-07-07 17:45:38 +00001484the latest version.
1485
1486If the file's name does not end in \".py\", then do execfile instead.
1487
1488If the current buffer is not visiting a file, do `py-execute-buffer'
1489instead.
1490
1491If the file local variable `py-master-file' is non-nil, import or
1492reload the named file instead of the buffer's file. The file may be
1493saved based on the value of `py-execute-import-or-reload-save-p'.
Barry Warsaw820273d1998-05-19 15:54:45 +00001494
Barry Warsaw41a05c71998-08-10 16:33:12 +00001495See the `\\[py-execute-region]' docs for an account of some
1496subtleties, including the use of the optional ASYNC argument.
Barry Warsaw820273d1998-05-19 15:54:45 +00001497
Barry Warsaw7c29b231998-07-07 17:45:38 +00001498This may be preferable to `\\[py-execute-buffer]' because:
Barry Warsaw820273d1998-05-19 15:54:45 +00001499
1500 - Definitions stay in their module rather than appearing at top
1501 level, where they would clutter the global namespace and not affect
1502 uses of qualified names (MODULE.NAME).
1503
1504 - The Python debugger gets line number information about the functions."
1505 (interactive "P")
1506 ;; Check file local variable py-master-file
1507 (if py-master-file
1508 (let* ((filename (expand-file-name py-master-file))
1509 (buffer (or (get-file-buffer filename)
1510 (find-file-noselect filename))))
1511 (set-buffer buffer)))
1512 (let ((file (buffer-file-name (current-buffer))))
1513 (if file
1514 (progn
Barry Warsaw3bfed5b1998-05-19 16:25:04 +00001515 ;; Maybe save some buffers
1516 (save-some-buffers (not py-ask-about-save) nil)
Barry Warsaw820273d1998-05-19 15:54:45 +00001517 (py-execute-string
1518 (if (string-match "\\.py$" file)
1519 (let ((f (file-name-sans-extension
1520 (file-name-nondirectory file))))
1521 (format "if globals().has_key('%s'):\n reload(%s)\nelse:\n import %s\n"
1522 f f f))
Barry Warsaw02e5f691998-09-24 23:48:40 +00001523 (format "execfile(r'%s')\n" file))
Barry Warsaw820273d1998-05-19 15:54:45 +00001524 async))
1525 ;; else
1526 (py-execute-buffer async))))
1527
1528
1529(defun py-execute-def-or-class (&optional async)
1530 "Send the current function or class definition to a Python interpreter.
1531
1532If there is a *Python* process buffer it is used.
1533
Barry Warsaw41a05c71998-08-10 16:33:12 +00001534See the `\\[py-execute-region]' docs for an account of some
1535subtleties, including the use of the optional ASYNC argument."
Barry Warsaw820273d1998-05-19 15:54:45 +00001536 (interactive "P")
1537 (save-excursion
1538 (py-mark-def-or-class)
1539 ;; mark is before point
1540 (py-execute-region (mark) (point) async)))
1541
1542
1543(defun py-execute-string (string &optional async)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001544 "Send the argument STRING to a Python interpreter.
Barry Warsaw820273d1998-05-19 15:54:45 +00001545
1546If there is a *Python* process buffer it is used.
1547
Barry Warsaw41a05c71998-08-10 16:33:12 +00001548See the `\\[py-execute-region]' docs for an account of some
1549subtleties, including the use of the optional ASYNC argument."
Barry Warsaw820273d1998-05-19 15:54:45 +00001550 (interactive "sExecute Python command: ")
1551 (save-excursion
1552 (set-buffer (get-buffer-create
1553 (generate-new-buffer-name " *Python Command*")))
1554 (insert string)
1555 (py-execute-region (point-min) (point-max) async)))
1556
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001557
1558
1559(defun py-jump-to-exception (file line)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001560 "Jump to the Python code in FILE at LINE."
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001561 (let ((buffer (cond ((string-equal file "<stdin>")
Barry Warsawebc7b7a1998-05-19 15:01:06 +00001562 (if (consp py-exception-buffer)
1563 (cdr py-exception-buffer)
1564 py-exception-buffer))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001565 ((and (consp py-exception-buffer)
1566 (string-equal file (car py-exception-buffer)))
1567 (cdr py-exception-buffer))
1568 ((py-safe (find-file-noselect file)))
1569 ;; could not figure out what file the exception
1570 ;; is pointing to, so prompt for it
1571 (t (find-file (read-file-name "Exception file: "
1572 nil
1573 file t))))))
1574 (pop-to-buffer buffer)
Barry Warsawebc7b7a1998-05-19 15:01:06 +00001575 ;; Force Python mode
Barry Warsaw820273d1998-05-19 15:54:45 +00001576 (if (not (eq major-mode 'python-mode))
Barry Warsawebc7b7a1998-05-19 15:01:06 +00001577 (python-mode))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001578 (goto-line line)
1579 (message "Jumping to exception in file %s on line %d" file line)))
1580
1581(defun py-mouseto-exception (event)
Barry Warsaw12c92941998-08-10 21:44:37 +00001582 "Jump to the code which caused the Python exception at EVENT.
Barry Warsaw41a05c71998-08-10 16:33:12 +00001583EVENT is usually a mouse click."
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001584 (interactive "e")
1585 (cond
1586 ((fboundp 'event-point)
1587 ;; XEmacs
1588 (let* ((point (event-point event))
1589 (buffer (event-buffer event))
1590 (e (and point buffer (extent-at point buffer 'py-exc-info)))
1591 (info (and e (extent-property e 'py-exc-info))))
1592 (message "Event point: %d, info: %s" point info)
1593 (and info
1594 (py-jump-to-exception (car info) (cdr info)))
1595 ))
1596 ;; Emacs -- Please port this!
1597 ))
1598
1599(defun py-goto-exception ()
1600 "Go to the line indicated by the traceback."
1601 (interactive)
1602 (let (file line)
1603 (save-excursion
1604 (beginning-of-line)
1605 (if (looking-at py-traceback-line-re)
1606 (setq file (match-string 1)
1607 line (string-to-int (match-string 2)))))
1608 (if (not file)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001609 (error "Not on a traceback line"))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001610 (py-jump-to-exception file line)))
1611
1612(defun py-find-next-exception (start buffer searchdir errwhere)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001613 "Find the next Python exception and jump to the code that caused it.
1614START is the buffer position in BUFFER from which to begin searching
1615for an exception. SEARCHDIR is a function, either
1616`re-search-backward' or `re-search-forward' indicating the direction
1617to search. ERRWHERE is used in an error message if the limit (top or
1618bottom) of the trackback stack is encountered."
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001619 (let (file line)
1620 (save-excursion
1621 (set-buffer buffer)
1622 (goto-char (py-point start))
1623 (if (funcall searchdir py-traceback-line-re nil t)
1624 (setq file (match-string 1)
1625 line (string-to-int (match-string 2)))))
1626 (if (and file line)
1627 (py-jump-to-exception file line)
1628 (error "%s of traceback" errwhere))))
1629
1630(defun py-down-exception (&optional bottom)
1631 "Go to the next line down in the traceback.
Barry Warsaw41a05c71998-08-10 16:33:12 +00001632With \\[univeral-argument] (programmatically, optional argument
1633BOTTOM), jump to the bottom (innermost) exception in the exception
1634stack."
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001635 (interactive "P")
1636 (let* ((proc (get-process "Python"))
1637 (buffer (if proc "*Python*" py-output-buffer)))
1638 (if bottom
1639 (py-find-next-exception 'eob buffer 're-search-backward "Bottom")
1640 (py-find-next-exception 'eol buffer 're-search-forward "Bottom"))))
1641
1642(defun py-up-exception (&optional top)
1643 "Go to the previous line up in the traceback.
Barry Warsaw41a05c71998-08-10 16:33:12 +00001644With \\[universal-argument] (programmatically, optional argument TOP)
1645jump to the top (outermost) exception in the exception stack."
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001646 (interactive "P")
1647 (let* ((proc (get-process "Python"))
1648 (buffer (if proc "*Python*" py-output-buffer)))
1649 (if top
1650 (py-find-next-exception 'bob buffer 're-search-forward "Top")
Barry Warsawffbc17d1997-11-27 20:08:14 +00001651 (py-find-next-exception 'bol buffer 're-search-backward "Top"))))
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001652
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001653
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001654;; Electric deletion
1655(defun py-electric-backspace (arg)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001656 "Delete preceding character or levels of indentation.
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001657Deletion is performed by calling the function in `py-backspace-function'
Barry Warsawb0539931996-12-17 22:05:07 +00001658with a single argument (the number of characters to delete).
Barry Warsaw7ae77681994-12-12 20:38:05 +00001659
Barry Warsaw41a05c71998-08-10 16:33:12 +00001660If point is at the leftmost column, delete the preceding newline.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001661
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001662Otherwise, if point is at the leftmost non-whitespace character of a
1663line that is neither a continuation line nor a non-indenting comment
1664line, or if point is at the end of a blank line, this command reduces
1665the indentation to match that of the line that opened the current
1666block of code. The line that opened the block is displayed in the
Barry Warsaw41a05c71998-08-10 16:33:12 +00001667echo area to help you keep track of where you are. With
1668\\[universal-argument] dedents that many blocks (but not past column
1669zero).
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001670
1671Otherwise the preceding character is deleted, converting a tab to
1672spaces if needed so that only a single column position is deleted.
Barry Warsawfa2def21999-05-24 21:43:37 +00001673\\[universal-argument] specifies how many characters to delete;
1674default is 1.
Barry Warsaw41a05c71998-08-10 16:33:12 +00001675
1676When used programmatically, argument ARG specifies the number of
1677blocks to dedent, or the number of characters to delete, as indicated
1678above."
Barry Warsaw03970731996-07-03 23:12:52 +00001679 (interactive "*p")
Barry Warsaw7ae77681994-12-12 20:38:05 +00001680 (if (or (/= (current-indentation) (current-column))
1681 (bolp)
1682 (py-continuation-line-p)
Barry Warsawfa2def21999-05-24 21:43:37 +00001683; (not py-honor-comment-indentation)
1684; (looking-at "#[^ \t\n]") ; non-indenting #
1685 )
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001686 (funcall py-backspace-function arg)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001687 ;; else indent the same as the colon line that opened the block
Barry Warsaw7ae77681994-12-12 20:38:05 +00001688 ;; force non-blank so py-goto-block-up doesn't ignore it
1689 (insert-char ?* 1)
1690 (backward-char)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001691 (let ((base-indent 0) ; indentation of base line
1692 (base-text "") ; and text of base line
1693 (base-found-p nil))
Barry Warsaw03970731996-07-03 23:12:52 +00001694 (save-excursion
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001695 (while (< 0 arg)
Barry Warsaw03970731996-07-03 23:12:52 +00001696 (condition-case nil ; in case no enclosing block
1697 (progn
1698 (py-goto-block-up 'no-mark)
1699 (setq base-indent (current-indentation)
1700 base-text (py-suck-up-leading-text)
1701 base-found-p t))
1702 (error nil))
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001703 (setq arg (1- arg))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001704 (delete-char 1) ; toss the dummy character
1705 (delete-horizontal-space)
1706 (indent-to base-indent)
1707 (if base-found-p
1708 (message "Closes block: %s" base-text)))))
1709
Barry Warsawfc8a01f1995-03-09 16:07:29 +00001710
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001711(defun py-electric-delete (arg)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001712 "Delete preceding or following character or levels of whitespace.
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001713
1714The behavior of this function depends on the variable
1715`delete-key-deletes-forward'. If this variable is nil (or does not
Barry Warsaw41a05c71998-08-10 16:33:12 +00001716exist, as in older Emacsen and non-XEmacs versions), then this
1717function behaves identically to \\[c-electric-backspace].
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001718
1719If `delete-key-deletes-forward' is non-nil and is supported in your
1720Emacs, then deletion occurs in the forward direction, by calling the
Barry Warsaw41a05c71998-08-10 16:33:12 +00001721function in `py-delete-function'.
1722
1723\\[universal-argument] (programmatically, argument ARG) specifies the
1724number of characters to delete (default is 1)."
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001725 (interactive "*p")
Barry Warsaw1d7b0fa1999-01-15 02:12:31 +00001726 (if (or (and (fboundp 'delete-forward-p) ;XEmacs 21
1727 (delete-forward-p))
1728 (and (boundp 'delete-key-deletes-forward) ;XEmacs 20
1729 delete-key-deletes-forward))
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001730 (funcall py-delete-function arg)
Barry Warsaw6d48c4a1997-11-04 19:21:50 +00001731 (py-electric-backspace arg)))
1732
1733;; required for pending-del and delsel modes
1734(put 'py-electric-backspace 'delete-selection 'supersede) ;delsel
1735(put 'py-electric-backspace 'pending-delete 'supersede) ;pending-del
1736(put 'py-electric-delete 'delete-selection 'supersede) ;delsel
1737(put 'py-electric-delete 'pending-delete 'supersede) ;pending-del
1738
1739
1740
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001741(defun py-indent-line (&optional arg)
1742 "Fix the indentation of the current line according to Python rules.
Barry Warsaw41a05c71998-08-10 16:33:12 +00001743With \\[universal-argument] (programmatically, the optional argument
1744ARG non-nil), ignore dedenting rules for block closing statements
1745(e.g. return, raise, break, continue, pass)
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001746
1747This function is normally bound to `indent-line-function' so
1748\\[indent-for-tab-command] will call it."
1749 (interactive "P")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001750 (let* ((ci (current-indentation))
1751 (move-to-indentation-p (<= (current-column) ci))
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001752 (need (py-compute-indentation (not arg))))
Barry Warsaw41a05c71998-08-10 16:33:12 +00001753 ;; see if we need to dedent
Barry Warsaw3874a3d1995-03-14 22:05:53 +00001754 (if (py-outdent-p)
Barry Warsaw0012c1e1995-03-14 16:32:55 +00001755 (setq need (- need py-indent-offset)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001756 (if (/= ci need)
1757 (save-excursion
1758 (beginning-of-line)
1759 (delete-horizontal-space)
1760 (indent-to need)))
1761 (if move-to-indentation-p (back-to-indentation))))
1762
1763(defun py-newline-and-indent ()
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001764 "Strives to act like the Emacs `newline-and-indent'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001765This is just `strives to' because correct indentation can't be computed
1766from scratch for Python code. In general, deletes the whitespace before
1767point, inserts a newline, and takes an educated guess as to how you want
1768the new line indented."
1769 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001770 (let ((ci (current-indentation)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001771 (if (< ci (current-column)) ; if point beyond indentation
1772 (newline-and-indent)
1773 ;; else try to act like newline-and-indent "normally" acts
1774 (beginning-of-line)
1775 (insert-char ?\n 1)
1776 (move-to-column ci))))
1777
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001778(defun py-compute-indentation (honor-block-close-p)
Barry Warsaw41a05c71998-08-10 16:33:12 +00001779 "Compute Python indentation.
1780When HONOR-BLOCK-CLOSE-P is non-nil, statements such as `return',
1781`raise', `break', `continue', and `pass' force one level of
1782dedenting."
Barry Warsaw7ae77681994-12-12 20:38:05 +00001783 (save-excursion
Barry Warsawf64b4051998-02-12 16:52:14 +00001784 (beginning-of-line)
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001785 (let* ((bod (py-point 'bod))
Barry Warsaw3b3ff4e1997-11-26 20:58:48 +00001786 (pps (parse-partial-sexp bod (point)))
Barry Warsaw9c1696c1998-12-15 04:36:22 +00001787 (boipps (parse-partial-sexp bod (py-point 'boi)))
1788 placeholder)
Barry Warsaw095e9c61995-09-19 20:01:42 +00001789 (cond
Barry Warsawa0ee8cd1997-11-26 01:04:44 +00001790 ;; are we inside a multi-line string or comment?
Barry Warsaw3b3ff4e1997-11-26 20:58:48 +00001791 ((or (and (nth 3 pps) (nth 3 boipps))
1792 (and (nth 4 pps) (nth 4 boipps)))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001793 (save-excursion
1794 (if (not py-align-multiline-strings-p) 0
1795 ;; skip back over blank & non-indenting comment lines
1796 ;; note: will skip a blank or non-indenting comment line
1797 ;; that happens to be a continuation line too
1798 (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#[ \t\n]\\)" nil 'move)
1799 (back-to-indentation)
1800 (current-column))))
1801 ;; are we on a continuation line?
1802 ((py-continuation-line-p)
1803 (let ((startpos (point))
1804 (open-bracket-pos (py-nesting-level))
Barry Warsawce60bc71996-08-01 18:17:14 +00001805 endpos searching found state)
Barry Warsaw095e9c61995-09-19 20:01:42 +00001806 (if open-bracket-pos
1807 (progn
1808 ;; align with first item in list; else a normal
1809 ;; indent beyond the line with the open bracket
1810 (goto-char (1+ open-bracket-pos)) ; just beyond bracket
1811 ;; is the first list item on the same line?
1812 (skip-chars-forward " \t")
1813 (if (null (memq (following-char) '(?\n ?# ?\\)))
1814 ; yes, so line up with it
1815 (current-column)
1816 ;; first list item on another line, or doesn't exist yet
1817 (forward-line 1)
1818 (while (and (< (point) startpos)
1819 (looking-at "[ \t]*[#\n\\\\]")) ; skip noise
1820 (forward-line 1))
Barry Warsaw92166d91998-04-01 21:59:41 +00001821 (if (and (< (point) startpos)
1822 (/= startpos
1823 (save-excursion
1824 (goto-char (1+ open-bracket-pos))
Barry Warsaw77d1fce1998-04-16 20:04:59 +00001825 (forward-comment (point-max))
Barry Warsaw92166d91998-04-01 21:59:41 +00001826 (point))))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001827 ;; again mimic the first list item
1828 (current-indentation)
1829 ;; else they're about to enter the first item
1830 (goto-char open-bracket-pos)
Barry Warsaw9c1696c1998-12-15 04:36:22 +00001831 (setq placeholder (point))
1832 (py-goto-initial-line)
1833 (py-goto-beginning-of-tqs
1834 (save-excursion (nth 3 (parse-partial-sexp
1835 placeholder (point)))))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001836 (+ (current-indentation) py-indent-offset))))
1837
1838 ;; else on backslash continuation line
1839 (forward-line -1)
1840 (if (py-continuation-line-p) ; on at least 3rd line in block
1841 (current-indentation) ; so just continue the pattern
1842 ;; else started on 2nd line in block, so indent more.
1843 ;; if base line is an assignment with a start on a RHS,
1844 ;; indent to 2 beyond the leftmost "="; else skip first
1845 ;; chunk of non-whitespace characters on base line, + 1 more
1846 ;; column
1847 (end-of-line)
Barry Warsawfd4c9e82001-06-18 23:40:35 +00001848 (setq endpos (point)
1849 searching t)
Barry Warsaw095e9c61995-09-19 20:01:42 +00001850 (back-to-indentation)
1851 (setq startpos (point))
1852 ;; look at all "=" from left to right, stopping at first
1853 ;; one not nested in a list or string
1854 (while searching
1855 (skip-chars-forward "^=" endpos)
1856 (if (= (point) endpos)
1857 (setq searching nil)
1858 (forward-char 1)
1859 (setq state (parse-partial-sexp startpos (point)))
1860 (if (and (zerop (car state)) ; not in a bracket
1861 (null (nth 3 state))) ; & not in a string
1862 (progn
1863 (setq searching nil) ; done searching in any case
1864 (setq found
1865 (not (or
1866 (eq (following-char) ?=)
1867 (memq (char-after (- (point) 2))
1868 '(?< ?> ?!)))))))))
1869 (if (or (not found) ; not an assignment
1870 (looking-at "[ \t]*\\\\")) ; <=><spaces><backslash>
1871 (progn
1872 (goto-char startpos)
1873 (skip-chars-forward "^ \t\n")))
Barry Warsaw40fb4522001-07-06 20:07:13 +00001874 ;; if this is a continuation for a block opening
1875 ;; statement, add some extra offset.
1876 (+ (current-column) (if (py-statement-opens-block-p)
1877 py-continuation-offset 0)
1878 1)
Barry Warsawfd4c9e82001-06-18 23:40:35 +00001879 ))))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001880
1881 ;; not on a continuation line
Barry Warsawa7891711996-08-01 15:53:09 +00001882 ((bobp) (current-indentation))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001883
Barry Warsawa7891711996-08-01 15:53:09 +00001884 ;; Dfn: "Indenting comment line". A line containing only a
1885 ;; comment, but which is treated like a statement for
1886 ;; indentation calculation purposes. Such lines are only
1887 ;; treated specially by the mode; they are not treated
1888 ;; specially by the Python interpreter.
1889
1890 ;; The rules for indenting comment lines are a line where:
1891 ;; - the first non-whitespace character is `#', and
1892 ;; - the character following the `#' is whitespace, and
Barry Warsaw41a05c71998-08-10 16:33:12 +00001893 ;; - the line is dedented with respect to (i.e. to the left
Barry Warsawa7891711996-08-01 15:53:09 +00001894 ;; of) the indentation of the preceding non-blank line.
1895
1896 ;; The first non-blank line following an indenting comment
1897 ;; line is given the same amount of indentation as the
1898 ;; indenting comment line.
1899
1900 ;; All other comment-only lines are ignored for indentation
1901 ;; purposes.
1902
1903 ;; Are we looking at a comment-only line which is *not* an
Barry Warsaw145ab1c1998-05-19 14:49:49 +00001904 ;; indenting comment line? If so, we assume that it's been
Barry Warsawa7891711996-08-01 15:53:09 +00001905 ;; placed at the desired indentation, so leave it alone.
1906 ;; Indenting comment lines are aligned as statements down
1907 ;; below.
1908 ((and (looking-at "[ \t]*#[^ \t\n]")
1909 ;; NOTE: this test will not be performed in older Emacsen
1910 (fboundp 'forward-comment)
1911 (<= (current-indentation)
1912 (save-excursion
1913 (forward-comment (- (point-max)))
1914 (current-indentation))))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001915 (current-indentation))
1916
1917 ;; else indentation based on that of the statement that
1918 ;; precedes us; use the first line of that statement to
1919 ;; establish the base, in case the user forced a non-std
1920 ;; indentation for the continuation lines (if any)
1921 (t
Barry Warsawc01c5c81995-09-14 18:49:11 +00001922 ;; skip back over blank & non-indenting comment lines note:
1923 ;; will skip a blank or non-indenting comment line that
Barry Warsawfd0fb381996-03-04 17:15:40 +00001924 ;; happens to be a continuation line too. use fast Emacs 19
1925 ;; function if it's there.
Barry Warsaw6d627751996-03-06 18:41:38 +00001926 (if (and (eq py-honor-comment-indentation nil)
Barry Warsaw33d6ec01996-03-05 16:28:07 +00001927 (fboundp 'forward-comment))
Barry Warsawfd0fb381996-03-04 17:15:40 +00001928 (forward-comment (- (point-max)))
Barry Warsaw218eb751998-09-22 19:51:47 +00001929 (let ((prefix-re (concat py-block-comment-prefix "[ \t]*"))
1930 done)
Barry Warsaw6d627751996-03-06 18:41:38 +00001931 (while (not done)
Barry Warsaw12c92941998-08-10 21:44:37 +00001932 (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#\\)" nil 'move)
1933 (setq done (or (bobp)
1934 (and (eq py-honor-comment-indentation t)
1935 (save-excursion
1936 (back-to-indentation)
Barry Warsaw218eb751998-09-22 19:51:47 +00001937 (not (looking-at prefix-re))
Barry Warsaw12c92941998-08-10 21:44:37 +00001938 ))
1939 (and (not (eq py-honor-comment-indentation t))
1940 (save-excursion
1941 (back-to-indentation)
Barry Warsawd36cfe42002-03-15 16:46:46 +00001942 (and (not (looking-at prefix-re))
1943 (or (looking-at "[^#]")
1944 (not (zerop (current-column)))
1945 ))
1946 ))
Barry Warsaw12c92941998-08-10 21:44:37 +00001947 ))
Barry Warsaw6d627751996-03-06 18:41:38 +00001948 )))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001949 ;; if we landed inside a string, go to the beginning of that
1950 ;; string. this handles triple quoted, multi-line spanning
1951 ;; strings.
Barry Warsaw9c1696c1998-12-15 04:36:22 +00001952 (py-goto-beginning-of-tqs (nth 3 (parse-partial-sexp bod (point))))
Barry Warsawc210e691998-01-20 22:52:56 +00001953 ;; now skip backward over continued lines
Barry Warsaw9c1696c1998-12-15 04:36:22 +00001954 (setq placeholder (point))
Barry Warsaw095e9c61995-09-19 20:01:42 +00001955 (py-goto-initial-line)
Barry Warsaw9c1696c1998-12-15 04:36:22 +00001956 ;; we may *now* have landed in a TQS, so find the beginning of
1957 ;; this string.
1958 (py-goto-beginning-of-tqs
1959 (save-excursion (nth 3 (parse-partial-sexp
1960 placeholder (point)))))
Barry Warsawf831d811996-07-31 20:42:59 +00001961 (+ (current-indentation)
1962 (if (py-statement-opens-block-p)
1963 py-indent-offset
Barry Warsaw7cb505c1996-10-23 20:44:59 +00001964 (if (and honor-block-close-p (py-statement-closes-block-p))
Barry Warsawf831d811996-07-31 20:42:59 +00001965 (- py-indent-offset)
1966 0)))
1967 )))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00001968
1969(defun py-guess-indent-offset (&optional global)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001970 "Guess a good value for, and change, `py-indent-offset'.
Barry Warsaw41a05c71998-08-10 16:33:12 +00001971
1972By default, make a buffer-local copy of `py-indent-offset' with the
1973new value, so that other Python buffers are not affected. With
1974\\[universal-argument] (programmatically, optional argument GLOBAL),
1975change the global value of `py-indent-offset'. This affects all
1976Python buffers (that don't have their own buffer-local copy), both
1977those currently existing and those created later in the Emacs session.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001978
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001979Some people use a different value for `py-indent-offset' than you use.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001980There's no excuse for such foolishness, but sometimes you have to deal
1981with their ugly code anyway. This function examines the file and sets
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001982`py-indent-offset' to what it thinks it was when they created the
1983mess.
Barry Warsaw7ae77681994-12-12 20:38:05 +00001984
1985Specifically, it searches forward from the statement containing point,
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001986looking for a line that opens a block of code. `py-indent-offset' is
1987set to the difference in indentation between that line and the Python
Barry Warsaw7ae77681994-12-12 20:38:05 +00001988statement following it. If the search doesn't succeed going forward,
1989it's tried again going backward."
1990 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001991 (let (new-value
1992 (start (point))
Barry Warsawe908b6b1998-03-19 22:48:02 +00001993 (restart (point))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00001994 (found nil)
1995 colon-indent)
Barry Warsaw7ae77681994-12-12 20:38:05 +00001996 (py-goto-initial-line)
1997 (while (not (or found (eobp)))
Barry Warsawe908b6b1998-03-19 22:48:02 +00001998 (when (and (re-search-forward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
1999 (not (py-in-literal restart)))
2000 (setq restart (point))
2001 (py-goto-initial-line)
2002 (if (py-statement-opens-block-p)
2003 (setq found t)
2004 (goto-char restart))))
2005 (unless found
Barry Warsaw7ae77681994-12-12 20:38:05 +00002006 (goto-char start)
2007 (py-goto-initial-line)
2008 (while (not (or found (bobp)))
Barry Warsawe908b6b1998-03-19 22:48:02 +00002009 (setq found (and
2010 (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
2011 (or (py-goto-initial-line) t) ; always true -- side effect
2012 (py-statement-opens-block-p)))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002013 (setq colon-indent (current-indentation)
2014 found (and found (zerop (py-next-statement 1)))
2015 new-value (- (current-indentation) colon-indent))
2016 (goto-char start)
Barry Warsawe908b6b1998-03-19 22:48:02 +00002017 (if (not found)
2018 (error "Sorry, couldn't guess a value for py-indent-offset")
2019 (funcall (if global 'kill-local-variable 'make-local-variable)
2020 'py-indent-offset)
2021 (setq py-indent-offset new-value)
Barry Warsawd35c2551998-09-25 00:08:38 +00002022 (or noninteractive
2023 (message "%s value of py-indent-offset set to %d"
2024 (if global "Global" "Local")
2025 py-indent-offset)))
Barry Warsawe908b6b1998-03-19 22:48:02 +00002026 ))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002027
Barry Warsaw003932a1998-07-07 15:11:24 +00002028(defun py-comment-indent-function ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00002029 "Python version of `comment-indent-function'."
2030 ;; This is required when filladapt is turned off. Without it, when
2031 ;; filladapt is not used, comments which start in column zero
2032 ;; cascade one character to the right
Barry Warsaw003932a1998-07-07 15:11:24 +00002033 (save-excursion
2034 (beginning-of-line)
2035 (let ((eol (py-point 'eol)))
2036 (and comment-start-skip
2037 (re-search-forward comment-start-skip eol t)
2038 (setq eol (match-beginning 0)))
2039 (goto-char eol)
2040 (skip-chars-backward " \t")
2041 (max comment-column (+ (current-column) (if (bolp) 0 1)))
2042 )))
2043
Barry Warsawf8ddb6a1999-01-18 21:49:39 +00002044(defun py-narrow-to-defun (&optional class)
2045 "Make text outside current defun invisible.
2046The defun visible is the one that contains point or follows point.
2047Optional CLASS is passed directly to `py-beginning-of-def-or-class'."
2048 (interactive "P")
2049 (save-excursion
2050 (widen)
2051 (py-end-of-def-or-class class)
2052 (let ((end (point)))
2053 (py-beginning-of-def-or-class class)
2054 (narrow-to-region (point) end))))
2055
Barry Warsaw003932a1998-07-07 15:11:24 +00002056
Barry Warsaw7ae77681994-12-12 20:38:05 +00002057(defun py-shift-region (start end count)
Barry Warsaw41a05c71998-08-10 16:33:12 +00002058 "Indent lines from START to END by COUNT spaces."
Barry Warsaw7ae77681994-12-12 20:38:05 +00002059 (save-excursion
Barry Warsaw41a05c71998-08-10 16:33:12 +00002060 (goto-char end)
2061 (beginning-of-line)
2062 (setq end (point))
2063 (goto-char start)
2064 (beginning-of-line)
2065 (setq start (point))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002066 (indent-rigidly start end count)))
2067
2068(defun py-shift-region-left (start end &optional count)
2069 "Shift region of Python code to the left.
2070The lines from the line containing the start of the current region up
2071to (but not including) the line containing the end of the region are
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002072shifted to the left, by `py-indent-offset' columns.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002073
2074If a prefix argument is given, the region is instead shifted by that
Barry Warsaw41a05c71998-08-10 16:33:12 +00002075many columns. With no active region, dedent only the current line.
2076You cannot dedent the region if any line is already at column zero."
Barry Warsawdea4a291996-07-03 22:59:12 +00002077 (interactive
2078 (let ((p (point))
2079 (m (mark))
2080 (arg current-prefix-arg))
2081 (if m
2082 (list (min p m) (max p m) arg)
2083 (list p (save-excursion (forward-line 1) (point)) arg))))
2084 ;; if any line is at column zero, don't shift the region
2085 (save-excursion
2086 (goto-char start)
2087 (while (< (point) end)
2088 (back-to-indentation)
Barry Warsaw71e315b1996-07-23 15:03:16 +00002089 (if (and (zerop (current-column))
2090 (not (looking-at "\\s *$")))
Barry Warsaw41a05c71998-08-10 16:33:12 +00002091 (error "Region is at left edge"))
Barry Warsawdea4a291996-07-03 22:59:12 +00002092 (forward-line 1)))
2093 (py-shift-region start end (- (prefix-numeric-value
2094 (or count py-indent-offset))))
2095 (py-keep-region-active))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002096
2097(defun py-shift-region-right (start end &optional count)
2098 "Shift region of Python code to the right.
2099The lines from the line containing the start of the current region up
2100to (but not including) the line containing the end of the region are
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002101shifted to the right, by `py-indent-offset' columns.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002102
2103If a prefix argument is given, the region is instead shifted by that
Barry Warsawdea4a291996-07-03 22:59:12 +00002104many columns. With no active region, indent only the current line."
2105 (interactive
2106 (let ((p (point))
2107 (m (mark))
2108 (arg current-prefix-arg))
2109 (if m
2110 (list (min p m) (max p m) arg)
2111 (list p (save-excursion (forward-line 1) (point)) arg))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002112 (py-shift-region start end (prefix-numeric-value
Barry Warsawdea4a291996-07-03 22:59:12 +00002113 (or count py-indent-offset)))
2114 (py-keep-region-active))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002115
2116(defun py-indent-region (start end &optional indent-offset)
2117 "Reindent a region of Python code.
Barry Warsaw867a32a1996-03-07 18:30:26 +00002118
Barry Warsaw7ae77681994-12-12 20:38:05 +00002119The lines from the line containing the start of the current region up
2120to (but not including) the line containing the end of the region are
2121reindented. If the first line of the region has a non-whitespace
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002122character in the first column, the first line is left alone and the
2123rest of the region is reindented with respect to it. Else the entire
Barry Warsaw867a32a1996-03-07 18:30:26 +00002124region is reindented with respect to the (closest code or indenting
2125comment) statement immediately preceding the region.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002126
2127This is useful when code blocks are moved or yanked, when enclosing
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002128control structures are introduced or removed, or to reformat code
2129using a new value for the indentation offset.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002130
2131If a numeric prefix argument is given, it will be used as the value of
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002132the indentation offset. Else the value of `py-indent-offset' will be
Barry Warsaw7ae77681994-12-12 20:38:05 +00002133used.
2134
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002135Warning: The region must be consistently indented before this function
Barry Warsaw7ae77681994-12-12 20:38:05 +00002136is called! This function does not compute proper indentation from
2137scratch (that's impossible in Python), it merely adjusts the existing
2138indentation to be correct in context.
2139
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002140Warning: This function really has no idea what to do with
2141non-indenting comment lines, and shifts them as if they were indenting
2142comment lines. Fixing this appears to require telepathy.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002143
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002144Special cases: whitespace is deleted from blank lines; continuation
2145lines are shifted by the same amount their initial line was shifted,
2146in order to preserve their relative indentation with respect to their
Barry Warsaw7ae77681994-12-12 20:38:05 +00002147initial line; and comment lines beginning in column 1 are ignored."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002148 (interactive "*r\nP") ; region; raw prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00002149 (save-excursion
2150 (goto-char end) (beginning-of-line) (setq end (point-marker))
2151 (goto-char start) (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002152 (let ((py-indent-offset (prefix-numeric-value
2153 (or indent-offset py-indent-offset)))
2154 (indents '(-1)) ; stack of active indent levels
2155 (target-column 0) ; column to which to indent
2156 (base-shifted-by 0) ; amount last base line was shifted
2157 (indent-base (if (looking-at "[ \t\n]")
Barry Warsaw7cb505c1996-10-23 20:44:59 +00002158 (py-compute-indentation t)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002159 0))
2160 ci)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002161 (while (< (point) end)
2162 (setq ci (current-indentation))
2163 ;; figure out appropriate target column
2164 (cond
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002165 ((or (eq (following-char) ?#) ; comment in column 1
2166 (looking-at "[ \t]*$")) ; entirely blank
2167 (setq target-column 0))
2168 ((py-continuation-line-p) ; shift relative to base line
2169 (setq target-column (+ ci base-shifted-by)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002170 (t ; new base line
2171 (if (> ci (car indents)) ; going deeper; push it
2172 (setq indents (cons ci indents))
2173 ;; else we should have seen this indent before
2174 (setq indents (memq ci indents)) ; pop deeper indents
2175 (if (null indents)
2176 (error "Bad indentation in region, at line %d"
2177 (save-restriction
2178 (widen)
2179 (1+ (count-lines 1 (point)))))))
2180 (setq target-column (+ indent-base
2181 (* py-indent-offset
2182 (- (length indents) 2))))
2183 (setq base-shifted-by (- target-column ci))))
2184 ;; shift as needed
2185 (if (/= ci target-column)
2186 (progn
2187 (delete-horizontal-space)
2188 (indent-to target-column)))
2189 (forward-line 1))))
2190 (set-marker end nil))
2191
Barry Warsawa7891711996-08-01 15:53:09 +00002192(defun py-comment-region (beg end &optional arg)
2193 "Like `comment-region' but uses double hash (`#') comment starter."
2194 (interactive "r\nP")
Barry Warsaw3fcaf611996-08-01 20:11:51 +00002195 (let ((comment-start py-block-comment-prefix))
Barry Warsawa7891711996-08-01 15:53:09 +00002196 (comment-region beg end arg)))
2197
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002198
2199;; Functions for moving point
Barry Warsaw7ae77681994-12-12 20:38:05 +00002200(defun py-previous-statement (count)
Barry Warsaw41a05c71998-08-10 16:33:12 +00002201 "Go to the start of the COUNTth preceding Python statement.
2202By default, goes to the previous statement. If there is no such
2203statement, goes to the first statement. Return count of statements
2204left to move. `Statements' do not include blank, comment, or
2205continuation lines."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002206 (interactive "p") ; numeric prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00002207 (if (< count 0) (py-next-statement (- count))
2208 (py-goto-initial-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002209 (let (start)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002210 (while (and
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002211 (setq start (point)) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00002212 (> count 0)
2213 (zerop (forward-line -1))
2214 (py-goto-statement-at-or-above))
2215 (setq count (1- count)))
2216 (if (> count 0) (goto-char start)))
2217 count))
2218
2219(defun py-next-statement (count)
2220 "Go to the start of next Python statement.
2221If the statement at point is the i'th Python statement, goes to the
2222start of statement i+COUNT. If there is no such statement, goes to the
2223last statement. Returns count of statements left to move. `Statements'
2224do not include blank, comment, or continuation lines."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002225 (interactive "p") ; numeric prefix arg
Barry Warsaw7ae77681994-12-12 20:38:05 +00002226 (if (< count 0) (py-previous-statement (- count))
2227 (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002228 (let (start)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002229 (while (and
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002230 (setq start (point)) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00002231 (> count 0)
2232 (py-goto-statement-below))
2233 (setq count (1- count)))
2234 (if (> count 0) (goto-char start)))
2235 count))
2236
2237(defun py-goto-block-up (&optional nomark)
2238 "Move up to start of current block.
2239Go to the statement that starts the smallest enclosing block; roughly
2240speaking, this will be the closest preceding statement that ends with a
2241colon and is indented less than the statement you started on. If
2242successful, also sets the mark to the starting point.
2243
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002244`\\[py-mark-block]' can be used afterward to mark the whole code
2245block, if desired.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002246
2247If called from a program, the mark will not be set if optional argument
2248NOMARK is not nil."
2249 (interactive)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002250 (let ((start (point))
2251 (found nil)
2252 initial-indent)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002253 (py-goto-initial-line)
2254 ;; if on blank or non-indenting comment line, use the preceding stmt
2255 (if (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)")
2256 (progn
2257 (py-goto-statement-at-or-above)
2258 (setq found (py-statement-opens-block-p))))
2259 ;; search back for colon line indented less
2260 (setq initial-indent (current-indentation))
2261 (if (zerop initial-indent)
2262 ;; force fast exit
2263 (goto-char (point-min)))
2264 (while (not (or found (bobp)))
2265 (setq found
2266 (and
2267 (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move)
2268 (or (py-goto-initial-line) t) ; always true -- side effect
2269 (< (current-indentation) initial-indent)
2270 (py-statement-opens-block-p))))
2271 (if found
2272 (progn
2273 (or nomark (push-mark start))
2274 (back-to-indentation))
2275 (goto-char start)
2276 (error "Enclosing block not found"))))
2277
Barry Warsawab0e86c1998-05-19 15:31:46 +00002278(defun py-beginning-of-def-or-class (&optional class count)
2279 "Move point to start of `def' or `class'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002280
2281Searches back for the closest preceding `def'. If you supply a prefix
Barry Warsawab0e86c1998-05-19 15:31:46 +00002282arg, looks for a `class' instead. The docs below assume the `def'
2283case; just substitute `class' for `def' for the other case.
Barry Warsaw7c29b231998-07-07 17:45:38 +00002284Programmatically, if CLASS is `either', then moves to either `class'
2285or `def'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002286
Barry Warsawab0e86c1998-05-19 15:31:46 +00002287When second optional argument is given programmatically, move to the
2288COUNTth start of `def'.
2289
2290If point is in a `def' statement already, and after the `d', simply
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002291moves point to the start of the statement.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002292
Barry Warsawab0e86c1998-05-19 15:31:46 +00002293Otherwise (i.e. when point is not in a `def' statement, or at or
2294before the `d' of a `def' statement), searches for the closest
2295preceding `def' statement, and leaves point at its start. If no such
2296statement can be found, leaves point at the start of the buffer.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002297
Barry Warsawab0e86c1998-05-19 15:31:46 +00002298Returns t iff a `def' statement is found by these rules.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002299
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002300Note that doing this command repeatedly will take you closer to the
2301start of the buffer each time.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002302
Barry Warsaw7c29b231998-07-07 17:45:38 +00002303To mark the current `def', see `\\[py-mark-def-or-class]'."
Barry Warsaw7ae77681994-12-12 20:38:05 +00002304 (interactive "P") ; raw prefix arg
Barry Warsaw6839d3a1998-10-28 00:10:45 +00002305 (setq count (or count 1))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002306 (let ((at-or-before-p (<= (current-column) (current-indentation)))
Barry Warsawab0e86c1998-05-19 15:31:46 +00002307 (start-of-line (goto-char (py-point 'bol)))
2308 (start-of-stmt (goto-char (py-point 'bos)))
Barry Warsaw7c29b231998-07-07 17:45:38 +00002309 (start-re (cond ((eq class 'either) "^[ \t]*\\(class\\|def\\)\\>")
2310 (class "^[ \t]*class\\>")
2311 (t "^[ \t]*def\\>")))
Barry Warsawab0e86c1998-05-19 15:31:46 +00002312 )
2313 ;; searching backward
2314 (if (and (< 0 count)
2315 (or (/= start-of-stmt start-of-line)
2316 (not at-or-before-p)))
2317 (end-of-line))
2318 ;; search forward
2319 (if (and (> 0 count)
2320 (zerop (current-column))
2321 (looking-at start-re))
2322 (end-of-line))
Barry Warsawddc46961999-07-27 21:40:02 +00002323 (if (re-search-backward start-re nil 'move count)
2324 (goto-char (match-beginning 0)))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002325
Barry Warsawab0e86c1998-05-19 15:31:46 +00002326;; Backwards compatibility
2327(defalias 'beginning-of-python-def-or-class 'py-beginning-of-def-or-class)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002328
Barry Warsawab0e86c1998-05-19 15:31:46 +00002329(defun py-end-of-def-or-class (&optional class count)
2330 "Move point beyond end of `def' or `class' body.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002331
Barry Warsawab0e86c1998-05-19 15:31:46 +00002332By default, looks for an appropriate `def'. If you supply a prefix
2333arg, looks for a `class' instead. The docs below assume the `def'
2334case; just substitute `class' for `def' for the other case.
Barry Warsaw7c29b231998-07-07 17:45:38 +00002335Programmatically, if CLASS is `either', then moves to either `class'
2336or `def'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002337
Barry Warsawab0e86c1998-05-19 15:31:46 +00002338When second optional argument is given programmatically, move to the
2339COUNTth end of `def'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002340
Barry Warsawab0e86c1998-05-19 15:31:46 +00002341If point is in a `def' statement already, this is the `def' we use.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002342
Barry Warsawab0e86c1998-05-19 15:31:46 +00002343Else, if the `def' found by `\\[py-beginning-of-def-or-class]'
2344contains the statement you started on, that's the `def' we use.
2345
2346Otherwise, we search forward for the closest following `def', and use that.
2347
2348If a `def' can be found by these rules, point is moved to the start of
2349the line immediately following the `def' block, and the position of the
2350start of the `def' is returned.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002351
2352Else point is moved to the end of the buffer, and nil is returned.
2353
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002354Note that doing this command repeatedly will take you closer to the
2355end of the buffer each time.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002356
Barry Warsaw7c29b231998-07-07 17:45:38 +00002357To mark the current `def', see `\\[py-mark-def-or-class]'."
Barry Warsaw7ae77681994-12-12 20:38:05 +00002358 (interactive "P") ; raw prefix arg
Barry Warsawab0e86c1998-05-19 15:31:46 +00002359 (if (and count (/= count 1))
2360 (py-beginning-of-def-or-class (- 1 count)))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002361 (let ((start (progn (py-goto-initial-line) (point)))
Barry Warsaw7c29b231998-07-07 17:45:38 +00002362 (which (cond ((eq class 'either) "\\(class\\|def\\)")
2363 (class "class")
2364 (t "def")))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002365 (state 'not-found))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002366 ;; move point to start of appropriate def/class
2367 (if (looking-at (concat "[ \t]*" which "\\>")) ; already on one
2368 (setq state 'at-beginning)
Barry Warsawab0e86c1998-05-19 15:31:46 +00002369 ;; else see if py-beginning-of-def-or-class hits container
2370 (if (and (py-beginning-of-def-or-class class)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002371 (progn (py-goto-beyond-block)
2372 (> (point) start)))
2373 (setq state 'at-end)
2374 ;; else search forward
2375 (goto-char start)
2376 (if (re-search-forward (concat "^[ \t]*" which "\\>") nil 'move)
2377 (progn (setq state 'at-beginning)
2378 (beginning-of-line)))))
2379 (cond
2380 ((eq state 'at-beginning) (py-goto-beyond-block) t)
2381 ((eq state 'at-end) t)
2382 ((eq state 'not-found) nil)
Barry Warsaw41a05c71998-08-10 16:33:12 +00002383 (t (error "Internal error in `py-end-of-def-or-class'")))))
Barry Warsawab0e86c1998-05-19 15:31:46 +00002384
2385;; Backwards compabitility
Barry Warsaw820273d1998-05-19 15:54:45 +00002386(defalias 'end-of-python-def-or-class 'py-end-of-def-or-class)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002387
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002388
2389;; Functions for marking regions
Barry Warsaw7ae77681994-12-12 20:38:05 +00002390(defun py-mark-block (&optional extend just-move)
2391 "Mark following block of lines. With prefix arg, mark structure.
2392Easier to use than explain. It sets the region to an `interesting'
2393block of succeeding lines. If point is on a blank line, it goes down to
2394the next non-blank line. That will be the start of the region. The end
2395of the region depends on the kind of line at the start:
2396
2397 - If a comment, the region will include all succeeding comment lines up
2398 to (but not including) the next non-comment line (if any).
2399
2400 - Else if a prefix arg is given, and the line begins one of these
2401 structures:
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002402
2403 if elif else try except finally for while def class
2404
Barry Warsaw7ae77681994-12-12 20:38:05 +00002405 the region will be set to the body of the structure, including
2406 following blocks that `belong' to it, but excluding trailing blank
2407 and comment lines. E.g., if on a `try' statement, the `try' block
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002408 and all (if any) of the following `except' and `finally' blocks
2409 that belong to the `try' structure will be in the region. Ditto
2410 for if/elif/else, for/else and while/else structures, and (a bit
2411 degenerate, since they're always one-block structures) def and
2412 class blocks.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002413
2414 - Else if no prefix argument is given, and the line begins a Python
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002415 block (see list above), and the block is not a `one-liner' (i.e.,
2416 the statement ends with a colon, not with code), the region will
2417 include all succeeding lines up to (but not including) the next
2418 code statement (if any) that's indented no more than the starting
2419 line, except that trailing blank and comment lines are excluded.
2420 E.g., if the starting line begins a multi-statement `def'
2421 structure, the region will be set to the full function definition,
2422 but without any trailing `noise' lines.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002423
2424 - Else the region will include all succeeding lines up to (but not
2425 including) the next blank line, or code or indenting-comment line
2426 indented strictly less than the starting line. Trailing indenting
2427 comment lines are included in this case, but not trailing blank
2428 lines.
2429
2430A msg identifying the location of the mark is displayed in the echo
2431area; or do `\\[exchange-point-and-mark]' to flip down to the end.
2432
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002433If called from a program, optional argument EXTEND plays the role of
2434the prefix arg, and if optional argument JUST-MOVE is not nil, just
2435moves to the end of the block (& does not set mark or display a msg)."
Barry Warsaw7ae77681994-12-12 20:38:05 +00002436 (interactive "P") ; raw prefix arg
2437 (py-goto-initial-line)
2438 ;; skip over blank lines
2439 (while (and
2440 (looking-at "[ \t]*$") ; while blank line
2441 (not (eobp))) ; & somewhere to go
2442 (forward-line 1))
2443 (if (eobp)
2444 (error "Hit end of buffer without finding a non-blank stmt"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002445 (let ((initial-pos (point))
2446 (initial-indent (current-indentation))
2447 last-pos ; position of last stmt in region
2448 (followers
2449 '((if elif else) (elif elif else) (else)
2450 (try except finally) (except except) (finally)
2451 (for else) (while else)
2452 (def) (class) ) )
2453 first-symbol next-symbol)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002454
2455 (cond
2456 ;; if comment line, suck up the following comment lines
2457 ((looking-at "[ \t]*#")
2458 (re-search-forward "^[ \t]*[^ \t#]" nil 'move) ; look for non-comment
2459 (re-search-backward "^[ \t]*#") ; and back to last comment in block
2460 (setq last-pos (point)))
2461
2462 ;; else if line is a block line and EXTEND given, suck up
2463 ;; the whole structure
2464 ((and extend
2465 (setq first-symbol (py-suck-up-first-keyword) )
2466 (assq first-symbol followers))
2467 (while (and
2468 (or (py-goto-beyond-block) t) ; side effect
2469 (forward-line -1) ; side effect
2470 (setq last-pos (point)) ; side effect
2471 (py-goto-statement-below)
2472 (= (current-indentation) initial-indent)
2473 (setq next-symbol (py-suck-up-first-keyword))
2474 (memq next-symbol (cdr (assq first-symbol followers))))
2475 (setq first-symbol next-symbol)))
2476
2477 ;; else if line *opens* a block, search for next stmt indented <=
2478 ((py-statement-opens-block-p)
2479 (while (and
2480 (setq last-pos (point)) ; always true -- side effect
2481 (py-goto-statement-below)
2482 (> (current-indentation) initial-indent))
2483 nil))
2484
2485 ;; else plain code line; stop at next blank line, or stmt or
2486 ;; indenting comment line indented <
2487 (t
2488 (while (and
2489 (setq last-pos (point)) ; always true -- side effect
2490 (or (py-goto-beyond-final-line) t)
2491 (not (looking-at "[ \t]*$")) ; stop at blank line
2492 (or
2493 (>= (current-indentation) initial-indent)
2494 (looking-at "[ \t]*#[^ \t\n]"))) ; ignore non-indenting #
2495 nil)))
2496
2497 ;; skip to end of last stmt
2498 (goto-char last-pos)
2499 (py-goto-beyond-final-line)
2500
2501 ;; set mark & display
2502 (if just-move
2503 () ; just return
2504 (push-mark (point) 'no-msg)
2505 (forward-line -1)
2506 (message "Mark set after: %s" (py-suck-up-leading-text))
2507 (goto-char initial-pos))))
2508
Barry Warsaw2518c671997-11-05 00:51:08 +00002509(defun py-mark-def-or-class (&optional class)
Barry Warsaw7ae77681994-12-12 20:38:05 +00002510 "Set region to body of def (or class, with prefix arg) enclosing point.
2511Pushes the current mark, then point, on the mark ring (all language
2512modes do this, but although it's handy it's never documented ...).
2513
2514In most Emacs language modes, this function bears at least a
Barry Warsawab0e86c1998-05-19 15:31:46 +00002515hallucinogenic resemblance to `\\[py-end-of-def-or-class]' and
2516`\\[py-beginning-of-def-or-class]'.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002517
2518And in earlier versions of Python mode, all 3 were tightly connected.
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002519Turned out that was more confusing than useful: the `goto start' and
2520`goto end' commands are usually used to search through a file, and
2521people expect them to act a lot like `search backward' and `search
2522forward' string-search commands. But because Python `def' and `class'
2523can nest to arbitrary levels, finding the smallest def containing
2524point cannot be done via a simple backward search: the def containing
2525point may not be the closest preceding def, or even the closest
2526preceding def that's indented less. The fancy algorithm required is
2527appropriate for the usual uses of this `mark' command, but not for the
2528`goto' variations.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002529
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002530So the def marked by this command may not be the one either of the
2531`goto' commands find: If point is on a blank or non-indenting comment
2532line, moves back to start of the closest preceding code statement or
2533indenting comment line. If this is a `def' statement, that's the def
2534we use. Else searches for the smallest enclosing `def' block and uses
2535that. Else signals an error.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002536
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002537When an enclosing def is found: The mark is left immediately beyond
2538the last line of the def block. Point is left at the start of the
2539def, except that: if the def is preceded by a number of comment lines
2540followed by (at most) one optional blank line, point is left at the
2541start of the comments; else if the def is preceded by a blank line,
2542point is left at its start.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002543
2544The intent is to mark the containing def/class and its associated
2545documentation, to make moving and duplicating functions and classes
2546pleasant."
2547 (interactive "P") ; raw prefix arg
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002548 (let ((start (point))
Barry Warsaw7c29b231998-07-07 17:45:38 +00002549 (which (cond ((eq class 'either) "\\(class\\|def\\)")
2550 (class "class")
2551 (t "def"))))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002552 (push-mark start)
2553 (if (not (py-go-up-tree-to-keyword which))
2554 (progn (goto-char start)
Barry Warsaw7c29b231998-07-07 17:45:38 +00002555 (error "Enclosing %s not found"
2556 (if (eq class 'either)
2557 "def or class"
2558 which)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002559 ;; else enclosing def/class found
2560 (setq start (point))
2561 (py-goto-beyond-block)
2562 (push-mark (point))
2563 (goto-char start)
2564 (if (zerop (forward-line -1)) ; if there is a preceding line
2565 (progn
2566 (if (looking-at "[ \t]*$") ; it's blank
2567 (setq start (point)) ; so reset start point
2568 (goto-char start)) ; else try again
2569 (if (zerop (forward-line -1))
2570 (if (looking-at "[ \t]*#") ; a comment
2571 ;; look back for non-comment line
2572 ;; tricky: note that the regexp matches a blank
2573 ;; line, cuz \n is in the 2nd character class
2574 (and
2575 (re-search-backward "^[ \t]*[^ \t#]" nil 'move)
2576 (forward-line 1))
2577 ;; no comment, so go back
Barry Warsaw4da6bd51997-11-26 06:00:26 +00002578 (goto-char start)))))))
2579 (exchange-point-and-mark)
2580 (py-keep-region-active))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002581
Barry Warsaw9e5a9c81996-07-24 18:26:53 +00002582;; ripped from cc-mode
2583(defun py-forward-into-nomenclature (&optional arg)
2584 "Move forward to end of a nomenclature section or word.
Barry Warsaw41a05c71998-08-10 16:33:12 +00002585With \\[universal-argument] (programmatically, optional argument ARG),
2586do it that many times.
Barry Warsaw9e5a9c81996-07-24 18:26:53 +00002587
2588A `nomenclature' is a fancy way of saying AWordWithMixedCaseNotUnderscores."
2589 (interactive "p")
2590 (let ((case-fold-search nil))
2591 (if (> arg 0)
Barry Warsawc5a8cbd1996-08-05 21:53:02 +00002592 (re-search-forward
2593 "\\(\\W\\|[_]\\)*\\([A-Z]*[a-z0-9]*\\)"
2594 (point-max) t arg)
Barry Warsaw9e5a9c81996-07-24 18:26:53 +00002595 (while (and (< arg 0)
2596 (re-search-backward
Barry Warsawc5a8cbd1996-08-05 21:53:02 +00002597 "\\(\\W\\|[a-z0-9]\\)[A-Z]+\\|\\(\\W\\|[_]\\)\\w+"
Barry Warsaw9e5a9c81996-07-24 18:26:53 +00002598 (point-min) 0))
2599 (forward-char 1)
2600 (setq arg (1+ arg)))))
2601 (py-keep-region-active))
2602
2603(defun py-backward-into-nomenclature (&optional arg)
2604 "Move backward to beginning of a nomenclature section or word.
2605With optional ARG, move that many times. If ARG is negative, move
2606forward.
2607
2608A `nomenclature' is a fancy way of saying AWordWithMixedCaseNotUnderscores."
2609 (interactive "p")
2610 (py-forward-into-nomenclature (- arg))
2611 (py-keep-region-active))
2612
2613
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002614
Barry Warsaw4f577d22001-04-11 20:23:17 +00002615;; pdbtrack functions
2616(defun py-pdbtrack-toggle-stack-tracking (arg)
2617 (interactive "P")
2618 (if (not (get-buffer-process (current-buffer)))
2619 (error "No process associated with buffer '%s'" (current-buffer)))
2620 ;; missing or 0 is toggle, >0 turn on, <0 turn off
2621 (if (or (not arg)
2622 (zerop (setq arg (prefix-numeric-value arg))))
2623 (setq py-pdbtrack-do-tracking-p (not py-pdbtrack-do-tracking-p))
2624 (setq py-pdbtrack-do-tracking-p (> arg 0)))
2625 (message "%sabled Python's pdbtrack"
2626 (if py-pdbtrack-do-tracking-p "En" "Dis")))
2627
2628(defun turn-on-pdbtrack ()
2629 (interactive)
2630 (py-pdbtrack-toggle-stack-tracking 1))
2631
2632(defun turn-off-pdbtrack ()
2633 (interactive)
2634 (py-pdbtrack-toggle-stack-tracking 0))
2635
2636
2637
Barry Warsaw29a90f02002-04-22 21:48:20 +00002638;; Pychecker
2639(defun py-pychecker-run (command)
2640 "*Run pychecker (default on the file currently visited)."
2641 (interactive
2642 (let ((default
2643 (format "%s %s %s" py-pychecker-command
2644 (mapconcat 'identity py-pychecker-command-args " ")
2645 (buffer-file-name))))
2646
2647 (list
2648 (read-shell-command "Run pychecker like this: "
2649 default
2650 py-pychecker-history))))
2651 (save-some-buffers (not py-ask-about-save) nil)
2652 (compile command))
2653
2654
2655
2656;; pydoc commands. The guts of this function is stolen from XEmacs's
2657;; symbol-near-point, but without the useless regexp-quote call on the
2658;; results, nor the interactive bit. Also, we've added the temporary
2659;; syntax table setting, which Skip originally had broken out into a
2660;; separate function. Note that Emacs doesn't have the original
2661;; function.
Barry Warsawa7cc43b2002-04-22 17:15:19 +00002662(defun py-symbol-near-point ()
2663 "Return the first textual item to the nearest point."
2664 ;; alg stolen from etag.el
2665 (save-excursion
2666 (with-syntax-table py-dotted-expression-syntax-table
2667 (if (or (bobp) (not (memq (char-syntax (char-before)) '(?w ?_))))
2668 (while (not (looking-at "\\sw\\|\\s_\\|\\'"))
2669 (forward-char 1)))
2670 (while (looking-at "\\sw\\|\\s_")
2671 (forward-char 1))
2672 (if (re-search-backward "\\sw\\|\\s_" nil t)
2673 (progn (forward-char 1)
2674 (buffer-substring (point)
2675 (progn (forward-sexp -1)
2676 (while (looking-at "\\s'")
2677 (forward-char 1))
2678 (point))))
2679 nil))))
2680
2681(defun py-help-at-point ()
2682 "Get help from Python based on the symbol nearest point."
2683 (interactive)
2684 (let* ((sym (py-symbol-near-point))
2685 (base (substring sym 0 (or (search "." sym :from-end t) 0)))
2686 cmd)
2687 (if (not (equal base ""))
2688 (setq cmd (concat "import " base "\n")))
2689 (setq cmd (concat "import pydoc\n"
2690 cmd
Barry Warsaw04949552002-04-22 22:05:49 +00002691 "try: pydoc.help('" sym "')\n"
Barry Warsawa7cc43b2002-04-22 17:15:19 +00002692 "except: print 'No help available on:', \"" sym "\""))
2693 (message cmd)
Barry Warsaw04949552002-04-22 22:05:49 +00002694 (py-execute-string cmd)
2695 (set-buffer "*Python Output*")
2696 ;; BAW: Should we really be leaving the output buffer in help-mode?
2697 (help-mode)))
Barry Warsawa7cc43b2002-04-22 17:15:19 +00002698
2699
2700
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002701;; Documentation functions
Barry Warsaw7ae77681994-12-12 20:38:05 +00002702
2703;; dump the long form of the mode blurb; does the usual doc escapes,
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002704;; plus lines of the form ^[vc]:name$ to suck variable & command docs
2705;; out of the right places, along with the keys they're on & current
2706;; values
Barry Warsaw7ae77681994-12-12 20:38:05 +00002707(defun py-dump-help-string (str)
2708 (with-output-to-temp-buffer "*Help*"
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002709 (let ((locals (buffer-local-variables))
2710 funckind funcname func funcdoc
2711 (start 0) mstart end
2712 keys )
Barry Warsaw7ae77681994-12-12 20:38:05 +00002713 (while (string-match "^%\\([vc]\\):\\(.+\\)\n" str start)
2714 (setq mstart (match-beginning 0) end (match-end 0)
2715 funckind (substring str (match-beginning 1) (match-end 1))
2716 funcname (substring str (match-beginning 2) (match-end 2))
2717 func (intern funcname))
2718 (princ (substitute-command-keys (substring str start mstart)))
2719 (cond
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002720 ((equal funckind "c") ; command
2721 (setq funcdoc (documentation func)
2722 keys (concat
2723 "Key(s): "
2724 (mapconcat 'key-description
2725 (where-is-internal func py-mode-map)
2726 ", "))))
2727 ((equal funckind "v") ; variable
Barry Warsaw604cefa1996-09-03 18:17:04 +00002728 (setq funcdoc (documentation-property func 'variable-documentation)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002729 keys (if (assq func locals)
2730 (concat
2731 "Local/Global values: "
2732 (prin1-to-string (symbol-value func))
2733 " / "
2734 (prin1-to-string (default-value func)))
2735 (concat
2736 "Value: "
2737 (prin1-to-string (symbol-value func))))))
2738 (t ; unexpected
2739 (error "Error in py-dump-help-string, tag `%s'" funckind)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00002740 (princ (format "\n-> %s:\t%s\t%s\n\n"
2741 (if (equal funckind "c") "Command" "Variable")
2742 funcname keys))
2743 (princ funcdoc)
2744 (terpri)
2745 (setq start end))
2746 (princ (substitute-command-keys (substring str start))))
2747 (print-help-return-message)))
2748
2749(defun py-describe-mode ()
2750 "Dump long form of Python-mode docs."
2751 (interactive)
2752 (py-dump-help-string "Major mode for editing Python files.
2753Knows about Python indentation, tokens, comments and continuation lines.
2754Paragraphs are separated by blank lines only.
2755
2756Major sections below begin with the string `@'; specific function and
2757variable docs begin with `->'.
2758
2759@EXECUTING PYTHON CODE
2760
Barry Warsaw820273d1998-05-19 15:54:45 +00002761\\[py-execute-import-or-reload]\timports or reloads the file in the Python interpreter
Barry Warsaw7ae77681994-12-12 20:38:05 +00002762\\[py-execute-buffer]\tsends the entire buffer to the Python interpreter
2763\\[py-execute-region]\tsends the current region
Barry Warsaw820273d1998-05-19 15:54:45 +00002764\\[py-execute-def-or-class]\tsends the current function or class definition
2765\\[py-execute-string]\tsends an arbitrary string
Barry Warsaw7ae77681994-12-12 20:38:05 +00002766\\[py-shell]\tstarts a Python interpreter window; this will be used by
Barry Warsaw820273d1998-05-19 15:54:45 +00002767\tsubsequent Python execution commands
2768%c:py-execute-import-or-reload
Barry Warsaw7ae77681994-12-12 20:38:05 +00002769%c:py-execute-buffer
2770%c:py-execute-region
Barry Warsaw820273d1998-05-19 15:54:45 +00002771%c:py-execute-def-or-class
2772%c:py-execute-string
Barry Warsaw7ae77681994-12-12 20:38:05 +00002773%c:py-shell
2774
2775@VARIABLES
2776
2777py-indent-offset\tindentation increment
Barry Warsaw42f707f1996-07-29 21:05:05 +00002778py-block-comment-prefix\tcomment string used by comment-region
Barry Warsaw7ae77681994-12-12 20:38:05 +00002779
2780py-python-command\tshell command to invoke Python interpreter
Barry Warsaw7ae77681994-12-12 20:38:05 +00002781py-temp-directory\tdirectory used for temp files (if needed)
2782
2783py-beep-if-tab-change\tring the bell if tab-width is changed
2784%v:py-indent-offset
2785%v:py-block-comment-prefix
2786%v:py-python-command
Barry Warsaw7ae77681994-12-12 20:38:05 +00002787%v:py-temp-directory
2788%v:py-beep-if-tab-change
2789
2790@KINDS OF LINES
2791
2792Each physical line in the file is either a `continuation line' (the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002793preceding line ends with a backslash that's not part of a comment, or
2794the paren/bracket/brace nesting level at the start of the line is
2795non-zero, or both) or an `initial line' (everything else).
Barry Warsaw7ae77681994-12-12 20:38:05 +00002796
2797An initial line is in turn a `blank line' (contains nothing except
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002798possibly blanks or tabs), a `comment line' (leftmost non-blank
2799character is `#'), or a `code line' (everything else).
Barry Warsaw7ae77681994-12-12 20:38:05 +00002800
2801Comment Lines
2802
2803Although all comment lines are treated alike by Python, Python mode
2804recognizes two kinds that act differently with respect to indentation.
2805
2806An `indenting comment line' is a comment line with a blank, tab or
2807nothing after the initial `#'. The indentation commands (see below)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002808treat these exactly as if they were code lines: a line following an
Barry Warsaw7ae77681994-12-12 20:38:05 +00002809indenting comment line will be indented like the comment line. All
2810other comment lines (those with a non-whitespace character immediately
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002811following the initial `#') are `non-indenting comment lines', and
2812their indentation is ignored by the indentation commands.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002813
2814Indenting comment lines are by far the usual case, and should be used
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002815whenever possible. Non-indenting comment lines are useful in cases
2816like these:
Barry Warsaw7ae77681994-12-12 20:38:05 +00002817
2818\ta = b # a very wordy single-line comment that ends up being
2819\t #... continued onto another line
2820
2821\tif a == b:
2822##\t\tprint 'panic!' # old code we've `commented out'
2823\t\treturn a
2824
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002825Since the `#...' and `##' comment lines have a non-whitespace
2826character following the initial `#', Python mode ignores them when
2827computing the proper indentation for the next line.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002828
2829Continuation Lines and Statements
2830
2831The Python-mode commands generally work on statements instead of on
2832individual lines, where a `statement' is a comment or blank line, or a
2833code line and all of its following continuation lines (if any)
2834considered as a single logical unit. The commands in this mode
2835generally (when it makes sense) automatically move to the start of the
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002836statement containing point, even if point happens to be in the middle
2837of some continuation line.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002838
2839
2840@INDENTATION
2841
2842Primarily for entering new code:
2843\t\\[indent-for-tab-command]\t indent line appropriately
2844\t\\[py-newline-and-indent]\t insert newline, then indent
Barry Warsaw27ee1151997-12-03 05:03:44 +00002845\t\\[py-electric-backspace]\t reduce indentation, or delete single character
Barry Warsaw7ae77681994-12-12 20:38:05 +00002846
2847Primarily for reindenting existing code:
2848\t\\[py-guess-indent-offset]\t guess py-indent-offset from file content; change locally
2849\t\\[universal-argument] \\[py-guess-indent-offset]\t ditto, but change globally
2850
2851\t\\[py-indent-region]\t reindent region to match its context
2852\t\\[py-shift-region-left]\t shift region left by py-indent-offset
2853\t\\[py-shift-region-right]\t shift region right by py-indent-offset
2854
2855Unlike most programming languages, Python uses indentation, and only
2856indentation, to specify block structure. Hence the indentation supplied
2857automatically by Python-mode is just an educated guess: only you know
2858the block structure you intend, so only you can supply correct
2859indentation.
2860
2861The \\[indent-for-tab-command] and \\[py-newline-and-indent] keys try to suggest plausible indentation, based on
2862the indentation of preceding statements. E.g., assuming
2863py-indent-offset is 4, after you enter
2864\tif a > 0: \\[py-newline-and-indent]
2865the cursor will be moved to the position of the `_' (_ is not a
2866character in the file, it's just used here to indicate the location of
2867the cursor):
2868\tif a > 0:
2869\t _
2870If you then enter `c = d' \\[py-newline-and-indent], the cursor will move
2871to
2872\tif a > 0:
2873\t c = d
2874\t _
2875Python-mode cannot know whether that's what you intended, or whether
2876\tif a > 0:
2877\t c = d
2878\t_
2879was your intent. In general, Python-mode either reproduces the
2880indentation of the (closest code or indenting-comment) preceding
2881statement, or adds an extra py-indent-offset blanks if the preceding
2882statement has `:' as its last significant (non-whitespace and non-
2883comment) character. If the suggested indentation is too much, use
Barry Warsaw27ee1151997-12-03 05:03:44 +00002884\\[py-electric-backspace] to reduce it.
Barry Warsaw7ae77681994-12-12 20:38:05 +00002885
2886Continuation lines are given extra indentation. If you don't like the
2887suggested indentation, change it to something you do like, and Python-
2888mode will strive to indent later lines of the statement in the same way.
2889
2890If a line is a continuation line by virtue of being in an unclosed
2891paren/bracket/brace structure (`list', for short), the suggested
2892indentation depends on whether the current line contains the first item
2893in the list. If it does, it's indented py-indent-offset columns beyond
2894the indentation of the line containing the open bracket. If you don't
2895like that, change it by hand. The remaining items in the list will mimic
2896whatever indentation you give to the first item.
2897
2898If a line is a continuation line because the line preceding it ends with
2899a backslash, the third and following lines of the statement inherit their
2900indentation from the line preceding them. The indentation of the second
2901line in the statement depends on the form of the first (base) line: if
2902the base line is an assignment statement with anything more interesting
2903than the backslash following the leftmost assigning `=', the second line
2904is indented two columns beyond that `='. Else it's indented to two
2905columns beyond the leftmost solid chunk of non-whitespace characters on
2906the base line.
2907
2908Warning: indent-region should not normally be used! It calls \\[indent-for-tab-command]
2909repeatedly, and as explained above, \\[indent-for-tab-command] can't guess the block
2910structure you intend.
2911%c:indent-for-tab-command
2912%c:py-newline-and-indent
Barry Warsaw27ee1151997-12-03 05:03:44 +00002913%c:py-electric-backspace
Barry Warsaw7ae77681994-12-12 20:38:05 +00002914
2915
2916The next function may be handy when editing code you didn't write:
2917%c:py-guess-indent-offset
2918
2919
2920The remaining `indent' functions apply to a region of Python code. They
2921assume the block structure (equals indentation, in Python) of the region
2922is correct, and alter the indentation in various ways while preserving
2923the block structure:
2924%c:py-indent-region
2925%c:py-shift-region-left
2926%c:py-shift-region-right
2927
2928@MARKING & MANIPULATING REGIONS OF CODE
2929
2930\\[py-mark-block]\t mark block of lines
Barry Warsaw2518c671997-11-05 00:51:08 +00002931\\[py-mark-def-or-class]\t mark smallest enclosing def
2932\\[universal-argument] \\[py-mark-def-or-class]\t mark smallest enclosing class
Barry Warsaw42f707f1996-07-29 21:05:05 +00002933\\[comment-region]\t comment out region of code
2934\\[universal-argument] \\[comment-region]\t uncomment region of code
Barry Warsaw7ae77681994-12-12 20:38:05 +00002935%c:py-mark-block
Barry Warsaw2518c671997-11-05 00:51:08 +00002936%c:py-mark-def-or-class
Barry Warsaw42f707f1996-07-29 21:05:05 +00002937%c:comment-region
Barry Warsaw7ae77681994-12-12 20:38:05 +00002938
2939@MOVING POINT
2940
2941\\[py-previous-statement]\t move to statement preceding point
2942\\[py-next-statement]\t move to statement following point
2943\\[py-goto-block-up]\t move up to start of current block
Barry Warsawab0e86c1998-05-19 15:31:46 +00002944\\[py-beginning-of-def-or-class]\t move to start of def
2945\\[universal-argument] \\[py-beginning-of-def-or-class]\t move to start of class
2946\\[py-end-of-def-or-class]\t move to end of def
2947\\[universal-argument] \\[py-end-of-def-or-class]\t move to end of class
Barry Warsaw7ae77681994-12-12 20:38:05 +00002948
2949The first two move to one statement beyond the statement that contains
2950point. A numeric prefix argument tells them to move that many
2951statements instead. Blank lines, comment lines, and continuation lines
2952do not count as `statements' for these commands. So, e.g., you can go
2953to the first code statement in a file by entering
2954\t\\[beginning-of-buffer]\t to move to the top of the file
2955\t\\[py-next-statement]\t to skip over initial comments and blank lines
2956Or do `\\[py-previous-statement]' with a huge prefix argument.
2957%c:py-previous-statement
2958%c:py-next-statement
2959%c:py-goto-block-up
Barry Warsawab0e86c1998-05-19 15:31:46 +00002960%c:py-beginning-of-def-or-class
2961%c:py-end-of-def-or-class
Barry Warsaw7ae77681994-12-12 20:38:05 +00002962
2963@LITTLE-KNOWN EMACS COMMANDS PARTICULARLY USEFUL IN PYTHON MODE
2964
2965`\\[indent-new-comment-line]' is handy for entering a multi-line comment.
2966
2967`\\[set-selective-display]' with a `small' prefix arg is ideally suited for viewing the
2968overall class and def structure of a module.
2969
2970`\\[back-to-indentation]' moves point to a line's first non-blank character.
2971
2972`\\[indent-relative]' is handy for creating odd indentation.
2973
2974@OTHER EMACS HINTS
2975
2976If you don't like the default value of a variable, change its value to
2977whatever you do like by putting a `setq' line in your .emacs file.
2978E.g., to set the indentation increment to 4, put this line in your
2979.emacs:
2980\t(setq py-indent-offset 4)
2981To see the value of a variable, do `\\[describe-variable]' and enter the variable
2982name at the prompt.
2983
2984When entering a key sequence like `C-c C-n', it is not necessary to
2985release the CONTROL key after doing the `C-c' part -- it suffices to
2986press the CONTROL key, press and release `c' (while still holding down
2987CONTROL), press and release `n' (while still holding down CONTROL), &
2988then release CONTROL.
2989
2990Entering Python mode calls with no arguments the value of the variable
2991`python-mode-hook', if that value exists and is not nil; for backward
2992compatibility it also tries `py-mode-hook'; see the `Hooks' section of
2993the Elisp manual for details.
2994
2995Obscure: When python-mode is first loaded, it looks for all bindings
2996to newline-and-indent in the global keymap, and shadows them with
2997local bindings to py-newline-and-indent."))
2998
Barry Warsaw7b0f5681995-03-08 21:33:04 +00002999
3000;; Helper functions
Barry Warsaw7ae77681994-12-12 20:38:05 +00003001(defvar py-parse-state-re
3002 (concat
3003 "^[ \t]*\\(if\\|elif\\|else\\|while\\|def\\|class\\)\\>"
3004 "\\|"
3005 "^[^ #\t\n]"))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003006
Barry Warsaw7ae77681994-12-12 20:38:05 +00003007(defun py-parse-state ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003008 "Return the parse state at point (see `parse-partial-sexp' docs)."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003009 (save-excursion
Barry Warsaw43ecf8e1996-04-06 00:00:19 +00003010 (let ((here (point))
Barry Warsawb2d5e622002-04-22 15:29:27 +00003011 pps done)
Barry Warsaw43ecf8e1996-04-06 00:00:19 +00003012 (while (not done)
3013 ;; back up to the first preceding line (if any; else start of
3014 ;; buffer) that begins with a popular Python keyword, or a
3015 ;; non- whitespace and non-comment character. These are good
3016 ;; places to start parsing to see whether where we started is
3017 ;; at a non-zero nesting level. It may be slow for people who
3018 ;; write huge code blocks or huge lists ... tough beans.
3019 (re-search-backward py-parse-state-re nil 'move)
3020 (beginning-of-line)
Barry Warsawf64b4051998-02-12 16:52:14 +00003021 ;; In XEmacs, we have a much better way to test for whether
3022 ;; we're in a triple-quoted string or not. Emacs does not
Barry Warsaw145ab1c1998-05-19 14:49:49 +00003023 ;; have this built-in function, which is its loss because
Barry Warsawf64b4051998-02-12 16:52:14 +00003024 ;; without scanning from the beginning of the buffer, there's
3025 ;; no accurate way to determine this otherwise.
Barry Warsawb2d5e622002-04-22 15:29:27 +00003026 (save-excursion (setq pps (parse-partial-sexp (point) here)))
3027 ;; make sure we don't land inside a triple-quoted string
3028 (setq done (or (not (nth 3 pps))
3029 (bobp)))
3030 ;; Just go ahead and short circuit the test back to the
3031 ;; beginning of the buffer. This will be slow, but not
3032 ;; nearly as slow as looping through many
3033 ;; re-search-backwards.
3034 (if (not done)
3035 (goto-char (point-min))))
Barry Warsaw43ecf8e1996-04-06 00:00:19 +00003036 pps)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00003037
Barry Warsaw7ae77681994-12-12 20:38:05 +00003038(defun py-nesting-level ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003039 "Return the buffer position of the last unclosed enclosing list.
3040If nesting level is zero, return nil."
Barry Warsawf64b4051998-02-12 16:52:14 +00003041 (let ((status (py-parse-state)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00003042 (if (zerop (car status))
3043 nil ; not in a nest
3044 (car (cdr status))))) ; char# of open bracket
3045
Barry Warsaw7ae77681994-12-12 20:38:05 +00003046(defun py-backslash-continuation-line-p ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003047 "Return t iff preceding line ends with backslash that is not in a comment."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003048 (save-excursion
3049 (beginning-of-line)
3050 (and
3051 ;; use a cheap test first to avoid the regexp if possible
3052 ;; use 'eq' because char-after may return nil
3053 (eq (char-after (- (point) 2)) ?\\ )
3054 ;; make sure; since eq test passed, there is a preceding line
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003055 (forward-line -1) ; always true -- side effect
Barry Warsaw7ae77681994-12-12 20:38:05 +00003056 (looking-at py-continued-re))))
3057
Barry Warsaw7ae77681994-12-12 20:38:05 +00003058(defun py-continuation-line-p ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003059 "Return t iff current line is a continuation line."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003060 (save-excursion
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003061 (beginning-of-line)
Barry Warsaw7ae77681994-12-12 20:38:05 +00003062 (or (py-backslash-continuation-line-p)
3063 (py-nesting-level))))
3064
Barry Warsaw9c1696c1998-12-15 04:36:22 +00003065(defun py-goto-beginning-of-tqs (delim)
3066 "Go to the beginning of the triple quoted string we find ourselves in.
3067DELIM is the TQS string delimiter character we're searching backwards
3068for."
Barry Warsaw3c34bb32000-10-27 05:00:25 +00003069 (let ((skip (and delim (make-string 1 delim)))
3070 (continue t))
Barry Warsaw9c1696c1998-12-15 04:36:22 +00003071 (when skip
3072 (save-excursion
Barry Warsaw3c34bb32000-10-27 05:00:25 +00003073 (while continue
3074 (py-safe (search-backward skip))
3075 (setq continue (and (not (bobp))
3076 (= (char-before) ?\\))))
3077 (if (and (= (char-before) delim)
3078 (= (char-before (1- (point))) delim))
Barry Warsaw9c1696c1998-12-15 04:36:22 +00003079 (setq skip (make-string 3 delim))))
3080 ;; we're looking at a triple-quoted string
3081 (py-safe (search-backward skip)))))
3082
Barry Warsaw7ae77681994-12-12 20:38:05 +00003083(defun py-goto-initial-line ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003084 "Go to the initial line of the current statement.
3085Usually this is the line we're on, but if we're on the 2nd or
3086following lines of a continuation block, we need to go up to the first
3087line of the block."
3088 ;; Tricky: We want to avoid quadratic-time behavior for long
3089 ;; continued blocks, whether of the backslash or open-bracket
3090 ;; varieties, or a mix of the two. The following manages to do that
3091 ;; in the usual cases.
3092 ;;
3093 ;; Also, if we're sitting inside a triple quoted string, this will
3094 ;; drop us at the line that begins the string.
Barry Warsaw9ec9fbc1998-01-21 05:15:57 +00003095 (let (open-bracket-pos)
Barry Warsaw7ae77681994-12-12 20:38:05 +00003096 (while (py-continuation-line-p)
3097 (beginning-of-line)
3098 (if (py-backslash-continuation-line-p)
3099 (while (py-backslash-continuation-line-p)
3100 (forward-line -1))
3101 ;; else zip out of nested brackets/braces/parens
3102 (while (setq open-bracket-pos (py-nesting-level))
3103 (goto-char open-bracket-pos)))))
3104 (beginning-of-line))
3105
Barry Warsaw7ae77681994-12-12 20:38:05 +00003106(defun py-goto-beyond-final-line ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003107 "Go to the point just beyond the fine line of the current statement.
3108Usually this is the start of the next line, but if this is a
3109multi-line statement we need to skip over the continuation lines."
3110 ;; Tricky: Again we need to be clever to avoid quadratic time
3111 ;; behavior.
3112 ;;
3113 ;; XXX: Not quite the right solution, but deals with multi-line doc
3114 ;; strings
Barry Warsaw751f4931998-05-19 16:06:21 +00003115 (if (looking-at (concat "[ \t]*\\(" py-stringlit-re "\\)"))
3116 (goto-char (match-end 0)))
3117 ;;
Barry Warsaw7ae77681994-12-12 20:38:05 +00003118 (forward-line 1)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003119 (let (state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00003120 (while (and (py-continuation-line-p)
3121 (not (eobp)))
3122 ;; skip over the backslash flavor
3123 (while (and (py-backslash-continuation-line-p)
3124 (not (eobp)))
3125 (forward-line 1))
3126 ;; if in nest, zip to the end of the nest
3127 (setq state (py-parse-state))
3128 (if (and (not (zerop (car state)))
3129 (not (eobp)))
3130 (progn
Barry Warsawaffc0ca1997-11-03 16:59:38 +00003131 (parse-partial-sexp (point) (point-max) 0 nil state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00003132 (forward-line 1))))))
3133
Barry Warsaw7ae77681994-12-12 20:38:05 +00003134(defun py-statement-opens-block-p ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003135 "Return t iff the current statement opens a block.
3136I.e., iff it ends with a colon that is not in a comment. Point should
3137be at the start of a statement."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003138 (save-excursion
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003139 (let ((start (point))
3140 (finish (progn (py-goto-beyond-final-line) (1- (point))))
3141 (searching t)
3142 (answer nil)
3143 state)
Barry Warsaw7ae77681994-12-12 20:38:05 +00003144 (goto-char start)
3145 (while searching
3146 ;; look for a colon with nothing after it except whitespace, and
3147 ;; maybe a comment
3148 (if (re-search-forward ":\\([ \t]\\|\\\\\n\\)*\\(#.*\\)?$"
3149 finish t)
3150 (if (eq (point) finish) ; note: no `else' clause; just
3151 ; keep searching if we're not at
3152 ; the end yet
3153 ;; sure looks like it opens a block -- but it might
3154 ;; be in a comment
3155 (progn
3156 (setq searching nil) ; search is done either way
3157 (setq state (parse-partial-sexp start
3158 (match-beginning 0)))
3159 (setq answer (not (nth 4 state)))))
3160 ;; search failed: couldn't find another interesting colon
3161 (setq searching nil)))
3162 answer)))
3163
Barry Warsawf831d811996-07-31 20:42:59 +00003164(defun py-statement-closes-block-p ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003165 "Return t iff the current statement closes a block.
3166I.e., if the line starts with `return', `raise', `break', `continue',
3167and `pass'. This doesn't catch embedded statements."
Barry Warsawf831d811996-07-31 20:42:59 +00003168 (let ((here (point)))
Barry Warsawa8f99ba1999-05-24 18:37:57 +00003169 (py-goto-initial-line)
Barry Warsawc0d2d511999-06-03 22:18:59 +00003170 (back-to-indentation)
Barry Warsawf831d811996-07-31 20:42:59 +00003171 (prog1
Barry Warsawaffc0ca1997-11-03 16:59:38 +00003172 (looking-at (concat py-block-closing-keywords-re "\\>"))
Barry Warsawf831d811996-07-31 20:42:59 +00003173 (goto-char here))))
3174
Barry Warsaw7ae77681994-12-12 20:38:05 +00003175(defun py-goto-beyond-block ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003176 "Go to point just beyond the final line of block begun by the current line.
3177This is the same as where `py-goto-beyond-final-line' goes unless
3178we're on colon line, in which case we go to the end of the block.
3179Assumes point is at the beginning of the line."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003180 (if (py-statement-opens-block-p)
3181 (py-mark-block nil 'just-move)
3182 (py-goto-beyond-final-line)))
3183
Barry Warsaw7ae77681994-12-12 20:38:05 +00003184(defun py-goto-statement-at-or-above ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003185 "Go to the start of the first statement at or preceding point.
3186Return t if there is such a statement, otherwise nil. `Statement'
3187does not include blank lines, comments, or continuation lines."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003188 (py-goto-initial-line)
3189 (if (looking-at py-blank-or-comment-re)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003190 ;; skip back over blank & comment lines
3191 ;; note: will skip a blank or comment line that happens to be
3192 ;; a continuation line too
3193 (if (re-search-backward "^[ \t]*[^ \t#\n]" nil t)
3194 (progn (py-goto-initial-line) t)
3195 nil)
Barry Warsaw7ae77681994-12-12 20:38:05 +00003196 t))
3197
Barry Warsaw7ae77681994-12-12 20:38:05 +00003198(defun py-goto-statement-below ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003199 "Go to start of the first statement following the statement containing point.
3200Return t if there is such a statement, otherwise nil. `Statement'
3201does not include blank lines, comments, or continuation lines."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003202 (beginning-of-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003203 (let ((start (point)))
Barry Warsaw7ae77681994-12-12 20:38:05 +00003204 (py-goto-beyond-final-line)
3205 (while (and
3206 (looking-at py-blank-or-comment-re)
3207 (not (eobp)))
3208 (forward-line 1))
3209 (if (eobp)
3210 (progn (goto-char start) nil)
3211 t)))
3212
Barry Warsaw7ae77681994-12-12 20:38:05 +00003213(defun py-go-up-tree-to-keyword (key)
Barry Warsaw41a05c71998-08-10 16:33:12 +00003214 "Go to begining of statement starting with KEY, at or preceding point.
3215
3216KEY is a regular expression describing a Python keyword. Skip blank
3217lines and non-indenting comments. If the statement found starts with
3218KEY, then stop, otherwise go back to first enclosing block starting
3219with KEY. If successful, leave point at the start of the KEY line and
3220return t. Otherwise, leav point at an undefined place and return nil."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003221 ;; skip blanks and non-indenting #
3222 (py-goto-initial-line)
3223 (while (and
3224 (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)")
3225 (zerop (forward-line -1))) ; go back
3226 nil)
3227 (py-goto-initial-line)
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003228 (let* ((re (concat "[ \t]*" key "\\b"))
3229 (case-fold-search nil) ; let* so looking-at sees this
3230 (found (looking-at re))
3231 (dead nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +00003232 (while (not (or found dead))
3233 (condition-case nil ; in case no enclosing block
3234 (py-goto-block-up 'no-mark)
3235 (error (setq dead t)))
3236 (or dead (setq found (looking-at re))))
3237 (beginning-of-line)
3238 found))
3239
Barry Warsaw7ae77681994-12-12 20:38:05 +00003240(defun py-suck-up-leading-text ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003241 "Return string in buffer from start of indentation to end of line.
3242Prefix with \"...\" if leading whitespace was skipped."
Barry Warsaw7ae77681994-12-12 20:38:05 +00003243 (save-excursion
3244 (back-to-indentation)
3245 (concat
3246 (if (bolp) "" "...")
3247 (buffer-substring (point) (progn (end-of-line) (point))))))
3248
Barry Warsaw7ae77681994-12-12 20:38:05 +00003249(defun py-suck-up-first-keyword ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003250 "Return first keyword on the line as a Lisp symbol.
3251`Keyword' is defined (essentially) as the regular expression
3252([a-z]+). Returns nil if none was found."
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003253 (let ((case-fold-search nil))
Barry Warsaw7ae77681994-12-12 20:38:05 +00003254 (if (looking-at "[ \t]*\\([a-z]+\\)\\b")
3255 (intern (buffer-substring (match-beginning 1) (match-end 1)))
3256 nil)))
3257
Barry Warsawb3e81d51996-09-04 15:12:42 +00003258(defun py-current-defun ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003259 "Python value for `add-log-current-defun-function'.
3260This tells add-log.el how to find the current function/method/variable."
Barry Warsawb3e81d51996-09-04 15:12:42 +00003261 (save-excursion
3262 (if (re-search-backward py-defun-start-re nil t)
3263 (or (match-string 3)
3264 (let ((method (match-string 2)))
3265 (if (and (not (zerop (length (match-string 1))))
3266 (re-search-backward py-class-start-re nil t))
3267 (concat (match-string 1) "." method)
3268 method)))
3269 nil)))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003270
3271
Barry Warsawfec75d61995-07-05 23:26:15 +00003272(defconst py-help-address "python-mode@python.org"
Barry Warsaw850437a1995-03-08 21:50:28 +00003273 "Address accepting submission of bug reports.")
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003274
Barry Warsaw850437a1995-03-08 21:50:28 +00003275(defun py-version ()
3276 "Echo the current version of `python-mode' in the minibuffer."
3277 (interactive)
3278 (message "Using `python-mode' version %s" py-version)
3279 (py-keep-region-active))
3280
3281;; only works under Emacs 19
3282;(eval-when-compile
3283; (require 'reporter))
3284
3285(defun py-submit-bug-report (enhancement-p)
3286 "Submit via mail a bug report on `python-mode'.
Barry Warsaw41a05c71998-08-10 16:33:12 +00003287With \\[universal-argument] (programmatically, argument ENHANCEMENT-P
3288non-nil) just submit an enhancement request."
Barry Warsaw850437a1995-03-08 21:50:28 +00003289 (interactive
3290 (list (not (y-or-n-p
Barry Warsaw41a05c71998-08-10 16:33:12 +00003291 "Is this a bug report (hit `n' to send other comments)? "))))
Barry Warsawb5e0ecb1995-03-14 18:32:54 +00003292 (let ((reporter-prompt-for-summary-p (if enhancement-p
3293 "(Very) brief summary: "
3294 t)))
Barry Warsaw850437a1995-03-08 21:50:28 +00003295 (require 'reporter)
3296 (reporter-submit-bug-report
3297 py-help-address ;address
Barry Warsawb5e0ecb1995-03-14 18:32:54 +00003298 (concat "python-mode " py-version) ;pkgname
Barry Warsaw850437a1995-03-08 21:50:28 +00003299 ;; varlist
3300 (if enhancement-p nil
3301 '(py-python-command
3302 py-indent-offset
3303 py-block-comment-prefix
Barry Warsaw850437a1995-03-08 21:50:28 +00003304 py-temp-directory
3305 py-beep-if-tab-change))
3306 nil ;pre-hooks
3307 nil ;post-hooks
3308 "Dear Barry,") ;salutation
3309 (if enhancement-p nil
3310 (set-mark (point))
3311 (insert
3312"Please replace this text with a sufficiently large code sample\n\
3313and an exact recipe so that I can reproduce your problem. Failure\n\
3314to do so may mean a greater delay in fixing your bug.\n\n")
3315 (exchange-point-and-mark)
3316 (py-keep-region-active))))
3317
3318
Barry Warsaw47384781997-11-26 05:27:45 +00003319(defun py-kill-emacs-hook ()
Barry Warsaw41a05c71998-08-10 16:33:12 +00003320 "Delete files in `py-file-queue'.
3321These are Python temporary files awaiting execution."
Barry Warsaw47384781997-11-26 05:27:45 +00003322 (mapcar #'(lambda (filename)
3323 (py-safe (delete-file filename)))
3324 py-file-queue))
3325
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003326;; arrange to kill temp files when Emacs exists
Barry Warsawc72c11c1997-08-09 06:42:08 +00003327(add-hook 'kill-emacs-hook 'py-kill-emacs-hook)
Barry Warsaw4f577d22001-04-11 20:23:17 +00003328(add-hook 'comint-output-filter-functions 'py-pdbtrack-track-stack-file)
3329
3330;; Add a designator to the minor mode strings
3331(or (assq 'py-pdbtrack-minor-mode-string minor-mode-alist)
3332 (push '(py-pdbtrack-is-tracking-p py-pdbtrack-minor-mode-string)
3333 minor-mode-alist))
Barry Warsaw7b0f5681995-03-08 21:33:04 +00003334
3335
3336
3337(provide 'python-mode)
3338;;; python-mode.el ends here