# Extension to format a paragraph
# Does basic, standard text formatting, and also understands Python
# comment blocks. Thus, for editing Python source code, this
# extension is really only suitable for reformatting these comment
# blocks or triple-quoted strings.
# Known problems with comment reformatting:
# * If there is a selection marked, and the first line of the
# selection is not complete, the block will probably not be detected
# as comments, and will have the normal "text formatting" rules
# * If a comment block has leading whitespace that mixes tabs and
# spaces, they will not be considered part of the same block.
# * Fancy comments, like this bulleted list, arent handled :-)
from configHandler
import idleConf
('format', [ # /s/edit/format dscherer@cmu.edu
('Format Paragraph', '<<format-paragraph>>'),
def __init__(self
, editwin
):
def format_paragraph_event(self
, event
):
maxformatwidth
= int(idleConf
.GetOption('main','FormatParagraph','paragraph'))
first
, last
= self
.editwin
.get_selection_indices()
data
= text
.get(first
, last
)
first
, last
, comment_header
, data
= \
find_paragraph(text
, text
.index("insert"))
# Reformat the comment lines - convert to text sans header.
lines
= map(lambda st
, l
=len(comment_header
): st
[l
:], lines
)
# Reformat to maxformatwidth chars or a 20 char width, whichever is greater.
format_width
= max(maxformatwidth
- len(comment_header
), 20)
newdata
= reformat_paragraph(data
, format_width
)
# re-split and re-insert the comment header.
newdata
= newdata
.split("\n")
# If the block ends in a \n, we dont want the comment
# prefix inserted after it. (Im not sure it makes sense to
# reformat a comment block that isnt made of complete
# lines, but whatever!) Can't think of a clean soltution,
builder
= lambda item
, prefix
=comment_header
: prefix
+item
newdata
= '\n'.join(map(builder
, newdata
)) + block_suffix
# Just a normal text format
newdata
= reformat_paragraph(data
, maxformatwidth
)
text
.tag_remove("sel", "1.0", "end")
text
.mark_set("insert", first
)
text
.insert(first
, newdata
)
text
.mark_set("insert", last
)
def find_paragraph(text
, mark
):
lineno
, col
= map(int, mark
.split("."))
line
= text
.get("%d.0" % lineno
, "%d.0 lineend" % lineno
)
while text
.compare("%d.0" % lineno
, "<", "end") and is_all_white(line
):
line
= text
.get("%d.0" % lineno
, "%d.0 lineend" % lineno
)
comment_header
= get_comment_header(line
)
comment_header_len
= len(comment_header
)
while get_comment_header(line
)==comment_header
and \
not is_all_white(line
[comment_header_len
:]):
line
= text
.get("%d.0" % lineno
, "%d.0 lineend" % lineno
)
# Search back to beginning of paragraph
lineno
= first_lineno
- 1
line
= text
.get("%d.0" % lineno
, "%d.0 lineend" % lineno
)
get_comment_header(line
)==comment_header
and \
not is_all_white(line
[comment_header_len
:]):
line
= text
.get("%d.0" % lineno
, "%d.0 lineend" % lineno
)
first
= "%d.0" % (lineno
+1)
return first
, last
, comment_header
, text
.get(first
, last
)
def reformat_paragraph(data
, limit
):
while i
< n
and is_all_white(lines
[i
]):
indent1
= get_indent(lines
[i
])
if i
+1 < n
and not is_all_white(lines
[i
+1]):
indent2
= get_indent(lines
[i
+1])
while i
< n
and not is_all_white(lines
[i
]):
# XXX Should take double space after period (etc.) into account
words
= re
.split("(\s+)", lines
[i
])
for j
in range(0, len(words
), 2):
continue # Can happen when line ends in whitespace
if len((partial
+ word
).expandtabs()) > limit
and \
new
.append(partial
.rstrip())
partial
= partial
+ word
+ " "
if j
+1 < len(words
) and words
[j
+1] != " ":
new
.append(partial
.rstrip())
# XXX Should reformat remaining paragraphs as well
return re
.match(r
"^\s*$", line
) is not None
return re
.match(r
"^(\s*)", line
).group()
def get_comment_header(line
):
m
= re
.match(r
"^(\s*#*)", line
)