cpython-lru_cache-weakref: Misc/python-mode.el annotate

annotate Misc/python-mode.el @ 10875:1821e64e08fc legacy-trunk

(py-statement-closes-block-p): Add a py-goto-initial-line which fixes indentation when the return value is a multiline sexp: def bug(): try: if 2>1: return (11+ 12) else: #XXX return 12 except: return 13

author	Barry Warsaw <barry@python.org>
date	Mon, 24 May 1999 18:37:57 +0000
parents	a86fe1f3cf4e
children	17ae178a3038

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
7262 c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	5 ;; Author: 1995-1998 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
9456 1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	11 (defconst py-version "$Revision$"
5968 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
9028 65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	24 ;; subsequently left the net; in 1995, Barry Warsaw inherited the mode
9456 1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	25 ;; and is the current maintainer. Tim's now back but disavows all
1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	26 ;; responsibility for the mode. Smart Tim :-)
6836 0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	27
0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	28 ;; This version of python-mode.el is no longer compatible with Emacs
9028 65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	29 ;; 18. I am striving to maintain compatibility with the X/Emacs 19
65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	30 ;; lineage but as time goes on that becomes more and more difficult.
65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	31 ;; I current recommend that you upgrade to the latest stable released
9456 1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	32 ;; version of your favorite branch: Emacs 20.3 or better, or XEmacs
1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	33 ;; 20.4 or better (XEmacs 21.0 is in beta testing as of this writing
1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	34 ;; 27-Oct-1998 appears to work fine with this version of
1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	35 ;; python-mode.el). Even Windows users should be using at least
1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	36 ;; NTEmacs 20.3, and XEmacs 21.0 will work very nicely on Windows when
1afdc5580157 #Some minor changes in the commentary, obstensibly to test the new Barry Warsaw <barry@python.org> parents: 9454 diff changeset	37 ;; it is released.
6836 0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	38
0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	39 ;; FOR MORE INFORMATION:
0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	40
9028 65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	41 ;; For more information on installing python-mode.el, especially with
65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	42 ;; respect to compatibility information, please see
65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	43 ;;
65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	44 ;; http://www.python.org/emacs/python-mode/
65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	45 ;;
65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	46 ;; This site also contains links to other packages that you might find
65139719b656 Update commentary. For most stuff, point people to the web page Barry Warsaw <barry@python.org> parents: 9027 diff changeset	47 ;; useful, such as pdb interfaces, OO-Browser links, etc.
6836 0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	48
0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	49 ;; BUG REPORTING:
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	50
6544 d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	51 ;; 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	52 ;; 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	53 ;; 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	54
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	55 ;; When in a Python mode buffer, do a C-h m for more help. It's
6836 0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	56 ;; doubtful that a texinfo manual would be very useful, but if you
0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	57 ;; want to contribute one, I'll certainly accept it!
2543 1a448dd84edc (py-submit-bug-report): fixed summary querying Barry Warsaw <barry@python.org> parents: 2537 diff changeset	58
6836 0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	59 ;; TO DO LIST:
0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	60
0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	61 ;; - Better integration with pdb.py and gud-mode for debugging.
2543 1a448dd84edc (py-submit-bug-report): fixed summary querying Barry Warsaw <barry@python.org> parents: 2537 diff changeset	62 ;; - Rewrite according to GNU Emacs Lisp standards.
3905 97e7011fb1b1 #comment update Barry Warsaw <barry@python.org> parents: 3904 diff changeset	63 ;; - have py-execute-region on indented code act as if the region is
6836 0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	64 ;; left justified. Avoids syntax errors.
0255b5ecde10 Update to the Big Comment at the top of the file. It should better Barry Warsaw <barry@python.org> parents: 6767 diff changeset	65 ;; - add a py-goto-block-down, bound to C-c C-d
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	66
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	67 ;;; Code:
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	68
9027 d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	69 (require 'comint)
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	70 (require 'custom)
6695 b9fcb9a34332 Require 'cl when compiling so that the push macro gets picked in Emacs Barry Warsaw <barry@python.org> parents: 6683 diff changeset	71 (eval-when-compile
6725 283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	72 (require 'cl)
7724 1bb943cd2c23 #minor change to eval-while-compile so that it must both find Barry Warsaw <barry@python.org> parents: 7723 diff changeset	73 (if (not (and (condition-case nil
1bb943cd2c23 #minor change to eval-while-compile so that it must both find Barry Warsaw <barry@python.org> parents: 7723 diff changeset	74 (require 'custom)
1bb943cd2c23 #minor change to eval-while-compile so that it must both find Barry Warsaw <barry@python.org> parents: 7723 diff changeset	75 (error nil))
1bb943cd2c23 #minor change to eval-while-compile so that it must both find Barry Warsaw <barry@python.org> parents: 7723 diff changeset	76 ;; Stock Emacs 19.34 has a broken/old Custom library
1bb943cd2c23 #minor change to eval-while-compile so that it must both find Barry Warsaw <barry@python.org> parents: 7723 diff changeset	77 ;; that does more harm than good. Fortunately, it is
1bb943cd2c23 #minor change to eval-while-compile so that it must both find Barry Warsaw <barry@python.org> parents: 7723 diff changeset	78 ;; missing defcustom
1bb943cd2c23 #minor change to eval-while-compile so that it must both find Barry Warsaw <barry@python.org> parents: 7723 diff changeset	79 (fboundp 'defcustom)))
6725 283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	80 (error "STOP! STOP! STOP! STOP!
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	81
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	82 The Custom library was not found or is out of date. A more current
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	83 version is required. Please download and install the latest version
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	84 of the Custom library from:
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	85
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	86 <http://www.dina.kvl.dk/~abraham/custom/>
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	87
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	88 See the Python Mode home page for details:
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	89
9458 e7d984f266cc (py-imenu-method-regexp): Fix suggested by Daniel Calvelo to Barry Warsaw <barry@python.org> parents: 9457 diff changeset	90 <http://www.python.org/emacs/python-mode>
6725 283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	91 ")))
283d1ca585d9 Test for an up-to-date Custom library when byte-compiling, and issue Barry Warsaw <barry@python.org> parents: 6695 diff changeset	92
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	93
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	94
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	95 ;; user definable variables
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	96 ;; vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	97
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	98 (defgroup python nil
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	99 "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	100 :group 'languages)
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	101
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	102 (defcustom py-python-command "python"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	103 "*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	104 :type 'string
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	105 :group 'python)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	106
7950 9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	107 (defcustom py-jpython-command "jpython"
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	108 "*Shell command used to start the JPython interpreter."
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	109 :type 'string
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	110 :group 'python)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	111
10207 29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	112 (defcustom py-default-interpreter 'cpython
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	113 "*Which Python interpreter is used by default.
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	114 The value for this variable can be either `cpython' or `jpython'.
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	115
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	116 When the value is `cpython', the variables `py-python-command' and
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	117 `py-python-command-args' are consulted to determine the interpreter
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	118 and arguments to use.
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	119
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	120 When the value is `jpython', the variables `py-jpython-command' and
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	121 `py-jpython-command-args' are consulted to determine the interpreter
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	122 and arguments to use.
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	123
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	124 Note that this variable is consulted only the first time that a Python
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	125 interpreter shell is started during an Emacs session. After that, use
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	126 \\[py-toggle-shells] to change the interpreter shell."
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	127 :type '(choice (const :tag "Python (a.k.a. CPython)" cpython)
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	128 (const :tag "JPython" jpython))
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	129 :group 'python)
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	130
7197 26d07735ba4a (py-python-command-args): New variable, allows user to customize the Barry Warsaw <barry@python.org> parents: 7152 diff changeset	131 (defcustom py-python-command-args '("-i")
26d07735ba4a (py-python-command-args): New variable, allows user to customize the Barry Warsaw <barry@python.org> parents: 7152 diff changeset	132 "*List of string arguments to be used when starting a Python shell."
26d07735ba4a (py-python-command-args): New variable, allows user to customize the Barry Warsaw <barry@python.org> parents: 7152 diff changeset	133 :type '(repeat string)
26d07735ba4a (py-python-command-args): New variable, allows user to customize the Barry Warsaw <barry@python.org> parents: 7152 diff changeset	134 :group 'python)
26d07735ba4a (py-python-command-args): New variable, allows user to customize the Barry Warsaw <barry@python.org> parents: 7152 diff changeset	135
7950 9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	136 (defcustom py-jpython-command-args '("-i")
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	137 "*List of string arguments to be used when starting a JPython shell."
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	138 :type '(repeat string)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	139 :group 'python)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	140
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	141 (defcustom py-indent-offset 4
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	142 "*Amount of offset per level of indentation.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	143 `\\[py-guess-indent-offset]' can usually guess a good value when
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	144 you're editing someone else's Python code."
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	145 :type 'integer
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	146 :group 'python)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	147
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	148 (defcustom py-smart-indentation t
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	149 "*Should `python-mode' try to automagically set some indentation variables?
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	150 When this variable is non-nil, two things happen when a buffer is set
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	151 to `python-mode':
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	152
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	153 1. `py-indent-offset' is guess from existing code in the buffer.
7699 96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	154 Only guessed values between 2 and 8 are considered. If a valid
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	155 guess can't be made (perhaps because you are visiting a new
7699 96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	156 file), then the value in `py-indent-offset' is used.
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	157
7699 96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	158 2. `indent-tabs-mode' is turned off if `py-indent-offset' does not
96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	159 equal `tab-width' (`indent-tabs-mode' is never turned on by
96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	160 Python mode). This means that for newly written code, tabs are
96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	161 only inserted in indentation if one tab is one indentation
96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	162 level, otherwise only spaces are used.
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	163
7676 bdcf708ae4da #(py-smart-indentation): Small fixes for clarity in the docstring. Barry Warsaw <barry@python.org> parents: 7675 diff changeset	164 Note that both these settings occur after `python-mode-hook' is run,
bdcf708ae4da #(py-smart-indentation): Small fixes for clarity in the docstring. Barry Warsaw <barry@python.org> parents: 7675 diff changeset	165 so if you want to defeat the automagic configuration, you must also
bdcf708ae4da #(py-smart-indentation): Small fixes for clarity in the docstring. Barry Warsaw <barry@python.org> parents: 7675 diff changeset	166 set `py-smart-indentation' to nil in your `python-mode-hook'."
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	167 :type 'boolean
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	168 :group 'python)
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	169
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	170 (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	171 "*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	172 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	173 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	174 lines are aligned to column zero."
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	175 :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	176 (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	177 :group 'python)
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	178
9136 e1b710e30acf (py-block-comment-prefix): Remove trailing space. Also explain that Barry Warsaw <barry@python.org> parents: 9106 diff changeset	179 (defcustom py-block-comment-prefix "##"
3445 07977bf0d997 (py-comment-region): obsoleted by comment-region Barry Warsaw <barry@python.org> parents: 3436 diff changeset	180 "*String used by \\[comment-region] to comment out a block of code.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	181 This should follow the convention for non-indenting comment lines so
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	182 that the indentation commands won't get confused (i.e., the string
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	183 should be of the form `#x...' where `x' is not a blank or a tab, and
9136 e1b710e30acf (py-block-comment-prefix): Remove trailing space. Also explain that Barry Warsaw <barry@python.org> parents: 9106 diff changeset	184 `...' is arbitrary). However, this string should not end in whitespace."
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	185 :type 'string
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	186 :group 'python)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	187
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	188 (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	189 "*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	190
529f4d9cbe3d (py-honor-comment-indentation, py-compute-indentation): allow other Barry Warsaw <barry@python.org> parents: 3429 diff changeset	191 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	192 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	193
3434 529f4d9cbe3d (py-honor-comment-indentation, py-compute-indentation): allow other Barry Warsaw <barry@python.org> parents: 3429 diff changeset	194 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	195 line indentation. If the previous line is such a comment line (as
8370 f2b0859fece3 #Documentation and comment typos patch given by Michael Ernst. More Barry Warsaw <barry@python.org> parents: 8070 diff changeset	196 opposed to one that starts with `py-block-comment-prefix'), then its
3434 529f4d9cbe3d (py-honor-comment-indentation, py-compute-indentation): allow other Barry Warsaw <barry@python.org> parents: 3429 diff changeset	197 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	198 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	199 purposes.
529f4d9cbe3d (py-honor-comment-indentation, py-compute-indentation): allow other Barry Warsaw <barry@python.org> parents: 3429 diff changeset	200
529f4d9cbe3d (py-honor-comment-indentation, py-compute-indentation): allow other Barry Warsaw <barry@python.org> parents: 3429 diff changeset	201 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	202 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	203 :type '(choice
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	204 (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	205 (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	206 (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	207 other)
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	208 )
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	209 :group 'python)
3429 da86b3b54363 (py-honor-comment-indentation): new variable. Barry Warsaw <barry@python.org> parents: 3428 diff changeset	210
5969 5f6a2eadab97 #Fixed two byte-compiler errors Barry Warsaw <barry@python.org> parents: 5968 diff changeset	211 (defcustom py-temp-directory
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	212 (let ((ok '(lambda (x)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	213 (and x
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	214 (setq x (expand-file-name x)) ; always true
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	215 (file-directory-p x)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	216 (file-writable-p x)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	217 x))))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	218 (or (funcall ok (getenv "TMPDIR"))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	219 (funcall ok "/usr/tmp")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	220 (funcall ok "/tmp")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	221 (funcall ok ".")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	222 (error
7480 55c3fd1853ce (py-temp-directory): Minor docstring nit. Barry Warsaw <barry@python.org> parents: 7478 diff changeset	223 "Couldn't find a usable temp directory -- set `py-temp-directory'")))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	224 "Directory used for temp files created by a Python* process.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	225 By default, the first directory from this list that exists and that you
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	226 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	227 /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	228 :type 'string
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	229 :group 'python)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	230
5969 5f6a2eadab97 #Fixed two byte-compiler errors Barry Warsaw <barry@python.org> parents: 5968 diff changeset	231 (defcustom py-beep-if-tab-change t
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	232 "*Ring the bell if `tab-width' is changed.
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	233 If a comment of the form
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	234
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	235 \t# vi:set tabsize=<number>:
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	236
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	237 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	238 current value of (the general Emacs variable) `tab-width' does not
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	239 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	240 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	241 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	242 :type 'boolean
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	243 :group 'python)
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	244
6731 21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	245 (defcustom py-jump-on-exception t
21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	246 "Jump to innermost exception frame in Python Output* buffer.
8924 0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	247 When this variable is non-nil and an exception occurs when running
6731 21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	248 Python code synchronously in a subprocess, jump immediately to the
8924 0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	249 source code of the innermost traceback frame."
8381 822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	250 :type 'boolean
822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	251 :group 'python)
822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	252
822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	253 (defcustom py-ask-about-save t
822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	254 "If not nil, ask about which buffers to save before executing some code.
822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	255 Otherwise, all modified buffers are saved without asking."
822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	256 :type 'boolean
822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	257 :group 'python)
6731 21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	258
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	259 (defcustom py-backspace-function 'backward-delete-char-untabify
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	260 "*Function called by `py-electric-backspace' when deleting backwards."
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	261 :type 'function
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	262 :group 'python)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	263
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	264 (defcustom py-delete-function 'delete-char
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	265 "*Function called by `py-electric-delete' when deleting forwards."
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	266 :type 'function
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	267 :group 'python)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	268
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	269 (defcustom py-imenu-show-method-args-p nil
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	270 "*Controls echoing of arguments of functions & methods in the Imenu buffer.
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	271 When non-nil, arguments are printed."
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	272 :type 'boolean
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	273 :group 'python)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	274 (make-variable-buffer-local 'py-indent-offset)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	275
7142 aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	276 ;; Not customizable
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	277 (defvar py-master-file nil
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	278 "If non-nil, execute the named file instead of the buffer's file.
7478 80739b0bc302 (py-master-file): Fixed some typos in the docstring. Barry Warsaw <barry@python.org> parents: 7262 diff changeset	279 The intent is to allow you to set this variable in the file's local
7142 aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	280 variable section, e.g.:
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	281
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	282 # Local Variables:
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	283 # py-master-file: \"master.py\"
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	284 # End:
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	285
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	286 so that typing \\[py-execute-buffer] in that buffer executes the named
9454 e5996279f58c #Fixed some typos in docstrings. Barry Warsaw <barry@python.org> parents: 9144 diff changeset	287 master file instead of the buffer's file. If the file name has a
e5996279f58c #Fixed some typos in docstrings. Barry Warsaw <barry@python.org> parents: 9144 diff changeset	288 relative path, the value of variable `default-directory' for the
e5996279f58c #Fixed some typos in docstrings. Barry Warsaw <barry@python.org> parents: 9144 diff changeset	289 buffer is prepended to come up with a file name.")
7142 aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	290 (make-variable-buffer-local 'py-master-file)
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	291
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	292
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	293
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	294 ;; ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	295 ;; 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	296
6562 53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	297 (defconst py-emacs-features
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	298 (let (features)
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	299 ;; NTEmacs 19.34.6 has a broken make-temp-name; it always returns
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	300 ;; the same string.
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	301 (let ((tmp1 (make-temp-name ""))
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	302 (tmp2 (make-temp-name "")))
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	303 (if (string-equal tmp1 tmp2)
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	304 (push 'broken-temp-names features)))
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	305 ;; return the features
53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	306 features)
6232 fc5e1e004994 (py-parse-partial-sexp-works-p): Removed as obsolete. All current Barry Warsaw <barry@python.org> parents: 5969 diff changeset	307 "A list of features extant in the Emacs you are using.
6565 e1c8d7182d66 #(py-emacs-features): Fixed typo in docstring. Barry Warsaw <barry@python.org> parents: 6564 diff changeset	308 There are many flavors of Emacs out there, with different levels of
e1c8d7182d66 #(py-emacs-features): Fixed typo in docstring. Barry Warsaw <barry@python.org> parents: 6564 diff changeset	309 support for features needed by `python-mode'.")
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	310
5150 4665e2849a4a (python-font-lock-keywords): Use new convention for installing in mode Barry Warsaw <barry@python.org> parents: 5075 diff changeset	311 (defvar python-font-lock-keywords
6564 812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	312 (let ((kw1 (mapconcat 'identity
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	313 '("and" "assert" "break" "class"
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	314 "continue" "def" "del" "elif"
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	315 "else" "except" "exec" "for"
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	316 "from" "global" "if" "import"
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	317 "in" "is" "lambda" "not"
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	318 "or" "pass" "print" "raise"
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	319 "return" "while"
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	320 )
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	321 "\\\|"))
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	322 (kw2 (mapconcat 'identity
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	323 '("else:" "except:" "finally:" "try:")
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	324 "\\\|"))
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	325 )
3427 af5ff5231d4a (python-font-lock-keywords): Much improved descrimination between Barry Warsaw <barry@python.org> parents: 3426 diff changeset	326 (list
6563 2aa13c0c8f2f (python-font-lock-keywords): Fix for consecutive keyword font locking, Barry Warsaw <barry@python.org> parents: 6562 diff changeset	327 ;; keywords
6564 812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	328 (cons (concat "\\b\$" kw1 "\$\\b[ \n\t(]") 1)
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	329 ;; block introducing keywords with immediately following colons.
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	330 ;; Yes "except" is in both lists.
812aad8c05c2 (python-font-lock-keywords): Pick up block introducing keywords with Barry Warsaw <barry@python.org> parents: 6563 diff changeset	331 (cons (concat "\\b\$" kw2 "\$[ \n\t(]") 1)
3427 af5ff5231d4a (python-font-lock-keywords): Much improved descrimination between Barry Warsaw <barry@python.org> parents: 3426 diff changeset	332 ;; classes
af5ff5231d4a (python-font-lock-keywords): Much improved descrimination between Barry Warsaw <barry@python.org> parents: 3426 diff changeset	333 '("\\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	334 1 font-lock-type-face)
af5ff5231d4a (python-font-lock-keywords): Much improved descrimination between Barry Warsaw <barry@python.org> parents: 3426 diff changeset	335 ;; functions
af5ff5231d4a (python-font-lock-keywords): Much improved descrimination between Barry Warsaw <barry@python.org> parents: 3426 diff changeset	336 '("\\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	337 1 font-lock-function-name-face)
af5ff5231d4a (python-font-lock-keywords): Much improved descrimination between Barry Warsaw <barry@python.org> parents: 3426 diff changeset	338 ))
3436 db9f6ede58a7 (python-font-lock-keywords): make it a defconst Barry Warsaw <barry@python.org> parents: 3434 diff changeset	339 "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	340 (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	341
6668 98552704b88f (python-mode): Patch to fix Imenu support under Emacs, given by Barry Warsaw <barry@python.org> parents: 6667 diff changeset	342 ;; have to bind py-file-queue before installing the kill-emacs-hook
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	343 (defvar py-file-queue nil
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	344 "Queue of Python temp files awaiting execution.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	345 Currently-active file is at the head of the list.")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	346
5968 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 ;; Constants
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	349
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	350 (defconst py-stringlit-re
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	351 (concat
8379 f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	352 ;; These fail if backslash-quote ends the string (not worth
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	353 ;; fixing?). They precede the short versions so that the first two
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	354 ;; quotes don't look like an empty short string.
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	355 ;;
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	356 ;; (maybe raw), long single quoted triple quoted strings (SQTQ),
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	357 ;; with potential embedded single quotes
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	358 "[rR]?'''[^']\$\\('[^']\\\|''[^']\$[^']\\)*'''"
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	359 "\\\|"
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	360 ;; (maybe raw), long double quoted triple quoted strings (DQTQ),
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	361 ;; with potential embedded double quotes
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	362 "[rR]?\"\"\"[^\"]\$\\(\"[^\"]\\\|\"\"[^\"]\$[^\"]\\)*\"\"\""
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	363 "\\\|"
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	364 "[rR]?'\$[^'\n\\]\\\|\\\\.\$*'" ; single-quoted
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	365 "\\\|" ; or
8379 f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	366 "[rR]?\"\$[^\"\n\\]\\\|\\\\.\$*\"" ; double-quoted
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	367 )
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	368 "Regular expression matching a Python string literal.")
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	369
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	370 (defconst py-continued-re
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	371 ;; This is tricky because a trailing backslash does not mean
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	372 ;; continuation if it's in a comment
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	373 (concat
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	374 "\$" "[^#'\"\n\\]" "\\\|" py-stringlit-re "\$*"
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	375 "\\\\$")
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	376 "Regular expression matching Python backslash continuation lines.")
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	377
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	378 (defconst py-blank-or-comment-re "[ \t]*\$$\\\|#\$"
8911 9a984276cc56 #Typos from previous checkin Barry Warsaw <barry@python.org> parents: 8910 diff changeset	379 "Regular expression matching a blank or comment line.")
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	380
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	381 (defconst py-outdent-re
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	382 (concat "\\(" (mapconcat 'identity
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	383 '("else:"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	384 "except\$\\s +.*\$?:"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	385 "finally:"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	386 "elif\\s +.*:")
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	387 "\\\|")
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	388 "\\)")
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	389 "Regular expression matching statements to be dedented one level.")
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	390
6544 d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	391 (defconst py-block-closing-keywords-re
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	392 "\$return\\\|raise\\\|break\\\|continue\\\|pass\$"
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	393 "Regular expression matching keywords which typically close a block.")
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	394
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	395 (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	396 (concat
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	397 "\\("
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	398 (mapconcat 'identity
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	399 (list "try:"
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	400 "except\$\\s +.*\$?:"
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	401 "while\\s +.*:"
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	402 "for\\s +.*:"
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	403 "if\\s +.*:"
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	404 "elif\\s +.*:"
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	405 (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	406 )
d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	407 "\\\|")
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	408 "\\)")
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	409 "Regular expression matching lines not to dedent after.")
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	410
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	411 (defconst py-defun-start-re
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	412 "^\$[ \t]\$def[ \t]+\$[a-zA-Z_0-9]+\$\\\|\$^[a-zA-Z_0-9]+\$[ \t]="
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	413 ;; If you change this, you probably have to change py-current-defun
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	414 ;; as well. This is only used by py-current-defun to find the name
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	415 ;; for add-log.el.
8911 9a984276cc56 #Typos from previous checkin Barry Warsaw <barry@python.org> parents: 8910 diff changeset	416 "Regular expression matching a function, method, or variable assignment.")
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	417
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	418 (defconst py-class-start-re "^class[ \t]*\$[a-zA-Z_0-9]+\$"
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	419 ;; If you change this, you probably have to change py-current-defun
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	420 ;; as well. This is only used by py-current-defun to find the name
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	421 ;; for add-log.el.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	422 "Regular expression for finding a class name.")
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	423
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	424 (defconst py-traceback-line-re
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	425 "[ \t]+File \"\$[^\"]+\$\", line \$[0-9]+\$"
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	426 "Regular expression that describes tracebacks.")
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	427
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	428
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	429
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	430 ;; Major mode boilerplate
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	431
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	432 ;; define a mode-specific abbrev table for those who use such things
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	433 (defvar python-mode-abbrev-table nil
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	434 "Abbrev table in use in `python-mode' buffers.")
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	435 (define-abbrev-table 'python-mode-abbrev-table nil)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	436
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	437 (defvar python-mode-hook nil
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	438 "*Hook called by `python-mode'.")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	439
8370 f2b0859fece3 #Documentation and comment typos patch given by Michael Ernst. More Barry Warsaw <barry@python.org> parents: 8070 diff changeset	440 ;; In previous version of python-mode.el, the hook was incorrectly
f2b0859fece3 #Documentation and comment typos patch given by Michael Ernst. More Barry Warsaw <barry@python.org> parents: 8070 diff changeset	441 ;; called py-mode-hook, and was not defvar'd. Deprecate its use.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	442 (and (fboundp 'make-obsolete-variable)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	443 (make-obsolete-variable 'py-mode-hook 'python-mode-hook))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	444
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	445 (defvar py-mode-map ()
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	446 "Keymap used in `python-mode' buffers.")
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	447 (if py-mode-map
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	448 nil
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	449 (setq py-mode-map (make-sparse-keymap))
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	450 ;; electric keys
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	451 (define-key py-mode-map ":" 'py-electric-colon)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	452 ;; indentation level modifiers
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	453 (define-key py-mode-map "\C-c\C-l" 'py-shift-region-left)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	454 (define-key py-mode-map "\C-c\C-r" 'py-shift-region-right)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	455 (define-key py-mode-map "\C-c<" 'py-shift-region-left)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	456 (define-key py-mode-map "\C-c>" 'py-shift-region-right)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	457 ;; subprocess commands
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	458 (define-key py-mode-map "\C-c\C-c" 'py-execute-buffer)
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	459 (define-key py-mode-map "\C-c\C-m" 'py-execute-import-or-reload)
8380 cd2dfed0c44b (py-execute-string): Bind to C-c C-s, and put on menu Barry Warsaw <barry@python.org> parents: 8379 diff changeset	460 (define-key py-mode-map "\C-c\C-s" 'py-execute-string)
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	461 (define-key py-mode-map "\C-c\|" 'py-execute-region)
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	462 (define-key py-mode-map "\e\C-x" 'py-execute-def-or-class)
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	463 (define-key py-mode-map "\C-c!" 'py-shell)
7950 9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	464 (define-key py-mode-map "\C-c\C-t" 'py-toggle-shells)
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	465 ;; Caution! Enter here at your own risk. We are trying to support
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	466 ;; several behaviors and it gets disgusting. :-( This logic ripped
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	467 ;; largely from CC Mode.
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	468 ;;
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	469 ;; In XEmacs 19, Emacs 19, and Emacs 20, we use this to bind
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	470 ;; backwards deletion behavior to DEL, which both Delete and
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	471 ;; Backspace get translated to. There's no way to separate this
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	472 ;; behavior in a clean way, so deal with it! Besides, it's been
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	473 ;; this way since the dawn of time.
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	474 (if (not (boundp 'delete-key-deletes-forward))
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	475 (define-key py-mode-map "\177" 'py-electric-backspace)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	476 ;; However, XEmacs 20 actually achieved enlightenment. It is
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	477 ;; possible to sanely define both backward and forward deletion
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	478 ;; behavior under X separately (TTYs are forever beyond hope, but
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	479 ;; who cares? XEmacs 20 does the right thing with these too).
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	480 (define-key py-mode-map [delete] 'py-electric-delete)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	481 (define-key py-mode-map [backspace] 'py-electric-backspace))
6677 e45b83708d9e (py-mode-map): Bind py-mark-def-or-class to C-M-h with a different Barry Warsaw <barry@python.org> parents: 6670 diff changeset	482 ;; Separate M-BS from C-M-h. The former should remain
e45b83708d9e (py-mode-map): Bind py-mark-def-or-class to C-M-h with a different Barry Warsaw <barry@python.org> parents: 6670 diff changeset	483 ;; backward-kill-word.
e45b83708d9e (py-mode-map): Bind py-mark-def-or-class to C-M-h with a different Barry Warsaw <barry@python.org> parents: 6670 diff changeset	484 (define-key py-mode-map [(control meta h)] 'py-mark-def-or-class)
6559 1a233be5fc17 (mark-python-def-or-class): Renamed to py-mark-def-or-class globally. Barry Warsaw <barry@python.org> parents: 6556 diff changeset	485 (define-key py-mode-map "\C-c\C-k" 'py-mark-block)
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	486 ;; Miscellaneous
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	487 (define-key py-mode-map "\C-c:" 'py-guess-indent-offset)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	488 (define-key py-mode-map "\C-c\t" 'py-indent-region)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	489 (define-key py-mode-map "\C-c\C-n" 'py-next-statement)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	490 (define-key py-mode-map "\C-c\C-p" 'py-previous-statement)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	491 (define-key py-mode-map "\C-c\C-u" 'py-goto-block-up)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	492 (define-key py-mode-map "\C-c#" 'py-comment-region)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	493 (define-key py-mode-map "\C-c?" 'py-describe-mode)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	494 (define-key py-mode-map "\C-c\C-hm" 'py-describe-mode)
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	495 (define-key py-mode-map "\e\C-a" 'py-beginning-of-def-or-class)
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	496 (define-key py-mode-map "\e\C-e" 'py-end-of-def-or-class)
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	497 (define-key py-mode-map "\C-c-" 'py-up-exception)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	498 (define-key py-mode-map "\C-c=" 'py-down-exception)
9905 6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	499 ;; stuff that is `standard' but doesn't interface well with
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	500 ;; python-mode, which forces us to rebind to special commands
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	501 (define-key py-mode-map "\C-xnd" 'py-narrow-to-defun)
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	502 ;; information
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	503 (define-key py-mode-map "\C-c\C-b" 'py-submit-bug-report)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	504 (define-key py-mode-map "\C-c\C-v" 'py-version)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	505 ;; shadow global bindings for newline-and-indent w/ the py- version.
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	506 ;; 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	507 ;; for now.
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	508 (mapcar #'(lambda (key)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	509 (define-key py-mode-map key 'py-newline-and-indent))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	510 (where-is-internal 'newline-and-indent))
9927 35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	511 ;; Force RET to be py-newline-and-indent even if it didn't get
35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	512 ;; mapped by the above code. motivation: Emacs' default binding for
35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	513 ;; RET is `newline' and C-j is `newline-and-indent'. Most Pythoneers
35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	514 ;; expect RET to do a `py-newline-and-indent' and any Emacsers who
35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	515 ;; dislike this are probably knowledgeable enough to do a rebind.
35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	516 ;; However, we do not change C-j since many Emacsers have already
35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	517 ;; swapped RET and C-j and they don't want C-j bound to `newline' to
35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	518 ;; change.
35f568480764 (py-mode-map): Add back force of RET (aka C-m) to Barry Warsaw <barry@python.org> parents: 9906 diff changeset	519 (define-key py-mode-map "\C-m" 'py-newline-and-indent)
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	520 )
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	521
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	522 (defvar py-mode-output-map nil
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	523 "Keymap used in Python Output buffers.")
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	524 (if py-mode-output-map
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	525 nil
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	526 (setq py-mode-output-map (make-sparse-keymap))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	527 (define-key py-mode-output-map [button2] 'py-mouseto-exception)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	528 (define-key py-mode-output-map "\C-c\C-c" 'py-goto-exception)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	529 ;; TBD: Disable all self-inserting keys. This is bogus, we should
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	530 ;; really implement this as Python Output buffer being read-only
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	531 (mapcar #' (lambda (key)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	532 (define-key py-mode-output-map key
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	533 #'(lambda () (interactive) (beep))))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	534 (where-is-internal 'self-insert-command))
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	535 )
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	536
9027 d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	537 (defvar py-shell-map nil
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	538 "Keymap used in Python shell buffers.")
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	539 (if py-shell-map
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	540 nil
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	541 (setq py-shell-map (copy-keymap comint-mode-map))
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	542 (define-key py-shell-map [tab] 'tab-to-tab-stop)
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	543 (define-key py-shell-map "\C-c-" 'py-up-exception)
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	544 (define-key py-shell-map "\C-c=" 'py-down-exception)
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	545 )
d53237bcf15f (py-shell-map): New variable contains the keymap used in Python Barry Warsaw <barry@python.org> parents: 9026 diff changeset	546
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	547 (defvar py-mode-syntax-table nil
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	548 "Syntax table used in `python-mode' buffers.")
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	549 (if py-mode-syntax-table
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	550 nil
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	551 (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	552 (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	553 (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	554 (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	555 (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	556 (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	557 (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	558 ;; 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	559 (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	560 (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	561 (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	562 (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	563 (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	564 (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	565 (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	566 (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	567 (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	568 (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	569 (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	570 ;; 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	571 ;; 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	572 ;; 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	573 ;; 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	574 ;; 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	575 ;; 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	576 ;; binding M-f and M-b to py-forward-into-nomenclature and
10207 29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	577 ;; py-backward-into-nomenclature instead. This doesn't help in all
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	578 ;; situations where you'd want the different behavior
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	579 ;; (e.g. backward-kill-word).
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	580 (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	581 ;; 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	582 (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	583 (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	584 ;; backquote is open and close paren
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	585 (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	586 ;; comment delimiters
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	587 (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	588 (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	589 )
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	590
4195 e3f6ada28ed0 I have been increasingly annoyed about the fact that Barry Warsaw <barry@python.org> parents: 4194 diff changeset	591
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	592
9106 ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	593 ;; Utilities
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	594
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	595 (defmacro py-safe (&rest body)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	596 "Safely execute BODY, return nil if an error occurred."
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	597 (` (condition-case nil
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	598 (progn (,@ body))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	599 (error nil))))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	600
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	601 (defsubst py-keep-region-active ()
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	602 "Keep the region active in XEmacs."
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	603 ;; Ignore byte-compiler warnings you might see. Also note that
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	604 ;; FSF's Emacs 19 does it differently; its policy doesn't require us
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	605 ;; to take explicit action.
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	606 (and (boundp 'zmacs-region-stays)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	607 (setq zmacs-region-stays t)))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	608
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	609 (defsubst py-point (position)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	610 "Returns the value of point at certain commonly referenced POSITIONs.
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	611 POSITION can be one of the following symbols:
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	612
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	613 bol -- beginning of line
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	614 eol -- end of line
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	615 bod -- beginning of def or class
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	616 eod -- end of def or class
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	617 bob -- beginning of buffer
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	618 eob -- end of buffer
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	619 boi -- back to indentation
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	620 bos -- beginning of statement
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	621
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	622 This function does not modify point or mark."
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	623 (let ((here (point)))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	624 (cond
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	625 ((eq position 'bol) (beginning-of-line))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	626 ((eq position 'eol) (end-of-line))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	627 ((eq position 'bod) (py-beginning-of-def-or-class))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	628 ((eq position 'eod) (py-end-of-def-or-class))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	629 ;; Kind of funny, I know, but useful for py-up-exception.
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	630 ((eq position 'bob) (beginning-of-buffer))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	631 ((eq position 'eob) (end-of-buffer))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	632 ((eq position 'boi) (back-to-indentation))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	633 ((eq position 'bos) (py-goto-initial-line))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	634 (t (error "Unknown buffer position requested: %s" position))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	635 )
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	636 (prog1
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	637 (point)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	638 (goto-char here))))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	639
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	640 (defsubst py-highlight-line (from to file line)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	641 (cond
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	642 ((fboundp 'make-extent)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	643 ;; XEmacs
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	644 (let ((e (make-extent from to)))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	645 (set-extent-property e 'mouse-face 'highlight)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	646 (set-extent-property e 'py-exc-info (cons file line))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	647 (set-extent-property e 'keymap py-mode-output-map)))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	648 (t
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	649 ;; Emacs -- Please port this!
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	650 )
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	651 ))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	652
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	653 (defun py-in-literal (&optional lim)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	654 "Return non-nil if point is in a Python literal (a comment or string).
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	655 Optional argument LIM indicates the beginning of the containing form,
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	656 i.e. the limit on how far back to scan."
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	657 ;; This is the version used for non-XEmacs, which has a nicer
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	658 ;; interface.
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	659 ;;
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	660 ;; WARNING: Watch out for infinite recursion.
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	661 (let* ((lim (or lim (py-point 'bod)))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	662 (state (parse-partial-sexp lim (point))))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	663 (cond
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	664 ((nth 3 state) 'string)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	665 ((nth 4 state) 'comment)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	666 (t nil))))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	667
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	668 ;; XEmacs has a built-in function that should make this much quicker.
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	669 ;; In this case, lim is ignored
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	670 (defun py-fast-in-literal (&optional lim)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	671 "Fast version of `py-in-literal', used only by XEmacs.
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	672 Optional LIM is ignored."
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	673 ;; don't have to worry about context == 'block-comment
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	674 (buffer-syntactic-context))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	675
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	676 (if (fboundp 'buffer-syntactic-context)
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	677 (defalias 'py-in-literal 'py-fast-in-literal))
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	678
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	679
ce52e922fbb2 #Code rearranging to quiet byte-compiler Barry Warsaw <barry@python.org> parents: 9063 diff changeset	680
3818 3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	681 ;; 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	682 ;; (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	683 (defvar py-menu nil
61b4cae77f7e (py-menu): Create default value Barry Warsaw <barry@python.org> parents: 3937 diff changeset	684 "Menu for Python Mode.
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	685 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	686 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	687
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	688 (and (py-safe (require 'easymenu) t)
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	689 (easy-menu-define
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	690 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	691 '("Python"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	692 ["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	693 ["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	694 "-"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	695 ["Mark current block" py-mark-block t]
6559 1a233be5fc17 (mark-python-def-or-class): Renamed to py-mark-def-or-class globally. Barry Warsaw <barry@python.org> parents: 6556 diff changeset	696 ["Mark current def" py-mark-def-or-class t]
1a233be5fc17 (mark-python-def-or-class): Renamed to py-mark-def-or-class globally. Barry Warsaw <barry@python.org> parents: 6556 diff changeset	697 ["Mark current class" (py-mark-def-or-class t) t]
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	698 "-"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	699 ["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	700 ["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	701 "-"
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	702 ["Import/reload file" py-execute-import-or-reload t]
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	703 ["Execute buffer" py-execute-buffer t]
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	704 ["Execute region" py-execute-region (mark)]
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	705 ["Execute def or class" py-execute-def-or-class (mark)]
8380 cd2dfed0c44b (py-execute-string): Bind to C-c C-s, and put on menu Barry Warsaw <barry@python.org> parents: 8379 diff changeset	706 ["Execute string" py-execute-string t]
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	707 ["Start interpreter..." py-shell t]
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	708 "-"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	709 ["Go to start of block" py-goto-block-up t]
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	710 ["Go to start of class" (py-beginning-of-def-or-class t) t]
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	711 ["Move to end of class" (py-end-of-def-or-class t) t]
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	712 ["Move to start of def" py-beginning-of-def-or-class t]
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	713 ["Move to end of def" py-end-of-def-or-class t]
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	714 "-"
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	715 ["Describe mode" py-describe-mode t]
b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	716 )))
3818 3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	717
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	718
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	719
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	720 ;; Imenu definitions
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	721 (defvar py-imenu-class-regexp
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	722 (concat ; <<classes>>
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	723 "\\(" ;
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	724 "^[ \t]*" ; newline and maybe whitespace
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	725 "\$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	726 ; possibly multiple superclasses
7878 ac2d1c1f1971 (imenu-example--python-class-regexp): Fix to recognize Module.Class in Barry Warsaw <barry@python.org> parents: 7796 diff changeset	727 "\$[ \t]\\((\\([a-zA-Z0-9_,. \t\n]\$)\\)?\\)"
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	728 "[ \t]*:" ; and the final :
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	729 "\\)" ; >>classes<<
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	730 )
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	731 "Regexp for Python classes for use with the Imenu package."
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	732 )
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	733
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	734 (defvar py-imenu-method-regexp
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	735 (concat ; <<methods and functions>>
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	736 "\\(" ;
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	737 "^[ \t]*" ; new line and maybe whitespace
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	738 "\\(def[ \t]+" ; function definitions start with def
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	739 "\$[a-zA-Z0-9_]+\$" ; name is here
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	740 ; function arguments...
9458 e7d984f266cc (py-imenu-method-regexp): Fix suggested by Daniel Calvelo to Barry Warsaw <barry@python.org> parents: 9457 diff changeset	741 ;; "[ \t](\$[-+/a-zA-Z0-9_=,\ \t\n.()\"'#]*\$)"
e7d984f266cc (py-imenu-method-regexp): Fix suggested by Daniel Calvelo to Barry Warsaw <barry@python.org> parents: 9457 diff changeset	742 "[ \t](\$[^:#]\$)"
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	743 "\\)" ; end of def
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	744 "[ \t]*:" ; and then the :
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	745 "\\)" ; >>methods and functions<<
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	746 )
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	747 "Regexp for Python methods/functions for use with the Imenu package."
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	748 )
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	749
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	750 (defvar py-imenu-method-no-arg-parens '(2 8)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	751 "Indices into groups of the Python regexp for use with Imenu.
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	752
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	753 Using these values will result in smaller Imenu lists, as arguments to
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	754 functions are not listed.
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	755
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	756 See the variable `py-imenu-show-method-args-p' for more
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	757 information.")
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	758
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	759 (defvar py-imenu-method-arg-parens '(2 7)
9454 e5996279f58c #Fixed some typos in docstrings. Barry Warsaw <barry@python.org> parents: 9144 diff changeset	760 "Indices into groups of the Python regexp for use with imenu.
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	761 Using these values will result in large Imenu lists, as arguments to
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	762 functions are listed.
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	763
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	764 See the variable `py-imenu-show-method-args-p' for more
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	765 information.")
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	766
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	767 ;; 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	768 ;; 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	769 ;; it.
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	770 (defvar py-imenu-generic-expression
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	771 (cons
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	772 (concat
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	773 py-imenu-class-regexp
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	774 "\\\|" ; or...
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	775 py-imenu-method-regexp
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	776 )
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	777 py-imenu-method-no-arg-parens)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	778 "Generic Python expression which may be used directly with Imenu.
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	779 Used by setting the variable `imenu-generic-expression' to this value.
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	780 Also, see the function \\[py-imenu-create-index] for a better
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	781 alternative for finding the index.")
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	782
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	783 ;; These next two variables are used when searching for the Python
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	784 ;; 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	785 ;; generic-python-expression, really.
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	786 (defvar py-imenu-generic-regexp nil)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	787 (defvar py-imenu-generic-parens nil)
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	788
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	789
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	790 (defun py-imenu-create-index-function ()
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	791 "Python interface function for the Imenu package.
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	792 Finds all Python classes and functions/methods. Calls function
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	793 \\[py-imenu-create-index-engine]. See that function for the details
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	794 of how this works."
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	795 (setq py-imenu-generic-regexp (car py-imenu-generic-expression)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	796 py-imenu-generic-parens (if py-imenu-show-method-args-p
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	797 py-imenu-method-arg-parens
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	798 py-imenu-method-no-arg-parens))
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	799 (goto-char (point-min))
9458 e7d984f266cc (py-imenu-method-regexp): Fix suggested by Daniel Calvelo to Barry Warsaw <barry@python.org> parents: 9457 diff changeset	800 ;; Warning: When the buffer has no classes or functions, this will
e7d984f266cc (py-imenu-method-regexp): Fix suggested by Daniel Calvelo to Barry Warsaw <barry@python.org> parents: 9457 diff changeset	801 ;; return nil, which seems proper according to the Imenu API, but
e7d984f266cc (py-imenu-method-regexp): Fix suggested by Daniel Calvelo to Barry Warsaw <barry@python.org> parents: 9457 diff changeset	802 ;; causes an error in the XEmacs port of Imenu. Sigh.
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	803 (py-imenu-create-index-engine nil))
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	804
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	805 (defun py-imenu-create-index-engine (&optional start-indent)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	806 "Function for finding Imenu definitions in Python.
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	807
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	808 Finds all definitions (classes, methods, or functions) in a Python
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	809 file for the Imenu package.
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	810
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	811 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	812
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	813 (INDEX-NAME . INDEX-POSITION)
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	814
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	815 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	816 list as in
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	817
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	818 (INDEX-NAME . INDEX-ALIST)
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	819
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	820 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	821 recursively and requires some setup. Rather this is the engine for
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	822 the function \\[py-imenu-create-index-function].
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	823
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	824 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	825 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	826 finds a definition at a greater indentation level, it removes the
8370 f2b0859fece3 #Documentation and comment typos patch given by Michael Ernst. More Barry Warsaw <barry@python.org> parents: 8070 diff changeset	827 previous definition from the alist. In its place it adds all
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	828 definitions found at the next indentation level. When it finds a
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	829 definition that is less indented then the current level, it returns
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	830 the alist it has created thus far.
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	831
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	832 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	833 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	834 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	835 of the first definition found."
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	836 (let (index-alist
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	837 sub-method-alist
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	838 looking-p
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	839 def-name prev-name
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	840 cur-indent def-pos
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	841 (class-paren (first py-imenu-generic-parens))
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	842 (def-paren (second py-imenu-generic-parens)))
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	843 (setq looking-p
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	844 (re-search-forward py-imenu-generic-regexp (point-max) t))
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	845 (while looking-p
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	846 (save-excursion
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	847 ;; used to set def-name to this value but generic-extract-name
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	848 ;; is new to imenu-1.14. this way it still works with
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	849 ;; imenu-1.11
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	850 ;;(imenu--generic-extract-name py-imenu-generic-parens))
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	851 (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	852 class-paren def-paren)))
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	853 (setq def-name
6670 8e3ee3577d4e (python-mode): Make imenu-create-index-function buffer local. Barry Warsaw <barry@python.org> parents: 6669 diff changeset	854 (buffer-substring-no-properties (match-beginning cur-paren)
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	855 (match-end cur-paren))))
9005 ec01fe9c2841 (imenu-example--create-python-index-engine): Fix nesting breakage when Barry Warsaw <barry@python.org> parents: 8925 diff changeset	856 (save-match-data
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	857 (py-beginning-of-def-or-class 'either))
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	858 (beginning-of-line)
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	859 (setq cur-indent (current-indentation)))
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	860 ;; HACK: want to go to the next correct definition location. We
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	861 ;; explicitly list them here but it would be better to have them
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	862 ;; in a list.
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	863 (setq def-pos
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	864 (or (match-beginning class-paren)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	865 (match-beginning def-paren)))
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	866 ;; 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	867 (or start-indent
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	868 (setq start-indent cur-indent))
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	869 ;; 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	870 (or prev-name
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	871 (setq prev-name def-name))
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	872 ;; 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	873 ;; or shallower indentation
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	874 (cond
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	875 ;; 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	876 ((= start-indent cur-indent)
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	877 (push (cons def-name def-pos) index-alist))
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	878 ;; deeper indented expression, recurse
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	879 ((< start-indent cur-indent)
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	880 ;; 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	881 ;; 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	882 ;; 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	883 ;; list
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	884 (re-search-backward py-imenu-generic-regexp (point-min) 'move)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	885 (setq sub-method-alist (py-imenu-create-index-engine cur-indent))
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	886 (if sub-method-alist
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	887 ;; 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	888 ;; 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	889 (let ((save-elmt (pop index-alist)))
6670 8e3ee3577d4e (python-mode): Make imenu-create-index-function buffer local. Barry Warsaw <barry@python.org> parents: 6669 diff changeset	890 (push (cons prev-name
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	891 (cons save-elmt sub-method-alist))
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	892 index-alist))))
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	893 ;; found less indented expression, we're done.
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	894 (t
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	895 (setq looking-p nil)
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	896 (re-search-backward py-imenu-generic-regexp (point-min) t)))
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	897 ;; end-cond
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	898 (setq prev-name def-name)
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	899 (and looking-p
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	900 (setq looking-p
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	901 (re-search-forward py-imenu-generic-regexp
3924 063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	902 (point-max) 'move))))
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	903 (nreverse index-alist)))
063d86741410 (imenu-example--python-show-method-args-p, Barry Warsaw <barry@python.org> parents: 3923 diff changeset	904
3818 3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	905
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	906 ;;;###autoload
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	907 (defun python-mode ()
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	908 "Major mode for editing Python files.
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	909 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	910 `python-mode' buffer. Do `\\[py-describe-mode]' for detailed
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	911 documentation. To see what version of `python-mode' you are running,
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	912 enter `\\[py-version]'.
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	913
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	914 This mode knows about Python indentation, tokens, comments and
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	915 continuation lines. Paragraphs are separated by blank lines only.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	916
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	917 COMMANDS
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	918 \\{py-mode-map}
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	919 VARIABLES
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	920
3818 3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	921 py-indent-offset\t\tindentation increment
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	922 py-block-comment-prefix\t\tcomment string used by `comment-region'
3818 3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	923 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	924 py-temp-directory\t\tdirectory used for temp files (if needed)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	925 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	926 (interactive)
4192 d23f78730e00 (python-mode): font-lock-defaults must be make-local-variable'd Barry Warsaw <barry@python.org> parents: 4189 diff changeset	927 ;; set up local variables
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	928 (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	929 (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	930 (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	931 (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	932 (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	933 (make-local-variable 'comment-start)
4763 38689aceae7b (python-mode): added comment-end definitions. Barry Warsaw <barry@python.org> parents: 4508 diff changeset	934 (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	935 (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	936 (make-local-variable 'comment-column)
8628 aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	937 (make-local-variable 'comment-indent-function)
4192 d23f78730e00 (python-mode): font-lock-defaults must be make-local-variable'd Barry Warsaw <barry@python.org> parents: 4189 diff changeset	938 (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	939 (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	940 (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	941 ;;
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	942 (set-syntax-table py-mode-syntax-table)
8628 aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	943 (setq major-mode 'python-mode
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	944 mode-name "Python"
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	945 local-abbrev-table python-mode-abbrev-table
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	946 font-lock-defaults '(python-font-lock-keywords)
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	947 paragraph-separate "^[ \t]*$"
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	948 paragraph-start "^[ \t]*$"
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	949 require-final-newline t
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	950 comment-start "# "
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	951 comment-end ""
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	952 comment-start-skip "# *"
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	953 comment-column 40
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	954 comment-indent-function 'py-comment-indent-function
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	955 indent-region-function 'py-indent-region
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	956 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	957 ;; 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	958 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	959 )
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	960 (use-local-map py-mode-map)
3818 3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	961 ;; add the menu
3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	962 (if py-menu
3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	963 (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	964 ;; Emacs 19 requires this
5968 b7048f5be9a1 #Checkpointing X/Emacs 20'fication of this mode. Barry Warsaw <barry@python.org> parents: 5965 diff changeset	965 (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	966 (setq comment-multi-line nil))
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	967 ;; Install Imenu if available
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	968 (when (py-safe (require 'imenu))
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	969 (setq imenu-create-index-function #'py-imenu-create-index-function)
54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	970 (setq imenu-generic-expression py-imenu-generic-expression)
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	971 (if (fboundp 'imenu-add-to-menubar)
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	972 (imenu-add-to-menubar (format "%s-%s" "IM" mode-name)))
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	973 )
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	974 ;; Run the mode hook. Note that py-mode-hook is deprecated.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	975 (if python-mode-hook
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	976 (run-hooks 'python-mode-hook)
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	977 (run-hooks 'py-mode-hook))
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	978 ;; Now do the automagical guessing
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	979 (if py-smart-indentation
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	980 (let ((offset py-indent-offset))
8370 f2b0859fece3 #Documentation and comment typos patch given by Michael Ernst. More Barry Warsaw <barry@python.org> parents: 8070 diff changeset	981 ;; It's okay if this fails to guess a good value
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	982 (if (and (py-safe (py-guess-indent-offset))
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	983 (<= py-indent-offset 8)
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	984 (>= py-indent-offset 2))
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	985 (setq offset py-indent-offset))
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	986 (setq py-indent-offset offset)
7699 96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	987 ;; Only turn indent-tabs-mode off if tab-width !=
96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	988 ;; py-indent-offset. Never turn it on, because the user must
96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	989 ;; have explicitly turned it off.
96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	990 (if (/= tab-width py-indent-offset)
96b7c1323d30 (py-smart-indentation): Updated docstring for new policy. Barry Warsaw <barry@python.org> parents: 7676 diff changeset	991 (setq indent-tabs-mode nil))
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	992 )))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	993
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	994
2535 875173f3f31c (py-electric-colon): new command Barry Warsaw <barry@python.org> parents: 2524 diff changeset	995 ;; electric characters
2547 3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	996 (defun py-outdent-p ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	997 "Returns non-nil if the current line should dedent one level."
2547 3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	998 (save-excursion
3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	999 (and (progn (back-to-indentation)
3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	1000 (looking-at py-outdent-re))
9827 ef97b4f6d187 (py-outdent-p): Short circuit infloop for illegal construct Barry Warsaw <barry@python.org> parents: 9639 diff changeset	1001 ;; short circuit infloop on illegal construct
ef97b4f6d187 (py-outdent-p): Short circuit infloop for illegal construct Barry Warsaw <barry@python.org> parents: 9639 diff changeset	1002 (not (bobp))
7152 d39a805852c2 (py-outdent-p): When looking at the previous line, watch out for Barry Warsaw <barry@python.org> parents: 7151 diff changeset	1003 (progn (forward-line -1)
d39a805852c2 (py-outdent-p): When looking at the previous line, watch out for Barry Warsaw <barry@python.org> parents: 7151 diff changeset	1004 (py-goto-initial-line)
d39a805852c2 (py-outdent-p): When looking at the previous line, watch out for Barry Warsaw <barry@python.org> parents: 7151 diff changeset	1005 (back-to-indentation)
2547 3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	1006 (while (or (looking-at py-blank-or-comment-re)
3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	1007 (bobp))
3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	1008 (backward-to-indentation 1))
3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	1009 (not (looking-at py-no-outdent-re)))
3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	1010 )))
3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	1011
2535 875173f3f31c (py-electric-colon): new command Barry Warsaw <barry@python.org> parents: 2524 diff changeset	1012 (defun py-electric-colon (arg)
875173f3f31c (py-electric-colon): new command Barry Warsaw <barry@python.org> parents: 2524 diff changeset	1013 "Insert a colon.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1014 In certain cases the line is dedented appropriately. If a numeric
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1015 argument ARG is provided, that many colons are inserted
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1016 non-electrically. Electric behavior is inhibited inside a string or
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1017 comment."
2535 875173f3f31c (py-electric-colon): new command Barry Warsaw <barry@python.org> parents: 2524 diff changeset	1018 (interactive "P")
875173f3f31c (py-electric-colon): new command Barry Warsaw <barry@python.org> parents: 2524 diff changeset	1019 (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	1020 ;; 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	1021 (if (save-excursion
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1022 (let ((pps (parse-partial-sexp (save-excursion
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	1023 (py-beginning-of-def-or-class)
3095 c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1024 (point))
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1025 (point))))
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1026 (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	1027 (save-excursion
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1028 (let ((here (point))
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1029 (outdent 0)
4479 2343803318e4 (py-indent-line): take an optional universal argument which says to Barry Warsaw <barry@python.org> parents: 4346 diff changeset	1030 (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	1031 (if (and (not arg)
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1032 (py-outdent-p)
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1033 (= indent (save-excursion
3934 f9ad98b58472 (py-electric-colon): Use (py-next-statement -1) instead of Barry Warsaw <barry@python.org> parents: 3926 diff changeset	1034 (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	1035 (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	1036 )
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1037 (setq outdent py-indent-offset))
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1038 ;; Don't indent, only dedent. This assumes that any lines
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1039 ;; that are already dedented relative to
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1040 ;; py-compute-indentation were put there on purpose. It's
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1041 ;; highly annoying to have `:' indent for you. Use TAB, C-c
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1042 ;; C-l or C-c C-r to adjust. TBD: Is there a better way to
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1043 ;; determine this???
3095 c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1044 (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	1045 (goto-char here)
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1046 (beginning-of-line)
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1047 (delete-horizontal-space)
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1048 (indent-to (- indent outdent))
c1d77d74fe35 (py-electric-colon): turn off electric behavior inside strings and Barry Warsaw <barry@python.org> parents: 3094 diff changeset	1049 )))))
2535 875173f3f31c (py-electric-colon): new command Barry Warsaw <barry@python.org> parents: 2524 diff changeset	1050
875173f3f31c (py-electric-colon): new command Barry Warsaw <barry@python.org> parents: 2524 diff changeset	1051
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1052 ;; Python subprocess utilities and filters
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1053 (defun py-execute-file (proc filename)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1054 "Send to Python interpreter process PROC \"execfile('FILENAME')\".
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1055 Make that process's buffer visible and force display. Also make
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1056 comint believe the user typed this string so that
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1057 `kill-output-from-shell' does The Right Thing."
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1058 (let ((curbuf (current-buffer))
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1059 (procbuf (process-buffer proc))
9025 3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1060 ; (comint-scroll-to-bottom-on-output t)
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1061 (msg (format "## working on region in file %s...\n" filename))
9141 881b86398c20 (py-execute-file, py-execute-import-or-reload): Use a Python `raw' Barry Warsaw <barry@python.org> parents: 9136 diff changeset	1062 (cmd (format "execfile(r'%s')\n" filename)))
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1063 (unwind-protect
9025 3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1064 (save-excursion
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1065 (set-buffer procbuf)
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1066 (goto-char (point-max))
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1067 (move-marker (process-mark proc) (point))
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1068 (funcall (process-filter proc) proc msg))
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1069 (set-buffer curbuf))
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1070 (process-send-string proc cmd)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1071
9025 3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1072 (defun py-comint-output-filter-function (string)
3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1073 "Watch output for Python prompt and exec next file waiting in queue.
3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1074 This function is appropriate for `comint-output-filter-functions'."
9491 a3bcf1b36551 (py-execute-region): Patch by Hunter Kelly so that execution uses the Barry Warsaw <barry@python.org> parents: 9458 diff changeset	1075 ;; TBD: this should probably use split-string
9144 520583bdf0b0 (py-comint-output-filter-function): Horrible kludgearound for making Barry Warsaw <barry@python.org> parents: 9142 diff changeset	1076 (when (and (or (string-equal string ">>> ")
520583bdf0b0 (py-comint-output-filter-function): Horrible kludgearound for making Barry Warsaw <barry@python.org> parents: 9142 diff changeset	1077 (and (>= (length string) 5)
520583bdf0b0 (py-comint-output-filter-function): Horrible kludgearound for making Barry Warsaw <barry@python.org> parents: 9142 diff changeset	1078 (string-equal (substring string -5) "\n>>> ")))
9025 3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1079 py-file-queue)
3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1080 (py-safe (delete-file (car py-file-queue)))
3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1081 (setq py-file-queue (cdr py-file-queue))
3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1082 (if py-file-queue
3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1083 (let ((pyproc (get-buffer-process (current-buffer))))
3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1084 (py-execute-file pyproc (car py-file-queue))))
3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1085 ))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1086
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1087 (defun py-postprocess-output-buffer (buf)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1088 "Highlight exceptions found in BUF.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1089 If an exception occurred return t, otherwise return nil. BUF must exist."
7743 269a327d6305 (py-postprocess-output-buffer): Return t if an exception was found, Barry Warsaw <barry@python.org> parents: 7742 diff changeset	1090 (let (line file bol err-p)
6731 21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	1091 (save-excursion
21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	1092 (set-buffer buf)
21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	1093 (beginning-of-buffer)
21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	1094 (while (re-search-forward py-traceback-line-re nil t)
21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	1095 (setq file (match-string 1)
21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	1096 line (string-to-int (match-string 2))
21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	1097 bol (py-point 'bol))
7743 269a327d6305 (py-postprocess-output-buffer): Return t if an exception was found, Barry Warsaw <barry@python.org> parents: 7742 diff changeset	1098 (py-highlight-line bol (py-point 'eol) file line)))
269a327d6305 (py-postprocess-output-buffer): Return t if an exception was found, Barry Warsaw <barry@python.org> parents: 7742 diff changeset	1099 (when (and py-jump-on-exception line)
269a327d6305 (py-postprocess-output-buffer): Return t if an exception was found, Barry Warsaw <barry@python.org> parents: 7742 diff changeset	1100 (beep)
269a327d6305 (py-postprocess-output-buffer): Return t if an exception was found, Barry Warsaw <barry@python.org> parents: 7742 diff changeset	1101 (py-jump-to-exception file line)
269a327d6305 (py-postprocess-output-buffer): Return t if an exception was found, Barry Warsaw <barry@python.org> parents: 7742 diff changeset	1102 (setq err-p t))
269a327d6305 (py-postprocess-output-buffer): Return t if an exception was found, Barry Warsaw <barry@python.org> parents: 7742 diff changeset	1103 err-p))
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1104
6731 21656204dd4f (py-jump-on-exception): Variable which if t, means that if an Barry Warsaw <barry@python.org> parents: 6730 diff changeset	1105
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1106
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1107 ;;; Subprocess commands
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1108
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1109 ;; only used when (memq 'broken-temp-names py-emacs-features)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1110 (defvar py-serial-number 0)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1111 (defvar py-exception-buffer nil)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1112 (defconst py-output-buffer "Python Output")
7950 9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1113 (make-variable-buffer-local 'py-output-buffer)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1114
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1115 ;; for toggling between CPython and JPython
10207 29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1116 (defvar py-which-shell nil)
7950 9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1117 (defvar py-which-args py-python-command-args)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1118 (defvar py-which-bufname "Python")
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1119 (make-variable-buffer-local 'py-which-shell)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1120 (make-variable-buffer-local 'py-which-args)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1121 (make-variable-buffer-local 'py-which-bufname)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1122
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1123 (defun py-toggle-shells (arg)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1124 "Toggles between the CPython and JPython shells.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1125 With positive argument ARG (interactively \\[universal-argument]),
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1126 uses the CPython shell, with negative ARG uses the JPython shell, and
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1127 with a zero argument, toggles the shell."
7950 9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1128 (interactive "P")
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1129 ;; default is to toggle
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1130 (if (null arg)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1131 (setq arg 0))
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1132 ;; toggle if zero
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1133 (if (= arg 0)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1134 (if (string-equal py-which-bufname "Python")
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1135 (setq arg -1)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1136 (setq arg 1)))
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1137 (let (msg)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1138 (cond
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1139 ((< 0 arg)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1140 ;; set to CPython
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1141 (setq py-which-shell py-python-command
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1142 py-which-args py-python-command-args
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1143 py-which-bufname "Python"
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1144 msg "CPython"
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1145 mode-name "Python"))
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1146 ((> 0 arg)
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1147 (setq py-which-shell py-jpython-command
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1148 py-which-args py-jpython-command-args
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1149 py-which-bufname "JPython"
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1150 msg "JPython"
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1151 mode-name "JPython"))
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1152 )
7952 72d9961540d8 (py-toggle-shells): Added a message in the minibuf. Barry Warsaw <barry@python.org> parents: 7950 diff changeset	1153 (message "Using the %s shell" msg)
7950 9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1154 (setq py-output-buffer (format "%s Output" py-which-bufname))))
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1155
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1156 ;;;###autoload
10208 a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1157 (defun py-shell (&optional argprompt)
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1158 "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	1159 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	1160 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	1161 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	1162 bindings active in the `Python' buffer.
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1163
10208 a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1164 With optional \\[universal-argument], the user is prompted for the
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1165 flags to pass to the Python interpreter. This has no effect when this
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1166 command is used to switch to an existing process, only when a new
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1167 process is started. If you use this, you will probably want to ensure
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1168 that the current arguments are retained (they will be included in the
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1169 prompt). This argument is ignored when this function is called
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1170 programmatically, or when running in Emacs 19.34 or older.
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1171
7950 9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1172 Note: You can toggle between using the CPython interpreter and the
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1173 JPython interpreter by hitting \\[py-toggle-shells]. This toggles
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1174 buffer local variables which control whether all your subshell
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1175 interactions happen to the `JPython' or `Python' buffers (the
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1176 latter is the name used for the CPython buffer).
9cbcb5931d80 Quick and extremely dirty hacks to toggle between using CPython and Barry Warsaw <barry@python.org> parents: 7878 diff changeset	1177
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1178 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	1179 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	1180 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	1181 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	1182 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	1183 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	1184 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	1185 mode.
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1186
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1187 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	1188 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	1189 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	1190 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	1191 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	1192 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	1193 filter."
10208 a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1194 (interactive "P")
10207 29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1195 (if (null py-which-shell)
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1196 (cond ((eq py-default-interpreter 'cpython)
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1197 (setq py-which-shell py-python-command
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1198 py-which-args py-python-command-args))
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1199 ((eq py-default-interpreter 'jpython)
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1200 (setq py-which-shell py-jpython-command
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1201 py-which-args py-jpython-command-args))
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1202 (t (error "Illegal value for `py-default-interpreter': %s"
29d1d3b08ca7 (py-default-interpreter): New variable which selects whether CPython Barry Warsaw <barry@python.org> parents: 9927 diff changeset	1203 py-default-interpreter))))
10208 a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1204 (let ((args py-which-args))
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1205 (when (and argprompt
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1206 (interactive-p)
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1207 (fboundp 'split-string))
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1208 ;; TBD: Perhaps force "-i" in the final list?
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1209 (setq args (split-string
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1210 (read-string (concat py-which-bufname
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1211 " arguments: ")
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1212 (concat
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1213 (mapconcat 'identity py-which-args " ") " ")
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1214 ))))
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1215 (switch-to-buffer-other-window
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1216 (apply 'make-comint py-which-bufname py-which-shell nil args))
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1217 (make-local-variable 'comint-prompt-regexp)
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1218 (setq comint-prompt-regexp "^>>> \\\|^[.][.][.] \\\|^(pdb) ")
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1219 (add-hook 'comint-output-filter-functions
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1220 'py-comint-output-filter-function)
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1221 (set-syntax-table py-mode-syntax-table)
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1222 (use-local-map py-shell-map)
a86fe1f3cf4e (py-shell): Added optional argprompt, which will prompt for additional Barry Warsaw <barry@python.org> parents: 10207 diff changeset	1223 ))
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1224
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1225 (defun py-clear-queue ()
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1226 "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	1227 (interactive)
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1228 (let ((n (length py-file-queue)))
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1229 (mapcar 'delete-file py-file-queue)
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1230 (setq py-file-queue nil)
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1231 (message "%d pending files de-queued." n)))
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1232
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1233
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1234 (defun py-execute-region (start end &optional async)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1235 "Execute the region in a Python interpreter.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1236
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1237 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	1238 `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	1239 running, this file is executed synchronously using
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1240 `shell-command-on-region'. If the program is long running, use
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1241 \\[universal-argument] to run the command asynchronously in its own
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1242 buffer.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1243
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1244 When this function is used programmatically, arguments START and END
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1245 specify the region to execute, and optional third argument ASYNC, if
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1246 non-nil, specifies to run the command asynchronously in its own
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1247 buffer.
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1248
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1249 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	1250 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	1251 `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	1252 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	1253 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	1254 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	1255
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1256 \t## working on region in file <name>...
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1257
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1258 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	1259 (interactive "r\nP")
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1260 (or (< start end)
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1261 (error "Region is empty"))
9491 a3bcf1b36551 (py-execute-region): Patch by Hunter Kelly so that execution uses the Barry Warsaw <barry@python.org> parents: 9458 diff changeset	1262 (let* ((proc (get-process py-which-bufname))
6562 53835043528c (py-emacs-features): Test for working make-temp-name, which is broken Barry Warsaw <barry@python.org> parents: 6560 diff changeset	1263 (temp (if (memq 'broken-temp-names py-emacs-features)
8888 9a075a2edb1f (py-execute-region): When temp-names are broken (Emacs 19.34), a Barry Warsaw <barry@python.org> parents: 8629 diff changeset	1264 (let
9a075a2edb1f (py-execute-region): When temp-names are broken (Emacs 19.34), a Barry Warsaw <barry@python.org> parents: 8629 diff changeset	1265 ((sn py-serial-number)
9a075a2edb1f (py-execute-region): When temp-names are broken (Emacs 19.34), a Barry Warsaw <barry@python.org> parents: 8629 diff changeset	1266 (pid (and (fboundp 'emacs-pid) (emacs-pid))))
9a075a2edb1f (py-execute-region): When temp-names are broken (Emacs 19.34), a Barry Warsaw <barry@python.org> parents: 8629 diff changeset	1267 (setq py-serial-number (1+ py-serial-number))
9a075a2edb1f (py-execute-region): When temp-names are broken (Emacs 19.34), a Barry Warsaw <barry@python.org> parents: 8629 diff changeset	1268 (if pid
9a075a2edb1f (py-execute-region): When temp-names are broken (Emacs 19.34), a Barry Warsaw <barry@python.org> parents: 8629 diff changeset	1269 (format "python-%d-%d" sn pid)
9a075a2edb1f (py-execute-region): When temp-names are broken (Emacs 19.34), a Barry Warsaw <barry@python.org> parents: 8629 diff changeset	1270 (format "python-%d" sn)))
7481 cca39d719aba (py-execute-region): Simplified calculation of temporary file name. Barry Warsaw <barry@python.org> parents: 7480 diff changeset	1271 (make-temp-name "python-")))
cca39d719aba (py-execute-region): Simplified calculation of temporary file name. Barry Warsaw <barry@python.org> parents: 7480 diff changeset	1272 (file (expand-file-name temp py-temp-directory)))
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1273 (write-region start end file nil 'nomsg)
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1274 (cond
8370 f2b0859fece3 #Documentation and comment typos patch given by Michael Ernst. More Barry Warsaw <barry@python.org> parents: 8070 diff changeset	1275 ;; always run the code in its own asynchronous subprocess
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1276 (async
9503 fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1277 (let* ((buf (generate-new-buffer-name py-output-buffer))
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1278 ;; TBD: a horrible hack, but why create new Custom variables?
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1279 (arg (if (string-equal py-which-bufname "Python")
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1280 "-u" "")))
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1281 (start-process py-which-bufname buf py-which-shell arg file)
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1282 (pop-to-buffer buf)
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1283 (py-postprocess-output-buffer buf)
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1284 ))
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1285 ;; 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	1286 ;; execution there.
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1287 (proc
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1288 ;; use the existing python shell
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1289 (if (not py-file-queue)
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1290 (py-execute-file proc file)
a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1291 (message "File %s queued for execution" file))
9025 3df5b9d8335b (py-process-filter): Deleted this function. In order to fix Barry Warsaw <barry@python.org> parents: 9005 diff changeset	1292 (setq py-file-queue (append py-file-queue (list file)))
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1293 (setq py-exception-buffer (cons file (current-buffer))))
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1294 (t
9503 fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1295 ;; TBD: a horrible hack, buy why create new Custom variables?
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1296 (let ((cmd (concat py-which-shell
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1297 (if (string-equal py-which-bufname "JPython")
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1298 " -" ""))))
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1299 ;; otherwise either run it synchronously in a subprocess
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1300 (shell-command-on-region start end cmd py-output-buffer)
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1301 ;; shell-command-on-region kills the output buffer if it never
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1302 ;; existed and there's no output from the command
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1303 (if (not (get-buffer py-output-buffer))
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1304 (message "No output.")
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1305 (setq py-exception-buffer (current-buffer))
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1306 (let ((err-p (py-postprocess-output-buffer py-output-buffer)))
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1307 (pop-to-buffer py-output-buffer)
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1308 (if err-p
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1309 (pop-to-buffer py-exception-buffer)))
fec862301d6e (py-execute-region): Hack around the different behavior and switch Barry Warsaw <barry@python.org> parents: 9491 diff changeset	1310 )))
7742 5bf66ab4dfb6 (py-execute-region): Watch out for shell-command-on-region killing a Barry Warsaw <barry@python.org> parents: 7727 diff changeset	1311 )))
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1312
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1313
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1314 ;; Code execution commands
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1315 (defun py-execute-buffer (&optional async)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1316 "Send the contents of the buffer to a Python interpreter.
7142 aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	1317 If the file local variable `py-master-file' is non-nil, execute the
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	1318 named file instead of the buffer's file.
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	1319
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1320 If there is a Python process buffer it is used. If a clipping
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1321 restriction is in effect, only the accessible portion of the buffer is
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1322 sent. A trailing newline will be supplied if needed.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1323
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1324 See the `\\[py-execute-region]' docs for an account of some
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1325 subtleties, including the use of the optional ASYNC argument."
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1326 (interactive "P")
7142 aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	1327 (if py-master-file
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	1328 (let* ((filename (expand-file-name py-master-file))
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	1329 (buffer (or (get-file-buffer filename)
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	1330 (find-file-noselect filename))))
aff1e7b1f523 (py-master-file): New buffer-local variable which can be set in the Barry Warsaw <barry@python.org> parents: 6836 diff changeset	1331 (set-buffer buffer)))
6555 a5f7eb869f21 First round of changes, mostly subprocess stuff. Barry Warsaw <barry@python.org> parents: 6544 diff changeset	1332 (py-execute-region (point-min) (point-max) async))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1333
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1334 (defun py-execute-import-or-reload (&optional async)
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1335 "Import the current buffer's file in a Python interpreter.
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1336
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1337 If the file has already been imported, then do reload instead to get
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1338 the latest version.
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1339
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1340 If the file's name does not end in \".py\", then do execfile instead.
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1341
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1342 If the current buffer is not visiting a file, do `py-execute-buffer'
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1343 instead.
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1344
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1345 If the file local variable `py-master-file' is non-nil, import or
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1346 reload the named file instead of the buffer's file. The file may be
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1347 saved based on the value of `py-execute-import-or-reload-save-p'.
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1348
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1349 See the `\\[py-execute-region]' docs for an account of some
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1350 subtleties, including the use of the optional ASYNC argument.
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1351
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	1352 This may be preferable to `\\[py-execute-buffer]' because:
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1353
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1354 - Definitions stay in their module rather than appearing at top
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1355 level, where they would clutter the global namespace and not affect
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1356 uses of qualified names (MODULE.NAME).
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1357
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1358 - The Python debugger gets line number information about the functions."
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1359 (interactive "P")
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1360 ;; Check file local variable py-master-file
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1361 (if py-master-file
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1362 (let* ((filename (expand-file-name py-master-file))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1363 (buffer (or (get-file-buffer filename)
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1364 (find-file-noselect filename))))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1365 (set-buffer buffer)))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1366 (let ((file (buffer-file-name (current-buffer))))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1367 (if file
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1368 (progn
8381 822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	1369 ;; Maybe save some buffers
822e0812f20c (py-ask-about-save): New variable used in Barry Warsaw <barry@python.org> parents: 8380 diff changeset	1370 (save-some-buffers (not py-ask-about-save) nil)
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1371 (py-execute-string
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1372 (if (string-match "\\.py$" file)
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1373 (let ((f (file-name-sans-extension
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1374 (file-name-nondirectory file))))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1375 (format "if globals().has_key('%s'):\n reload(%s)\nelse:\n import %s\n"
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1376 f f f))
9141 881b86398c20 (py-execute-file, py-execute-import-or-reload): Use a Python `raw' Barry Warsaw <barry@python.org> parents: 9136 diff changeset	1377 (format "execfile(r'%s')\n" file))
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1378 async))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1379 ;; else
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1380 (py-execute-buffer async))))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1381
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1382
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1383 (defun py-execute-def-or-class (&optional async)
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1384 "Send the current function or class definition to a Python interpreter.
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1385
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1386 If there is a Python process buffer it is used.
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1387
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1388 See the `\\[py-execute-region]' docs for an account of some
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1389 subtleties, including the use of the optional ASYNC argument."
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1390 (interactive "P")
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1391 (save-excursion
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1392 (py-mark-def-or-class)
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1393 ;; mark is before point
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1394 (py-execute-region (mark) (point) async)))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1395
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1396
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1397 (defun py-execute-string (string &optional async)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1398 "Send the argument STRING to a Python interpreter.
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1399
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1400 If there is a Python process buffer it is used.
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1401
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1402 See the `\\[py-execute-region]' docs for an account of some
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1403 subtleties, including the use of the optional ASYNC argument."
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1404 (interactive "sExecute Python command: ")
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1405 (save-excursion
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1406 (set-buffer (get-buffer-create
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1407 (generate-new-buffer-name " Python Command")))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1408 (insert string)
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1409 (py-execute-region (point-min) (point-max) async)))
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1410
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1411
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1412
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1413 (defun py-jump-to-exception (file line)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1414 "Jump to the Python code in FILE at LINE."
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1415 (let ((buffer (cond ((string-equal file "<stdin>")
8371 a65930f5cddb More ME patches: Barry Warsaw <barry@python.org> parents: 8370 diff changeset	1416 (if (consp py-exception-buffer)
a65930f5cddb More ME patches: Barry Warsaw <barry@python.org> parents: 8370 diff changeset	1417 (cdr py-exception-buffer)
a65930f5cddb More ME patches: Barry Warsaw <barry@python.org> parents: 8370 diff changeset	1418 py-exception-buffer))
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1419 ((and (consp py-exception-buffer)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1420 (string-equal file (car py-exception-buffer)))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1421 (cdr py-exception-buffer))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1422 ((py-safe (find-file-noselect file)))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1423 ;; could not figure out what file the exception
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1424 ;; is pointing to, so prompt for it
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1425 (t (find-file (read-file-name "Exception file: "
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1426 nil
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1427 file t))))))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1428 (pop-to-buffer buffer)
8371 a65930f5cddb More ME patches: Barry Warsaw <barry@python.org> parents: 8370 diff changeset	1429 ;; Force Python mode
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	1430 (if (not (eq major-mode 'python-mode))
8371 a65930f5cddb More ME patches: Barry Warsaw <barry@python.org> parents: 8370 diff changeset	1431 (python-mode))
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1432 (goto-line line)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1433 (message "Jumping to exception in file %s on line %d" file line)))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1434
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1435 (defun py-mouseto-exception (event)
8924 0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1436 "Jump to the code which caused the Python exception at EVENT.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1437 EVENT is usually a mouse click."
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1438 (interactive "e")
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1439 (cond
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1440 ((fboundp 'event-point)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1441 ;; XEmacs
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1442 (let* ((point (event-point event))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1443 (buffer (event-buffer event))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1444 (e (and point buffer (extent-at point buffer 'py-exc-info)))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1445 (info (and e (extent-property e 'py-exc-info))))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1446 (message "Event point: %d, info: %s" point info)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1447 (and info
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1448 (py-jump-to-exception (car info) (cdr info)))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1449 ))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1450 ;; Emacs -- Please port this!
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1451 ))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1452
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1453 (defun py-goto-exception ()
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1454 "Go to the line indicated by the traceback."
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1455 (interactive)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1456 (let (file line)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1457 (save-excursion
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1458 (beginning-of-line)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1459 (if (looking-at py-traceback-line-re)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1460 (setq file (match-string 1)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1461 line (string-to-int (match-string 2)))))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1462 (if (not file)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1463 (error "Not on a traceback line"))
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1464 (py-jump-to-exception file line)))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1465
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1466 (defun py-find-next-exception (start buffer searchdir errwhere)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1467 "Find the next Python exception and jump to the code that caused it.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1468 START is the buffer position in BUFFER from which to begin searching
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1469 for an exception. SEARCHDIR is a function, either
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1470 `re-search-backward' or `re-search-forward' indicating the direction
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1471 to search. ERRWHERE is used in an error message if the limit (top or
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1472 bottom) of the trackback stack is encountered."
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1473 (let (file line)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1474 (save-excursion
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1475 (set-buffer buffer)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1476 (goto-char (py-point start))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1477 (if (funcall searchdir py-traceback-line-re nil t)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1478 (setq file (match-string 1)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1479 line (string-to-int (match-string 2)))))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1480 (if (and file line)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1481 (py-jump-to-exception file line)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1482 (error "%s of traceback" errwhere))))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1483
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1484 (defun py-down-exception (&optional bottom)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1485 "Go to the next line down in the traceback.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1486 With \\[univeral-argument] (programmatically, optional argument
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1487 BOTTOM), jump to the bottom (innermost) exception in the exception
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1488 stack."
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1489 (interactive "P")
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1490 (let* ((proc (get-process "Python"))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1491 (buffer (if proc "Python" py-output-buffer)))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1492 (if bottom
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1493 (py-find-next-exception 'eob buffer 're-search-backward "Bottom")
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1494 (py-find-next-exception 'eol buffer 're-search-forward "Bottom"))))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1495
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1496 (defun py-up-exception (&optional top)
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1497 "Go to the previous line up in the traceback.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1498 With \\[universal-argument] (programmatically, optional argument TOP)
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1499 jump to the top (outermost) exception in the exception stack."
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1500 (interactive "P")
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1501 (let* ((proc (get-process "Python"))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1502 (buffer (if proc "Python" py-output-buffer)))
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1503 (if top
9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1504 (py-find-next-exception 'bob buffer 're-search-forward "Top")
6683 cb889b678053 (py-traceback-line-re): Relaxation of regexp to catch SyntaxErrors. Barry Warsaw <barry@python.org> parents: 6679 diff changeset	1505 (py-find-next-exception 'bol buffer 're-search-backward "Top"))))
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1506
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1507
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1508 ;; Electric deletion
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1509 (defun py-electric-backspace (arg)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1510 "Delete preceding character or levels of indentation.
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1511 Deletion is performed by calling the function in `py-backspace-function'
4764 88714fbf9a06 (py-delete-function): new variable Barry Warsaw <barry@python.org> parents: 4763 diff changeset	1512 with a single argument (the number of characters to delete).
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1513
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1514 If point is at the leftmost column, delete the preceding newline.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1515
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1516 Otherwise, if point is at the leftmost non-whitespace character of a
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1517 line that is neither a continuation line nor a non-indenting comment
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1518 line, or if point is at the end of a blank line, this command reduces
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1519 the indentation to match that of the line that opened the current
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1520 block of code. The line that opened the block is displayed in the
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1521 echo area to help you keep track of where you are. With
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1522 \\[universal-argument] dedents that many blocks (but not past column
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1523 zero).
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1524
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1525 Otherwise the preceding character is deleted, converting a tab to
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1526 spaces if needed so that only a single column position is deleted.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1527 \\[universal-argument] specifies how many characters to delete
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1528 (default is 1).
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1529
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1530 When used programmatically, argument ARG specifies the number of
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1531 blocks to dedent, or the number of characters to delete, as indicated
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1532 above."
3744 ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1533 (interactive "*p")
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1534 (if (or (/= (current-indentation) (current-column))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1535 (bolp)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1536 (py-continuation-line-p)
3920 9366164f5c4a (py-delete-char): Check for py-honor-comment-indentation. Barry Warsaw <barry@python.org> parents: 3919 diff changeset	1537 (not py-honor-comment-indentation)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1538 (looking-at "#[^ \t\n]")) ; non-indenting #
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1539 (funcall py-backspace-function arg)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1540 ;; else indent the same as the colon line that opened the block
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1541 ;; force non-blank so py-goto-block-up doesn't ignore it
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1542 (insert-char ?* 1)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1543 (backward-char)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1544 (let ((base-indent 0) ; indentation of base line
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1545 (base-text "") ; and text of base line
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1546 (base-found-p nil))
3744 ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1547 (save-excursion
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1548 (while (< 0 arg)
3744 ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1549 (condition-case nil ; in case no enclosing block
ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1550 (progn
ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1551 (py-goto-block-up 'no-mark)
ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1552 (setq base-indent (current-indentation)
ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1553 base-text (py-suck-up-leading-text)
ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1554 base-found-p t))
ffdf1f06cf8b (py-delete-char): Obey numeric argument. Barry Warsaw <barry@python.org> parents: 3743 diff changeset	1555 (error nil))
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1556 (setq arg (1- arg))))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1557 (delete-char 1) ; toss the dummy character
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1558 (delete-horizontal-space)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1559 (indent-to base-indent)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1560 (if base-found-p
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1561 (message "Closes block: %s" base-text)))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1562
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1563
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1564 (defun py-electric-delete (arg)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1565 "Delete preceding or following character or levels of whitespace.
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1566
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1567 The behavior of this function depends on the variable
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1568 `delete-key-deletes-forward'. If this variable is nil (or does not
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1569 exist, as in older Emacsen and non-XEmacs versions), then this
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1570 function behaves identically to \\[c-electric-backspace].
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1571
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1572 If `delete-key-deletes-forward' is non-nil and is supported in your
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1573 Emacs, then deletion occurs in the forward direction, by calling the
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1574 function in `py-delete-function'.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1575
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1576 \\[universal-argument] (programmatically, argument ARG) specifies the
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1577 number of characters to delete (default is 1)."
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1578 (interactive "*p")
9897 7bdef4bedd5c (py-electric-delete): Implement the XEmacs 21 blessed way of checking Barry Warsaw <barry@python.org> parents: 9827 diff changeset	1579 (if (or (and (fboundp 'delete-forward-p) ;XEmacs 21
7bdef4bedd5c (py-electric-delete): Implement the XEmacs 21 blessed way of checking Barry Warsaw <barry@python.org> parents: 9827 diff changeset	1580 (delete-forward-p))
7bdef4bedd5c (py-electric-delete): Implement the XEmacs 21 blessed way of checking Barry Warsaw <barry@python.org> parents: 9827 diff changeset	1581 (and (boundp 'delete-key-deletes-forward) ;XEmacs 20
7bdef4bedd5c (py-electric-delete): Implement the XEmacs 21 blessed way of checking Barry Warsaw <barry@python.org> parents: 9827 diff changeset	1582 delete-key-deletes-forward))
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1583 (funcall py-delete-function arg)
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1584 (py-electric-backspace arg)))
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1585
2513 56e25114d438 (py-delete-char): must have 'supersede value for 'delete-selection and Barry Warsaw <barry@python.org> parents: 2499 diff changeset	1586 ;; required for pending-del and delsel modes
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1587 (put 'py-electric-backspace 'delete-selection 'supersede) ;delsel
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1588 (put 'py-electric-backspace 'pending-delete 'supersede) ;pending-del
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1589 (put 'py-electric-delete 'delete-selection 'supersede) ;delsel
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1590 (put 'py-electric-delete 'pending-delete 'supersede) ;pending-del
2513 56e25114d438 (py-delete-char): must have 'supersede value for 'delete-selection and Barry Warsaw <barry@python.org> parents: 2499 diff changeset	1591
6556 4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1592
4280b2729cce (py-backspace-function): New variable. Barry Warsaw <barry@python.org> parents: 6555 diff changeset	1593
4479 2343803318e4 (py-indent-line): take an optional universal argument which says to Barry Warsaw <barry@python.org> parents: 4346 diff changeset	1594 (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	1595 "Fix the indentation of the current line according to Python rules.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1596 With \\[universal-argument] (programmatically, the optional argument
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1597 ARG non-nil), ignore dedenting rules for block closing statements
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1598 (e.g. return, raise, break, continue, pass)
4479 2343803318e4 (py-indent-line): take an optional universal argument which says to Barry Warsaw <barry@python.org> parents: 4346 diff changeset	1599
2343803318e4 (py-indent-line): take an optional universal argument which says to Barry Warsaw <barry@python.org> parents: 4346 diff changeset	1600 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	1601 \\[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	1602 (interactive "P")
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1603 (let* ((ci (current-indentation))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1604 (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	1605 (need (py-compute-indentation (not arg))))
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1606 ;; see if we need to dedent
2547 3281a931a1d9 (py-outdent-p): new function Barry Warsaw <barry@python.org> parents: 2544 diff changeset	1607 (if (py-outdent-p)
2537 6fcd0b022fa7 (py-outdent-re): new constant Barry Warsaw <barry@python.org> parents: 2536 diff changeset	1608 (setq need (- need py-indent-offset)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1609 (if (/= ci need)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1610 (save-excursion
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1611 (beginning-of-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1612 (delete-horizontal-space)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1613 (indent-to need)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1614 (if move-to-indentation-p (back-to-indentation))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1615
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1616 (defun py-newline-and-indent ()
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1617 "Strives to act like the Emacs `newline-and-indent'.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1618 This is just `strives to' because correct indentation can't be computed
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1619 from scratch for Python code. In general, deletes the whitespace before
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1620 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	1621 the new line indented."
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1622 (interactive)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1623 (let ((ci (current-indentation)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1624 (if (< ci (current-column)) ; if point beyond indentation
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1625 (newline-and-indent)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1626 ;; else try to act like newline-and-indent "normally" acts
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1627 (beginning-of-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1628 (insert-char ?\n 1)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1629 (move-to-column ci))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1630
4479 2343803318e4 (py-indent-line): take an optional universal argument which says to Barry Warsaw <barry@python.org> parents: 4346 diff changeset	1631 (defun py-compute-indentation (honor-block-close-p)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1632 "Compute Python indentation.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1633 When HONOR-BLOCK-CLOSE-P is non-nil, statements such as `return',
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1634 `raise', `break', `continue', and `pass' force one level of
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1635 dedenting."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1636 (save-excursion
7262 c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	1637 (beginning-of-line)
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1638 (let* ((bod (py-point 'bod))
6678 de2f8f494ae3 (py-compute-indentation): Check for multiline stringness and Barry Warsaw <barry@python.org> parents: 6677 diff changeset	1639 (pps (parse-partial-sexp bod (point)))
9639 da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1640 (boipps (parse-partial-sexp bod (py-point 'boi)))
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1641 placeholder)
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1642 (cond
6663 9f02eb36b573 Added comment about where to find details on python-mode.el, pointing Barry Warsaw <barry@python.org> parents: 6565 diff changeset	1643 ;; are we inside a multi-line string or comment?
6678 de2f8f494ae3 (py-compute-indentation): Check for multiline stringness and Barry Warsaw <barry@python.org> parents: 6677 diff changeset	1644 ((or (and (nth 3 pps) (nth 3 boipps))
de2f8f494ae3 (py-compute-indentation): Check for multiline stringness and Barry Warsaw <barry@python.org> parents: 6677 diff changeset	1645 (and (nth 4 pps) (nth 4 boipps)))
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1646 (save-excursion
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1647 (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	1648 ;; 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	1649 ;; 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	1650 ;; 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	1651 (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	1652 (back-to-indentation)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1653 (current-column))))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1654 ;; are we on a continuation line?
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1655 ((py-continuation-line-p)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1656 (let ((startpos (point))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1657 (open-bracket-pos (py-nesting-level))
3923 a39d06497520 (py-keep-region-active): Zap duplicate defun. Barry Warsaw <barry@python.org> parents: 3920 diff changeset	1658 endpos searching found state)
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1659 (if open-bracket-pos
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1660 (progn
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1661 ;; 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	1662 ;; 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	1663 (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	1664 ;; 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	1665 (skip-chars-forward " \t")
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1666 (if (null (memq (following-char) '(?\n ?# ?\\)))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1667 ; yes, so line up with it
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1668 (current-column)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1669 ;; 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	1670 (forward-line 1)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1671 (while (and (< (point) startpos)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1672 (looking-at "[ \t]*[#\n\\\\]")) ; skip noise
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1673 (forward-line 1))
7777 5e215894c555 (py-compute-indentation): When looking at a continuation line inside Barry Warsaw <barry@python.org> parents: 7776 diff changeset	1674 (if (and (< (point) startpos)
5e215894c555 (py-compute-indentation): When looking at a continuation line inside Barry Warsaw <barry@python.org> parents: 7776 diff changeset	1675 (/= startpos
5e215894c555 (py-compute-indentation): When looking at a continuation line inside Barry Warsaw <barry@python.org> parents: 7776 diff changeset	1676 (save-excursion
5e215894c555 (py-compute-indentation): When looking at a continuation line inside Barry Warsaw <barry@python.org> parents: 7776 diff changeset	1677 (goto-char (1+ open-bracket-pos))
8070 4a2f1c69fde8 (py-compute-indentation): Use forward-comment to skip over all Barry Warsaw <barry@python.org> parents: 7952 diff changeset	1678 (forward-comment (point-max))
7777 5e215894c555 (py-compute-indentation): When looking at a continuation line inside Barry Warsaw <barry@python.org> parents: 7776 diff changeset	1679 (point))))
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1680 ;; again mimic the first list item
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1681 (current-indentation)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1682 ;; 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	1683 (goto-char open-bracket-pos)
9639 da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1684 (setq placeholder (point))
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1685 (py-goto-initial-line)
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1686 (py-goto-beginning-of-tqs
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1687 (save-excursion (nth 3 (parse-partial-sexp
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1688 placeholder (point)))))
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1689 (+ (current-indentation) py-indent-offset))))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1690
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1691 ;; else on backslash continuation line
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1692 (forward-line -1)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1693 (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	1694 (current-indentation) ; so just continue the pattern
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1695 ;; 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	1696 ;; 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	1697 ;; 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	1698 ;; 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	1699 ;; column
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1700 (end-of-line)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1701 (setq endpos (point) searching t)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1702 (back-to-indentation)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1703 (setq startpos (point))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1704 ;; 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	1705 ;; 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	1706 (while searching
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1707 (skip-chars-forward "^=" endpos)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1708 (if (= (point) endpos)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1709 (setq searching nil)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1710 (forward-char 1)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1711 (setq state (parse-partial-sexp startpos (point)))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1712 (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	1713 (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	1714 (progn
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1715 (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	1716 (setq found
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1717 (not (or
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1718 (eq (following-char) ?=)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1719 (memq (char-after (- (point) 2))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1720 '(?< ?> ?!)))))))))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1721 (if (or (not found) ; not an assignment
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1722 (looking-at "[ \t]*\\\\")) ; <=><spaces><backslash>
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1723 (progn
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1724 (goto-char startpos)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1725 (skip-chars-forward "^ \t\n")))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1726 (1+ (current-column))))))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1727
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1728 ;; 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	1729 ((bobp) (current-indentation))
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1730
3919 f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1731 ;; 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	1732 ;; 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	1733 ;; 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	1734 ;; 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	1735 ;; 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	1736
f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1737 ;; 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	1738 ;; - 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	1739 ;; - the character following the `#' is whitespace, and
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1740 ;; - the line is dedented with respect to (i.e. to the left
3919 f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1741 ;; 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	1742
f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1743 ;; 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	1744 ;; 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	1745 ;; 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	1746
f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1747 ;; 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	1748 ;; purposes.
f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1749
f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1750 ;; Are we looking at a comment-only line which is not an
8370 f2b0859fece3 #Documentation and comment typos patch given by Michael Ernst. More Barry Warsaw <barry@python.org> parents: 8070 diff changeset	1751 ;; indenting comment line? If so, we assume that it's been
3919 f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1752 ;; 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	1753 ;; 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	1754 ;; below.
f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1755 ((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	1756 ;; 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	1757 (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	1758 (<= (current-indentation)
f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1759 (save-excursion
f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	1760 (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	1761 (current-indentation))))
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1762 (current-indentation))
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1763
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1764 ;; 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	1765 ;; 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	1766 ;; 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	1767 ;; indentation for the continuation lines (if any)
3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1768 (t
3093 b3a8013cb4fa (py-compute-indentation): when inside a comment, indent to under the Barry Warsaw <barry@python.org> parents: 2799 diff changeset	1769 ;; 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	1770 ;; 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	1771 ;; 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	1772 ;; 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	1773 (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	1774 (fboundp 'forward-comment))
3426 6402be2689c5 (py-compute-indentation): fix skipping backwards over comments by Barry Warsaw <barry@python.org> parents: 3348 diff changeset	1775 (forward-comment (- (point-max)))
9136 e1b710e30acf (py-block-comment-prefix): Remove trailing space. Also explain that Barry Warsaw <barry@python.org> parents: 9106 diff changeset	1776 (let ((prefix-re (concat py-block-comment-prefix "[ \t]*"))
e1b710e30acf (py-block-comment-prefix): Remove trailing space. Also explain that Barry Warsaw <barry@python.org> parents: 9106 diff changeset	1777 done)
3434 529f4d9cbe3d (py-honor-comment-indentation, py-compute-indentation): allow other Barry Warsaw <barry@python.org> parents: 3429 diff changeset	1778 (while (not done)
8924 0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1779 (re-search-backward "^[ \t]*\$[^ \t\n#]\\\|#\$" nil 'move)
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1780 (setq done (or (bobp)
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1781 (and (eq py-honor-comment-indentation t)
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1782 (save-excursion
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1783 (back-to-indentation)
9136 e1b710e30acf (py-block-comment-prefix): Remove trailing space. Also explain that Barry Warsaw <barry@python.org> parents: 9106 diff changeset	1784 (not (looking-at prefix-re))
8924 0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1785 ))
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1786 (and (not (eq py-honor-comment-indentation t))
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1787 (save-excursion
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1788 (back-to-indentation)
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1789 (not (zerop (current-column)))))
0954ad4acdfd (py-compute-indentation): Changes to the `t' condition which affect Barry Warsaw <barry@python.org> parents: 8911 diff changeset	1790 ))
3434 529f4d9cbe3d (py-honor-comment-indentation, py-compute-indentation): allow other Barry Warsaw <barry@python.org> parents: 3429 diff changeset	1791 )))
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1792 ;; 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	1793 ;; 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	1794 ;; strings.
9639 da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1795 (py-goto-beginning-of-tqs (nth 3 (parse-partial-sexp bod (point))))
7143 3f0be7de7ca5 (py-compute-indentation): In the most common case, where indentation Barry Warsaw <barry@python.org> parents: 7142 diff changeset	1796 ;; now skip backward over continued lines
9639 da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1797 (setq placeholder (point))
3114 3aab925ebfb0 (py-align-multiline-strings-p): new variable Barry Warsaw <barry@python.org> parents: 3095 diff changeset	1798 (py-goto-initial-line)
9639 da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1799 ;; we may now have landed in a TQS, so find the beginning of
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1800 ;; this string.
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1801 (py-goto-beginning-of-tqs
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1802 (save-excursion (nth 3 (parse-partial-sexp
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	1803 placeholder (point)))))
3900 cba4ce15a0d5 (py-statement-closes-block-p, py-compute-indentation): Outdent one Barry Warsaw <barry@python.org> parents: 3818 diff changeset	1804 (+ (current-indentation)
cba4ce15a0d5 (py-statement-closes-block-p, py-compute-indentation): Outdent one Barry Warsaw <barry@python.org> parents: 3818 diff changeset	1805 (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	1806 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	1807 (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	1808 (- py-indent-offset)
cba4ce15a0d5 (py-statement-closes-block-p, py-compute-indentation): Outdent one Barry Warsaw <barry@python.org> parents: 3818 diff changeset	1809 0)))
cba4ce15a0d5 (py-statement-closes-block-p, py-compute-indentation): Outdent one Barry Warsaw <barry@python.org> parents: 3818 diff changeset	1810 )))))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1811
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1812 (defun py-guess-indent-offset (&optional global)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1813 "Guess a good value for, and change, `py-indent-offset'.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1814
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1815 By default, make a buffer-local copy of `py-indent-offset' with the
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1816 new value, so that other Python buffers are not affected. With
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1817 \\[universal-argument] (programmatically, optional argument GLOBAL),
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1818 change the global value of `py-indent-offset'. This affects all
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1819 Python buffers (that don't have their own buffer-local copy), both
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1820 those currently existing and those created later in the Emacs session.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1821
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1822 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	1823 There's no excuse for such foolishness, but sometimes you have to deal
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1824 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	1825 `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	1826 mess.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1827
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1828 Specifically, it searches forward from the statement containing point,
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1829 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	1830 set to the difference in indentation between that line and the Python
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1831 statement following it. If the search doesn't succeed going forward,
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1832 it's tried again going backward."
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1833 (interactive "P") ; raw prefix arg
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1834 (let (new-value
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1835 (start (point))
7725 663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1836 (restart (point))
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1837 (found nil)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1838 colon-indent)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1839 (py-goto-initial-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1840 (while (not (or found (eobp)))
7725 663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1841 (when (and (re-search-forward ":[ \t]*\$$\\\|[#\\]\$" nil 'move)
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1842 (not (py-in-literal restart)))
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1843 (setq restart (point))
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1844 (py-goto-initial-line)
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1845 (if (py-statement-opens-block-p)
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1846 (setq found t)
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1847 (goto-char restart))))
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1848 (unless found
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1849 (goto-char start)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1850 (py-goto-initial-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1851 (while (not (or found (bobp)))
7725 663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1852 (setq found (and
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1853 (re-search-backward ":[ \t]*\$$\\\|[#\\]\$" nil 'move)
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1854 (or (py-goto-initial-line) t) ; always true -- side effect
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1855 (py-statement-opens-block-p)))))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1856 (setq colon-indent (current-indentation)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1857 found (and found (zerop (py-next-statement 1)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1858 new-value (- (current-indentation) colon-indent))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1859 (goto-char start)
7725 663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1860 (if (not found)
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1861 (error "Sorry, couldn't guess a value for py-indent-offset")
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1862 (funcall (if global 'kill-local-variable 'make-local-variable)
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1863 'py-indent-offset)
663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1864 (setq py-indent-offset new-value)
9142 98dc675d0913 (py-guess-indent-offset): Only print message about py-indent-offset Barry Warsaw <barry@python.org> parents: 9141 diff changeset	1865 (or noninteractive
98dc675d0913 (py-guess-indent-offset): Only print message about py-indent-offset Barry Warsaw <barry@python.org> parents: 9141 diff changeset	1866 (message "%s value of py-indent-offset set to %d"
98dc675d0913 (py-guess-indent-offset): Only print message about py-indent-offset Barry Warsaw <barry@python.org> parents: 9141 diff changeset	1867 (if global "Global" "Local")
98dc675d0913 (py-guess-indent-offset): Only print message about py-indent-offset Barry Warsaw <barry@python.org> parents: 9141 diff changeset	1868 py-indent-offset)))
7725 663367ca13f8 (py-in-literal, py-fast-in-literal): New functions (mostly) stolen Barry Warsaw <barry@python.org> parents: 7724 diff changeset	1869 ))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1870
8628 aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1871 (defun py-comment-indent-function ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1872 "Python version of `comment-indent-function'."
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1873 ;; This is required when filladapt is turned off. Without it, when
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1874 ;; filladapt is not used, comments which start in column zero
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1875 ;; cascade one character to the right
8628 aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1876 (save-excursion
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1877 (beginning-of-line)
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1878 (let ((eol (py-point 'eol)))
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1879 (and comment-start-skip
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1880 (re-search-forward comment-start-skip eol t)
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1881 (setq eol (match-beginning 0)))
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1882 (goto-char eol)
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1883 (skip-chars-backward " \t")
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1884 (max comment-column (+ (current-column) (if (bolp) 0 1)))
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1885 )))
aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1886
9905 6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1887 (defun py-narrow-to-defun (&optional class)
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1888 "Make text outside current defun invisible.
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1889 The defun visible is the one that contains point or follows point.
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1890 Optional CLASS is passed directly to `py-beginning-of-def-or-class'."
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1891 (interactive "P")
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1892 (save-excursion
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1893 (widen)
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1894 (py-end-of-def-or-class class)
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1895 (let ((end (point)))
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1896 (py-beginning-of-def-or-class class)
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1897 (narrow-to-region (point) end))))
6cf01eab05a3 (py-narrow-to-defun): New command (bound to C-x n d) which mimics the Barry Warsaw <barry@python.org> parents: 9897 diff changeset	1898
8628 aea6841ab898 (py-comment-indent-function): A replacement for Barry Warsaw <barry@python.org> parents: 8381 diff changeset	1899
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1900 (defun py-shift-region (start end count)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1901 "Indent lines from START to END by COUNT spaces."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1902 (save-excursion
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1903 (goto-char end)
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1904 (beginning-of-line)
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1905 (setq end (point))
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1906 (goto-char start)
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1907 (beginning-of-line)
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1908 (setq start (point))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1909 (indent-rigidly start end count)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1910
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1911 (defun py-shift-region-left (start end &optional count)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1912 "Shift region of Python code to the left.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1913 The lines from the line containing the start of the current region up
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1914 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	1915 shifted to the left, by `py-indent-offset' columns.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1916
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1917 If a prefix argument is given, the region is instead shifted by that
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1918 many columns. With no active region, dedent only the current line.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1919 You cannot dedent the region if any line is already at column zero."
3743 b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1920 (interactive
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1921 (let ((p (point))
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1922 (m (mark))
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1923 (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	1924 (if m
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1925 (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	1926 (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	1927 ;; 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	1928 (save-excursion
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1929 (goto-char start)
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1930 (while (< (point) end)
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1931 (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	1932 (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	1933 (not (looking-at "\\s *$")))
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	1934 (error "Region is at left edge"))
3743 b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1935 (forward-line 1)))
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1936 (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	1937 (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	1938 (py-keep-region-active))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1939
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1940 (defun py-shift-region-right (start end &optional count)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1941 "Shift region of Python code to the right.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1942 The lines from the line containing the start of the current region up
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1943 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	1944 shifted to the right, by `py-indent-offset' columns.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1945
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1946 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	1947 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	1948 (interactive
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1949 (let ((p (point))
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1950 (m (mark))
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1951 (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	1952 (if m
b207876df29a (py-shift-region-left, py-shift-region-right, py-indent-right, Barry Warsaw <barry@python.org> parents: 3488 diff changeset	1953 (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	1954 (list p (save-excursion (forward-line 1) (point)) arg))))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1955 (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	1956 (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	1957 (py-keep-region-active))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1958
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1959 (defun py-indent-region (start end &optional indent-offset)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1960 "Reindent a region of Python code.
3445 07977bf0d997 (py-comment-region): obsoleted by comment-region Barry Warsaw <barry@python.org> parents: 3436 diff changeset	1961
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1962 The lines from the line containing the start of the current region up
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1963 to (but not including) the line containing the end of the region are
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1964 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	1965 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	1966 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	1967 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	1968 comment) statement immediately preceding the region.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1969
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1970 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	1971 control structures are introduced or removed, or to reformat code
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1972 using a new value for the indentation offset.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1973
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1974 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	1975 the indentation offset. Else the value of `py-indent-offset' will be
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1976 used.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1977
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1978 Warning: The region must be consistently indented before this function
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1979 is called! This function does not compute proper indentation from
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1980 scratch (that's impossible in Python), it merely adjusts the existing
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1981 indentation to be correct in context.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1982
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1983 Warning: This function really has no idea what to do with
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1984 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	1985 comment lines. Fixing this appears to require telepathy.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1986
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1987 Special cases: whitespace is deleted from blank lines; continuation
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1988 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	1989 in order to preserve their relative indentation with respect to their
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1990 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	1991 (interactive "*r\nP") ; region; raw prefix arg
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1992 (save-excursion
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1993 (goto-char end) (beginning-of-line) (setq end (point-marker))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	1994 (goto-char start) (beginning-of-line)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1995 (let ((py-indent-offset (prefix-numeric-value
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1996 (or indent-offset py-indent-offset)))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1997 (indents '(-1)) ; stack of active indent levels
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1998 (target-column 0) ; column to which to indent
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	1999 (base-shifted-by 0) ; amount last base line was shifted
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2000 (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	2001 (py-compute-indentation t)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2002 0))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2003 ci)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2004 (while (< (point) end)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2005 (setq ci (current-indentation))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2006 ;; figure out appropriate target column
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2007 (cond
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2008 ((or (eq (following-char) ?#) ; comment in column 1
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2009 (looking-at "[ \t]*$")) ; entirely blank
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2010 (setq target-column 0))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2011 ((py-continuation-line-p) ; shift relative to base line
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2012 (setq target-column (+ ci base-shifted-by)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2013 (t ; new base line
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2014 (if (> ci (car indents)) ; going deeper; push it
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2015 (setq indents (cons ci indents))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2016 ;; else we should have seen this indent before
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2017 (setq indents (memq ci indents)) ; pop deeper indents
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2018 (if (null indents)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2019 (error "Bad indentation in region, at line %d"
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2020 (save-restriction
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2021 (widen)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2022 (1+ (count-lines 1 (point)))))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2023 (setq target-column (+ indent-base
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2024 (* py-indent-offset
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2025 (- (length indents) 2))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2026 (setq base-shifted-by (- target-column ci))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2027 ;; shift as needed
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2028 (if (/= ci target-column)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2029 (progn
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2030 (delete-horizontal-space)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2031 (indent-to target-column)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2032 (forward-line 1))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2033 (set-marker end nil))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2034
3919 f487793d6018 (py-mode): comment-start is now "# " so indent-for-comment does the Barry Warsaw <barry@python.org> parents: 3905 diff changeset	2035 (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	2036 "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	2037 (interactive "r\nP")
3926 1da168185e4e #updated comments Barry Warsaw <barry@python.org> parents: 3925 diff changeset	2038 (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	2039 (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	2040
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2041
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2042 ;; Functions for moving point
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2043 (defun py-previous-statement (count)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2044 "Go to the start of the COUNTth preceding Python statement.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2045 By default, goes to the previous statement. If there is no such
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2046 statement, goes to the first statement. Return count of statements
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2047 left to move. `Statements' do not include blank, comment, or
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2048 continuation lines."
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2049 (interactive "p") ; numeric prefix arg
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2050 (if (< count 0) (py-next-statement (- count))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2051 (py-goto-initial-line)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2052 (let (start)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2053 (while (and
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2054 (setq start (point)) ; always true -- side effect
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2055 (> count 0)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2056 (zerop (forward-line -1))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2057 (py-goto-statement-at-or-above))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2058 (setq count (1- count)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2059 (if (> count 0) (goto-char start)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2060 count))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2061
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2062 (defun py-next-statement (count)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2063 "Go to the start of next Python statement.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2064 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	2065 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	2066 last statement. Returns count of statements left to move. `Statements'
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2067 do not include blank, comment, or continuation lines."
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2068 (interactive "p") ; numeric prefix arg
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2069 (if (< count 0) (py-previous-statement (- count))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2070 (beginning-of-line)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2071 (let (start)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2072 (while (and
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2073 (setq start (point)) ; always true -- side effect
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2074 (> count 0)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2075 (py-goto-statement-below))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2076 (setq count (1- count)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2077 (if (> count 0) (goto-char start)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2078 count))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2079
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2080 (defun py-goto-block-up (&optional nomark)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2081 "Move up to start of current block.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2082 Go to the statement that starts the smallest enclosing block; roughly
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2083 speaking, this will be the closest preceding statement that ends with a
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2084 colon and is indented less than the statement you started on. If
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2085 successful, also sets the mark to the starting point.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2086
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2087 `\\[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	2088 block, if desired.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2089
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2090 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	2091 NOMARK is not nil."
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2092 (interactive)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2093 (let ((start (point))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2094 (found nil)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2095 initial-indent)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2096 (py-goto-initial-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2097 ;; if on blank or non-indenting comment line, use the preceding stmt
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2098 (if (looking-at "[ \t]*\$$\\\|#[^ \t\n]\$")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2099 (progn
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2100 (py-goto-statement-at-or-above)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2101 (setq found (py-statement-opens-block-p))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2102 ;; search back for colon line indented less
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2103 (setq initial-indent (current-indentation))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2104 (if (zerop initial-indent)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2105 ;; force fast exit
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2106 (goto-char (point-min)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2107 (while (not (or found (bobp)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2108 (setq found
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2109 (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2110 (re-search-backward ":[ \t]*\$$\\\|[#\\]\$" nil 'move)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2111 (or (py-goto-initial-line) t) ; always true -- side effect
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2112 (< (current-indentation) initial-indent)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2113 (py-statement-opens-block-p))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2114 (if found
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2115 (progn
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2116 (or nomark (push-mark start))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2117 (back-to-indentation))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2118 (goto-char start)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2119 (error "Enclosing block not found"))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2120
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2121 (defun py-beginning-of-def-or-class (&optional class count)
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2122 "Move point to start of `def' or `class'.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2123
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2124 Searches back for the closest preceding `def'. If you supply a prefix
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2125 arg, looks for a `class' instead. The docs below assume the `def'
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2126 case; just substitute `class' for `def' for the other case.
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2127 Programmatically, if CLASS is `either', then moves to either `class'
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2128 or `def'.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2129
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2130 When second optional argument is given programmatically, move to the
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2131 COUNTth start of `def'.
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2132
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2133 If point is in a `def' statement already, and after the `d', simply
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2134 moves point to the start of the statement.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2135
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2136 Otherwise (i.e. when point is not in a `def' statement, or at or
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2137 before the `d' of a `def' statement), searches for the closest
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2138 preceding `def' statement, and leaves point at its start. If no such
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2139 statement can be found, leaves point at the start of the buffer.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2140
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2141 Returns t iff a `def' statement is found by these rules.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2142
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2143 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	2144 start of the buffer each time.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2145
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2146 To mark the current `def', see `\\[py-mark-def-or-class]'."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2147 (interactive "P") ; raw prefix arg
9457 54422b46f6d1 #XEmacs 21 now supports Imenu, so I am able to test (and fix) some Barry Warsaw <barry@python.org> parents: 9456 diff changeset	2148 (setq count (or count 1))
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2149 (let ((at-or-before-p (<= (current-column) (current-indentation)))
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2150 (start-of-line (goto-char (py-point 'bol)))
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2151 (start-of-stmt (goto-char (py-point 'bos)))
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2152 (start-re (cond ((eq class 'either) "^[ \t]*\$class\\\|def\$\\>")
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2153 (class "^[ \t]*class\\>")
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2154 (t "^[ \t]*def\\>")))
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2155 )
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2156 ;; searching backward
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2157 (if (and (< 0 count)
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2158 (or (/= start-of-stmt start-of-line)
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2159 (not at-or-before-p)))
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2160 (end-of-line))
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2161 ;; search forward
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2162 (if (and (> 0 count)
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2163 (zerop (current-column))
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2164 (looking-at start-re))
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2165 (end-of-line))
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2166 (re-search-backward start-re nil 'move count)
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2167 (goto-char (match-beginning 0))))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2168
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2169 ;; Backwards compatibility
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2170 (defalias 'beginning-of-python-def-or-class 'py-beginning-of-def-or-class)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2171
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2172 (defun py-end-of-def-or-class (&optional class count)
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2173 "Move point beyond end of `def' or `class' body.
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2174
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2175 By default, looks for an appropriate `def'. If you supply a prefix
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2176 arg, looks for a `class' instead. The docs below assume the `def'
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2177 case; just substitute `class' for `def' for the other case.
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2178 Programmatically, if CLASS is `either', then moves to either `class'
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2179 or `def'.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2180
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2181 When second optional argument is given programmatically, move to the
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2182 COUNTth end of `def'.
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2183
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2184 If point is in a `def' statement already, this is the `def' we use.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2185
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2186 Else, if the `def' found by `\\[py-beginning-of-def-or-class]'
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2187 contains the statement you started on, that's the `def' we use.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2188
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2189 Otherwise, we search forward for the closest following `def', and use that.
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2190
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2191 If a `def' can be found by these rules, point is moved to the start of
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2192 the line immediately following the `def' block, and the position of the
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2193 start of the `def' is returned.
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 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	2196
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2197 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	2198 end of the buffer each time.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2199
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2200 To mark the current `def', see `\\[py-mark-def-or-class]'."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2201 (interactive "P") ; raw prefix arg
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2202 (if (and count (/= count 1))
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2203 (py-beginning-of-def-or-class (- 1 count)))
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2204 (let ((start (progn (py-goto-initial-line) (point)))
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2205 (which (cond ((eq class 'either) "\$class\\\|def\$")
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2206 (class "class")
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2207 (t "def")))
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2208 (state 'not-found))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2209 ;; move point to start of appropriate def/class
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2210 (if (looking-at (concat "[ \t]*" which "\\>")) ; already on one
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2211 (setq state 'at-beginning)
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2212 ;; else see if py-beginning-of-def-or-class hits container
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2213 (if (and (py-beginning-of-def-or-class class)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2214 (progn (py-goto-beyond-block)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2215 (> (point) start)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2216 (setq state 'at-end)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2217 ;; else search forward
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2218 (goto-char start)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2219 (if (re-search-forward (concat "^[ \t]*" which "\\>") nil 'move)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2220 (progn (setq state 'at-beginning)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2221 (beginning-of-line)))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2222 (cond
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2223 ((eq state 'at-beginning) (py-goto-beyond-block) t)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2224 ((eq state 'at-end) t)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2225 ((eq state 'not-found) nil)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2226 (t (error "Internal error in `py-end-of-def-or-class'")))))
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2227
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2228 ;; Backwards compabitility
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	2229 (defalias 'end-of-python-def-or-class 'py-end-of-def-or-class)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2230
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2231
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2232 ;; Functions for marking regions
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2233 (defun py-mark-block (&optional extend just-move)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2234 "Mark following block of lines. With prefix arg, mark structure.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2235 Easier to use than explain. It sets the region to an `interesting'
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2236 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	2237 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	2238 of the region depends on the kind of line at the start:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2239
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2240 - If a comment, the region will include all succeeding comment lines up
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2241 to (but not including) the next non-comment line (if any).
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2242
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2243 - 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	2244 structures:
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2245
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2246 if elif else try except finally for while def class
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2247
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2248 the region will be set to the body of the structure, including
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2249 following blocks that `belong' to it, but excluding trailing blank
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2250 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	2251 and all (if any) of the following `except' and `finally' blocks
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2252 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	2253 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	2254 degenerate, since they're always one-block structures) def and
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2255 class blocks.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2256
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2257 - 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	2258 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	2259 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	2260 include all succeeding lines up to (but not including) the next
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2261 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	2262 line, except that trailing blank and comment lines are excluded.
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2263 E.g., if the starting line begins a multi-statement `def'
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2264 structure, the region will be set to the full function definition,
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2265 but without any trailing `noise' lines.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2266
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2267 - Else the region will include all succeeding lines up to (but not
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2268 including) the next blank line, or code or indenting-comment line
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2269 indented strictly less than the starting line. Trailing indenting
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2270 comment lines are included in this case, but not trailing blank
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2271 lines.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2272
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2273 A msg identifying the location of the mark is displayed in the echo
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2274 area; or do `\\[exchange-point-and-mark]' to flip down to the end.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2275
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2276 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	2277 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	2278 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	2279 (interactive "P") ; raw prefix arg
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2280 (py-goto-initial-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2281 ;; skip over blank lines
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2282 (while (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2283 (looking-at "[ \t]*$") ; while blank line
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2284 (not (eobp))) ; & somewhere to go
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2285 (forward-line 1))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2286 (if (eobp)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2287 (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	2288 (let ((initial-pos (point))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2289 (initial-indent (current-indentation))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2290 last-pos ; position of last stmt in region
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2291 (followers
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2292 '((if elif else) (elif elif else) (else)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2293 (try except finally) (except except) (finally)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2294 (for else) (while else)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2295 (def) (class) ) )
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2296 first-symbol next-symbol)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2297
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2298 (cond
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2299 ;; if comment line, suck up the following comment lines
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2300 ((looking-at "[ \t]*#")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2301 (re-search-forward "^[ \t]*[^ \t#]" nil 'move) ; look for non-comment
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2302 (re-search-backward "^[ \t]*#") ; and back to last comment in block
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2303 (setq last-pos (point)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2304
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2305 ;; else if line is a block line and EXTEND given, suck up
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2306 ;; the whole structure
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2307 ((and extend
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2308 (setq first-symbol (py-suck-up-first-keyword) )
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2309 (assq first-symbol followers))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2310 (while (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2311 (or (py-goto-beyond-block) t) ; side effect
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2312 (forward-line -1) ; side effect
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2313 (setq last-pos (point)) ; side effect
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2314 (py-goto-statement-below)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2315 (= (current-indentation) initial-indent)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2316 (setq next-symbol (py-suck-up-first-keyword))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2317 (memq next-symbol (cdr (assq first-symbol followers))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2318 (setq first-symbol next-symbol)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2319
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2320 ;; else if line opens a block, search for next stmt indented <=
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2321 ((py-statement-opens-block-p)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2322 (while (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2323 (setq last-pos (point)) ; always true -- side effect
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2324 (py-goto-statement-below)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2325 (> (current-indentation) initial-indent))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2326 nil))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2327
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2328 ;; else plain code line; stop at next blank line, or stmt or
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2329 ;; indenting comment line indented <
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2330 (t
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2331 (while (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2332 (setq last-pos (point)) ; always true -- side effect
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2333 (or (py-goto-beyond-final-line) t)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2334 (not (looking-at "[ \t]*$")) ; stop at blank line
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2335 (or
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2336 (>= (current-indentation) initial-indent)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2337 (looking-at "[ \t]*#[^ \t\n]"))) ; ignore non-indenting #
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2338 nil)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2339
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2340 ;; skip to end of last stmt
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2341 (goto-char last-pos)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2342 (py-goto-beyond-final-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2343
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2344 ;; set mark & display
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2345 (if just-move
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2346 () ; just return
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2347 (push-mark (point) 'no-msg)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2348 (forward-line -1)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2349 (message "Mark set after: %s" (py-suck-up-leading-text))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2350 (goto-char initial-pos))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2351
6559 1a233be5fc17 (mark-python-def-or-class): Renamed to py-mark-def-or-class globally. Barry Warsaw <barry@python.org> parents: 6556 diff changeset	2352 (defun py-mark-def-or-class (&optional class)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2353 "Set region to body of def (or class, with prefix arg) enclosing point.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2354 Pushes the current mark, then point, on the mark ring (all language
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2355 modes do this, but although it's handy it's never documented ...).
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2356
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2357 In most Emacs language modes, this function bears at least a
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2358 hallucinogenic resemblance to `\\[py-end-of-def-or-class]' and
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2359 `\\[py-beginning-of-def-or-class]'.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2360
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2361 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	2362 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	2363 `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	2364 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	2365 forward' string-search commands. But because Python `def' and `class'
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2366 can nest to arbitrary levels, finding the smallest def containing
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2367 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	2368 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	2369 preceding def that's indented less. The fancy algorithm required is
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2370 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	2371 `goto' variations.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2372
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2373 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	2374 `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	2375 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	2376 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	2377 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	2378 that. Else signals an error.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2379
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2380 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	2381 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	2382 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	2383 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	2384 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	2385 point is left at its start.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2386
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2387 The intent is to mark the containing def/class and its associated
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2388 documentation, to make moving and duplicating functions and classes
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2389 pleasant."
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2390 (interactive "P") ; raw prefix arg
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2391 (let ((start (point))
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2392 (which (cond ((eq class 'either) "\$class\\\|def\$")
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2393 (class "class")
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2394 (t "def"))))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2395 (push-mark start)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2396 (if (not (py-go-up-tree-to-keyword which))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2397 (progn (goto-char start)
8629 239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2398 (error "Enclosing %s not found"
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2399 (if (eq class 'either)
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2400 "def or class"
239492b34f68 (py-beginning-of-def-or-class, py-end-of-def-or-class, Barry Warsaw <barry@python.org> parents: 8628 diff changeset	2401 which)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2402 ;; else enclosing def/class found
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2403 (setq start (point))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2404 (py-goto-beyond-block)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2405 (push-mark (point))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2406 (goto-char start)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2407 (if (zerop (forward-line -1)) ; if there is a preceding line
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2408 (progn
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2409 (if (looking-at "[ \t]*$") ; it's blank
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2410 (setq start (point)) ; so reset start point
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2411 (goto-char start)) ; else try again
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2412 (if (zerop (forward-line -1))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2413 (if (looking-at "[ \t]*#") ; a comment
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2414 ;; look back for non-comment line
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2415 ;; tricky: note that the regexp matches a blank
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2416 ;; line, cuz \n is in the 2nd character class
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2417 (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2418 (re-search-backward "^[ \t]*[^ \t#]" nil 'move)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2419 (forward-line 1))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2420 ;; no comment, so go back
6669 2f5c8374825c (py-mark-def-or-class): Added an exchange-point-and-mark and a Barry Warsaw <barry@python.org> parents: 6668 diff changeset	2421 (goto-char start)))))))
2f5c8374825c (py-mark-def-or-class): Added an exchange-point-and-mark and a Barry Warsaw <barry@python.org> parents: 6668 diff changeset	2422 (exchange-point-and-mark)
2f5c8374825c (py-mark-def-or-class): Added an exchange-point-and-mark and a Barry Warsaw <barry@python.org> parents: 6668 diff changeset	2423 (py-keep-region-active))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2424
3811 b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2425 ;; ripped from cc-mode
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2426 (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	2427 "Move forward to end of a nomenclature section or word.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2428 With \\[universal-argument] (programmatically, optional argument ARG),
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2429 do it that many times.
3811 b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2430
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2431 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	2432 (interactive "p")
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2433 (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	2434 (if (> arg 0)
3937 decd13f6629d (py-forward-into-nomenclature): Slightly better regex for stopping on Barry Warsaw <barry@python.org> parents: 3934 diff changeset	2435 (re-search-forward
decd13f6629d (py-forward-into-nomenclature): Slightly better regex for stopping on Barry Warsaw <barry@python.org> parents: 3934 diff changeset	2436 "\$\\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	2437 (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	2438 (while (and (< arg 0)
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2439 (re-search-backward
3937 decd13f6629d (py-forward-into-nomenclature): Slightly better regex for stopping on Barry Warsaw <barry@python.org> parents: 3934 diff changeset	2440 "\$\\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	2441 (point-min) 0))
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2442 (forward-char 1)
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2443 (setq arg (1+ arg)))))
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2444 (py-keep-region-active))
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2445
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2446 (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	2447 "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	2448 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	2449 forward.
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2450
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2451 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	2452 (interactive "p")
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2453 (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	2454 (py-keep-region-active))
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2455
b9a0434d2cb6 (py-forward-into-nomenclature, py-backward-into-nomenclature): New functions. Barry Warsaw <barry@python.org> parents: 3796 diff changeset	2456
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2457
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2458 ;; Documentation functions
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2459
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2460 ;; 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	2461 ;; 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	2462 ;; 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	2463 ;; values
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2464 (defun py-dump-help-string (str)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2465 (with-output-to-temp-buffer "Help"
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2466 (let ((locals (buffer-local-variables))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2467 funckind funcname func funcdoc
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2468 (start 0) mstart end
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2469 keys )
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2470 (while (string-match "^%\$[vc]\$:\$.+\$\n" str start)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2471 (setq mstart (match-beginning 0) end (match-end 0)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2472 funckind (substring str (match-beginning 1) (match-end 1))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2473 funcname (substring str (match-beginning 2) (match-end 2))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2474 func (intern funcname))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2475 (princ (substitute-command-keys (substring str start mstart)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2476 (cond
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2477 ((equal funckind "c") ; command
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2478 (setq funcdoc (documentation func)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2479 keys (concat
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2480 "Key(s): "
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2481 (mapconcat 'key-description
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2482 (where-is-internal func py-mode-map)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2483 ", "))))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2484 ((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	2485 (setq funcdoc (documentation-property func 'variable-documentation)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2486 keys (if (assq func locals)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2487 (concat
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2488 "Local/Global values: "
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2489 (prin1-to-string (symbol-value func))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2490 " / "
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2491 (prin1-to-string (default-value func)))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2492 (concat
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2493 "Value: "
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2494 (prin1-to-string (symbol-value func))))))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2495 (t ; unexpected
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2496 (error "Error in py-dump-help-string, tag `%s'" funckind)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2497 (princ (format "\n-> %s:\t%s\t%s\n\n"
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2498 (if (equal funckind "c") "Command" "Variable")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2499 funcname keys))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2500 (princ funcdoc)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2501 (terpri)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2502 (setq start end))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2503 (princ (substitute-command-keys (substring str start))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2504 (print-help-return-message)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2505
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2506 (defun py-describe-mode ()
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2507 "Dump long form of Python-mode docs."
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2508 (interactive)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2509 (py-dump-help-string "Major mode for editing Python files.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2510 Knows about Python indentation, tokens, comments and continuation lines.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2511 Paragraphs are separated by blank lines only.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2512
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2513 Major sections below begin with the string `@'; specific function and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2514 variable docs begin with `->'.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2515
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2516 @EXECUTING PYTHON CODE
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2517
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	2518 \\[py-execute-import-or-reload]\timports or reloads the file in the Python interpreter
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2519 \\[py-execute-buffer]\tsends the entire buffer to the Python interpreter
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2520 \\[py-execute-region]\tsends the current region
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	2521 \\[py-execute-def-or-class]\tsends the current function or class definition
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	2522 \\[py-execute-string]\tsends an arbitrary string
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2523 \\[py-shell]\tstarts a Python interpreter window; this will be used by
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	2524 \tsubsequent Python execution commands
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	2525 %c:py-execute-import-or-reload
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2526 %c:py-execute-buffer
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2527 %c:py-execute-region
8378 7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	2528 %c:py-execute-def-or-class
7ac15f1e5302 More ME patches: Barry Warsaw <barry@python.org> parents: 8377 diff changeset	2529 %c:py-execute-string
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2530 %c:py-shell
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2531
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2532 @VARIABLES
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2533
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2534 py-indent-offset\tindentation increment
3818 3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	2535 py-block-comment-prefix\tcomment string used by comment-region
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2536
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2537 py-python-command\tshell command to invoke Python interpreter
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2538 py-temp-directory\tdirectory used for temp files (if needed)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2539
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2540 py-beep-if-tab-change\tring the bell if tab-width is changed
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2541 %v:py-indent-offset
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2542 %v:py-block-comment-prefix
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2543 %v:py-python-command
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2544 %v:py-temp-directory
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2545 %v:py-beep-if-tab-change
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2546
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2547 @KINDS OF LINES
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2548
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2549 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	2550 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	2551 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	2552 non-zero, or both) or an `initial line' (everything else).
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2553
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2554 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	2555 possibly blanks or tabs), a `comment line' (leftmost non-blank
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2556 character is `#'), or a `code line' (everything else).
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2557
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2558 Comment Lines
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2559
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2560 Although all comment lines are treated alike by Python, Python mode
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2561 recognizes two kinds that act differently with respect to indentation.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2562
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2563 An `indenting comment line' is a comment line with a blank, tab or
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2564 nothing after the initial `#'. The indentation commands (see below)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2565 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	2566 indenting comment line will be indented like the comment line. All
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2567 other comment lines (those with a non-whitespace character immediately
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2568 following the initial `#') are `non-indenting comment lines', and
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2569 their indentation is ignored by the indentation commands.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2570
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2571 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	2572 whenever possible. Non-indenting comment lines are useful in cases
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2573 like these:
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2574
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2575 \ta = b # a very wordy single-line comment that ends up being
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2576 \t #... continued onto another line
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2577
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2578 \tif a == b:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2579 ##\t\tprint 'panic!' # old code we've `commented out'
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2580 \t\treturn a
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2581
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2582 Since the `#...' and `##' comment lines have a non-whitespace
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2583 character following the initial `#', Python mode ignores them when
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2584 computing the proper indentation for the next line.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2585
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2586 Continuation Lines and Statements
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2587
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2588 The Python-mode commands generally work on statements instead of on
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2589 individual lines, where a `statement' is a comment or blank line, or a
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2590 code line and all of its following continuation lines (if any)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2591 considered as a single logical unit. The commands in this mode
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2592 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	2593 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	2594 of some continuation line.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2595
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2596
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2597 @INDENTATION
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2598
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2599 Primarily for entering new code:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2600 \t\\[indent-for-tab-command]\t indent line appropriately
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2601 \t\\[py-newline-and-indent]\t insert newline, then indent
6730 9c9a87b5bb17 Removed redundant eval-when-compile. Barry Warsaw <barry@python.org> parents: 6726 diff changeset	2602 \t\\[py-electric-backspace]\t reduce indentation, or delete single character
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2603
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2604 Primarily for reindenting existing code:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2605 \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	2606 \t\\[universal-argument] \\[py-guess-indent-offset]\t ditto, but change globally
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2607
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2608 \t\\[py-indent-region]\t reindent region to match its context
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2609 \t\\[py-shift-region-left]\t shift region left by py-indent-offset
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2610 \t\\[py-shift-region-right]\t shift region right by py-indent-offset
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2611
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2612 Unlike most programming languages, Python uses indentation, and only
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2613 indentation, to specify block structure. Hence the indentation supplied
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2614 automatically by Python-mode is just an educated guess: only you know
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2615 the block structure you intend, so only you can supply correct
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2616 indentation.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2617
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2618 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	2619 the indentation of preceding statements. E.g., assuming
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2620 py-indent-offset is 4, after you enter
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2621 \tif a > 0: \\[py-newline-and-indent]
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2622 the cursor will be moved to the position of the `_' (_ is not a
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2623 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	2624 the cursor):
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2625 \tif a > 0:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2626 \t _
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2627 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	2628 to
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2629 \tif a > 0:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2630 \t c = d
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2631 \t _
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2632 Python-mode cannot know whether that's what you intended, or whether
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2633 \tif a > 0:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2634 \t c = d
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2635 \t_
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2636 was your intent. In general, Python-mode either reproduces the
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2637 indentation of the (closest code or indenting-comment) preceding
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2638 statement, or adds an extra py-indent-offset blanks if the preceding
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2639 statement has `:' as its last significant (non-whitespace and non-
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2640 comment) character. If the suggested indentation is too much, use
6730 9c9a87b5bb17 Removed redundant eval-when-compile. Barry Warsaw <barry@python.org> parents: 6726 diff changeset	2641 \\[py-electric-backspace] to reduce it.
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2642
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2643 Continuation lines are given extra indentation. If you don't like the
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2644 suggested indentation, change it to something you do like, and Python-
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2645 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	2646
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2647 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	2648 paren/bracket/brace structure (`list', for short), the suggested
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2649 indentation depends on whether the current line contains the first item
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2650 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	2651 the indentation of the line containing the open bracket. If you don't
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2652 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	2653 whatever indentation you give to the first item.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2654
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2655 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	2656 a backslash, the third and following lines of the statement inherit their
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2657 indentation from the line preceding them. The indentation of the second
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2658 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	2659 the base line is an assignment statement with anything more interesting
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2660 than the backslash following the leftmost assigning `=', the second line
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2661 is indented two columns beyond that `='. Else it's indented to two
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2662 columns beyond the leftmost solid chunk of non-whitespace characters on
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2663 the base line.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2664
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2665 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	2666 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	2667 structure you intend.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2668 %c:indent-for-tab-command
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2669 %c:py-newline-and-indent
6730 9c9a87b5bb17 Removed redundant eval-when-compile. Barry Warsaw <barry@python.org> parents: 6726 diff changeset	2670 %c:py-electric-backspace
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2671
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2672
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2673 The next function may be handy when editing code you didn't write:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2674 %c:py-guess-indent-offset
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2675
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2676
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2677 The remaining `indent' functions apply to a region of Python code. They
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2678 assume the block structure (equals indentation, in Python) of the region
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2679 is correct, and alter the indentation in various ways while preserving
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2680 the block structure:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2681 %c:py-indent-region
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2682 %c:py-shift-region-left
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2683 %c:py-shift-region-right
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2684
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2685 @MARKING & MANIPULATING REGIONS OF CODE
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2686
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2687 \\[py-mark-block]\t mark block of lines
6559 1a233be5fc17 (mark-python-def-or-class): Renamed to py-mark-def-or-class globally. Barry Warsaw <barry@python.org> parents: 6556 diff changeset	2688 \\[py-mark-def-or-class]\t mark smallest enclosing def
1a233be5fc17 (mark-python-def-or-class): Renamed to py-mark-def-or-class globally. Barry Warsaw <barry@python.org> parents: 6556 diff changeset	2689 \\[universal-argument] \\[py-mark-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	2690 \\[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	2691 \\[universal-argument] \\[comment-region]\t uncomment region of code
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2692 %c:py-mark-block
6559 1a233be5fc17 (mark-python-def-or-class): Renamed to py-mark-def-or-class globally. Barry Warsaw <barry@python.org> parents: 6556 diff changeset	2693 %c:py-mark-def-or-class
3818 3c5ca7727988 (python-mode): Added menu support, requires easymenu. Barry Warsaw <barry@python.org> parents: 3813 diff changeset	2694 %c:comment-region
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2695
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2696 @MOVING POINT
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2697
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2698 \\[py-previous-statement]\t move to statement preceding point
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2699 \\[py-next-statement]\t move to statement following point
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2700 \\[py-goto-block-up]\t move up to start of current block
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2701 \\[py-beginning-of-def-or-class]\t move to start of def
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2702 \\[universal-argument] \\[py-beginning-of-def-or-class]\t move to start of class
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2703 \\[py-end-of-def-or-class]\t move to end of def
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2704 \\[universal-argument] \\[py-end-of-def-or-class]\t move to end of class
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2705
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2706 The first two move to one statement beyond the statement that contains
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2707 point. A numeric prefix argument tells them to move that many
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2708 statements instead. Blank lines, comment lines, and continuation lines
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2709 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	2710 to the first code statement in a file by entering
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2711 \t\\[beginning-of-buffer]\t to move to the top of the file
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2712 \t\\[py-next-statement]\t to skip over initial comments and blank lines
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2713 Or do `\\[py-previous-statement]' with a huge prefix argument.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2714 %c:py-previous-statement
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2715 %c:py-next-statement
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2716 %c:py-goto-block-up
8377 95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2717 %c:py-beginning-of-def-or-class
95f7c52b6399 (beginning-of-python-def-or-class): Renamed to Barry Warsaw <barry@python.org> parents: 8371 diff changeset	2718 %c:py-end-of-def-or-class
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2719
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2720 @LITTLE-KNOWN EMACS COMMANDS PARTICULARLY USEFUL IN PYTHON MODE
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2721
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2722 `\\[indent-new-comment-line]' is handy for entering a multi-line comment.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2723
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2724 `\\[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	2725 overall class and def structure of a module.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2726
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2727 `\\[back-to-indentation]' moves point to a line's first non-blank character.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2728
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2729 `\\[indent-relative]' is handy for creating odd indentation.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2730
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2731 @OTHER EMACS HINTS
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2732
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2733 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	2734 whatever you do like by putting a `setq' line in your .emacs file.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2735 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	2736 .emacs:
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2737 \t(setq py-indent-offset 4)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2738 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	2739 name at the prompt.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2740
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2741 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	2742 release the CONTROL key after doing the `C-c' part -- it suffices to
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2743 press the CONTROL key, press and release `c' (while still holding down
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2744 CONTROL), press and release `n' (while still holding down CONTROL), &
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2745 then release CONTROL.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2746
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2747 Entering Python mode calls with no arguments the value of the variable
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2748 `python-mode-hook', if that value exists and is not nil; for backward
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2749 compatibility it also tries `py-mode-hook'; see the `Hooks' section of
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2750 the Elisp manual for details.
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2751
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2752 Obscure: When python-mode is first loaded, it looks for all bindings
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2753 to newline-and-indent in the global keymap, and shadows them with
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2754 local bindings to py-newline-and-indent."))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2755
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2756
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2757 ;; Helper functions
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2758 (defvar py-parse-state-re
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2759 (concat
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2760 "^[ \t]*\$if\\\|elif\\\|else\\\|while\\\|def\\\|class\$\\>"
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2761 "\\\|"
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2762 "^[^ #\t\n]"))
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2763
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2764 (defun py-parse-state ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2765 "Return the parse state at point (see `parse-partial-sexp' docs)."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2766 (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	2767 (let ((here (point))
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	2768 pps done)
3487 83557153f544 (py-parse-state): make sure we don't land inside a triple-quoted Barry Warsaw <barry@python.org> parents: 3480 diff changeset	2769 (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	2770 ;; 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	2771 ;; 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	2772 ;; 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	2773 ;; 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	2774 ;; 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	2775 ;; 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	2776 (re-search-backward py-parse-state-re nil 'move)
83557153f544 (py-parse-state): make sure we don't land inside a triple-quoted Barry Warsaw <barry@python.org> parents: 3480 diff changeset	2777 (beginning-of-line)
7262 c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2778 ;; In XEmacs, we have a much better way to test for whether
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2779 ;; we're in a triple-quoted string or not. Emacs does not
8370 f2b0859fece3 #Documentation and comment typos patch given by Michael Ernst. More Barry Warsaw <barry@python.org> parents: 8070 diff changeset	2780 ;; have this built-in function, which is its loss because
7262 c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2781 ;; without scanning from the beginning of the buffer, there's
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2782 ;; no accurate way to determine this otherwise.
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2783 (if (not (fboundp 'buffer-syntactic-context))
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2784 ;; Emacs
7776 db94b15bd640 Two patches for Emacs 20.2 compatibility: Barry Warsaw <barry@python.org> parents: 7743 diff changeset	2785 (progn
db94b15bd640 Two patches for Emacs 20.2 compatibility: Barry Warsaw <barry@python.org> parents: 7743 diff changeset	2786 (save-excursion (setq pps (parse-partial-sexp (point) here)))
7262 c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2787 ;; make sure we don't land inside a triple-quoted string
7672 1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	2788 (setq done (or (not (nth 3 pps))
1fb868f25459 (py-smart-indentation): New variable which controls the automagic Barry Warsaw <barry@python.org> parents: 7481 diff changeset	2789 (bobp))))
7262 c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2790 ;; XEmacs
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2791 (setq done (or (not (buffer-syntactic-context))
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2792 (bobp)))
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2793 (when done
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2794 (setq pps (parse-partial-sexp (point) here)))
c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2795 ))
3487 83557153f544 (py-parse-state): make sure we don't land inside a triple-quoted Barry Warsaw <barry@python.org> parents: 3480 diff changeset	2796 pps)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2797
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2798 (defun py-nesting-level ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2799 "Return the buffer position of the last unclosed enclosing list.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2800 If nesting level is zero, return nil."
7262 c09907104092 (py-compute-indentation): Several changes made to improve navigation Barry Warsaw <barry@python.org> parents: 7201 diff changeset	2801 (let ((status (py-parse-state)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2802 (if (zerop (car status))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2803 nil ; not in a nest
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2804 (car (cdr status))))) ; char# of open bracket
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2805
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2806 (defun py-backslash-continuation-line-p ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2807 "Return t iff preceding line ends with backslash that is not in a comment."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2808 (save-excursion
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2809 (beginning-of-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2810 (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2811 ;; use a cheap test first to avoid the regexp if possible
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2812 ;; use 'eq' because char-after may return nil
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2813 (eq (char-after (- (point) 2)) ?\\ )
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2814 ;; 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	2815 (forward-line -1) ; always true -- side effect
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2816 (looking-at py-continued-re))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2817
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2818 (defun py-continuation-line-p ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2819 "Return t iff current line is a continuation line."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2820 (save-excursion
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2821 (beginning-of-line)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2822 (or (py-backslash-continuation-line-p)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2823 (py-nesting-level))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2824
9639 da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2825 (defun py-goto-beginning-of-tqs (delim)
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2826 "Go to the beginning of the triple quoted string we find ourselves in.
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2827 DELIM is the TQS string delimiter character we're searching backwards
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2828 for."
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2829 (let ((skip (and delim (make-string 1 delim))))
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2830 (when skip
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2831 (save-excursion
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2832 (py-safe (search-backward skip))
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2833 (if (and (eq (char-before) delim)
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2834 (eq (char-before (1- (point))) delim))
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2835 (setq skip (make-string 3 delim))))
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2836 ;; we're looking at a triple-quoted string
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2837 (py-safe (search-backward skip)))))
da1dd3e54b7a (py-goto-beginning-of-tqs): Finds the beginning of the triple quoted Barry Warsaw <barry@python.org> parents: 9503 diff changeset	2838
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2839 (defun py-goto-initial-line ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2840 "Go to the initial line of the current statement.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2841 Usually this is the line we're on, but if we're on the 2nd or
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2842 following lines of a continuation block, we need to go up to the first
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2843 line of the block."
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2844 ;; Tricky: We want to avoid quadratic-time behavior for long
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2845 ;; continued blocks, whether of the backslash or open-bracket
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2846 ;; varieties, or a mix of the two. The following manages to do that
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2847 ;; in the usual cases.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2848 ;;
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2849 ;; Also, if we're sitting inside a triple quoted string, this will
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2850 ;; drop us at the line that begins the string.
7151 d339954ea57d (py-goto-initial-line): Shut up the byte compiler. Barry Warsaw <barry@python.org> parents: 7150 diff changeset	2851 (let (open-bracket-pos)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2852 (while (py-continuation-line-p)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2853 (beginning-of-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2854 (if (py-backslash-continuation-line-p)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2855 (while (py-backslash-continuation-line-p)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2856 (forward-line -1))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2857 ;; else zip out of nested brackets/braces/parens
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2858 (while (setq open-bracket-pos (py-nesting-level))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2859 (goto-char open-bracket-pos)))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2860 (beginning-of-line))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2861
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2862 (defun py-goto-beyond-final-line ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2863 "Go to the point just beyond the fine line of the current statement.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2864 Usually this is the start of the next line, but if this is a
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2865 multi-line statement we need to skip over the continuation lines."
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2866 ;; Tricky: Again we need to be clever to avoid quadratic time
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2867 ;; behavior.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2868 ;;
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2869 ;; XXX: Not quite the right solution, but deals with multi-line doc
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2870 ;; strings
8379 f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	2871 (if (looking-at (concat "[ \t]*\$" py-stringlit-re "\$"))
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	2872 (goto-char (match-end 0)))
f5ebcc7a5ab2 (py-stringlit-re): Another ME patch to recognize SQTQs and DQTQs Barry Warsaw <barry@python.org> parents: 8378 diff changeset	2873 ;;
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2874 (forward-line 1)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2875 (let (state)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2876 (while (and (py-continuation-line-p)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2877 (not (eobp)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2878 ;; skip over the backslash flavor
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2879 (while (and (py-backslash-continuation-line-p)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2880 (not (eobp)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2881 (forward-line 1))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2882 ;; if in nest, zip to the end of the nest
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2883 (setq state (py-parse-state))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2884 (if (and (not (zerop (car state)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2885 (not (eobp)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2886 (progn
6544 d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	2887 (parse-partial-sexp (point) (point-max) 0 nil state)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2888 (forward-line 1))))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2889
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2890 (defun py-statement-opens-block-p ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2891 "Return t iff the current statement opens a block.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2892 I.e., iff it ends with a colon that is not in a comment. Point should
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2893 be at the start of a statement."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2894 (save-excursion
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2895 (let ((start (point))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2896 (finish (progn (py-goto-beyond-final-line) (1- (point))))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2897 (searching t)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2898 (answer nil)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2899 state)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2900 (goto-char start)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2901 (while searching
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2902 ;; look for a colon with nothing after it except whitespace, and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2903 ;; maybe a comment
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2904 (if (re-search-forward ":\$[ \t]\\\|\\\\\n\$\$#.\$?$"
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2905 finish t)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2906 (if (eq (point) finish) ; note: no `else' clause; just
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2907 ; keep searching if we're not at
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2908 ; the end yet
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2909 ;; sure looks like it opens a block -- but it might
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2910 ;; be in a comment
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2911 (progn
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2912 (setq searching nil) ; search is done either way
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2913 (setq state (parse-partial-sexp start
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2914 (match-beginning 0)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2915 (setq answer (not (nth 4 state)))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2916 ;; search failed: couldn't find another interesting colon
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2917 (setq searching nil)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2918 answer)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2919
3900 cba4ce15a0d5 (py-statement-closes-block-p, py-compute-indentation): Outdent one Barry Warsaw <barry@python.org> parents: 3818 diff changeset	2920 (defun py-statement-closes-block-p ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2921 "Return t iff the current statement closes a block.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2922 I.e., if the line starts with `return', `raise', `break', `continue',
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2923 and `pass'. This 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	2924 (let ((here (point)))
cba4ce15a0d5 (py-statement-closes-block-p, py-compute-indentation): Outdent one Barry Warsaw <barry@python.org> parents: 3818 diff changeset	2925 (back-to-indentation)
10875 1821e64e08fc (py-statement-closes-block-p): Add a py-goto-initial-line which fixes Barry Warsaw <barry@python.org> parents: 10208 diff changeset	2926 (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	2927 (prog1
6544 d28932d676c8 Changes in preparation for integrating into the Python CVS tree. Barry Warsaw <barry@python.org> parents: 6232 diff changeset	2928 (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	2929 (goto-char here))))
cba4ce15a0d5 (py-statement-closes-block-p, py-compute-indentation): Outdent one Barry Warsaw <barry@python.org> parents: 3818 diff changeset	2930
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2931 (defun py-goto-beyond-block ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2932 "Go to point just beyond the final line of block begun by the current line.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2933 This is the same as where `py-goto-beyond-final-line' goes unless
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2934 we're on colon line, in which case we go to the end of the block.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2935 Assumes point is at the beginning of the line."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2936 (if (py-statement-opens-block-p)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2937 (py-mark-block nil 'just-move)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2938 (py-goto-beyond-final-line)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2939
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2940 (defun py-goto-statement-at-or-above ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2941 "Go to the start of the first statement at or preceding point.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2942 Return t if there is such a statement, otherwise nil. `Statement'
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2943 does not include blank lines, comments, or continuation lines."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2944 (py-goto-initial-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2945 (if (looking-at py-blank-or-comment-re)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2946 ;; skip back over blank & comment lines
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2947 ;; 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	2948 ;; a continuation line too
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2949 (if (re-search-backward "^[ \t]*[^ \t#\n]" nil t)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2950 (progn (py-goto-initial-line) t)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2951 nil)
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2952 t))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2953
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2954 (defun py-goto-statement-below ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2955 "Go to start of the first statement following the statement containing point.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2956 Return t if there is such a statement, otherwise nil. `Statement'
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2957 does not include blank lines, comments, or continuation lines."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2958 (beginning-of-line)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2959 (let ((start (point)))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2960 (py-goto-beyond-final-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2961 (while (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2962 (looking-at py-blank-or-comment-re)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2963 (not (eobp)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2964 (forward-line 1))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2965 (if (eobp)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2966 (progn (goto-char start) nil)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2967 t)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2968
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2969 (defun py-go-up-tree-to-keyword (key)
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2970 "Go to begining of statement starting with KEY, at or preceding point.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2971
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2972 KEY is a regular expression describing a Python keyword. Skip blank
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2973 lines and non-indenting comments. If the statement found starts with
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2974 KEY, then stop, otherwise go back to first enclosing block starting
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2975 with KEY. If successful, leave point at the start of the KEY line and
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2976 return t. Otherwise, leav point at an undefined place and return nil."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2977 ;; skip blanks and non-indenting #
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2978 (py-goto-initial-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2979 (while (and
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2980 (looking-at "[ \t]*\$$\\\|#[^ \t\n]\$")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2981 (zerop (forward-line -1))) ; go back
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2982 nil)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2983 (py-goto-initial-line)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2984 (let* ((re (concat "[ \t]*" key "\\b"))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2985 (case-fold-search nil) ; let* so looking-at sees this
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2986 (found (looking-at re))
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	2987 (dead nil))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2988 (while (not (or found dead))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2989 (condition-case nil ; in case no enclosing block
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2990 (py-goto-block-up 'no-mark)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2991 (error (setq dead t)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2992 (or dead (setq found (looking-at re))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2993 (beginning-of-line)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2994 found))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2995
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2996 (defun py-suck-up-leading-text ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2997 "Return string in buffer from start of indentation to end of line.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	2998 Prefix with \"...\" if leading whitespace was skipped."
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	2999 (save-excursion
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3000 (back-to-indentation)
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3001 (concat
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3002 (if (bolp) "" "...")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3003 (buffer-substring (point) (progn (end-of-line) (point))))))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3004
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3005 (defun py-suck-up-first-keyword ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3006 "Return first keyword on the line as a Lisp symbol.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3007 `Keyword' is defined (essentially) as the regular expression
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3008 ([a-z]+). Returns nil if none was found."
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3009 (let ((case-fold-search nil))
2018 5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3010 (if (looking-at "[ \t]*\$[a-z]+\$\\b")
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3011 (intern (buffer-substring (match-beginning 1) (match-end 1)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3012 nil)))
5a0775ce7b31 Initial revision Barry Warsaw <barry@python.org> parents: diff changeset	3013
4195 e3f6ada28ed0 I have been increasingly annoyed about the fact that Barry Warsaw <barry@python.org> parents: 4194 diff changeset	3014 (defun py-current-defun ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3015 "Python value for `add-log-current-defun-function'.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3016 This tells add-log.el how to find the current function/method/variable."
4195 e3f6ada28ed0 I have been increasingly annoyed about the fact that Barry Warsaw <barry@python.org> parents: 4194 diff changeset	3017 (save-excursion
e3f6ada28ed0 I have been increasingly annoyed about the fact that Barry Warsaw <barry@python.org> parents: 4194 diff changeset	3018 (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	3019 (or (match-string 3)
e3f6ada28ed0 I have been increasingly annoyed about the fact that Barry Warsaw <barry@python.org> parents: 4194 diff changeset	3020 (let ((method (match-string 2)))
e3f6ada28ed0 I have been increasingly annoyed about the fact that Barry Warsaw <barry@python.org> parents: 4194 diff changeset	3021 (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	3022 (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	3023 (concat (match-string 1) "." method)
e3f6ada28ed0 I have been increasingly annoyed about the fact that Barry Warsaw <barry@python.org> parents: 4194 diff changeset	3024 method)))
e3f6ada28ed0 I have been increasingly annoyed about the fact that Barry Warsaw <barry@python.org> parents: 4194 diff changeset	3025 nil)))
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3026
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3027
2799 4a998b1a331f #changed all email address to go through python.org Barry Warsaw <barry@python.org> parents: 2798 diff changeset	3028 (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	3029 "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	3030
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	3031 (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	3032 "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	3033 (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	3034 (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	3035 (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	3036
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	3037 ;; 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	3038 ;(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	3039 ; (require 'reporter))
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3040
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	3041 (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	3042 "Submit via mail a bug report on `python-mode'.
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3043 With \\[universal-argument] (programmatically, argument ENHANCEMENT-P
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3044 non-nil) just submit an enhancement request."
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	3045 (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	3046 (list (not (y-or-n-p
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3047 "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	3048 (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	3049 "(Very) brief summary: "
1a448dd84edc (py-submit-bug-report): fixed summary querying Barry Warsaw <barry@python.org> parents: 2537 diff changeset	3050 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	3051 (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	3052 (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	3053 py-help-address ;address
2543 1a448dd84edc (py-submit-bug-report): fixed summary querying Barry Warsaw <barry@python.org> parents: 2537 diff changeset	3054 (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	3055 ;; 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	3056 (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	3057 '(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	3058 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	3059 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	3060 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	3061 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	3062 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	3063 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	3064 "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	3065 (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	3066 (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	3067 (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	3068 "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	3069 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	3070 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	3071 (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	3072 (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	3073
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	3074
6667 089c04d89151 (py-kill-emacs-hook): Simplification. Barry Warsaw <barry@python.org> parents: 6663 diff changeset	3075 (defun py-kill-emacs-hook ()
8910 b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3076 "Delete files in `py-file-queue'.
b1d1d8c0071b Huge number of docstring changes, typo fixes, rewordings, GNU standard Barry Warsaw <barry@python.org> parents: 8888 diff changeset	3077 These are Python temporary files awaiting execution."
6667 089c04d89151 (py-kill-emacs-hook): Simplification. Barry Warsaw <barry@python.org> parents: 6663 diff changeset	3078 (mapcar #'(lambda (filename)
089c04d89151 (py-kill-emacs-hook): Simplification. Barry Warsaw <barry@python.org> parents: 6663 diff changeset	3079 (py-safe (delete-file filename)))
089c04d89151 (py-kill-emacs-hook): Simplification. Barry Warsaw <barry@python.org> parents: 6663 diff changeset	3080 py-file-queue))
089c04d89151 (py-kill-emacs-hook): Simplification. Barry Warsaw <barry@python.org> parents: 6663 diff changeset	3081
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3082 ;; 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	3083 (add-hook 'kill-emacs-hook 'py-kill-emacs-hook)
2493 d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3084
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3085
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3086
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3087 (provide 'python-mode)
d9481354fdc3 #initial stylistic rewrite Barry Warsaw <barry@python.org> parents: 2041 diff changeset	3088 ;;; python-mode.el ends here

Mercurial > cpython-lru_cache-weakref

annotate Misc/python-mode.el @ 10875:1821e64e08fc legacy-trunk