15d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# markdown is released under the BSD license 25d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# Copyright 2007, 2008 The Python Markdown Project (v. 1.7 and later) 35d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b) 45d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# Copyright 2004 Manfred Stienstra (the original version) 55d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# 65d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# All rights reserved. 75d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# 85d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# Redistribution and use in source and binary forms, with or without 95d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# modification, are permitted provided that the following conditions are met: 105d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# 115d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# * Redistributions of source code must retain the above copyright 125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# notice, this list of conditions and the following disclaimer. 135d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# * Redistributions in binary form must reproduce the above copyright 145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# notice, this list of conditions and the following disclaimer in the 155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# documentation and/or other materials provided with the distribution. 165d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# * Neither the name of the <organization> nor the 175d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# names of its contributors may be used to endorse or promote products 185d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# derived from this software without specific prior written permission. 195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# 205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# THIS SOFTWARE IS PROVIDED BY THE PYTHON MARKDOWN PROJECT ''AS IS'' AND ANY 215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# DISCLAIMED. IN NO EVENT SHALL ANY CONTRIBUTORS TO THE PYTHON MARKDOWN PROJECT 245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 275d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 285d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# POSSIBILITY OF SUCH DAMAGE. 315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 335d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)""" 345d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)CodeHilite Extension for Python-Markdown 355d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)======================================== 365d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 375d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)Adds code/syntax highlighting to standard Python-Markdown code blocks. 385d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 395d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)Copyright 2006-2008 [Waylan Limberg](http://achinghead.com/). 405d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 415d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)Project website: <http://packages.python.org/Markdown/extensions/code_hilite.html> 425d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)Contact: markdown@freewisdom.org 435d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 445d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)License: BSD (see ../LICENSE.md for details) 455d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 465d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)Dependencies: 475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)* [Python 2.3+](http://python.org/) 485d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)* [Markdown 2.0+](http://packages.python.org/Markdown/) 495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)* [Pygments](http://pygments.org/) 505d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 515d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)""" 525d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 535d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)from __future__ import absolute_import 545d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)from __future__ import unicode_literals 555d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)from . import Extension 565d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)from ..treeprocessors import Treeprocessor 575d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)import warnings 585d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)try: 595d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) from pygments import highlight 605d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) from pygments.lexers import get_lexer_by_name, guess_lexer, TextLexer 615d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) from pygments.formatters import HtmlFormatter 625d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) pygments = True 635d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)except ImportError: 645d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) pygments = False 655d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# ------------------ The Main CodeHilite Class ---------------------- 675d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)class CodeHilite(object): 685d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ 695d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) Determine language of source code, and pass it into the pygments hilighter. 705d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 715d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) Basic Usage: 725d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) >>> code = CodeHilite(src = 'some text') 735d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) >>> html = code.hilite() 745d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 755d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) * src: Source string or any object with a .readline attribute. 765d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 775d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) * linenums: (Boolean) Set line numbering to 'on' (True), 'off' (False) or 'auto'(None). 785d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) Set to 'auto' by default. 795d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 805d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) * guess_lang: (Boolean) Turn language auto-detection 'on' or 'off' (on by default). 815d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 825d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) * css_class: Set class name of wrapper div ('codehilite' by default). 835d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 845d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) Low Level Usage: 855d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) >>> code = CodeHilite() 865d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) >>> code.src = 'some text' # String or anything with a .readline attr. 875d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) >>> code.linenos = True # True or False; Turns line numbering on or of. 885d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) >>> html = code.hilite() 895d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 905d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ 915d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 925d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) def __init__(self, src=None, linenums=None, guess_lang=True, 935d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) css_class="codehilite", lang=None, style='default', 945d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) noclasses=False, tab_length=4): 955d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.src = src 965d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.lang = lang 975d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.linenums = linenums 985d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.guess_lang = guess_lang 995d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.css_class = css_class 1005d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.style = style 1015d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.noclasses = noclasses 1025d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.tab_length = tab_length 1035d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1045d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) def hilite(self): 1055d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ 1065d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) Pass code to the [Pygments](http://pygments.pocoo.org/) highliter with 1075d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) optional line numbers. The output should then be styled with css to 1085d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) your liking. No styles are applied by default - only styling hooks 1095d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) (i.e.: <span class="k">). 1105d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1115d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) returns : A string of html. 1125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1135d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ 1145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.src = self.src.strip('\n') 1165d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1175d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if self.lang is None: 1185d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self._getLang() 1195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if pygments: 1215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) try: 1225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) lexer = get_lexer_by_name(self.lang) 1235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) except ValueError: 1245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) try: 1255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if self.guess_lang: 1265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) lexer = guess_lexer(self.src) 1275d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) else: 1285d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) lexer = TextLexer() 1295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) except ValueError: 1305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) lexer = TextLexer() 1315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) formatter = HtmlFormatter(linenos=self.linenums, 1325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) cssclass=self.css_class, 1335d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) style=self.style, 1345d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) noclasses=self.noclasses) 1355d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) return highlight(self.src, lexer, formatter) 1365d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) else: 1375d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # just escape and build markup usable by JS highlighting libs 1385d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) txt = self.src.replace('&', '&') 1395d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) txt = txt.replace('<', '<') 1405d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) txt = txt.replace('>', '>') 1415d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) txt = txt.replace('"', '"') 1425d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) classes = [] 1435d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if self.lang: 1445d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) classes.append('language-%s' % self.lang) 1455d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if self.linenums: 1465d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) classes.append('linenums') 1475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) class_str = '' 1485d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if classes: 1495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) class_str = ' class="%s"' % ' '.join(classes) 1505d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) return '<pre class="%s"><code%s>%s</code></pre>\n'% \ 1515d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) (self.css_class, class_str, txt) 1525d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1535d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) def _getLang(self): 1545d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ 1555d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) Determines language of a code block from shebang line and whether said 1565d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) line should be removed or left in place. If the sheband line contains a 1575d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) path (even a single /) then it is assumed to be a real shebang line and 1585d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) left alone. However, if no path is given (e.i.: #!python or :::python) 1595d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) then it is assumed to be a mock shebang for language identifitation of a 1605d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) code fragment and removed from the code block prior to processing for 1615d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) code highlighting. When a mock shebang (e.i: #!python) is found, line 1625d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) numbering is turned on. When colons are found in place of a shebang 1635d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) (e.i.: :::python), line numbering is left in the current state - off 1645d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) by default. 1655d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ 1675d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1685d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) import re 1695d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1705d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) #split text into lines 1715d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) lines = self.src.split("\n") 1725d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) #pull first line to examine 1735d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) fl = lines.pop(0) 1745d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1755d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) c = re.compile(r''' 1765d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) (?:(?:^::+)|(?P<shebang>^[#]!)) # Shebang or 2 or more colons. 1775d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) (?P<path>(?:/\w+)*[/ ])? # Zero or 1 path 1785d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) (?P<lang>[\w+-]*) # The language 1795d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) ''', re.VERBOSE) 1805d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # search first line for shebang 1815d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) m = c.search(fl) 1825d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if m: 1835d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # we have a match 1845d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) try: 1855d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.lang = m.group('lang').lower() 1865d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) except IndexError: 1875d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.lang = None 1885d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if m.group('path'): 1895d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # path exists - restore first line 1905d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) lines.insert(0, fl) 1915d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if self.linenums is None and m.group('shebang'): 1925d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # Overridable and Shebang exists - use line numbers 1935d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.linenums = True 1945d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) else: 1955d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # No match 1965d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) lines.insert(0, fl) 1975d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 1985d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.src = "\n".join(lines).strip("\n") 1995d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2005d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2015d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2025d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)# ------------------ The Markdown Extension ------------------------------- 2035d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)class HiliteTreeprocessor(Treeprocessor): 2045d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ Hilight source code in code blocks. """ 2055d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2065d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) def run(self, root): 2075d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ Find code blocks and store in htmlStash. """ 2085d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) blocks = root.getiterator('pre') 2095d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) for block in blocks: 2105d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) children = block.getchildren() 2115d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if len(children) == 1 and children[0].tag == 'code': 2125d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) code = CodeHilite(children[0].text, 2135d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) linenums=self.config['linenums'], 2145d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) guess_lang=self.config['guess_lang'], 2155d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) css_class=self.config['css_class'], 2165d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) style=self.config['pygments_style'], 2175d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) noclasses=self.config['noclasses'], 2185d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) tab_length=self.markdown.tab_length) 2195d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) placeholder = self.markdown.htmlStash.store(code.hilite(), 2205d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) safe=True) 2215d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # Clear codeblock in etree instance 2225d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) block.clear() 2235d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # Change to p element which will later 2245d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # be removed when inserting raw html 2255d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) block.tag = 'p' 2265d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) block.text = placeholder 2275d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2285d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2295d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)class CodeHiliteExtension(Extension): 2305d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ Add source code hilighting to markdown codeblocks. """ 2315d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2325d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) def __init__(self, configs): 2335d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # define default configs 2345d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.config = { 2355d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 'linenums': [None, "Use lines numbers. True=yes, False=no, None=auto"], 2365d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 'force_linenos' : [False, "Depreciated! Use 'linenums' instead. Force line numbers - Default: False"], 2375d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 'guess_lang' : [True, "Automatic language detection - Default: True"], 2385d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 'css_class' : ["codehilite", 2395d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) "Set class name for wrapper <div> - Default: codehilite"], 2405d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 'pygments_style' : ['default', 'Pygments HTML Formatter Style (Colorscheme) - Default: default'], 2415d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 'noclasses': [False, 'Use inline styles instead of CSS classes - Default false'] 2425d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) } 2435d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2445d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # Override defaults with user settings 2455d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) for key, value in configs: 2465d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # convert strings to booleans 2475d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if value == 'True': value = True 2485d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if value == 'False': value = False 2495d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if value == 'None': value = None 2505d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2515d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if key == 'force_linenos': 2525d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) warnings.warn('The "force_linenos" config setting' 2535d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) ' to the CodeHilite extension is deprecrecated.' 2545d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) ' Use "linenums" instead.', PendingDeprecationWarning) 2555d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) if value: 2565d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) # Carry 'force_linenos' over to new 'linenos'. 2575d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.setConfig('linenums', True) 2585d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2595d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) self.setConfig(key, value) 2605d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2615d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) def extendMarkdown(self, md, md_globals): 2625d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) """ Add HilitePostprocessor to Markdown instance. """ 2635d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) hiliter = HiliteTreeprocessor(md) 2645d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) hiliter.config = self.getConfigs() 2655d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) md.treeprocessors.add("hilite", hiliter, "<inline") 2665d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2675d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) md.registerExtension(self) 2685d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2695d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 2705d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles)def makeExtension(configs={}): 2715d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) return CodeHiliteExtension(configs=configs) 2725d1f7b1de12d16ceb2c938c56701a3e8bfa558f7Torne (Richard Coles) 273