| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265 |
- import logging
- import re
- from io import BytesIO
- from typing import Dict, List, Mapping, Optional, Sequence, Tuple, Union, cast
- from pdfminer import settings
- from pdfminer.casting import safe_cmyk, safe_float, safe_int, safe_matrix, safe_rgb
- from pdfminer.cmapdb import CMap, CMapBase, CMapDB
- from pdfminer.pdfcolor import PREDEFINED_COLORSPACE, PDFColorSpace
- from pdfminer.pdfdevice import PDFDevice, PDFTextSeq
- from pdfminer.pdfexceptions import PDFException, PDFValueError
- from pdfminer.pdffont import (
- PDFCIDFont,
- PDFFont,
- PDFFontError,
- PDFTrueTypeFont,
- PDFType1Font,
- PDFType3Font,
- )
- from pdfminer.pdfpage import PDFPage
- from pdfminer.pdftypes import (
- LITERALS_ASCII85_DECODE,
- PDFObjRef,
- PDFStream,
- dict_value,
- list_value,
- resolve1,
- stream_value,
- )
- from pdfminer.psexceptions import PSEOF, PSTypeError
- from pdfminer.psparser import (
- KWD,
- LIT,
- PSKeyword,
- PSLiteral,
- PSStackParser,
- PSStackType,
- keyword_name,
- literal_name,
- )
- from pdfminer.utils import (
- MATRIX_IDENTITY,
- Matrix,
- PathSegment,
- Point,
- Rect,
- choplist,
- mult_matrix,
- )
- log = logging.getLogger(__name__)
- class PDFResourceError(PDFException):
- pass
- class PDFInterpreterError(PDFException):
- pass
- LITERAL_PDF = LIT("PDF")
- LITERAL_TEXT = LIT("Text")
- LITERAL_FONT = LIT("Font")
- LITERAL_FORM = LIT("Form")
- LITERAL_IMAGE = LIT("Image")
- class PDFTextState:
- matrix: Matrix
- linematrix: Point
- def __init__(self) -> None:
- self.font: Optional[PDFFont] = None
- self.fontsize: float = 0
- self.charspace: float = 0
- self.wordspace: float = 0
- self.scaling: float = 100
- self.leading: float = 0
- self.render: int = 0
- self.rise: float = 0
- self.reset()
- # self.matrix is set
- # self.linematrix is set
- def __repr__(self) -> str:
- return (
- "<PDFTextState: font=%r, fontsize=%r, charspace=%r, "
- "wordspace=%r, scaling=%r, leading=%r, render=%r, rise=%r, "
- "matrix=%r, linematrix=%r>"
- % (
- self.font,
- self.fontsize,
- self.charspace,
- self.wordspace,
- self.scaling,
- self.leading,
- self.render,
- self.rise,
- self.matrix,
- self.linematrix,
- )
- )
- def copy(self) -> "PDFTextState":
- obj = PDFTextState()
- obj.font = self.font
- obj.fontsize = self.fontsize
- obj.charspace = self.charspace
- obj.wordspace = self.wordspace
- obj.scaling = self.scaling
- obj.leading = self.leading
- obj.render = self.render
- obj.rise = self.rise
- obj.matrix = self.matrix
- obj.linematrix = self.linematrix
- return obj
- def reset(self) -> None:
- self.matrix = MATRIX_IDENTITY
- self.linematrix = (0, 0)
- Color = Union[
- float, # Greyscale
- Tuple[float, float, float], # R, G, B
- Tuple[float, float, float, float], # C, M, Y, K
- ]
- class PDFGraphicState:
- def __init__(self) -> None:
- self.linewidth: float = 0
- self.linecap: Optional[object] = None
- self.linejoin: Optional[object] = None
- self.miterlimit: Optional[object] = None
- self.dash: Optional[Tuple[object, object]] = None
- self.intent: Optional[object] = None
- self.flatness: Optional[object] = None
- # stroking color
- self.scolor: Color = 0
- self.scs: PDFColorSpace = PREDEFINED_COLORSPACE["DeviceGray"]
- # non stroking color
- self.ncolor: Color = 0
- self.ncs: PDFColorSpace = PREDEFINED_COLORSPACE["DeviceGray"]
- def copy(self) -> "PDFGraphicState":
- obj = PDFGraphicState()
- obj.linewidth = self.linewidth
- obj.linecap = self.linecap
- obj.linejoin = self.linejoin
- obj.miterlimit = self.miterlimit
- obj.dash = self.dash
- obj.intent = self.intent
- obj.flatness = self.flatness
- obj.scolor = self.scolor
- obj.ncolor = self.ncolor
- return obj
- def __repr__(self) -> str:
- return (
- "<PDFGraphicState: linewidth=%r, linecap=%r, linejoin=%r, "
- " miterlimit=%r, dash=%r, intent=%r, flatness=%r, "
- " stroking color=%r, non stroking color=%r>"
- % (
- self.linewidth,
- self.linecap,
- self.linejoin,
- self.miterlimit,
- self.dash,
- self.intent,
- self.flatness,
- self.scolor,
- self.ncolor,
- )
- )
- class PDFResourceManager:
- """Repository of shared resources.
- ResourceManager facilitates reuse of shared resources
- such as fonts and images so that large objects are not
- allocated multiple times.
- """
- def __init__(self, caching: bool = True) -> None:
- self.caching = caching
- self._cached_fonts: Dict[object, PDFFont] = {}
- def get_procset(self, procs: Sequence[object]) -> None:
- for proc in procs:
- if proc is LITERAL_PDF or proc is LITERAL_TEXT:
- pass
- else:
- pass
- def get_cmap(self, cmapname: str, strict: bool = False) -> CMapBase:
- try:
- return CMapDB.get_cmap(cmapname)
- except CMapDB.CMapNotFound:
- if strict:
- raise
- return CMap()
- def get_font(self, objid: object, spec: Mapping[str, object]) -> PDFFont:
- if objid and objid in self._cached_fonts:
- font = self._cached_fonts[objid]
- else:
- log.debug("get_font: create: objid=%r, spec=%r", objid, spec)
- if settings.STRICT:
- if spec["Type"] is not LITERAL_FONT:
- raise PDFFontError("Type is not /Font")
- # Create a Font object.
- if "Subtype" in spec:
- subtype = literal_name(spec["Subtype"])
- else:
- if settings.STRICT:
- raise PDFFontError("Font Subtype is not specified.")
- subtype = "Type1"
- if subtype in ("Type1", "MMType1"):
- # Type1 Font
- font = PDFType1Font(self, spec)
- elif subtype == "TrueType":
- # TrueType Font
- font = PDFTrueTypeFont(self, spec)
- elif subtype == "Type3":
- # Type3 Font
- font = PDFType3Font(self, spec)
- elif subtype in ("CIDFontType0", "CIDFontType2"):
- # CID Font
- font = PDFCIDFont(self, spec)
- elif subtype == "Type0":
- # Type0 Font
- dfonts = list_value(spec["DescendantFonts"])
- assert dfonts
- subspec = dict_value(dfonts[0]).copy()
- for k in ("Encoding", "ToUnicode"):
- if k in spec:
- subspec[k] = resolve1(spec[k])
- font = self.get_font(None, subspec)
- else:
- if settings.STRICT:
- raise PDFFontError("Invalid Font spec: %r" % spec)
- font = PDFType1Font(self, spec) # this is so wrong!
- if objid and self.caching:
- self._cached_fonts[objid] = font
- return font
- class PDFContentParser(PSStackParser[Union[PSKeyword, PDFStream]]):
- def __init__(self, streams: Sequence[object]) -> None:
- self.streams = streams
- self.istream = 0
- # PSStackParser.__init__(fp=None) is safe only because we've overloaded
- # all the methods that would attempt to access self.fp without first
- # calling self.fillfp().
- PSStackParser.__init__(self, None) # type: ignore[arg-type]
- def fillfp(self) -> None:
- if not self.fp:
- if self.istream < len(self.streams):
- strm = stream_value(self.streams[self.istream])
- self.istream += 1
- else:
- raise PSEOF("Unexpected EOF, file truncated?")
- self.fp = BytesIO(strm.get_data())
- def seek(self, pos: int) -> None:
- self.fillfp()
- PSStackParser.seek(self, pos)
- def fillbuf(self) -> None:
- if self.charpos < len(self.buf):
- return
- while 1:
- self.fillfp()
- self.bufpos = self.fp.tell()
- self.buf = self.fp.read(self.BUFSIZ)
- if self.buf:
- break
- self.fp = None # type: ignore[assignment]
- self.charpos = 0
- def get_inline_data(self, pos: int, target: bytes = b"EI") -> Tuple[int, bytes]:
- self.seek(pos)
- i = 0
- data = b""
- while i <= len(target):
- self.fillbuf()
- if i:
- ci = self.buf[self.charpos]
- c = bytes((ci,))
- data += c
- self.charpos += 1
- if (
- len(target) <= i
- and c.isspace()
- or i < len(target)
- and c == (bytes((target[i],)))
- ):
- i += 1
- else:
- i = 0
- else:
- try:
- j = self.buf.index(target[0], self.charpos)
- data += self.buf[self.charpos : j + 1]
- self.charpos = j + 1
- i = 1
- except ValueError:
- data += self.buf[self.charpos :]
- self.charpos = len(self.buf)
- data = data[: -(len(target) + 1)] # strip the last part
- data = re.sub(rb"(\x0d\x0a|[\x0d\x0a])$", b"", data)
- return (pos, data)
- def flush(self) -> None:
- self.add_results(*self.popall())
- KEYWORD_BI = KWD(b"BI")
- KEYWORD_ID = KWD(b"ID")
- KEYWORD_EI = KWD(b"EI")
- def do_keyword(self, pos: int, token: PSKeyword) -> None:
- if token is self.KEYWORD_BI:
- # inline image within a content stream
- self.start_type(pos, "inline")
- elif token is self.KEYWORD_ID:
- try:
- (_, objs) = self.end_type("inline")
- if len(objs) % 2 != 0:
- error_msg = f"Invalid dictionary construct: {objs!r}"
- raise PSTypeError(error_msg)
- d = {literal_name(k): resolve1(v) for (k, v) in choplist(2, objs)}
- eos = b"EI"
- filter = d.get("F", None)
- if filter is not None:
- if isinstance(filter, PSLiteral):
- filter = [filter]
- if filter[0] in LITERALS_ASCII85_DECODE:
- eos = b"~>"
- (pos, data) = self.get_inline_data(pos + len(b"ID "), target=eos)
- if eos != b"EI": # it may be necessary for decoding
- data += eos
- obj = PDFStream(d, data)
- self.push((pos, obj))
- if eos == b"EI": # otherwise it is still in the stream
- self.push((pos, self.KEYWORD_EI))
- except PSTypeError:
- if settings.STRICT:
- raise
- else:
- self.push((pos, token))
- PDFStackT = PSStackType[PDFStream]
- """Types that may appear on the PDF argument stack."""
- class PDFPageInterpreter:
- """Processor for the content of a PDF page
- Reference: PDF Reference, Appendix A, Operator Summary
- """
- def __init__(self, rsrcmgr: PDFResourceManager, device: PDFDevice) -> None:
- self.rsrcmgr = rsrcmgr
- self.device = device
- def dup(self) -> "PDFPageInterpreter":
- return self.__class__(self.rsrcmgr, self.device)
- def init_resources(self, resources: Dict[object, object]) -> None:
- """Prepare the fonts and XObjects listed in the Resource attribute."""
- self.resources = resources
- self.fontmap: Dict[object, PDFFont] = {}
- self.xobjmap = {}
- self.csmap: Dict[str, PDFColorSpace] = PREDEFINED_COLORSPACE.copy()
- if not resources:
- return
- def get_colorspace(spec: object) -> Optional[PDFColorSpace]:
- if isinstance(spec, list):
- name = literal_name(spec[0])
- else:
- name = literal_name(spec)
- if name == "ICCBased" and isinstance(spec, list) and len(spec) >= 2:
- return PDFColorSpace(name, stream_value(spec[1])["N"])
- elif name == "DeviceN" and isinstance(spec, list) and len(spec) >= 2:
- return PDFColorSpace(name, len(list_value(spec[1])))
- else:
- return PREDEFINED_COLORSPACE.get(name)
- for k, v in dict_value(resources).items():
- log.debug("Resource: %r: %r", k, v)
- if k == "Font":
- for fontid, spec in dict_value(v).items():
- objid = None
- if isinstance(spec, PDFObjRef):
- objid = spec.objid
- spec = dict_value(spec)
- self.fontmap[fontid] = self.rsrcmgr.get_font(objid, spec)
- elif k == "ColorSpace":
- for csid, spec in dict_value(v).items():
- colorspace = get_colorspace(resolve1(spec))
- if colorspace is not None:
- self.csmap[csid] = colorspace
- elif k == "ProcSet":
- self.rsrcmgr.get_procset(list_value(v))
- elif k == "XObject":
- for xobjid, xobjstrm in dict_value(v).items():
- self.xobjmap[xobjid] = xobjstrm
- def init_state(self, ctm: Matrix) -> None:
- """Initialize the text and graphic states for rendering a page."""
- # gstack: stack for graphical states.
- self.gstack: List[Tuple[Matrix, PDFTextState, PDFGraphicState]] = []
- self.ctm = ctm
- self.device.set_ctm(self.ctm)
- self.textstate = PDFTextState()
- self.graphicstate = PDFGraphicState()
- self.curpath: List[PathSegment] = []
- # argstack: stack for command arguments.
- self.argstack: List[PDFStackT] = []
- def push(self, obj: PDFStackT) -> None:
- self.argstack.append(obj)
- def pop(self, n: int) -> List[PDFStackT]:
- if n == 0:
- return []
- x = self.argstack[-n:]
- self.argstack = self.argstack[:-n]
- return x
- def get_current_state(self) -> Tuple[Matrix, PDFTextState, PDFGraphicState]:
- return (self.ctm, self.textstate.copy(), self.graphicstate.copy())
- def set_current_state(
- self,
- state: Tuple[Matrix, PDFTextState, PDFGraphicState],
- ) -> None:
- (self.ctm, self.textstate, self.graphicstate) = state
- self.device.set_ctm(self.ctm)
- def do_q(self) -> None:
- """Save graphics state"""
- self.gstack.append(self.get_current_state())
- def do_Q(self) -> None:
- """Restore graphics state"""
- if self.gstack:
- self.set_current_state(self.gstack.pop())
- def do_cm(
- self,
- a1: PDFStackT,
- b1: PDFStackT,
- c1: PDFStackT,
- d1: PDFStackT,
- e1: PDFStackT,
- f1: PDFStackT,
- ) -> None:
- """Concatenate matrix to current transformation matrix"""
- matrix = safe_matrix(a1, b1, c1, d1, e1, f1)
- if matrix is None:
- log.warning(
- f"Cannot concatenate matrix to current transformation matrix because not all values in {(a1, b1, c1, d1, e1, f1)!r} can be parsed as floats"
- )
- else:
- self.ctm = mult_matrix(matrix, self.ctm)
- self.device.set_ctm(self.ctm)
- def do_w(self, linewidth: PDFStackT) -> None:
- """Set line width"""
- linewidth_f = safe_float(linewidth)
- if linewidth_f is None:
- log.warning(
- f"Cannot set line width because {linewidth!r} is an invalid float value"
- )
- else:
- self.graphicstate.linewidth = linewidth_f
- def do_J(self, linecap: PDFStackT) -> None:
- """Set line cap style"""
- self.graphicstate.linecap = linecap
- def do_j(self, linejoin: PDFStackT) -> None:
- """Set line join style"""
- self.graphicstate.linejoin = linejoin
- def do_M(self, miterlimit: PDFStackT) -> None:
- """Set miter limit"""
- self.graphicstate.miterlimit = miterlimit
- def do_d(self, dash: PDFStackT, phase: PDFStackT) -> None:
- """Set line dash pattern"""
- self.graphicstate.dash = (dash, phase)
- def do_ri(self, intent: PDFStackT) -> None:
- """Set color rendering intent"""
- self.graphicstate.intent = intent
- def do_i(self, flatness: PDFStackT) -> None:
- """Set flatness tolerance"""
- self.graphicstate.flatness = flatness
- def do_gs(self, name: PDFStackT) -> None:
- """Set parameters from graphics state parameter dictionary"""
- # TODO
- def do_m(self, x: PDFStackT, y: PDFStackT) -> None:
- """Begin new subpath"""
- x_f = safe_float(x)
- y_f = safe_float(y)
- if x_f is None or y_f is None:
- point = ("m", x, y)
- log.warning(
- f"Cannot start new subpath because not all values in {point!r} can be parsed as floats"
- )
- else:
- point = ("m", x_f, y_f)
- self.curpath.append(point)
- def do_l(self, x: PDFStackT, y: PDFStackT) -> None:
- """Append straight line segment to path"""
- x_f = safe_float(x)
- y_f = safe_float(y)
- if x_f is None or y_f is None:
- point = ("l", x, y)
- log.warning(
- f"Cannot append straight line segment to path because not all values in {point!r} can be parsed as floats"
- )
- else:
- point = ("l", x_f, y_f)
- self.curpath.append(point)
- def do_c(
- self,
- x1: PDFStackT,
- y1: PDFStackT,
- x2: PDFStackT,
- y2: PDFStackT,
- x3: PDFStackT,
- y3: PDFStackT,
- ) -> None:
- """Append curved segment to path (three control points)"""
- x1_f = safe_float(x1)
- y1_f = safe_float(y1)
- x2_f = safe_float(x2)
- y2_f = safe_float(y2)
- x3_f = safe_float(x3)
- y3_f = safe_float(y3)
- if (
- x1_f is None
- or y1_f is None
- or x2_f is None
- or y2_f is None
- or x3_f is None
- or y3_f is None
- ):
- point = ("c", x1, y1, x2, y2, x3, y3)
- log.warning(
- f"Cannot append curved segment to path because not all values in {point!r} can be parsed as floats"
- )
- else:
- point = ("c", x1_f, y1_f, x2_f, y2_f, x3_f, y3_f)
- self.curpath.append(point)
- def do_v(self, x2: PDFStackT, y2: PDFStackT, x3: PDFStackT, y3: PDFStackT) -> None:
- """Append curved segment to path (initial point replicated)"""
- x2_f = safe_float(x2)
- y2_f = safe_float(y2)
- x3_f = safe_float(x3)
- y3_f = safe_float(y3)
- if x2_f is None or y2_f is None or x3_f is None or y3_f is None:
- point = ("v", x2, y2, x3, y3)
- log.warning(
- f"Cannot append curved segment to path because not all values in {point!r} can be parsed as floats"
- )
- else:
- point = ("v", x2_f, y2_f, x3_f, y3_f)
- self.curpath.append(point)
- def do_y(self, x1: PDFStackT, y1: PDFStackT, x3: PDFStackT, y3: PDFStackT) -> None:
- """Append curved segment to path (final point replicated)"""
- x1_f = safe_float(x1)
- y1_f = safe_float(y1)
- x3_f = safe_float(x3)
- y3_f = safe_float(y3)
- if x1_f is None or y1_f is None or x3_f is None or y3_f is None:
- point = ("y", x1, y1, x3, y3)
- log.warning(
- f"Cannot append curved segment to path because not all values in {point!r} can be parsed as floats"
- )
- else:
- point = ("y", x1_f, y1_f, x3_f, y3_f)
- self.curpath.append(point)
- def do_h(self) -> None:
- """Close subpath"""
- self.curpath.append(("h",))
- def do_re(self, x: PDFStackT, y: PDFStackT, w: PDFStackT, h: PDFStackT) -> None:
- """Append rectangle to path"""
- x_f = safe_float(x)
- y_f = safe_float(y)
- w_f = safe_float(w)
- h_f = safe_float(h)
- if x_f is None or y_f is None or w_f is None or h_f is None:
- values = (x, y, w, h)
- log.warning(
- f"Cannot append rectangle to path because not all values in {values!r} can be parsed as floats"
- )
- else:
- self.curpath.append(("m", x_f, y_f))
- self.curpath.append(("l", x_f + w_f, y_f))
- self.curpath.append(("l", x_f + w_f, y_f + h_f))
- self.curpath.append(("l", x_f, y_f + h_f))
- self.curpath.append(("h",))
- def do_S(self) -> None:
- """Stroke path"""
- self.device.paint_path(self.graphicstate, True, False, False, self.curpath)
- self.curpath = []
- def do_s(self) -> None:
- """Close and stroke path"""
- self.do_h()
- self.do_S()
- def do_f(self) -> None:
- """Fill path using nonzero winding number rule"""
- self.device.paint_path(self.graphicstate, False, True, False, self.curpath)
- self.curpath = []
- def do_F(self) -> None:
- """Fill path using nonzero winding number rule (obsolete)"""
- def do_f_a(self) -> None:
- """Fill path using even-odd rule"""
- self.device.paint_path(self.graphicstate, False, True, True, self.curpath)
- self.curpath = []
- def do_B(self) -> None:
- """Fill and stroke path using nonzero winding number rule"""
- self.device.paint_path(self.graphicstate, True, True, False, self.curpath)
- self.curpath = []
- def do_B_a(self) -> None:
- """Fill and stroke path using even-odd rule"""
- self.device.paint_path(self.graphicstate, True, True, True, self.curpath)
- self.curpath = []
- def do_b(self) -> None:
- """Close, fill, and stroke path using nonzero winding number rule"""
- self.do_h()
- self.do_B()
- def do_b_a(self) -> None:
- """Close, fill, and stroke path using even-odd rule"""
- self.do_h()
- self.do_B_a()
- def do_n(self) -> None:
- """End path without filling or stroking"""
- self.curpath = []
- def do_W(self) -> None:
- """Set clipping path using nonzero winding number rule"""
- def do_W_a(self) -> None:
- """Set clipping path using even-odd rule"""
- def do_CS(self, name: PDFStackT) -> None:
- """Set color space for stroking operations
- Introduced in PDF 1.1
- """
- try:
- self.graphicstate.scs = self.csmap[literal_name(name)]
- except KeyError:
- if settings.STRICT:
- raise PDFInterpreterError("Undefined ColorSpace: %r" % name)
- def do_cs(self, name: PDFStackT) -> None:
- """Set color space for nonstroking operations"""
- try:
- self.graphicstate.ncs = self.csmap[literal_name(name)]
- except KeyError:
- if settings.STRICT:
- raise PDFInterpreterError("Undefined ColorSpace: %r" % name)
- def do_G(self, gray: PDFStackT) -> None:
- """Set gray level for stroking operations"""
- gray_f = safe_float(gray)
- if gray_f is None:
- log.warning(
- f"Cannot set gray level because {gray!r} is an invalid float value"
- )
- else:
- self.graphicstate.scolor = gray_f
- self.graphicstate.scs = self.csmap["DeviceGray"]
- def do_g(self, gray: PDFStackT) -> None:
- """Set gray level for nonstroking operations"""
- gray_f = safe_float(gray)
- if gray_f is None:
- log.warning(
- f"Cannot set gray level because {gray!r} is an invalid float value"
- )
- else:
- self.graphicstate.ncolor = gray_f
- self.graphicstate.ncs = self.csmap["DeviceGray"]
- def do_RG(self, r: PDFStackT, g: PDFStackT, b: PDFStackT) -> None:
- """Set RGB color for stroking operations"""
- rgb = safe_rgb(r, g, b)
- if rgb is None:
- log.warning(
- f"Cannot set RGB stroke color because not all values in {(r, g, b)!r} can be parsed as floats"
- )
- else:
- self.graphicstate.scolor = rgb
- self.graphicstate.scs = self.csmap["DeviceRGB"]
- def do_rg(self, r: PDFStackT, g: PDFStackT, b: PDFStackT) -> None:
- """Set RGB color for nonstroking operations"""
- rgb = safe_rgb(r, g, b)
- if rgb is None:
- log.warning(
- f"Cannot set RGB non-stroke color because not all values in {(r, g, b)!r} can be parsed as floats"
- )
- else:
- self.graphicstate.ncolor = rgb
- self.graphicstate.ncs = self.csmap["DeviceRGB"]
- def do_K(self, c: PDFStackT, m: PDFStackT, y: PDFStackT, k: PDFStackT) -> None:
- """Set CMYK color for stroking operations"""
- cmyk = safe_cmyk(c, m, y, k)
- if cmyk is None:
- log.warning(
- f"Cannot set CMYK stroke color because not all values in {(c, m, y, k)!r} can be parsed as floats"
- )
- else:
- self.graphicstate.scolor = cmyk
- self.graphicstate.scs = self.csmap["DeviceCMYK"]
- def do_k(self, c: PDFStackT, m: PDFStackT, y: PDFStackT, k: PDFStackT) -> None:
- """Set CMYK color for nonstroking operations"""
- cmyk = safe_cmyk(c, m, y, k)
- if cmyk is None:
- log.warning(
- f"Cannot set CMYK non-stroke color because not all values in {(c, m, y, k)!r} can be parsed as floats"
- )
- else:
- self.graphicstate.ncolor = cmyk
- self.graphicstate.ncs = self.csmap["DeviceCMYK"]
- def do_SCN(self) -> None:
- """Set color for stroking operations."""
- n = self.graphicstate.scs.ncomponents
- components = self.pop(n)
- if len(components) != n:
- log.warning(
- f"Cannot set stroke color because expected {n} components but got {components:!r}"
- )
- elif len(components) == 1:
- gray = components[0]
- gray_f = safe_float(gray)
- if gray_f is None:
- log.warning(
- f"Cannot set gray stroke color because {gray!r} is an invalid float value"
- )
- else:
- self.graphicstate.scolor = gray_f
- elif len(components) == 3:
- rgb = safe_rgb(*components)
- if rgb is None:
- log.warning(
- f"Cannot set RGB stroke color because components {components!r} cannot be parsed as RGB"
- )
- else:
- self.graphicstate.scolor = rgb
- elif len(components) == 4:
- cmyk = safe_cmyk(*components)
- if cmyk is None:
- log.warning(
- f"Cannot set CMYK stroke color because components {components!r} cannot be parsed as CMYK"
- )
- else:
- self.graphicstate.scolor = cmyk
- else:
- log.warning(
- f"Cannot set stroke color because {len(components)} components are specified but only 1 (grayscale), 3 (rgb) and 4 (cmyk) are supported"
- )
- def do_scn(self) -> None:
- """Set color for nonstroking operations"""
- n = self.graphicstate.ncs.ncomponents
- components = self.pop(n)
- if len(components) != n:
- log.warning(
- f"Cannot set non-stroke color because expected {n} components but got {components:!r}"
- )
- elif len(components) == 1:
- gray = components[0]
- gray_f = safe_float(gray)
- if gray_f is None:
- log.warning(
- f"Cannot set gray non-stroke color because {gray!r} is an invalid float value"
- )
- else:
- self.graphicstate.ncolor = gray_f
- elif len(components) == 3:
- rgb = safe_rgb(*components)
- if rgb is None:
- log.warning(
- f"Cannot set RGB non-stroke color because components {components!r} cannot be parsed as RGB"
- )
- else:
- self.graphicstate.ncolor = rgb
- elif len(components) == 4:
- cmyk = safe_cmyk(*components)
- if cmyk is None:
- log.warning(
- f"Cannot set CMYK non-stroke color because components {components!r} cannot be parsed as CMYK"
- )
- else:
- self.graphicstate.ncolor = cmyk
- else:
- log.warning(
- f"Cannot set non-stroke color because {len(components)} components are specified but only 1 (grayscale), 3 (rgb) and 4 (cmyk) are supported"
- )
- def do_SC(self) -> None:
- """Set color for stroking operations"""
- self.do_SCN()
- def do_sc(self) -> None:
- """Set color for nonstroking operations"""
- self.do_scn()
- def do_sh(self, name: object) -> None:
- """Paint area defined by shading pattern"""
- def do_BT(self) -> None:
- """Begin text object
- Initializing the text matrix, Tm, and the text line matrix, Tlm, to
- the identity matrix. Text objects cannot be nested; a second BT cannot
- appear before an ET.
- """
- self.textstate.reset()
- def do_ET(self) -> None:
- """End a text object"""
- def do_BX(self) -> None:
- """Begin compatibility section"""
- def do_EX(self) -> None:
- """End compatibility section"""
- def do_MP(self, tag: PDFStackT) -> None:
- """Define marked-content point"""
- if isinstance(tag, PSLiteral):
- self.device.do_tag(tag)
- else:
- log.warning(
- f"Cannot define marked-content point because {tag!r} is not a PSLiteral"
- )
- def do_DP(self, tag: PDFStackT, props: PDFStackT) -> None:
- """Define marked-content point with property list"""
- if isinstance(tag, PSLiteral):
- self.device.do_tag(tag, props)
- else:
- log.warning(
- f"Cannot define marked-content point with property list because {tag!r} is not a PSLiteral"
- )
- def do_BMC(self, tag: PDFStackT) -> None:
- """Begin marked-content sequence"""
- if isinstance(tag, PSLiteral):
- self.device.begin_tag(tag)
- else:
- log.warning(
- f"Cannot begin marked-content sequence because {tag!r} is not a PSLiteral"
- )
- def do_BDC(self, tag: PDFStackT, props: PDFStackT) -> None:
- """Begin marked-content sequence with property list"""
- if isinstance(tag, PSLiteral):
- self.device.begin_tag(tag, props)
- else:
- log.warning(
- f"Cannot begin marked-content sequence with property list because {tag!r} is not a PSLiteral"
- )
- def do_EMC(self) -> None:
- """End marked-content sequence"""
- self.device.end_tag()
- def do_Tc(self, space: PDFStackT) -> None:
- """Set character spacing.
- Character spacing is used by the Tj, TJ, and ' operators.
- :param space: a number expressed in unscaled text space units.
- """
- charspace = safe_float(space)
- if charspace is None:
- log.warning(
- f"Could not set character spacing because {space!r} is an invalid float value"
- )
- else:
- self.textstate.charspace = charspace
- def do_Tw(self, space: PDFStackT) -> None:
- """Set the word spacing.
- Word spacing is used by the Tj, TJ, and ' operators.
- :param space: a number expressed in unscaled text space units
- """
- wordspace = safe_float(space)
- if wordspace is None:
- log.warning(
- f"Could not set word spacing becuase {space!r} is an invalid float value"
- )
- else:
- self.textstate.wordspace = wordspace
- def do_Tz(self, scale: PDFStackT) -> None:
- """Set the horizontal scaling.
- :param scale: is a number specifying the percentage of the normal width
- """
- scale_f = safe_float(scale)
- if scale_f is None:
- log.warning(
- f"Could not set horizontal scaling because {scale!r} is an invalid float value"
- )
- else:
- self.textstate.scaling = scale_f
- def do_TL(self, leading: PDFStackT) -> None:
- """Set the text leading.
- Text leading is used only by the T*, ', and " operators.
- :param leading: a number expressed in unscaled text space units
- """
- leading_f = safe_float(leading)
- if leading_f is None:
- log.warning(
- f"Could not set text leading because {leading!r} is an invalid float value"
- )
- else:
- self.textstate.leading = -leading_f
- def do_Tf(self, fontid: PDFStackT, fontsize: PDFStackT) -> None:
- """Set the text font
- :param fontid: the name of a font resource in the Font subdictionary
- of the current resource dictionary
- :param fontsize: size is a number representing a scale factor.
- """
- try:
- self.textstate.font = self.fontmap[literal_name(fontid)]
- except KeyError:
- if settings.STRICT:
- raise PDFInterpreterError("Undefined Font id: %r" % fontid)
- self.textstate.font = self.rsrcmgr.get_font(None, {})
- fontsize_f = safe_float(fontsize)
- if fontsize_f is None:
- log.warning(
- f"Could not set text font because {fontsize!r} is an invalid float value"
- )
- else:
- self.textstate.fontsize = fontsize_f
- def do_Tr(self, render: PDFStackT) -> None:
- """Set the text rendering mode"""
- render_i = safe_int(render)
- if render_i is None:
- log.warning(
- f"Could not set text rendering mode because {render!r} is an invalid int value"
- )
- else:
- self.textstate.render = render_i
- def do_Ts(self, rise: PDFStackT) -> None:
- """Set the text rise
- :param rise: a number expressed in unscaled text space units
- """
- rise_f = safe_float(rise)
- if rise_f is None:
- log.warning(
- f"Could not set text rise because {rise!r} is an invalid float value"
- )
- else:
- self.textstate.rise = rise_f
- def do_Td(self, tx: PDFStackT, ty: PDFStackT) -> None:
- """Move to the start of the next line
- Offset from the start of the current line by (tx , ty).
- """
- tx_ = safe_float(tx)
- ty_ = safe_float(ty)
- if tx_ is not None and ty_ is not None:
- (a, b, c, d, e, f) = self.textstate.matrix
- e_new = tx_ * a + ty_ * c + e
- f_new = tx_ * b + ty_ * d + f
- self.textstate.matrix = (a, b, c, d, e_new, f_new)
- elif settings.STRICT:
- raise PDFValueError(f"Invalid offset ({tx!r}, {ty!r}) for Td")
- self.textstate.linematrix = (0, 0)
- def do_TD(self, tx: PDFStackT, ty: PDFStackT) -> None:
- """Move to the start of the next line.
- offset from the start of the current line by (tx , ty). As a side effect, this
- operator sets the leading parameter in the text state.
- """
- tx_ = safe_float(tx)
- ty_ = safe_float(ty)
- if tx_ is not None and ty_ is not None:
- (a, b, c, d, e, f) = self.textstate.matrix
- e_new = tx_ * a + ty_ * c + e
- f_new = tx_ * b + ty_ * d + f
- self.textstate.matrix = (a, b, c, d, e_new, f_new)
- elif settings.STRICT:
- raise PDFValueError("Invalid offset ({tx}, {ty}) for TD")
- if ty_ is not None:
- self.textstate.leading = ty_
- self.textstate.linematrix = (0, 0)
- def do_Tm(
- self,
- a: PDFStackT,
- b: PDFStackT,
- c: PDFStackT,
- d: PDFStackT,
- e: PDFStackT,
- f: PDFStackT,
- ) -> None:
- """Set text matrix and text line matrix"""
- values = (a, b, c, d, e, f)
- matrix = safe_matrix(*values)
- if matrix is None:
- log.warning(
- f"Could not set text matrix because not all values in {values!r} can be parsed as floats"
- )
- else:
- self.textstate.matrix = matrix
- self.textstate.linematrix = (0, 0)
- def do_T_a(self) -> None:
- """Move to start of next text line"""
- (a, b, c, d, e, f) = self.textstate.matrix
- self.textstate.matrix = (
- a,
- b,
- c,
- d,
- self.textstate.leading * c + e,
- self.textstate.leading * d + f,
- )
- self.textstate.linematrix = (0, 0)
- def do_TJ(self, seq: PDFStackT) -> None:
- """Show text, allowing individual glyph positioning"""
- if self.textstate.font is None:
- if settings.STRICT:
- raise PDFInterpreterError("No font specified!")
- return
- self.device.render_string(
- self.textstate,
- cast(PDFTextSeq, seq),
- self.graphicstate.ncs,
- self.graphicstate.copy(),
- )
- def do_Tj(self, s: PDFStackT) -> None:
- """Show text"""
- self.do_TJ([s])
- def do__q(self, s: PDFStackT) -> None:
- """Move to next line and show text
- The ' (single quote) operator.
- """
- self.do_T_a()
- self.do_TJ([s])
- def do__w(self, aw: PDFStackT, ac: PDFStackT, s: PDFStackT) -> None:
- """Set word and character spacing, move to next line, and show text
- The " (double quote) operator.
- """
- self.do_Tw(aw)
- self.do_Tc(ac)
- self.do_TJ([s])
- def do_BI(self) -> None:
- """Begin inline image object"""
- def do_ID(self) -> None:
- """Begin inline image data"""
- def do_EI(self, obj: PDFStackT) -> None:
- """End inline image object"""
- if isinstance(obj, PDFStream) and "W" in obj and "H" in obj:
- iobjid = str(id(obj))
- self.device.begin_figure(iobjid, (0, 0, 1, 1), MATRIX_IDENTITY)
- self.device.render_image(iobjid, obj)
- self.device.end_figure(iobjid)
- def do_Do(self, xobjid_arg: PDFStackT) -> None:
- """Invoke named XObject"""
- xobjid = literal_name(xobjid_arg)
- try:
- xobj = stream_value(self.xobjmap[xobjid])
- except KeyError:
- if settings.STRICT:
- raise PDFInterpreterError("Undefined xobject id: %r" % xobjid)
- return
- log.debug("Processing xobj: %r", xobj)
- subtype = xobj.get("Subtype")
- if subtype is LITERAL_FORM and "BBox" in xobj:
- interpreter = self.dup()
- bbox = cast(Rect, list_value(xobj["BBox"]))
- matrix = cast(Matrix, list_value(xobj.get("Matrix", MATRIX_IDENTITY)))
- # According to PDF reference 1.7 section 4.9.1, XObjects in
- # earlier PDFs (prior to v1.2) use the page's Resources entry
- # instead of having their own Resources entry.
- xobjres = xobj.get("Resources")
- if xobjres:
- resources = dict_value(xobjres)
- else:
- resources = self.resources.copy()
- self.device.begin_figure(xobjid, bbox, matrix)
- interpreter.render_contents(
- resources,
- [xobj],
- ctm=mult_matrix(matrix, self.ctm),
- )
- self.device.end_figure(xobjid)
- elif subtype is LITERAL_IMAGE and "Width" in xobj and "Height" in xobj:
- self.device.begin_figure(xobjid, (0, 0, 1, 1), MATRIX_IDENTITY)
- self.device.render_image(xobjid, xobj)
- self.device.end_figure(xobjid)
- else:
- # unsupported xobject type.
- pass
- def process_page(self, page: PDFPage) -> None:
- log.debug("Processing page: %r", page)
- (x0, y0, x1, y1) = page.mediabox
- if page.rotate == 90:
- ctm = (0, -1, 1, 0, -y0, x1)
- elif page.rotate == 180:
- ctm = (-1, 0, 0, -1, x1, y1)
- elif page.rotate == 270:
- ctm = (0, 1, -1, 0, y1, -x0)
- else:
- ctm = (1, 0, 0, 1, -x0, -y0)
- self.device.begin_page(page, ctm)
- self.render_contents(page.resources, page.contents, ctm=ctm)
- self.device.end_page(page)
- def render_contents(
- self,
- resources: Dict[object, object],
- streams: Sequence[object],
- ctm: Matrix = MATRIX_IDENTITY,
- ) -> None:
- """Render the content streams.
- This method may be called recursively.
- """
- log.debug(
- "render_contents: resources=%r, streams=%r, ctm=%r",
- resources,
- streams,
- ctm,
- )
- self.init_resources(resources)
- self.init_state(ctm)
- self.execute(list_value(streams))
- def execute(self, streams: Sequence[object]) -> None:
- try:
- parser = PDFContentParser(streams)
- except PSEOF:
- # empty page
- return
- while True:
- try:
- (_, obj) = parser.nextobject()
- except PSEOF:
- break
- if isinstance(obj, PSKeyword):
- name = keyword_name(obj)
- method = "do_%s" % name.replace("*", "_a").replace('"', "_w").replace(
- "'",
- "_q",
- )
- if hasattr(self, method):
- func = getattr(self, method)
- nargs = func.__code__.co_argcount - 1
- if nargs:
- args = self.pop(nargs)
- log.debug("exec: %s %r", name, args)
- if len(args) == nargs:
- func(*args)
- else:
- log.debug("exec: %s", name)
- func()
- elif settings.STRICT:
- error_msg = "Unknown operator: %r" % name
- raise PDFInterpreterError(error_msg)
- else:
- self.push(obj)
|