U :vh0@sdZddlZddlZddlmZddlmZddlmZddl m Z m Z ddZ d,ddZ ddZ ddZd-ddZGdddeZGdddeZGdddZGdddeZd.ddZd d!ZGd"d#d#eZGd$d%d%ZGd&d'd'eZGd(d)d)eZGd*d+d+eZdS)/a Classes & functions that represent core elements of the PDF syntax Most of what happens in a PDF happens in objects, which are formatted like so: ``` 3 0 obj <> endobj ``` The first line says that this is the third object in the structure of the document. There are 8 kinds of objects (Adobe Reference, 51): * Boolean values * Integer and real numbers * Strings * Names * Arrays * Dictionaries * Streams * The null object The `<<` in the second line and the `>>` in the line preceding `endobj` denote that it is a dictionary object. Dictionaries map Names to other objects. Names are the strings preceded by `/`, valid Names do not have to start with a capital letter, they can be any ascii characters, # and two characters can escape non-printable ascii characters, described on page 57. `3 0 obj` means what follows here is the third object, but the name Type (represented here by `/Type`) is mapped to an indirect object reference: `0 obj` vs `0 R`. The structure of this data, in python/dict form, is thus: ``` third_obj = { '/Type': '/Page'), '/Parent': iobj_ref(1), '/Resources': iobj_ref(2), '/Contents': iobj_ref(4), } ``` Content streams are of the form: ``` 4 0 obj <> stream 68656c6c6f20776f726c64 endstream endobj ``` The contents of this module are internal to fpdf2, and not part of the public API. They may change at any time without prior warning or any deprecation period, in non-backward-compatible ways. N)ABC)hexlify) BOM_UTF16_BE)datetimetimezonecCsdd|DS)NcSsi|]\}}|r||qSr.0kvrr//tmp/pip-unpacked-wheel-dvf6lv8i/fpdf/syntax.py Gsz&clear_empty_fields..)items)drrr clear_empty_fieldsFsr<<>>  Fcs4|r t|}d||fdd|D|gS)a{format dictionary as PDF dictionary @param dict_: dictionary of values to render @param open_dict: string to open PDF dictionary @param close_dict: string to close PDF dictionary @param field_join: string to join fields with @param key_value_join: string to join key to value with @param has_empty_fields: whether or not to clear_empty_fields first. c3s$|]\}}|t|fVqdSN)joinstrrkey_value_joinrr asz+create_dictionary_string..)rrr)Zdict_ open_dict close_dictZ field_joinrZhas_empty_fieldsrrr create_dictionary_stringJsrcCsdd|dS)z#format list of strings as PDF array[r])r)list_rrr create_list_stringgsr"cCs |dS)z:format an indirect PDF Object reference from its id numberz 0 Rr)nrrr iobj_reflsr$cCs8t|ttfrt|d}|r(|||dd|dgS)Nlatin-1rstreamZ endstream) isinstance bytearraybytesrencryptr)r&Zencryption_handlerZobj_idrrr create_streamqs   r+c@seZdZdZdS)RawzVstr subclass signifying raw data to be directly emitted to PDF without transformation.N)__name__ __module__ __qualname____doc__rrrr r,ysr,c@sFeZdZdZededdeddDdZd e d d d Z dS) NamezVstr subclass signifying a PDF name, which are emitted differently than normal strings.s[^ccs|]}|dkr|VqdS)s ()<>[]{}/%#\Nr)r r rrr rszName.!]N)returncCs$|jdd|}d|S)NcSsd|ddS)Ns#%02Xrr)mrrr z Name.serialize../)NAME_ESCsubencodedecode)self_security_handler_obj_idescapedrrr serializes zName.serialize)NN) r-r.r/r0recompiler)ranger:rrBrrrr r1}s r1c@sVeZdZddZeddZejddZeddZdd d Zd d Z dd dZ dS) PDFObjectcCs d|_dSr_idr>rrr __init__szPDFObject.__init__cCs"|jdkrt|jjd|jS)Nz has not been assigned an ID yet)rHAttributeError __class__r-rIrrr ids   z PDFObject.idcCs ||_dSrrG)r>r#rrr rMscCs t|jSr)r$rMrIrrr refsz PDFObject.refNcCszg}||jd|d|s.||}|t|ddd|d|}|rf|t||dd|S)z8Serialize the PDF object as an obj<>endobj text blockz 0 objrr)rrrZendobjr)appendrM_build_obj_dictrcontent_streamr+r)r>obj_dictr?outputrQrrr rBs    zPDFObject.serializecCsdS)zPSubclasses can override this method to indicate the presence of a content streamr8rrIrrr rQszPDFObject.content_streamcs"tfddtD|jdS)z Build the PDF Object associative map to serialize, based on this class instance properties. The property names are converted from snake_case to CamelCase, and prefixed with a slash character "/". csi|]}|t|qSr)getattr)r keyrIrr r sz-PDFObject._build_obj_dict..r?r@)build_obj_dictdirrM)r>Zsecurity_handlerrrIr rPs zPDFObject._build_obj_dict)NN)N) r-r.r/rJpropertyrMsetterrNrBrQrPrrrr rFs    rFcs8eZdZdZd fdd ZddZd fdd ZZS) PDFContentStreamFcsFt|rtj||jdn||_|r0tdnd|_t|j|_ dS)N)levelZ FlateDecode) superrJzlibcompress_COMPRESSION_LEVEL _contentsr1filterlenlength)r>contentsr`rLrr rJs zPDFContentStream.__init__cCs|jSr)rbrIrrr rQszPDFContentStream.content_streamNcsV|rH|r tt|jttfs*|jd|_||j|j|_t|j|_ t ||S)Nr%) AssertionErrorr'rbr(r)r<r*rMrdrer^rB)r>rRr?rgrr rBs zPDFContentStream.serialize)F)NN)r-r.r/rarJrQrB __classcell__rrrgr r[s r[cCsi}|D]\}}t|s |ds |dks |dkr8q t|drH|j}t|trZ|j}n0t|drt|j||d}nt|t rt | }||dt |<q |S)z Build the PDF Object associative map to serialize, based on a key-values dict. The property names are converted from snake_case to CamelCase, and prefixed with a slash character "/". _)rMrNNvaluerBrVr9) rcallable startswithhasattrrkr'rFrNrBboolrlower camel_case) key_valuesr?r@rRrUrkrrr rWs0     rWcCsddd|DS)Nrcss|]}|dkr|VqdS)rjNr)r xrrr rszcamel_case..)rtitle)Z snake_caserrr rqsrqcs,eZdZdZdfdd Zd ddZZS) PDFStringTFcst||}||_|S)z Args: content (str): text encrypt (bool): if document encryption is enabled, should this string be encrypted? )r^__new__r*)clscontentr*r>rgrr rv szPDFString.__new__NcCs|r|jr|st|||Sz|dd|dWStk rJYnX|jrvtt|dd}d|dSd|dddS) Nascii()z utf-16-ber%<>zUTF-16) r*rhencrypt_stringr<UnicodeEncodeErrorUSE_HEX_ENCODINGrrr=)r>r?r@hex_strrrr rBs    zPDFString.serialize)F)NN)r-r.r/rrvrBrirrrgr rus ruc@s.eZdZd edddZddZd dd ZdS) PDFDateF)datecCs||_||_||_dS)z Args: date (datetime): self-explanatory with_tz (bool): should the timezone be encoded in included in the date? encrypt (bool): if document encryption is enabled, should this string be encrypted? Nrwith_tzr*)r>rrr*rrr rJ)szPDFDate.__init__cCsd|jd|jd|jdS)NzPDFDate(z , with_tz=z , encrypt=r{rrIrrr __repr__4szPDFDate.__repr__NcCs|jr`|jjst|jjtjkr0d|jd}qnd|jd}|ddd|ddd}nd|jd}|r|jr|st|||Sd|dS) NzD:z %Y%m%d%H%M%SZz%Y%m%d%H%M%S%z'z %Y%m%d%H%M%Srzr{)rrtzinforhrutcr*r~)r>r?r@Zout_strrrr rB7s "  zPDFDate.serialize)FF)NN)r-r.r/rrJrrBrrrr r(s rc@seZdZdddZdS)PDFArrayNcsltdd|Drd|}nBtdd|DrFddd|D}ndfdd|D}d|d S) Ncss|]}t|tVqdSr)r'rr elemrrr rIsz%PDFArray.serialize..rcss|]}t|ttfVqdSr)r'intfloatrrrr rKscss|]}t|VqdSr)rrrrr rLsrc3s,|]$}t|tr|jn |jdVqdS)rVN)r'rFrNrBrr@r?rr rNsrr )allr)r>r?r@Zserialized_elemsrrr rBHs  zPDFArray.serialize)NNr-r.r/rBrrrr rGsrc@seZdZdddZdS) DestinationNcCstdSr)NotImplementedError)r>r?r@rrr rB]szDestination.serialize)NNrrrrr r\src@sBeZdZdddZddZddZd d Zdd d ZdddZd S)DestinationXYZrnullcCs"||_||_||_||_d|_dSr page_numbertopleftzoompage_refr>pagerrrrrr rJbs zDestinationXYZ.__init__cCs0|j|jko.|j|jko.|j|jko.|j|jkSr)rrrr)r>destrrr __eq__is    zDestinationXYZ.__eq__cCst|j|j|j|jfSr)hashrrrrrIrrr __hash__qszDestinationXYZ.__hash__c Cs.d|jd|jd|jd|jd|jd S)NzDestinationXYZ(page_number=z, top=z, left=z, zoom="z ", page_ref=r{rrIrrr rtszDestinationXYZ.__repr__Nc Csht|jtrt|jdn|j}t|jtr6t|jdn|j}|jsFtd|jd|d|d|jd S)Nrz /XYZ rr )r'rrroundrrrhr)r>r?r@rrrrr rBws zDestinationXYZ.serializecCsV|jrtdt|dkr|jn||dkr.|jn||dkr>|jn||dkrN|jn|dS)Nz7DestinationXYZ should not be copied after serialization)rrrr)rrhrrrrrrrrr replace}szDestinationXYZ.replace)rr)NN)NNNN) r-r.r/rJrrrrBrrrrr ras   r)rrrrF)NN)NN)r0rCr_abcrbinasciircodecsrrrrrr"r$r+rr,r1rFr[rWrqrurlistrrrrrrr s4>     ; "