diff options
Diffstat (limited to 'Tools')
| -rw-r--r-- | Tools/scripts/README | 1 | ||||
| -rw-r--r-- | Tools/scripts/texcheck.py | 167 |
2 files changed, 168 insertions, 0 deletions
diff --git a/Tools/scripts/README b/Tools/scripts/README index e718c4a9ee..7ca509048c 100644 --- a/Tools/scripts/README +++ b/Tools/scripts/README @@ -43,6 +43,7 @@ suff.py Sort a list of files by suffix sum5.py Print md5 checksums of files tabnanny.py Check for ambiguous indentation (Tim Peters) tabpolice.py Check for ambiguous indentation (GvR) +texcheck.py Validate Python LaTeX formatting (Raymond Hettinger) texi2html.py Convert GNU texinfo files into HTML treesync.py Synchronize source trees (very ideosyncratic) untabify.py Replace tabs with spaces in argument files diff --git a/Tools/scripts/texcheck.py b/Tools/scripts/texcheck.py new file mode 100644 index 0000000000..96acfc1ec8 --- /dev/null +++ b/Tools/scripts/texcheck.py @@ -0,0 +1,167 @@ +""" TeXcheck.py -- rough syntax checking on Python style LaTeX documents. + + Written by Raymond D. Hettinger <python at rcn.com> + Copyright (c) 2003 Python Software Foundation. All rights reserved. + +Designed to catch common markup errors including: +* Unbalanced or mismatched parenthesis, brackets, and braces. +* Unbalanced of mismatched \begin and \end blocks. +* Misspelled or invalid LaTeX commands. +* Use of forward slashes instead of backslashes for commands. + +Command line usage: + python texcheck.py [-h] [-k keyword] foobar.tex + +Options: + -m Munge parenthesis and brackets. [0,n) would normally mismatch. + -k keyword: Keyword is a valid LaTeX command. Do not include the backslash. + -f: Forward-slash warnings suppressed. + -d: Delimiter check only (useful for non-LaTeX files). + -h: Help + -s lineno: Start at lineno (useful for skipping complex sections). + -v: Verbose. Shows current delimiter and unclosed delimiters. +""" + +# Todo: +# Add tableiii/lineiii cross-checking +# Add braces matching + +import re +import sets +import sys +import getopt +from itertools import izip, count, islice + +cmdstr = r""" + \section \module \declaremodule \modulesynopsis \moduleauthor + \sectionauthor \versionadded \code \class \method \begin + \optional \var \ref \end \subsection \lineiii \hline \label + \indexii \textrm \ldots \keyword \stindex \index \item \note + \withsubitem \ttindex \footnote \citetitle \samp \opindex + \noindent \exception \strong \dfn \ctype \obindex \character + \indexiii \function \bifuncindex \refmodule \refbimodindex + \subsubsection \nodename \member \chapter \emph \ASCII \UNIX + \regexp \program \production \token \productioncont \term + \grammartoken \lineii \seemodule \file \EOF \documentclass + \usepackage \title \input \maketitle \ifhtml \fi \url \Cpp + \tableofcontents \kbd \programopt \envvar \refstmodindex + \cfunction \constant \NULL \moreargs \cfuncline \cdata + \textasciicircum \n \ABC \setindexsubitem \versionchanged + \deprecated \seetext \newcommand \POSIX \pep \warning \rfc + \verbatiminput \methodline \textgreater \seetitle \lineiv + \funclineni \ulink \manpage \funcline \dataline \unspecified + \textbackslash \mimetype \mailheader \seepep \textunderscore + \longprogramopt \infinity \plusminus \shortversion \version + \refmodindex \seerfc \makeindex \makemodindex \renewcommand + \indexname \appendix +""" + +def matchclose(c_lineno, c_symbol, openers, pairmap): + "Verify that closing delimiter matches most recent opening delimiter" + try: + o_lineno, o_symbol = openers.pop() + except IndexError: + msg = "Delimiter mismatch. On line %d, encountered closing '%s' without corresponding open" % (c_lineno, c_symbol) + raise Exception, msg + if o_symbol in pairmap.get(c_symbol, [c_symbol]): return + msg = "Opener '%s' on line %d was not closed before encountering '%s' on line %d" % (o_symbol, o_lineno, c_symbol, c_lineno) + raise Exception, msg + +def checkit(source, opts, morecmds=[]): + """Check the LaTex formatting in a sequence of lines. + + Opts is a mapping of options to option values if any: + -m munge parenthesis and brackets + -f forward slash warnings to be skipped + -d delimiters only checking + -v verbose listing on delimiters + -s lineno: linenumber to start scan (default is 1). + + Morecmds is a sequence of LaTex commands (without backslashes) that + are to be considered valid in the scan. + """ + + texcmd = re.compile(r'\\[A-Za-z]+') + + validcmds = sets.Set(cmdstr.split()) + for cmd in morecmds: + validcmds.add('\\' + cmd) + + openers = [] # Stack of pending open delimiters + + if '-m' in opts: + pairmap = {']':'[(', ')':'(['} # Munged openers + else: + pairmap = {']':'[', ')':'('} # Normal opener for a given closer + openpunct = sets.Set('([') # Set of valid openers + + delimiters = re.compile(r'\\(begin|end){([_a-zA-Z]+)}|([()\[\]])') + + startline = int(opts.get('-s', '1')) + lineno = 0 + + for lineno, line in izip(count(startline), islice(source, startline-1, None)): + line = line.rstrip() + + if '-f' not in opts and '/' in line: + # Warn whenever forward slashes encountered + line = line.rstrip() + print 'Warning, forward slash on line %d: %s' % (lineno, line) + + if '-d' not in opts: + # Validate commands + nc = line.find(r'\newcommand') + if nc != -1: + start = line.find('{', nc) + end = line.find('}', start) + validcmds.add(line[start+1:end]) + for cmd in texcmd.findall(line): + if cmd not in validcmds: + print r'Warning, unknown tex cmd on line %d: \%s' % (lineno, cmd) + + # Check balancing of open/close markers (parens, brackets, etc) + for begend, name, punct in delimiters.findall(line): + if '-v' in opts: + print lineno, '|', begend, name, punct, + if begend == 'begin' and '-d' not in opts: + openers.append((lineno, name)) + elif punct in openpunct: + openers.append((lineno, punct)) + elif begend == 'end' and '-d' not in opts: + matchclose(lineno, name, openers, pairmap) + elif punct in pairmap: + matchclose(lineno, punct, openers, pairmap) + if '-v' in opts: + print ' --> ', openers + + for lineno, symbol in openers: + print "Unmatched open delimiter '%s' on line %d", (symbol, lineno) + print 'Done checking %d lines.' % (lineno,) + return 0 + +def main(args=None): + if args is None: + args = sys.argv[1:] + optitems, arglist = getopt.getopt(args, "k:mfdhs:v") + opts = dict(optitems) + if '-h' in opts or args==[]: + print __doc__ + return 0 + + if len(arglist) < 1: + print 'Please specify a file to be checked' + return 1 + + morecmds = [v for k,v in optitems if k=='-k'] + + try: + f = open(arglist[0]) + except IOError: + print 'Cannot open file %s.' % arglist[0] + return 2 + + return(checkit(f, opts, morecmds)) + +if __name__ == '__main__': + sys.exit(main()) + |