o e: @sdZddlmZddlmZddlmZddlmZm Z m Z ddl m Z m Z mZmZmZmZmZGdddeZejd ejd ejd ejd ejd ejd iZeeeZ d'd d d d d dd(ddZ d'd)dd Z Gd!d"d"e!Z"Gd#d$d$Z#Gd%d&d&Z$d S)*z7Support for document outlines (e.g. table of contents).) annotations)Enum)chain)IterableListcast)Array DictionaryNameObjectPagePdfStringc@s0eZdZdZdZdZdZdZdZdZ dZ d Z d S) PageLocationz.Page view location definitions, from PDF spec.N) __name__ __module__ __qualname____doc__XYZFitFitHFitVFitRZFitBFitBHFitBVr#r#GD:\Projects\ConvertPro\env\Lib\site-packages\pikepdf/models/outlines.pyrsr)lefttopzoom)r&)r%)r%bottomrightr&Nr%r&r)r(r'pdfr page_numint page_locationPageLocation | str | Noner% float | Noner&r)r(r'returnrc Cst||||||||dS)az Create a destination ``Array`` with reference to a Pdf document's page number. Arguments: pdf: PDF document object. page_num: Page number (zero-based). page_location: Optional page location, as a string or :enum:`PageLocation`. left: Specify page viewport rectangle. top: Specify page viewport rectangle. right: Specify page viewport rectangle. bottom: Specify page viewport rectangle. zoom: Specify page viewport rectangle's zoom level. left, top, right, bottom, zoom are used in conjunction with the page fit style specified by *page_location*. )r.r%r&r)r(r')_make_page_destination)r+r,r.r%r&r)r(r'r#r#r$make_page_destination(sr3c sddD|j|jg}|rVt|tr|}|j}n|}zt|}Wnty4td|dw|t d|t |}|rR| fdd|Dt|S|t j t|S)NcSi|] \}}|dur||qSNr#.0kvr#r#r$ Uz*_make_page_destination..z*Invalid or unsupported page location type /c3s|] }|dVqdS)rN)get)r7r8kwargsr#r$ gsz)_make_page_destination..)itemsZpagesobj isinstancernameKeyError ValueErrorappendr PAGE_LOCATION_ARGSr=extendrr)r+r,r.r?resZloc_keyZloc_strZdest_arg_namesr#r>r$r2Os.     r2c@seZdZdZdS)OutlineStructureErrorz1Indicates an error in the outline data structure.N)rrrrr#r#r#r$rKmsrKc@s\eZdZdZ    d$ddddddd%ddZddZddZed&ddZd'd(d"d#Z dS)) OutlineItemaManage a single item in a PDF document outlines structure. Includes nested items. Arguments: title: Title of the outlines item. destination: Page number, destination name, or any other PDF object to be used as a reference when clicking on the outlines entry. Note this should be ``None`` if an action is used instead. If set to a page number, it will be resolved to a reference at the time of writing the outlines back to the document. page_location: Supplemental page location for a page number in ``destination``, e.g. ``PageLocation.Fit``. May also be a simple string such as ``'FitH'``. action: Action to perform when clicking on this item. Will be ignored during writing if ``destination`` is also set. obj: ``Dictionary`` object representing this outlines item in a ``Pdf``. May be ``None`` for creating a new object. If present, an existing object is modified in-place during writing and original attributes are retained. left, top, bottom, right, zoom: Describes the viewport position associated with a destination. This object does not contain any information about higher-level or neighboring elements. Valid destination arrays: [page /XYZ left top zoom] generally [page, PageLocationEntry, 0 to 4 ints] Nr*titlestr destination"Array | String | Name | int | Noner.r/actionDictionary | NonerBr%r0r&r)r(r'c Csv||_||_||_i|_||_|jdur|jdurtd||_t|||| | d} dd| D|_d|_ g|_ dS)Nz-Only one of destination and action may be setr*cSr4r5r#r6r#r#r$r:r;z(OutlineItem.__init__..F) rMrOr.page_location_kwargsrQrFrBdictrA is_closedchildren) selfrMrOr.rQrBr%r&r)r(r'r?r#r#r$__init__s zOutlineItem.__init__cCs|jr |jr d}nd}nd}|jdurPt|jtr&|jd}t|}|j}n,t|jtr4d|jd}nt|jtrBd|jd}nt|jt rOd|jd}nd }|d |j d |S) Nz[+]z[-]z[ ]rz7z7 z -> ) rVrUrOrCrr labelrr r-rM)rWZ oc_indicatorZraw_pagepagedestr#r#r$__str__s&      zOutlineItem.__str__cCsd|jjd|jdS)N ) __class__rrMrWr#r#r$__repr__szOutlineItem.__repr__r cCsxt|j}|tj}|durt|tttfstd||tj }|dur4t|t s4td||||||dS)zCreates a ``OutlineItem`` from a ``Dictionary``. Does not process nested items. Arguments: obj: ``Dictionary`` object representing a single outline node. Nz+Unexpected object type in Outline's /Dest: z(Unexpected object type in Outline's /A: )rOrQrB) rNTitler=r DestrCrrrKAr )clsrBrMrOrQr#r#r$from_dictionary_objects    z"OutlineItem.from_dictionary_objectFr+r create_newboolr1cCs|s|jdur|t|_}n|j}|j|_|jdur>t|jtr1t||j|j fi|j |_|j|_ t j |vr<|` |S|jdurN|j|_ t j |vrN|` |S)a^Creates/updates a ``Dictionary`` object from this outline node. Page numbers are resolved to a page reference on the input ``Pdf`` object. Arguments: pdf: PDF document object. create_new: If set to ``True``, creates a new object instead of modifying an existing one in-place. N)rB make_indirectr rMrcrOrCr-r3r.rSrdr rerQ)rWr+rhrBr#r#r$to_dictionary_objects,      z OutlineItem.to_dictionary_object)NNNN)rMrNrOrPr.r/rQrRrBrRr%r0r&r0r)r0r(r0r'r0)rBr )F)r+r rhrir1r ) rrrrrXr^rb classmethodrgrkr#r#r#r$rLqs$# rLc@sneZdZdZd*d+d d Zd d ZddZddZddZd,ddZ d-dd Z d!d"Z d#d$Z e d.d'd(Zd)S)/OutlineaEMaintains a intuitive interface for creating and editing PDF document outlines. See |pdfrm| section 12.3. Arguments: pdf: PDF document object. max_depth: Maximum recursion depth to consider when reading the outline. strict: If set to ``False`` (default) silently ignores structural errors. Setting it to ``True`` raises a :class:`pikepdf.OutlineStructureError` if any object references re-occur while the outline is being read or written. See Also: :meth:`pikepdf.Pdf.open_outline` Fr+r max_depthr-strictricCs"d|_||_||_||_d|_dSNF)_root_pdf _max_depth_strict _updating)rWr+rorpr#r#r$rXs  zOutline.__init__cCs t|jSr5)rNrootrar#r#r$r^ s zOutline.__str__cCsd|jjdt|jdS)Nr_z: z items>)r`rlenrwrar#r#r$rb#szOutline.__repr__cCs d|_|S)NT)rvrar#r#r$ __enter__&szOutline.__enter__cCs2z|dur Wd|_dS|Wd|_dSd|_wrq)rv_save)rWexc_typeexc_valexc_tbr#r#r$__exit__*s   zOutline.__exit__parentr outline_itemsIterable[OutlineItem]level visited_objsset[tuple[int, int]]c CsHd}d}d}|D]n}||j} | j} | |vr+|jr"td| d|j|jdd} n|| || _|d7}|durB| |_|| _n | }t j| vrK| `| }||j krV|j } nd} | | | |d||j rntt| j | _q|tt| j7}q|r|dur|dusJt j|vr|`||_||_nt j|vr|`t j|vr|`||_dS)NrOutline object  reoccurred in structureT)rhrr#)rkrsobjgenrurKaddZParentNextZPrevr rtrV_save_level_outlinerUrr-CountFirstZLast) rWrrrrcountprevfirstitemZout_objrZ sub_itemsr#r#r$r2sP         zOutline._save_level_outline first_obj list[Object]c Cs|}|rr|j}||vr|jrtd|ddS||t|}|tj}t |t rO||j krO| ||j |d||tj} t | trO| dkrOd|_|||tj} | dusct | t rf| }ntd|d|sdSdS)NrrrrTz points to non-dictionary)rrurKrrLrgr=r rrCr rt_load_level_outlinerVrr-rUrGr) rWrrrrZ current_objrrZ first_childrZnext_objr#r#r$rhs6         zOutline._load_level_outlinecCs^|jdurdStj|jjvr|jjj}n|jttjd|jj_}|||jdtdS)N)Typer) rrr OutlinesrsRootrjr rset)rWoutlinesr#r#r$rzs   z Outline._savecCsTg|_}tj|jjvrdS|jjjpi}|tj}|r(|||dtdSdS)Nr) rrr rrsrr=rrr)rWrwrrr#r#r$_loads  z Outline._loadr1list[OutlineItem]cCs"|jdur |ttt|jS)z$Return the root node of the outline.N)rrrrrrLrar#r#r$rws z Outline.rootN)rnF)r+r ror-rpri)rr rrrr-rr)rr rrrr-rr)r1r)rrrrrXr^rbryr~rrrzrpropertyrwr#r#r#r$rms   6$  rmr5)r+r r,r-r.r/r%r0r&r0r)r0r(r0r'r0r1r)r+r r,r-r.r/r1r)%r __future__renumr itertoolsrtypingrrrZpikepdfrr r r r r rrrrrr r!r"rHr from_iterablevaluesZALL_PAGE_LOCATION_KWARGSr3r2 ExceptionrKrLrmr#r#r#r$s:   $*