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

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

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

""" 

    pygments.formatters.img 

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

 

    Formatter for Pixmap output. 

 

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

    :license: BSD, see LICENSE for details. 

""" 

 

import sys 

 

from pygments.formatter import Formatter 

from pygments.util import get_bool_opt, get_int_opt, get_list_opt, \ 

    get_choice_opt, xrange 

 

# Import this carefully 

try: 

    from PIL import Image, ImageDraw, ImageFont 

    pil_available = True 

except ImportError: 

    pil_available = False 

 

try: 

    import _winreg 

except ImportError: 

    try: 

        import winreg as _winreg 

    except ImportError: 

        _winreg = None 

 

__all__ = ['ImageFormatter', 'GifImageFormatter', 'JpgImageFormatter', 

           'BmpImageFormatter'] 

 

 

# For some unknown reason every font calls it something different 

STYLES = { 

    'NORMAL':     ['', 'Roman', 'Book', 'Normal', 'Regular', 'Medium'], 

    'ITALIC':     ['Oblique', 'Italic'], 

    'BOLD':       ['Bold'], 

    'BOLDITALIC': ['Bold Oblique', 'Bold Italic'], 

} 

 

# A sane default for modern systems 

DEFAULT_FONT_NAME_NIX = 'Bitstream Vera Sans Mono' 

DEFAULT_FONT_NAME_WIN = 'Courier New' 

 

 

class PilNotAvailable(ImportError): 

    """When Python imaging library is not available""" 

 

 

class FontNotFound(Exception): 

    """When there are no usable fonts specified""" 

 

 

class FontManager(object): 

    """ 

    Manages a set of fonts: normal, italic, bold, etc... 

    """ 

 

    def __init__(self, font_name, font_size=14): 

        self.font_name = font_name 

        self.font_size = font_size 

        self.fonts = {} 

        self.encoding = None 

        if sys.platform.startswith('win'): 

            if not font_name: 

                self.font_name = DEFAULT_FONT_NAME_WIN 

            self._create_win() 

        else: 

            if not font_name: 

                self.font_name = DEFAULT_FONT_NAME_NIX 

            self._create_nix() 

 

    def _get_nix_font_path(self, name, style): 

        try: 

            from commands import getstatusoutput 

        except ImportError: 

            from subprocess import getstatusoutput 

        exit, out = getstatusoutput('fc-list "%s:style=%s" file' % 

                                    (name, style)) 

        if not exit: 

            lines = out.splitlines() 

            if lines: 

                path = lines[0].strip().strip(':') 

                return path 

 

    def _create_nix(self): 

        for name in STYLES['NORMAL']: 

            path = self._get_nix_font_path(self.font_name, name) 

            if path is not None: 

                self.fonts['NORMAL'] = ImageFont.truetype(path, self.font_size) 

                break 

        else: 

            raise FontNotFound('No usable fonts named: "%s"' % 

                               self.font_name) 

        for style in ('ITALIC', 'BOLD', 'BOLDITALIC'): 

            for stylename in STYLES[style]: 

                path = self._get_nix_font_path(self.font_name, stylename) 

                if path is not None: 

                    self.fonts[style] = ImageFont.truetype(path, self.font_size) 

                    break 

            else: 

                if style == 'BOLDITALIC': 

                    self.fonts[style] = self.fonts['BOLD'] 

                else: 

                    self.fonts[style] = self.fonts['NORMAL'] 

 

    def _lookup_win(self, key, basename, styles, fail=False): 

        for suffix in ('', ' (TrueType)'): 

            for style in styles: 

                try: 

                    valname = '%s%s%s' % (basename, style and ' '+style, suffix) 

                    val, _ = _winreg.QueryValueEx(key, valname) 

                    return val 

                except EnvironmentError: 

                    continue 

        else: 

            if fail: 

                raise FontNotFound('Font %s (%s) not found in registry' % 

                                   (basename, styles[0])) 

            return None 

 

    def _create_win(self): 

        try: 

            key = _winreg.OpenKey( 

                _winreg.HKEY_LOCAL_MACHINE, 

                r'Software\Microsoft\Windows NT\CurrentVersion\Fonts') 

        except EnvironmentError: 

            try: 

                key = _winreg.OpenKey( 

                    _winreg.HKEY_LOCAL_MACHINE, 

                    r'Software\Microsoft\Windows\CurrentVersion\Fonts') 

            except EnvironmentError: 

                raise FontNotFound('Can\'t open Windows font registry key') 

        try: 

            path = self._lookup_win(key, self.font_name, STYLES['NORMAL'], True) 

            self.fonts['NORMAL'] = ImageFont.truetype(path, self.font_size) 

            for style in ('ITALIC', 'BOLD', 'BOLDITALIC'): 

                path = self._lookup_win(key, self.font_name, STYLES[style]) 

                if path: 

                    self.fonts[style] = ImageFont.truetype(path, self.font_size) 

                else: 

                    if style == 'BOLDITALIC': 

                        self.fonts[style] = self.fonts['BOLD'] 

                    else: 

                        self.fonts[style] = self.fonts['NORMAL'] 

        finally: 

            _winreg.CloseKey(key) 

 

    def get_char_size(self): 

        """ 

        Get the character size. 

        """ 

        return self.fonts['NORMAL'].getsize('M') 

 

    def get_font(self, bold, oblique): 

        """ 

        Get the font based on bold and italic flags. 

        """ 

        if bold and oblique: 

            return self.fonts['BOLDITALIC'] 

        elif bold: 

            return self.fonts['BOLD'] 

        elif oblique: 

            return self.fonts['ITALIC'] 

        else: 

            return self.fonts['NORMAL'] 

 

 

class ImageFormatter(Formatter): 

    """ 

    Create a PNG image from source code. This uses the Python Imaging Library to 

    generate a pixmap from the source code. 

 

    .. versionadded:: 0.10 

 

    Additional options accepted: 

 

    `image_format` 

        An image format to output to that is recognised by PIL, these include: 

 

        * "PNG" (default) 

        * "JPEG" 

        * "BMP" 

        * "GIF" 

 

    `line_pad` 

        The extra spacing (in pixels) between each line of text. 

 

        Default: 2 

 

    `font_name` 

        The font name to be used as the base font from which others, such as 

        bold and italic fonts will be generated.  This really should be a 

        monospace font to look sane. 

 

        Default: "Bitstream Vera Sans Mono" 

 

    `font_size` 

        The font size in points to be used. 

 

        Default: 14 

 

    `image_pad` 

        The padding, in pixels to be used at each edge of the resulting image. 

 

        Default: 10 

 

    `line_numbers` 

        Whether line numbers should be shown: True/False 

 

        Default: True 

 

    `line_number_start` 

        The line number of the first line. 

 

        Default: 1 

 

    `line_number_step` 

        The step used when printing line numbers. 

 

        Default: 1 

 

    `line_number_bg` 

        The background colour (in "#123456" format) of the line number bar, or 

        None to use the style background color. 

 

        Default: "#eed" 

 

    `line_number_fg` 

        The text color of the line numbers (in "#123456"-like format). 

 

        Default: "#886" 

 

    `line_number_chars` 

        The number of columns of line numbers allowable in the line number 

        margin. 

 

        Default: 2 

 

    `line_number_bold` 

        Whether line numbers will be bold: True/False 

 

        Default: False 

 

    `line_number_italic` 

        Whether line numbers will be italicized: True/False 

 

        Default: False 

 

    `line_number_separator` 

        Whether a line will be drawn between the line number area and the 

        source code area: True/False 

 

        Default: True 

 

    `line_number_pad` 

        The horizontal padding (in pixels) between the line number margin, and 

        the source code area. 

 

        Default: 6 

 

    `hl_lines` 

        Specify a list of lines to be highlighted. 

 

        .. versionadded:: 1.2 

 

        Default: empty list 

 

    `hl_color` 

        Specify the color for highlighting lines. 

 

        .. versionadded:: 1.2 

 

        Default: highlight color of the selected style 

    """ 

 

    # Required by the pygments mapper 

    name = 'img' 

    aliases = ['img', 'IMG', 'png'] 

    filenames = ['*.png'] 

 

    unicodeoutput = False 

 

    default_image_format = 'png' 

 

    def __init__(self, **options): 

        """ 

        See the class docstring for explanation of options. 

        """ 

        if not pil_available: 

            raise PilNotAvailable( 

                'Python Imaging Library is required for this formatter') 

        Formatter.__init__(self, **options) 

        self.encoding = 'latin1'  # let pygments.format() do the right thing 

        # Read the style 

        self.styles = dict(self.style) 

        if self.style.background_color is None: 

            self.background_color = '#fff' 

        else: 

            self.background_color = self.style.background_color 

        # Image options 

        self.image_format = get_choice_opt( 

            options, 'image_format', ['png', 'jpeg', 'gif', 'bmp'], 

            self.default_image_format, normcase=True) 

        self.image_pad = get_int_opt(options, 'image_pad', 10) 

        self.line_pad = get_int_opt(options, 'line_pad', 2) 

        # The fonts 

        fontsize = get_int_opt(options, 'font_size', 14) 

        self.fonts = FontManager(options.get('font_name', ''), fontsize) 

        self.fontw, self.fonth = self.fonts.get_char_size() 

        # Line number options 

        self.line_number_fg = options.get('line_number_fg', '#886') 

        self.line_number_bg = options.get('line_number_bg', '#eed') 

        self.line_number_chars = get_int_opt(options, 

                                             'line_number_chars', 2) 

        self.line_number_bold = get_bool_opt(options, 

                                             'line_number_bold', False) 

        self.line_number_italic = get_bool_opt(options, 

                                               'line_number_italic', False) 

        self.line_number_pad = get_int_opt(options, 'line_number_pad', 6) 

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

        self.line_number_separator = get_bool_opt(options, 

                                                  'line_number_separator', True) 

        self.line_number_step = get_int_opt(options, 'line_number_step', 1) 

        self.line_number_start = get_int_opt(options, 'line_number_start', 1) 

        if self.line_numbers: 

            self.line_number_width = (self.fontw * self.line_number_chars + 

                                      self.line_number_pad * 2) 

        else: 

            self.line_number_width = 0 

        self.hl_lines = [] 

        hl_lines_str = get_list_opt(options, 'hl_lines', []) 

        for line in hl_lines_str: 

            try: 

                self.hl_lines.append(int(line)) 

            except ValueError: 

                pass 

        self.hl_color = options.get('hl_color', 

                                    self.style.highlight_color) or '#f90' 

        self.drawables = [] 

 

    def get_style_defs(self, arg=''): 

        raise NotImplementedError('The -S option is meaningless for the image ' 

                                  'formatter. Use -O style=<stylename> instead.') 

 

    def _get_line_height(self): 

        """ 

        Get the height of a line. 

        """ 

        return self.fonth + self.line_pad 

 

    def _get_line_y(self, lineno): 

        """ 

        Get the Y coordinate of a line number. 

        """ 

        return lineno * self._get_line_height() + self.image_pad 

 

    def _get_char_width(self): 

        """ 

        Get the width of a character. 

        """ 

        return self.fontw 

 

    def _get_char_x(self, charno): 

        """ 

        Get the X coordinate of a character position. 

        """ 

        return charno * self.fontw + self.image_pad + self.line_number_width 

 

    def _get_text_pos(self, charno, lineno): 

        """ 

        Get the actual position for a character and line position. 

        """ 

        return self._get_char_x(charno), self._get_line_y(lineno) 

 

    def _get_linenumber_pos(self, lineno): 

        """ 

        Get the actual position for the start of a line number. 

        """ 

        return (self.image_pad, self._get_line_y(lineno)) 

 

    def _get_text_color(self, style): 

        """ 

        Get the correct color for the token from the style. 

        """ 

        if style['color'] is not None: 

            fill = '#' + style['color'] 

        else: 

            fill = '#000' 

        return fill 

 

    def _get_style_font(self, style): 

        """ 

        Get the correct font for the style. 

        """ 

        return self.fonts.get_font(style['bold'], style['italic']) 

 

    def _get_image_size(self, maxcharno, maxlineno): 

        """ 

        Get the required image size. 

        """ 

        return (self._get_char_x(maxcharno) + self.image_pad, 

                self._get_line_y(maxlineno + 0) + self.image_pad) 

 

    def _draw_linenumber(self, posno, lineno): 

        """ 

        Remember a line number drawable to paint later. 

        """ 

        self._draw_text( 

            self._get_linenumber_pos(posno), 

            str(lineno).rjust(self.line_number_chars), 

            font=self.fonts.get_font(self.line_number_bold, 

                                     self.line_number_italic), 

            fill=self.line_number_fg, 

        ) 

 

    def _draw_text(self, pos, text, font, **kw): 

        """ 

        Remember a single drawable tuple to paint later. 

        """ 

        self.drawables.append((pos, text, font, kw)) 

 

    def _create_drawables(self, tokensource): 

        """ 

        Create drawables for the token content. 

        """ 

        lineno = charno = maxcharno = 0 

        for ttype, value in tokensource: 

            while ttype not in self.styles: 

                ttype = ttype.parent 

            style = self.styles[ttype] 

            # TODO: make sure tab expansion happens earlier in the chain.  It 

            # really ought to be done on the input, as to do it right here is 

            # quite complex. 

            value = value.expandtabs(4) 

            lines = value.splitlines(True) 

            # print lines 

            for i, line in enumerate(lines): 

                temp = line.rstrip('\n') 

                if temp: 

                    self._draw_text( 

                        self._get_text_pos(charno, lineno), 

                        temp, 

                        font = self._get_style_font(style), 

                        fill = self._get_text_color(style) 

                    ) 

                    charno += len(temp) 

                    maxcharno = max(maxcharno, charno) 

                if line.endswith('\n'): 

                    # add a line for each extra line in the value 

                    charno = 0 

                    lineno += 1 

        self.maxcharno = maxcharno 

        self.maxlineno = lineno 

 

    def _draw_line_numbers(self): 

        """ 

        Create drawables for the line numbers. 

        """ 

        if not self.line_numbers: 

            return 

        for p in xrange(self.maxlineno): 

            n = p + self.line_number_start 

            if (n % self.line_number_step) == 0: 

                self._draw_linenumber(p, n) 

 

    def _paint_line_number_bg(self, im): 

        """ 

        Paint the line number background on the image. 

        """ 

        if not self.line_numbers: 

            return 

        if self.line_number_fg is None: 

            return 

        draw = ImageDraw.Draw(im) 

        recth = im.size[-1] 

        rectw = self.image_pad + self.line_number_width - self.line_number_pad 

        draw.rectangle([(0, 0), (rectw, recth)], 

                       fill=self.line_number_bg) 

        draw.line([(rectw, 0), (rectw, recth)], fill=self.line_number_fg) 

        del draw 

 

    def format(self, tokensource, outfile): 

        """ 

        Format ``tokensource``, an iterable of ``(tokentype, tokenstring)`` 

        tuples and write it into ``outfile``. 

 

        This implementation calculates where it should draw each token on the 

        pixmap, then calculates the required pixmap size and draws the items. 

        """ 

        self._create_drawables(tokensource) 

        self._draw_line_numbers() 

        im = Image.new( 

            'RGB', 

            self._get_image_size(self.maxcharno, self.maxlineno), 

            self.background_color 

        ) 

        self._paint_line_number_bg(im) 

        draw = ImageDraw.Draw(im) 

        # Highlight 

        if self.hl_lines: 

            x = self.image_pad + self.line_number_width - self.line_number_pad + 1 

            recth = self._get_line_height() 

            rectw = im.size[0] - x 

            for linenumber in self.hl_lines: 

                y = self._get_line_y(linenumber - 1) 

                draw.rectangle([(x, y), (x + rectw, y + recth)], 

                               fill=self.hl_color) 

        for pos, value, font, kw in self.drawables: 

            draw.text(pos, value, font=font, **kw) 

        im.save(outfile, self.image_format.upper()) 

 

 

# Add one formatter per format, so that the "-f gif" option gives the correct result 

# when used in pygmentize. 

 

class GifImageFormatter(ImageFormatter): 

    """ 

    Create a GIF image from source code. This uses the Python Imaging Library to 

    generate a pixmap from the source code. 

 

    .. versionadded:: 1.0 

    """ 

 

    name = 'img_gif' 

    aliases = ['gif'] 

    filenames = ['*.gif'] 

    default_image_format = 'gif' 

 

 

class JpgImageFormatter(ImageFormatter): 

    """ 

    Create a JPEG image from source code. This uses the Python Imaging Library to 

    generate a pixmap from the source code. 

 

    .. versionadded:: 1.0 

    """ 

 

    name = 'img_jpg' 

    aliases = ['jpg', 'jpeg'] 

    filenames = ['*.jpg'] 

    default_image_format = 'jpeg' 

 

 

class BmpImageFormatter(ImageFormatter): 

    """ 

    Create a bitmap image from source code. This uses the Python Imaging Library to 

    generate a pixmap from the source code. 

 

    .. versionadded:: 1.0 

    """ 

 

    name = 'img_bmp' 

    aliases = ['bmp', 'bitmap'] 

    filenames = ['*.bmp'] 

    default_image_format = 'bmp'