matplotlib.github.com/3.0.3/_modules/matplotlib/afm.html at main · matplotlib/matplotlib.github.com

History

694 lines (565 loc) · 71.9 KB

Raw

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

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>matplotlib.afm — Matplotlib 3.0.3 documentation</title>

type="text/css" />

type="text/css" />

title="Search within Matplotlib 3.0.3 documentation"

href="../../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v3.0.3). For the latest version see <a href="/stable/">https://matplotlib.org/stable/</a> </div>

<div style="float: left; position: absolute; width: 496px; bottom: 0; padding-bottom: 24px">Version 3.0.3</div>

<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li><a href="../../gallery/index.html">examples</a>| </li>

<li><a href="../../tutorials/index.html">tutorials</a>| </li>

<li><a href="../index.html" >Module code</a> »</li>

<li><a href="../matplotlib.html" accesskey="U">matplotlib</a> »</li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

<h3>Related Topics</h3>

<ul>

<li><a href="../../contents.html">Documentation overview</a><ul>

<li><a href="../index.html">Module code</a><ul>

<li><a href="../matplotlib.html">matplotlib</a><ul>

</ul></li>

</ul>

</div>

<h1>Source code for matplotlib.afm</h1><div class="highlight"><pre>

"""

This is a python interface to Adobe Font Metrics Files. Although a

number of other python implementations exist, and may be more complete

than this, it was decided not to go with them because they were

either:

1) copyrighted or used a non-BSD compatible license

2) had too many dependencies and a free standing lib was needed

3) Did more than needed and it was easier to write afresh rather than

figure out how to get just what was needed.

It is pretty easy to use, and requires only built-in python libs:

>>> from matplotlib import rcParams

>>> import os.path

>>> afm_fname = os.path.join(rcParams['datapath'],

... 'fonts', 'afm', 'ptmr8a.afm')

>>>

>>> from matplotlib.afm import AFM

>>> with open(afm_fname, 'rb') as fh:

... afm = AFM(fh)

>>> afm.string_width_height('What the heck?')

(6220.0, 694)

>>> afm.get_fontname()

'Times-Roman'

>>> afm.get_kern_dist('A', 'f')

0

>>> afm.get_kern_dist('A', 'y')

-92.0

>>> afm.get_bbox_char('!')

[130, -9, 238, 676]

As in the Adobe Font Metrics File Format Specification, all dimensions

are given in units of 1/1000 of the scale factor (point size) of the font

being used.

"""

from collections import namedtuple

import re

import sys

from ._mathtext_data import uni2type1

from matplotlib.cbook import deprecated

# some afm files have floats where we are expecting ints -- there is

# probably a better way to handle this (support floats, round rather

# than truncate). But I don't know what the best approach is now and

# this change to _to_int should at least prevent mpl from crashing on

# these JDH (2009-11-06)

def _to_int(x):

return int(float(x))

_to_float = float

def _to_str(x):

return x.decode('utf8')

def _to_list_of_ints(s):

s = s.replace(b',', b' ')

return [_to_int(val) for val in s.split()]

def _to_list_of_floats(s):

return [_to_float(val) for val in s.split()]

def _to_bool(s):

if s.lower().strip() in (b'false', b'0', b'no'):

return False

else:

return True

def _sanity_check(fh):

"""

Check if the file at least looks like AFM.

If not, raise :exc:`RuntimeError`.

"""

# Remember the file position in case the caller wants to

# do something else with the file.

pos = fh.tell()

try:

line = next(fh)

finally:

fh.seek(pos, 0)

# AFM spec, Section 4: The StartFontMetrics keyword [followed by a

# version number] must be the first line in the file, and the

# EndFontMetrics keyword must be the last non-empty line in the

# file. We just check the first line.

if not line.startswith(b'StartFontMetrics'):

raise RuntimeError('Not an AFM file')

def _parse_header(fh):

"""

Reads the font metrics header (up to the char metrics) and returns

a dictionary mapping *key* to *val*. *val* will be converted to the

appropriate python type as necessary; e.g.:

* 'False'->False

* '0'->0

* '-168 -218 1000 898'-> [-168, -218, 1000, 898]

Dictionary keys are

StartFontMetrics, FontName, FullName, FamilyName, Weight,

ItalicAngle, IsFixedPitch, FontBBox, UnderlinePosition,

UnderlineThickness, Version, Notice, EncodingScheme, CapHeight,

XHeight, Ascender, Descender, StartCharMetrics

"""

headerConverters = {

b'StartFontMetrics': _to_float,

b'FontName': _to_str,

b'FullName': _to_str,

b'FamilyName': _to_str,

b'Weight': _to_str,

b'ItalicAngle': _to_float,

b'IsFixedPitch': _to_bool,

b'FontBBox': _to_list_of_ints,

b'UnderlinePosition': _to_int,

b'UnderlineThickness': _to_int,

b'Version': _to_str,

b'Notice': _to_str,

b'EncodingScheme': _to_str,

b'CapHeight': _to_float, # Is the second version a mistake, or

b'Capheight': _to_float, # do some AFM files contain 'Capheight'? -JKS

b'XHeight': _to_float,

b'Ascender': _to_float,

b'Descender': _to_float,

b'StdHW': _to_float,

b'StdVW': _to_float,

b'StartCharMetrics': _to_int,

b'CharacterSet': _to_str,

b'Characters': _to_int,

}

d = {}

for line in fh:

line = line.rstrip()

if line.startswith(b'Comment'):

continue

lst = line.split(b' ', 1)

key = lst[0]

if len(lst) == 2:

val = lst[1]

else:

val = b''

try:

d[key] = headerConverters[key](val)

except ValueError:

print('Value error parsing header in AFM:', key, val,

file=sys.stderr)

continue

except KeyError:

print('Found an unknown keyword in AFM header (was %r)' % key,

file=sys.stderr)

continue

if key == b'StartCharMetrics':

return d

raise RuntimeError('Bad parse')

CharMetrics = namedtuple('CharMetrics', 'width, name, bbox')

CharMetrics.__doc__ = """

Represents the character metrics of a single character.

Notes

-----

The fields do currently only describe a subset of character metrics

information defined in the AFM standard.

"""

CharMetrics.width.__doc__ = """The character width (WX)."""

CharMetrics.name.__doc__ = """The character name (N)."""

CharMetrics.bbox.__doc__ = """

The bbox of the character (B) as a tuple (*llx*, *lly*, *urx*, *ury*)."""

def _parse_char_metrics(fh):

"""

Parse the given filehandle for character metrics information and return

the information as dicts.

It is assumed that the file cursor is on the line behind

'StartCharMetrics'.

Returns

-------

ascii_d : dict

A mapping "ASCII num of the character" to `.CharMetrics`.

name_d : dict

A mapping "character name" to `.CharMetrics`.

Notes

-----

This function is incomplete per the standard, but thus far parses

all the sample afm files tried.

"""

required_keys = {'C', 'WX', 'N', 'B'}

ascii_d = {}

name_d = {}

for line in fh:

# We are defensively letting values be utf8. The spec requires

# ascii, but there are non-compliant fonts in circulation

line = _to_str(line.rstrip()) # Convert from byte-literal

if line.startswith('EndCharMetrics'):

return ascii_d, name_d

# Split the metric line into a dictionary, keyed by metric identifiers

vals = dict(s.strip().split(' ', 1) for s in line.split(';') if s)

# There may be other metrics present, but only these are needed

if not required_keys.issubset(vals):

raise RuntimeError('Bad char metrics line: %s' % line)

num = _to_int(vals['C'])

wx = _to_float(vals['WX'])

name = vals['N']

bbox = _to_list_of_floats(vals['B'])

bbox = list(map(int, bbox))

metrics = CharMetrics(wx, name, bbox)

# Workaround: If the character name is 'Euro', give it the

# corresponding character code, according to WinAnsiEncoding (see PDF

# Reference).

if name == 'Euro':

num = 128

if num != -1:

ascii_d[num] = metrics

name_d[name] = metrics

raise RuntimeError('Bad parse')

def _parse_kern_pairs(fh):

"""

Return a kern pairs dictionary; keys are (*char1*, *char2*) tuples and

values are the kern pair value. For example, a kern pairs line like

``KPX A y -50``

will be represented as::

d[ ('A', 'y') ] = -50

"""

line = next(fh)

raise RuntimeError('Bad start of kern pairs data: %s' % line)

d = {}

for line in fh:

line = line.rstrip()

if not line:

continue

next(fh) # EndKernData

return d

vals = line.split()

if len(vals) != 4 or vals[0] != b'KPX':

raise RuntimeError('Bad kern pairs line: %s' % line)

c1, c2, val = _to_str(vals[1]), _to_str(vals[2]), _to_float(vals[3])

d[(c1, c2)] = val

raise RuntimeError('Bad kern pairs parse')

CompositePart = namedtuple('CompositePart', 'name, dx, dy')

CompositePart.__doc__ = """

Represents the information on a composite element of a composite char."""

CompositePart.name.__doc__ = """Name of the part, e.g. 'acute'."""

CompositePart.dx.__doc__ = """x-displacement of the part from the origin."""

CompositePart.dy.__doc__ = """y-displacement of the part from the origin."""

def _parse_composites(fh):

"""

Parse the given filehandle for composites information return them as a

dict.

It is assumed that the file cursor is on the line behind 'StartComposites'.

Returns

-------

composites : dict

A dict mapping composite character names to a parts list. The parts

list is a list of `.CompositePart` entries describing the parts of

the composite.

Example

-------

A composite definition line::

CC Aacute 2 ; PCC A 0 0 ; PCC acute 160 170 ;

will be represented as::

composites['Aacute'] = [CompositePart(name='A', dx=0, dy=0),

CompositePart(name='acute', dx=160, dy=170)]

"""

composites = {}

for line in fh:

line = line.rstrip()

if not line:

continue

return composites

vals = line.split(b';')

cc = vals[0].split()

name, numParts = cc[1], _to_int(cc[2])

pccParts = []

for s in vals[1:-1]:

pcc = s.split()

part = CompositePart(pcc[1], _to_float(pcc[2]), _to_float(pcc[3]))

pccParts.append(part)

composites[name] = pccParts

raise RuntimeError('Bad composites parse')

def _parse_optional(fh):

"""

Parse the optional fields for kern pair data and composites.

Returns

-------

kern_data : dict

A dict containing kerning information. May be empty.

See `._parse_kern_pairs`.

composites : dict

A dict containing composite information. May be empty.

See `._parse_composites`.

"""

optional = {

b'StartKernData': _parse_kern_pairs,

b'StartComposites': _parse_composites,

}

d = {b'StartKernData': {},

b'StartComposites': {}}

for line in fh:

line = line.rstrip()

if not line:

continue

key = line.split()[0]

if key in optional:

d[key] = optional[key](fh)

return d[b'StartKernData'], d[b'StartComposites']

<div class="viewcode-block" id="parse_afm"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.parse_afm">[docs]</a>@deprecated("3.0", "Use the class AFM instead.")

def parse_afm(fh):

return _parse_afm(fh)</div>

def _parse_afm(fh):

"""

Parse the Adobe Font Metrics file in file handle *fh*.

Returns

-------

header : dict

A header dict. See :func:`_parse_header`.

cmetrics_by_ascii : dict

From :func:`_parse_char_metrics`.

cmetrics_by_name : dict

From :func:`_parse_char_metrics`.

kernpairs : dict

From :func:`_parse_kern_pairs`.

composites : dict

From :func:`_parse_composites`

"""

_sanity_check(fh)

header = _parse_header(fh)

cmetrics_by_ascii, cmetrics_by_name = _parse_char_metrics(fh)

kernpairs, composites = _parse_optional(fh)

return header, cmetrics_by_ascii, cmetrics_by_name, kernpairs, composites

<div class="viewcode-block" id="AFM"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM">[docs]</a>class AFM(object):

def __init__(self, fh):

"""Parse the AFM file in file object *fh*."""

(self._header,

self._metrics,

self._metrics_by_name,

self._kern,

self._composite) = _parse_afm(fh)

<div class="viewcode-block" id="AFM.get_bbox_char"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_bbox_char">[docs]</a> def get_bbox_char(self, c, isord=False):

if not isord:

c = ord(c)

return self._metrics[c].bbox</div>

<div class="viewcode-block" id="AFM.string_width_height"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.string_width_height">[docs]</a> def string_width_height(self, s):

"""

Return the string width (including kerning) and string height

as a (*w*, *h*) tuple.

"""

if not len(s):

return 0, 0

total_width = 0

namelast = None

miny = 1e9

maxy = 0

for c in s:

if c == '\n':

continue

wx, name, bbox = self._metrics[ord(c)]

total_width += wx + self._kern.get((namelast, name), 0)

l, b, w, h = bbox

miny = min(miny, b)

maxy = max(maxy, b + h)

namelast = name

return total_width, maxy - miny</div>

<div class="viewcode-block" id="AFM.get_str_bbox_and_descent"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_str_bbox_and_descent">[docs]</a> def get_str_bbox_and_descent(self, s):

"""Return the string bounding box and the maximal descent."""

if not len(s):

return 0, 0, 0, 0, 0

total_width = 0

namelast = None

miny = 1e9

maxy = 0

left = 0

if not isinstance(s, str):

s = _to_str(s)

for c in s:

if c == '\n':

continue

name = uni2type1.get(ord(c), 'question')

try:

wx, _, bbox = self._metrics_by_name[name]

except KeyError:

name = 'question'

left = min(left, l)

namelast = name

return left, miny, total_width, maxy - miny, -miny</div>

<div class="viewcode-block" id="AFM.get_str_bbox"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_str_bbox">[docs]</a> def get_str_bbox(self, s):

"""Return the string bounding box."""

return self.get_str_bbox_and_descent(s)[:4]</div>

<div class="viewcode-block" id="AFM.get_name_char"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_name_char">[docs]</a> def get_name_char(self, c, isord=False):

"""Get the name of the character, i.e., ';' is 'semicolon'."""

if not isord:

c = ord(c)

<div class="viewcode-block" id="AFM.get_width_char"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_width_char">[docs]</a> def get_width_char(self, c, isord=False):

"""

Get the width of the character from the character metric WX field.

"""

if not isord:

c = ord(c)

<div class="viewcode-block" id="AFM.get_width_from_char_name"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_width_from_char_name">[docs]</a> def get_width_from_char_name(self, name):

"""Get the width of the character from a type1 character name."""

return self._metrics_by_name[name].width</div>

<div class="viewcode-block" id="AFM.get_height_char"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_height_char">[docs]</a> def get_height_char(self, c, isord=False):

"""Get the bounding box (ink) height of character *c* (space is 0)."""

if not isord:

c = ord(c)

<div class="viewcode-block" id="AFM.get_kern_dist"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_kern_dist">[docs]</a> def get_kern_dist(self, c1, c2):

"""

Return the kerning pair distance (possibly 0) for chars *c1* and *c2*.

"""

name1, name2 = self.get_name_char(c1), self.get_name_char(c2)

return self.get_kern_dist_from_name(name1, name2)</div>

<div class="viewcode-block" id="AFM.get_kern_dist_from_name"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_kern_dist_from_name">[docs]</a> def get_kern_dist_from_name(self, name1, name2):

"""

Return the kerning pair distance (possibly 0) for chars

*name1* and *name2*.

"""

return self._kern.get((name1, name2), 0)</div>

<div class="viewcode-block" id="AFM.get_fontname"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_fontname">[docs]</a> def get_fontname(self):

"""Return the font name, e.g., 'Times-Roman'."""

return self._header[b'FontName']</div>

<div class="viewcode-block" id="AFM.get_fullname"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_fullname">[docs]</a> def get_fullname(self):

"""Return the font full name, e.g., 'Times-Roman'."""

name = self._header.get(b'FullName')

if name is None: # use FontName as a substitute

name = self._header[b'FontName']

return name</div>

<div class="viewcode-block" id="AFM.get_familyname"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_familyname">[docs]</a> def get_familyname(self):

"""Return the font family name, e.g., 'Times'."""

if name is not None:

return name

# FamilyName not specified so we'll make a guess

name = self.get_fullname()

r'light|ultralight|extra|condensed))+$')

return re.sub(extras, '', name)</div>

@property

def family_name(self):

"""The font family name, e.g., 'Times'."""

return self.get_familyname()

<div class="viewcode-block" id="AFM.get_weight"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_weight">[docs]</a> def get_weight(self):

"""Return the font weight, e.g., 'Bold' or 'Roman'."""

<div class="viewcode-block" id="AFM.get_angle"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_angle">[docs]</a> def get_angle(self):

"""Return the fontangle as float."""

<div class="viewcode-block" id="AFM.get_capheight"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_capheight">[docs]</a> def get_capheight(self):

"""Return the cap height as float."""

<div class="viewcode-block" id="AFM.get_xheight"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_xheight">[docs]</a> def get_xheight(self):

"""Return the xheight as float."""

<div class="viewcode-block" id="AFM.get_underline_thickness"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_underline_thickness">[docs]</a> def get_underline_thickness(self):

"""Return the underline thickness as float."""

<div class="viewcode-block" id="AFM.get_horizontal_stem_width"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_horizontal_stem_width">[docs]</a> def get_horizontal_stem_width(self):

"""

Return the standard horizontal stem width as float, or *None* if

not specified in AFM file.

"""

return self._header.get(b'StdHW', None)</div>

<div class="viewcode-block" id="AFM.get_vertical_stem_width"><a class="viewcode-back" href="../../api/afm_api.html#matplotlib.afm.AFM.get_vertical_stem_width">[docs]</a> def get_vertical_stem_width(self):

"""

Return the standard vertical stem width as float, or *None* if

not specified in AFM file.

"""

return self._header.get(b'StdVW', None)</div></div>

</pre></div>

</div>

</div>

Last updated on Feb 28, 2019.

Created using

<a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.

Doc version v3.0.3-2-gfc177a9cd.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

afm.html

Latest commit

History

afm.html

File metadata and controls