diff options
Diffstat (limited to 'pygments/__init__.py')
| -rw-r--r-- | pygments/__init__.py | 270 |
1 files changed, 270 insertions, 0 deletions
diff --git a/pygments/__init__.py b/pygments/__init__.py new file mode 100644 index 00000000..23bdbccb --- /dev/null +++ b/pygments/__init__.py @@ -0,0 +1,270 @@ +# -*- coding: utf-8 -*- +""" + Pygments + ~~~~~~~ + + Pygments is a syntax highlighting package written in Python. + + It aims to be a generic syntax highlighter for general use in all + kinds of software such as forum systems, wikis or other applications + that need to prettify source code. Highlights are: + + * a wide range of common languages and markup formats is supported + * special attention is paid to details, increasing quality by a fair amount + * support for new languages and formats are added easily + * a number of output formats, presently HTML, LaTeX and ANSI sequences + * it is usable as a command-line tool and as a library + * ... and it highlights even Brainfuck! + + + :copyright: 2006 by Georg Brandl, Armin Ronacher, Lukas Meuser and others. + :license: GNU LGPL, see LICENSE for more details. +""" + +__version__ = '0.1' +__docformat__ = 'restructuredtext' +__license__ = 'GNU Lesser General Public License (LGPL)' +__author__ = 'Georg Brandl <g.brandl@gmx.net>' +__url__ = 'http://pygments.pocoo.org/' + + +import sys, os +# using StringIO because it can handle Unicode strings +from StringIO import StringIO + +from pygments.util import OptionError +from pygments.lexers import LEXERS, get_lexer_by_name, get_lexer_for_filename + +from pygments.formatters import FORMATTERS, get_formatter_by_name, \ + get_formatter_for_filename, TerminalFormatter + + +def lex(code, lexer): + """ + Lex ``code`` with ``lexer`` and return an iterable of tokens. + """ + return lexer.get_tokens(code) + + +def format(tokens, formatter, outfile=None): + """ + Format a tokenlist ``tokens`` with the formatter ``formatter``. + + If ``outfile`` is given and a valid file object (an object + with a ``write`` method), the result will be written to it, otherwise + it is returned as a string. + """ + realoutfile = outfile or StringIO() + formatter.format(tokens, realoutfile) + if not outfile: + return realoutfile.getvalue() + + +def highlight(code, lexer, formatter, outfile=None): + """ + Lex ``code`` with ``lexer`` and format it with the formatter + ``formatter``. + + If ``outfile`` is given and a valid file object (an object + with a ``write`` method), the result will be written to it, otherwise + it is returned as a string. + """ + return format(lex(code, lexer), formatter, outfile) + + +def cmdline_main(args): + """ + Make pygments usable as a command line utility. + """ + import getopt + + USAGE = """\ +Usage: %s [-l <lexer>] [-f <formatter>] [-O <options>] [-o <outfile>] [<infile>] + %s -S <style> -f <formatter> [-a <arg>] [-O <options>] + %s -L | -h | -V + +Highlight the input file and write the result to <outfile>. + +If no input file is given, use stdin, if -o is not given, use stdout. + +<lexer> is a lexer name (query all lexer names with -L). If -l is not +given, the lexer is guessed from the extension of the input file name +(this obviously doesn't work if the input is stdin). + +Likewise, <formatter> is a formatter name, and will be guessed from +the extension of the output file name. If no output file is given, +the terminal formatter will be used by default. + +With the -O option, you can give the lexer and formatter a comma- +separated list of options, e.g. ``-O bg=light,python=cool``. + +With the -S option, print out style definitions for style <style> +for formatter <formatter>. The argument given by -a is formatter +dependent. + +The -L option lists all available lexers and formatters. +The -h option prints this help. +The -V option prints the package version. +""" % ((args[0],)*3) + + try: + opts, args = getopt.getopt(args[1:], "l:f:o:O:LhVS:a:") + except getopt.GetoptError: + print >>sys.stderr, USAGE + return 2 + opts = dict(opts) + + if not opts and not args: + print USAGE + return 0 + + if opts.pop('-h', None) is not None: + print USAGE + return 0 + + if opts.pop('-V', None) is not None: + print 'Pygments version %s, (c) 2006 by %s.' % (__version__, __author__) + return 0 + + L_opt = opts.pop('-L', None) + if L_opt is not None: + if opts or args: + print >>sys.stderr, USAGE + return 2 + + # print version + cmdline_main(['', '-V']) + print + print "Lexers:" + print "~~~~~~~" + + info = [] + maxlen = 0 + for mod, fullname, names, exts in LEXERS.itervalues(): + tup = (', '.join(names)+':', fullname, + exts and '(extensions ' + ', '.join(exts) + ')' or '') + info.append(tup) + if len(tup[0]) > maxlen: maxlen = len(tup[0]) + info.sort() + for i in info: + print ('%-'+str(maxlen)+'s %s %s') % i + + print + print "Formatters:" + print "~~~~~~~~~~~" + + info = [] + maxlen = 0 + for fullname, names, exts, doc in FORMATTERS.itervalues(): + tup = (', '.join(names)+':', doc, + exts and '(extensions ' + ', '.join(exts) + ')' or '') + info.append(tup) + if len(tup[0]) > maxlen: maxlen = len(tup[0]) + info.sort() + for i in info: + print ('%-'+str(maxlen)+'s %s %s') % i + return 0 + + O_opts = {} + o_str = opts.pop('-O', None) + if o_str: + try: + o_args = o_str.split(',') + for o_arg in o_args: + o_key, o_val = o_arg.split('=') + O_opts[o_key] = o_val + except ValueError: + print >>sys.stderr, 'Error in -O specification.' + return 2 + + S_opt = opts.pop('-S', None) + a_opt = opts.pop('-a', None) + if S_opt is not None: + f_opt = opts.pop('-f', None) + if not f_opt: + print >>sys.stderr, USAGE + return 2 + if opts or args: + print >>sys.stderr, USAGE + return 2 + + try: + O_opts['style'] = S_opt + fmter = get_formatter_by_name(f_opt, **O_opts) + except ValueError, err: + print >>sys.stderr, err + return 1 + + arg = a_opt or '' + print fmter.get_style_defs(arg) + return 0 + + if a_opt is not None: + print >>sys.stderr, USAGE + return 2 + + outfn = opts.pop('-o', None) + fmter = opts.pop('-f', None) + if fmter: + try: + fmter = get_formatter_by_name(fmter, **O_opts) + except (OptionError, ValueError), err: + print >>sys.stderr, 'Error:', err + return 1 + + if outfn: + if not fmter: + try: + fmter = get_formatter_for_filename(outfn, **O_opts) + except (OptionError, ValueError), err: + print >>sys.stderr, 'Error:', err + return 1 + try: + outfile = file(outfn, 'wb') + except Exception, err: + print >>sys.stderr, 'Error: cannot open outfile:', err + return 1 + else: + if not fmter: + fmter = TerminalFormatter(**O_opts) + outfile = sys.stdout + + lexer = opts.pop('-l', None) + if lexer: + try: + lexer = get_lexer_by_name(lexer, **O_opts) + except (OptionError, ValueError), err: + print >>sys.stderr, 'Error:', err + return 1 + + if args: + infn = args[0] + if not lexer: + try: + lexer = get_lexer_for_filename(infn, **O_opts) + except (OptionError, ValueError), err: + print >>sys.stderr, 'Error:', err + return 1 + + try: + code = file(infn).read() + except Exception, err: + print >>sys.stderr, 'Error: cannot read infile:', err + return 1 + else: + if not lexer: + print >>sys.stderr, 'Error: no lexer name given and reading from stdin' + return 2 + code = sys.stdin.read() + + try: + highlight(code, lexer, fmter, outfile) + except Exception, err: + raise + print >>sys.stderr, 'Error while highlighting:', err + return 1 + return 0 + + +if __name__ == '__main__': + sys.exit(cmdline_main(sys.argv)) |