Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1# -*- coding: utf-8 -*- 

2""" 

3 pygments.formatters._mapping 

4 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 

5 

6 Formatter mapping definitions. This file is generated by itself. Everytime 

7 you change something on a builtin formatter definition, run this script from 

8 the formatters folder to update it. 

9 

10 Do not alter the FORMATTERS dictionary by hand. 

11 

12 :copyright: Copyright 2006-2021 by the Pygments team, see AUTHORS. 

13 :license: BSD, see LICENSE for details. 

14""" 

15 

16FORMATTERS = { 

17 'BBCodeFormatter': ('pygments.formatters.bbcode', 'BBCode', ('bbcode', 'bb'), (), 'Format tokens with BBcodes. These formatting codes are used by many bulletin boards, so you can highlight your sourcecode with pygments before posting it there.'), 

18 'BmpImageFormatter': ('pygments.formatters.img', 'img_bmp', ('bmp', 'bitmap'), ('*.bmp',), 'Create a bitmap image from source code. This uses the Python Imaging Library to generate a pixmap from the source code.'), 

19 'GifImageFormatter': ('pygments.formatters.img', 'img_gif', ('gif',), ('*.gif',), 'Create a GIF image from source code. This uses the Python Imaging Library to generate a pixmap from the source code.'), 

20 'HtmlFormatter': ('pygments.formatters.html', 'HTML', ('html',), ('*.html', '*.htm'), "Format tokens as HTML 4 ``<span>`` tags within a ``<pre>`` tag, wrapped in a ``<div>`` tag. The ``<div>``'s CSS class can be set by the `cssclass` option."), 

21 'IRCFormatter': ('pygments.formatters.irc', 'IRC', ('irc', 'IRC'), (), 'Format tokens with IRC color sequences'), 

22 'ImageFormatter': ('pygments.formatters.img', 'img', ('img', 'IMG', 'png'), ('*.png',), 'Create a PNG image from source code. This uses the Python Imaging Library to generate a pixmap from the source code.'), 

23 'JpgImageFormatter': ('pygments.formatters.img', 'img_jpg', ('jpg', 'jpeg'), ('*.jpg',), 'Create a JPEG image from source code. This uses the Python Imaging Library to generate a pixmap from the source code.'), 

24 'LatexFormatter': ('pygments.formatters.latex', 'LaTeX', ('latex', 'tex'), ('*.tex',), 'Format tokens as LaTeX code. This needs the `fancyvrb` and `color` standard packages.'), 

25 'NullFormatter': ('pygments.formatters.other', 'Text only', ('text', 'null'), ('*.txt',), 'Output the text unchanged without any formatting.'), 

26 'RawTokenFormatter': ('pygments.formatters.other', 'Raw tokens', ('raw', 'tokens'), ('*.raw',), 'Format tokens as a raw representation for storing token streams.'), 

27 'RtfFormatter': ('pygments.formatters.rtf', 'RTF', ('rtf',), ('*.rtf',), 'Format tokens as RTF markup. This formatter automatically outputs full RTF documents with color information and other useful stuff. Perfect for Copy and Paste into Microsoft(R) Word(R) documents.'), 

28 'SvgFormatter': ('pygments.formatters.svg', 'SVG', ('svg',), ('*.svg',), 'Format tokens as an SVG graphics file. This formatter is still experimental. Each line of code is a ``<text>`` element with explicit ``x`` and ``y`` coordinates containing ``<tspan>`` elements with the individual token styles.'), 

29 'Terminal256Formatter': ('pygments.formatters.terminal256', 'Terminal256', ('terminal256', 'console256', '256'), (), 'Format tokens with ANSI color sequences, for output in a 256-color terminal or console. Like in `TerminalFormatter` color sequences are terminated at newlines, so that paging the output works correctly.'), 

30 'TerminalFormatter': ('pygments.formatters.terminal', 'Terminal', ('terminal', 'console'), (), 'Format tokens with ANSI color sequences, for output in a text console. Color sequences are terminated at newlines, so that paging the output works correctly.'), 

31 'TerminalTrueColorFormatter': ('pygments.formatters.terminal256', 'TerminalTrueColor', ('terminal16m', 'console16m', '16m'), (), 'Format tokens with ANSI color sequences, for output in a true-color terminal or console. Like in `TerminalFormatter` color sequences are terminated at newlines, so that paging the output works correctly.'), 

32 'TestcaseFormatter': ('pygments.formatters.other', 'Testcase', ('testcase',), (), 'Format tokens as appropriate for a new testcase.') 

33} 

34 

35if __name__ == '__main__': # pragma: no cover 

36 import sys 

37 import os 

38 

39 # lookup formatters 

40 found_formatters = [] 

41 imports = [] 

42 sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..', '..')) 

43 from pygments.util import docstring_headline 

44 

45 for root, dirs, files in os.walk('.'): 

46 for filename in files: 

47 if filename.endswith('.py') and not filename.startswith('_'): 

48 module_name = 'pygments.formatters%s.%s' % ( 

49 root[1:].replace('/', '.'), filename[:-3]) 

50 print(module_name) 

51 module = __import__(module_name, None, None, ['']) 

52 for formatter_name in module.__all__: 

53 formatter = getattr(module, formatter_name) 

54 found_formatters.append( 

55 '%r: %r' % (formatter_name, 

56 (module_name, 

57 formatter.name, 

58 tuple(formatter.aliases), 

59 tuple(formatter.filenames), 

60 docstring_headline(formatter)))) 

61 # sort them to make the diff minimal 

62 found_formatters.sort() 

63 

64 # extract useful sourcecode from this file 

65 with open(__file__) as fp: 

66 content = fp.read() 

67 # replace crnl to nl for Windows. 

68 # 

69 # Note that, originally, contributers should keep nl of master 

70 # repository, for example by using some kind of automatic 

71 # management EOL, like `EolExtension 

72 # <https://www.mercurial-scm.org/wiki/EolExtension>`. 

73 content = content.replace("\r\n", "\n") 

74 header = content[:content.find('FORMATTERS = {')] 

75 footer = content[content.find("if __name__ == '__main__':"):] 

76 

77 # write new file 

78 with open(__file__, 'w') as fp: 

79 fp.write(header) 

80 fp.write('FORMATTERS = {\n %s\n}\n\n' % ',\n '.join(found_formatters)) 

81 fp.write(footer) 

82 

83 print ('=== %d formatters processed.' % len(found_formatters))