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

annotate Misc/python-mode.el @ 7198:5cd2f699bf69 legacy-trunk

(py-parse-state): When looking for landing inside triple-quoted string, don't check for indentation at column zero. This will falsely hit a line inside a docstring that starts at column zero but ends in a colon.

author	Barry Warsaw <barry@python.org>
date	Thu, 05 Feb 1998 23:35:09 +0000
parents	26d07735ba4a
children	720e9183961e

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

Mercurial > cpython-lru_cache-weakref

annotate Misc/python-mode.el @ 7198:5cd2f699bf69 legacy-trunk