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

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

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

""" 

    pygments.lexers.markup 

    ~~~~~~~~~~~~~~~~~~~~~~ 

 

    Lexers for non-HTML markup languages. 

 

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

    :license: BSD, see LICENSE for details. 

""" 

 

import re 

 

from pygments.lexers.html import HtmlLexer, XmlLexer 

from pygments.lexers.javascript import JavascriptLexer 

from pygments.lexers.css import CssLexer 

 

from pygments.lexer import RegexLexer, DelegatingLexer, include, bygroups, \ 

    using, this, do_insertions, default, words 

from pygments.token import Text, Comment, Operator, Keyword, Name, String, \ 

    Number, Punctuation, Generic, Other 

from pygments.util import get_bool_opt, ClassNotFound 

 

__all__ = ['BBCodeLexer', 'MoinWikiLexer', 'RstLexer', 'TexLexer', 'GroffLexer', 

           'MozPreprocHashLexer', 'MozPreprocPercentLexer', 

           'MozPreprocXulLexer', 'MozPreprocJavascriptLexer', 

           'MozPreprocCssLexer'] 

 

 

class BBCodeLexer(RegexLexer): 

    """ 

    A lexer that highlights BBCode(-like) syntax. 

 

    .. versionadded:: 0.6 

    """ 

 

    name = 'BBCode' 

    aliases = ['bbcode'] 

    mimetypes = ['text/x-bbcode'] 

 

    tokens = { 

        'root': [ 

            (r'[^[]+', Text), 

            # tag/end tag begin 

            (r'\[/?\w+', Keyword, 'tag'), 

            # stray bracket 

            (r'\[', Text), 

        ], 

        'tag': [ 

            (r'\s+', Text), 

            # attribute with value 

            (r'(\w+)(=)("?[^\s"\]]+"?)', 

             bygroups(Name.Attribute, Operator, String)), 

            # tag argument (a la [color=green]) 

            (r'(=)("?[^\s"\]]+"?)', 

             bygroups(Operator, String)), 

            # tag end 

            (r'\]', Keyword, '#pop'), 

        ], 

    } 

 

 

class MoinWikiLexer(RegexLexer): 

    """ 

    For MoinMoin (and Trac) Wiki markup. 

 

    .. versionadded:: 0.7 

    """ 

 

    name = 'MoinMoin/Trac Wiki markup' 

    aliases = ['trac-wiki', 'moin'] 

    filenames = [] 

    mimetypes = ['text/x-trac-wiki'] 

    flags = re.MULTILINE | re.IGNORECASE 

 

    tokens = { 

        'root': [ 

            (r'^#.*$', Comment), 

            (r'(!)(\S+)', bygroups(Keyword, Text)),  # Ignore-next 

            # Titles 

            (r'^(=+)([^=]+)(=+)(\s*#.+)?$', 

             bygroups(Generic.Heading, using(this), Generic.Heading, String)), 

            # Literal code blocks, with optional shebang 

            (r'(\{\{\{)(\n#!.+)?', bygroups(Name.Builtin, Name.Namespace), 'codeblock'), 

            (r'(\'\'\'?|\|\||`|__|~~|\^|,,|::)', Comment),  # Formatting 

            # Lists 

            (r'^( +)([.*-])( )', bygroups(Text, Name.Builtin, Text)), 

            (r'^( +)([a-z]{1,5}\.)( )', bygroups(Text, Name.Builtin, Text)), 

            # Other Formatting 

            (r'\[\[\w+.*?\]\]', Keyword),  # Macro 

            (r'(\[[^\s\]]+)(\s+[^\]]+?)?(\])', 

             bygroups(Keyword, String, Keyword)),  # Link 

            (r'^----+$', Keyword),  # Horizontal rules 

            (r'[^\n\'\[{!_~^,|]+', Text), 

            (r'\n', Text), 

            (r'.', Text), 

        ], 

        'codeblock': [ 

            (r'\}\}\}', Name.Builtin, '#pop'), 

            # these blocks are allowed to be nested in Trac, but not MoinMoin 

            (r'\{\{\{', Text, '#push'), 

            (r'[^{}]+', Comment.Preproc),  # slurp boring text 

            (r'.', Comment.Preproc),  # allow loose { or } 

        ], 

    } 

 

 

class RstLexer(RegexLexer): 

    """ 

    For `reStructuredText <http://docutils.sf.net/rst.html>`_ markup. 

 

    .. versionadded:: 0.7 

 

    Additional options accepted: 

 

    `handlecodeblocks` 

        Highlight the contents of ``.. sourcecode:: language``, 

        ``.. code:: language`` and ``.. code-block:: language`` 

        directives with a lexer for the given language (default: 

        ``True``). 

 

        .. versionadded:: 0.8 

    """ 

    name = 'reStructuredText' 

    aliases = ['rst', 'rest', 'restructuredtext'] 

    filenames = ['*.rst', '*.rest'] 

    mimetypes = ["text/x-rst", "text/prs.fallenstein.rst"] 

    flags = re.MULTILINE 

 

    def _handle_sourcecode(self, match): 

        from pygments.lexers import get_lexer_by_name 

 

        # section header 

        yield match.start(1), Punctuation, match.group(1) 

        yield match.start(2), Text, match.group(2) 

        yield match.start(3), Operator.Word, match.group(3) 

        yield match.start(4), Punctuation, match.group(4) 

        yield match.start(5), Text, match.group(5) 

        yield match.start(6), Keyword, match.group(6) 

        yield match.start(7), Text, match.group(7) 

 

        # lookup lexer if wanted and existing 

        lexer = None 

        if self.handlecodeblocks: 

            try: 

                lexer = get_lexer_by_name(match.group(6).strip()) 

            except ClassNotFound: 

                pass 

        indention = match.group(8) 

        indention_size = len(indention) 

        code = (indention + match.group(9) + match.group(10) + match.group(11)) 

 

        # no lexer for this language. handle it like it was a code block 

        if lexer is None: 

            yield match.start(8), String, code 

            return 

 

        # highlight the lines with the lexer. 

        ins = [] 

        codelines = code.splitlines(True) 

        code = '' 

        for line in codelines: 

            if len(line) > indention_size: 

                ins.append((len(code), [(0, Text, line[:indention_size])])) 

                code += line[indention_size:] 

            else: 

                code += line 

        for item in do_insertions(ins, lexer.get_tokens_unprocessed(code)): 

            yield item 

 

    # from docutils.parsers.rst.states 

    closers = u'\'")]}>\u2019\u201d\xbb!?' 

    unicode_delimiters = u'\u2010\u2011\u2012\u2013\u2014\u00a0' 

    end_string_suffix = (r'((?=$)|(?=[-/:.,; \n\x00%s%s]))' 

                         % (re.escape(unicode_delimiters), 

                            re.escape(closers))) 

 

    tokens = { 

        'root': [ 

            # Heading with overline 

            (r'^(=+|-+|`+|:+|\.+|\'+|"+|~+|\^+|_+|\*+|\++|#+)([ \t]*\n)' 

             r'(.+)(\n)(\1)(\n)', 

             bygroups(Generic.Heading, Text, Generic.Heading, 

                      Text, Generic.Heading, Text)), 

            # Plain heading 

            (r'^(\S.*)(\n)(={3,}|-{3,}|`{3,}|:{3,}|\.{3,}|\'{3,}|"{3,}|' 

             r'~{3,}|\^{3,}|_{3,}|\*{3,}|\+{3,}|#{3,})(\n)', 

             bygroups(Generic.Heading, Text, Generic.Heading, Text)), 

            # Bulleted lists 

            (r'^(\s*)([-*+])( .+\n(?:\1  .+\n)*)', 

             bygroups(Text, Number, using(this, state='inline'))), 

            # Numbered lists 

            (r'^(\s*)([0-9#ivxlcmIVXLCM]+\.)( .+\n(?:\1  .+\n)*)', 

             bygroups(Text, Number, using(this, state='inline'))), 

            (r'^(\s*)(\(?[0-9#ivxlcmIVXLCM]+\))( .+\n(?:\1  .+\n)*)', 

             bygroups(Text, Number, using(this, state='inline'))), 

            # Numbered, but keep words at BOL from becoming lists 

            (r'^(\s*)([A-Z]+\.)( .+\n(?:\1  .+\n)+)', 

             bygroups(Text, Number, using(this, state='inline'))), 

            (r'^(\s*)(\(?[A-Za-z]+\))( .+\n(?:\1  .+\n)+)', 

             bygroups(Text, Number, using(this, state='inline'))), 

            # Line blocks 

            (r'^(\s*)(\|)( .+\n(?:\|  .+\n)*)', 

             bygroups(Text, Operator, using(this, state='inline'))), 

            # Sourcecode directives 

            (r'^( *\.\.)(\s*)((?:source)?code(?:-block)?)(::)([ \t]*)([^\n]+)' 

             r'(\n[ \t]*\n)([ \t]+)(.*)(\n)((?:(?:\8.*|)\n)+)', 

             _handle_sourcecode), 

            # A directive 

            (r'^( *\.\.)(\s*)([\w:-]+?)(::)(?:([ \t]*)(.*))', 

             bygroups(Punctuation, Text, Operator.Word, Punctuation, Text, 

                      using(this, state='inline'))), 

            # A reference target 

            (r'^( *\.\.)(\s*)(_(?:[^:\\]|\\.)+:)(.*?)$', 

             bygroups(Punctuation, Text, Name.Tag, using(this, state='inline'))), 

            # A footnote/citation target 

            (r'^( *\.\.)(\s*)(\[.+\])(.*?)$', 

             bygroups(Punctuation, Text, Name.Tag, using(this, state='inline'))), 

            # A substitution def 

            (r'^( *\.\.)(\s*)(\|.+\|)(\s*)([\w:-]+?)(::)(?:([ \t]*)(.*))', 

             bygroups(Punctuation, Text, Name.Tag, Text, Operator.Word, 

                      Punctuation, Text, using(this, state='inline'))), 

            # Comments 

            (r'^ *\.\..*(\n( +.*\n|\n)+)?', Comment.Preproc), 

            # Field list 

            (r'^( *)(:[a-zA-Z-]+:)(\s*)$', bygroups(Text, Name.Class, Text)), 

            (r'^( *)(:.*?:)([ \t]+)(.*?)$', 

             bygroups(Text, Name.Class, Text, Name.Function)), 

            # Definition list 

            (r'^(\S.*(?<!::)\n)((?:(?: +.*)\n)+)', 

             bygroups(using(this, state='inline'), using(this, state='inline'))), 

            # Code blocks 

            (r'(::)(\n[ \t]*\n)([ \t]+)(.*)(\n)((?:(?:\3.*|)\n)+)', 

             bygroups(String.Escape, Text, String, String, Text, String)), 

            include('inline'), 

        ], 

        'inline': [ 

            (r'\\.', Text),  # escape 

            (r'``', String, 'literal'),  # code 

            (r'(`.+?)(<.+?>)(`__?)',  # reference with inline target 

             bygroups(String, String.Interpol, String)), 

            (r'`.+?`__?', String),  # reference 

            (r'(`.+?`)(:[a-zA-Z0-9:-]+?:)?', 

             bygroups(Name.Variable, Name.Attribute)),  # role 

            (r'(:[a-zA-Z0-9:-]+?:)(`.+?`)', 

             bygroups(Name.Attribute, Name.Variable)),  # role (content first) 

            (r'\*\*.+?\*\*', Generic.Strong),  # Strong emphasis 

            (r'\*.+?\*', Generic.Emph),  # Emphasis 

            (r'\[.*?\]_', String),  # Footnote or citation 

            (r'<.+?>', Name.Tag),   # Hyperlink 

            (r'[^\\\n\[*`:]+', Text), 

            (r'.', Text), 

        ], 

        'literal': [ 

            (r'[^`]+', String), 

            (r'``' + end_string_suffix, String, '#pop'), 

            (r'`', String), 

        ] 

    } 

 

    def __init__(self, **options): 

        self.handlecodeblocks = get_bool_opt(options, 'handlecodeblocks', True) 

        RegexLexer.__init__(self, **options) 

 

    def analyse_text(text): 

        if text[:2] == '..' and text[2:3] != '.': 

            return 0.3 

        p1 = text.find("\n") 

        p2 = text.find("\n", p1 + 1) 

        if (p2 > -1 and              # has two lines 

                p1 * 2 + 1 == p2 and     # they are the same length 

                text[p1+1] in '-=' and   # the next line both starts and ends with 

                text[p1+1] == text[p2-1]):  # ...a sufficiently high header 

            return 0.5 

 

 

class TexLexer(RegexLexer): 

    """ 

    Lexer for the TeX and LaTeX typesetting languages. 

    """ 

 

    name = 'TeX' 

    aliases = ['tex', 'latex'] 

    filenames = ['*.tex', '*.aux', '*.toc'] 

    mimetypes = ['text/x-tex', 'text/x-latex'] 

 

    tokens = { 

        'general': [ 

            (r'%.*?\n', Comment), 

            (r'[{}]', Name.Builtin), 

            (r'[&_^]', Name.Builtin), 

        ], 

        'root': [ 

            (r'\\\[', String.Backtick, 'displaymath'), 

            (r'\\\(', String, 'inlinemath'), 

            (r'\$\$', String.Backtick, 'displaymath'), 

            (r'\$', String, 'inlinemath'), 

            (r'\\([a-zA-Z]+|.)', Keyword, 'command'), 

            (r'\\$', Keyword), 

            include('general'), 

            (r'[^\\$%&_^{}]+', Text), 

        ], 

        'math': [ 

            (r'\\([a-zA-Z]+|.)', Name.Variable), 

            include('general'), 

            (r'[0-9]+', Number), 

            (r'[-=!+*/()\[\]]', Operator), 

            (r'[^=!+*/()\[\]\\$%&_^{}0-9-]+', Name.Builtin), 

        ], 

        'inlinemath': [ 

            (r'\\\)', String, '#pop'), 

            (r'\$', String, '#pop'), 

            include('math'), 

        ], 

        'displaymath': [ 

            (r'\\\]', String, '#pop'), 

            (r'\$\$', String, '#pop'), 

            (r'\$', Name.Builtin), 

            include('math'), 

        ], 

        'command': [ 

            (r'\[.*?\]', Name.Attribute), 

            (r'\*', Keyword), 

            default('#pop'), 

        ], 

    } 

 

    def analyse_text(text): 

        for start in ("\\documentclass", "\\input", "\\documentstyle", 

                      "\\relax"): 

            if text[:len(start)] == start: 

                return True 

 

 

class GroffLexer(RegexLexer): 

    """ 

    Lexer for the (g)roff typesetting language, supporting groff 

    extensions. Mainly useful for highlighting manpage sources. 

 

    .. versionadded:: 0.6 

    """ 

 

    name = 'Groff' 

    aliases = ['groff', 'nroff', 'man'] 

    filenames = ['*.[1234567]', '*.man'] 

    mimetypes = ['application/x-troff', 'text/troff'] 

 

    tokens = { 

        'root': [ 

            (r'(\.)(\w+)', bygroups(Text, Keyword), 'request'), 

            (r'\.', Punctuation, 'request'), 

            # Regular characters, slurp till we find a backslash or newline 

            (r'[^\\\n]+', Text, 'textline'), 

            default('textline'), 

        ], 

        'textline': [ 

            include('escapes'), 

            (r'[^\\\n]+', Text), 

            (r'\n', Text, '#pop'), 

        ], 

        'escapes': [ 

            # groff has many ways to write escapes. 

            (r'\\"[^\n]*', Comment), 

            (r'\\[fn]\w', String.Escape), 

            (r'\\\(.{2}', String.Escape), 

            (r'\\.\[.*\]', String.Escape), 

            (r'\\.', String.Escape), 

            (r'\\\n', Text, 'request'), 

        ], 

        'request': [ 

            (r'\n', Text, '#pop'), 

            include('escapes'), 

            (r'"[^\n"]+"', String.Double), 

            (r'\d+', Number), 

            (r'\S+', String), 

            (r'\s+', Text), 

        ], 

    } 

 

    def analyse_text(text): 

        if text[:1] != '.': 

            return False 

        if text[:3] == '.\\"': 

            return True 

        if text[:4] == '.TH ': 

            return True 

        if text[1:3].isalnum() and text[3].isspace(): 

            return 0.9 

 

 

class MozPreprocHashLexer(RegexLexer): 

    """ 

    Lexer for Mozilla Preprocessor files (with '#' as the marker). 

 

    Other data is left untouched. 

 

    .. versionadded:: 2.0 

    """ 

    name = 'mozhashpreproc' 

    aliases = [name] 

    filenames = [] 

    mimetypes = [] 

 

    tokens = { 

        'root': [ 

            (r'^#', Comment.Preproc, ('expr', 'exprstart')), 

            (r'.+', Other), 

        ], 

        'exprstart': [ 

            (r'(literal)(.*)', bygroups(Comment.Preproc, Text), '#pop:2'), 

            (words(( 

                'define', 'undef', 'if', 'ifdef', 'ifndef', 'else', 'elif', 

                'elifdef', 'elifndef', 'endif', 'expand', 'filter', 'unfilter', 

                'include', 'includesubst', 'error')), 

             Comment.Preproc, '#pop'), 

        ], 

        'expr': [ 

            (words(('!', '!=', '==', '&&', '||')), Operator), 

            (r'(defined)(\()', bygroups(Keyword, Punctuation)), 

            (r'\)', Punctuation), 

            (r'[0-9]+', Number.Decimal), 

            (r'__\w+?__', Name.Variable), 

            (r'@\w+?@', Name.Class), 

            (r'\w+', Name), 

            (r'\n', Text, '#pop'), 

            (r'\s+', Text), 

            (r'\S', Punctuation), 

        ], 

    } 

 

 

class MozPreprocPercentLexer(MozPreprocHashLexer): 

    """ 

    Lexer for Mozilla Preprocessor files (with '%' as the marker). 

 

    Other data is left untouched. 

 

    .. versionadded:: 2.0 

    """ 

    name = 'mozpercentpreproc' 

    aliases = [name] 

    filenames = [] 

    mimetypes = [] 

 

    tokens = { 

        'root': [ 

            (r'^%', Comment.Preproc, ('expr', 'exprstart')), 

            (r'.+', Other), 

        ], 

    } 

 

 

class MozPreprocXulLexer(DelegatingLexer): 

    """ 

    Subclass of the `MozPreprocHashLexer` that highlights unlexed data with the 

    `XmlLexer`. 

 

    .. versionadded:: 2.0 

    """ 

    name = "XUL+mozpreproc" 

    aliases = ['xul+mozpreproc'] 

    filenames = ['*.xul.in'] 

    mimetypes = [] 

 

    def __init__(self, **options): 

        super(MozPreprocXulLexer, self).__init__( 

            XmlLexer, MozPreprocHashLexer, **options) 

 

 

class MozPreprocJavascriptLexer(DelegatingLexer): 

    """ 

    Subclass of the `MozPreprocHashLexer` that highlights unlexed data with the 

    `JavascriptLexer`. 

 

    .. versionadded:: 2.0 

    """ 

    name = "Javascript+mozpreproc" 

    aliases = ['javascript+mozpreproc'] 

    filenames = ['*.js.in'] 

    mimetypes = [] 

 

    def __init__(self, **options): 

        super(MozPreprocJavascriptLexer, self).__init__( 

            JavascriptLexer, MozPreprocHashLexer, **options) 

 

 

class MozPreprocCssLexer(DelegatingLexer): 

    """ 

    Subclass of the `MozPreprocHashLexer` that highlights unlexed data with the 

    `CssLexer`. 

 

    .. versionadded:: 2.0 

    """ 

    name = "CSS+mozpreproc" 

    aliases = ['css+mozpreproc'] 

    filenames = ['*.css.in'] 

    mimetypes = [] 

 

    def __init__(self, **options): 

        super(MozPreprocCssLexer, self).__init__( 

            CssLexer, MozPreprocPercentLexer, **options)