annotate Misc/python-mode.el @ 6555:a5f7eb869f21 legacy-trunk

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