Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1 | ;;; python-mode.el --- Major mode for editing Python programs |
| 2 | |
| 3 | ;; Copyright (C) 1992,1993,1994 Tim Peters |
| 4 | |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 5 | ;; Author: 1995-2002 Barry A. Warsaw |
Barry Warsaw | fec75d6 | 1995-07-05 23:26:15 +0000 | [diff] [blame] | 6 | ;; 1992-1994 Tim Peters |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 7 | ;; Maintainer: python-mode@python.org |
| 8 | ;; Created: Feb 1992 |
| 9 | ;; Keywords: python languages oop |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 10 | |
Barry Warsaw | 19b1c61 | 2001-07-06 20:27:29 +0000 | [diff] [blame] | 11 | (defconst py-version "$Revision$" |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 12 | "`python-mode' version number.") |
| 13 | |
Barry Warsaw | cfec359 | 1995-03-10 15:58:16 +0000 | [diff] [blame] | 14 | ;; 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 Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 19 | |
| 20 | ;;; Commentary: |
Barry Warsaw | 755c671 | 1996-08-01 20:02:55 +0000 | [diff] [blame] | 21 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 22 | ;; This is a major mode for editing Python programs. It was developed |
Barry Warsaw | 261f87d | 1996-08-20 19:57:34 +0000 | [diff] [blame] | 23 | ;; by Tim Peters after an original idea by Michael A. Guravage. Tim |
Barry Warsaw | f7039e2 | 1998-08-20 22:10:46 +0000 | [diff] [blame] | 24 | ;; subsequently left the net; in 1995, Barry Warsaw inherited the mode |
Barry Warsaw | 38e21e7 | 1998-10-27 22:09:25 +0000 | [diff] [blame] | 25 | ;; and is the current maintainer. Tim's now back but disavows all |
| 26 | ;; responsibility for the mode. Smart Tim :-) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 27 | |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 28 | ;; pdbtrack support contributed by Ken Manheimer, April 2001. |
| 29 | |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 30 | ;; Please use the SourceForge Python project to submit bugs or |
| 31 | ;; patches: |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 32 | ;; |
| 33 | ;; http://sourceforge.net/projects/python |
Barry Warsaw | 3723152 | 1997-12-11 17:23:13 +0000 | [diff] [blame] | 34 | |
| 35 | ;; FOR MORE INFORMATION: |
| 36 | |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 37 | ;; There is some information on python-mode.el at |
| 38 | |
Barry Warsaw | f7039e2 | 1998-08-20 22:10:46 +0000 | [diff] [blame] | 39 | ;; http://www.python.org/emacs/python-mode/ |
| 40 | ;; |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 41 | ;; It does contain links to other packages that you might find useful, |
| 42 | ;; such as pdb interfaces, OO-Browser links, etc. |
Barry Warsaw | 3723152 | 1997-12-11 17:23:13 +0000 | [diff] [blame] | 43 | |
| 44 | ;; BUG REPORTING: |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 45 | |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 46 | ;; 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 Warsaw | affc0ca | 1997-11-03 16:59:38 +0000 | [diff] [blame] | 50 | ;; 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 Warsaw | 3723152 | 1997-12-11 17:23:13 +0000 | [diff] [blame] | 54 | ;; doubtful that a texinfo manual would be very useful, but if you |
| 55 | ;; want to contribute one, I'll certainly accept it! |
Barry Warsaw | b5e0ecb | 1995-03-14 18:32:54 +0000 | [diff] [blame] | 56 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 57 | ;;; Code: |
| 58 | |
Barry Warsaw | 6dfbe5d | 1998-08-20 21:51:27 +0000 | [diff] [blame] | 59 | (require 'comint) |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 60 | (require 'custom) |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 61 | (require 'cl) |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 62 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 63 | |
| 64 | ;; user definable variables |
| 65 | ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 66 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 67 | (defgroup python nil |
| 68 | "Support for the Python programming language, <http://www.python.org/>" |
Barry Warsaw | 5ed843f | 1999-07-28 22:06:06 +0000 | [diff] [blame] | 69 | :group 'languages |
| 70 | :prefix "py-") |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 71 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 72 | (defcustom py-python-command "python" |
| 73 | "*Shell command used to start Python interpreter." |
| 74 | :type 'string |
| 75 | :group 'python) |
| 76 | |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 77 | (defcustom py-jpython-command "jpython" |
| 78 | "*Shell command used to start the JPython interpreter." |
| 79 | :type 'string |
Barry Warsaw | 5ed843f | 1999-07-28 22:06:06 +0000 | [diff] [blame] | 80 | :group 'python |
| 81 | :tag "JPython Command") |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 82 | |
Barry Warsaw | aa384fd | 1999-02-16 23:36:16 +0000 | [diff] [blame] | 83 | (defcustom py-default-interpreter 'cpython |
| 84 | "*Which Python interpreter is used by default. |
| 85 | The value for this variable can be either `cpython' or `jpython'. |
| 86 | |
| 87 | When the value is `cpython', the variables `py-python-command' and |
| 88 | `py-python-command-args' are consulted to determine the interpreter |
| 89 | and arguments to use. |
| 90 | |
| 91 | When the value is `jpython', the variables `py-jpython-command' and |
| 92 | `py-jpython-command-args' are consulted to determine the interpreter |
| 93 | and arguments to use. |
| 94 | |
Barry Warsaw | 11f2156 | 1999-07-28 21:59:43 +0000 | [diff] [blame] | 95 | Note that this variable is consulted only the first time that a Python |
| 96 | mode buffer is visited during an Emacs session. After that, use |
Barry Warsaw | aa384fd | 1999-02-16 23:36:16 +0000 | [diff] [blame] | 97 | \\[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 Warsaw | 8f972b7 | 1998-02-05 20:45:49 +0000 | [diff] [blame] | 102 | (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 Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 107 | (defcustom py-jpython-command-args '("-i") |
| 108 | "*List of string arguments to be used when starting a JPython shell." |
| 109 | :type '(repeat string) |
Barry Warsaw | 5ed843f | 1999-07-28 22:06:06 +0000 | [diff] [blame] | 110 | :group 'python |
| 111 | :tag "JPython Command Args") |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 112 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 113 | (defcustom py-indent-offset 4 |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 114 | "*Amount of offset per level of indentation. |
| 115 | `\\[py-guess-indent-offset]' can usually guess a good value when |
| 116 | you're editing someone else's Python code." |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 117 | :type 'integer |
| 118 | :group 'python) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 119 | |
Barry Warsaw | fd4c9e8 | 2001-06-18 23:40:35 +0000 | [diff] [blame] | 120 | (defcustom py-continuation-offset 4 |
Barry Warsaw | 40fb452 | 2001-07-06 20:07:13 +0000 | [diff] [blame] | 121 | "*Additional amount of offset to give for some continuation lines. |
Barry Warsaw | fd4c9e8 | 2001-06-18 23:40:35 +0000 | [diff] [blame] | 122 | Continuation lines are those that immediately follow a backslash |
Barry Warsaw | 40fb452 | 2001-07-06 20:07:13 +0000 | [diff] [blame] | 123 | terminated line. Only those continuation lines for a block opening |
| 124 | statement are given this extra offset." |
Barry Warsaw | fd4c9e8 | 2001-06-18 23:40:35 +0000 | [diff] [blame] | 125 | :type 'integer |
| 126 | :group 'python) |
| 127 | |
Barry Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 128 | (defcustom py-smart-indentation t |
| 129 | "*Should `python-mode' try to automagically set some indentation variables? |
| 130 | When this variable is non-nil, two things happen when a buffer is set |
| 131 | to `python-mode': |
| 132 | |
Barry Warsaw | c0d2d51 | 1999-06-03 22:18:59 +0000 | [diff] [blame] | 133 | 1. `py-indent-offset' is guessed from existing code in the buffer. |
Barry Warsaw | 639eea6 | 1998-03-16 18:12:13 +0000 | [diff] [blame] | 134 | Only guessed values between 2 and 8 are considered. If a valid |
Barry Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 135 | guess can't be made (perhaps because you are visiting a new |
Barry Warsaw | 639eea6 | 1998-03-16 18:12:13 +0000 | [diff] [blame] | 136 | file), then the value in `py-indent-offset' is used. |
Barry Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 137 | |
Barry Warsaw | 639eea6 | 1998-03-16 18:12:13 +0000 | [diff] [blame] | 138 | 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 Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 143 | |
Barry Warsaw | 8046bef | 1998-03-13 20:04:52 +0000 | [diff] [blame] | 144 | Note that both these settings occur *after* `python-mode-hook' is run, |
| 145 | so if you want to defeat the automagic configuration, you must also |
| 146 | set `py-smart-indentation' to nil in your `python-mode-hook'." |
Barry Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 147 | :type 'boolean |
| 148 | :group 'python) |
| 149 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 150 | (defcustom py-align-multiline-strings-p t |
| 151 | "*Flag describing how multi-line triple quoted strings are aligned. |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 152 | When this flag is non-nil, continuation lines are lined up under the |
| 153 | preceding line's indentation. When this flag is nil, continuation |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 154 | lines 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 Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 158 | |
Barry Warsaw | 218eb75 | 1998-09-22 19:51:47 +0000 | [diff] [blame] | 159 | (defcustom py-block-comment-prefix "##" |
Barry Warsaw | 867a32a | 1996-03-07 18:30:26 +0000 | [diff] [blame] | 160 | "*String used by \\[comment-region] to comment out a block of code. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 161 | This should follow the convention for non-indenting comment lines so |
| 162 | that the indentation commands won't get confused (i.e., the string |
| 163 | should be of the form `#x...' where `x' is not a blank or a tab, and |
Barry Warsaw | 218eb75 | 1998-09-22 19:51:47 +0000 | [diff] [blame] | 164 | `...' is arbitrary). However, this string should not end in whitespace." |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 165 | :type 'string |
| 166 | :group 'python) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 167 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 168 | (defcustom py-honor-comment-indentation t |
Barry Warsaw | 6d62775 | 1996-03-06 18:41:38 +0000 | [diff] [blame] | 169 | "*Controls how comment lines influence subsequent indentation. |
Barry Warsaw | 33d6ec0 | 1996-03-05 16:28:07 +0000 | [diff] [blame] | 170 | |
Barry Warsaw | 6d62775 | 1996-03-06 18:41:38 +0000 | [diff] [blame] | 171 | When nil, all comment lines are skipped for indentation purposes, and |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 172 | if possible, a faster algorithm is used (i.e. X/Emacs 19 and beyond). |
Barry Warsaw | 6d62775 | 1996-03-06 18:41:38 +0000 | [diff] [blame] | 173 | |
| 174 | When t, lines that begin with a single `#' are a hint to subsequent |
| 175 | line indentation. If the previous line is such a comment line (as |
Barry Warsaw | 145ab1c | 1998-05-19 14:49:49 +0000 | [diff] [blame] | 176 | opposed to one that starts with `py-block-comment-prefix'), then its |
Barry Warsaw | 6d62775 | 1996-03-06 18:41:38 +0000 | [diff] [blame] | 177 | indentation is used as a hint for this line's indentation. Lines that |
| 178 | begin with `py-block-comment-prefix' are ignored for indentation |
| 179 | purposes. |
| 180 | |
Barry Warsaw | d36cfe4 | 2002-03-15 16:46:46 +0000 | [diff] [blame] | 181 | When not nil or t, comment lines that begin with a single `#' are used |
| 182 | as indentation hints, unless the comment character is in column zero." |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 183 | :type '(choice |
| 184 | (const :tag "Skip all comment lines (fast)" nil) |
| 185 | (const :tag "Single # `sets' indentation for next line" t) |
Barry Warsaw | affc0ca | 1997-11-03 16:59:38 +0000 | [diff] [blame] | 186 | (const :tag "Single # `sets' indentation except at column zero" |
| 187 | other) |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 188 | ) |
| 189 | :group 'python) |
Barry Warsaw | 33d6ec0 | 1996-03-05 16:28:07 +0000 | [diff] [blame] | 190 | |
Barry Warsaw | 516b620 | 1997-08-09 06:43:20 +0000 | [diff] [blame] | 191 | (defcustom py-temp-directory |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 192 | (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 Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 198 | (or (funcall ok (getenv "TMPDIR")) |
| 199 | (funcall ok "/usr/tmp") |
| 200 | (funcall ok "/tmp") |
Barry Warsaw | d164837 | 2002-03-18 18:53:56 +0000 | [diff] [blame] | 201 | (funcall ok "/var/tmp") |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 202 | (funcall ok ".") |
| 203 | (error |
Barry Warsaw | 6c6db0a | 1998-02-25 16:33:56 +0000 | [diff] [blame] | 204 | "Couldn't find a usable temp directory -- set `py-temp-directory'"))) |
Barry Warsaw | d164837 | 2002-03-18 18:53:56 +0000 | [diff] [blame] | 205 | "*Directory used for temporary files created by a *Python* process. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 206 | By default, the first directory from this list that exists and that you |
Barry Warsaw | d164837 | 2002-03-18 18:53:56 +0000 | [diff] [blame] | 207 | can write into: the value (if any) of the environment variable TMPDIR, |
| 208 | /usr/tmp, /tmp, /var/tmp, or the current directory." |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 209 | :type 'string |
| 210 | :group 'python) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 211 | |
Barry Warsaw | 516b620 | 1997-08-09 06:43:20 +0000 | [diff] [blame] | 212 | (defcustom py-beep-if-tab-change t |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 213 | "*Ring the bell if `tab-width' is changed. |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 214 | If a comment of the form |
| 215 | |
| 216 | \t# vi:set tabsize=<number>: |
| 217 | |
| 218 | is found before the first code line when the file is entered, and the |
| 219 | current value of (the general Emacs variable) `tab-width' does not |
| 220 | equal <number>, `tab-width' is set to <number>, a message saying so is |
| 221 | displayed in the echo area, and if `py-beep-if-tab-change' is non-nil |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 222 | the Emacs bell is also rung as a warning." |
| 223 | :type 'boolean |
| 224 | :group 'python) |
| 225 | |
Barry Warsaw | 9981d22 | 1997-12-03 05:25:48 +0000 | [diff] [blame] | 226 | (defcustom py-jump-on-exception t |
| 227 | "*Jump to innermost exception frame in *Python Output* buffer. |
Barry Warsaw | 12c9294 | 1998-08-10 21:44:37 +0000 | [diff] [blame] | 228 | When this variable is non-nil and an exception occurs when running |
Barry Warsaw | 9981d22 | 1997-12-03 05:25:48 +0000 | [diff] [blame] | 229 | Python code synchronously in a subprocess, jump immediately to the |
Barry Warsaw | 12c9294 | 1998-08-10 21:44:37 +0000 | [diff] [blame] | 230 | source code of the innermost traceback frame." |
Barry Warsaw | 3bfed5b | 1998-05-19 16:25:04 +0000 | [diff] [blame] | 231 | :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. |
| 236 | Otherwise, all modified buffers are saved without asking." |
| 237 | :type 'boolean |
| 238 | :group 'python) |
Barry Warsaw | 9981d22 | 1997-12-03 05:25:48 +0000 | [diff] [blame] | 239 | |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 240 | (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 Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 250 | (defcustom py-imenu-show-method-args-p nil |
| 251 | "*Controls echoing of arguments of functions & methods in the Imenu buffer. |
| 252 | When non-nil, arguments are printed." |
| 253 | :type 'boolean |
| 254 | :group 'python) |
| 255 | (make-variable-buffer-local 'py-indent-offset) |
| 256 | |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 257 | (defcustom py-pdbtrack-do-tracking-p t |
| 258 | "*Controls whether the pdbtrack feature is enabled or not. |
| 259 | When non-nil, pdbtrack is enabled in all comint-based buffers, |
| 260 | e.g. shell buffers and the *Python* buffer. When using pdb to debug a |
| 261 | Python program, pdbtrack notices the pdb prompt and displays the |
| 262 | source file and line that the program is stopped at, much the same way |
| 263 | as 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 Warsaw | c0ecb53 | 1998-01-20 21:43:34 +0000 | [diff] [blame] | 273 | ;; Not customizable |
| 274 | (defvar py-master-file nil |
| 275 | "If non-nil, execute the named file instead of the buffer's file. |
Barry Warsaw | 50b3eb6 | 1998-02-25 15:57:47 +0000 | [diff] [blame] | 276 | The intent is to allow you to set this variable in the file's local |
Barry Warsaw | c0ecb53 | 1998-01-20 21:43:34 +0000 | [diff] [blame] | 277 | variable section, e.g.: |
| 278 | |
| 279 | # Local Variables: |
| 280 | # py-master-file: \"master.py\" |
| 281 | # End: |
| 282 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 283 | so that typing \\[py-execute-buffer] in that buffer executes the named |
Barry Warsaw | 1bbc031 | 1998-10-27 21:54:56 +0000 | [diff] [blame] | 284 | master file instead of the buffer's file. If the file name has a |
| 285 | relative path, the value of variable `default-directory' for the |
| 286 | buffer is prepended to come up with a file name.") |
Barry Warsaw | c0ecb53 | 1998-01-20 21:43:34 +0000 | [diff] [blame] | 287 | (make-variable-buffer-local 'py-master-file) |
| 288 | |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 289 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 290 | |
| 291 | ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| 292 | ;; NO USER DEFINABLE VARIABLES BEYOND THIS POINT |
| 293 | |
Barry Warsaw | 5e21cb0 | 1997-11-05 18:41:11 +0000 | [diff] [blame] | 294 | (defconst py-emacs-features |
| 295 | (let (features) |
Barry Warsaw | 5e21cb0 | 1997-11-05 18:41:11 +0000 | [diff] [blame] | 296 | features) |
Barry Warsaw | c12c62e | 1997-09-04 04:18:07 +0000 | [diff] [blame] | 297 | "A list of features extant in the Emacs you are using. |
Barry Warsaw | 6ae21ad | 1997-11-06 14:36:49 +0000 | [diff] [blame] | 298 | There are many flavors of Emacs out there, with different levels of |
| 299 | support for features needed by `python-mode'.") |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 300 | |
Barry Warsaw | fb07f40 | 1997-02-24 03:37:22 +0000 | [diff] [blame] | 301 | (defvar python-font-lock-keywords |
Barry Warsaw | b8f1166 | 1997-11-06 14:35:15 +0000 | [diff] [blame] | 302 | (let ((kw1 (mapconcat 'identity |
| 303 | '("and" "assert" "break" "class" |
| 304 | "continue" "def" "del" "elif" |
| 305 | "else" "except" "exec" "for" |
| 306 | "from" "global" "if" "import" |
| 307 | "in" "is" "lambda" "not" |
| 308 | "or" "pass" "print" "raise" |
Barry Warsaw | e275c42 | 2001-06-19 18:24:42 +0000 | [diff] [blame] | 309 | "return" "while" "yield" |
Barry Warsaw | b8f1166 | 1997-11-06 14:35:15 +0000 | [diff] [blame] | 310 | ) |
| 311 | "\\|")) |
| 312 | (kw2 (mapconcat 'identity |
| 313 | '("else:" "except:" "finally:" "try:") |
| 314 | "\\|")) |
| 315 | ) |
Barry Warsaw | 33ab6e4 | 1996-03-05 00:44:31 +0000 | [diff] [blame] | 316 | (list |
Barry Warsaw | ef3c891 | 1997-11-05 18:55:50 +0000 | [diff] [blame] | 317 | ;; keywords |
Barry Warsaw | b8f1166 | 1997-11-06 14:35:15 +0000 | [diff] [blame] | 318 | (cons (concat "\\b\\(" kw1 "\\)\\b[ \n\t(]") 1) |
| 319 | ;; block introducing keywords with immediately following colons. |
| 320 | ;; Yes "except" is in both lists. |
| 321 | (cons (concat "\\b\\(" kw2 "\\)[ \n\t(]") 1) |
Barry Warsaw | e0c182f | 2000-12-27 17:41:47 +0000 | [diff] [blame] | 322 | ;; `as' but only in "import foo as bar" |
| 323 | '("[ \t]*\\(\\bfrom\\b.*\\)?\\bimport\\b.*\\b\\(as\\)\\b" . 2) |
Barry Warsaw | 33ab6e4 | 1996-03-05 00:44:31 +0000 | [diff] [blame] | 324 | ;; classes |
| 325 | '("\\bclass[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)" |
| 326 | 1 font-lock-type-face) |
| 327 | ;; functions |
| 328 | '("\\bdef[ \t]+\\([a-zA-Z_]+[a-zA-Z0-9_]*\\)" |
| 329 | 1 font-lock-function-name-face) |
| 330 | )) |
Barry Warsaw | 62d9d6e | 1996-03-06 20:32:27 +0000 | [diff] [blame] | 331 | "Additional expressions to highlight in Python mode.") |
Barry Warsaw | fb07f40 | 1997-02-24 03:37:22 +0000 | [diff] [blame] | 332 | (put 'python-mode 'font-lock-defaults '(python-font-lock-keywords)) |
| 333 | |
Barry Warsaw | e467bfb | 1997-11-26 05:40:58 +0000 | [diff] [blame] | 334 | ;; have to bind py-file-queue before installing the kill-emacs-hook |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 335 | (defvar py-file-queue nil |
| 336 | "Queue of Python temp files awaiting execution. |
| 337 | Currently-active file is at the head of the list.") |
| 338 | |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 339 | (defvar py-pdbtrack-is-tracking-p nil) |
| 340 | |
| 341 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 342 | |
| 343 | ;; Constants |
| 344 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 345 | (defconst py-stringlit-re |
| 346 | (concat |
Barry Warsaw | 751f493 | 1998-05-19 16:06:21 +0000 | [diff] [blame] | 347 | ;; These fail if backslash-quote ends the string (not worth |
| 348 | ;; fixing?). They precede the short versions so that the first two |
| 349 | ;; quotes don't look like an empty short string. |
| 350 | ;; |
| 351 | ;; (maybe raw), long single quoted triple quoted strings (SQTQ), |
| 352 | ;; with potential embedded single quotes |
| 353 | "[rR]?'''[^']*\\(\\('[^']\\|''[^']\\)[^']*\\)*'''" |
| 354 | "\\|" |
| 355 | ;; (maybe raw), long double quoted triple quoted strings (DQTQ), |
| 356 | ;; with potential embedded double quotes |
| 357 | "[rR]?\"\"\"[^\"]*\\(\\(\"[^\"]\\|\"\"[^\"]\\)[^\"]*\\)*\"\"\"" |
| 358 | "\\|" |
| 359 | "[rR]?'\\([^'\n\\]\\|\\\\.\\)*'" ; single-quoted |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 360 | "\\|" ; or |
Barry Warsaw | 751f493 | 1998-05-19 16:06:21 +0000 | [diff] [blame] | 361 | "[rR]?\"\\([^\"\n\\]\\|\\\\.\\)*\"" ; double-quoted |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 362 | ) |
| 363 | "Regular expression matching a Python string literal.") |
Barry Warsaw | 751f493 | 1998-05-19 16:06:21 +0000 | [diff] [blame] | 364 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 365 | (defconst py-continued-re |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 366 | ;; This is tricky because a trailing backslash does not mean |
| 367 | ;; continuation if it's in a comment |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 368 | (concat |
| 369 | "\\(" "[^#'\"\n\\]" "\\|" py-stringlit-re "\\)*" |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 370 | "\\\\$") |
| 371 | "Regular expression matching Python backslash continuation lines.") |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 372 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 373 | (defconst py-blank-or-comment-re "[ \t]*\\($\\|#\\)" |
Barry Warsaw | 71c3adb | 1998-08-10 16:34:33 +0000 | [diff] [blame] | 374 | "Regular expression matching a blank or comment line.") |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 375 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 376 | (defconst py-outdent-re |
| 377 | (concat "\\(" (mapconcat 'identity |
| 378 | '("else:" |
| 379 | "except\\(\\s +.*\\)?:" |
| 380 | "finally:" |
| 381 | "elif\\s +.*:") |
| 382 | "\\|") |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 383 | "\\)") |
| 384 | "Regular expression matching statements to be dedented one level.") |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 385 | |
Barry Warsaw | affc0ca | 1997-11-03 16:59:38 +0000 | [diff] [blame] | 386 | (defconst py-block-closing-keywords-re |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 387 | "\\(return\\|raise\\|break\\|continue\\|pass\\)" |
| 388 | "Regular expression matching keywords which typically close a block.") |
Barry Warsaw | affc0ca | 1997-11-03 16:59:38 +0000 | [diff] [blame] | 389 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 390 | (defconst py-no-outdent-re |
Barry Warsaw | affc0ca | 1997-11-03 16:59:38 +0000 | [diff] [blame] | 391 | (concat |
| 392 | "\\(" |
| 393 | (mapconcat 'identity |
| 394 | (list "try:" |
| 395 | "except\\(\\s +.*\\)?:" |
| 396 | "while\\s +.*:" |
| 397 | "for\\s +.*:" |
| 398 | "if\\s +.*:" |
| 399 | "elif\\s +.*:" |
| 400 | (concat py-block-closing-keywords-re "[ \t\n]") |
| 401 | ) |
| 402 | "\\|") |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 403 | "\\)") |
| 404 | "Regular expression matching lines not to dedent after.") |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 405 | |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 406 | (defconst py-defun-start-re |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 407 | "^\\([ \t]*\\)def[ \t]+\\([a-zA-Z_0-9]+\\)\\|\\(^[a-zA-Z_0-9]+\\)[ \t]*=" |
| 408 | ;; If you change this, you probably have to change py-current-defun |
| 409 | ;; as well. This is only used by py-current-defun to find the name |
| 410 | ;; for add-log.el. |
Barry Warsaw | 71c3adb | 1998-08-10 16:34:33 +0000 | [diff] [blame] | 411 | "Regular expression matching a function, method, or variable assignment.") |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 412 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 413 | (defconst py-class-start-re "^class[ \t]*\\([a-zA-Z_0-9]+\\)" |
| 414 | ;; If you change this, you probably have to change py-current-defun |
| 415 | ;; as well. This is only used by py-current-defun to find the name |
| 416 | ;; for add-log.el. |
| 417 | "Regular expression for finding a class name.") |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 418 | |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 419 | (defconst py-traceback-line-re |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 420 | "[ \t]+File \"\\([^\"]+\\)\", line \\([0-9]+\\)" |
| 421 | "Regular expression that describes tracebacks.") |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 422 | |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 423 | ;; pdbtrack contants |
| 424 | (defconst py-pdbtrack-stack-entry-regexp |
| 425 | "> \\([^(]+\\)(\\([0-9]+\\))[?a-zA-Z0-9_]+()" |
| 426 | "Regular expression pdbtrack uses to find a stack trace entry.") |
| 427 | |
| 428 | (defconst py-pdbtrack-input-prompt "\n[(<]?pdb[>)]? " |
| 429 | "Regular expression pdbtrack uses to recognize a pdb prompt.") |
| 430 | |
| 431 | (defconst py-pdbtrack-track-range 10000 |
| 432 | "Max number of characters from end of buffer to search for stack entry.") |
| 433 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 434 | |
| 435 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 436 | ;; Major mode boilerplate |
| 437 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 438 | ;; define a mode-specific abbrev table for those who use such things |
| 439 | (defvar python-mode-abbrev-table nil |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 440 | "Abbrev table in use in `python-mode' buffers.") |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 441 | (define-abbrev-table 'python-mode-abbrev-table nil) |
| 442 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 443 | (defvar python-mode-hook nil |
| 444 | "*Hook called by `python-mode'.") |
| 445 | |
Barry Warsaw | 145ab1c | 1998-05-19 14:49:49 +0000 | [diff] [blame] | 446 | ;; In previous version of python-mode.el, the hook was incorrectly |
| 447 | ;; called py-mode-hook, and was not defvar'd. Deprecate its use. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 448 | (and (fboundp 'make-obsolete-variable) |
| 449 | (make-obsolete-variable 'py-mode-hook 'python-mode-hook)) |
| 450 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 451 | (defvar py-mode-map () |
| 452 | "Keymap used in `python-mode' buffers.") |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 453 | (if py-mode-map |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 454 | nil |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 455 | (setq py-mode-map (make-sparse-keymap)) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 456 | ;; electric keys |
| 457 | (define-key py-mode-map ":" 'py-electric-colon) |
| 458 | ;; indentation level modifiers |
| 459 | (define-key py-mode-map "\C-c\C-l" 'py-shift-region-left) |
| 460 | (define-key py-mode-map "\C-c\C-r" 'py-shift-region-right) |
| 461 | (define-key py-mode-map "\C-c<" 'py-shift-region-left) |
| 462 | (define-key py-mode-map "\C-c>" 'py-shift-region-right) |
| 463 | ;; subprocess commands |
| 464 | (define-key py-mode-map "\C-c\C-c" 'py-execute-buffer) |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 465 | (define-key py-mode-map "\C-c\C-m" 'py-execute-import-or-reload) |
Barry Warsaw | 1d0364b | 1998-05-19 16:15:26 +0000 | [diff] [blame] | 466 | (define-key py-mode-map "\C-c\C-s" 'py-execute-string) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 467 | (define-key py-mode-map "\C-c|" 'py-execute-region) |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 468 | (define-key py-mode-map "\e\C-x" 'py-execute-def-or-class) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 469 | (define-key py-mode-map "\C-c!" 'py-shell) |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 470 | (define-key py-mode-map "\C-c\C-t" 'py-toggle-shells) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 471 | ;; Caution! Enter here at your own risk. We are trying to support |
| 472 | ;; several behaviors and it gets disgusting. :-( This logic ripped |
| 473 | ;; largely from CC Mode. |
| 474 | ;; |
| 475 | ;; In XEmacs 19, Emacs 19, and Emacs 20, we use this to bind |
| 476 | ;; backwards deletion behavior to DEL, which both Delete and |
| 477 | ;; Backspace get translated to. There's no way to separate this |
| 478 | ;; behavior in a clean way, so deal with it! Besides, it's been |
| 479 | ;; this way since the dawn of time. |
| 480 | (if (not (boundp 'delete-key-deletes-forward)) |
| 481 | (define-key py-mode-map "\177" 'py-electric-backspace) |
| 482 | ;; However, XEmacs 20 actually achieved enlightenment. It is |
| 483 | ;; possible to sanely define both backward and forward deletion |
| 484 | ;; behavior under X separately (TTYs are forever beyond hope, but |
| 485 | ;; who cares? XEmacs 20 does the right thing with these too). |
| 486 | (define-key py-mode-map [delete] 'py-electric-delete) |
| 487 | (define-key py-mode-map [backspace] 'py-electric-backspace)) |
Barry Warsaw | 8c4a8de | 1997-11-26 20:30:33 +0000 | [diff] [blame] | 488 | ;; Separate M-BS from C-M-h. The former should remain |
| 489 | ;; backward-kill-word. |
| 490 | (define-key py-mode-map [(control meta h)] 'py-mark-def-or-class) |
Barry Warsaw | 2518c67 | 1997-11-05 00:51:08 +0000 | [diff] [blame] | 491 | (define-key py-mode-map "\C-c\C-k" 'py-mark-block) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 492 | ;; Miscellaneous |
| 493 | (define-key py-mode-map "\C-c:" 'py-guess-indent-offset) |
| 494 | (define-key py-mode-map "\C-c\t" 'py-indent-region) |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 495 | (define-key py-mode-map "\C-c\C-d" 'py-pdbtrack-toggle-stack-tracking) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 496 | (define-key py-mode-map "\C-c\C-n" 'py-next-statement) |
| 497 | (define-key py-mode-map "\C-c\C-p" 'py-previous-statement) |
| 498 | (define-key py-mode-map "\C-c\C-u" 'py-goto-block-up) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 499 | (define-key py-mode-map "\C-c#" 'py-comment-region) |
| 500 | (define-key py-mode-map "\C-c?" 'py-describe-mode) |
| 501 | (define-key py-mode-map "\C-c\C-hm" 'py-describe-mode) |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 502 | (define-key py-mode-map "\e\C-a" 'py-beginning-of-def-or-class) |
| 503 | (define-key py-mode-map "\e\C-e" 'py-end-of-def-or-class) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 504 | (define-key py-mode-map "\C-c-" 'py-up-exception) |
| 505 | (define-key py-mode-map "\C-c=" 'py-down-exception) |
Barry Warsaw | f8ddb6a | 1999-01-18 21:49:39 +0000 | [diff] [blame] | 506 | ;; stuff that is `standard' but doesn't interface well with |
| 507 | ;; python-mode, which forces us to rebind to special commands |
| 508 | (define-key py-mode-map "\C-xnd" 'py-narrow-to-defun) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 509 | ;; information |
| 510 | (define-key py-mode-map "\C-c\C-b" 'py-submit-bug-report) |
| 511 | (define-key py-mode-map "\C-c\C-v" 'py-version) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 512 | ;; shadow global bindings for newline-and-indent w/ the py- version. |
| 513 | ;; BAW - this is extremely bad form, but I'm not going to change it |
| 514 | ;; for now. |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 515 | (mapcar #'(lambda (key) |
| 516 | (define-key py-mode-map key 'py-newline-and-indent)) |
| 517 | (where-is-internal 'newline-and-indent)) |
Barry Warsaw | f19feb8 | 1999-01-21 17:06:11 +0000 | [diff] [blame] | 518 | ;; Force RET to be py-newline-and-indent even if it didn't get |
| 519 | ;; mapped by the above code. motivation: Emacs' default binding for |
| 520 | ;; RET is `newline' and C-j is `newline-and-indent'. Most Pythoneers |
| 521 | ;; expect RET to do a `py-newline-and-indent' and any Emacsers who |
| 522 | ;; dislike this are probably knowledgeable enough to do a rebind. |
| 523 | ;; However, we do *not* change C-j since many Emacsers have already |
| 524 | ;; swapped RET and C-j and they don't want C-j bound to `newline' to |
| 525 | ;; change. |
| 526 | (define-key py-mode-map "\C-m" 'py-newline-and-indent) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 527 | ) |
| 528 | |
| 529 | (defvar py-mode-output-map nil |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 530 | "Keymap used in *Python Output* buffers.") |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 531 | (if py-mode-output-map |
| 532 | nil |
| 533 | (setq py-mode-output-map (make-sparse-keymap)) |
| 534 | (define-key py-mode-output-map [button2] 'py-mouseto-exception) |
| 535 | (define-key py-mode-output-map "\C-c\C-c" 'py-goto-exception) |
| 536 | ;; TBD: Disable all self-inserting keys. This is bogus, we should |
| 537 | ;; really implement this as *Python Output* buffer being read-only |
| 538 | (mapcar #' (lambda (key) |
| 539 | (define-key py-mode-output-map key |
| 540 | #'(lambda () (interactive) (beep)))) |
| 541 | (where-is-internal 'self-insert-command)) |
Barry Warsaw | 850437a | 1995-03-08 21:50:28 +0000 | [diff] [blame] | 542 | ) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 543 | |
Barry Warsaw | 6dfbe5d | 1998-08-20 21:51:27 +0000 | [diff] [blame] | 544 | (defvar py-shell-map nil |
| 545 | "Keymap used in *Python* shell buffers.") |
| 546 | (if py-shell-map |
| 547 | nil |
| 548 | (setq py-shell-map (copy-keymap comint-mode-map)) |
| 549 | (define-key py-shell-map [tab] 'tab-to-tab-stop) |
| 550 | (define-key py-shell-map "\C-c-" 'py-up-exception) |
| 551 | (define-key py-shell-map "\C-c=" 'py-down-exception) |
| 552 | ) |
| 553 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 554 | (defvar py-mode-syntax-table nil |
| 555 | "Syntax table used in `python-mode' buffers.") |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 556 | (if py-mode-syntax-table |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 557 | nil |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 558 | (setq py-mode-syntax-table (make-syntax-table)) |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 559 | (modify-syntax-entry ?\( "()" py-mode-syntax-table) |
| 560 | (modify-syntax-entry ?\) ")(" py-mode-syntax-table) |
| 561 | (modify-syntax-entry ?\[ "(]" py-mode-syntax-table) |
| 562 | (modify-syntax-entry ?\] ")[" py-mode-syntax-table) |
| 563 | (modify-syntax-entry ?\{ "(}" py-mode-syntax-table) |
| 564 | (modify-syntax-entry ?\} "){" py-mode-syntax-table) |
| 565 | ;; Add operator symbols misassigned in the std table |
| 566 | (modify-syntax-entry ?\$ "." py-mode-syntax-table) |
| 567 | (modify-syntax-entry ?\% "." py-mode-syntax-table) |
| 568 | (modify-syntax-entry ?\& "." py-mode-syntax-table) |
| 569 | (modify-syntax-entry ?\* "." py-mode-syntax-table) |
| 570 | (modify-syntax-entry ?\+ "." py-mode-syntax-table) |
| 571 | (modify-syntax-entry ?\- "." py-mode-syntax-table) |
| 572 | (modify-syntax-entry ?\/ "." py-mode-syntax-table) |
| 573 | (modify-syntax-entry ?\< "." py-mode-syntax-table) |
| 574 | (modify-syntax-entry ?\= "." py-mode-syntax-table) |
| 575 | (modify-syntax-entry ?\> "." py-mode-syntax-table) |
| 576 | (modify-syntax-entry ?\| "." py-mode-syntax-table) |
| 577 | ;; For historical reasons, underscore is word class instead of |
| 578 | ;; symbol class. GNU conventions say it should be symbol class, but |
| 579 | ;; there's a natural conflict between what major mode authors want |
| 580 | ;; and what users expect from `forward-word' and `backward-word'. |
| 581 | ;; Guido and I have hashed this out and have decided to keep |
| 582 | ;; underscore in word class. If you're tempted to change it, try |
| 583 | ;; binding M-f and M-b to py-forward-into-nomenclature and |
Barry Warsaw | aa384fd | 1999-02-16 23:36:16 +0000 | [diff] [blame] | 584 | ;; py-backward-into-nomenclature instead. This doesn't help in all |
| 585 | ;; situations where you'd want the different behavior |
| 586 | ;; (e.g. backward-kill-word). |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 587 | (modify-syntax-entry ?\_ "w" py-mode-syntax-table) |
| 588 | ;; Both single quote and double quote are string delimiters |
| 589 | (modify-syntax-entry ?\' "\"" py-mode-syntax-table) |
| 590 | (modify-syntax-entry ?\" "\"" py-mode-syntax-table) |
| 591 | ;; backquote is open and close paren |
| 592 | (modify-syntax-entry ?\` "$" py-mode-syntax-table) |
| 593 | ;; comment delimiters |
| 594 | (modify-syntax-entry ?\# "<" py-mode-syntax-table) |
| 595 | (modify-syntax-entry ?\n ">" py-mode-syntax-table) |
| 596 | ) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 597 | |
Barry Warsaw | b3e81d5 | 1996-09-04 15:12:42 +0000 | [diff] [blame] | 598 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 599 | |
Barry Warsaw | bc3760b | 1998-09-14 16:16:18 +0000 | [diff] [blame] | 600 | ;; Utilities |
| 601 | |
| 602 | (defmacro py-safe (&rest body) |
| 603 | "Safely execute BODY, return nil if an error occurred." |
| 604 | (` (condition-case nil |
| 605 | (progn (,@ body)) |
| 606 | (error nil)))) |
| 607 | |
| 608 | (defsubst py-keep-region-active () |
| 609 | "Keep the region active in XEmacs." |
| 610 | ;; Ignore byte-compiler warnings you might see. Also note that |
| 611 | ;; FSF's Emacs 19 does it differently; its policy doesn't require us |
| 612 | ;; to take explicit action. |
| 613 | (and (boundp 'zmacs-region-stays) |
| 614 | (setq zmacs-region-stays t))) |
| 615 | |
| 616 | (defsubst py-point (position) |
| 617 | "Returns the value of point at certain commonly referenced POSITIONs. |
| 618 | POSITION can be one of the following symbols: |
| 619 | |
| 620 | bol -- beginning of line |
| 621 | eol -- end of line |
| 622 | bod -- beginning of def or class |
| 623 | eod -- end of def or class |
| 624 | bob -- beginning of buffer |
| 625 | eob -- end of buffer |
| 626 | boi -- back to indentation |
| 627 | bos -- beginning of statement |
| 628 | |
| 629 | This function does not modify point or mark." |
| 630 | (let ((here (point))) |
| 631 | (cond |
| 632 | ((eq position 'bol) (beginning-of-line)) |
| 633 | ((eq position 'eol) (end-of-line)) |
| 634 | ((eq position 'bod) (py-beginning-of-def-or-class)) |
| 635 | ((eq position 'eod) (py-end-of-def-or-class)) |
| 636 | ;; Kind of funny, I know, but useful for py-up-exception. |
| 637 | ((eq position 'bob) (beginning-of-buffer)) |
| 638 | ((eq position 'eob) (end-of-buffer)) |
| 639 | ((eq position 'boi) (back-to-indentation)) |
| 640 | ((eq position 'bos) (py-goto-initial-line)) |
| 641 | (t (error "Unknown buffer position requested: %s" position)) |
| 642 | ) |
| 643 | (prog1 |
| 644 | (point) |
| 645 | (goto-char here)))) |
| 646 | |
| 647 | (defsubst py-highlight-line (from to file line) |
| 648 | (cond |
| 649 | ((fboundp 'make-extent) |
| 650 | ;; XEmacs |
| 651 | (let ((e (make-extent from to))) |
| 652 | (set-extent-property e 'mouse-face 'highlight) |
| 653 | (set-extent-property e 'py-exc-info (cons file line)) |
| 654 | (set-extent-property e 'keymap py-mode-output-map))) |
| 655 | (t |
| 656 | ;; Emacs -- Please port this! |
| 657 | ) |
| 658 | )) |
| 659 | |
| 660 | (defun py-in-literal (&optional lim) |
| 661 | "Return non-nil if point is in a Python literal (a comment or string). |
| 662 | Optional argument LIM indicates the beginning of the containing form, |
| 663 | i.e. the limit on how far back to scan." |
| 664 | ;; This is the version used for non-XEmacs, which has a nicer |
| 665 | ;; interface. |
| 666 | ;; |
| 667 | ;; WARNING: Watch out for infinite recursion. |
| 668 | (let* ((lim (or lim (py-point 'bod))) |
| 669 | (state (parse-partial-sexp lim (point)))) |
| 670 | (cond |
| 671 | ((nth 3 state) 'string) |
| 672 | ((nth 4 state) 'comment) |
| 673 | (t nil)))) |
| 674 | |
| 675 | ;; XEmacs has a built-in function that should make this much quicker. |
| 676 | ;; In this case, lim is ignored |
| 677 | (defun py-fast-in-literal (&optional lim) |
| 678 | "Fast version of `py-in-literal', used only by XEmacs. |
| 679 | Optional LIM is ignored." |
| 680 | ;; don't have to worry about context == 'block-comment |
| 681 | (buffer-syntactic-context)) |
| 682 | |
| 683 | (if (fboundp 'buffer-syntactic-context) |
| 684 | (defalias 'py-in-literal 'py-fast-in-literal)) |
| 685 | |
| 686 | |
| 687 | |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 688 | ;; Menu definitions, only relevent if you have the easymenu.el package |
| 689 | ;; (standard in the latest Emacs 19 and XEmacs 19 distributions). |
Barry Warsaw | 5490a06 | 1996-08-06 15:43:33 +0000 | [diff] [blame] | 690 | (defvar py-menu nil |
| 691 | "Menu for Python Mode. |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 692 | This menu will get created automatically if you have the `easymenu' |
| 693 | package. Note that the latest X/Emacs releases contain this package.") |
Barry Warsaw | 5490a06 | 1996-08-06 15:43:33 +0000 | [diff] [blame] | 694 | |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 695 | (and (py-safe (require 'easymenu) t) |
| 696 | (easy-menu-define |
| 697 | py-menu py-mode-map "Python Mode menu" |
| 698 | '("Python" |
| 699 | ["Comment Out Region" py-comment-region (mark)] |
| 700 | ["Uncomment Region" (py-comment-region (point) (mark) '(4)) (mark)] |
| 701 | "-" |
| 702 | ["Mark current block" py-mark-block t] |
Barry Warsaw | 2518c67 | 1997-11-05 00:51:08 +0000 | [diff] [blame] | 703 | ["Mark current def" py-mark-def-or-class t] |
| 704 | ["Mark current class" (py-mark-def-or-class t) t] |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 705 | "-" |
| 706 | ["Shift region left" py-shift-region-left (mark)] |
| 707 | ["Shift region right" py-shift-region-right (mark)] |
| 708 | "-" |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 709 | ["Import/reload file" py-execute-import-or-reload t] |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 710 | ["Execute buffer" py-execute-buffer t] |
| 711 | ["Execute region" py-execute-region (mark)] |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 712 | ["Execute def or class" py-execute-def-or-class (mark)] |
Barry Warsaw | 1d0364b | 1998-05-19 16:15:26 +0000 | [diff] [blame] | 713 | ["Execute string" py-execute-string t] |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 714 | ["Start interpreter..." py-shell t] |
| 715 | "-" |
| 716 | ["Go to start of block" py-goto-block-up t] |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 717 | ["Go to start of class" (py-beginning-of-def-or-class t) t] |
| 718 | ["Move to end of class" (py-end-of-def-or-class t) t] |
| 719 | ["Move to start of def" py-beginning-of-def-or-class t] |
| 720 | ["Move to end of def" py-end-of-def-or-class t] |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 721 | "-" |
| 722 | ["Describe mode" py-describe-mode t] |
| 723 | ))) |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 724 | |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 725 | |
| 726 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 727 | ;; Imenu definitions |
| 728 | (defvar py-imenu-class-regexp |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 729 | (concat ; <<classes>> |
| 730 | "\\(" ; |
| 731 | "^[ \t]*" ; newline and maybe whitespace |
| 732 | "\\(class[ \t]+[a-zA-Z0-9_]+\\)" ; class name |
| 733 | ; possibly multiple superclasses |
Barry Warsaw | 3179fe0 | 1998-04-04 21:36:53 +0000 | [diff] [blame] | 734 | "\\([ \t]*\\((\\([a-zA-Z0-9_,. \t\n]\\)*)\\)?\\)" |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 735 | "[ \t]*:" ; and the final : |
| 736 | "\\)" ; >>classes<< |
| 737 | ) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 738 | "Regexp for Python classes for use with the Imenu package." |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 739 | ) |
| 740 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 741 | (defvar py-imenu-method-regexp |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 742 | (concat ; <<methods and functions>> |
| 743 | "\\(" ; |
| 744 | "^[ \t]*" ; new line and maybe whitespace |
| 745 | "\\(def[ \t]+" ; function definitions start with def |
| 746 | "\\([a-zA-Z0-9_]+\\)" ; name is here |
| 747 | ; function arguments... |
Barry Warsaw | 1d5f988 | 1998-10-28 04:08:13 +0000 | [diff] [blame] | 748 | ;; "[ \t]*(\\([-+/a-zA-Z0-9_=,\* \t\n.()\"'#]*\\))" |
| 749 | "[ \t]*(\\([^:#]*\\))" |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 750 | "\\)" ; end of def |
| 751 | "[ \t]*:" ; and then the : |
| 752 | "\\)" ; >>methods and functions<< |
| 753 | ) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 754 | "Regexp for Python methods/functions for use with the Imenu package." |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 755 | ) |
| 756 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 757 | (defvar py-imenu-method-no-arg-parens '(2 8) |
| 758 | "Indices into groups of the Python regexp for use with Imenu. |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 759 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 760 | Using these values will result in smaller Imenu lists, as arguments to |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 761 | functions are not listed. |
| 762 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 763 | See the variable `py-imenu-show-method-args-p' for more |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 764 | information.") |
| 765 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 766 | (defvar py-imenu-method-arg-parens '(2 7) |
Barry Warsaw | 1bbc031 | 1998-10-27 21:54:56 +0000 | [diff] [blame] | 767 | "Indices into groups of the Python regexp for use with imenu. |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 768 | Using these values will result in large Imenu lists, as arguments to |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 769 | functions are listed. |
| 770 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 771 | See the variable `py-imenu-show-method-args-p' for more |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 772 | information.") |
| 773 | |
| 774 | ;; Note that in this format, this variable can still be used with the |
| 775 | ;; imenu--generic-function. Otherwise, there is no real reason to have |
| 776 | ;; it. |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 777 | (defvar py-imenu-generic-expression |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 778 | (cons |
| 779 | (concat |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 780 | py-imenu-class-regexp |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 781 | "\\|" ; or... |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 782 | py-imenu-method-regexp |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 783 | ) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 784 | py-imenu-method-no-arg-parens) |
| 785 | "Generic Python expression which may be used directly with Imenu. |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 786 | Used by setting the variable `imenu-generic-expression' to this value. |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 787 | Also, see the function \\[py-imenu-create-index] for a better |
| 788 | alternative for finding the index.") |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 789 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 790 | ;; These next two variables are used when searching for the Python |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 791 | ;; class/definitions. Just saving some time in accessing the |
| 792 | ;; generic-python-expression, really. |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 793 | (defvar py-imenu-generic-regexp nil) |
| 794 | (defvar py-imenu-generic-parens nil) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 795 | |
| 796 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 797 | (defun py-imenu-create-index-function () |
| 798 | "Python interface function for the Imenu package. |
| 799 | Finds all Python classes and functions/methods. Calls function |
| 800 | \\[py-imenu-create-index-engine]. See that function for the details |
| 801 | of how this works." |
| 802 | (setq py-imenu-generic-regexp (car py-imenu-generic-expression) |
| 803 | py-imenu-generic-parens (if py-imenu-show-method-args-p |
| 804 | py-imenu-method-arg-parens |
| 805 | py-imenu-method-no-arg-parens)) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 806 | (goto-char (point-min)) |
Barry Warsaw | 1d5f988 | 1998-10-28 04:08:13 +0000 | [diff] [blame] | 807 | ;; Warning: When the buffer has no classes or functions, this will |
| 808 | ;; return nil, which seems proper according to the Imenu API, but |
| 809 | ;; causes an error in the XEmacs port of Imenu. Sigh. |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 810 | (py-imenu-create-index-engine nil)) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 811 | |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 812 | (defun py-imenu-create-index-engine (&optional start-indent) |
| 813 | "Function for finding Imenu definitions in Python. |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 814 | |
| 815 | Finds all definitions (classes, methods, or functions) in a Python |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 816 | file for the Imenu package. |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 817 | |
| 818 | Returns a possibly nested alist of the form |
| 819 | |
| 820 | (INDEX-NAME . INDEX-POSITION) |
| 821 | |
| 822 | The second element of the alist may be an alist, producing a nested |
| 823 | list as in |
| 824 | |
| 825 | (INDEX-NAME . INDEX-ALIST) |
| 826 | |
| 827 | This function should not be called directly, as it calls itself |
| 828 | recursively and requires some setup. Rather this is the engine for |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 829 | the function \\[py-imenu-create-index-function]. |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 830 | |
| 831 | It works recursively by looking for all definitions at the current |
| 832 | indention level. When it finds one, it adds it to the alist. If it |
| 833 | finds a definition at a greater indentation level, it removes the |
Barry Warsaw | 145ab1c | 1998-05-19 14:49:49 +0000 | [diff] [blame] | 834 | previous definition from the alist. In its place it adds all |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 835 | definitions found at the next indentation level. When it finds a |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 836 | definition that is less indented then the current level, it returns |
| 837 | the alist it has created thus far. |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 838 | |
| 839 | The optional argument START-INDENT indicates the starting indentation |
| 840 | at which to continue looking for Python classes, methods, or |
| 841 | functions. If this is not supplied, the function uses the indentation |
| 842 | of the first definition found." |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 843 | (let (index-alist |
| 844 | sub-method-alist |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 845 | looking-p |
| 846 | def-name prev-name |
| 847 | cur-indent def-pos |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 848 | (class-paren (first py-imenu-generic-parens)) |
| 849 | (def-paren (second py-imenu-generic-parens))) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 850 | (setq looking-p |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 851 | (re-search-forward py-imenu-generic-regexp (point-max) t)) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 852 | (while looking-p |
| 853 | (save-excursion |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 854 | ;; used to set def-name to this value but generic-extract-name |
| 855 | ;; is new to imenu-1.14. this way it still works with |
| 856 | ;; imenu-1.11 |
| 857 | ;;(imenu--generic-extract-name py-imenu-generic-parens)) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 858 | (let ((cur-paren (if (match-beginning class-paren) |
| 859 | class-paren def-paren))) |
| 860 | (setq def-name |
Barry Warsaw | c852035 | 1997-11-26 06:14:40 +0000 | [diff] [blame] | 861 | (buffer-substring-no-properties (match-beginning cur-paren) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 862 | (match-end cur-paren)))) |
Barry Warsaw | 93c88cc | 1998-08-18 02:00:44 +0000 | [diff] [blame] | 863 | (save-match-data |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 864 | (py-beginning-of-def-or-class 'either)) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 865 | (beginning-of-line) |
| 866 | (setq cur-indent (current-indentation))) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 867 | ;; HACK: want to go to the next correct definition location. We |
| 868 | ;; explicitly list them here but it would be better to have them |
| 869 | ;; in a list. |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 870 | (setq def-pos |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 871 | (or (match-beginning class-paren) |
| 872 | (match-beginning def-paren))) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 873 | ;; if we don't have a starting indent level, take this one |
| 874 | (or start-indent |
| 875 | (setq start-indent cur-indent)) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 876 | ;; if we don't have class name yet, take this one |
| 877 | (or prev-name |
| 878 | (setq prev-name def-name)) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 879 | ;; what level is the next definition on? must be same, deeper |
| 880 | ;; or shallower indentation |
| 881 | (cond |
| 882 | ;; at the same indent level, add it to the list... |
| 883 | ((= start-indent cur-indent) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 884 | (push (cons def-name def-pos) index-alist)) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 885 | ;; deeper indented expression, recurse |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 886 | ((< start-indent cur-indent) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 887 | ;; the point is currently on the expression we're supposed to |
| 888 | ;; start on, so go back to the last expression. The recursive |
| 889 | ;; call will find this place again and add it to the correct |
| 890 | ;; list |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 891 | (re-search-backward py-imenu-generic-regexp (point-min) 'move) |
| 892 | (setq sub-method-alist (py-imenu-create-index-engine cur-indent)) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 893 | (if sub-method-alist |
| 894 | ;; we put the last element on the index-alist on the start |
| 895 | ;; of the submethod alist so the user can still get to it. |
| 896 | (let ((save-elmt (pop index-alist))) |
Barry Warsaw | c852035 | 1997-11-26 06:14:40 +0000 | [diff] [blame] | 897 | (push (cons prev-name |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 898 | (cons save-elmt sub-method-alist)) |
| 899 | index-alist)))) |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 900 | ;; found less indented expression, we're done. |
| 901 | (t |
| 902 | (setq looking-p nil) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 903 | (re-search-backward py-imenu-generic-regexp (point-min) t))) |
| 904 | ;; end-cond |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 905 | (setq prev-name def-name) |
| 906 | (and looking-p |
| 907 | (setq looking-p |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 908 | (re-search-forward py-imenu-generic-regexp |
Barry Warsaw | 8143746 | 1996-08-01 19:48:02 +0000 | [diff] [blame] | 909 | (point-max) 'move)))) |
| 910 | (nreverse index-alist))) |
| 911 | |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 912 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 913 | ;;;###autoload |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 914 | (defun python-mode () |
| 915 | "Major mode for editing Python files. |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 916 | To submit a problem report, enter `\\[py-submit-bug-report]' from a |
| 917 | `python-mode' buffer. Do `\\[py-describe-mode]' for detailed |
| 918 | documentation. To see what version of `python-mode' you are running, |
| 919 | enter `\\[py-version]'. |
| 920 | |
| 921 | This mode knows about Python indentation, tokens, comments and |
| 922 | continuation lines. Paragraphs are separated by blank lines only. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 923 | |
| 924 | COMMANDS |
| 925 | \\{py-mode-map} |
| 926 | VARIABLES |
| 927 | |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 928 | py-indent-offset\t\tindentation increment |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 929 | py-block-comment-prefix\t\tcomment string used by `comment-region' |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 930 | py-python-command\t\tshell command to invoke Python interpreter |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 931 | py-temp-directory\t\tdirectory used for temp files (if needed) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 932 | py-beep-if-tab-change\t\tring the bell if `tab-width' is changed" |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 933 | (interactive) |
Barry Warsaw | 615d4a4 | 1996-09-04 14:14:10 +0000 | [diff] [blame] | 934 | ;; set up local variables |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 935 | (kill-all-local-variables) |
Barry Warsaw | 615d4a4 | 1996-09-04 14:14:10 +0000 | [diff] [blame] | 936 | (make-local-variable 'font-lock-defaults) |
| 937 | (make-local-variable 'paragraph-separate) |
| 938 | (make-local-variable 'paragraph-start) |
| 939 | (make-local-variable 'require-final-newline) |
| 940 | (make-local-variable 'comment-start) |
Barry Warsaw | 5c8bef1 | 1996-12-17 21:56:10 +0000 | [diff] [blame] | 941 | (make-local-variable 'comment-end) |
Barry Warsaw | 615d4a4 | 1996-09-04 14:14:10 +0000 | [diff] [blame] | 942 | (make-local-variable 'comment-start-skip) |
| 943 | (make-local-variable 'comment-column) |
Barry Warsaw | 003932a | 1998-07-07 15:11:24 +0000 | [diff] [blame] | 944 | (make-local-variable 'comment-indent-function) |
Barry Warsaw | 615d4a4 | 1996-09-04 14:14:10 +0000 | [diff] [blame] | 945 | (make-local-variable 'indent-region-function) |
| 946 | (make-local-variable 'indent-line-function) |
Barry Warsaw | b3e81d5 | 1996-09-04 15:12:42 +0000 | [diff] [blame] | 947 | (make-local-variable 'add-log-current-defun-function) |
Barry Warsaw | 615d4a4 | 1996-09-04 14:14:10 +0000 | [diff] [blame] | 948 | ;; |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 949 | (set-syntax-table py-mode-syntax-table) |
Barry Warsaw | 003932a | 1998-07-07 15:11:24 +0000 | [diff] [blame] | 950 | (setq major-mode 'python-mode |
| 951 | mode-name "Python" |
| 952 | local-abbrev-table python-mode-abbrev-table |
| 953 | font-lock-defaults '(python-font-lock-keywords) |
| 954 | paragraph-separate "^[ \t]*$" |
| 955 | paragraph-start "^[ \t]*$" |
| 956 | require-final-newline t |
| 957 | comment-start "# " |
| 958 | comment-end "" |
| 959 | comment-start-skip "# *" |
| 960 | comment-column 40 |
| 961 | comment-indent-function 'py-comment-indent-function |
| 962 | indent-region-function 'py-indent-region |
| 963 | indent-line-function 'py-indent-line |
Barry Warsaw | b3e81d5 | 1996-09-04 15:12:42 +0000 | [diff] [blame] | 964 | ;; tell add-log.el how to find the current function/method/variable |
| 965 | add-log-current-defun-function 'py-current-defun |
Barry Warsaw | b1f8951 | 1996-09-03 16:38:30 +0000 | [diff] [blame] | 966 | ) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 967 | (use-local-map py-mode-map) |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 968 | ;; add the menu |
| 969 | (if py-menu |
| 970 | (easy-menu-add py-menu)) |
Barry Warsaw | 57697af | 1995-09-14 20:01:14 +0000 | [diff] [blame] | 971 | ;; Emacs 19 requires this |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 972 | (if (boundp 'comment-multi-line) |
Barry Warsaw | 57697af | 1995-09-14 20:01:14 +0000 | [diff] [blame] | 973 | (setq comment-multi-line nil)) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 974 | ;; Install Imenu if available |
Barry Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 975 | (when (py-safe (require 'imenu)) |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 976 | (setq imenu-create-index-function #'py-imenu-create-index-function) |
| 977 | (setq imenu-generic-expression py-imenu-generic-expression) |
Barry Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 978 | (if (fboundp 'imenu-add-to-menubar) |
| 979 | (imenu-add-to-menubar (format "%s-%s" "IM" mode-name))) |
| 980 | ) |
| 981 | ;; Run the mode hook. Note that py-mode-hook is deprecated. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 982 | (if python-mode-hook |
| 983 | (run-hooks 'python-mode-hook) |
Barry Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 984 | (run-hooks 'py-mode-hook)) |
| 985 | ;; Now do the automagical guessing |
| 986 | (if py-smart-indentation |
| 987 | (let ((offset py-indent-offset)) |
Barry Warsaw | 145ab1c | 1998-05-19 14:49:49 +0000 | [diff] [blame] | 988 | ;; It's okay if this fails to guess a good value |
Barry Warsaw | 742a511 | 1998-03-13 17:29:15 +0000 | [diff] [blame] | 989 | (if (and (py-safe (py-guess-indent-offset)) |
| 990 | (<= py-indent-offset 8) |
| 991 | (>= py-indent-offset 2)) |
| 992 | (setq offset py-indent-offset)) |
| 993 | (setq py-indent-offset offset) |
Barry Warsaw | 639eea6 | 1998-03-16 18:12:13 +0000 | [diff] [blame] | 994 | ;; Only turn indent-tabs-mode off if tab-width != |
| 995 | ;; py-indent-offset. Never turn it on, because the user must |
| 996 | ;; have explicitly turned it off. |
| 997 | (if (/= tab-width py-indent-offset) |
| 998 | (setq indent-tabs-mode nil)) |
Barry Warsaw | 11f2156 | 1999-07-28 21:59:43 +0000 | [diff] [blame] | 999 | )) |
| 1000 | ;; Set the default shell if not already set |
| 1001 | (when (null py-which-shell) |
| 1002 | (py-toggle-shells py-default-interpreter)) |
| 1003 | ) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1004 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1005 | |
Barry Warsaw | b91b743 | 1995-03-14 15:55:20 +0000 | [diff] [blame] | 1006 | ;; electric characters |
Barry Warsaw | 3874a3d | 1995-03-14 22:05:53 +0000 | [diff] [blame] | 1007 | (defun py-outdent-p () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1008 | "Returns non-nil if the current line should dedent one level." |
Barry Warsaw | 3874a3d | 1995-03-14 22:05:53 +0000 | [diff] [blame] | 1009 | (save-excursion |
| 1010 | (and (progn (back-to-indentation) |
| 1011 | (looking-at py-outdent-re)) |
Barry Warsaw | 1a1c6bb | 1999-01-09 17:22:38 +0000 | [diff] [blame] | 1012 | ;; short circuit infloop on illegal construct |
| 1013 | (not (bobp)) |
Barry Warsaw | f06777d | 1998-01-21 05:36:18 +0000 | [diff] [blame] | 1014 | (progn (forward-line -1) |
| 1015 | (py-goto-initial-line) |
| 1016 | (back-to-indentation) |
Barry Warsaw | 3874a3d | 1995-03-14 22:05:53 +0000 | [diff] [blame] | 1017 | (while (or (looking-at py-blank-or-comment-re) |
| 1018 | (bobp)) |
| 1019 | (backward-to-indentation 1)) |
| 1020 | (not (looking-at py-no-outdent-re))) |
| 1021 | ))) |
| 1022 | |
Barry Warsaw | b91b743 | 1995-03-14 15:55:20 +0000 | [diff] [blame] | 1023 | (defun py-electric-colon (arg) |
| 1024 | "Insert a colon. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1025 | In certain cases the line is dedented appropriately. If a numeric |
| 1026 | argument ARG is provided, that many colons are inserted |
| 1027 | non-electrically. Electric behavior is inhibited inside a string or |
| 1028 | comment." |
Barry Warsaw | b91b743 | 1995-03-14 15:55:20 +0000 | [diff] [blame] | 1029 | (interactive "P") |
| 1030 | (self-insert-command (prefix-numeric-value arg)) |
Barry Warsaw | 0c6563f | 1995-09-14 20:57:02 +0000 | [diff] [blame] | 1031 | ;; are we in a string or comment? |
| 1032 | (if (save-excursion |
| 1033 | (let ((pps (parse-partial-sexp (save-excursion |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 1034 | (py-beginning-of-def-or-class) |
Barry Warsaw | 0c6563f | 1995-09-14 20:57:02 +0000 | [diff] [blame] | 1035 | (point)) |
| 1036 | (point)))) |
| 1037 | (not (or (nth 3 pps) (nth 4 pps))))) |
| 1038 | (save-excursion |
| 1039 | (let ((here (point)) |
| 1040 | (outdent 0) |
Barry Warsaw | 7cb505c | 1996-10-23 20:44:59 +0000 | [diff] [blame] | 1041 | (indent (py-compute-indentation t))) |
Barry Warsaw | 0c6563f | 1995-09-14 20:57:02 +0000 | [diff] [blame] | 1042 | (if (and (not arg) |
| 1043 | (py-outdent-p) |
| 1044 | (= indent (save-excursion |
Barry Warsaw | a766182 | 1996-08-02 16:22:43 +0000 | [diff] [blame] | 1045 | (py-next-statement -1) |
Barry Warsaw | 7cb505c | 1996-10-23 20:44:59 +0000 | [diff] [blame] | 1046 | (py-compute-indentation t))) |
Barry Warsaw | 0c6563f | 1995-09-14 20:57:02 +0000 | [diff] [blame] | 1047 | ) |
| 1048 | (setq outdent py-indent-offset)) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1049 | ;; Don't indent, only dedent. This assumes that any lines |
| 1050 | ;; that are already dedented relative to |
| 1051 | ;; py-compute-indentation were put there on purpose. It's |
| 1052 | ;; highly annoying to have `:' indent for you. Use TAB, C-c |
| 1053 | ;; C-l or C-c C-r to adjust. TBD: Is there a better way to |
| 1054 | ;; determine this??? |
Barry Warsaw | 0c6563f | 1995-09-14 20:57:02 +0000 | [diff] [blame] | 1055 | (if (< (current-indentation) indent) nil |
| 1056 | (goto-char here) |
| 1057 | (beginning-of-line) |
| 1058 | (delete-horizontal-space) |
| 1059 | (indent-to (- indent outdent)) |
| 1060 | ))))) |
Barry Warsaw | b91b743 | 1995-03-14 15:55:20 +0000 | [diff] [blame] | 1061 | |
| 1062 | |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1063 | ;; Python subprocess utilities and filters |
| 1064 | (defun py-execute-file (proc filename) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1065 | "Send to Python interpreter process PROC \"execfile('FILENAME')\". |
| 1066 | Make that process's buffer visible and force display. Also make |
| 1067 | comint believe the user typed this string so that |
| 1068 | `kill-output-from-shell' does The Right Thing." |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1069 | (let ((curbuf (current-buffer)) |
| 1070 | (procbuf (process-buffer proc)) |
Barry Warsaw | 3c96f6f | 1998-08-20 19:44:51 +0000 | [diff] [blame] | 1071 | ; (comint-scroll-to-bottom-on-output t) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1072 | (msg (format "## working on region in file %s...\n" filename)) |
Barry Warsaw | 02e5f69 | 1998-09-24 23:48:40 +0000 | [diff] [blame] | 1073 | (cmd (format "execfile(r'%s')\n" filename))) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1074 | (unwind-protect |
Barry Warsaw | 3c96f6f | 1998-08-20 19:44:51 +0000 | [diff] [blame] | 1075 | (save-excursion |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1076 | (set-buffer procbuf) |
| 1077 | (goto-char (point-max)) |
| 1078 | (move-marker (process-mark proc) (point)) |
| 1079 | (funcall (process-filter proc) proc msg)) |
| 1080 | (set-buffer curbuf)) |
| 1081 | (process-send-string proc cmd))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1082 | |
Barry Warsaw | 3c96f6f | 1998-08-20 19:44:51 +0000 | [diff] [blame] | 1083 | (defun py-comint-output-filter-function (string) |
| 1084 | "Watch output for Python prompt and exec next file waiting in queue. |
| 1085 | This function is appropriate for `comint-output-filter-functions'." |
Barry Warsaw | 014e0e2 | 1998-11-17 19:24:47 +0000 | [diff] [blame] | 1086 | ;; TBD: this should probably use split-string |
Barry Warsaw | 4f94c73 | 1998-09-25 19:40:10 +0000 | [diff] [blame] | 1087 | (when (and (or (string-equal string ">>> ") |
Barry Warsaw | 4f94c73 | 1998-09-25 19:40:10 +0000 | [diff] [blame] | 1088 | (and (>= (length string) 5) |
| 1089 | (string-equal (substring string -5) "\n>>> "))) |
Barry Warsaw | 3c96f6f | 1998-08-20 19:44:51 +0000 | [diff] [blame] | 1090 | py-file-queue) |
| 1091 | (py-safe (delete-file (car py-file-queue))) |
| 1092 | (setq py-file-queue (cdr py-file-queue)) |
| 1093 | (if py-file-queue |
| 1094 | (let ((pyproc (get-buffer-process (current-buffer)))) |
| 1095 | (py-execute-file pyproc (car py-file-queue)))) |
| 1096 | )) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1097 | |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 1098 | (defun py-pdbtrack-overlay-arrow (activation) |
| 1099 | "Activate or de arrow at beginning-of-line in current buffer." |
| 1100 | ;; This was derived/simplified from edebug-overlay-arrow |
| 1101 | (cond (activation |
| 1102 | (setq overlay-arrow-position (make-marker)) |
| 1103 | (setq overlay-arrow-string "=>") |
| 1104 | (set-marker overlay-arrow-position (py-point 'bol) (current-buffer)) |
| 1105 | (setq py-pdbtrack-is-tracking-p t)) |
| 1106 | (overlay-arrow-position |
| 1107 | (setq overlay-arrow-position nil) |
| 1108 | (setq py-pdbtrack-is-tracking-p nil)) |
| 1109 | )) |
| 1110 | |
| 1111 | (defun py-pdbtrack-track-stack-file (text) |
| 1112 | "Show the file indicated by the pdb stack entry line, in a separate window. |
| 1113 | |
| 1114 | Activity is disabled if the buffer-local variable |
| 1115 | `py-pdbtrack-do-tracking-p' is nil. |
| 1116 | |
| 1117 | We depend on the pdb input prompt matching `py-pdbtrack-input-prompt' |
| 1118 | at the beginning of the line." |
| 1119 | ;; Instead of trying to piece things together from partial text |
| 1120 | ;; (which can be almost useless depending on Emacs version), we |
| 1121 | ;; monitor to the point where we have the next pdb prompt, and then |
| 1122 | ;; check all text from comint-last-input-end to process-mark. |
| 1123 | ;; |
| 1124 | ;; KLM: It might be nice to provide an optional override, so this |
| 1125 | ;; routine could be fed debugger output strings as the text |
| 1126 | ;; argument, for deliberate application elsewhere. |
| 1127 | ;; |
| 1128 | ;; KLM: We're very conservative about clearing the overlay arrow, to |
| 1129 | ;; minimize residue. This means, for instance, that executing other |
| 1130 | ;; pdb commands wipes out the highlight. |
| 1131 | (let* ((origbuf (current-buffer)) |
| 1132 | (currproc (get-buffer-process origbuf))) |
| 1133 | (if (not (and currproc py-pdbtrack-do-tracking-p)) |
| 1134 | (py-pdbtrack-overlay-arrow nil) |
| 1135 | (let* (;(origdir default-directory) |
| 1136 | (procmark (process-mark currproc)) |
| 1137 | (block (buffer-substring (max comint-last-input-end |
| 1138 | (- procmark |
| 1139 | py-pdbtrack-track-range)) |
| 1140 | procmark)) |
| 1141 | fname lineno) |
| 1142 | (if (not (string-match (concat py-pdbtrack-input-prompt "$") block)) |
| 1143 | (py-pdbtrack-overlay-arrow nil) |
| 1144 | (if (not (string-match |
| 1145 | (concat ".*" py-pdbtrack-stack-entry-regexp ".*") |
| 1146 | block)) |
| 1147 | (py-pdbtrack-overlay-arrow nil) |
| 1148 | (setq fname (match-string 1 block) |
| 1149 | lineno (match-string 2 block)) |
| 1150 | (if (file-exists-p fname) |
| 1151 | (progn |
| 1152 | (find-file-other-window fname) |
| 1153 | (goto-line (string-to-int lineno)) |
Barry Warsaw | c8c1a5b | 2001-04-11 22:27:41 +0000 | [diff] [blame] | 1154 | (message "pdbtrack: line %s, file %s" lineno fname) |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 1155 | (py-pdbtrack-overlay-arrow t) |
| 1156 | (pop-to-buffer origbuf t) ) |
| 1157 | (if (= (elt fname 0) ?\<) |
Barry Warsaw | c8c1a5b | 2001-04-11 22:27:41 +0000 | [diff] [blame] | 1158 | (message "pdbtrack: (Non-file source: '%s')" fname) |
| 1159 | (message "pdbtrack: File not found: %s" fname)) |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 1160 | ))))))) |
| 1161 | |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1162 | (defun py-postprocess-output-buffer (buf) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1163 | "Highlight exceptions found in BUF. |
| 1164 | If an exception occurred return t, otherwise return nil. BUF must exist." |
Barry Warsaw | f9b99f4 | 1998-03-26 16:08:59 +0000 | [diff] [blame] | 1165 | (let (line file bol err-p) |
Barry Warsaw | 9981d22 | 1997-12-03 05:25:48 +0000 | [diff] [blame] | 1166 | (save-excursion |
| 1167 | (set-buffer buf) |
| 1168 | (beginning-of-buffer) |
| 1169 | (while (re-search-forward py-traceback-line-re nil t) |
| 1170 | (setq file (match-string 1) |
| 1171 | line (string-to-int (match-string 2)) |
| 1172 | bol (py-point 'bol)) |
Barry Warsaw | f9b99f4 | 1998-03-26 16:08:59 +0000 | [diff] [blame] | 1173 | (py-highlight-line bol (py-point 'eol) file line))) |
| 1174 | (when (and py-jump-on-exception line) |
| 1175 | (beep) |
| 1176 | (py-jump-to-exception file line) |
| 1177 | (setq err-p t)) |
| 1178 | err-p)) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1179 | |
Barry Warsaw | 9981d22 | 1997-12-03 05:25:48 +0000 | [diff] [blame] | 1180 | |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1181 | |
| 1182 | ;;; Subprocess commands |
| 1183 | |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1184 | ;; only used when (memq 'broken-temp-names py-emacs-features) |
| 1185 | (defvar py-serial-number 0) |
| 1186 | (defvar py-exception-buffer nil) |
| 1187 | (defconst py-output-buffer "*Python Output*") |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 1188 | (make-variable-buffer-local 'py-output-buffer) |
| 1189 | |
| 1190 | ;; for toggling between CPython and JPython |
Barry Warsaw | aa384fd | 1999-02-16 23:36:16 +0000 | [diff] [blame] | 1191 | (defvar py-which-shell nil) |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 1192 | (defvar py-which-args py-python-command-args) |
| 1193 | (defvar py-which-bufname "Python") |
| 1194 | (make-variable-buffer-local 'py-which-shell) |
| 1195 | (make-variable-buffer-local 'py-which-args) |
| 1196 | (make-variable-buffer-local 'py-which-bufname) |
| 1197 | |
| 1198 | (defun py-toggle-shells (arg) |
| 1199 | "Toggles between the CPython and JPython shells. |
Barry Warsaw | 11f2156 | 1999-07-28 21:59:43 +0000 | [diff] [blame] | 1200 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1201 | With positive argument ARG (interactively \\[universal-argument]), |
| 1202 | uses the CPython shell, with negative ARG uses the JPython shell, and |
Barry Warsaw | 11f2156 | 1999-07-28 21:59:43 +0000 | [diff] [blame] | 1203 | with a zero argument, toggles the shell. |
| 1204 | |
| 1205 | Programmatically, ARG can also be one of the symbols `cpython' or |
| 1206 | `jpython', equivalent to positive arg and negative arg respectively." |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 1207 | (interactive "P") |
| 1208 | ;; default is to toggle |
| 1209 | (if (null arg) |
| 1210 | (setq arg 0)) |
Barry Warsaw | 11f2156 | 1999-07-28 21:59:43 +0000 | [diff] [blame] | 1211 | ;; preprocess arg |
| 1212 | (cond |
| 1213 | ((equal arg 0) |
| 1214 | ;; toggle |
| 1215 | (if (string-equal py-which-bufname "Python") |
| 1216 | (setq arg -1) |
| 1217 | (setq arg 1))) |
| 1218 | ((equal arg 'cpython) (setq arg 1)) |
| 1219 | ((equal arg 'jpython) (setq arg -1))) |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 1220 | (let (msg) |
| 1221 | (cond |
| 1222 | ((< 0 arg) |
| 1223 | ;; set to CPython |
| 1224 | (setq py-which-shell py-python-command |
| 1225 | py-which-args py-python-command-args |
| 1226 | py-which-bufname "Python" |
| 1227 | msg "CPython" |
| 1228 | mode-name "Python")) |
| 1229 | ((> 0 arg) |
| 1230 | (setq py-which-shell py-jpython-command |
| 1231 | py-which-args py-jpython-command-args |
| 1232 | py-which-bufname "JPython" |
| 1233 | msg "JPython" |
| 1234 | mode-name "JPython")) |
| 1235 | ) |
Barry Warsaw | ea609c1 | 1998-04-10 16:08:26 +0000 | [diff] [blame] | 1236 | (message "Using the %s shell" msg) |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 1237 | (setq py-output-buffer (format "*%s Output*" py-which-bufname)))) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1238 | |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1239 | ;;;###autoload |
Barry Warsaw | 3b4e2f0 | 1999-02-16 23:52:46 +0000 | [diff] [blame] | 1240 | (defun py-shell (&optional argprompt) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1241 | "Start an interactive Python interpreter in another window. |
| 1242 | This is like Shell mode, except that Python is running in the window |
| 1243 | instead of a shell. See the `Interactive Shell' and `Shell Mode' |
| 1244 | sections of the Emacs manual for details, especially for the key |
| 1245 | bindings active in the `*Python*' buffer. |
| 1246 | |
Barry Warsaw | 3b4e2f0 | 1999-02-16 23:52:46 +0000 | [diff] [blame] | 1247 | With optional \\[universal-argument], the user is prompted for the |
| 1248 | flags to pass to the Python interpreter. This has no effect when this |
| 1249 | command is used to switch to an existing process, only when a new |
| 1250 | process is started. If you use this, you will probably want to ensure |
| 1251 | that the current arguments are retained (they will be included in the |
| 1252 | prompt). This argument is ignored when this function is called |
| 1253 | programmatically, or when running in Emacs 19.34 or older. |
| 1254 | |
Barry Warsaw | a239880 | 1998-04-09 23:28:20 +0000 | [diff] [blame] | 1255 | Note: You can toggle between using the CPython interpreter and the |
| 1256 | JPython interpreter by hitting \\[py-toggle-shells]. This toggles |
| 1257 | buffer local variables which control whether all your subshell |
| 1258 | interactions happen to the `*JPython*' or `*Python*' buffers (the |
| 1259 | latter is the name used for the CPython buffer). |
| 1260 | |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1261 | Warning: Don't use an interactive Python if you change sys.ps1 or |
| 1262 | sys.ps2 from their default values, or if you're running code that |
| 1263 | prints `>>> ' or `... ' at the start of a line. `python-mode' can't |
| 1264 | distinguish your output from Python's output, and assumes that `>>> ' |
| 1265 | at the start of a line is a prompt from Python. Similarly, the Emacs |
| 1266 | Shell mode code assumes that both `>>> ' and `... ' at the start of a |
| 1267 | line are Python prompts. Bad things can happen if you fool either |
| 1268 | mode. |
| 1269 | |
| 1270 | Warning: If you do any editing *in* the process buffer *while* the |
| 1271 | buffer is accepting output from Python, do NOT attempt to `undo' the |
| 1272 | changes. Some of the output (nowhere near the parts you changed!) may |
| 1273 | be lost if you do. This appears to be an Emacs bug, an unfortunate |
| 1274 | interaction between undo and process filters; the same problem exists in |
| 1275 | non-Python process buffers using the default (Emacs-supplied) process |
| 1276 | filter." |
Barry Warsaw | 3b4e2f0 | 1999-02-16 23:52:46 +0000 | [diff] [blame] | 1277 | (interactive "P") |
Barry Warsaw | 50765ab | 1999-08-10 21:49:00 +0000 | [diff] [blame] | 1278 | ;; Set the default shell if not already set |
| 1279 | (when (null py-which-shell) |
| 1280 | (py-toggle-shells py-default-interpreter)) |
Barry Warsaw | 3b4e2f0 | 1999-02-16 23:52:46 +0000 | [diff] [blame] | 1281 | (let ((args py-which-args)) |
| 1282 | (when (and argprompt |
| 1283 | (interactive-p) |
| 1284 | (fboundp 'split-string)) |
| 1285 | ;; TBD: Perhaps force "-i" in the final list? |
| 1286 | (setq args (split-string |
| 1287 | (read-string (concat py-which-bufname |
| 1288 | " arguments: ") |
| 1289 | (concat |
| 1290 | (mapconcat 'identity py-which-args " ") " ") |
| 1291 | )))) |
| 1292 | (switch-to-buffer-other-window |
| 1293 | (apply 'make-comint py-which-bufname py-which-shell nil args)) |
| 1294 | (make-local-variable 'comint-prompt-regexp) |
| 1295 | (setq comint-prompt-regexp "^>>> \\|^[.][.][.] \\|^(pdb) ") |
| 1296 | (add-hook 'comint-output-filter-functions |
| 1297 | 'py-comint-output-filter-function) |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 1298 | ;; pdbtrack |
| 1299 | (add-hook 'comint-output-filter-functions 'py-pdbtrack-track-stack-file) |
| 1300 | (setq py-pdbtrack-do-tracking-p t) |
Barry Warsaw | 3b4e2f0 | 1999-02-16 23:52:46 +0000 | [diff] [blame] | 1301 | (set-syntax-table py-mode-syntax-table) |
| 1302 | (use-local-map py-shell-map) |
| 1303 | )) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1304 | |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1305 | (defun py-clear-queue () |
| 1306 | "Clear the queue of temporary files waiting to execute." |
| 1307 | (interactive) |
| 1308 | (let ((n (length py-file-queue))) |
| 1309 | (mapcar 'delete-file py-file-queue) |
| 1310 | (setq py-file-queue nil) |
| 1311 | (message "%d pending files de-queued." n))) |
| 1312 | |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1313 | |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1314 | (defun py-execute-region (start end &optional async) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1315 | "Execute the region in a Python interpreter. |
| 1316 | |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1317 | The region is first copied into a temporary file (in the directory |
| 1318 | `py-temp-directory'). If there is no Python interpreter shell |
| 1319 | running, this file is executed synchronously using |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1320 | `shell-command-on-region'. If the program is long running, use |
| 1321 | \\[universal-argument] to run the command asynchronously in its own |
| 1322 | buffer. |
| 1323 | |
| 1324 | When this function is used programmatically, arguments START and END |
| 1325 | specify the region to execute, and optional third argument ASYNC, if |
| 1326 | non-nil, specifies to run the command asynchronously in its own |
| 1327 | buffer. |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1328 | |
| 1329 | If the Python interpreter shell is running, the region is execfile()'d |
| 1330 | in that shell. If you try to execute regions too quickly, |
| 1331 | `python-mode' will queue them up and execute them one at a time when |
| 1332 | it sees a `>>> ' prompt from Python. Each time this happens, the |
| 1333 | process buffer is popped into a window (if it's not already in some |
| 1334 | window) so you can see it, and a comment of the form |
| 1335 | |
| 1336 | \t## working on region in file <name>... |
| 1337 | |
| 1338 | is inserted at the end. See also the command `py-clear-queue'." |
| 1339 | (interactive "r\nP") |
| 1340 | (or (< start end) |
| 1341 | (error "Region is empty")) |
Barry Warsaw | 014e0e2 | 1998-11-17 19:24:47 +0000 | [diff] [blame] | 1342 | (let* ((proc (get-process py-which-bufname)) |
Barry Warsaw | 5e21cb0 | 1997-11-05 18:41:11 +0000 | [diff] [blame] | 1343 | (temp (if (memq 'broken-temp-names py-emacs-features) |
Barry Warsaw | 1b34424 | 1998-08-07 22:24:16 +0000 | [diff] [blame] | 1344 | (let |
| 1345 | ((sn py-serial-number) |
| 1346 | (pid (and (fboundp 'emacs-pid) (emacs-pid)))) |
| 1347 | (setq py-serial-number (1+ py-serial-number)) |
| 1348 | (if pid |
| 1349 | (format "python-%d-%d" sn pid) |
| 1350 | (format "python-%d" sn))) |
Barry Warsaw | 2f32fbb | 1998-02-25 16:45:43 +0000 | [diff] [blame] | 1351 | (make-temp-name "python-"))) |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 1352 | (file (concat (expand-file-name temp py-temp-directory) ".py")) |
Barry Warsaw | caee2fe | 2000-05-23 05:47:43 +0000 | [diff] [blame] | 1353 | (cur (current-buffer)) |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 1354 | (buf (get-buffer-create file)) |
| 1355 | shell) |
Barry Warsaw | caee2fe | 2000-05-23 05:47:43 +0000 | [diff] [blame] | 1356 | ;; Write the contents of the buffer, watching out for indented regions. |
| 1357 | (save-excursion |
| 1358 | (goto-char start) |
Barry Warsaw | 99eadf4 | 2000-06-23 20:24:25 +0000 | [diff] [blame] | 1359 | (let ((needs-if (/= (py-point 'bol) (py-point 'boi)))) |
Barry Warsaw | caee2fe | 2000-05-23 05:47:43 +0000 | [diff] [blame] | 1360 | (set-buffer buf) |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 1361 | (python-mode) |
| 1362 | (setq shell py-which-shell) |
Barry Warsaw | 99eadf4 | 2000-06-23 20:24:25 +0000 | [diff] [blame] | 1363 | (when needs-if |
| 1364 | (insert "if 1:\n")) |
| 1365 | (insert-buffer-substring cur start end))) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1366 | (cond |
Barry Warsaw | 145ab1c | 1998-05-19 14:49:49 +0000 | [diff] [blame] | 1367 | ;; always run the code in its own asynchronous subprocess |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1368 | (async |
Barry Warsaw | caee2fe | 2000-05-23 05:47:43 +0000 | [diff] [blame] | 1369 | ;; User explicitly wants this to run in its own async subprocess |
| 1370 | (save-excursion |
| 1371 | (set-buffer buf) |
| 1372 | (write-region (point-min) (point-max) file nil 'nomsg)) |
Barry Warsaw | 34d8317 | 1998-11-20 03:04:07 +0000 | [diff] [blame] | 1373 | (let* ((buf (generate-new-buffer-name py-output-buffer)) |
| 1374 | ;; TBD: a horrible hack, but why create new Custom variables? |
| 1375 | (arg (if (string-equal py-which-bufname "Python") |
| 1376 | "-u" ""))) |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 1377 | (start-process py-which-bufname buf shell arg file) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1378 | (pop-to-buffer buf) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1379 | (py-postprocess-output-buffer buf) |
Barry Warsaw | caee2fe | 2000-05-23 05:47:43 +0000 | [diff] [blame] | 1380 | ;; TBD: clean up the temporary file! |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1381 | )) |
| 1382 | ;; if the Python interpreter shell is running, queue it up for |
| 1383 | ;; execution there. |
| 1384 | (proc |
| 1385 | ;; use the existing python shell |
Barry Warsaw | caee2fe | 2000-05-23 05:47:43 +0000 | [diff] [blame] | 1386 | (save-excursion |
| 1387 | (set-buffer buf) |
| 1388 | (write-region (point-min) (point-max) file nil 'nomsg)) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1389 | (if (not py-file-queue) |
| 1390 | (py-execute-file proc file) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1391 | (message "File %s queued for execution" file)) |
Barry Warsaw | 3c96f6f | 1998-08-20 19:44:51 +0000 | [diff] [blame] | 1392 | (setq py-file-queue (append py-file-queue (list file))) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1393 | (setq py-exception-buffer (cons file (current-buffer)))) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1394 | (t |
Barry Warsaw | 34d8317 | 1998-11-20 03:04:07 +0000 | [diff] [blame] | 1395 | ;; TBD: a horrible hack, buy why create new Custom variables? |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 1396 | (let ((cmd (concat shell |
Barry Warsaw | 34d8317 | 1998-11-20 03:04:07 +0000 | [diff] [blame] | 1397 | (if (string-equal py-which-bufname "JPython") |
| 1398 | " -" "")))) |
| 1399 | ;; otherwise either run it synchronously in a subprocess |
Barry Warsaw | caee2fe | 2000-05-23 05:47:43 +0000 | [diff] [blame] | 1400 | (save-excursion |
| 1401 | (set-buffer buf) |
| 1402 | (shell-command-on-region (point-min) (point-max) |
| 1403 | cmd py-output-buffer)) |
Barry Warsaw | 34d8317 | 1998-11-20 03:04:07 +0000 | [diff] [blame] | 1404 | ;; shell-command-on-region kills the output buffer if it never |
| 1405 | ;; existed and there's no output from the command |
| 1406 | (if (not (get-buffer py-output-buffer)) |
| 1407 | (message "No output.") |
| 1408 | (setq py-exception-buffer (current-buffer)) |
| 1409 | (let ((err-p (py-postprocess-output-buffer py-output-buffer))) |
| 1410 | (pop-to-buffer py-output-buffer) |
| 1411 | (if err-p |
| 1412 | (pop-to-buffer py-exception-buffer))) |
Barry Warsaw | caee2fe | 2000-05-23 05:47:43 +0000 | [diff] [blame] | 1413 | )) |
| 1414 | ;; TBD: delete the buffer |
| 1415 | ) |
Barry Warsaw | 7153460 | 2001-02-20 23:07:56 +0000 | [diff] [blame] | 1416 | ) |
| 1417 | ;; Clean up after ourselves. |
| 1418 | (kill-buffer buf))) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1419 | |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1420 | |
| 1421 | ;; Code execution commands |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1422 | (defun py-execute-buffer (&optional async) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1423 | "Send the contents of the buffer to a Python interpreter. |
Barry Warsaw | c0ecb53 | 1998-01-20 21:43:34 +0000 | [diff] [blame] | 1424 | If the file local variable `py-master-file' is non-nil, execute the |
| 1425 | named file instead of the buffer's file. |
| 1426 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1427 | If there is a *Python* process buffer it is used. If a clipping |
| 1428 | restriction is in effect, only the accessible portion of the buffer is |
| 1429 | sent. A trailing newline will be supplied if needed. |
| 1430 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1431 | See the `\\[py-execute-region]' docs for an account of some |
| 1432 | subtleties, including the use of the optional ASYNC argument." |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1433 | (interactive "P") |
Barry Warsaw | c0ecb53 | 1998-01-20 21:43:34 +0000 | [diff] [blame] | 1434 | (if py-master-file |
| 1435 | (let* ((filename (expand-file-name py-master-file)) |
| 1436 | (buffer (or (get-file-buffer filename) |
| 1437 | (find-file-noselect filename)))) |
| 1438 | (set-buffer buffer))) |
Barry Warsaw | a97a3f3 | 1997-11-04 18:47:06 +0000 | [diff] [blame] | 1439 | (py-execute-region (point-min) (point-max) async)) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1440 | |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1441 | (defun py-execute-import-or-reload (&optional async) |
| 1442 | "Import the current buffer's file in a Python interpreter. |
| 1443 | |
| 1444 | If the file has already been imported, then do reload instead to get |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 1445 | the latest version. |
| 1446 | |
| 1447 | If the file's name does not end in \".py\", then do execfile instead. |
| 1448 | |
| 1449 | If the current buffer is not visiting a file, do `py-execute-buffer' |
| 1450 | instead. |
| 1451 | |
| 1452 | If the file local variable `py-master-file' is non-nil, import or |
| 1453 | reload the named file instead of the buffer's file. The file may be |
| 1454 | saved based on the value of `py-execute-import-or-reload-save-p'. |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1455 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1456 | See the `\\[py-execute-region]' docs for an account of some |
| 1457 | subtleties, including the use of the optional ASYNC argument. |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1458 | |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 1459 | This may be preferable to `\\[py-execute-buffer]' because: |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1460 | |
| 1461 | - Definitions stay in their module rather than appearing at top |
| 1462 | level, where they would clutter the global namespace and not affect |
| 1463 | uses of qualified names (MODULE.NAME). |
| 1464 | |
| 1465 | - The Python debugger gets line number information about the functions." |
| 1466 | (interactive "P") |
| 1467 | ;; Check file local variable py-master-file |
| 1468 | (if py-master-file |
| 1469 | (let* ((filename (expand-file-name py-master-file)) |
| 1470 | (buffer (or (get-file-buffer filename) |
| 1471 | (find-file-noselect filename)))) |
| 1472 | (set-buffer buffer))) |
| 1473 | (let ((file (buffer-file-name (current-buffer)))) |
| 1474 | (if file |
| 1475 | (progn |
Barry Warsaw | 3bfed5b | 1998-05-19 16:25:04 +0000 | [diff] [blame] | 1476 | ;; Maybe save some buffers |
| 1477 | (save-some-buffers (not py-ask-about-save) nil) |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1478 | (py-execute-string |
| 1479 | (if (string-match "\\.py$" file) |
| 1480 | (let ((f (file-name-sans-extension |
| 1481 | (file-name-nondirectory file)))) |
| 1482 | (format "if globals().has_key('%s'):\n reload(%s)\nelse:\n import %s\n" |
| 1483 | f f f)) |
Barry Warsaw | 02e5f69 | 1998-09-24 23:48:40 +0000 | [diff] [blame] | 1484 | (format "execfile(r'%s')\n" file)) |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1485 | async)) |
| 1486 | ;; else |
| 1487 | (py-execute-buffer async)))) |
| 1488 | |
| 1489 | |
| 1490 | (defun py-execute-def-or-class (&optional async) |
| 1491 | "Send the current function or class definition to a Python interpreter. |
| 1492 | |
| 1493 | If there is a *Python* process buffer it is used. |
| 1494 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1495 | See the `\\[py-execute-region]' docs for an account of some |
| 1496 | subtleties, including the use of the optional ASYNC argument." |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1497 | (interactive "P") |
| 1498 | (save-excursion |
| 1499 | (py-mark-def-or-class) |
| 1500 | ;; mark is before point |
| 1501 | (py-execute-region (mark) (point) async))) |
| 1502 | |
| 1503 | |
| 1504 | (defun py-execute-string (string &optional async) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1505 | "Send the argument STRING to a Python interpreter. |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1506 | |
| 1507 | If there is a *Python* process buffer it is used. |
| 1508 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1509 | See the `\\[py-execute-region]' docs for an account of some |
| 1510 | subtleties, including the use of the optional ASYNC argument." |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1511 | (interactive "sExecute Python command: ") |
| 1512 | (save-excursion |
| 1513 | (set-buffer (get-buffer-create |
| 1514 | (generate-new-buffer-name " *Python Command*"))) |
| 1515 | (insert string) |
| 1516 | (py-execute-region (point-min) (point-max) async))) |
| 1517 | |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1518 | |
| 1519 | |
| 1520 | (defun py-jump-to-exception (file line) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1521 | "Jump to the Python code in FILE at LINE." |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1522 | (let ((buffer (cond ((string-equal file "<stdin>") |
Barry Warsaw | ebc7b7a | 1998-05-19 15:01:06 +0000 | [diff] [blame] | 1523 | (if (consp py-exception-buffer) |
| 1524 | (cdr py-exception-buffer) |
| 1525 | py-exception-buffer)) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1526 | ((and (consp py-exception-buffer) |
| 1527 | (string-equal file (car py-exception-buffer))) |
| 1528 | (cdr py-exception-buffer)) |
| 1529 | ((py-safe (find-file-noselect file))) |
| 1530 | ;; could not figure out what file the exception |
| 1531 | ;; is pointing to, so prompt for it |
| 1532 | (t (find-file (read-file-name "Exception file: " |
| 1533 | nil |
| 1534 | file t)))))) |
| 1535 | (pop-to-buffer buffer) |
Barry Warsaw | ebc7b7a | 1998-05-19 15:01:06 +0000 | [diff] [blame] | 1536 | ;; Force Python mode |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 1537 | (if (not (eq major-mode 'python-mode)) |
Barry Warsaw | ebc7b7a | 1998-05-19 15:01:06 +0000 | [diff] [blame] | 1538 | (python-mode)) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1539 | (goto-line line) |
| 1540 | (message "Jumping to exception in file %s on line %d" file line))) |
| 1541 | |
| 1542 | (defun py-mouseto-exception (event) |
Barry Warsaw | 12c9294 | 1998-08-10 21:44:37 +0000 | [diff] [blame] | 1543 | "Jump to the code which caused the Python exception at EVENT. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1544 | EVENT is usually a mouse click." |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1545 | (interactive "e") |
| 1546 | (cond |
| 1547 | ((fboundp 'event-point) |
| 1548 | ;; XEmacs |
| 1549 | (let* ((point (event-point event)) |
| 1550 | (buffer (event-buffer event)) |
| 1551 | (e (and point buffer (extent-at point buffer 'py-exc-info))) |
| 1552 | (info (and e (extent-property e 'py-exc-info)))) |
| 1553 | (message "Event point: %d, info: %s" point info) |
| 1554 | (and info |
| 1555 | (py-jump-to-exception (car info) (cdr info))) |
| 1556 | )) |
| 1557 | ;; Emacs -- Please port this! |
| 1558 | )) |
| 1559 | |
| 1560 | (defun py-goto-exception () |
| 1561 | "Go to the line indicated by the traceback." |
| 1562 | (interactive) |
| 1563 | (let (file line) |
| 1564 | (save-excursion |
| 1565 | (beginning-of-line) |
| 1566 | (if (looking-at py-traceback-line-re) |
| 1567 | (setq file (match-string 1) |
| 1568 | line (string-to-int (match-string 2))))) |
| 1569 | (if (not file) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1570 | (error "Not on a traceback line")) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1571 | (py-jump-to-exception file line))) |
| 1572 | |
| 1573 | (defun py-find-next-exception (start buffer searchdir errwhere) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1574 | "Find the next Python exception and jump to the code that caused it. |
| 1575 | START is the buffer position in BUFFER from which to begin searching |
| 1576 | for an exception. SEARCHDIR is a function, either |
| 1577 | `re-search-backward' or `re-search-forward' indicating the direction |
| 1578 | to search. ERRWHERE is used in an error message if the limit (top or |
| 1579 | bottom) of the trackback stack is encountered." |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1580 | (let (file line) |
| 1581 | (save-excursion |
| 1582 | (set-buffer buffer) |
| 1583 | (goto-char (py-point start)) |
| 1584 | (if (funcall searchdir py-traceback-line-re nil t) |
| 1585 | (setq file (match-string 1) |
| 1586 | line (string-to-int (match-string 2))))) |
| 1587 | (if (and file line) |
| 1588 | (py-jump-to-exception file line) |
| 1589 | (error "%s of traceback" errwhere)))) |
| 1590 | |
| 1591 | (defun py-down-exception (&optional bottom) |
| 1592 | "Go to the next line down in the traceback. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1593 | With \\[univeral-argument] (programmatically, optional argument |
| 1594 | BOTTOM), jump to the bottom (innermost) exception in the exception |
| 1595 | stack." |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1596 | (interactive "P") |
| 1597 | (let* ((proc (get-process "Python")) |
| 1598 | (buffer (if proc "*Python*" py-output-buffer))) |
| 1599 | (if bottom |
| 1600 | (py-find-next-exception 'eob buffer 're-search-backward "Bottom") |
| 1601 | (py-find-next-exception 'eol buffer 're-search-forward "Bottom")))) |
| 1602 | |
| 1603 | (defun py-up-exception (&optional top) |
| 1604 | "Go to the previous line up in the traceback. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1605 | With \\[universal-argument] (programmatically, optional argument TOP) |
| 1606 | jump to the top (outermost) exception in the exception stack." |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1607 | (interactive "P") |
| 1608 | (let* ((proc (get-process "Python")) |
| 1609 | (buffer (if proc "*Python*" py-output-buffer))) |
| 1610 | (if top |
| 1611 | (py-find-next-exception 'bob buffer 're-search-forward "Top") |
Barry Warsaw | ffbc17d | 1997-11-27 20:08:14 +0000 | [diff] [blame] | 1612 | (py-find-next-exception 'bol buffer 're-search-backward "Top")))) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1613 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1614 | |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1615 | ;; Electric deletion |
| 1616 | (defun py-electric-backspace (arg) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1617 | "Delete preceding character or levels of indentation. |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1618 | Deletion is performed by calling the function in `py-backspace-function' |
Barry Warsaw | b053993 | 1996-12-17 22:05:07 +0000 | [diff] [blame] | 1619 | with a single argument (the number of characters to delete). |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1620 | |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1621 | If point is at the leftmost column, delete the preceding newline. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1622 | |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1623 | Otherwise, if point is at the leftmost non-whitespace character of a |
| 1624 | line that is neither a continuation line nor a non-indenting comment |
| 1625 | line, or if point is at the end of a blank line, this command reduces |
| 1626 | the indentation to match that of the line that opened the current |
| 1627 | block of code. The line that opened the block is displayed in the |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1628 | echo area to help you keep track of where you are. With |
| 1629 | \\[universal-argument] dedents that many blocks (but not past column |
| 1630 | zero). |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1631 | |
| 1632 | Otherwise the preceding character is deleted, converting a tab to |
| 1633 | spaces if needed so that only a single column position is deleted. |
Barry Warsaw | fa2def2 | 1999-05-24 21:43:37 +0000 | [diff] [blame] | 1634 | \\[universal-argument] specifies how many characters to delete; |
| 1635 | default is 1. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1636 | |
| 1637 | When used programmatically, argument ARG specifies the number of |
| 1638 | blocks to dedent, or the number of characters to delete, as indicated |
| 1639 | above." |
Barry Warsaw | 0397073 | 1996-07-03 23:12:52 +0000 | [diff] [blame] | 1640 | (interactive "*p") |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1641 | (if (or (/= (current-indentation) (current-column)) |
| 1642 | (bolp) |
| 1643 | (py-continuation-line-p) |
Barry Warsaw | fa2def2 | 1999-05-24 21:43:37 +0000 | [diff] [blame] | 1644 | ; (not py-honor-comment-indentation) |
| 1645 | ; (looking-at "#[^ \t\n]") ; non-indenting # |
| 1646 | ) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1647 | (funcall py-backspace-function arg) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1648 | ;; else indent the same as the colon line that opened the block |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1649 | ;; force non-blank so py-goto-block-up doesn't ignore it |
| 1650 | (insert-char ?* 1) |
| 1651 | (backward-char) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1652 | (let ((base-indent 0) ; indentation of base line |
| 1653 | (base-text "") ; and text of base line |
| 1654 | (base-found-p nil)) |
Barry Warsaw | 0397073 | 1996-07-03 23:12:52 +0000 | [diff] [blame] | 1655 | (save-excursion |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1656 | (while (< 0 arg) |
Barry Warsaw | 0397073 | 1996-07-03 23:12:52 +0000 | [diff] [blame] | 1657 | (condition-case nil ; in case no enclosing block |
| 1658 | (progn |
| 1659 | (py-goto-block-up 'no-mark) |
| 1660 | (setq base-indent (current-indentation) |
| 1661 | base-text (py-suck-up-leading-text) |
| 1662 | base-found-p t)) |
| 1663 | (error nil)) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1664 | (setq arg (1- arg)))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1665 | (delete-char 1) ; toss the dummy character |
| 1666 | (delete-horizontal-space) |
| 1667 | (indent-to base-indent) |
| 1668 | (if base-found-p |
| 1669 | (message "Closes block: %s" base-text))))) |
| 1670 | |
Barry Warsaw | fc8a01f | 1995-03-09 16:07:29 +0000 | [diff] [blame] | 1671 | |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1672 | (defun py-electric-delete (arg) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1673 | "Delete preceding or following character or levels of whitespace. |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1674 | |
| 1675 | The behavior of this function depends on the variable |
| 1676 | `delete-key-deletes-forward'. If this variable is nil (or does not |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1677 | exist, as in older Emacsen and non-XEmacs versions), then this |
| 1678 | function behaves identically to \\[c-electric-backspace]. |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1679 | |
| 1680 | If `delete-key-deletes-forward' is non-nil and is supported in your |
| 1681 | Emacs, then deletion occurs in the forward direction, by calling the |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1682 | function in `py-delete-function'. |
| 1683 | |
| 1684 | \\[universal-argument] (programmatically, argument ARG) specifies the |
| 1685 | number of characters to delete (default is 1)." |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1686 | (interactive "*p") |
Barry Warsaw | 1d7b0fa | 1999-01-15 02:12:31 +0000 | [diff] [blame] | 1687 | (if (or (and (fboundp 'delete-forward-p) ;XEmacs 21 |
| 1688 | (delete-forward-p)) |
| 1689 | (and (boundp 'delete-key-deletes-forward) ;XEmacs 20 |
| 1690 | delete-key-deletes-forward)) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1691 | (funcall py-delete-function arg) |
Barry Warsaw | 6d48c4a | 1997-11-04 19:21:50 +0000 | [diff] [blame] | 1692 | (py-electric-backspace arg))) |
| 1693 | |
| 1694 | ;; required for pending-del and delsel modes |
| 1695 | (put 'py-electric-backspace 'delete-selection 'supersede) ;delsel |
| 1696 | (put 'py-electric-backspace 'pending-delete 'supersede) ;pending-del |
| 1697 | (put 'py-electric-delete 'delete-selection 'supersede) ;delsel |
| 1698 | (put 'py-electric-delete 'pending-delete 'supersede) ;pending-del |
| 1699 | |
| 1700 | |
| 1701 | |
Barry Warsaw | 7cb505c | 1996-10-23 20:44:59 +0000 | [diff] [blame] | 1702 | (defun py-indent-line (&optional arg) |
| 1703 | "Fix the indentation of the current line according to Python rules. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1704 | With \\[universal-argument] (programmatically, the optional argument |
| 1705 | ARG non-nil), ignore dedenting rules for block closing statements |
| 1706 | (e.g. return, raise, break, continue, pass) |
Barry Warsaw | 7cb505c | 1996-10-23 20:44:59 +0000 | [diff] [blame] | 1707 | |
| 1708 | This function is normally bound to `indent-line-function' so |
| 1709 | \\[indent-for-tab-command] will call it." |
| 1710 | (interactive "P") |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1711 | (let* ((ci (current-indentation)) |
| 1712 | (move-to-indentation-p (<= (current-column) ci)) |
Barry Warsaw | 7cb505c | 1996-10-23 20:44:59 +0000 | [diff] [blame] | 1713 | (need (py-compute-indentation (not arg)))) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1714 | ;; see if we need to dedent |
Barry Warsaw | 3874a3d | 1995-03-14 22:05:53 +0000 | [diff] [blame] | 1715 | (if (py-outdent-p) |
Barry Warsaw | 0012c1e | 1995-03-14 16:32:55 +0000 | [diff] [blame] | 1716 | (setq need (- need py-indent-offset))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1717 | (if (/= ci need) |
| 1718 | (save-excursion |
| 1719 | (beginning-of-line) |
| 1720 | (delete-horizontal-space) |
| 1721 | (indent-to need))) |
| 1722 | (if move-to-indentation-p (back-to-indentation)))) |
| 1723 | |
| 1724 | (defun py-newline-and-indent () |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1725 | "Strives to act like the Emacs `newline-and-indent'. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1726 | This is just `strives to' because correct indentation can't be computed |
| 1727 | from scratch for Python code. In general, deletes the whitespace before |
| 1728 | point, inserts a newline, and takes an educated guess as to how you want |
| 1729 | the new line indented." |
| 1730 | (interactive) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1731 | (let ((ci (current-indentation))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1732 | (if (< ci (current-column)) ; if point beyond indentation |
| 1733 | (newline-and-indent) |
| 1734 | ;; else try to act like newline-and-indent "normally" acts |
| 1735 | (beginning-of-line) |
| 1736 | (insert-char ?\n 1) |
| 1737 | (move-to-column ci)))) |
| 1738 | |
Barry Warsaw | 7cb505c | 1996-10-23 20:44:59 +0000 | [diff] [blame] | 1739 | (defun py-compute-indentation (honor-block-close-p) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1740 | "Compute Python indentation. |
| 1741 | When HONOR-BLOCK-CLOSE-P is non-nil, statements such as `return', |
| 1742 | `raise', `break', `continue', and `pass' force one level of |
| 1743 | dedenting." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1744 | (save-excursion |
Barry Warsaw | f64b405 | 1998-02-12 16:52:14 +0000 | [diff] [blame] | 1745 | (beginning-of-line) |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1746 | (let* ((bod (py-point 'bod)) |
Barry Warsaw | 3b3ff4e | 1997-11-26 20:58:48 +0000 | [diff] [blame] | 1747 | (pps (parse-partial-sexp bod (point))) |
Barry Warsaw | 9c1696c | 1998-12-15 04:36:22 +0000 | [diff] [blame] | 1748 | (boipps (parse-partial-sexp bod (py-point 'boi))) |
| 1749 | placeholder) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1750 | (cond |
Barry Warsaw | a0ee8cd | 1997-11-26 01:04:44 +0000 | [diff] [blame] | 1751 | ;; are we inside a multi-line string or comment? |
Barry Warsaw | 3b3ff4e | 1997-11-26 20:58:48 +0000 | [diff] [blame] | 1752 | ((or (and (nth 3 pps) (nth 3 boipps)) |
| 1753 | (and (nth 4 pps) (nth 4 boipps))) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1754 | (save-excursion |
| 1755 | (if (not py-align-multiline-strings-p) 0 |
| 1756 | ;; skip back over blank & non-indenting comment lines |
| 1757 | ;; note: will skip a blank or non-indenting comment line |
| 1758 | ;; that happens to be a continuation line too |
| 1759 | (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#[ \t\n]\\)" nil 'move) |
| 1760 | (back-to-indentation) |
| 1761 | (current-column)))) |
| 1762 | ;; are we on a continuation line? |
| 1763 | ((py-continuation-line-p) |
| 1764 | (let ((startpos (point)) |
| 1765 | (open-bracket-pos (py-nesting-level)) |
Barry Warsaw | ce60bc7 | 1996-08-01 18:17:14 +0000 | [diff] [blame] | 1766 | endpos searching found state) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1767 | (if open-bracket-pos |
| 1768 | (progn |
| 1769 | ;; align with first item in list; else a normal |
| 1770 | ;; indent beyond the line with the open bracket |
| 1771 | (goto-char (1+ open-bracket-pos)) ; just beyond bracket |
| 1772 | ;; is the first list item on the same line? |
| 1773 | (skip-chars-forward " \t") |
| 1774 | (if (null (memq (following-char) '(?\n ?# ?\\))) |
| 1775 | ; yes, so line up with it |
| 1776 | (current-column) |
| 1777 | ;; first list item on another line, or doesn't exist yet |
| 1778 | (forward-line 1) |
| 1779 | (while (and (< (point) startpos) |
| 1780 | (looking-at "[ \t]*[#\n\\\\]")) ; skip noise |
| 1781 | (forward-line 1)) |
Barry Warsaw | 92166d9 | 1998-04-01 21:59:41 +0000 | [diff] [blame] | 1782 | (if (and (< (point) startpos) |
| 1783 | (/= startpos |
| 1784 | (save-excursion |
| 1785 | (goto-char (1+ open-bracket-pos)) |
Barry Warsaw | 77d1fce | 1998-04-16 20:04:59 +0000 | [diff] [blame] | 1786 | (forward-comment (point-max)) |
Barry Warsaw | 92166d9 | 1998-04-01 21:59:41 +0000 | [diff] [blame] | 1787 | (point)))) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1788 | ;; again mimic the first list item |
| 1789 | (current-indentation) |
| 1790 | ;; else they're about to enter the first item |
| 1791 | (goto-char open-bracket-pos) |
Barry Warsaw | 9c1696c | 1998-12-15 04:36:22 +0000 | [diff] [blame] | 1792 | (setq placeholder (point)) |
| 1793 | (py-goto-initial-line) |
| 1794 | (py-goto-beginning-of-tqs |
| 1795 | (save-excursion (nth 3 (parse-partial-sexp |
| 1796 | placeholder (point))))) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1797 | (+ (current-indentation) py-indent-offset)))) |
| 1798 | |
| 1799 | ;; else on backslash continuation line |
| 1800 | (forward-line -1) |
| 1801 | (if (py-continuation-line-p) ; on at least 3rd line in block |
| 1802 | (current-indentation) ; so just continue the pattern |
| 1803 | ;; else started on 2nd line in block, so indent more. |
| 1804 | ;; if base line is an assignment with a start on a RHS, |
| 1805 | ;; indent to 2 beyond the leftmost "="; else skip first |
| 1806 | ;; chunk of non-whitespace characters on base line, + 1 more |
| 1807 | ;; column |
| 1808 | (end-of-line) |
Barry Warsaw | fd4c9e8 | 2001-06-18 23:40:35 +0000 | [diff] [blame] | 1809 | (setq endpos (point) |
| 1810 | searching t) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1811 | (back-to-indentation) |
| 1812 | (setq startpos (point)) |
| 1813 | ;; look at all "=" from left to right, stopping at first |
| 1814 | ;; one not nested in a list or string |
| 1815 | (while searching |
| 1816 | (skip-chars-forward "^=" endpos) |
| 1817 | (if (= (point) endpos) |
| 1818 | (setq searching nil) |
| 1819 | (forward-char 1) |
| 1820 | (setq state (parse-partial-sexp startpos (point))) |
| 1821 | (if (and (zerop (car state)) ; not in a bracket |
| 1822 | (null (nth 3 state))) ; & not in a string |
| 1823 | (progn |
| 1824 | (setq searching nil) ; done searching in any case |
| 1825 | (setq found |
| 1826 | (not (or |
| 1827 | (eq (following-char) ?=) |
| 1828 | (memq (char-after (- (point) 2)) |
| 1829 | '(?< ?> ?!))))))))) |
| 1830 | (if (or (not found) ; not an assignment |
| 1831 | (looking-at "[ \t]*\\\\")) ; <=><spaces><backslash> |
| 1832 | (progn |
| 1833 | (goto-char startpos) |
| 1834 | (skip-chars-forward "^ \t\n"))) |
Barry Warsaw | 40fb452 | 2001-07-06 20:07:13 +0000 | [diff] [blame] | 1835 | ;; if this is a continuation for a block opening |
| 1836 | ;; statement, add some extra offset. |
| 1837 | (+ (current-column) (if (py-statement-opens-block-p) |
| 1838 | py-continuation-offset 0) |
| 1839 | 1) |
Barry Warsaw | fd4c9e8 | 2001-06-18 23:40:35 +0000 | [diff] [blame] | 1840 | )))) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1841 | |
| 1842 | ;; not on a continuation line |
Barry Warsaw | a789171 | 1996-08-01 15:53:09 +0000 | [diff] [blame] | 1843 | ((bobp) (current-indentation)) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1844 | |
Barry Warsaw | a789171 | 1996-08-01 15:53:09 +0000 | [diff] [blame] | 1845 | ;; Dfn: "Indenting comment line". A line containing only a |
| 1846 | ;; comment, but which is treated like a statement for |
| 1847 | ;; indentation calculation purposes. Such lines are only |
| 1848 | ;; treated specially by the mode; they are not treated |
| 1849 | ;; specially by the Python interpreter. |
| 1850 | |
| 1851 | ;; The rules for indenting comment lines are a line where: |
| 1852 | ;; - the first non-whitespace character is `#', and |
| 1853 | ;; - the character following the `#' is whitespace, and |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1854 | ;; - the line is dedented with respect to (i.e. to the left |
Barry Warsaw | a789171 | 1996-08-01 15:53:09 +0000 | [diff] [blame] | 1855 | ;; of) the indentation of the preceding non-blank line. |
| 1856 | |
| 1857 | ;; The first non-blank line following an indenting comment |
| 1858 | ;; line is given the same amount of indentation as the |
| 1859 | ;; indenting comment line. |
| 1860 | |
| 1861 | ;; All other comment-only lines are ignored for indentation |
| 1862 | ;; purposes. |
| 1863 | |
| 1864 | ;; Are we looking at a comment-only line which is *not* an |
Barry Warsaw | 145ab1c | 1998-05-19 14:49:49 +0000 | [diff] [blame] | 1865 | ;; indenting comment line? If so, we assume that it's been |
Barry Warsaw | a789171 | 1996-08-01 15:53:09 +0000 | [diff] [blame] | 1866 | ;; placed at the desired indentation, so leave it alone. |
| 1867 | ;; Indenting comment lines are aligned as statements down |
| 1868 | ;; below. |
| 1869 | ((and (looking-at "[ \t]*#[^ \t\n]") |
| 1870 | ;; NOTE: this test will not be performed in older Emacsen |
| 1871 | (fboundp 'forward-comment) |
| 1872 | (<= (current-indentation) |
| 1873 | (save-excursion |
| 1874 | (forward-comment (- (point-max))) |
| 1875 | (current-indentation)))) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1876 | (current-indentation)) |
| 1877 | |
| 1878 | ;; else indentation based on that of the statement that |
| 1879 | ;; precedes us; use the first line of that statement to |
| 1880 | ;; establish the base, in case the user forced a non-std |
| 1881 | ;; indentation for the continuation lines (if any) |
| 1882 | (t |
Barry Warsaw | c01c5c8 | 1995-09-14 18:49:11 +0000 | [diff] [blame] | 1883 | ;; skip back over blank & non-indenting comment lines note: |
| 1884 | ;; will skip a blank or non-indenting comment line that |
Barry Warsaw | fd0fb38 | 1996-03-04 17:15:40 +0000 | [diff] [blame] | 1885 | ;; happens to be a continuation line too. use fast Emacs 19 |
| 1886 | ;; function if it's there. |
Barry Warsaw | 6d62775 | 1996-03-06 18:41:38 +0000 | [diff] [blame] | 1887 | (if (and (eq py-honor-comment-indentation nil) |
Barry Warsaw | 33d6ec0 | 1996-03-05 16:28:07 +0000 | [diff] [blame] | 1888 | (fboundp 'forward-comment)) |
Barry Warsaw | fd0fb38 | 1996-03-04 17:15:40 +0000 | [diff] [blame] | 1889 | (forward-comment (- (point-max))) |
Barry Warsaw | 218eb75 | 1998-09-22 19:51:47 +0000 | [diff] [blame] | 1890 | (let ((prefix-re (concat py-block-comment-prefix "[ \t]*")) |
| 1891 | done) |
Barry Warsaw | 6d62775 | 1996-03-06 18:41:38 +0000 | [diff] [blame] | 1892 | (while (not done) |
Barry Warsaw | 12c9294 | 1998-08-10 21:44:37 +0000 | [diff] [blame] | 1893 | (re-search-backward "^[ \t]*\\([^ \t\n#]\\|#\\)" nil 'move) |
| 1894 | (setq done (or (bobp) |
| 1895 | (and (eq py-honor-comment-indentation t) |
| 1896 | (save-excursion |
| 1897 | (back-to-indentation) |
Barry Warsaw | 218eb75 | 1998-09-22 19:51:47 +0000 | [diff] [blame] | 1898 | (not (looking-at prefix-re)) |
Barry Warsaw | 12c9294 | 1998-08-10 21:44:37 +0000 | [diff] [blame] | 1899 | )) |
| 1900 | (and (not (eq py-honor-comment-indentation t)) |
| 1901 | (save-excursion |
| 1902 | (back-to-indentation) |
Barry Warsaw | d36cfe4 | 2002-03-15 16:46:46 +0000 | [diff] [blame] | 1903 | (and (not (looking-at prefix-re)) |
| 1904 | (or (looking-at "[^#]") |
| 1905 | (not (zerop (current-column))) |
| 1906 | )) |
| 1907 | )) |
Barry Warsaw | 12c9294 | 1998-08-10 21:44:37 +0000 | [diff] [blame] | 1908 | )) |
Barry Warsaw | 6d62775 | 1996-03-06 18:41:38 +0000 | [diff] [blame] | 1909 | ))) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1910 | ;; if we landed inside a string, go to the beginning of that |
| 1911 | ;; string. this handles triple quoted, multi-line spanning |
| 1912 | ;; strings. |
Barry Warsaw | 9c1696c | 1998-12-15 04:36:22 +0000 | [diff] [blame] | 1913 | (py-goto-beginning-of-tqs (nth 3 (parse-partial-sexp bod (point)))) |
Barry Warsaw | c210e69 | 1998-01-20 22:52:56 +0000 | [diff] [blame] | 1914 | ;; now skip backward over continued lines |
Barry Warsaw | 9c1696c | 1998-12-15 04:36:22 +0000 | [diff] [blame] | 1915 | (setq placeholder (point)) |
Barry Warsaw | 095e9c6 | 1995-09-19 20:01:42 +0000 | [diff] [blame] | 1916 | (py-goto-initial-line) |
Barry Warsaw | 9c1696c | 1998-12-15 04:36:22 +0000 | [diff] [blame] | 1917 | ;; we may *now* have landed in a TQS, so find the beginning of |
| 1918 | ;; this string. |
| 1919 | (py-goto-beginning-of-tqs |
| 1920 | (save-excursion (nth 3 (parse-partial-sexp |
| 1921 | placeholder (point))))) |
Barry Warsaw | f831d81 | 1996-07-31 20:42:59 +0000 | [diff] [blame] | 1922 | (+ (current-indentation) |
| 1923 | (if (py-statement-opens-block-p) |
| 1924 | py-indent-offset |
Barry Warsaw | 7cb505c | 1996-10-23 20:44:59 +0000 | [diff] [blame] | 1925 | (if (and honor-block-close-p (py-statement-closes-block-p)) |
Barry Warsaw | f831d81 | 1996-07-31 20:42:59 +0000 | [diff] [blame] | 1926 | (- py-indent-offset) |
| 1927 | 0))) |
| 1928 | ))))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1929 | |
| 1930 | (defun py-guess-indent-offset (&optional global) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1931 | "Guess a good value for, and change, `py-indent-offset'. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1932 | |
| 1933 | By default, make a buffer-local copy of `py-indent-offset' with the |
| 1934 | new value, so that other Python buffers are not affected. With |
| 1935 | \\[universal-argument] (programmatically, optional argument GLOBAL), |
| 1936 | change the global value of `py-indent-offset'. This affects all |
| 1937 | Python buffers (that don't have their own buffer-local copy), both |
| 1938 | those currently existing and those created later in the Emacs session. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1939 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1940 | Some people use a different value for `py-indent-offset' than you use. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1941 | There's no excuse for such foolishness, but sometimes you have to deal |
| 1942 | with their ugly code anyway. This function examines the file and sets |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1943 | `py-indent-offset' to what it thinks it was when they created the |
| 1944 | mess. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1945 | |
| 1946 | Specifically, it searches forward from the statement containing point, |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1947 | looking for a line that opens a block of code. `py-indent-offset' is |
| 1948 | set to the difference in indentation between that line and the Python |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1949 | statement following it. If the search doesn't succeed going forward, |
| 1950 | it's tried again going backward." |
| 1951 | (interactive "P") ; raw prefix arg |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1952 | (let (new-value |
| 1953 | (start (point)) |
Barry Warsaw | e908b6b | 1998-03-19 22:48:02 +0000 | [diff] [blame] | 1954 | (restart (point)) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 1955 | (found nil) |
| 1956 | colon-indent) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1957 | (py-goto-initial-line) |
| 1958 | (while (not (or found (eobp))) |
Barry Warsaw | e908b6b | 1998-03-19 22:48:02 +0000 | [diff] [blame] | 1959 | (when (and (re-search-forward ":[ \t]*\\($\\|[#\\]\\)" nil 'move) |
| 1960 | (not (py-in-literal restart))) |
| 1961 | (setq restart (point)) |
| 1962 | (py-goto-initial-line) |
| 1963 | (if (py-statement-opens-block-p) |
| 1964 | (setq found t) |
| 1965 | (goto-char restart)))) |
| 1966 | (unless found |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1967 | (goto-char start) |
| 1968 | (py-goto-initial-line) |
| 1969 | (while (not (or found (bobp))) |
Barry Warsaw | e908b6b | 1998-03-19 22:48:02 +0000 | [diff] [blame] | 1970 | (setq found (and |
| 1971 | (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move) |
| 1972 | (or (py-goto-initial-line) t) ; always true -- side effect |
| 1973 | (py-statement-opens-block-p))))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1974 | (setq colon-indent (current-indentation) |
| 1975 | found (and found (zerop (py-next-statement 1))) |
| 1976 | new-value (- (current-indentation) colon-indent)) |
| 1977 | (goto-char start) |
Barry Warsaw | e908b6b | 1998-03-19 22:48:02 +0000 | [diff] [blame] | 1978 | (if (not found) |
| 1979 | (error "Sorry, couldn't guess a value for py-indent-offset") |
| 1980 | (funcall (if global 'kill-local-variable 'make-local-variable) |
| 1981 | 'py-indent-offset) |
| 1982 | (setq py-indent-offset new-value) |
Barry Warsaw | d35c255 | 1998-09-25 00:08:38 +0000 | [diff] [blame] | 1983 | (or noninteractive |
| 1984 | (message "%s value of py-indent-offset set to %d" |
| 1985 | (if global "Global" "Local") |
| 1986 | py-indent-offset))) |
Barry Warsaw | e908b6b | 1998-03-19 22:48:02 +0000 | [diff] [blame] | 1987 | )) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 1988 | |
Barry Warsaw | 003932a | 1998-07-07 15:11:24 +0000 | [diff] [blame] | 1989 | (defun py-comment-indent-function () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 1990 | "Python version of `comment-indent-function'." |
| 1991 | ;; This is required when filladapt is turned off. Without it, when |
| 1992 | ;; filladapt is not used, comments which start in column zero |
| 1993 | ;; cascade one character to the right |
Barry Warsaw | 003932a | 1998-07-07 15:11:24 +0000 | [diff] [blame] | 1994 | (save-excursion |
| 1995 | (beginning-of-line) |
| 1996 | (let ((eol (py-point 'eol))) |
| 1997 | (and comment-start-skip |
| 1998 | (re-search-forward comment-start-skip eol t) |
| 1999 | (setq eol (match-beginning 0))) |
| 2000 | (goto-char eol) |
| 2001 | (skip-chars-backward " \t") |
| 2002 | (max comment-column (+ (current-column) (if (bolp) 0 1))) |
| 2003 | ))) |
| 2004 | |
Barry Warsaw | f8ddb6a | 1999-01-18 21:49:39 +0000 | [diff] [blame] | 2005 | (defun py-narrow-to-defun (&optional class) |
| 2006 | "Make text outside current defun invisible. |
| 2007 | The defun visible is the one that contains point or follows point. |
| 2008 | Optional CLASS is passed directly to `py-beginning-of-def-or-class'." |
| 2009 | (interactive "P") |
| 2010 | (save-excursion |
| 2011 | (widen) |
| 2012 | (py-end-of-def-or-class class) |
| 2013 | (let ((end (point))) |
| 2014 | (py-beginning-of-def-or-class class) |
| 2015 | (narrow-to-region (point) end)))) |
| 2016 | |
Barry Warsaw | 003932a | 1998-07-07 15:11:24 +0000 | [diff] [blame] | 2017 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2018 | (defun py-shift-region (start end count) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2019 | "Indent lines from START to END by COUNT spaces." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2020 | (save-excursion |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2021 | (goto-char end) |
| 2022 | (beginning-of-line) |
| 2023 | (setq end (point)) |
| 2024 | (goto-char start) |
| 2025 | (beginning-of-line) |
| 2026 | (setq start (point)) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2027 | (indent-rigidly start end count))) |
| 2028 | |
| 2029 | (defun py-shift-region-left (start end &optional count) |
| 2030 | "Shift region of Python code to the left. |
| 2031 | The lines from the line containing the start of the current region up |
| 2032 | to (but not including) the line containing the end of the region are |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2033 | shifted to the left, by `py-indent-offset' columns. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2034 | |
| 2035 | If a prefix argument is given, the region is instead shifted by that |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2036 | many columns. With no active region, dedent only the current line. |
| 2037 | You cannot dedent the region if any line is already at column zero." |
Barry Warsaw | dea4a29 | 1996-07-03 22:59:12 +0000 | [diff] [blame] | 2038 | (interactive |
| 2039 | (let ((p (point)) |
| 2040 | (m (mark)) |
| 2041 | (arg current-prefix-arg)) |
| 2042 | (if m |
| 2043 | (list (min p m) (max p m) arg) |
| 2044 | (list p (save-excursion (forward-line 1) (point)) arg)))) |
| 2045 | ;; if any line is at column zero, don't shift the region |
| 2046 | (save-excursion |
| 2047 | (goto-char start) |
| 2048 | (while (< (point) end) |
| 2049 | (back-to-indentation) |
Barry Warsaw | 71e315b | 1996-07-23 15:03:16 +0000 | [diff] [blame] | 2050 | (if (and (zerop (current-column)) |
| 2051 | (not (looking-at "\\s *$"))) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2052 | (error "Region is at left edge")) |
Barry Warsaw | dea4a29 | 1996-07-03 22:59:12 +0000 | [diff] [blame] | 2053 | (forward-line 1))) |
| 2054 | (py-shift-region start end (- (prefix-numeric-value |
| 2055 | (or count py-indent-offset)))) |
| 2056 | (py-keep-region-active)) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2057 | |
| 2058 | (defun py-shift-region-right (start end &optional count) |
| 2059 | "Shift region of Python code to the right. |
| 2060 | The lines from the line containing the start of the current region up |
| 2061 | to (but not including) the line containing the end of the region are |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2062 | shifted to the right, by `py-indent-offset' columns. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2063 | |
| 2064 | If a prefix argument is given, the region is instead shifted by that |
Barry Warsaw | dea4a29 | 1996-07-03 22:59:12 +0000 | [diff] [blame] | 2065 | many columns. With no active region, indent only the current line." |
| 2066 | (interactive |
| 2067 | (let ((p (point)) |
| 2068 | (m (mark)) |
| 2069 | (arg current-prefix-arg)) |
| 2070 | (if m |
| 2071 | (list (min p m) (max p m) arg) |
| 2072 | (list p (save-excursion (forward-line 1) (point)) arg)))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2073 | (py-shift-region start end (prefix-numeric-value |
Barry Warsaw | dea4a29 | 1996-07-03 22:59:12 +0000 | [diff] [blame] | 2074 | (or count py-indent-offset))) |
| 2075 | (py-keep-region-active)) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2076 | |
| 2077 | (defun py-indent-region (start end &optional indent-offset) |
| 2078 | "Reindent a region of Python code. |
Barry Warsaw | 867a32a | 1996-03-07 18:30:26 +0000 | [diff] [blame] | 2079 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2080 | The lines from the line containing the start of the current region up |
| 2081 | to (but not including) the line containing the end of the region are |
| 2082 | reindented. If the first line of the region has a non-whitespace |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2083 | character in the first column, the first line is left alone and the |
| 2084 | rest of the region is reindented with respect to it. Else the entire |
Barry Warsaw | 867a32a | 1996-03-07 18:30:26 +0000 | [diff] [blame] | 2085 | region is reindented with respect to the (closest code or indenting |
| 2086 | comment) statement immediately preceding the region. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2087 | |
| 2088 | This is useful when code blocks are moved or yanked, when enclosing |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2089 | control structures are introduced or removed, or to reformat code |
| 2090 | using a new value for the indentation offset. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2091 | |
| 2092 | If a numeric prefix argument is given, it will be used as the value of |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2093 | the indentation offset. Else the value of `py-indent-offset' will be |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2094 | used. |
| 2095 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2096 | Warning: The region must be consistently indented before this function |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2097 | is called! This function does not compute proper indentation from |
| 2098 | scratch (that's impossible in Python), it merely adjusts the existing |
| 2099 | indentation to be correct in context. |
| 2100 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2101 | Warning: This function really has no idea what to do with |
| 2102 | non-indenting comment lines, and shifts them as if they were indenting |
| 2103 | comment lines. Fixing this appears to require telepathy. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2104 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2105 | Special cases: whitespace is deleted from blank lines; continuation |
| 2106 | lines are shifted by the same amount their initial line was shifted, |
| 2107 | in order to preserve their relative indentation with respect to their |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2108 | initial line; and comment lines beginning in column 1 are ignored." |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2109 | (interactive "*r\nP") ; region; raw prefix arg |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2110 | (save-excursion |
| 2111 | (goto-char end) (beginning-of-line) (setq end (point-marker)) |
| 2112 | (goto-char start) (beginning-of-line) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2113 | (let ((py-indent-offset (prefix-numeric-value |
| 2114 | (or indent-offset py-indent-offset))) |
| 2115 | (indents '(-1)) ; stack of active indent levels |
| 2116 | (target-column 0) ; column to which to indent |
| 2117 | (base-shifted-by 0) ; amount last base line was shifted |
| 2118 | (indent-base (if (looking-at "[ \t\n]") |
Barry Warsaw | 7cb505c | 1996-10-23 20:44:59 +0000 | [diff] [blame] | 2119 | (py-compute-indentation t) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2120 | 0)) |
| 2121 | ci) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2122 | (while (< (point) end) |
| 2123 | (setq ci (current-indentation)) |
| 2124 | ;; figure out appropriate target column |
| 2125 | (cond |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2126 | ((or (eq (following-char) ?#) ; comment in column 1 |
| 2127 | (looking-at "[ \t]*$")) ; entirely blank |
| 2128 | (setq target-column 0)) |
| 2129 | ((py-continuation-line-p) ; shift relative to base line |
| 2130 | (setq target-column (+ ci base-shifted-by))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2131 | (t ; new base line |
| 2132 | (if (> ci (car indents)) ; going deeper; push it |
| 2133 | (setq indents (cons ci indents)) |
| 2134 | ;; else we should have seen this indent before |
| 2135 | (setq indents (memq ci indents)) ; pop deeper indents |
| 2136 | (if (null indents) |
| 2137 | (error "Bad indentation in region, at line %d" |
| 2138 | (save-restriction |
| 2139 | (widen) |
| 2140 | (1+ (count-lines 1 (point))))))) |
| 2141 | (setq target-column (+ indent-base |
| 2142 | (* py-indent-offset |
| 2143 | (- (length indents) 2)))) |
| 2144 | (setq base-shifted-by (- target-column ci)))) |
| 2145 | ;; shift as needed |
| 2146 | (if (/= ci target-column) |
| 2147 | (progn |
| 2148 | (delete-horizontal-space) |
| 2149 | (indent-to target-column))) |
| 2150 | (forward-line 1)))) |
| 2151 | (set-marker end nil)) |
| 2152 | |
Barry Warsaw | a789171 | 1996-08-01 15:53:09 +0000 | [diff] [blame] | 2153 | (defun py-comment-region (beg end &optional arg) |
| 2154 | "Like `comment-region' but uses double hash (`#') comment starter." |
| 2155 | (interactive "r\nP") |
Barry Warsaw | 3fcaf61 | 1996-08-01 20:11:51 +0000 | [diff] [blame] | 2156 | (let ((comment-start py-block-comment-prefix)) |
Barry Warsaw | a789171 | 1996-08-01 15:53:09 +0000 | [diff] [blame] | 2157 | (comment-region beg end arg))) |
| 2158 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2159 | |
| 2160 | ;; Functions for moving point |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2161 | (defun py-previous-statement (count) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2162 | "Go to the start of the COUNTth preceding Python statement. |
| 2163 | By default, goes to the previous statement. If there is no such |
| 2164 | statement, goes to the first statement. Return count of statements |
| 2165 | left to move. `Statements' do not include blank, comment, or |
| 2166 | continuation lines." |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2167 | (interactive "p") ; numeric prefix arg |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2168 | (if (< count 0) (py-next-statement (- count)) |
| 2169 | (py-goto-initial-line) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2170 | (let (start) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2171 | (while (and |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2172 | (setq start (point)) ; always true -- side effect |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2173 | (> count 0) |
| 2174 | (zerop (forward-line -1)) |
| 2175 | (py-goto-statement-at-or-above)) |
| 2176 | (setq count (1- count))) |
| 2177 | (if (> count 0) (goto-char start))) |
| 2178 | count)) |
| 2179 | |
| 2180 | (defun py-next-statement (count) |
| 2181 | "Go to the start of next Python statement. |
| 2182 | If the statement at point is the i'th Python statement, goes to the |
| 2183 | start of statement i+COUNT. If there is no such statement, goes to the |
| 2184 | last statement. Returns count of statements left to move. `Statements' |
| 2185 | do not include blank, comment, or continuation lines." |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2186 | (interactive "p") ; numeric prefix arg |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2187 | (if (< count 0) (py-previous-statement (- count)) |
| 2188 | (beginning-of-line) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2189 | (let (start) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2190 | (while (and |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2191 | (setq start (point)) ; always true -- side effect |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2192 | (> count 0) |
| 2193 | (py-goto-statement-below)) |
| 2194 | (setq count (1- count))) |
| 2195 | (if (> count 0) (goto-char start))) |
| 2196 | count)) |
| 2197 | |
| 2198 | (defun py-goto-block-up (&optional nomark) |
| 2199 | "Move up to start of current block. |
| 2200 | Go to the statement that starts the smallest enclosing block; roughly |
| 2201 | speaking, this will be the closest preceding statement that ends with a |
| 2202 | colon and is indented less than the statement you started on. If |
| 2203 | successful, also sets the mark to the starting point. |
| 2204 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2205 | `\\[py-mark-block]' can be used afterward to mark the whole code |
| 2206 | block, if desired. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2207 | |
| 2208 | If called from a program, the mark will not be set if optional argument |
| 2209 | NOMARK is not nil." |
| 2210 | (interactive) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2211 | (let ((start (point)) |
| 2212 | (found nil) |
| 2213 | initial-indent) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2214 | (py-goto-initial-line) |
| 2215 | ;; if on blank or non-indenting comment line, use the preceding stmt |
| 2216 | (if (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)") |
| 2217 | (progn |
| 2218 | (py-goto-statement-at-or-above) |
| 2219 | (setq found (py-statement-opens-block-p)))) |
| 2220 | ;; search back for colon line indented less |
| 2221 | (setq initial-indent (current-indentation)) |
| 2222 | (if (zerop initial-indent) |
| 2223 | ;; force fast exit |
| 2224 | (goto-char (point-min))) |
| 2225 | (while (not (or found (bobp))) |
| 2226 | (setq found |
| 2227 | (and |
| 2228 | (re-search-backward ":[ \t]*\\($\\|[#\\]\\)" nil 'move) |
| 2229 | (or (py-goto-initial-line) t) ; always true -- side effect |
| 2230 | (< (current-indentation) initial-indent) |
| 2231 | (py-statement-opens-block-p)))) |
| 2232 | (if found |
| 2233 | (progn |
| 2234 | (or nomark (push-mark start)) |
| 2235 | (back-to-indentation)) |
| 2236 | (goto-char start) |
| 2237 | (error "Enclosing block not found")))) |
| 2238 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2239 | (defun py-beginning-of-def-or-class (&optional class count) |
| 2240 | "Move point to start of `def' or `class'. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2241 | |
| 2242 | Searches back for the closest preceding `def'. If you supply a prefix |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2243 | arg, looks for a `class' instead. The docs below assume the `def' |
| 2244 | case; just substitute `class' for `def' for the other case. |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 2245 | Programmatically, if CLASS is `either', then moves to either `class' |
| 2246 | or `def'. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2247 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2248 | When second optional argument is given programmatically, move to the |
| 2249 | COUNTth start of `def'. |
| 2250 | |
| 2251 | If point is in a `def' statement already, and after the `d', simply |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2252 | moves point to the start of the statement. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2253 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2254 | Otherwise (i.e. when point is not in a `def' statement, or at or |
| 2255 | before the `d' of a `def' statement), searches for the closest |
| 2256 | preceding `def' statement, and leaves point at its start. If no such |
| 2257 | statement can be found, leaves point at the start of the buffer. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2258 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2259 | Returns t iff a `def' statement is found by these rules. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2260 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2261 | Note that doing this command repeatedly will take you closer to the |
| 2262 | start of the buffer each time. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2263 | |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 2264 | To mark the current `def', see `\\[py-mark-def-or-class]'." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2265 | (interactive "P") ; raw prefix arg |
Barry Warsaw | 6839d3a | 1998-10-28 00:10:45 +0000 | [diff] [blame] | 2266 | (setq count (or count 1)) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2267 | (let ((at-or-before-p (<= (current-column) (current-indentation))) |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2268 | (start-of-line (goto-char (py-point 'bol))) |
| 2269 | (start-of-stmt (goto-char (py-point 'bos))) |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 2270 | (start-re (cond ((eq class 'either) "^[ \t]*\\(class\\|def\\)\\>") |
| 2271 | (class "^[ \t]*class\\>") |
| 2272 | (t "^[ \t]*def\\>"))) |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2273 | ) |
| 2274 | ;; searching backward |
| 2275 | (if (and (< 0 count) |
| 2276 | (or (/= start-of-stmt start-of-line) |
| 2277 | (not at-or-before-p))) |
| 2278 | (end-of-line)) |
| 2279 | ;; search forward |
| 2280 | (if (and (> 0 count) |
| 2281 | (zerop (current-column)) |
| 2282 | (looking-at start-re)) |
| 2283 | (end-of-line)) |
Barry Warsaw | ddc4696 | 1999-07-27 21:40:02 +0000 | [diff] [blame] | 2284 | (if (re-search-backward start-re nil 'move count) |
| 2285 | (goto-char (match-beginning 0))))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2286 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2287 | ;; Backwards compatibility |
| 2288 | (defalias 'beginning-of-python-def-or-class 'py-beginning-of-def-or-class) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2289 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2290 | (defun py-end-of-def-or-class (&optional class count) |
| 2291 | "Move point beyond end of `def' or `class' body. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2292 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2293 | By default, looks for an appropriate `def'. If you supply a prefix |
| 2294 | arg, looks for a `class' instead. The docs below assume the `def' |
| 2295 | case; just substitute `class' for `def' for the other case. |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 2296 | Programmatically, if CLASS is `either', then moves to either `class' |
| 2297 | or `def'. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2298 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2299 | When second optional argument is given programmatically, move to the |
| 2300 | COUNTth end of `def'. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2301 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2302 | If point is in a `def' statement already, this is the `def' we use. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2303 | |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2304 | Else, if the `def' found by `\\[py-beginning-of-def-or-class]' |
| 2305 | contains the statement you started on, that's the `def' we use. |
| 2306 | |
| 2307 | Otherwise, we search forward for the closest following `def', and use that. |
| 2308 | |
| 2309 | If a `def' can be found by these rules, point is moved to the start of |
| 2310 | the line immediately following the `def' block, and the position of the |
| 2311 | start of the `def' is returned. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2312 | |
| 2313 | Else point is moved to the end of the buffer, and nil is returned. |
| 2314 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2315 | Note that doing this command repeatedly will take you closer to the |
| 2316 | end of the buffer each time. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2317 | |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 2318 | To mark the current `def', see `\\[py-mark-def-or-class]'." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2319 | (interactive "P") ; raw prefix arg |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2320 | (if (and count (/= count 1)) |
| 2321 | (py-beginning-of-def-or-class (- 1 count))) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2322 | (let ((start (progn (py-goto-initial-line) (point))) |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 2323 | (which (cond ((eq class 'either) "\\(class\\|def\\)") |
| 2324 | (class "class") |
| 2325 | (t "def"))) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2326 | (state 'not-found)) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2327 | ;; move point to start of appropriate def/class |
| 2328 | (if (looking-at (concat "[ \t]*" which "\\>")) ; already on one |
| 2329 | (setq state 'at-beginning) |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2330 | ;; else see if py-beginning-of-def-or-class hits container |
| 2331 | (if (and (py-beginning-of-def-or-class class) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2332 | (progn (py-goto-beyond-block) |
| 2333 | (> (point) start))) |
| 2334 | (setq state 'at-end) |
| 2335 | ;; else search forward |
| 2336 | (goto-char start) |
| 2337 | (if (re-search-forward (concat "^[ \t]*" which "\\>") nil 'move) |
| 2338 | (progn (setq state 'at-beginning) |
| 2339 | (beginning-of-line))))) |
| 2340 | (cond |
| 2341 | ((eq state 'at-beginning) (py-goto-beyond-block) t) |
| 2342 | ((eq state 'at-end) t) |
| 2343 | ((eq state 'not-found) nil) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2344 | (t (error "Internal error in `py-end-of-def-or-class'"))))) |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2345 | |
| 2346 | ;; Backwards compabitility |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 2347 | (defalias 'end-of-python-def-or-class 'py-end-of-def-or-class) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2348 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2349 | |
| 2350 | ;; Functions for marking regions |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2351 | (defun py-mark-block (&optional extend just-move) |
| 2352 | "Mark following block of lines. With prefix arg, mark structure. |
| 2353 | Easier to use than explain. It sets the region to an `interesting' |
| 2354 | block of succeeding lines. If point is on a blank line, it goes down to |
| 2355 | the next non-blank line. That will be the start of the region. The end |
| 2356 | of the region depends on the kind of line at the start: |
| 2357 | |
| 2358 | - If a comment, the region will include all succeeding comment lines up |
| 2359 | to (but not including) the next non-comment line (if any). |
| 2360 | |
| 2361 | - Else if a prefix arg is given, and the line begins one of these |
| 2362 | structures: |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2363 | |
| 2364 | if elif else try except finally for while def class |
| 2365 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2366 | the region will be set to the body of the structure, including |
| 2367 | following blocks that `belong' to it, but excluding trailing blank |
| 2368 | and comment lines. E.g., if on a `try' statement, the `try' block |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2369 | and all (if any) of the following `except' and `finally' blocks |
| 2370 | that belong to the `try' structure will be in the region. Ditto |
| 2371 | for if/elif/else, for/else and while/else structures, and (a bit |
| 2372 | degenerate, since they're always one-block structures) def and |
| 2373 | class blocks. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2374 | |
| 2375 | - Else if no prefix argument is given, and the line begins a Python |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2376 | block (see list above), and the block is not a `one-liner' (i.e., |
| 2377 | the statement ends with a colon, not with code), the region will |
| 2378 | include all succeeding lines up to (but not including) the next |
| 2379 | code statement (if any) that's indented no more than the starting |
| 2380 | line, except that trailing blank and comment lines are excluded. |
| 2381 | E.g., if the starting line begins a multi-statement `def' |
| 2382 | structure, the region will be set to the full function definition, |
| 2383 | but without any trailing `noise' lines. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2384 | |
| 2385 | - Else the region will include all succeeding lines up to (but not |
| 2386 | including) the next blank line, or code or indenting-comment line |
| 2387 | indented strictly less than the starting line. Trailing indenting |
| 2388 | comment lines are included in this case, but not trailing blank |
| 2389 | lines. |
| 2390 | |
| 2391 | A msg identifying the location of the mark is displayed in the echo |
| 2392 | area; or do `\\[exchange-point-and-mark]' to flip down to the end. |
| 2393 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2394 | If called from a program, optional argument EXTEND plays the role of |
| 2395 | the prefix arg, and if optional argument JUST-MOVE is not nil, just |
| 2396 | moves to the end of the block (& does not set mark or display a msg)." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2397 | (interactive "P") ; raw prefix arg |
| 2398 | (py-goto-initial-line) |
| 2399 | ;; skip over blank lines |
| 2400 | (while (and |
| 2401 | (looking-at "[ \t]*$") ; while blank line |
| 2402 | (not (eobp))) ; & somewhere to go |
| 2403 | (forward-line 1)) |
| 2404 | (if (eobp) |
| 2405 | (error "Hit end of buffer without finding a non-blank stmt")) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2406 | (let ((initial-pos (point)) |
| 2407 | (initial-indent (current-indentation)) |
| 2408 | last-pos ; position of last stmt in region |
| 2409 | (followers |
| 2410 | '((if elif else) (elif elif else) (else) |
| 2411 | (try except finally) (except except) (finally) |
| 2412 | (for else) (while else) |
| 2413 | (def) (class) ) ) |
| 2414 | first-symbol next-symbol) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2415 | |
| 2416 | (cond |
| 2417 | ;; if comment line, suck up the following comment lines |
| 2418 | ((looking-at "[ \t]*#") |
| 2419 | (re-search-forward "^[ \t]*[^ \t#]" nil 'move) ; look for non-comment |
| 2420 | (re-search-backward "^[ \t]*#") ; and back to last comment in block |
| 2421 | (setq last-pos (point))) |
| 2422 | |
| 2423 | ;; else if line is a block line and EXTEND given, suck up |
| 2424 | ;; the whole structure |
| 2425 | ((and extend |
| 2426 | (setq first-symbol (py-suck-up-first-keyword) ) |
| 2427 | (assq first-symbol followers)) |
| 2428 | (while (and |
| 2429 | (or (py-goto-beyond-block) t) ; side effect |
| 2430 | (forward-line -1) ; side effect |
| 2431 | (setq last-pos (point)) ; side effect |
| 2432 | (py-goto-statement-below) |
| 2433 | (= (current-indentation) initial-indent) |
| 2434 | (setq next-symbol (py-suck-up-first-keyword)) |
| 2435 | (memq next-symbol (cdr (assq first-symbol followers)))) |
| 2436 | (setq first-symbol next-symbol))) |
| 2437 | |
| 2438 | ;; else if line *opens* a block, search for next stmt indented <= |
| 2439 | ((py-statement-opens-block-p) |
| 2440 | (while (and |
| 2441 | (setq last-pos (point)) ; always true -- side effect |
| 2442 | (py-goto-statement-below) |
| 2443 | (> (current-indentation) initial-indent)) |
| 2444 | nil)) |
| 2445 | |
| 2446 | ;; else plain code line; stop at next blank line, or stmt or |
| 2447 | ;; indenting comment line indented < |
| 2448 | (t |
| 2449 | (while (and |
| 2450 | (setq last-pos (point)) ; always true -- side effect |
| 2451 | (or (py-goto-beyond-final-line) t) |
| 2452 | (not (looking-at "[ \t]*$")) ; stop at blank line |
| 2453 | (or |
| 2454 | (>= (current-indentation) initial-indent) |
| 2455 | (looking-at "[ \t]*#[^ \t\n]"))) ; ignore non-indenting # |
| 2456 | nil))) |
| 2457 | |
| 2458 | ;; skip to end of last stmt |
| 2459 | (goto-char last-pos) |
| 2460 | (py-goto-beyond-final-line) |
| 2461 | |
| 2462 | ;; set mark & display |
| 2463 | (if just-move |
| 2464 | () ; just return |
| 2465 | (push-mark (point) 'no-msg) |
| 2466 | (forward-line -1) |
| 2467 | (message "Mark set after: %s" (py-suck-up-leading-text)) |
| 2468 | (goto-char initial-pos)))) |
| 2469 | |
Barry Warsaw | 2518c67 | 1997-11-05 00:51:08 +0000 | [diff] [blame] | 2470 | (defun py-mark-def-or-class (&optional class) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2471 | "Set region to body of def (or class, with prefix arg) enclosing point. |
| 2472 | Pushes the current mark, then point, on the mark ring (all language |
| 2473 | modes do this, but although it's handy it's never documented ...). |
| 2474 | |
| 2475 | In most Emacs language modes, this function bears at least a |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2476 | hallucinogenic resemblance to `\\[py-end-of-def-or-class]' and |
| 2477 | `\\[py-beginning-of-def-or-class]'. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2478 | |
| 2479 | And in earlier versions of Python mode, all 3 were tightly connected. |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2480 | Turned out that was more confusing than useful: the `goto start' and |
| 2481 | `goto end' commands are usually used to search through a file, and |
| 2482 | people expect them to act a lot like `search backward' and `search |
| 2483 | forward' string-search commands. But because Python `def' and `class' |
| 2484 | can nest to arbitrary levels, finding the smallest def containing |
| 2485 | point cannot be done via a simple backward search: the def containing |
| 2486 | point may not be the closest preceding def, or even the closest |
| 2487 | preceding def that's indented less. The fancy algorithm required is |
| 2488 | appropriate for the usual uses of this `mark' command, but not for the |
| 2489 | `goto' variations. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2490 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2491 | So the def marked by this command may not be the one either of the |
| 2492 | `goto' commands find: If point is on a blank or non-indenting comment |
| 2493 | line, moves back to start of the closest preceding code statement or |
| 2494 | indenting comment line. If this is a `def' statement, that's the def |
| 2495 | we use. Else searches for the smallest enclosing `def' block and uses |
| 2496 | that. Else signals an error. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2497 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2498 | When an enclosing def is found: The mark is left immediately beyond |
| 2499 | the last line of the def block. Point is left at the start of the |
| 2500 | def, except that: if the def is preceded by a number of comment lines |
| 2501 | followed by (at most) one optional blank line, point is left at the |
| 2502 | start of the comments; else if the def is preceded by a blank line, |
| 2503 | point is left at its start. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2504 | |
| 2505 | The intent is to mark the containing def/class and its associated |
| 2506 | documentation, to make moving and duplicating functions and classes |
| 2507 | pleasant." |
| 2508 | (interactive "P") ; raw prefix arg |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2509 | (let ((start (point)) |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 2510 | (which (cond ((eq class 'either) "\\(class\\|def\\)") |
| 2511 | (class "class") |
| 2512 | (t "def")))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2513 | (push-mark start) |
| 2514 | (if (not (py-go-up-tree-to-keyword which)) |
| 2515 | (progn (goto-char start) |
Barry Warsaw | 7c29b23 | 1998-07-07 17:45:38 +0000 | [diff] [blame] | 2516 | (error "Enclosing %s not found" |
| 2517 | (if (eq class 'either) |
| 2518 | "def or class" |
| 2519 | which))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2520 | ;; else enclosing def/class found |
| 2521 | (setq start (point)) |
| 2522 | (py-goto-beyond-block) |
| 2523 | (push-mark (point)) |
| 2524 | (goto-char start) |
| 2525 | (if (zerop (forward-line -1)) ; if there is a preceding line |
| 2526 | (progn |
| 2527 | (if (looking-at "[ \t]*$") ; it's blank |
| 2528 | (setq start (point)) ; so reset start point |
| 2529 | (goto-char start)) ; else try again |
| 2530 | (if (zerop (forward-line -1)) |
| 2531 | (if (looking-at "[ \t]*#") ; a comment |
| 2532 | ;; look back for non-comment line |
| 2533 | ;; tricky: note that the regexp matches a blank |
| 2534 | ;; line, cuz \n is in the 2nd character class |
| 2535 | (and |
| 2536 | (re-search-backward "^[ \t]*[^ \t#]" nil 'move) |
| 2537 | (forward-line 1)) |
| 2538 | ;; no comment, so go back |
Barry Warsaw | 4da6bd5 | 1997-11-26 06:00:26 +0000 | [diff] [blame] | 2539 | (goto-char start))))))) |
| 2540 | (exchange-point-and-mark) |
| 2541 | (py-keep-region-active)) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2542 | |
Barry Warsaw | 9e5a9c8 | 1996-07-24 18:26:53 +0000 | [diff] [blame] | 2543 | ;; ripped from cc-mode |
| 2544 | (defun py-forward-into-nomenclature (&optional arg) |
| 2545 | "Move forward to end of a nomenclature section or word. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2546 | With \\[universal-argument] (programmatically, optional argument ARG), |
| 2547 | do it that many times. |
Barry Warsaw | 9e5a9c8 | 1996-07-24 18:26:53 +0000 | [diff] [blame] | 2548 | |
| 2549 | A `nomenclature' is a fancy way of saying AWordWithMixedCaseNotUnderscores." |
| 2550 | (interactive "p") |
| 2551 | (let ((case-fold-search nil)) |
| 2552 | (if (> arg 0) |
Barry Warsaw | c5a8cbd | 1996-08-05 21:53:02 +0000 | [diff] [blame] | 2553 | (re-search-forward |
| 2554 | "\\(\\W\\|[_]\\)*\\([A-Z]*[a-z0-9]*\\)" |
| 2555 | (point-max) t arg) |
Barry Warsaw | 9e5a9c8 | 1996-07-24 18:26:53 +0000 | [diff] [blame] | 2556 | (while (and (< arg 0) |
| 2557 | (re-search-backward |
Barry Warsaw | c5a8cbd | 1996-08-05 21:53:02 +0000 | [diff] [blame] | 2558 | "\\(\\W\\|[a-z0-9]\\)[A-Z]+\\|\\(\\W\\|[_]\\)\\w+" |
Barry Warsaw | 9e5a9c8 | 1996-07-24 18:26:53 +0000 | [diff] [blame] | 2559 | (point-min) 0)) |
| 2560 | (forward-char 1) |
| 2561 | (setq arg (1+ arg))))) |
| 2562 | (py-keep-region-active)) |
| 2563 | |
| 2564 | (defun py-backward-into-nomenclature (&optional arg) |
| 2565 | "Move backward to beginning of a nomenclature section or word. |
| 2566 | With optional ARG, move that many times. If ARG is negative, move |
| 2567 | forward. |
| 2568 | |
| 2569 | A `nomenclature' is a fancy way of saying AWordWithMixedCaseNotUnderscores." |
| 2570 | (interactive "p") |
| 2571 | (py-forward-into-nomenclature (- arg)) |
| 2572 | (py-keep-region-active)) |
| 2573 | |
| 2574 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2575 | |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 2576 | ;; pdbtrack functions |
| 2577 | (defun py-pdbtrack-toggle-stack-tracking (arg) |
| 2578 | (interactive "P") |
| 2579 | (if (not (get-buffer-process (current-buffer))) |
| 2580 | (error "No process associated with buffer '%s'" (current-buffer))) |
| 2581 | ;; missing or 0 is toggle, >0 turn on, <0 turn off |
| 2582 | (if (or (not arg) |
| 2583 | (zerop (setq arg (prefix-numeric-value arg)))) |
| 2584 | (setq py-pdbtrack-do-tracking-p (not py-pdbtrack-do-tracking-p)) |
| 2585 | (setq py-pdbtrack-do-tracking-p (> arg 0))) |
| 2586 | (message "%sabled Python's pdbtrack" |
| 2587 | (if py-pdbtrack-do-tracking-p "En" "Dis"))) |
| 2588 | |
| 2589 | (defun turn-on-pdbtrack () |
| 2590 | (interactive) |
| 2591 | (py-pdbtrack-toggle-stack-tracking 1)) |
| 2592 | |
| 2593 | (defun turn-off-pdbtrack () |
| 2594 | (interactive) |
| 2595 | (py-pdbtrack-toggle-stack-tracking 0)) |
| 2596 | |
| 2597 | |
| 2598 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2599 | ;; Documentation functions |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2600 | |
| 2601 | ;; dump the long form of the mode blurb; does the usual doc escapes, |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2602 | ;; plus lines of the form ^[vc]:name$ to suck variable & command docs |
| 2603 | ;; out of the right places, along with the keys they're on & current |
| 2604 | ;; values |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2605 | (defun py-dump-help-string (str) |
| 2606 | (with-output-to-temp-buffer "*Help*" |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2607 | (let ((locals (buffer-local-variables)) |
| 2608 | funckind funcname func funcdoc |
| 2609 | (start 0) mstart end |
| 2610 | keys ) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2611 | (while (string-match "^%\\([vc]\\):\\(.+\\)\n" str start) |
| 2612 | (setq mstart (match-beginning 0) end (match-end 0) |
| 2613 | funckind (substring str (match-beginning 1) (match-end 1)) |
| 2614 | funcname (substring str (match-beginning 2) (match-end 2)) |
| 2615 | func (intern funcname)) |
| 2616 | (princ (substitute-command-keys (substring str start mstart))) |
| 2617 | (cond |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2618 | ((equal funckind "c") ; command |
| 2619 | (setq funcdoc (documentation func) |
| 2620 | keys (concat |
| 2621 | "Key(s): " |
| 2622 | (mapconcat 'key-description |
| 2623 | (where-is-internal func py-mode-map) |
| 2624 | ", ")))) |
| 2625 | ((equal funckind "v") ; variable |
Barry Warsaw | 604cefa | 1996-09-03 18:17:04 +0000 | [diff] [blame] | 2626 | (setq funcdoc (documentation-property func 'variable-documentation) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2627 | keys (if (assq func locals) |
| 2628 | (concat |
| 2629 | "Local/Global values: " |
| 2630 | (prin1-to-string (symbol-value func)) |
| 2631 | " / " |
| 2632 | (prin1-to-string (default-value func))) |
| 2633 | (concat |
| 2634 | "Value: " |
| 2635 | (prin1-to-string (symbol-value func)))))) |
| 2636 | (t ; unexpected |
| 2637 | (error "Error in py-dump-help-string, tag `%s'" funckind))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2638 | (princ (format "\n-> %s:\t%s\t%s\n\n" |
| 2639 | (if (equal funckind "c") "Command" "Variable") |
| 2640 | funcname keys)) |
| 2641 | (princ funcdoc) |
| 2642 | (terpri) |
| 2643 | (setq start end)) |
| 2644 | (princ (substitute-command-keys (substring str start)))) |
| 2645 | (print-help-return-message))) |
| 2646 | |
| 2647 | (defun py-describe-mode () |
| 2648 | "Dump long form of Python-mode docs." |
| 2649 | (interactive) |
| 2650 | (py-dump-help-string "Major mode for editing Python files. |
| 2651 | Knows about Python indentation, tokens, comments and continuation lines. |
| 2652 | Paragraphs are separated by blank lines only. |
| 2653 | |
| 2654 | Major sections below begin with the string `@'; specific function and |
| 2655 | variable docs begin with `->'. |
| 2656 | |
| 2657 | @EXECUTING PYTHON CODE |
| 2658 | |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 2659 | \\[py-execute-import-or-reload]\timports or reloads the file in the Python interpreter |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2660 | \\[py-execute-buffer]\tsends the entire buffer to the Python interpreter |
| 2661 | \\[py-execute-region]\tsends the current region |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 2662 | \\[py-execute-def-or-class]\tsends the current function or class definition |
| 2663 | \\[py-execute-string]\tsends an arbitrary string |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2664 | \\[py-shell]\tstarts a Python interpreter window; this will be used by |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 2665 | \tsubsequent Python execution commands |
| 2666 | %c:py-execute-import-or-reload |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2667 | %c:py-execute-buffer |
| 2668 | %c:py-execute-region |
Barry Warsaw | 820273d | 1998-05-19 15:54:45 +0000 | [diff] [blame] | 2669 | %c:py-execute-def-or-class |
| 2670 | %c:py-execute-string |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2671 | %c:py-shell |
| 2672 | |
| 2673 | @VARIABLES |
| 2674 | |
| 2675 | py-indent-offset\tindentation increment |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 2676 | py-block-comment-prefix\tcomment string used by comment-region |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2677 | |
| 2678 | py-python-command\tshell command to invoke Python interpreter |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2679 | py-temp-directory\tdirectory used for temp files (if needed) |
| 2680 | |
| 2681 | py-beep-if-tab-change\tring the bell if tab-width is changed |
| 2682 | %v:py-indent-offset |
| 2683 | %v:py-block-comment-prefix |
| 2684 | %v:py-python-command |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2685 | %v:py-temp-directory |
| 2686 | %v:py-beep-if-tab-change |
| 2687 | |
| 2688 | @KINDS OF LINES |
| 2689 | |
| 2690 | Each physical line in the file is either a `continuation line' (the |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2691 | preceding line ends with a backslash that's not part of a comment, or |
| 2692 | the paren/bracket/brace nesting level at the start of the line is |
| 2693 | non-zero, or both) or an `initial line' (everything else). |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2694 | |
| 2695 | An initial line is in turn a `blank line' (contains nothing except |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2696 | possibly blanks or tabs), a `comment line' (leftmost non-blank |
| 2697 | character is `#'), or a `code line' (everything else). |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2698 | |
| 2699 | Comment Lines |
| 2700 | |
| 2701 | Although all comment lines are treated alike by Python, Python mode |
| 2702 | recognizes two kinds that act differently with respect to indentation. |
| 2703 | |
| 2704 | An `indenting comment line' is a comment line with a blank, tab or |
| 2705 | nothing after the initial `#'. The indentation commands (see below) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2706 | treat these exactly as if they were code lines: a line following an |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2707 | indenting comment line will be indented like the comment line. All |
| 2708 | other comment lines (those with a non-whitespace character immediately |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2709 | following the initial `#') are `non-indenting comment lines', and |
| 2710 | their indentation is ignored by the indentation commands. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2711 | |
| 2712 | Indenting comment lines are by far the usual case, and should be used |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2713 | whenever possible. Non-indenting comment lines are useful in cases |
| 2714 | like these: |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2715 | |
| 2716 | \ta = b # a very wordy single-line comment that ends up being |
| 2717 | \t #... continued onto another line |
| 2718 | |
| 2719 | \tif a == b: |
| 2720 | ##\t\tprint 'panic!' # old code we've `commented out' |
| 2721 | \t\treturn a |
| 2722 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2723 | Since the `#...' and `##' comment lines have a non-whitespace |
| 2724 | character following the initial `#', Python mode ignores them when |
| 2725 | computing the proper indentation for the next line. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2726 | |
| 2727 | Continuation Lines and Statements |
| 2728 | |
| 2729 | The Python-mode commands generally work on statements instead of on |
| 2730 | individual lines, where a `statement' is a comment or blank line, or a |
| 2731 | code line and all of its following continuation lines (if any) |
| 2732 | considered as a single logical unit. The commands in this mode |
| 2733 | generally (when it makes sense) automatically move to the start of the |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2734 | statement containing point, even if point happens to be in the middle |
| 2735 | of some continuation line. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2736 | |
| 2737 | |
| 2738 | @INDENTATION |
| 2739 | |
| 2740 | Primarily for entering new code: |
| 2741 | \t\\[indent-for-tab-command]\t indent line appropriately |
| 2742 | \t\\[py-newline-and-indent]\t insert newline, then indent |
Barry Warsaw | 27ee115 | 1997-12-03 05:03:44 +0000 | [diff] [blame] | 2743 | \t\\[py-electric-backspace]\t reduce indentation, or delete single character |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2744 | |
| 2745 | Primarily for reindenting existing code: |
| 2746 | \t\\[py-guess-indent-offset]\t guess py-indent-offset from file content; change locally |
| 2747 | \t\\[universal-argument] \\[py-guess-indent-offset]\t ditto, but change globally |
| 2748 | |
| 2749 | \t\\[py-indent-region]\t reindent region to match its context |
| 2750 | \t\\[py-shift-region-left]\t shift region left by py-indent-offset |
| 2751 | \t\\[py-shift-region-right]\t shift region right by py-indent-offset |
| 2752 | |
| 2753 | Unlike most programming languages, Python uses indentation, and only |
| 2754 | indentation, to specify block structure. Hence the indentation supplied |
| 2755 | automatically by Python-mode is just an educated guess: only you know |
| 2756 | the block structure you intend, so only you can supply correct |
| 2757 | indentation. |
| 2758 | |
| 2759 | The \\[indent-for-tab-command] and \\[py-newline-and-indent] keys try to suggest plausible indentation, based on |
| 2760 | the indentation of preceding statements. E.g., assuming |
| 2761 | py-indent-offset is 4, after you enter |
| 2762 | \tif a > 0: \\[py-newline-and-indent] |
| 2763 | the cursor will be moved to the position of the `_' (_ is not a |
| 2764 | character in the file, it's just used here to indicate the location of |
| 2765 | the cursor): |
| 2766 | \tif a > 0: |
| 2767 | \t _ |
| 2768 | If you then enter `c = d' \\[py-newline-and-indent], the cursor will move |
| 2769 | to |
| 2770 | \tif a > 0: |
| 2771 | \t c = d |
| 2772 | \t _ |
| 2773 | Python-mode cannot know whether that's what you intended, or whether |
| 2774 | \tif a > 0: |
| 2775 | \t c = d |
| 2776 | \t_ |
| 2777 | was your intent. In general, Python-mode either reproduces the |
| 2778 | indentation of the (closest code or indenting-comment) preceding |
| 2779 | statement, or adds an extra py-indent-offset blanks if the preceding |
| 2780 | statement has `:' as its last significant (non-whitespace and non- |
| 2781 | comment) character. If the suggested indentation is too much, use |
Barry Warsaw | 27ee115 | 1997-12-03 05:03:44 +0000 | [diff] [blame] | 2782 | \\[py-electric-backspace] to reduce it. |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2783 | |
| 2784 | Continuation lines are given extra indentation. If you don't like the |
| 2785 | suggested indentation, change it to something you do like, and Python- |
| 2786 | mode will strive to indent later lines of the statement in the same way. |
| 2787 | |
| 2788 | If a line is a continuation line by virtue of being in an unclosed |
| 2789 | paren/bracket/brace structure (`list', for short), the suggested |
| 2790 | indentation depends on whether the current line contains the first item |
| 2791 | in the list. If it does, it's indented py-indent-offset columns beyond |
| 2792 | the indentation of the line containing the open bracket. If you don't |
| 2793 | like that, change it by hand. The remaining items in the list will mimic |
| 2794 | whatever indentation you give to the first item. |
| 2795 | |
| 2796 | If a line is a continuation line because the line preceding it ends with |
| 2797 | a backslash, the third and following lines of the statement inherit their |
| 2798 | indentation from the line preceding them. The indentation of the second |
| 2799 | line in the statement depends on the form of the first (base) line: if |
| 2800 | the base line is an assignment statement with anything more interesting |
| 2801 | than the backslash following the leftmost assigning `=', the second line |
| 2802 | is indented two columns beyond that `='. Else it's indented to two |
| 2803 | columns beyond the leftmost solid chunk of non-whitespace characters on |
| 2804 | the base line. |
| 2805 | |
| 2806 | Warning: indent-region should not normally be used! It calls \\[indent-for-tab-command] |
| 2807 | repeatedly, and as explained above, \\[indent-for-tab-command] can't guess the block |
| 2808 | structure you intend. |
| 2809 | %c:indent-for-tab-command |
| 2810 | %c:py-newline-and-indent |
Barry Warsaw | 27ee115 | 1997-12-03 05:03:44 +0000 | [diff] [blame] | 2811 | %c:py-electric-backspace |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2812 | |
| 2813 | |
| 2814 | The next function may be handy when editing code you didn't write: |
| 2815 | %c:py-guess-indent-offset |
| 2816 | |
| 2817 | |
| 2818 | The remaining `indent' functions apply to a region of Python code. They |
| 2819 | assume the block structure (equals indentation, in Python) of the region |
| 2820 | is correct, and alter the indentation in various ways while preserving |
| 2821 | the block structure: |
| 2822 | %c:py-indent-region |
| 2823 | %c:py-shift-region-left |
| 2824 | %c:py-shift-region-right |
| 2825 | |
| 2826 | @MARKING & MANIPULATING REGIONS OF CODE |
| 2827 | |
| 2828 | \\[py-mark-block]\t mark block of lines |
Barry Warsaw | 2518c67 | 1997-11-05 00:51:08 +0000 | [diff] [blame] | 2829 | \\[py-mark-def-or-class]\t mark smallest enclosing def |
| 2830 | \\[universal-argument] \\[py-mark-def-or-class]\t mark smallest enclosing class |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 2831 | \\[comment-region]\t comment out region of code |
| 2832 | \\[universal-argument] \\[comment-region]\t uncomment region of code |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2833 | %c:py-mark-block |
Barry Warsaw | 2518c67 | 1997-11-05 00:51:08 +0000 | [diff] [blame] | 2834 | %c:py-mark-def-or-class |
Barry Warsaw | 42f707f | 1996-07-29 21:05:05 +0000 | [diff] [blame] | 2835 | %c:comment-region |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2836 | |
| 2837 | @MOVING POINT |
| 2838 | |
| 2839 | \\[py-previous-statement]\t move to statement preceding point |
| 2840 | \\[py-next-statement]\t move to statement following point |
| 2841 | \\[py-goto-block-up]\t move up to start of current block |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2842 | \\[py-beginning-of-def-or-class]\t move to start of def |
| 2843 | \\[universal-argument] \\[py-beginning-of-def-or-class]\t move to start of class |
| 2844 | \\[py-end-of-def-or-class]\t move to end of def |
| 2845 | \\[universal-argument] \\[py-end-of-def-or-class]\t move to end of class |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2846 | |
| 2847 | The first two move to one statement beyond the statement that contains |
| 2848 | point. A numeric prefix argument tells them to move that many |
| 2849 | statements instead. Blank lines, comment lines, and continuation lines |
| 2850 | do not count as `statements' for these commands. So, e.g., you can go |
| 2851 | to the first code statement in a file by entering |
| 2852 | \t\\[beginning-of-buffer]\t to move to the top of the file |
| 2853 | \t\\[py-next-statement]\t to skip over initial comments and blank lines |
| 2854 | Or do `\\[py-previous-statement]' with a huge prefix argument. |
| 2855 | %c:py-previous-statement |
| 2856 | %c:py-next-statement |
| 2857 | %c:py-goto-block-up |
Barry Warsaw | ab0e86c | 1998-05-19 15:31:46 +0000 | [diff] [blame] | 2858 | %c:py-beginning-of-def-or-class |
| 2859 | %c:py-end-of-def-or-class |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2860 | |
| 2861 | @LITTLE-KNOWN EMACS COMMANDS PARTICULARLY USEFUL IN PYTHON MODE |
| 2862 | |
| 2863 | `\\[indent-new-comment-line]' is handy for entering a multi-line comment. |
| 2864 | |
| 2865 | `\\[set-selective-display]' with a `small' prefix arg is ideally suited for viewing the |
| 2866 | overall class and def structure of a module. |
| 2867 | |
| 2868 | `\\[back-to-indentation]' moves point to a line's first non-blank character. |
| 2869 | |
| 2870 | `\\[indent-relative]' is handy for creating odd indentation. |
| 2871 | |
| 2872 | @OTHER EMACS HINTS |
| 2873 | |
| 2874 | If you don't like the default value of a variable, change its value to |
| 2875 | whatever you do like by putting a `setq' line in your .emacs file. |
| 2876 | E.g., to set the indentation increment to 4, put this line in your |
| 2877 | .emacs: |
| 2878 | \t(setq py-indent-offset 4) |
| 2879 | To see the value of a variable, do `\\[describe-variable]' and enter the variable |
| 2880 | name at the prompt. |
| 2881 | |
| 2882 | When entering a key sequence like `C-c C-n', it is not necessary to |
| 2883 | release the CONTROL key after doing the `C-c' part -- it suffices to |
| 2884 | press the CONTROL key, press and release `c' (while still holding down |
| 2885 | CONTROL), press and release `n' (while still holding down CONTROL), & |
| 2886 | then release CONTROL. |
| 2887 | |
| 2888 | Entering Python mode calls with no arguments the value of the variable |
| 2889 | `python-mode-hook', if that value exists and is not nil; for backward |
| 2890 | compatibility it also tries `py-mode-hook'; see the `Hooks' section of |
| 2891 | the Elisp manual for details. |
| 2892 | |
| 2893 | Obscure: When python-mode is first loaded, it looks for all bindings |
| 2894 | to newline-and-indent in the global keymap, and shadows them with |
| 2895 | local bindings to py-newline-and-indent.")) |
| 2896 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2897 | |
| 2898 | ;; Helper functions |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2899 | (defvar py-parse-state-re |
| 2900 | (concat |
| 2901 | "^[ \t]*\\(if\\|elif\\|else\\|while\\|def\\|class\\)\\>" |
| 2902 | "\\|" |
| 2903 | "^[^ #\t\n]")) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2904 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2905 | (defun py-parse-state () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2906 | "Return the parse state at point (see `parse-partial-sexp' docs)." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2907 | (save-excursion |
Barry Warsaw | 43ecf8e | 1996-04-06 00:00:19 +0000 | [diff] [blame] | 2908 | (let ((here (point)) |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 2909 | pps done) |
Barry Warsaw | 43ecf8e | 1996-04-06 00:00:19 +0000 | [diff] [blame] | 2910 | (while (not done) |
| 2911 | ;; back up to the first preceding line (if any; else start of |
| 2912 | ;; buffer) that begins with a popular Python keyword, or a |
| 2913 | ;; non- whitespace and non-comment character. These are good |
| 2914 | ;; places to start parsing to see whether where we started is |
| 2915 | ;; at a non-zero nesting level. It may be slow for people who |
| 2916 | ;; write huge code blocks or huge lists ... tough beans. |
| 2917 | (re-search-backward py-parse-state-re nil 'move) |
| 2918 | (beginning-of-line) |
Barry Warsaw | f64b405 | 1998-02-12 16:52:14 +0000 | [diff] [blame] | 2919 | ;; In XEmacs, we have a much better way to test for whether |
| 2920 | ;; we're in a triple-quoted string or not. Emacs does not |
Barry Warsaw | 145ab1c | 1998-05-19 14:49:49 +0000 | [diff] [blame] | 2921 | ;; have this built-in function, which is its loss because |
Barry Warsaw | f64b405 | 1998-02-12 16:52:14 +0000 | [diff] [blame] | 2922 | ;; without scanning from the beginning of the buffer, there's |
| 2923 | ;; no accurate way to determine this otherwise. |
Barry Warsaw | b2d5e62 | 2002-04-22 15:29:27 +0000 | [diff] [blame^] | 2924 | (save-excursion (setq pps (parse-partial-sexp (point) here))) |
| 2925 | ;; make sure we don't land inside a triple-quoted string |
| 2926 | (setq done (or (not (nth 3 pps)) |
| 2927 | (bobp))) |
| 2928 | ;; Just go ahead and short circuit the test back to the |
| 2929 | ;; beginning of the buffer. This will be slow, but not |
| 2930 | ;; nearly as slow as looping through many |
| 2931 | ;; re-search-backwards. |
| 2932 | (if (not done) |
| 2933 | (goto-char (point-min)))) |
Barry Warsaw | 43ecf8e | 1996-04-06 00:00:19 +0000 | [diff] [blame] | 2934 | pps))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2935 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2936 | (defun py-nesting-level () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2937 | "Return the buffer position of the last unclosed enclosing list. |
| 2938 | If nesting level is zero, return nil." |
Barry Warsaw | f64b405 | 1998-02-12 16:52:14 +0000 | [diff] [blame] | 2939 | (let ((status (py-parse-state))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2940 | (if (zerop (car status)) |
| 2941 | nil ; not in a nest |
| 2942 | (car (cdr status))))) ; char# of open bracket |
| 2943 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2944 | (defun py-backslash-continuation-line-p () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2945 | "Return t iff preceding line ends with backslash that is not in a comment." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2946 | (save-excursion |
| 2947 | (beginning-of-line) |
| 2948 | (and |
| 2949 | ;; use a cheap test first to avoid the regexp if possible |
| 2950 | ;; use 'eq' because char-after may return nil |
| 2951 | (eq (char-after (- (point) 2)) ?\\ ) |
| 2952 | ;; make sure; since eq test passed, there is a preceding line |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2953 | (forward-line -1) ; always true -- side effect |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2954 | (looking-at py-continued-re)))) |
| 2955 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2956 | (defun py-continuation-line-p () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2957 | "Return t iff current line is a continuation line." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2958 | (save-excursion |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 2959 | (beginning-of-line) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2960 | (or (py-backslash-continuation-line-p) |
| 2961 | (py-nesting-level)))) |
| 2962 | |
Barry Warsaw | 9c1696c | 1998-12-15 04:36:22 +0000 | [diff] [blame] | 2963 | (defun py-goto-beginning-of-tqs (delim) |
| 2964 | "Go to the beginning of the triple quoted string we find ourselves in. |
| 2965 | DELIM is the TQS string delimiter character we're searching backwards |
| 2966 | for." |
Barry Warsaw | 3c34bb3 | 2000-10-27 05:00:25 +0000 | [diff] [blame] | 2967 | (let ((skip (and delim (make-string 1 delim))) |
| 2968 | (continue t)) |
Barry Warsaw | 9c1696c | 1998-12-15 04:36:22 +0000 | [diff] [blame] | 2969 | (when skip |
| 2970 | (save-excursion |
Barry Warsaw | 3c34bb3 | 2000-10-27 05:00:25 +0000 | [diff] [blame] | 2971 | (while continue |
| 2972 | (py-safe (search-backward skip)) |
| 2973 | (setq continue (and (not (bobp)) |
| 2974 | (= (char-before) ?\\)))) |
| 2975 | (if (and (= (char-before) delim) |
| 2976 | (= (char-before (1- (point))) delim)) |
Barry Warsaw | 9c1696c | 1998-12-15 04:36:22 +0000 | [diff] [blame] | 2977 | (setq skip (make-string 3 delim)))) |
| 2978 | ;; we're looking at a triple-quoted string |
| 2979 | (py-safe (search-backward skip))))) |
| 2980 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2981 | (defun py-goto-initial-line () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 2982 | "Go to the initial line of the current statement. |
| 2983 | Usually this is the line we're on, but if we're on the 2nd or |
| 2984 | following lines of a continuation block, we need to go up to the first |
| 2985 | line of the block." |
| 2986 | ;; Tricky: We want to avoid quadratic-time behavior for long |
| 2987 | ;; continued blocks, whether of the backslash or open-bracket |
| 2988 | ;; varieties, or a mix of the two. The following manages to do that |
| 2989 | ;; in the usual cases. |
| 2990 | ;; |
| 2991 | ;; Also, if we're sitting inside a triple quoted string, this will |
| 2992 | ;; drop us at the line that begins the string. |
Barry Warsaw | 9ec9fbc | 1998-01-21 05:15:57 +0000 | [diff] [blame] | 2993 | (let (open-bracket-pos) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 2994 | (while (py-continuation-line-p) |
| 2995 | (beginning-of-line) |
| 2996 | (if (py-backslash-continuation-line-p) |
| 2997 | (while (py-backslash-continuation-line-p) |
| 2998 | (forward-line -1)) |
| 2999 | ;; else zip out of nested brackets/braces/parens |
| 3000 | (while (setq open-bracket-pos (py-nesting-level)) |
| 3001 | (goto-char open-bracket-pos))))) |
| 3002 | (beginning-of-line)) |
| 3003 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3004 | (defun py-goto-beyond-final-line () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3005 | "Go to the point just beyond the fine line of the current statement. |
| 3006 | Usually this is the start of the next line, but if this is a |
| 3007 | multi-line statement we need to skip over the continuation lines." |
| 3008 | ;; Tricky: Again we need to be clever to avoid quadratic time |
| 3009 | ;; behavior. |
| 3010 | ;; |
| 3011 | ;; XXX: Not quite the right solution, but deals with multi-line doc |
| 3012 | ;; strings |
Barry Warsaw | 751f493 | 1998-05-19 16:06:21 +0000 | [diff] [blame] | 3013 | (if (looking-at (concat "[ \t]*\\(" py-stringlit-re "\\)")) |
| 3014 | (goto-char (match-end 0))) |
| 3015 | ;; |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3016 | (forward-line 1) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3017 | (let (state) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3018 | (while (and (py-continuation-line-p) |
| 3019 | (not (eobp))) |
| 3020 | ;; skip over the backslash flavor |
| 3021 | (while (and (py-backslash-continuation-line-p) |
| 3022 | (not (eobp))) |
| 3023 | (forward-line 1)) |
| 3024 | ;; if in nest, zip to the end of the nest |
| 3025 | (setq state (py-parse-state)) |
| 3026 | (if (and (not (zerop (car state))) |
| 3027 | (not (eobp))) |
| 3028 | (progn |
Barry Warsaw | affc0ca | 1997-11-03 16:59:38 +0000 | [diff] [blame] | 3029 | (parse-partial-sexp (point) (point-max) 0 nil state) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3030 | (forward-line 1)))))) |
| 3031 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3032 | (defun py-statement-opens-block-p () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3033 | "Return t iff the current statement opens a block. |
| 3034 | I.e., iff it ends with a colon that is not in a comment. Point should |
| 3035 | be at the start of a statement." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3036 | (save-excursion |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3037 | (let ((start (point)) |
| 3038 | (finish (progn (py-goto-beyond-final-line) (1- (point)))) |
| 3039 | (searching t) |
| 3040 | (answer nil) |
| 3041 | state) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3042 | (goto-char start) |
| 3043 | (while searching |
| 3044 | ;; look for a colon with nothing after it except whitespace, and |
| 3045 | ;; maybe a comment |
| 3046 | (if (re-search-forward ":\\([ \t]\\|\\\\\n\\)*\\(#.*\\)?$" |
| 3047 | finish t) |
| 3048 | (if (eq (point) finish) ; note: no `else' clause; just |
| 3049 | ; keep searching if we're not at |
| 3050 | ; the end yet |
| 3051 | ;; sure looks like it opens a block -- but it might |
| 3052 | ;; be in a comment |
| 3053 | (progn |
| 3054 | (setq searching nil) ; search is done either way |
| 3055 | (setq state (parse-partial-sexp start |
| 3056 | (match-beginning 0))) |
| 3057 | (setq answer (not (nth 4 state))))) |
| 3058 | ;; search failed: couldn't find another interesting colon |
| 3059 | (setq searching nil))) |
| 3060 | answer))) |
| 3061 | |
Barry Warsaw | f831d81 | 1996-07-31 20:42:59 +0000 | [diff] [blame] | 3062 | (defun py-statement-closes-block-p () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3063 | "Return t iff the current statement closes a block. |
| 3064 | I.e., if the line starts with `return', `raise', `break', `continue', |
| 3065 | and `pass'. This doesn't catch embedded statements." |
Barry Warsaw | f831d81 | 1996-07-31 20:42:59 +0000 | [diff] [blame] | 3066 | (let ((here (point))) |
Barry Warsaw | a8f99ba | 1999-05-24 18:37:57 +0000 | [diff] [blame] | 3067 | (py-goto-initial-line) |
Barry Warsaw | c0d2d51 | 1999-06-03 22:18:59 +0000 | [diff] [blame] | 3068 | (back-to-indentation) |
Barry Warsaw | f831d81 | 1996-07-31 20:42:59 +0000 | [diff] [blame] | 3069 | (prog1 |
Barry Warsaw | affc0ca | 1997-11-03 16:59:38 +0000 | [diff] [blame] | 3070 | (looking-at (concat py-block-closing-keywords-re "\\>")) |
Barry Warsaw | f831d81 | 1996-07-31 20:42:59 +0000 | [diff] [blame] | 3071 | (goto-char here)))) |
| 3072 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3073 | (defun py-goto-beyond-block () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3074 | "Go to point just beyond the final line of block begun by the current line. |
| 3075 | This is the same as where `py-goto-beyond-final-line' goes unless |
| 3076 | we're on colon line, in which case we go to the end of the block. |
| 3077 | Assumes point is at the beginning of the line." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3078 | (if (py-statement-opens-block-p) |
| 3079 | (py-mark-block nil 'just-move) |
| 3080 | (py-goto-beyond-final-line))) |
| 3081 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3082 | (defun py-goto-statement-at-or-above () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3083 | "Go to the start of the first statement at or preceding point. |
| 3084 | Return t if there is such a statement, otherwise nil. `Statement' |
| 3085 | does not include blank lines, comments, or continuation lines." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3086 | (py-goto-initial-line) |
| 3087 | (if (looking-at py-blank-or-comment-re) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3088 | ;; skip back over blank & comment lines |
| 3089 | ;; note: will skip a blank or comment line that happens to be |
| 3090 | ;; a continuation line too |
| 3091 | (if (re-search-backward "^[ \t]*[^ \t#\n]" nil t) |
| 3092 | (progn (py-goto-initial-line) t) |
| 3093 | nil) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3094 | t)) |
| 3095 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3096 | (defun py-goto-statement-below () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3097 | "Go to start of the first statement following the statement containing point. |
| 3098 | Return t if there is such a statement, otherwise nil. `Statement' |
| 3099 | does not include blank lines, comments, or continuation lines." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3100 | (beginning-of-line) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3101 | (let ((start (point))) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3102 | (py-goto-beyond-final-line) |
| 3103 | (while (and |
| 3104 | (looking-at py-blank-or-comment-re) |
| 3105 | (not (eobp))) |
| 3106 | (forward-line 1)) |
| 3107 | (if (eobp) |
| 3108 | (progn (goto-char start) nil) |
| 3109 | t))) |
| 3110 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3111 | (defun py-go-up-tree-to-keyword (key) |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3112 | "Go to begining of statement starting with KEY, at or preceding point. |
| 3113 | |
| 3114 | KEY is a regular expression describing a Python keyword. Skip blank |
| 3115 | lines and non-indenting comments. If the statement found starts with |
| 3116 | KEY, then stop, otherwise go back to first enclosing block starting |
| 3117 | with KEY. If successful, leave point at the start of the KEY line and |
| 3118 | return t. Otherwise, leav point at an undefined place and return nil." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3119 | ;; skip blanks and non-indenting # |
| 3120 | (py-goto-initial-line) |
| 3121 | (while (and |
| 3122 | (looking-at "[ \t]*\\($\\|#[^ \t\n]\\)") |
| 3123 | (zerop (forward-line -1))) ; go back |
| 3124 | nil) |
| 3125 | (py-goto-initial-line) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3126 | (let* ((re (concat "[ \t]*" key "\\b")) |
| 3127 | (case-fold-search nil) ; let* so looking-at sees this |
| 3128 | (found (looking-at re)) |
| 3129 | (dead nil)) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3130 | (while (not (or found dead)) |
| 3131 | (condition-case nil ; in case no enclosing block |
| 3132 | (py-goto-block-up 'no-mark) |
| 3133 | (error (setq dead t))) |
| 3134 | (or dead (setq found (looking-at re)))) |
| 3135 | (beginning-of-line) |
| 3136 | found)) |
| 3137 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3138 | (defun py-suck-up-leading-text () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3139 | "Return string in buffer from start of indentation to end of line. |
| 3140 | Prefix with \"...\" if leading whitespace was skipped." |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3141 | (save-excursion |
| 3142 | (back-to-indentation) |
| 3143 | (concat |
| 3144 | (if (bolp) "" "...") |
| 3145 | (buffer-substring (point) (progn (end-of-line) (point)))))) |
| 3146 | |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3147 | (defun py-suck-up-first-keyword () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3148 | "Return first keyword on the line as a Lisp symbol. |
| 3149 | `Keyword' is defined (essentially) as the regular expression |
| 3150 | ([a-z]+). Returns nil if none was found." |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3151 | (let ((case-fold-search nil)) |
Barry Warsaw | 7ae7768 | 1994-12-12 20:38:05 +0000 | [diff] [blame] | 3152 | (if (looking-at "[ \t]*\\([a-z]+\\)\\b") |
| 3153 | (intern (buffer-substring (match-beginning 1) (match-end 1))) |
| 3154 | nil))) |
| 3155 | |
Barry Warsaw | b3e81d5 | 1996-09-04 15:12:42 +0000 | [diff] [blame] | 3156 | (defun py-current-defun () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3157 | "Python value for `add-log-current-defun-function'. |
| 3158 | This tells add-log.el how to find the current function/method/variable." |
Barry Warsaw | b3e81d5 | 1996-09-04 15:12:42 +0000 | [diff] [blame] | 3159 | (save-excursion |
| 3160 | (if (re-search-backward py-defun-start-re nil t) |
| 3161 | (or (match-string 3) |
| 3162 | (let ((method (match-string 2))) |
| 3163 | (if (and (not (zerop (length (match-string 1)))) |
| 3164 | (re-search-backward py-class-start-re nil t)) |
| 3165 | (concat (match-string 1) "." method) |
| 3166 | method))) |
| 3167 | nil))) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3168 | |
| 3169 | |
Barry Warsaw | fec75d6 | 1995-07-05 23:26:15 +0000 | [diff] [blame] | 3170 | (defconst py-help-address "python-mode@python.org" |
Barry Warsaw | 850437a | 1995-03-08 21:50:28 +0000 | [diff] [blame] | 3171 | "Address accepting submission of bug reports.") |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3172 | |
Barry Warsaw | 850437a | 1995-03-08 21:50:28 +0000 | [diff] [blame] | 3173 | (defun py-version () |
| 3174 | "Echo the current version of `python-mode' in the minibuffer." |
| 3175 | (interactive) |
| 3176 | (message "Using `python-mode' version %s" py-version) |
| 3177 | (py-keep-region-active)) |
| 3178 | |
| 3179 | ;; only works under Emacs 19 |
| 3180 | ;(eval-when-compile |
| 3181 | ; (require 'reporter)) |
| 3182 | |
| 3183 | (defun py-submit-bug-report (enhancement-p) |
| 3184 | "Submit via mail a bug report on `python-mode'. |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3185 | With \\[universal-argument] (programmatically, argument ENHANCEMENT-P |
| 3186 | non-nil) just submit an enhancement request." |
Barry Warsaw | 850437a | 1995-03-08 21:50:28 +0000 | [diff] [blame] | 3187 | (interactive |
| 3188 | (list (not (y-or-n-p |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3189 | "Is this a bug report (hit `n' to send other comments)? ")))) |
Barry Warsaw | b5e0ecb | 1995-03-14 18:32:54 +0000 | [diff] [blame] | 3190 | (let ((reporter-prompt-for-summary-p (if enhancement-p |
| 3191 | "(Very) brief summary: " |
| 3192 | t))) |
Barry Warsaw | 850437a | 1995-03-08 21:50:28 +0000 | [diff] [blame] | 3193 | (require 'reporter) |
| 3194 | (reporter-submit-bug-report |
| 3195 | py-help-address ;address |
Barry Warsaw | b5e0ecb | 1995-03-14 18:32:54 +0000 | [diff] [blame] | 3196 | (concat "python-mode " py-version) ;pkgname |
Barry Warsaw | 850437a | 1995-03-08 21:50:28 +0000 | [diff] [blame] | 3197 | ;; varlist |
| 3198 | (if enhancement-p nil |
| 3199 | '(py-python-command |
| 3200 | py-indent-offset |
| 3201 | py-block-comment-prefix |
Barry Warsaw | 850437a | 1995-03-08 21:50:28 +0000 | [diff] [blame] | 3202 | py-temp-directory |
| 3203 | py-beep-if-tab-change)) |
| 3204 | nil ;pre-hooks |
| 3205 | nil ;post-hooks |
| 3206 | "Dear Barry,") ;salutation |
| 3207 | (if enhancement-p nil |
| 3208 | (set-mark (point)) |
| 3209 | (insert |
| 3210 | "Please replace this text with a sufficiently large code sample\n\ |
| 3211 | and an exact recipe so that I can reproduce your problem. Failure\n\ |
| 3212 | to do so may mean a greater delay in fixing your bug.\n\n") |
| 3213 | (exchange-point-and-mark) |
| 3214 | (py-keep-region-active)))) |
| 3215 | |
| 3216 | |
Barry Warsaw | 4738478 | 1997-11-26 05:27:45 +0000 | [diff] [blame] | 3217 | (defun py-kill-emacs-hook () |
Barry Warsaw | 41a05c7 | 1998-08-10 16:33:12 +0000 | [diff] [blame] | 3218 | "Delete files in `py-file-queue'. |
| 3219 | These are Python temporary files awaiting execution." |
Barry Warsaw | 4738478 | 1997-11-26 05:27:45 +0000 | [diff] [blame] | 3220 | (mapcar #'(lambda (filename) |
| 3221 | (py-safe (delete-file filename))) |
| 3222 | py-file-queue)) |
| 3223 | |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3224 | ;; arrange to kill temp files when Emacs exists |
Barry Warsaw | c72c11c | 1997-08-09 06:42:08 +0000 | [diff] [blame] | 3225 | (add-hook 'kill-emacs-hook 'py-kill-emacs-hook) |
Barry Warsaw | 4f577d2 | 2001-04-11 20:23:17 +0000 | [diff] [blame] | 3226 | (add-hook 'comint-output-filter-functions 'py-pdbtrack-track-stack-file) |
| 3227 | |
| 3228 | ;; Add a designator to the minor mode strings |
| 3229 | (or (assq 'py-pdbtrack-minor-mode-string minor-mode-alist) |
| 3230 | (push '(py-pdbtrack-is-tracking-p py-pdbtrack-minor-mode-string) |
| 3231 | minor-mode-alist)) |
Barry Warsaw | 7b0f568 | 1995-03-08 21:33:04 +0000 | [diff] [blame] | 3232 | |
| 3233 | |
| 3234 | |
| 3235 | (provide 'python-mode) |
| 3236 | ;;; python-mode.el ends here |