Commit | Line | Data |
---|---|---|
6f480c7a SM |
1 | ;;; python.el --- silly walks for Python |
2 | ||
abe0aa3e | 3 | ;; Copyright (C) 2003, 2004 Free Software Foundation, Inc. |
6f480c7a SM |
4 | |
5 | ;; Author: Dave Love <fx@gnu.org> | |
c02484a0 | 6 | ;; Maintainer: FSF |
6f480c7a SM |
7 | ;; Created: Nov 2003 |
8 | ;; Keywords: languages | |
9 | ||
10 | ;; This file is part of GNU Emacs. | |
11 | ||
12 | ;; This file is free software; you can redistribute it and/or modify | |
13 | ;; it under the terms of the GNU General Public License as published by | |
14 | ;; the Free Software Foundation; either version 2, or (at your option) | |
15 | ;; any later version. | |
16 | ||
17 | ;; This file is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
23 | ;; along with GNU Emacs; see the file COPYING. If not, write to | |
24 | ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
25 | ;; Boston, MA 02111-1307, USA. | |
26 | ||
27 | ;;; Commentary: | |
28 | ||
29 | ;; Major mode for editing Python, with support for inferior processes. | |
30 | ||
31 | ;; There is another Python mode, python-mode.el, used by XEmacs and | |
32 | ;; maintained with Python. That isn't covered by an FSF copyright | |
33 | ;; assignment, unlike this code, and seems not to be well-maintained | |
34 | ;; for Emacs (though I've submitted fixes). This mode is rather | |
35 | ;; simpler and is, perhaps, better in other ways. In particular, | |
36 | ;; using the syntax functions with text properties maintained by | |
37 | ;; font-lock should make it more correct with arbitrary string and | |
38 | ;; comment contents. | |
39 | ||
40 | ;; This doesn't implement all the facilities of python-mode.el. Some | |
41 | ;; just need doing, e.g. catching exceptions in the inferior Python | |
0578dead | 42 | ;; buffer (but see M-x pdb for debugging). [Actually, the use of |
6f480c7a SM |
43 | ;; `compilation-minor-mode' now is probably enough for that.] Others |
44 | ;; don't seem appropriate. For instance, `forward-into-nomenclature' | |
45 | ;; should be done separately, since it's not specific to Python, and | |
46 | ;; I've installed a minor mode to do the job properly in Emacs 22. | |
47 | ;; Other things seem more natural or canonical here, e.g. the | |
48 | ;; {beginning,end}-of-defun implementation dealing with nested | |
24d5055c SM |
49 | ;; definitions, and the inferior mode following `cmuscheme'. The |
50 | ;; inferior mode can find the source of errors from | |
51 | ;; `python-send-region' & al via `compilation-minor-mode'. Successive | |
52 | ;; TABs cycle between possible indentations for the line. There is | |
53 | ;; symbol completion using lookup in Python. | |
6f480c7a SM |
54 | |
55 | ;; Even where it has similar facilities, this is incompatible with | |
56 | ;; python-mode.el in various respects. For instance, various key | |
57 | ;; bindings are changed to obey Emacs conventions, and things like | |
58 | ;; marking blocks and `beginning-of-defun' behave differently. | |
59 | ||
24d5055c | 60 | ;; TODO: See various Fixmes below. |
0578dead | 61 | |
6f480c7a SM |
62 | ;;; Code: |
63 | ||
6f480c7a SM |
64 | ;; It's messy to autoload the relevant comint functions so that comint |
65 | ;; is only required when inferior Python is used. | |
66 | (require 'comint) | |
0578dead SM |
67 | (eval-when-compile |
68 | (require 'compile) | |
0578dead | 69 | (autoload 'info-lookup-maybe-add-help "info-look")) |
b6ea7940 | 70 | (autoload 'compilation-start "compile") |
6f480c7a SM |
71 | |
72 | (defgroup python nil | |
73 | "Silly walks in the Python language" | |
74 | :group 'languages | |
bf247b6e | 75 | :version "22.1" |
6f480c7a SM |
76 | :link '(emacs-commentary-link "python")) |
77 | \f | |
78 | ;;;###autoload | |
79 | (add-to-list 'interpreter-mode-alist '("jython" . jython-mode)) | |
80 | ;;;###autoload | |
81 | (add-to-list 'interpreter-mode-alist '("python" . python-mode)) | |
82 | ;;;###autoload | |
83 | (add-to-list 'auto-mode-alist '("\\.py\\'" . python-mode)) | |
84 | \f | |
85 | ;;;; Font lock | |
86 | ||
87 | (defvar python-font-lock-keywords | |
88 | `(,(rx (and word-start | |
89 | ;; From v 2.3 reference. | |
90 | ;; def and class dealt with separately below | |
91 | (or "and" "assert" "break" "continue" "del" "elif" "else" | |
92 | "except" "exec" "finally" "for" "from" "global" "if" | |
93 | "import" "in" "is" "lambda" "not" "or" "pass" "print" | |
94 | "raise" "return" "try" "while" "yield" | |
95 | ;; Future keywords | |
96 | "as" "None") | |
97 | word-end)) | |
98 | (,(rx (and word-start (group "class") (1+ space) (group (1+ word)))) | |
99 | (1 font-lock-keyword-face) (2 font-lock-type-face)) | |
100 | (,(rx (and word-start (group "def") (1+ space) (group (1+ word)))) | |
101 | (1 font-lock-keyword-face) (2 font-lock-function-name-face)))) | |
102 | ||
103 | (defconst python-font-lock-syntactic-keywords | |
104 | ;; Make outer chars of matching triple-quote sequences into generic | |
105 | ;; string delimiters. Fixme: Is there a better way? | |
25f35ef6 | 106 | `((,(rx (and (or line-start buffer-start (not (syntax escape))) ; avoid escaped |
c2214147 RS |
107 | ; leading quote |
108 | (group (optional (any "uUrR"))) ; prefix gets syntax property | |
6f480c7a SM |
109 | (optional (any "rR")) ; possible second prefix |
110 | (group (syntax string-quote)) ; maybe gets property | |
111 | (backref 2) ; per first quote | |
112 | (group (backref 2)))) ; maybe gets property | |
0578dead SM |
113 | (1 (python-quote-syntax 1)) |
114 | (2 (python-quote-syntax 2)) | |
6f480c7a SM |
115 | (3 (python-quote-syntax 3))) |
116 | ;; This doesn't really help. | |
117 | ;;; (,(rx (and ?\\ (group ?\n))) (1 " ")) | |
118 | )) | |
119 | ||
120 | (defun python-quote-syntax (n) | |
121 | "Put `syntax-table' property correctly on triple quote. | |
122 | Used for syntactic keywords. N is the match number (1, 2 or 3)." | |
0578dead SM |
123 | ;; Given a triple quote, we have to check the context to know |
124 | ;; whether this is an opening or closing triple or whether it's | |
125 | ;; quoted anyhow, and should be ignored. (For that we need to do | |
126 | ;; the same job as `syntax-ppss' to be correct and it seems to be OK | |
127 | ;; to use it here despite initial worries.) We also have to sort | |
128 | ;; out a possible prefix -- well, we don't _have_ to, but I think it | |
129 | ;; should be treated as part of the string. | |
130 | ||
131 | ;; Test cases: | |
132 | ;; ur"""ar""" x='"' # """ | |
133 | ;; x = ''' """ ' a | |
134 | ;; ''' | |
c2214147 | 135 | ;; x '"""' x """ \"""" x |
0578dead SM |
136 | (save-excursion |
137 | (goto-char (match-beginning 0)) | |
c2214147 RS |
138 | (cond |
139 | ;; Consider property for the last char if in a fenced string. | |
140 | ((= n 3) | |
141 | (let ((syntax (syntax-ppss))) | |
142 | (when (eq t (nth 3 syntax)) ; after unclosed fence | |
143 | (goto-char (nth 8 syntax)) ; fence position | |
144 | ;; Skip any prefix. | |
145 | (if (memq (char-after) '(?u ?U ?R ?r)) | |
146 | (skip-chars-forward "uUrR")) | |
147 | ;; Is it a matching sequence? | |
148 | (if (eq (char-after) (char-after (match-beginning 2))) | |
149 | (eval-when-compile (string-to-syntax "|")))))) | |
150 | ;; Consider property for initial char, accounting for prefixes. | |
151 | ((or (and (= n 2) ; not prefix | |
152 | (= (match-beginning 1) (match-end 1))) ; prefix is null | |
153 | (and (= n 1) ; prefix | |
154 | (/= (match-beginning 1) (match-end 1)))) ; non-empty | |
155 | (unless (eq 'string (syntax-ppss-context (syntax-ppss))) | |
156 | (eval-when-compile (string-to-syntax "|")))) | |
157 | ;; Otherwise (we're in a non-matching string) the property is | |
158 | ;; nil, which is OK. | |
159 | ))) | |
6f480c7a SM |
160 | |
161 | ;; This isn't currently in `font-lock-defaults' as probably not worth | |
162 | ;; it -- we basically only mess with a few normally-symbol characters. | |
163 | ||
164 | ;; (defun python-font-lock-syntactic-face-function (state) | |
165 | ;; "`font-lock-syntactic-face-function' for Python mode. | |
166 | ;; Returns the string or comment face as usual, with side effect of putting | |
167 | ;; a `syntax-table' property on the inside of the string or comment which is | |
168 | ;; the standard syntax table." | |
169 | ;; (if (nth 3 state) | |
170 | ;; (save-excursion | |
171 | ;; (goto-char (nth 8 state)) | |
172 | ;; (condition-case nil | |
173 | ;; (forward-sexp) | |
174 | ;; (error nil)) | |
175 | ;; (put-text-property (1+ (nth 8 state)) (1- (point)) | |
176 | ;; 'syntax-table (standard-syntax-table)) | |
177 | ;; 'font-lock-string-face) | |
178 | ;; (put-text-property (1+ (nth 8 state)) (line-end-position) | |
179 | ;; 'syntax-table (standard-syntax-table)) | |
180 | ;; 'font-lock-comment-face)) | |
181 | \f | |
182 | ;;;; Keymap and syntax | |
183 | ||
184 | (defvar python-mode-map | |
185 | (let ((map (make-sparse-keymap))) | |
186 | ;; Mostly taken from python-mode.el. | |
187 | (define-key map ":" 'python-electric-colon) | |
188 | (define-key map "\177" 'python-backspace) | |
189 | (define-key map "\C-c<" 'python-shift-left) | |
190 | (define-key map "\C-c>" 'python-shift-right) | |
191 | (define-key map "\C-c\C-k" 'python-mark-block) | |
192 | (define-key map "\C-c\C-n" 'python-next-statement) | |
193 | (define-key map "\C-c\C-p" 'python-previous-statement) | |
194 | (define-key map "\C-c\C-u" 'python-beginning-of-block) | |
195 | (define-key map "\C-c\C-f" 'python-describe-symbol) | |
196 | (define-key map "\C-c\C-w" 'python-check) | |
197 | (define-key map "\C-c\C-v" 'python-check) ; a la sgml-mode | |
198 | (define-key map "\C-c\C-s" 'python-send-string) | |
199 | (define-key map [?\C-\M-x] 'python-send-defun) | |
200 | (define-key map "\C-c\C-r" 'python-send-region) | |
201 | (define-key map "\C-c\M-r" 'python-send-region-and-go) | |
202 | (define-key map "\C-c\C-c" 'python-send-buffer) | |
203 | (define-key map "\C-c\C-z" 'python-switch-to-python) | |
204 | (define-key map "\C-c\C-m" 'python-load-file) | |
205 | (define-key map "\C-c\C-l" 'python-load-file) ; a la cmuscheme | |
24d5055c SM |
206 | (substitute-key-definition 'complete-symbol 'python-complete-symbol |
207 | map global-map) | |
6f480c7a SM |
208 | ;; Fixme: Add :help to menu. |
209 | (easy-menu-define python-menu map "Python Mode menu" | |
210 | '("Python" | |
211 | ["Shift region left" python-shift-left :active mark-active] | |
212 | ["Shift region right" python-shift-right :active mark-active] | |
213 | "-" | |
214 | ["Mark block" python-mark-block] | |
215 | ["Mark def/class" mark-defun | |
216 | :help "Mark innermost definition around point"] | |
217 | "-" | |
218 | ["Start of block" python-beginning-of-block] | |
219 | ["End of block" python-end-of-block] | |
220 | ["Start of def/class" beginning-of-defun | |
221 | :help "Go to start of innermost definition around point"] | |
222 | ["End of def/class" end-of-defun | |
223 | :help "Go to end of innermost definition around point"] | |
224 | "-" | |
225 | ["Start interpreter" run-python | |
226 | :help "Run `inferior' Python in separate buffer"] | |
227 | ["Import/reload file" python-load-file | |
228 | :help "Load into inferior Python session"] | |
229 | ["Eval buffer" python-send-buffer | |
230 | :help "Evaluate buffer en bloc in inferior Python session"] | |
231 | ["Eval region" python-send-region :active mark-active | |
232 | :help "Evaluate region en bloc in inferior Python session"] | |
233 | ["Eval def/class" python-send-defun | |
234 | :help "Evaluate current definition in inferior Python session"] | |
235 | ["Switch to interpreter" python-switch-to-python | |
236 | :help "Switch to inferior Python buffer"] | |
237 | ["Check file" python-check :help "Run pychecker"] | |
238 | ["Debugger" pdb :help "Run pdb under GUD"] | |
239 | "-" | |
240 | ["Help on symbol" python-describe-symbol | |
241 | :help "Use pydoc on symbol at point"])) | |
242 | map)) | |
243 | ||
244 | (defvar python-mode-syntax-table | |
245 | (let ((table (make-syntax-table))) | |
246 | ;; Give punctuation syntax to ASCII that normally has symbol | |
247 | ;; syntax or has word syntax and isn't a letter. | |
248 | (let ((symbol (string-to-syntax "_")) | |
249 | (sst (standard-syntax-table))) | |
250 | (dotimes (i 128) | |
251 | (unless (= i ?_) | |
252 | (if (equal symbol (aref sst i)) | |
253 | (modify-syntax-entry i "." table))))) | |
254 | (modify-syntax-entry ?$ "." table) | |
255 | (modify-syntax-entry ?% "." table) | |
256 | ;; exceptions | |
257 | (modify-syntax-entry ?# "<" table) | |
258 | (modify-syntax-entry ?\n ">" table) | |
259 | (modify-syntax-entry ?' "\"" table) | |
260 | (modify-syntax-entry ?` "$" table) | |
261 | table)) | |
262 | \f | |
263 | ;;;; Utility stuff | |
264 | ||
265 | (defsubst python-in-string/comment () | |
24d5055c | 266 | "Return non-nil if point is in a Python literal (a comment or string)." |
6f480c7a SM |
267 | (syntax-ppss-context (syntax-ppss))) |
268 | ||
269 | (defconst python-space-backslash-table | |
270 | (let ((table (copy-syntax-table python-mode-syntax-table))) | |
271 | (modify-syntax-entry ?\\ " " table) | |
272 | table) | |
273 | "`python-mode-syntax-table' with backslash given whitespace syntax.") | |
274 | ||
275 | (defun python-skip-comments/blanks (&optional backward) | |
276 | "Skip comments and blank lines. | |
277 | BACKWARD non-nil means go backwards, otherwise go forwards. Backslash is | |
278 | treated as whitespace so that continued blank lines are skipped. | |
279 | Doesn't move out of comments -- should be outside or at end of line." | |
280 | (with-syntax-table python-space-backslash-table | |
281 | (forward-comment (if backward | |
282 | most-negative-fixnum | |
283 | most-positive-fixnum)))) | |
284 | ||
285 | (defun python-backslash-continuation-line-p () | |
286 | "Non-nil if preceding line ends with backslash that is not in a comment." | |
287 | (and (eq ?\\ (char-before (line-end-position 0))) | |
288 | (not (syntax-ppss-context (syntax-ppss))))) | |
289 | ||
290 | (defun python-continuation-line-p () | |
291 | "Return non-nil if current line continues a previous one. | |
292 | The criteria are that the previous line ends in a backslash outside | |
293 | comments and strings, or that the bracket/paren nesting depth is nonzero." | |
294 | (or (and (eq ?\\ (char-before (line-end-position 0))) | |
295 | (not (syntax-ppss-context (syntax-ppss)))) | |
296 | (/= 0 (syntax-ppss-depth | |
297 | (save-excursion ; syntax-ppss with arg changes point | |
298 | (syntax-ppss (line-beginning-position))))))) | |
299 | ||
300 | (defun python-comment-line-p () | |
07c7712f | 301 | "Return non-nil iff current line has only a comment." |
6f480c7a | 302 | (save-excursion |
24d5055c | 303 | (end-of-line) |
24d5055c SM |
304 | (when (eq 'comment (syntax-ppss-context (syntax-ppss))) |
305 | (back-to-indentation) | |
306 | (looking-at (rx (or (syntax comment-start) line-end)))))) | |
6f480c7a SM |
307 | |
308 | (defun python-beginning-of-string () | |
309 | "Go to beginning of string around point. | |
310 | Do nothing if not in string." | |
311 | (let ((state (syntax-ppss))) | |
24d5055c | 312 | (when (eq 'string (syntax-ppss-context state)) |
6f480c7a SM |
313 | (goto-char (nth 8 state))))) |
314 | ||
315 | (defun python-open-block-statement-p (&optional bos) | |
316 | "Return non-nil if statement at point opens a block. | |
317 | BOS non-nil means point is known to be at beginning of statement." | |
318 | (save-excursion | |
319 | (unless bos (python-beginning-of-statement)) | |
320 | (and (not (python-comment-line-p)) | |
321 | (re-search-forward (rx (and ?: (0+ space) | |
322 | (optional (and (syntax comment-start) | |
323 | (0+ not-newline))) | |
324 | line-end)) | |
325 | (save-excursion (python-end-of-statement)) | |
326 | t) | |
cebe0988 EZ |
327 | (not (progn (goto-char (match-beginning 0)) |
328 | (python-in-string/comment)))))) | |
6f480c7a SM |
329 | |
330 | (defun python-close-block-statement-p (&optional bos) | |
331 | "Return non-nil if current line is a statement closing a block. | |
332 | BOS non-nil means point is at beginning of statement. | |
333 | The criteria are that the line isn't a comment or in string and starts with | |
334 | keyword `raise', `break', `continue' or `pass'." | |
335 | (save-excursion | |
336 | (unless bos (python-beginning-of-statement)) | |
337 | (back-to-indentation) | |
338 | (looking-at (rx (and (or "return" "raise" "break" "continue" "pass") | |
339 | word-end))))) | |
340 | ||
341 | (defun python-outdent-p () | |
342 | "Return non-nil if current line should outdent a level." | |
343 | (save-excursion | |
344 | (back-to-indentation) | |
345 | (and (looking-at (rx (and (or (and (or "else" "finally") word-end) | |
346 | (and (or "except" "elif") word-end | |
347 | (1+ (not (any ?:))))) | |
348 | (optional space) ":" (optional space) | |
349 | (or (syntax comment-start) line-end)))) | |
350 | (progn (end-of-line) | |
351 | (not (python-in-string/comment))) | |
352 | ;; Ensure there's a previous statement and move to it. | |
353 | (zerop (python-previous-statement)) | |
354 | (not (python-close-block-statement-p t)) | |
355 | ;; Fixme: check this | |
356 | (not (looking-at (rx (and (or (and (or "if" "elif" "except" | |
357 | "for" "while") | |
358 | word-end (1+ (not (any ?:)))) | |
359 | (and "try" word-end)) | |
360 | (optional space) ":" (optional space) | |
361 | (or (syntax comment-start) line-end))))) | |
362 | (progn (end-of-line) | |
363 | (not (python-in-string/comment)))))) | |
364 | \f | |
365 | ;;;; Indentation. | |
366 | ||
367 | (defcustom python-indent 4 | |
368 | "*Number of columns for a unit of indentation in Python mode. | |
369 | See also `\\[python-guess-indent]'" | |
370 | :group 'python | |
371 | :type 'integer) | |
372 | ||
373 | (defcustom python-guess-indent t | |
374 | "*Non-nil means Python mode guesses `python-indent' for the buffer." | |
375 | :type 'boolean | |
376 | :group 'python) | |
377 | ||
378 | (defcustom python-indent-string-contents t | |
379 | "*Non-nil means indent contents of multi-line strings together. | |
380 | This means indent them the same as the preceding non-blank line. | |
381 | Otherwise indent them to column zero." | |
382 | :type '(choice (const :tag "Align with preceding" t) | |
383 | (const :tag "Indent to column 0" nil)) | |
384 | :group 'python) | |
385 | ||
386 | (defcustom python-honour-comment-indentation nil | |
387 | "Non-nil means indent relative to preceding comment line. | |
388 | Only do this for comments where the leading comment character is followed | |
24d5055c SM |
389 | by space. This doesn't apply to comment lines, which are always indented |
390 | in lines with preceding comments." | |
6f480c7a SM |
391 | :type 'boolean |
392 | :group 'python) | |
393 | ||
394 | (defcustom python-continuation-offset 4 | |
395 | "*Number of columns of additional indentation for continuation lines. | |
396 | Continuation lines follow a backslash-terminated line starting a statement." | |
397 | :group 'python | |
398 | :type 'integer) | |
399 | ||
400 | (defun python-guess-indent () | |
401 | "Guess step for indentation of current buffer. | |
402 | Set `python-indent' locally to the value guessed." | |
403 | (interactive) | |
404 | (save-excursion | |
0578dead SM |
405 | (save-restriction |
406 | (widen) | |
407 | (goto-char (point-min)) | |
408 | (let (done indent) | |
409 | (while (and (not done) (not (eobp))) | |
410 | (when (and (re-search-forward (rx (and ?: (0+ space) | |
411 | (or (syntax comment-start) | |
412 | line-end))) | |
413 | nil 'move) | |
414 | (python-open-block-statement-p)) | |
415 | (save-excursion | |
416 | (python-beginning-of-statement) | |
417 | (let ((initial (current-indentation))) | |
418 | (if (zerop (python-next-statement)) | |
419 | (setq indent (- (current-indentation) initial))) | |
420 | (if (and (>= indent 2) (<= indent 8)) ; sanity check | |
421 | (setq done t)))))) | |
422 | (when done | |
423 | (when (/= indent (default-value 'python-indent)) | |
424 | (set (make-local-variable 'python-indent) indent) | |
425 | (unless (= tab-width python-indent) | |
426 | (setq indent-tabs-mode nil))) | |
427 | indent))))) | |
6f480c7a SM |
428 | |
429 | (defun python-calculate-indentation () | |
430 | "Calculate Python indentation for line at point." | |
431 | (save-excursion | |
432 | (beginning-of-line) | |
433 | (let ((syntax (syntax-ppss)) | |
434 | start) | |
435 | (cond | |
436 | ((eq 'string (syntax-ppss-context syntax)) ; multi-line string | |
437 | (if (not python-indent-string-contents) | |
438 | 0 | |
439 | (save-excursion | |
440 | ;; Find indentation of preceding non-blank line within string. | |
441 | (setq start (nth 8 syntax)) | |
442 | (forward-line -1) | |
443 | (while (and (< start (point)) (looking-at "\\s-*$")) | |
444 | (forward-line -1)) | |
445 | (current-indentation)))) | |
446 | ((python-continuation-line-p) | |
447 | (let ((point (point)) | |
448 | (open-start (cadr syntax))) | |
449 | (if open-start | |
450 | ;; Inside bracketed expression. | |
451 | (progn | |
452 | (goto-char (1+ open-start)) | |
453 | ;; Look for first item in list (preceding point) and | |
454 | ;; align with it, if found. | |
455 | (if (with-syntax-table python-space-backslash-table | |
456 | (let ((parse-sexp-ignore-comments t)) | |
457 | (condition-case () | |
458 | (progn (forward-sexp) | |
459 | (backward-sexp) | |
460 | (< (point) point)) | |
461 | (error nil)))) | |
462 | (current-column) | |
463 | ;; Otherwise indent relative to statement start, one | |
464 | ;; level per bracketing level. | |
465 | (goto-char (1+ open-start)) | |
466 | (python-beginning-of-statement) | |
467 | (+ (current-indentation) (* (car syntax) python-indent)))) | |
468 | ;; Otherwise backslash-continued. | |
469 | (forward-line -1) | |
470 | (if (python-continuation-line-p) | |
471 | ;; We're past first continuation line. Align with | |
472 | ;; previous line. | |
473 | (current-indentation) | |
474 | ;; First continuation line. Indent one step, with an | |
475 | ;; extra one if statement opens a block. | |
476 | (save-excursion | |
477 | (python-beginning-of-statement) | |
478 | (+ (current-indentation) python-continuation-offset | |
479 | (if (python-open-block-statement-p t) | |
480 | python-indent | |
481 | 0))))))) | |
482 | ((bobp) 0) | |
483 | ;; Fixme: Like python-mode.el; not convinced by this. | |
484 | ((looking-at (rx (and (0+ space) (syntax comment-start) | |
485 | (not (any " \t\n"))))) ; non-indentable comment | |
486 | (current-indentation)) | |
487 | (t (let ((point (point))) | |
488 | (if python-honour-comment-indentation | |
489 | ;; Back over whitespace, newlines, non-indentable comments. | |
490 | (catch 'done | |
491 | (while t | |
492 | (if (cond ((bobp)) | |
493 | ;; not at comment start | |
494 | ((not (forward-comment -1)) | |
495 | (python-beginning-of-statement) | |
496 | t) | |
497 | ;; trailing comment | |
498 | ((/= (current-column) (current-indentation)) | |
499 | (python-beginning-of-statement) | |
500 | t) | |
501 | ;; indentable comment like python-mode.el | |
502 | ((and (looking-at (rx (and (syntax comment-start) | |
503 | (or space line-end)))) | |
504 | (/= 0 (current-column))))) | |
505 | (throw 'done t)))) | |
506 | ;; Else back over all comments. | |
507 | (python-skip-comments/blanks t) | |
508 | (python-beginning-of-statement)) | |
509 | ;; don't lose on bogus outdent | |
510 | (max 0 (+ (current-indentation) | |
511 | (or (cond ((python-open-block-statement-p t) | |
512 | python-indent) | |
513 | ((python-close-block-statement-p t) | |
514 | (- python-indent))) | |
515 | (progn (goto-char point) | |
516 | (if (python-outdent-p) | |
517 | (- python-indent))) | |
518 | 0))))))))) | |
519 | ||
24d5055c SM |
520 | (defun python-comment-indent () |
521 | "`comment-indent-function' for Python." | |
522 | ;; If previous non-blank line was a comment, use its indentation. | |
523 | ;; FIXME: This seems unnecessary since the default code delegates to | |
524 | ;; indent-according-to-mode. --Stef | |
525 | (unless (bobp) | |
526 | (save-excursion | |
527 | (forward-comment -1) | |
528 | (if (eq ?# (char-after)) (current-column))))) | |
529 | ||
6f480c7a SM |
530 | ;;;; Cycling through the possible indentations with successive TABs. |
531 | ||
532 | ;; These don't need to be buffer-local since they're only relevant | |
533 | ;; during a cycle. | |
534 | ||
535 | ;; Alist of possible indentations and start of statement they would close. | |
536 | (defvar python-indent-list nil | |
537 | "Internal use.") | |
538 | ;; Length of the above | |
539 | (defvar python-indent-list-length nil | |
540 | "Internal use.") | |
541 | ;; Current index into the alist. | |
542 | (defvar python-indent-index nil | |
543 | "Internal use.") | |
544 | ||
545 | (defun python-initial-text () | |
546 | "Text of line following indentation and ignoring any trailing comment." | |
547 | (buffer-substring (+ (line-beginning-position) (current-indentation)) | |
548 | (save-excursion | |
549 | (end-of-line) | |
550 | (forward-comment -1) | |
551 | (point)))) | |
552 | ||
553 | (defun python-indentation-levels () | |
24d5055c | 554 | "Return a list of possible indentations for this line. |
6f480c7a | 555 | Includes the default indentation and those which would close all |
24d5055c SM |
556 | enclosing blocks. Assumes the line has already been indented per |
557 | `python-indent-line'. Elements of the list are actually pairs: | |
558 | \(INDENTATION . TEXT), where TEXT is the initial text of the | |
559 | corresponding block opening (or nil)." | |
6f480c7a | 560 | (save-excursion |
24d5055c SM |
561 | (let ((levels (list (cons (current-indentation) |
562 | (save-excursion | |
563 | (if (python-beginning-of-block) | |
564 | (python-initial-text))))))) | |
6f480c7a SM |
565 | ;; Only one possibility if we immediately follow a block open or |
566 | ;; are in a continuation line. | |
567 | (unless (or (python-continuation-line-p) | |
568 | (save-excursion (and (python-previous-statement) | |
569 | (python-open-block-statement-p t)))) | |
570 | (while (python-beginning-of-block) | |
571 | (push (cons (current-indentation) (python-initial-text)) | |
572 | levels))) | |
573 | levels))) | |
574 | ||
575 | ;; This is basically what `python-indent-line' would be if we didn't | |
576 | ;; do the cycling. | |
577 | (defun python-indent-line-1 () | |
578 | "Subroutine of `python-indent-line'." | |
579 | (let ((target (python-calculate-indentation)) | |
580 | (pos (- (point-max) (point)))) | |
581 | (if (= target (current-indentation)) | |
582 | (if (< (current-column) (current-indentation)) | |
583 | (back-to-indentation)) | |
584 | (beginning-of-line) | |
585 | (delete-horizontal-space) | |
586 | (indent-to target) | |
587 | (if (> (- (point-max) pos) (point)) | |
588 | (goto-char (- (point-max) pos)))))) | |
589 | ||
24d5055c | 590 | (defun python-indent-line () |
6f480c7a SM |
591 | "Indent current line as Python code. |
592 | When invoked via `indent-for-tab-command', cycle through possible | |
593 | indentations for current line. The cycle is broken by a command different | |
594 | from `indent-for-tab-command', i.e. successive TABs do the cycling." | |
595 | (interactive) | |
596 | ;; Don't do extra work if invoked via `indent-region', for instance. | |
597 | (if (not (eq this-command 'indent-for-tab-command)) | |
598 | (python-indent-line-1) | |
599 | (if (eq last-command this-command) | |
600 | (if (= 1 python-indent-list-length) | |
601 | (message "Sole indentation") | |
602 | (progn (setq python-indent-index (% (1+ python-indent-index) | |
603 | python-indent-list-length)) | |
604 | (beginning-of-line) | |
605 | (delete-horizontal-space) | |
606 | (indent-to (car (nth python-indent-index python-indent-list))) | |
24d5055c SM |
607 | (if (python-block-end-p) |
608 | (let ((text (cdr (nth python-indent-index | |
609 | python-indent-list)))) | |
610 | (if text | |
611 | (message "Closes: %s" text)))))) | |
6f480c7a SM |
612 | (python-indent-line-1) |
613 | (setq python-indent-list (python-indentation-levels) | |
614 | python-indent-list-length (length python-indent-list) | |
615 | python-indent-index (1- python-indent-list-length))))) | |
24d5055c SM |
616 | |
617 | (defun python-block-end-p () | |
618 | "Non-nil if this is a line in a statement closing a block, | |
619 | or a blank line indented to where it would close a block." | |
620 | (and (not (python-comment-line-p)) | |
621 | (or (python-close-block-statement-p t) | |
622 | (< (current-indentation) | |
623 | (save-excursion | |
624 | (python-previous-statement) | |
625 | (current-indentation)))))) | |
626 | ||
627 | ;; Fixme: Define an indent-region-function. It should probably leave | |
628 | ;; lines alone if the indentation is already at one of the allowed | |
629 | ;; levels. Otherwise, M-C-\ typically keeps indenting more deeply | |
630 | ;; down a function. | |
6f480c7a SM |
631 | \f |
632 | ;;;; Movement. | |
633 | ||
634 | (defun python-beginning-of-defun () | |
635 | "`beginning-of-defun-function' for Python. | |
636 | Finds beginning of innermost nested class or method definition. | |
637 | Returns the name of the definition found at the end, or nil if reached | |
638 | start of buffer." | |
639 | (let ((ci (current-indentation)) | |
640 | (def-re (rx (and line-start (0+ space) (or "def" "class") | |
641 | (1+ space) | |
642 | (group (1+ (or word (syntax symbol))))))) | |
a1ae0e9c | 643 | found lep def-line) |
6f480c7a SM |
644 | (if (python-comment-line-p) |
645 | (setq ci most-positive-fixnum)) | |
646 | (while (and (not (bobp)) (not found)) | |
647 | ;; Treat bol at beginning of function as outside function so | |
648 | ;; that successive C-M-a makes progress backwards. | |
649 | (setq def-line (looking-at def-re)) | |
650 | (unless (bolp) (end-of-line)) | |
651 | (setq lep (line-end-position)) | |
652 | (if (and (re-search-backward def-re nil 'move) | |
653 | ;; Must be less indented or matching top level, or | |
654 | ;; equally indented if we started on a definition line. | |
655 | (let ((in (current-indentation))) | |
656 | (or (and (zerop ci) (zerop in)) | |
657 | (= lep (line-end-position)) ; on initial line | |
658 | (and def-line (= in ci)) | |
659 | (< in ci))) | |
660 | (not (python-in-string/comment))) | |
661 | (setq found t))))) | |
662 | ||
663 | (defun python-end-of-defun () | |
664 | "`end-of-defun-function' for Python. | |
665 | Finds end of innermost nested class or method definition." | |
666 | (let ((orig (point)) | |
24d5055c | 667 | (pattern (rx (and line-start (0+ space) (or "def" "class") space)))) |
6f480c7a SM |
668 | ;; Go to start of current block and check whether it's at top |
669 | ;; level. If it is, and not a block start, look forward for | |
670 | ;; definition statement. | |
671 | (when (python-comment-line-p) | |
672 | (end-of-line) | |
673 | (forward-comment most-positive-fixnum)) | |
674 | (if (not (python-open-block-statement-p)) | |
675 | (python-beginning-of-block)) | |
676 | (if (zerop (current-indentation)) | |
677 | (unless (python-open-block-statement-p) | |
678 | (while (and (re-search-forward pattern nil 'move) | |
679 | (python-in-string/comment))) ; just loop | |
680 | (unless (eobp) | |
681 | (beginning-of-line))) | |
682 | ;; Don't move before top-level statement that would end defun. | |
683 | (end-of-line) | |
684 | (python-beginning-of-defun)) | |
685 | ;; If we got to the start of buffer, look forward for | |
686 | ;; definition statement. | |
687 | (if (and (bobp) (not (looking-at "def\\|class"))) | |
688 | (while (and (not (eobp)) | |
689 | (re-search-forward pattern nil 'move) | |
690 | (python-in-string/comment)))) ; just loop | |
691 | ;; We're at a definition statement (or end-of-buffer). | |
692 | (unless (eobp) | |
693 | (python-end-of-block) | |
694 | ;; Count trailing space in defun (but not trailing comments). | |
695 | (skip-syntax-forward " >") | |
696 | (beginning-of-line)) | |
697 | ;; Catch pathological case like this, where the beginning-of-defun | |
698 | ;; skips to a definition we're not in: | |
699 | ;; if ...: | |
700 | ;; ... | |
701 | ;; else: | |
702 | ;; ... # point here | |
703 | ;; ... | |
704 | ;; def ... | |
705 | (if (< (point) orig) | |
706 | (goto-char (point-max))))) | |
707 | ||
708 | (defun python-beginning-of-statement () | |
709 | "Go to start of current statement. | |
710 | Accounts for continuation lines, multi-line strings, and multi-line bracketed | |
711 | expressions." | |
712 | (beginning-of-line) | |
713 | (python-beginning-of-string) | |
b830b63b RS |
714 | (catch 'foo |
715 | (while (python-continuation-line-p) | |
716 | (beginning-of-line) | |
717 | (if (python-backslash-continuation-line-p) | |
718 | (while (python-backslash-continuation-line-p) | |
719 | (forward-line -1)) | |
720 | (python-beginning-of-string) | |
721 | ;; Skip forward out of nested brackets. | |
722 | (condition-case () ; beware invalid syntax | |
723 | (progn (backward-up-list (syntax-ppss-depth (syntax-ppss))) t) | |
724 | (error (throw 'foo nil)))))) | |
6f480c7a SM |
725 | (back-to-indentation)) |
726 | ||
727 | (defun python-end-of-statement () | |
728 | "Go to the end of the current statement and return point. | |
729 | Usually this is the start of the next line, but if this is a | |
730 | multi-line statement we need to skip over the continuation lines. | |
731 | On a comment line, go to end of line." | |
732 | (end-of-line) | |
733 | (while (let (comment) | |
734 | ;; Move past any enclosing strings and sexps, or stop if | |
735 | ;; we're in a comment. | |
736 | (while (let ((s (syntax-ppss))) | |
737 | (cond ((eq 'comment (syntax-ppss-context s)) | |
738 | (setq comment t) | |
739 | nil) | |
740 | ((eq 'string (syntax-ppss-context s)) | |
741 | ;; Go to start of string and skip it. | |
742 | (goto-char (nth 8 s)) | |
743 | (condition-case () ; beware invalid syntax | |
744 | (progn (forward-sexp) t) | |
745 | (error (end-of-line)))) | |
746 | ((> (syntax-ppss-depth s) 0) | |
747 | ;; Skip forward out of nested brackets. | |
748 | (condition-case () ; beware invalid syntax | |
749 | (progn (backward-up-list | |
750 | (- (syntax-ppss-depth s))) | |
751 | t) | |
752 | (error (end-of-line)))))) | |
753 | (end-of-line)) | |
754 | (unless comment | |
755 | (eq ?\\ (char-before)))) ; Line continued? | |
756 | (end-of-line 2)) ; Try next line. | |
757 | (point)) | |
758 | ||
759 | (defun python-previous-statement (&optional count) | |
760 | "Go to start of previous statement. | |
761 | With argument COUNT, do it COUNT times. Stop at beginning of buffer. | |
762 | Return count of statements left to move." | |
763 | (interactive "p") | |
764 | (unless count (setq count 1)) | |
765 | (if (< count 0) | |
766 | (python-next-statement (- count)) | |
767 | (python-beginning-of-statement) | |
768 | (while (and (> count 0) (not (bobp))) | |
769 | (python-skip-comments/blanks t) | |
770 | (python-beginning-of-statement) | |
771 | (unless (bobp) (setq count (1- count)))) | |
772 | count)) | |
773 | ||
774 | (defun python-next-statement (&optional count) | |
775 | "Go to start of next statement. | |
776 | With argument COUNT, do it COUNT times. Stop at end of buffer. | |
777 | Return count of statements left to move." | |
778 | (interactive "p") | |
779 | (unless count (setq count 1)) | |
780 | (if (< count 0) | |
781 | (python-previous-statement (- count)) | |
782 | (beginning-of-line) | |
783 | (while (and (> count 0) (not (eobp))) | |
784 | (python-end-of-statement) | |
785 | (python-skip-comments/blanks) | |
786 | (setq count (1- count))) | |
787 | count)) | |
788 | ||
789 | (defun python-beginning-of-block (&optional arg) | |
790 | "Go to start of current block. | |
791 | With numeric arg, do it that many times. If ARG is negative, call | |
792 | `python-end-of-block' instead. | |
793 | If point is on the first line of a block, use its outer block. | |
794 | If current statement is in column zero, don't move and return nil. | |
795 | Otherwise return non-nil." | |
796 | (interactive "p") | |
797 | (unless arg (setq arg 1)) | |
798 | (cond | |
799 | ((zerop arg)) | |
800 | ((< arg 0) (python-end-of-block (- arg))) | |
801 | (t | |
802 | (let ((point (point))) | |
803 | (if (python-comment-line-p) | |
804 | (python-skip-comments/blanks t)) | |
805 | (python-beginning-of-statement) | |
806 | (let ((ci (current-indentation))) | |
807 | (if (zerop ci) | |
808 | (not (goto-char point)) ; return nil | |
809 | ;; Look upwards for less indented statement. | |
810 | (if (catch 'done | |
811 | ;;; This is slower than the below. | |
812 | ;;; (while (zerop (python-previous-statement)) | |
813 | ;;; (when (and (< (current-indentation) ci) | |
814 | ;;; (python-open-block-statement-p t)) | |
815 | ;;; (beginning-of-line) | |
816 | ;;; (throw 'done t))) | |
817 | (while (and (zerop (forward-line -1))) | |
818 | (when (and (< (current-indentation) ci) | |
819 | (not (python-comment-line-p)) | |
820 | ;; Move to beginning to save effort in case | |
821 | ;; this is in string. | |
822 | (progn (python-beginning-of-statement) t) | |
823 | (python-open-block-statement-p t)) | |
824 | (beginning-of-line) | |
825 | (throw 'done t))) | |
826 | (not (goto-char point))) ; Failed -- return nil | |
827 | (python-beginning-of-block (1- arg))))))))) | |
828 | ||
829 | (defun python-end-of-block (&optional arg) | |
830 | "Go to end of current block. | |
831 | With numeric arg, do it that many times. If ARG is negative, call | |
832 | `python-beginning-of-block' instead. | |
833 | If current statement is in column zero and doesn't open a block, don't | |
834 | move and return nil. Otherwise return t." | |
835 | (interactive "p") | |
836 | (unless arg (setq arg 1)) | |
837 | (if (< arg 0) | |
838 | (python-beginning-of-block (- arg))) | |
839 | (while (and (> arg 0) | |
840 | (let* ((point (point)) | |
841 | (_ (if (python-comment-line-p) | |
842 | (python-skip-comments/blanks t))) | |
843 | (ci (current-indentation)) | |
844 | (open (python-open-block-statement-p))) | |
845 | (if (and (zerop ci) (not open)) | |
846 | (not (goto-char point)) | |
847 | (catch 'done | |
848 | (while (zerop (python-next-statement)) | |
849 | (when (or (and open (<= (current-indentation) ci)) | |
850 | (< (current-indentation) ci)) | |
851 | (python-skip-comments/blanks t) | |
852 | (beginning-of-line 2) | |
853 | (throw 'done t))) | |
854 | (not (goto-char point)))))) | |
855 | (setq arg (1- arg))) | |
856 | (zerop arg)) | |
857 | \f | |
858 | ;;;; Imenu. | |
859 | ||
a1ae0e9c | 860 | (defvar python-recursing) |
6f480c7a SM |
861 | (defun python-imenu-create-index () |
862 | "`imenu-create-index-function' for Python. | |
863 | ||
864 | Makes nested Imenu menus from nested `class' and `def' statements. | |
865 | The nested menus are headed by an item referencing the outer | |
866 | definition; it has a space prepended to the name so that it sorts | |
b6ea7940 SM |
867 | first with `imenu--sort-by-name' (though, unfortunately, sub-menus |
868 | precede it)." | |
a1ae0e9c | 869 | (unless (boundp 'python-recursing) ; dynamically bound below |
6f480c7a SM |
870 | (goto-char (point-min))) ; normal call from Imenu |
871 | (let (index-alist ; accumulated value to return | |
a1ae0e9c | 872 | name) |
6f480c7a SM |
873 | (while (re-search-forward |
874 | (rx (and line-start (0+ space) ; leading space | |
875 | (or (group "def") (group "class")) ; type | |
876 | (1+ space) (group (1+ (or word ?_))))) ; name | |
877 | nil t) | |
878 | (unless (python-in-string/comment) | |
879 | (let ((pos (match-beginning 0)) | |
880 | (name (match-string-no-properties 3))) | |
881 | (if (match-beginning 2) ; def or class? | |
882 | (setq name (concat "class " name))) | |
883 | (save-restriction | |
884 | (narrow-to-defun) | |
a1ae0e9c | 885 | (let* ((python-recursing t) |
6f480c7a SM |
886 | (sublist (python-imenu-create-index))) |
887 | (if sublist | |
888 | (progn (push (cons (concat " " name) pos) sublist) | |
889 | (push (cons name sublist) index-alist)) | |
890 | (push (cons name pos) index-alist))))))) | |
891 | (nreverse index-alist))) | |
892 | \f | |
893 | ;;;; `Electric' commands. | |
894 | ||
895 | (defun python-electric-colon (arg) | |
896 | "Insert a colon and maybe outdent the line if it is a statement like `else'. | |
897 | With numeric ARG, just insert that many colons. With \\[universal-argument], | |
898 | just insert a single colon." | |
899 | (interactive "*P") | |
900 | (self-insert-command (if (not (integerp arg)) 1 arg)) | |
901 | (and (not arg) | |
902 | (eolp) | |
903 | (python-outdent-p) | |
904 | (not (python-in-string/comment)) | |
905 | (> (current-indentation) (python-calculate-indentation)) | |
906 | (python-indent-line))) ; OK, do it | |
907 | (put 'python-electric-colon 'delete-selection t) | |
908 | ||
909 | (defun python-backspace (arg) | |
910 | "Maybe delete a level of indentation on the current line. | |
911 | If not at the end of line's indentation, or on a comment line, just call | |
912 | `backward-delete-char-untabify'. With ARG, repeat that many times." | |
913 | (interactive "*p") | |
914 | (if (or (/= (current-indentation) (current-column)) | |
915 | (bolp) | |
916 | (python-continuation-line-p)) | |
917 | (backward-delete-char-untabify arg) | |
918 | (let ((indent 0)) | |
919 | (save-excursion | |
920 | (while (and (> arg 0) (python-beginning-of-block)) | |
921 | (setq arg (1- arg))) | |
922 | (when (zerop arg) | |
923 | (setq indent (current-indentation)) | |
924 | (message "Closes %s" (python-initial-text)))) | |
925 | (delete-horizontal-space) | |
926 | (indent-to indent)))) | |
927 | (put 'python-backspace 'delete-selection 'supersede) | |
928 | \f | |
929 | ;;;; pychecker | |
930 | ||
931 | (defcustom python-check-command "pychecker --stdlib" | |
932 | "*Command used to check a Python file." | |
933 | :type 'string | |
934 | :group 'python) | |
935 | ||
936 | (defvar python-saved-check-command nil | |
937 | "Internal use.") | |
938 | ||
6f480c7a SM |
939 | ;; After `sgml-validate-command'. |
940 | (defun python-check (command) | |
941 | "Check a Python file (default current buffer's file). | |
942 | Runs COMMAND, a shell command, as if by `compile'. | |
943 | See `python-check-command' for the default." | |
944 | (interactive | |
945 | (list (read-string "Checker command: " | |
946 | (or python-saved-check-command | |
947 | (concat python-check-command " " | |
948 | (let ((name (buffer-file-name))) | |
949 | (if name | |
950 | (file-name-nondirectory name)))))))) | |
951 | (setq python-saved-check-command command) | |
952 | (save-some-buffers (not compilation-ask-about-save) nil) | |
24d5055c SM |
953 | (let ((compilation-error-regexp-alist |
954 | (cons '("(\\([^,]+\\), line \\([0-9]+\\))" 1 2) | |
955 | compilation-error-regexp-alist))) | |
956 | (compilation-start command))) | |
6f480c7a SM |
957 | \f |
958 | ;;;; Inferior mode stuff (following cmuscheme). | |
959 | ||
24d5055c SM |
960 | ;; Fixme: Make sure we can work with IPython. |
961 | ||
6f480c7a SM |
962 | (defcustom python-python-command "python" |
963 | "*Shell command to run Python interpreter. | |
24d5055c SM |
964 | Any arguments can't contain whitespace. |
965 | Note that IPython may not work properly; it must at least be used with the | |
966 | `-cl' flag, i.e. use `ipython -cl'." | |
6f480c7a SM |
967 | :group 'python |
968 | :type 'string) | |
969 | ||
970 | (defcustom python-jython-command "jython" | |
971 | "*Shell command to run Jython interpreter. | |
972 | Any arguments can't contain whitespace." | |
973 | :group 'python | |
974 | :type 'string) | |
975 | ||
976 | (defvar python-command python-python-command | |
977 | "Actual command used to run Python. | |
978 | May be `python-python-command' or `python-jython-command'. | |
979 | Additional arguments are added when the command is used by `run-python' | |
980 | et al.") | |
981 | ||
982 | (defvar python-buffer nil | |
b6ea7940 SM |
983 | "The current python process buffer." |
984 | ;; Fixme: a single process is currently assumed, so that this doc | |
985 | ;; is misleading. | |
986 | ||
987 | ;; "*The current python process buffer. | |
988 | ;; To run multiple Python processes, start the first with \\[run-python]. | |
989 | ;; It will be in a buffer named *Python*. Rename that with | |
990 | ;; \\[rename-buffer]. Now start a new process with \\[run-python]. It | |
991 | ;; will be in a new buffer, named *Python*. Switch between the different | |
992 | ;; process buffers with \\[switch-to-buffer]. | |
993 | ||
994 | ;; Commands that send text from source buffers to Python processes have | |
995 | ;; to choose a process to send to. This is determined by global variable | |
996 | ;; `python-buffer'. Suppose you have three inferior Pythons running: | |
997 | ;; Buffer Process | |
998 | ;; foo python | |
999 | ;; bar python<2> | |
1000 | ;; *Python* python<3> | |
1001 | ;; If you do a \\[python-send-region-and-go] command on some Python source | |
1002 | ;; code, what process does it go to? | |
1003 | ||
1004 | ;; - In a process buffer (foo, bar, or *Python*), send it to that process. | |
1005 | ;; - In some other buffer (e.g. a source file), send it to the process | |
1006 | ;; attached to `python-buffer'. | |
1007 | ;; Process selection is done by function `python-proc'. | |
1008 | ||
1009 | ;; Whenever \\[run-python] starts a new process, it resets `python-buffer' | |
1010 | ;; to be the new process's buffer. If you only run one process, this will | |
1011 | ;; do the right thing. If you run multiple processes, you can change | |
1012 | ;; `python-buffer' to another process buffer with \\[set-variable]." | |
1013 | ) | |
6f480c7a | 1014 | |
0578dead | 1015 | (defconst python-compilation-regexp-alist |
24d5055c | 1016 | ;; FIXME: maybe these should move to compilation-error-regexp-alist-alist. |
0578dead SM |
1017 | `((,(rx (and line-start (1+ (any " \t")) "File \"" |
1018 | (group (1+ (not (any "\"<")))) ; avoid `<stdin>' &c | |
1019 | "\", line " (group (1+ digit)))) | |
24d5055c SM |
1020 | 1 2) |
1021 | (,(rx (and " in file " (group (1+ not-newline)) " on line " | |
1022 | (group (1+ digit)))) | |
ee99b45b | 1023 | 1 2)) |
0578dead SM |
1024 | "`compilation-error-regexp-alist' for inferior Python.") |
1025 | ||
24d5055c SM |
1026 | (defvar inferior-python-mode-map |
1027 | (let ((map (make-sparse-keymap))) | |
1028 | ;; This will inherit from comint-mode-map. | |
1029 | (define-key map "\C-c\C-l" 'python-load-file) | |
24d5055c SM |
1030 | (define-key map "\C-c\C-v" 'python-check) |
1031 | ;; Note that we _can_ still use these commands which send to the | |
1032 | ;; Python process even at the prompt iff we have a normal prompt, | |
1033 | ;; i.e. '>>> ' and not '... '. See the comment before | |
1034 | ;; python-send-region. Fixme: uncomment these if we address that. | |
1035 | ||
1036 | ;; (define-key map [(meta ?\t)] 'python-complete-symbol) | |
1037 | ;; (define-key map "\C-c\C-f" 'python-describe-symbol) | |
1038 | map)) | |
1039 | ||
b6ea7940 SM |
1040 | ;; Fixme: This should inherit some stuff from python-mode, but I'm not |
1041 | ;; sure how much: at least some keybindings, like C-c C-f; syntax?; | |
1042 | ;; font-locking, e.g. for triple-quoted strings? | |
6f480c7a SM |
1043 | (define-derived-mode inferior-python-mode comint-mode "Inferior Python" |
1044 | "Major mode for interacting with an inferior Python process. | |
1045 | A Python process can be started with \\[run-python]. | |
1046 | ||
1047 | Hooks `comint-mode-hook' and `inferior-python-mode-hook' are run in | |
1048 | that order. | |
1049 | ||
1050 | You can send text to the inferior Python process from other buffers containing | |
1051 | Python source. | |
1052 | * `python-switch-to-python' switches the current buffer to the Python | |
1053 | process buffer. | |
1054 | * `python-send-region' sends the current region to the Python process. | |
1055 | * `python-send-region-and-go' switches to the Python process buffer | |
1056 | after sending the text. | |
1057 | For running multiple processes in multiple buffers, see `python-buffer'. | |
1058 | ||
1059 | \\{inferior-python-mode-map}" | |
1060 | :group 'python | |
1061 | (set-syntax-table python-mode-syntax-table) | |
1062 | (setq mode-line-process '(":%s")) | |
24d5055c | 1063 | (set (make-local-variable 'comint-input-filter) 'python-input-filter) |
0578dead SM |
1064 | (add-hook 'comint-preoutput-filter-functions #'python-preoutput-filter |
1065 | nil t) | |
b6ea7940 SM |
1066 | ;; Still required by `comint-redirect-send-command', for instance |
1067 | ;; (and we need to match things like `>>> ... >>> '): | |
24d5055c SM |
1068 | (set (make-local-variable 'comint-prompt-regexp) |
1069 | (rx (and line-start (1+ (and (repeat 3 (any ">.")) ?\ ))))) | |
0578dead SM |
1070 | (set (make-local-variable 'compilation-error-regexp-alist) |
1071 | python-compilation-regexp-alist) | |
1072 | (compilation-shell-minor-mode 1)) | |
6f480c7a SM |
1073 | |
1074 | (defcustom inferior-python-filter-regexp "\\`\\s-*\\S-?\\S-?\\s-*\\'" | |
1075 | "*Input matching this regexp is not saved on the history list. | |
1076 | Default ignores all inputs of 0, 1, or 2 non-blank characters." | |
1077 | :type 'regexp | |
1078 | :group 'python) | |
1079 | ||
24d5055c SM |
1080 | (defun python-input-filter (str) |
1081 | "`comint-input-filter' function for inferior Python. | |
1082 | Don't save anything for STR matching `inferior-python-filter-regexp'." | |
1083 | (not (string-match inferior-python-filter-regexp str))) | |
1084 | ||
6f480c7a SM |
1085 | ;; Fixme: Loses with quoted whitespace. |
1086 | (defun python-args-to-list (string) | |
1087 | (let ((where (string-match "[ \t]" string))) | |
1088 | (cond ((null where) (list string)) | |
1089 | ((not (= where 0)) | |
1090 | (cons (substring string 0 where) | |
1091 | (python-args-to-list (substring string (+ 1 where))))) | |
1092 | (t (let ((pos (string-match "[^ \t]" string))) | |
1093 | (if pos (python-args-to-list (substring string pos)))))))) | |
1094 | ||
0578dead | 1095 | (defvar python-preoutput-result nil |
24d5055c | 1096 | "Data from last `_emacs_out' line seen by the preoutput filter.") |
0578dead SM |
1097 | |
1098 | (defvar python-preoutput-continuation nil | |
1099 | "If non-nil, funcall this when `python-preoutput-filter' sees `_emacs_ok'.") | |
1100 | ||
1101 | ;; Using this stops us getting lines in the buffer like | |
1102 | ;; >>> ... ... >>> | |
1103 | ;; Also look for (and delete) an `_emacs_ok' string and call | |
1104 | ;; `python-preoutput-continuation' if we get it. | |
1105 | (defun python-preoutput-filter (s) | |
1106 | "`comint-preoutput-filter-functions' function: ignore prompts not at bol." | |
24d5055c SM |
1107 | (cond ((and (string-match (rx (and string-start (repeat 3 (any ".>")) |
1108 | " " string-end)) | |
1109 | s) | |
0578dead SM |
1110 | (/= (let ((inhibit-field-text-motion t)) |
1111 | (line-beginning-position)) | |
1112 | (point))) | |
1113 | "") | |
1114 | ((string= s "_emacs_ok\n") | |
1115 | (when python-preoutput-continuation | |
1116 | (funcall python-preoutput-continuation) | |
1117 | (setq python-preoutput-continuation nil)) | |
1118 | "") | |
1119 | ((string-match "_emacs_out \\(.*\\)\n" s) | |
1120 | (setq python-preoutput-result (match-string 1 s)) | |
1121 | "") | |
1122 | (t s))) | |
1123 | ||
6f480c7a | 1124 | ;;;###autoload |
0578dead | 1125 | (defun run-python (&optional cmd noshow) |
6f480c7a | 1126 | "Run an inferior Python process, input and output via buffer *Python*. |
0578dead SM |
1127 | CMD is the Python command to run. NOSHOW non-nil means don't show the |
1128 | buffer automatically. | |
6f480c7a | 1129 | If there is a process already running in `*Python*', switch to |
24d5055c | 1130 | that buffer. Interactively, a prefix arg allows you to edit the initial |
abe0aa3e | 1131 | command line (default is `python-command'); `-i' etc. args will be added |
24d5055c SM |
1132 | to this as appropriate. Runs the hook `inferior-python-mode-hook' |
1133 | \(after the `comint-mode-hook' is run). | |
0578dead | 1134 | \(Type \\[describe-mode] in the process buffer for a list of commands.)" |
6f480c7a SM |
1135 | (interactive (list (if current-prefix-arg |
1136 | (read-string "Run Python: " python-command) | |
1137 | python-command))) | |
0578dead SM |
1138 | (unless cmd (setq cmd python-python-command)) |
1139 | (setq python-command cmd) | |
6f480c7a SM |
1140 | ;; Fixme: Consider making `python-buffer' buffer-local as a buffer |
1141 | ;; (not a name) in Python buffers from which `run-python' &c is | |
1142 | ;; invoked. Would support multiple processes better. | |
24d5055c | 1143 | (unless (comint-check-proc python-buffer) |
522067b2 SM |
1144 | (let* ((cmdlist (append (python-args-to-list cmd) '("-i"))) |
1145 | (path (getenv "PYTHONPATH")) | |
1146 | (process-environment ; to import emacs.py | |
abe0aa3e | 1147 | (cons (concat "PYTHONPATH=" data-directory |
522067b2 SM |
1148 | (if path (concat ":" path))) |
1149 | process-environment))) | |
0578dead | 1150 | (set-buffer (apply 'make-comint "Python" (car cmdlist) nil |
24d5055c | 1151 | (cdr cmdlist))) |
abe0aa3e | 1152 | (setq python-buffer (buffer-name))) |
0578dead SM |
1153 | (inferior-python-mode) |
1154 | ;; Load function defintions we need. | |
1155 | ;; Before the preoutput function was used, this was done via -c in | |
1156 | ;; cmdlist, but that loses the banner and doesn't run the startup | |
24d5055c SM |
1157 | ;; file. The code might be inline here, but there's enough that it |
1158 | ;; seems worth putting in a separate file, and it's probably cleaner | |
1159 | ;; to put it in a module. | |
1160 | (python-send-string "import emacs")) | |
1161 | (unless noshow (pop-to-buffer python-buffer))) | |
1162 | ||
1163 | ;; Fixme: We typically lose if the inferior isn't in the normal REPL, | |
1164 | ;; e.g. prompt is `help> '. Probably raise an error if the form of | |
1165 | ;; the prompt is unexpected; actually, it needs to be `>>> ', not | |
1166 | ;; `... ', i.e. we're not inputting a block &c. However, this may not | |
1167 | ;; be the place to do it, e.g. we might actually want to send commands | |
1168 | ;; having set up such a state. | |
6f480c7a | 1169 | |
56e6d6fe SM |
1170 | (defun python-send-command (command) |
1171 | "Like `python-send-string' but resets `compilation-minor-mode'." | |
24d5055c | 1172 | (goto-char (point-max)) |
56e6d6fe SM |
1173 | (let ((end (marker-position (process-mark (python-proc))))) |
1174 | (compilation-forget-errors) | |
1175 | (python-send-string command) | |
1176 | (set-marker compilation-parsing-end end) | |
1177 | (setq compilation-last-buffer (current-buffer)))) | |
1178 | ||
6f480c7a SM |
1179 | (defun python-send-region (start end) |
1180 | "Send the region to the inferior Python process." | |
1181 | ;; The region is evaluated from a temporary file. This avoids | |
1182 | ;; problems with blank lines, which have different semantics | |
1183 | ;; interactively and in files. It also saves the inferior process | |
24d5055c SM |
1184 | ;; buffer filling up with interpreter prompts. We need a Python |
1185 | ;; function to remove the temporary file when it has been evaluated | |
1186 | ;; (though we could probably do it in Lisp with a Comint output | |
1187 | ;; filter). This function also catches exceptions and truncates | |
1188 | ;; tracebacks not to mention the frame of the function itself. | |
6f480c7a SM |
1189 | ;; |
1190 | ;; The compilation-minor-mode parsing takes care of relating the | |
24d5055c SM |
1191 | ;; reference to the temporary file to the source. |
1192 | ;; | |
1193 | ;; Fixme: Write a `coding' header to the temp file if the region is | |
1194 | ;; non-ASCII. | |
6f480c7a SM |
1195 | (interactive "r") |
1196 | (let* ((f (make-temp-file "py")) | |
24d5055c | 1197 | (command (format "emacs.eexecfile(%S)" f)) |
a1ae0e9c | 1198 | (orig-start (copy-marker start))) |
24d5055c SM |
1199 | (when (save-excursion |
1200 | (goto-char start) | |
1201 | (/= 0 (current-indentation))) ; need dummy block | |
1202 | (save-excursion | |
1203 | (goto-char orig-start) | |
1204 | ;; Wrong if we had indented code at buffer start. | |
1205 | (set-marker orig-start (line-beginning-position 0))) | |
1206 | (write-region "if True:\n" nil f nil 'nomsg)) | |
6f480c7a | 1207 | (write-region start end f t 'nomsg) |
abe0aa3e SM |
1208 | (with-current-buffer (process-buffer (python-proc)) ;Runs python if needed. |
1209 | (python-send-command command) | |
1210 | ;; Tell compile.el to redirect error locations in file `f' to | |
1211 | ;; positions past marker `orig-start'. It has to be done *after* | |
1212 | ;; python-send-command's call to compilation-forget-errors. | |
1213 | (compilation-fake-loc orig-start f)))) | |
6f480c7a SM |
1214 | |
1215 | (defun python-send-string (string) | |
1216 | "Evaluate STRING in inferior Python process." | |
1217 | (interactive "sPython command: ") | |
0578dead SM |
1218 | (comint-send-string (python-proc) string) |
1219 | (comint-send-string (python-proc) "\n\n")) | |
6f480c7a SM |
1220 | |
1221 | (defun python-send-buffer () | |
1222 | "Send the current buffer to the inferior Python process." | |
1223 | (interactive) | |
1224 | (python-send-region (point-min) (point-max))) | |
1225 | ||
24d5055c SM |
1226 | ;; Fixme: Try to define the function or class within the relevant |
1227 | ;; module, not just at top level. | |
6f480c7a SM |
1228 | (defun python-send-defun () |
1229 | "Send the current defun (class or method) to the inferior Python process." | |
1230 | (interactive) | |
1231 | (save-excursion (python-send-region (progn (beginning-of-defun) (point)) | |
1232 | (progn (end-of-defun) (point))))) | |
1233 | ||
1234 | (defun python-switch-to-python (eob-p) | |
1235 | "Switch to the Python process buffer. | |
1236 | With prefix arg, position cursor at end of buffer." | |
1237 | (interactive "P") | |
abe0aa3e | 1238 | (pop-to-buffer (process-buffer (python-proc))) ;Runs python if needed. |
6f480c7a SM |
1239 | (when eob-p |
1240 | (push-mark) | |
1241 | (goto-char (point-max)))) | |
1242 | ||
6f480c7a SM |
1243 | (defun python-send-region-and-go (start end) |
1244 | "Send the region to the inferior Python process. | |
1245 | Then switch to the process buffer." | |
1246 | (interactive "r") | |
1247 | (python-send-region start end) | |
1248 | (python-switch-to-python t)) | |
1249 | ||
1250 | (defcustom python-source-modes '(python-mode jython-mode) | |
1251 | "*Used to determine if a buffer contains Python source code. | |
1252 | If it's loaded into a buffer that is in one of these major modes, it's | |
1253 | considered a Python source file by `python-load-file'. | |
1254 | Used by these commands to determine defaults." | |
1255 | :type '(repeat function) | |
1256 | :group 'python) | |
1257 | ||
1258 | (defvar python-prev-dir/file nil | |
1259 | "Caches (directory . file) pair used in the last `python-load-file' command. | |
1260 | Used for determining the default in the next one.") | |
1261 | ||
1262 | (defun python-load-file (file-name) | |
1263 | "Load a Python file FILE-NAME into the inferior Python process. | |
1264 | If the file has extension `.py' import or reload it as a module. | |
1265 | Treating it as a module keeps the global namespace clean, provides | |
1266 | function location information for debugging, and supports users of | |
1267 | module-qualified names." | |
1268 | (interactive (comint-get-source "Load Python file: " python-prev-dir/file | |
1269 | python-source-modes | |
24d5055c SM |
1270 | t)) ; because execfile needs exact name |
1271 | (comint-check-source file-name) ; Check to see if buffer needs saving. | |
6f480c7a SM |
1272 | (setq python-prev-dir/file (cons (file-name-directory file-name) |
1273 | (file-name-nondirectory file-name))) | |
abe0aa3e SM |
1274 | (with-current-buffer (process-buffer (python-proc)) ;Runs python if needed. |
1275 | ;; Fixme: I'm not convinced by this logic from python-mode.el. | |
1276 | (python-send-command | |
1277 | (if (string-match "\\.py\\'" file-name) | |
1278 | (let ((module (file-name-sans-extension | |
1279 | (file-name-nondirectory file-name)))) | |
1280 | (format "emacs.eimport(%S,%S)" | |
1281 | module (file-name-directory file-name))) | |
1282 | (format "execfile(%S)" file-name))) | |
1283 | (message "%s loaded" file-name))) | |
6f480c7a | 1284 | |
24d5055c SM |
1285 | ;; Fixme: If we need to start the process, wait until we've got the OK |
1286 | ;; from the startup. | |
6f480c7a | 1287 | (defun python-proc () |
24d5055c SM |
1288 | "Return the current Python process. |
1289 | See variable `python-buffer'. Starts a new process if necessary." | |
1290 | (or (if python-buffer | |
1291 | (get-buffer-process (if (eq major-mode 'inferior-python-mode) | |
1292 | (current-buffer) | |
1293 | python-buffer))) | |
1294 | (progn (run-python nil t) | |
1295 | (python-proc)))) | |
6f480c7a SM |
1296 | \f |
1297 | ;;;; Context-sensitive help. | |
1298 | ||
0578dead SM |
1299 | (defconst python-dotty-syntax-table |
1300 | (let ((table (make-syntax-table))) | |
1301 | (set-char-table-parent table python-mode-syntax-table) | |
1302 | (modify-syntax-entry ?. "_" table) | |
1303 | table) | |
1304 | "Syntax table giving `.' symbol syntax. | |
1305 | Otherwise inherits from `python-mode-syntax-table'.") | |
6f480c7a | 1306 | |
24d5055c | 1307 | (defvar view-return-to-alist) |
522067b2 | 1308 | (eval-when-compile (autoload 'help-buffer "help-fns")) |
24d5055c | 1309 | |
0578dead | 1310 | ;; Fixme: Should this actually be used instead of info-look, i.e. be |
24d5055c | 1311 | ;; bound to C-h S? Can we use other pydoc stuff before python 2.2? |
6f480c7a | 1312 | (defun python-describe-symbol (symbol) |
24d5055c SM |
1313 | "Get help on SYMBOL using `help'. |
1314 | Interactively, prompt for symbol. | |
1315 | ||
1316 | Symbol may be anything recognized by the interpreter's `help' command -- | |
1317 | e.g. `CALLS' -- not just variables in scope. | |
1318 | This only works for Python version 2.2 or newer since earlier interpreters | |
1319 | don't support `help'." | |
1320 | ;; Note that we do this in the inferior process, not a separate one, to | |
0578dead | 1321 | ;; ensure the environment is appropriate. |
6f480c7a | 1322 | (interactive |
0578dead SM |
1323 | (let ((symbol (with-syntax-table python-dotty-syntax-table |
1324 | (current-word))) | |
24d5055c SM |
1325 | (enable-recursive-minibuffers t)) |
1326 | (list (read-string (if symbol | |
1327 | (format "Describe symbol (default %s): " symbol) | |
1328 | "Describe symbol: ") | |
1329 | nil nil symbol)))) | |
6f480c7a | 1330 | (if (equal symbol "") (error "No symbol")) |
0578dead | 1331 | (let* ((func `(lambda () |
24d5055c SM |
1332 | (comint-redirect-send-command (format "emacs.ehelp(%S)\n" |
1333 | ,symbol) | |
0578dead SM |
1334 | "*Help*" nil)))) |
1335 | ;; Ensure we have a suitable help buffer. | |
24d5055c SM |
1336 | ;; Fixme: Maybe process `Related help topics' a la help xrefs and |
1337 | ;; allow C-c C-f in help buffer. | |
1338 | (let ((temp-buffer-show-hook ; avoid xref stuff | |
1339 | (lambda () | |
1340 | (toggle-read-only 1) | |
1341 | (setq view-return-to-alist | |
1342 | (list (cons (selected-window) help-return-method)))))) | |
3299a03a | 1343 | (help-setup-xref (list 'python-describe-symbol symbol) (interactive-p)) |
24d5055c | 1344 | (with-output-to-temp-buffer (help-buffer) |
0578dead | 1345 | (with-current-buffer standard-output |
24d5055c SM |
1346 | (set (make-local-variable 'comint-redirect-subvert-readonly) t) |
1347 | (print-help-return-message)))) | |
0578dead SM |
1348 | (if (and python-buffer (get-buffer python-buffer)) |
1349 | (with-current-buffer python-buffer | |
1350 | (funcall func)) | |
1351 | (setq python-preoutput-continuation func) | |
1352 | (run-python nil t)))) | |
6f480c7a SM |
1353 | |
1354 | (add-to-list 'debug-ignored-errors "^No symbol") | |
0578dead | 1355 | |
24d5055c SM |
1356 | (defun python-send-receive (string) |
1357 | "Send STRING to inferior Python (if any) and return result. | |
1358 | The result is what follows `_emacs_out' in the output (or nil)." | |
1359 | (let ((proc (python-proc))) | |
1360 | (python-send-string string) | |
1361 | (setq python-preoutput-result nil) | |
1362 | (accept-process-output proc 5) | |
1363 | python-preoutput-result)) | |
1364 | ||
0578dead SM |
1365 | ;; Fixme: try to make it work with point in the arglist. Also, is |
1366 | ;; there anything reasonable we can do with random methods? | |
1367 | ;; (Currently only works with functions.) | |
1368 | (defun python-eldoc-function () | |
1369 | "`eldoc-print-current-symbol-info' for Python. | |
1370 | Only works when point is in a function name, not its arglist, for instance. | |
1371 | Assumes an inferior Python is running." | |
1372 | (let ((symbol (with-syntax-table python-dotty-syntax-table | |
24d5055c SM |
1373 | (current-word)))) |
1374 | (when symbol | |
1375 | (python-send-receive (format "emacs.eargs(%S)" symbol))))) | |
6f480c7a SM |
1376 | \f |
1377 | ;;;; Info-look functionality. | |
1378 | ||
0578dead SM |
1379 | (defun python-after-info-look () |
1380 | "Set up info-look for Python. | |
1381 | Used with `eval-after-load'." | |
1382 | (let* ((version (let ((s (shell-command-to-string (concat python-command | |
1383 | " -V")))) | |
1384 | (string-match "^Python \\([0-9]+\\.[0-9]+\\>\\)" s) | |
1385 | (match-string 1 s))) | |
1386 | ;; Whether info files have a Python version suffix, e.g. in Debian. | |
3299a03a | 1387 | (versioned |
0578dead | 1388 | (with-temp-buffer |
b6ea7940 | 1389 | (with-no-warnings (Info-mode)) |
0578dead | 1390 | (condition-case () |
a1ae0e9c | 1391 | ;; Don't use `info' because it would pop-up a *info* buffer. |
b6ea7940 SM |
1392 | (with-no-warnings |
1393 | (Info-goto-node (format "(python%s-lib)Miscellaneous Index" | |
522067b2 SM |
1394 | version)) |
1395 | t) | |
0578dead SM |
1396 | (error nil))))) |
1397 | (info-lookup-maybe-add-help | |
1398 | :mode 'python-mode | |
1399 | :regexp "[[:alnum:]_]+" | |
1400 | :doc-spec | |
1401 | ;; Fixme: Can this reasonably be made specific to indices with | |
1402 | ;; different rules? Is the order of indices optimal? | |
1403 | ;; (Miscellaneous in -ref first prefers lookup of keywords, for | |
1404 | ;; instance.) | |
1405 | (if versioned | |
1406 | ;; The empty prefix just gets us highlighted terms. | |
1407 | `((,(concat "(python" version "-ref)Miscellaneous Index") nil "") | |
1408 | (,(concat "(python" version "-ref)Module Index" nil "")) | |
1409 | (,(concat "(python" version "-ref)Function-Method-Variable Index" | |
1410 | nil "")) | |
1411 | (,(concat "(python" version "-ref)Class-Exception-Object Index" | |
1412 | nil "")) | |
1413 | (,(concat "(python" version "-lib)Module Index" nil "")) | |
1414 | (,(concat "(python" version "-lib)Class-Exception-Object Index" | |
1415 | nil "")) | |
1416 | (,(concat "(python" version "-lib)Function-Method-Variable Index" | |
1417 | nil "")) | |
1418 | (,(concat "(python" version "-lib)Miscellaneous Index" nil ""))) | |
1419 | '(("(python-ref)Miscellaneous Index" nil "") | |
1420 | ("(python-ref)Module Index" nil "") | |
1421 | ("(python-ref)Function-Method-Variable Index" nil "") | |
1422 | ("(python-ref)Class-Exception-Object Index" nil "") | |
1423 | ("(python-lib)Module Index" nil "") | |
1424 | ("(python-lib)Class-Exception-Object Index" nil "") | |
1425 | ("(python-lib)Function-Method-Variable Index" nil "") | |
1426 | ("(python-lib)Miscellaneous Index" nil "")))))) | |
1427 | (eval-after-load "info-look" '(python-after-info-look)) | |
6f480c7a SM |
1428 | \f |
1429 | ;;;; Miscellancy. | |
1430 | ||
1431 | (defcustom python-jython-packages '("java" "javax" "org" "com") | |
1432 | "Packages implying `jython-mode'. | |
1433 | If these are imported near the beginning of the buffer, `python-mode' | |
1434 | actually punts to `jython-mode'." | |
1435 | :type '(repeat string) | |
1436 | :group 'python) | |
1437 | ||
1438 | ;; Called from `python-mode', this causes a recursive call of the | |
1439 | ;; mode. See logic there to break out of the recursion. | |
1440 | (defun python-maybe-jython () | |
1441 | "Invoke `jython-mode' if the buffer appears to contain Jython code. | |
1442 | The criterion is either a match for `jython-mode' via | |
1443 | `interpreter-mode-alist' or an import of a module from the list | |
1444 | `python-jython-packages'." | |
1445 | ;; The logic is taken from python-mode.el. | |
1446 | (save-excursion | |
0578dead SM |
1447 | (save-restriction |
1448 | (widen) | |
1449 | (goto-char (point-min)) | |
1450 | (let ((interpreter (if (looking-at auto-mode-interpreter-regexp) | |
1451 | (match-string 2)))) | |
1452 | (if (and interpreter (eq 'jython-mode | |
1453 | (cdr (assoc (file-name-nondirectory | |
1454 | interpreter) | |
1455 | interpreter-mode-alist)))) | |
1456 | (jython-mode) | |
1457 | (if (catch 'done | |
1458 | (while (re-search-forward | |
1459 | (rx (and line-start (or "import" "from") (1+ space) | |
1460 | (group (1+ (not (any " \t\n.")))))) | |
c3f85d95 | 1461 | (+ (point-min) 10000) ; Probably not worth customizing. |
0578dead SM |
1462 | t) |
1463 | (if (member (match-string 1) python-jython-packages) | |
1464 | (throw 'done t)))) | |
1465 | (jython-mode))))))) | |
6f480c7a SM |
1466 | |
1467 | (defun python-fill-paragraph (&optional justify) | |
0578dead | 1468 | "`fill-paragraph-function' handling comments and multi-line strings. |
6f480c7a | 1469 | If any of the current line is a comment, fill the comment or the |
0578dead SM |
1470 | paragraph of it that point is in, preserving the comment's |
1471 | indentation and initial comment characters. Similarly if the end | |
1472 | of the current line is in or at the end of a multi-line string. | |
1473 | Otherwise, do nothing." | |
6f480c7a SM |
1474 | (interactive "P") |
1475 | (or (fill-comment-paragraph justify) | |
0578dead SM |
1476 | ;; The `paragraph-start' and `paragraph-separate' variables |
1477 | ;; don't allow us to delimit the last paragraph in a multi-line | |
1478 | ;; string properly, so narrow to the string and then fill around | |
1479 | ;; (the end of) the current line. | |
1480 | (save-excursion | |
1481 | (end-of-line) | |
1482 | (let* ((syntax (syntax-ppss)) | |
1483 | (orig (point)) | |
1484 | (start (nth 8 syntax)) | |
1485 | end) | |
1486 | (cond ((eq t (nth 3 syntax)) ; in fenced string | |
1487 | (goto-char (nth 8 syntax)) ; string start | |
1488 | (condition-case () ; for unbalanced quotes | |
1489 | (progn (forward-sexp) | |
1490 | (setq end (point))) | |
1491 | (error (setq end (point-max))))) | |
1492 | ((re-search-backward "\\s|\\s-*\\=" nil t) ; end of fenced | |
1493 | ; string | |
1494 | (forward-char) | |
1495 | (setq end (point)) | |
1496 | (condition-case () | |
1497 | (progn (backward-sexp) | |
1498 | (setq start (point))) | |
1499 | (error nil)))) | |
1500 | (when end | |
1501 | (save-restriction | |
1502 | (narrow-to-region start end) | |
1503 | (goto-char orig) | |
1504 | (fill-paragraph justify)))))) | |
1505 | t) | |
6f480c7a SM |
1506 | |
1507 | (defun python-shift-left (start end &optional count) | |
1508 | "Shift lines in region COUNT (the prefix arg) columns to the left. | |
1509 | COUNT defaults to `python-indent'. If region isn't active, just shift | |
1510 | current line. The region shifted includes the lines in which START and | |
1511 | END lie. It is an error if any lines in the region are indented less than | |
1512 | COUNT columns." | |
1513 | (interactive (if mark-active | |
1514 | (list (region-beginning) (region-end) current-prefix-arg) | |
1515 | (list (point) (point) current-prefix-arg))) | |
1516 | (if count | |
1517 | (setq count (prefix-numeric-value count)) | |
1518 | (setq count python-indent)) | |
1519 | (when (> count 0) | |
1520 | (save-excursion | |
1521 | (goto-char start) | |
1522 | (while (< (point) end) | |
1523 | (if (and (< (current-indentation) count) | |
1524 | (not (looking-at "[ \t]*$"))) | |
1525 | (error "Can't shift all lines enough")) | |
1526 | (forward-line)) | |
1527 | (indent-rigidly start end (- count))))) | |
1528 | ||
1529 | (add-to-list 'debug-ignored-errors "^Can't shift all lines enough") | |
1530 | ||
1531 | (defun python-shift-right (start end &optional count) | |
1532 | "Shift lines in region COUNT (the prefix arg) columns to the right. | |
1533 | COUNT defaults to `python-indent'. If region isn't active, just shift | |
1534 | current line. The region shifted includes the lines in which START and | |
1535 | END lie." | |
1536 | (interactive (if mark-active | |
1537 | (list (region-beginning) (region-end) current-prefix-arg) | |
1538 | (list (point) (point) current-prefix-arg))) | |
1539 | (if count | |
1540 | (setq count (prefix-numeric-value count)) | |
1541 | (setq count python-indent)) | |
1542 | (indent-rigidly start end count)) | |
1543 | ||
1544 | (defun python-outline-level () | |
1545 | "`outline-level' function for Python mode. | |
0578dead SM |
1546 | The level is the number of `python-indent' steps of indentation |
1547 | of current line." | |
6f480c7a SM |
1548 | (/ (current-indentation) python-indent)) |
1549 | ||
1550 | ;; Fixme: Consider top-level assignments, imports, &c. | |
1551 | (defun python-current-defun () | |
1552 | "`add-log-current-defun-function' for Python." | |
1553 | (save-excursion | |
1554 | ;; Move up the tree of nested `class' and `def' blocks until we | |
1555 | ;; get to zero indentation, accumulating the defined names. | |
1556 | (let ((start t) | |
1557 | accum) | |
1558 | (while (or start (> (current-indentation) 0)) | |
1559 | (setq start nil) | |
1560 | (python-beginning-of-block) | |
1561 | (end-of-line) | |
1562 | (beginning-of-defun) | |
1563 | (if (looking-at (rx (and (0+ space) (or "def" "class") (1+ space) | |
1564 | (group (1+ (or word (syntax symbol)))) | |
1565 | word-end))) | |
1566 | (push (match-string 1) accum))) | |
1567 | (if accum (mapconcat 'identity accum "."))))) | |
1568 | ||
1569 | (defun python-mark-block () | |
1570 | "Mark the block around point. | |
1571 | Uses `python-beginning-of-block', `python-end-of-block'." | |
1572 | (interactive) | |
1573 | (push-mark) | |
1574 | (python-beginning-of-block) | |
1575 | (push-mark (point) nil t) | |
1576 | (python-end-of-block) | |
1577 | (exchange-point-and-mark)) | |
1578 | \f | |
24d5055c SM |
1579 | ;;;; Completion. |
1580 | ||
1581 | (defun python-symbol-completions (symbol) | |
1582 | "Return a list of completions of the string SYMBOL from Python process. | |
1583 | The list is sorted." | |
1584 | (when symbol | |
1585 | (let ((completions | |
1586 | (condition-case () | |
1587 | (car (read-from-string (python-send-receive | |
1588 | (format "emacs.complete(%S)" symbol)))) | |
1589 | (error nil)))) | |
1590 | (sort | |
1591 | ;; We can get duplicates from the above -- don't know why. | |
1592 | (delete-dups completions) | |
1593 | #'string<)))) | |
1594 | ||
1595 | (defun python-partial-symbol () | |
1596 | "Return the partial symbol before point (for completion)." | |
1597 | (let ((end (point)) | |
1598 | (start (save-excursion | |
1599 | (and (re-search-backward | |
1600 | (rx (and (or buffer-start (regexp "[^[:alnum:]._]")) | |
1601 | (group (1+ (regexp "[[:alnum:]._]"))) | |
1602 | point)) | |
1603 | nil t) | |
1604 | (match-beginning 1))))) | |
1605 | (if start (buffer-substring-no-properties start end)))) | |
1606 | ||
1607 | ;; Fixme: We should have an abstraction of this sort of thing in the | |
1608 | ;; core. | |
1609 | (defun python-complete-symbol () | |
1610 | "Perform completion on the Python symbol preceding point. | |
1611 | Repeating the command scrolls the completion window." | |
1612 | (interactive) | |
1613 | (let ((window (get-buffer-window "*Completions*"))) | |
1614 | (if (and (eq last-command this-command) | |
1615 | window (window-live-p window) (window-buffer window) | |
1616 | (buffer-name (window-buffer window))) | |
1617 | (with-current-buffer (window-buffer window) | |
1618 | (if (pos-visible-in-window-p (point-max) window) | |
1619 | (set-window-start window (point-min)) | |
1620 | (save-selected-window | |
1621 | (select-window window) | |
1622 | (scroll-up)))) | |
1623 | ;; Do completion. | |
1624 | (let* ((end (point)) | |
1625 | (symbol (python-partial-symbol)) | |
1626 | (completions (python-symbol-completions symbol)) | |
1627 | (completion (if completions | |
1628 | (try-completion symbol completions)))) | |
1629 | (when symbol | |
1630 | (cond ((eq completion t)) | |
1631 | ((null completion) | |
1632 | (message "Can't find completion for \"%s\"" symbol) | |
1633 | (ding)) | |
1634 | ((not (string= symbol completion)) | |
1635 | (delete-region (- end (length symbol)) end) | |
1636 | (insert completion)) | |
1637 | (t | |
1638 | (message "Making completion list...") | |
1639 | (with-output-to-temp-buffer "*Completions*" | |
1640 | (display-completion-list completions)) | |
1641 | (message "Making completion list...%s" "done")))))))) | |
1642 | ||
1643 | (eval-when-compile (require 'hippie-exp)) | |
1644 | ||
1645 | (defun python-try-complete (old) | |
1646 | "Completion function for Python for use with `hippie-expand'." | |
1647 | (when (eq major-mode 'python-mode) ; though we only add it locally | |
1648 | (unless old | |
1649 | (let ((symbol (python-partial-symbol))) | |
1650 | (he-init-string (- (point) (length symbol)) (point)) | |
1651 | (if (not (he-string-member he-search-string he-tried-table)) | |
1652 | (push he-search-string he-tried-table)) | |
1653 | (setq he-expand-list | |
1654 | (and symbol (python-symbol-completions symbol))))) | |
1655 | (while (and he-expand-list | |
1656 | (he-string-member (car he-expand-list) he-tried-table)) | |
1657 | (pop he-expand-list)) | |
1658 | (if he-expand-list | |
1659 | (progn | |
1660 | (he-substitute-string (pop he-expand-list)) | |
1661 | t) | |
1662 | (if old (he-reset-string)) | |
1663 | nil))) | |
1664 | \f | |
6f480c7a SM |
1665 | ;;;; Modes. |
1666 | ||
0578dead SM |
1667 | (defvar outline-heading-end-regexp) |
1668 | (defvar eldoc-print-current-symbol-info-function) | |
24d5055c | 1669 | |
6f480c7a SM |
1670 | ;;;###autoload |
1671 | (define-derived-mode python-mode fundamental-mode "Python" | |
1672 | "Major mode for editing Python files. | |
1673 | Turns on Font Lock mode unconditionally since it is required for correct | |
1674 | parsing of the source. | |
1675 | See also `jython-mode', which is actually invoked if the buffer appears to | |
0578dead SM |
1676 | contain Jython code. See also `run-python' and associated Python mode |
1677 | commands for running Python under Emacs. | |
6f480c7a SM |
1678 | |
1679 | The Emacs commands which work with `defun's, e.g. \\[beginning-of-defun], deal | |
1680 | with nested `def' and `class' blocks. They take the innermost one as | |
0578dead SM |
1681 | current without distinguishing method and class definitions. Used multiple |
1682 | times, they move over others at the same indentation level until they reach | |
1683 | the end of definitions at that level, when they move up a level. | |
6f480c7a SM |
1684 | \\<python-mode-map> |
1685 | Colon is electric: it outdents the line if appropriate, e.g. for | |
1686 | an else statement. \\[python-backspace] at the beginning of an indented statement | |
1687 | deletes a level of indentation to close the current block; otherwise it | |
1688 | deletes a charcter backward. TAB indents the current line relative to | |
1689 | the preceding code. Successive TABs, with no intervening command, cycle | |
1690 | through the possibilities for indentation on the basis of enclosing blocks. | |
1691 | ||
0578dead SM |
1692 | \\[fill-paragraph] fills comments and multiline strings appropriately, but has no |
1693 | effect outside them. | |
1694 | ||
1695 | Supports Eldoc mode (only for functions, using a Python process), | |
1696 | Info-Look and Imenu. In Outline minor mode, `class' and `def' | |
1697 | lines count as headers. | |
1698 | ||
6f480c7a SM |
1699 | \\{python-mode-map}" |
1700 | :group 'python | |
1701 | (set (make-local-variable 'font-lock-defaults) | |
1702 | '(python-font-lock-keywords nil nil ((?_ . "w")) nil | |
1703 | (font-lock-syntactic-keywords | |
1704 | . python-font-lock-syntactic-keywords) | |
1705 | ;;; This probably isn't worth it. | |
1706 | ;;; (font-lock-syntactic-face-function | |
1707 | ;;; . python-font-lock-syntactic-face-function) | |
1708 | )) | |
1709 | (set (make-local-variable 'parse-sexp-lookup-properties) t) | |
1710 | (set (make-local-variable 'comment-start) "# ") | |
24d5055c | 1711 | (set (make-local-variable 'comment-indent-function) #'python-comment-indent) |
6f480c7a SM |
1712 | (set (make-local-variable 'indent-line-function) #'python-indent-line) |
1713 | (set (make-local-variable 'paragraph-start) "\\s-*$") | |
24d5055c | 1714 | (set (make-local-variable 'fill-paragraph-function) 'python-fill-paragraph) |
68e44273 | 1715 | (set (make-local-variable 'require-final-newline) mode-require-final-newline) |
6f480c7a SM |
1716 | (set (make-local-variable 'add-log-current-defun-function) |
1717 | #'python-current-defun) | |
1718 | ;; Fixme: Generalize to do all blocks? | |
0578dead SM |
1719 | (set (make-local-variable 'outline-regexp) "\\s-*\\(def\\|class\\)\\>") |
1720 | (set (make-local-variable 'outline-heading-end-regexp) ":\\s-*\n") | |
6f480c7a SM |
1721 | (set (make-local-variable 'outline-level) #'python-outline-level) |
1722 | (set (make-local-variable 'open-paren-in-column-0-is-defun-start) nil) | |
1723 | (make-local-variable 'python-saved-check-command) | |
1724 | (set (make-local-variable 'beginning-of-defun-function) | |
1725 | 'python-beginning-of-defun) | |
1726 | (set (make-local-variable 'end-of-defun-function) 'python-end-of-defun) | |
1727 | (setq imenu-create-index-function #'python-imenu-create-index) | |
0578dead SM |
1728 | (set (make-local-variable 'eldoc-print-current-symbol-info-function) |
1729 | #'python-eldoc-function) | |
1730 | (add-hook 'eldoc-mode-hook | |
1731 | '(lambda () (run-python 0 t)) nil t) ; need it running | |
24d5055c SM |
1732 | (if (featurep 'hippie-exp) |
1733 | (set (make-local-variable 'hippie-expand-try-functions-list) | |
1734 | (cons 'python-try-complete hippie-expand-try-functions-list))) | |
6f480c7a SM |
1735 | (unless font-lock-mode (font-lock-mode 1)) |
1736 | (when python-guess-indent (python-guess-indent)) | |
1737 | (set (make-local-variable 'python-command) python-python-command) | |
1738 | (unless (boundp 'python-mode-running) ; kill the recursion from jython-mode | |
1739 | (let ((python-mode-running t)) | |
1740 | (python-maybe-jython)))) | |
1741 | ||
1742 | (custom-add-option 'python-mode-hook 'imenu-add-menubar-index) | |
1743 | (custom-add-option 'python-mode-hook | |
1744 | '(lambda () | |
1745 | "Turn on Indent Tabs mode." | |
1746 | (set (make-local-variable 'indent-tabs-mode) t))) | |
0578dead | 1747 | (custom-add-option 'python-mode-hook 'turn-on-eldoc-mode) |
6f480c7a SM |
1748 | |
1749 | ;;;###autoload | |
1750 | (define-derived-mode jython-mode python-mode "Jython" | |
1751 | "Major mode for editing Jython files. | |
1752 | Like `python-mode', but sets up parameters for Jython subprocesses. | |
1753 | Runs `jython-mode-hook' after `python-mode-hook'." | |
1754 | :group 'python | |
1755 | (set (make-local-variable 'python-command) python-jython-command)) | |
1756 | ||
1757 | (provide 'python) | |
1758 | ;; arch-tag: 6fce1d99-a704-4de9-ba19-c6e4912b0554 | |
1759 | ;;; python.el ends here |