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