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