File: //lib/python3/dist-packages/sphinx/builders/latex/__pycache__/transforms.cpython-310.pyc
o
�$�a�P � @ s� d Z ddlmZmZmZmZmZmZ ddlm Z ddl
m Z m Z ddl
mZ ddlmZ ddlmZ ddlmZmZmZmZmZ dd lmZ dd
lm Z dd l m Z dd l m Z d
Z!G dd� de �Z"G dd� de �Z#G dd� de �Z$G dd� de j%�Z&G dd� de �Z'G dd� de j%�Z(G dd� de �Z)G d d � d e �Z*G d d � d e �Z+G d d!� d!e �Z,G d"d#� d#e �Z-G d$d%� d%e �Z.d&ed'ee/ef fd(d)�Z0d*S )+z�
sphinx.builders.latex.transforms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Transforms for LaTeX builder.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� )�Any�Dict�List�Set�Tuple�cast)�nodes)�Element�Node)�
Substitutions)�addnodes)�Sphinx)�captioned_literal_block� footnotemark� footnotetext�math_reference�thebibliography)�CitationDomain)�SphinxTransform)�SphinxPostTransform)� NodeMatcher)�mailto:zhttp:zhttps:zftp:c @ s2 e Zd ZdZdZejejfZde ddfdd�Z
dS )�FootnoteDocnameUpdaterz5Add docname to footnote and footnote_reference nodes.i� �kwargs�returnNc K s, t | j� }| j�|�D ]}| jj|d< q d S )N�docname)r � TARGET_NODES�document�traverse�envr )�selfr �matcher�node� r# �B/usr/lib/python3/dist-packages/sphinx/builders/latex/transforms.py�apply" s
�z FootnoteDocnameUpdater.apply) �__name__�
__module__� __qualname__�__doc__�default_priorityr �footnote�footnote_referencer r r% r# r# r# r$ r s
r c @ s0 e Zd ZdZejd ZdZdeddfdd�ZdS ) � SubstitutionDefinitionsRemoverz4Remove ``substitution_definition node from doctrees.� ��latexr r Nc K s( t | j�tj��D ]}|j�|� q d S �N)�listr r r �substitution_definition�parent�remove)r r r" r# r# r$ �run/ s �z"SubstitutionDefinitionsRemover.run) r& r' r( r) r r* �formatsr r6 r# r# r# r$ r- ( s
r- c @ sv e Zd ZdZdZdZdZdeddfdd �Zdd
d �Z d e
de fd
d�Z de de de
ejejf fdd�Zddd�ZdS )�ShowUrlsTransformz�Expand references to inline text or footnotes.
For more information, see :confval:`latex_show_urls`.
.. note:: This transform is used for integrated doctree
� r/ Fr r Nc K sL z!| j j}|j}d|_| �� | jr | �� W ||_d S W ||_d S ||_w )N� show_urls)r �settings� id_prefix�expand_show_urls�expanded�renumber_footnotes)r r r; r< r# r# r$ r6 A s
�zShowUrlsTransform.runc C s� | j j}|du s |dkrd S t| j�tj��D ][}|�dd�}|�t �rr|�d�r/|dd � }|�
� |krr|j � |�}| �
|�}|dkrb| �||�\}}|j �|d |� |j �|d |� d
| _qt�d | �}|j �|d |� qd S ) NF�no�refuri� r � r+ r. � Tz (%s))�config�latex_show_urlsr2 r r r � reference�get�
startswith� URI_SCHEMES�astextr4 �index�get_docname_for_node�create_footnote�insertr> �Text) r r: r" �urirL r �fn�fnref�textnoder# r# r$ r= O s(
��z"ShowUrlsTransform.expand_show_urlsr" c C sB |r t |tj�r| j�|d �S t |tj�r|d S |j}|sd S )N�sourcer )�
isinstancer r r �path2docr �
start_of_filer4 �r r" r# r# r$ rM f s �z&ShowUrlsTransform.get_docname_for_noderQ r c C s� t jdt �|�|dd�}t j|d|d�}|d �d� |t �dd�7 }|t �dd|�7 }| j�|� t j dd|d d
|d �}|t �d�7 }| j�
|� |� |d d
� ||fS ) NrB T)rA � nolinkurlr. )�autor �names�#z[#]_�idsr )r[ �refidr ) r rG rP r+ �append�label� paragraphr �note_autofootnoter, �note_autofootnote_ref� add_backref)r rQ r rG r+ � footnote_refr# r# r$ rN q s � z!ShowUrlsTransform.create_footnotec C s� t | j�}| j�|� d}|jD ]e} |d7 }t|�|jvr nqttj|d �}|� t�dt|��� ||d v rB|d �
|� � � |d � t|�� |d }|j
D ]"}||d krt|d d |d krt|�
|d � |t�t|��7 }qRqd S ) Nr Tr. rB r\ r r^ r_ )�FootnoteCollectorr � walkabout�auto_footnotes�str�used_footnote_numbersr r ra � replace_selfr5 rK r` �
footnote_refsrP )r � collector�numr+ � old_labelr �refr# r# r$ r? � s,
�
���z$ShowUrlsTransform.renumber_footnotes)r N)r& r' r( r) r* r7 r> r r6 r= r
rj rM r r r+ r, rN r? r# r# r# r$ r8 4 s
" r8 c sx e Zd ZdZdejddf� fdd� Zdeddfdd �Zdeddfd
d �Z dej
ddfd d
�Z dej ddfdd�Z
� ZS )rg z9Collect footnotes and footnote references on the documentr r Nc s$ g | _ t� | _g | _t� �|� d S r1 )ri �setrk rm �super�__init__)r r �� __class__r# r$ rt � s zFootnoteCollector.__init__r" c C � d S r1 r# rY r# r# r$ �
unknown_visit� � z FootnoteCollector.unknown_visitc C rw r1 r# rY r# r# r$ �unknown_departure� ry z#FootnoteCollector.unknown_departurec C s8 |� d�r
| j�|� d S |d D ]}| j�|� qd S )Nr[ r\ )rH ri r` rk �add)r r" �namer# r# r$ �visit_footnote� s
�z FootnoteCollector.visit_footnotec C s | j �|� d S r1 )rm r` rY r# r# r$ �visit_footnote_reference� s z*FootnoteCollector.visit_footnote_reference)r& r' r( r) r r rt r
rx rz r+ r} r, r~ �
__classcell__r# r# ru r$ rg � s rg c @ �* e Zd ZdZdZdZdeddfdd�ZdS ) �LaTeXFootnoteTransformaT Convert footnote definitions and references to appropriate form to LaTeX.
* Replace footnotes on restricted zone (e.g. headings) by footnotemark node.
In addition, append a footnotetext node after the zone.
Before::
<section>
<title>
headings having footnotes
<footnote_reference>
1
<footnote ids="id1">
<label>
1
<paragraph>
footnote body
After::
<section>
<title>
headings having footnotes
<footnotemark refid="id1">
1
<footnotetext ids="id1">
<label>
1
<paragraph>
footnote body
* Integrate footnote definitions and footnote references to single footnote node
Before::
blah blah blah
<footnote_reference refid="id1">
1
blah blah blah ...
<footnote ids="id1">
<label>
1
<paragraph>
footnote body
After::
blah blah blah
<footnote ids="id1">
<label>
1
<paragraph>
footnote body
blah blah blah ...
* Replace second and subsequent footnote references which refers same footnote definition
by footnotemark node.
Before::
blah blah blah
<footnote_reference refid="id1">
1
blah blah blah
<footnote_reference refid="id1">
1
blah blah blah ...
<footnote ids="id1">
<label>
1
<paragraph>
footnote body
After::
blah blah blah
<footnote ids="id1">
<label>
1
<paragraph>
footnote body
blah blah blah
<footnotemark refid="id1">
1
blah blah blah ...
* Remove unreferenced footnotes
Before::
<footnote ids="id1">
<label>
1
<paragraph>
Unreferenced footnote!
After::
<!-- nothing! -->
* Move footnotes in a title of table or thead to head of tbody
Before::
<table>
<title>
title having footnote_reference
<footnote_reference refid="id1">
1
<tgroup>
<thead>
<row>
<entry>
header having footnote_reference
<footnote_reference refid="id2">
2
<tbody>
<row>
...
<footnote ids="id1">
<label>
1
<paragraph>
footnote body
<footnote ids="id2">
<label>
2
<paragraph>
footnote body
After::
<table>
<title>
title having footnote_reference
<footnotemark refid="id1">
1
<tgroup>
<thead>
<row>
<entry>
header having footnote_reference
<footnotemark refid="id2">
2
<tbody>
<footnotetext ids="id1">
<label>
1
<paragraph>
footnote body
<footnotetext ids="id2">
<label>
2
<paragraph>
footnote body
<row>
...
iX r/ r r Nc K sD t | j�tj��}|D ]}|j�|� q t| j|�}| j�|� d S r1 ) r2 r r r r+ r4 r5 �LaTeXFootnoteVisitorrh )r r � footnotesr" �visitorr# r# r$ r6 ^ s
zLaTeXFootnoteTransform.run�r& r' r( r) r* r7 r r6 r# r# r# r$ r� � s %r� c s� e Zd Zdejdeej ddf� fdd� Zdeddfdd �Z deddfd
d �Z
de ddfd d
�Z de ddfdd�Z
dejddfdd�Zdejddfdd�Zdejddfdd�Zdejddfdd�Zdejddfdd�Zdejddfdd�Zdejddfd d �Zdejddfd d �Zdejddfd d!�Zdejddfd"d#�Z dej ddfd$d%�Z dejddfd&d'�Z dejddfd(d)�Z dej!ddfd*d+�Z"dej!dejfd,d-�Z#� Z$S ).r� r r� r Nc s0 t � | _|| _g | _g | _d | _t� �|� d S r1 )rr �appearedr� �pendings�table_footnotes�
restrictedrs rt )r r r� ru r# r$ rt h s z LaTeXFootnoteVisitor.__init__r" c C rw r1 r# rY r# r# r$ rx p ry z"LaTeXFootnoteVisitor.unknown_visitc C rw r1 r# rY r# r# r$ rz s ry z&LaTeXFootnoteVisitor.unknown_departurec C s | j d u r
|| _ d S d S r1 )r� rY r# r# r$ �restrictv s
�z LaTeXFootnoteVisitor.restrictc C sp | j |kr6d | _ |j�|�}t| j�D ] \}}tdg|j�R d|d i�}|j�|| d |� qg | _d S d S )NrB r^ r. )r� r4 rL � enumerater� r �childrenrO )r r" �pos�ir+ �fntextr# r# r$ �
unrestrictz s
�z LaTeXFootnoteVisitor.unrestrictc C � | � |� d S r1 �r� rY r# r# r$ � visit_figure� � z!LaTeXFootnoteVisitor.visit_figurec C r� r1 �r� rY r# r# r$ �
depart_figure� r� z"LaTeXFootnoteVisitor.depart_figurec C r� r1 r� rY r# r# r$ �
visit_term� r� z LaTeXFootnoteVisitor.visit_termc C r� r1 r� rY r# r# r$ � depart_term� r� z LaTeXFootnoteVisitor.depart_termc C r� r1 r� rY r# r# r$ �
visit_caption� r� z"LaTeXFootnoteVisitor.visit_captionc C r� r1 r� rY r# r# r$ �depart_caption� r� z#LaTeXFootnoteVisitor.depart_captionc C s& t |jtjtjf�r| �|� d S d S r1 )rV r4 r �section�tabler� rY r# r# r$ � visit_title� s �z LaTeXFootnoteVisitor.visit_titlec C sR t |jtj�r| �|� d S t |jtj�r'| j| j7 _g | _| �|� d S d S r1 )rV r4 r r� r� r� r� r� rY r# r# r$ � depart_title� s �z!LaTeXFootnoteVisitor.depart_titlec C r� r1 r� rY r# r# r$ � visit_thead� r� z LaTeXFootnoteVisitor.visit_theadc C s$ | j | j7 _ g | _| �|� d S r1 )r� r� r� rY r# r# r$ � depart_thead� s z!LaTeXFootnoteVisitor.depart_theadc C sV t |�tj��d }t| j�D ]}tdg|j�R d|d i�}|�d|� qg | _d S )Nr rB r^ ) r2 r r �tbody�reversedr� r r� rO )r r" r� r+ r� r# r# r$ � depart_table� s
z!LaTeXFootnoteVisitor.depart_tablec C r� r1 r� rY r# r# r$ r} � r� z#LaTeXFootnoteVisitor.visit_footnotec C r� r1 r� rY r# r# r$ �depart_footnote� r� z$LaTeXFootnoteVisitor.depart_footnotec C s� |� � �� }|d }| jr.td||d d�}|�|� ||f| jvr-| �|�}| j�|� n+||f| jv rDtd||d d�}|�|� n| �|�}| j �
|� |�|� |� | � | j� ||f� t
j�)Nr rB r_ )r_ )rK �stripr� r rl r� �get_footnote_by_referencer� r` r� r5 rh r{ r �SkipNode)r r" �numberr �markr+ r# r# r$ r~ � s$
�
z-LaTeXFootnoteVisitor.visit_footnote_referencec C s@ |d }| j D ]}||d kr |d d |d kr | S qd S )Nr r^ r r_ )r� )r r" r r+ r# r# r$ r� � s
�z.LaTeXFootnoteVisitor.get_footnote_by_reference)%r& r' r( r r r r+ rt r
rx rz r r� r� �figurer� r� �termr� r� �captionr� r� �titler� r� �theadr� r� r� r� r} r� r, r~ r� r r# r# ru r$ r� g s* " r� c @ r� ) �BibliographyTransformaN Gather bibliography entries to tail of document.
Before::
<document>
<paragraph>
blah blah blah
<citation>
...
<paragraph>
blah blah blah
<citation>
...
...
After::
<document>
<paragraph>
blah blah blah
<paragraph>
blah blah blah
...
<thebibliography>
<citation>
...
<citation>
...
i� r/ r r Nc K sT t � }t| j�tj��D ] }|j�|� ||7 }q t|�dkr(| j|7 _d S d S )Nr ) r r2 r r r �citationr4 r5 �len)r r � citationsr" r# r# r$ r6 � s
�zBibliographyTransform.runr� r# r# r# r$ r� � s
r� c @ r� ) �CitationReferenceTransformz�Replace pending_xref nodes for citation by citation_reference.
To handle citation reference easily on LaTeX writer, this converts
pending_xref nodes to citation_reference.
� r/ r r Nc K s| t t| j�d��}ttjddd�}| j�|�D ]$}|j �
|d d�\}}}|r;t j ddg|j
�R ||d��}|�|� qd S )Nr� rq )� refdomain�reftype� reftarget)rB rB r rB )r �refname)r r r �
get_domainr r � pending_xrefr r r� rH r �citation_referencer� rl ) r r �domainr! r" r �labelid�_� citation_refr# r# r$ r6 s �
��z CitationReferenceTransform.runr� r# r# r# r$ r� �
r� c @ r� ) �MathReferenceTransformz�Replace pending_xref nodes for math by math_reference.
To handle math reference easily on LaTeX writer, this converts pending_xref
nodes to math_reference.
r� r/ r r Nc K sv | j �d�jd }| j�tj�D ](}|d dkr8|d dv r8|�|d d�\}}|r8td||d d �}|� |� qd S )
N�math�objectsr� r� )�eq�numrefr� )NNrB )r �target)
r r� �datar r r r� rH r rl )r r � equationsr" r r� �refnoder# r# r$ r6 s
��zMathReferenceTransform.runr� r# r# r# r$ r� r� r� c @ r� ) �LiteralBlockTransformzEReplace container nodes for literal_block by captioned_literal_block.r9 r/ r r Nc K sH t tjdd�}| j�|�D ]}tdg|j�R i |j��}|�|� q
d S )NT)�
literal_blockrB ) r r � containerr r r r� �
attributesrl )r r r! r" �newnoder# r# r$ r6 , s
�zLiteralBlockTransform.runr� r# r# r# r$ r� ' �
r� c @ r� ) �DocumentTargetTransformz5Add :doc label to the first section of each document.r9 r/ r r Nc K s6 | j �tj�D ]}|�tj�}|r|d �d� qd S )Nr^ z:doc)r r r rX � next_noder r� r` )r r r" r� r# r# r$ r6 8 s ��zDocumentTargetTransform.runr� r# r# r# r$ r� 3 r� r� c @ r� ) � IndexInSectionTitleTransforma� Move index nodes in section title to outside of the title.
LaTeX index macro is not compatible with some handling of section titles
such as uppercasing done on LaTeX side (cf. fncychap handling of ``\chapter``).
Moving the index node to after the title node fixes that.
Before::
<section>
<title>
blah blah <index entries=[...]/>blah
<paragraph>
blah blah blah
...
After::
<section>
<title>
blah blah blah
<index entries=[...]/>
<paragraph>
blah blah blah
...
r9 r/ r r Nc K sd t | j�tj��D ]&}t|jtj�r/tt |�t j
���D ]\}}|� |� |j� |d |� q q d S )Nr. )
r2 r r r r� rV r4 r� r� r rL r5 rO )r r r" r� rL r# r# r$ r6 \ s
��z IndexInSectionTitleTransform.runr� r# r# r# r$ r� ? s
r� �appr c C sp | � t� | �t� | �t� | �t� | �t� | �t� | �t� | �t � | �t
� | �t � dddd�S )N�builtinT)�version�parallel_read_safe�parallel_write_safe) �
add_transformr �add_post_transformr- r� r� r� r� r� r� r� r8 )r� r# r# r$ �setupe s
�r� N)1r) �typingr r r r r r �docutilsr �docutils.nodesr r
� docutils.transforms.referencesr �sphinxr �sphinx.applicationr
�sphinx.builders.latex.nodesr r r r r �sphinx.domains.citationr �sphinx.transformsr �!sphinx.transforms.post_transformsr �sphinx.util.nodesr rJ r r- r8 � NodeVisitorrg r� r� r� r� r� r� r� r� rj r� r# r# r# r$ �<module> s6
h 2n+ &