ó
öÀ„\c           @   s‘  d  Z  d d l m Z d d l m Z d d l m Z m Z m Z m	 Z	 m
 Z
 d d l m Z e r d d l m Z m Z m Z m Z m Z n  d" Z d e f d „  ƒ  YZ d e f d „  ƒ  YZ d e j f d „  ƒ  YZ d e f d „  ƒ  YZ d e j f d „  ƒ  YZ d e f d „  ƒ  YZ d e f d „  ƒ  YZ d e f d „  ƒ  YZ d e f d „  ƒ  YZ d e f d „  ƒ  YZ d e f d  „  ƒ  YZ  d! S(#   sà   
    sphinx.builders.latex.transforms
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    Transforms for LaTeX builder.

    :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
iÿÿÿÿ(   t   nodes(   t   addnodes(   t   captioned_literal_blockt   footnotemarkt   footnotetextt   math_referencet   thebibliography(   t   SphinxTransform(   t   Dictt   Listt   Sett   Tuplet   Unions   mailto:s   http:s   https:s   ftp:t   FootnoteDocnameUpdaterc           B   s/   e  Z d  Z d Z e j e j f Z d „  Z RS(   s5   Add docname to footnote and footnote_reference nodes.i¼  c            s:   x3 ˆ  j  j ‡  f d †  ƒ D] } ˆ  j j | d <q Wd  S(   Nc            s   t  |  ˆ  j ƒ S(   N(   t
   isinstancet   TARGET_NODES(   t   n(   t   self(    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   <lambda>!   s    t   docname(   t   documentt   traverset   envR   (   R   t   node(    (   R   s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   apply    s    "(	   t   __name__t
   __module__t   __doc__t   default_priorityR    t   footnotet   footnote_referenceR   R   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR      s   t   ShowUrlsTransformc           B   sG   e  Z d  Z d Z e Z d „  Z d „  Z d „  Z d „  Z	 d „  Z
 RS(   s«   Expand references to inline text or footnotes.

    For more information, see :confval:`latex_show_urls`.

    .. note:: This transform is used for integrated doctree
    i  c         C   sY   zB |  j  j j } d |  j  j _ |  j ƒ  |  j rA |  j ƒ  n  Wd  | |  j  j _ Xd  S(   Nt	   show_urls(   R   t   settingst	   id_prefixt   expand_show_urlst   expandedt   renumber_footnotes(   R   R"   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR   1   s    
	c   	      C   sS  |  j  j j j j } | t k s- | d k r1 d  Sx|  j  j t j ƒ D]} | j	 d d ƒ } | j
 t ƒ rG | j
 d ƒ rŠ | d } n  | j ƒ  | k rK| j j | ƒ } |  j | ƒ } | d k r|  j | | ƒ \ } } | j j | d | ƒ | j j | d | ƒ t |  _ qHt j d	 | ƒ } | j j | d | ƒ qKqG qG Wd  S(
   Nt   not   refurit    s   mailto:i   R   i   i   s    (%s)(   R   R!   R   t   configt   latex_show_urlst   FalseR   R    t	   referencet   gett
   startswitht   URI_SCHEMESt   astextt   parentt   indext   get_docname_for_nodet   create_footnotet   insertt   TrueR$   t   Text(	   R   R    R   t   uriR2   R   t   fnt   fnreft   textnode(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR#   ?   s$    c         C   sZ   xS | rU t  | t j ƒ r/ |  j j | d ƒ St  | t j ƒ rI | d S| j } q Wd  S(   Nt   sourceR   (	   R   R    R   R   t   path2docR   t   start_of_fileR1   t   None(   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR3   W   s    	c      	   C   sø   t  j d d ƒ } t  j ƒ  } | j t  j d t  j | ƒ d | d t ƒƒ t  j | | | d d d | ƒ} | d j d ƒ |  j j	 | ƒ t  j d ƒ } t  j
 d	 | d d d
 | d d d | ƒ} |  j j | ƒ | j | d d ƒ | | f S(   NR(   t   #R'   t	   nolinkurlt   autoi   R   t   namess   [#]_t   refidt   idsi    (   R    t   labelt	   paragrapht   appendR,   R7   R6   R   R   t   note_autofootnoteR   t   note_autofootnote_reft   add_backref(   R   R8   R   RF   t   paraR   t   footnote_ref(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR4   c   s    .!c         C   sN  t  |  j ƒ } |  j j | ƒ d } x"| j D]} x- t rd | d 7} t | ƒ | j k r8 Pq8 q8 W| d j ƒ  } | d j t	 j
 d t | ƒ ƒ ƒ | | d k r¼ | d j | ƒ n  | d j t | ƒ ƒ | d } xf | j D][ } | | d k rç | d d | d k rç | j | d ƒ | t	 j t | ƒ ƒ 7} qç qç Wq/ Wd  S(   Ni    i   R(   RC   R   RE   RD   (   t   FootnoteCollectorR   t	   walkaboutt   auto_footnotesR6   t   strt   used_footnote_numbersR0   t   replace_selfR    RF   t   removeRH   t   footnote_refsR7   (   R   t	   collectort   numR   t	   old_labelR   t   ref(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR%   t   s$    	
#
((   R   R   R   R   R+   R$   R   R#   R3   R4   R%   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR   %   s   				RN   c           B   s;   e  Z d  Z d „  Z d „  Z d „  Z d „  Z d „  Z RS(   s9   Collect footnotes and footnote references on the documentc         C   s5   g  |  _  t ƒ  |  _ g  |  _ t j j |  | ƒ d  S(   N(   RP   t   setRR   RU   R    t   NodeVisitort   __init__(   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR\   “   s    		c         C   s   d  S(   N(    (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   unknown_visitš   s    c         C   s   d  S(   N(    (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   unknown_departurež   s    c         C   sK   | j  d ƒ r" |  j j | ƒ n% x" | d D] } |  j j | ƒ q- Wd  S(   NRB   RC   (   R-   RP   RH   RR   t   add(   R   R   t   name(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   visit_footnote¢   s    c         C   s   |  j  j | ƒ d  S(   N(   RU   RH   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   visit_footnote_referenceª   s    (   R   R   R   R\   R]   R^   Ra   Rb   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyRN      s   				t   LaTeXFootnoteTransformc           B   s   e  Z d  Z d Z d „  Z RS(   s/  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="1">
                  <label>
                      1
                  <paragraph>
                      footnote body

      After::

          <section>
              <title>
                  headings having footnotes
                  <footnotemark>
                      1
              <footnotetext>
                  footnote body
              <footnotetext>
                  <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="1">
              <label>
                  1
              <paragraph>
                  footnote body

      After::

          blah blah blah
          <footnote ids="1">
              <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="1">
              <label>
                  1
              <paragraph>
                  footnote body

      After::

          blah blah blah
          <footnote ids="1">
              <label>
                  1
              <paragraph>
                  footnote body
          blah blah blah
          <footnotemark>
              1
          blah blah blah ...

    * Remove unreferenced footnotes

      Before::

          <footnote ids="1">
              <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="1">
                      1
              <tgroup>
                  <thead>
                      <row>
                          <entry>
                              header having footnote_reference
                              <footnote_reference refid="2">
                                  2
                  <tbody>
                      <row>
                      ...

          <footnote ids="1">
              <label>
                  1
              <paragraph>
                  footnote body

          <footnote ids="2">
              <label>
                  2
              <paragraph>
                  footnote body

      After::

          <table>
              <title>
                  title having footnote_reference
                  <footnotemark>
                      1
              <tgroup>
                  <thead>
                      <row>
                          <entry>
                              header having footnote_reference
                              <footnotemark>
                                  2
                  <tbody>
                      <footnotetext>
                          <label>
                              1
                          <paragraph>
                              footnote body

                      <footnotetext>
                          <label>
                              2
                          <paragraph>
                              footnote body
                      <row>
                      ...
    iX  c         C   sb   t  |  j j t j ƒ ƒ } x | D] } | j j | ƒ q" Wt |  j | ƒ } |  j j | ƒ d  S(   N(	   t   listR   R   R    R   R1   RT   t   LaTeXFootnoteVisitorRO   (   R   t	   footnotesR   t   visitor(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR   X  s
    (   R   R   R   R   R   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyRc   ¯   s   ¥Re   c           B   s¼   e  Z d  „  Z d „  Z d „  Z d „  Z d „  Z d „  Z d „  Z d „  Z	 d „  Z
 d	 „  Z d
 „  Z d „  Z d „  Z d „  Z d „  Z d „  Z d „  Z d „  Z d „  Z d „  Z RS(   c         C   sG   t  ƒ  |  _ | |  _ g  |  _ g  |  _ d  |  _ t j j	 |  | ƒ d  S(   N(
   RZ   t   appearedRf   t   pendingst   table_footnotesR?   t
   restrictedR    R[   R\   (   R   R   Rf   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR\   b  s    				c         C   s   d  S(   N(    (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR]   k  s    c         C   s   d  S(   N(    (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR^   o  s    c         C   s   |  j  d  k r | |  _  n  d  S(   N(   Rk   R?   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   restricts  s    c         C   s‡   |  j  | k rƒ d  |  _  | j j | ƒ } xJ t |  j ƒ D]9 \ } } t d | j Œ } | j j | | d | ƒ q: Wg  |  _ n  d  S(   NR(   i   (	   Rk   R?   R1   R2   t	   enumerateRi   R   t   childrenR5   (   R   R   t   post   iR   t   fntext(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt
   unrestrictx  s    	c         C   s   |  j  | ƒ d  S(   N(   Rl   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   visit_figure‚  s    c         C   s   |  j  | ƒ d  S(   N(   Rr   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   depart_figure†  s    c         C   s   |  j  | ƒ d  S(   N(   Rl   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt
   visit_termŠ  s    c         C   s   |  j  | ƒ d  S(   N(   Rr   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   depart_termŽ  s    c         C   s   |  j  | ƒ d  S(   N(   Rl   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   visit_caption’  s    c         C   s   |  j  | ƒ d  S(   N(   Rr   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   depart_caption–  s    c         C   s2   t  | j t j t j f ƒ r. |  j | ƒ n  d  S(   N(   R   R1   R    t   sectiont   tableRl   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   visit_titleš  s    c         C   si   t  | j t j ƒ r% |  j | ƒ n@ t  | j t j ƒ re |  j |  j 7_ g  |  _ |  j | ƒ n  d  S(   N(   R   R1   R    Ry   Rr   Rz   Rj   Ri   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   depart_titleŸ  s    	c         C   s   |  j  | ƒ d  S(   N(   Rl   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   visit_thead¨  s    c         C   s,   |  j  |  j 7_  g  |  _ |  j | ƒ d  S(   N(   Rj   Ri   Rr   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   depart_thead¬  s    	c         C   se   t  | j t j ƒ ƒ d } x9 t |  j ƒ D]( } t d | j Œ } | j d | ƒ q, Wg  |  _ d  S(   Ni    R(   (	   Rd   R   R    t   tbodyt   reversedRj   R   Rn   R5   (   R   R   R   R   Rq   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   depart_table²  s
    c         C   s   |  j  | ƒ d  S(   N(   Rl   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyRa   »  s    c         C   s   |  j  | ƒ d  S(   N(   Rr   (   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   depart_footnote¿  s    c         C   s  | j  ƒ  j ƒ  } | d } |  j r{ t d | ƒ } | j | ƒ | | f |  j k rè |  j | ƒ } |  j j | ƒ qè nm | | f |  j k r¯ t d | ƒ } | j | ƒ n9 |  j | ƒ } |  j	 j
 | ƒ | j | ƒ | j |  ƒ |  j j | | f ƒ t j ‚ d  S(   NR   R(   (   R0   t   stripRk   R   RS   Rh   t   get_footnote_by_referenceRi   RH   Rf   RT   RO   R_   R    t   SkipNode(   R   R   t   numberR   t   markR   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyRb   Ã  s"    
	c         C   sN   | d } x= |  j  D]2 } | | d k r | d d | d k r | Sq Wd  S(   NR   RE   i    RD   (   Rf   R?   (   R   R   R   R   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR„   Ù  s
    
((   R   R   R\   R]   R^   Rl   Rr   Rs   Rt   Ru   Rv   Rw   Rx   R{   R|   R}   R~   R   Ra   R‚   Rb   R„   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyRe   a  s(   						
																t   BibliographyTransformc           B   s   e  Z d  Z d Z d „  Z RS(   sN  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î  c         C   sk   t  ƒ  } x7 |  j j t j ƒ D]  } | j j | ƒ | | 7} q Wt | ƒ d k rg |  j | 7_ n  d  S(   Ni    (   R   R   R   R    t   citationR1   RT   t   len(   R   t	   citationsR   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR     s    	(   R   R   R   R   R   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyRˆ   ã  s   t   CitationReferenceTransformc           B   s   e  Z d  Z d Z d „  Z RS(   s¹   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.
    i   c         C   sÏ   |  j  j j d k r d  S|  j j d ƒ j d } x– |  j j t j	 ƒ D] } | d d k rH | d d k rH | j
 | d d ƒ \ } } } | rÇ t j d d
 | d | | j Œ} | j | ƒ qÇ qH qH Wd  S(   Nt   latext   stdR‹   t	   refdomaint   reftypeR‰   t	   reftargetR(   i    R   t   refname(   R(   R(   i    (   t   appt   builderR`   R   t
   get_domaint   dataR   R   R   t   pending_xrefR-   R    t   citation_referenceRn   RS   (   R   R‹   R   R   t   labelidt   _t   citation_ref(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR     s     (   R   R   R   R   R   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyRŒ     s   t   MathReferenceTransformc           B   s   e  Z d  Z d Z d „  Z RS(   s©   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.
    i   c         C   sÇ   |  j  j j d k r d  S|  j j d ƒ j d } xŽ |  j j t j	 ƒ D]w } | d d k rH | d d k rH | j
 | d d ƒ \ } } | r¿ t d	 d
 | d | d ƒ} | j | ƒ q¿ qH qH Wd  S(   NR   t   matht   objectsR   R   t   eqt   numrefR‘   R(   R   t   target(   RŸ   R    (   NN(   R“   R”   R`   R   R•   R–   R   R   R   R—   R-   R?   R   RS   (   R   t	   equationsR   R   Rš   t   refnode(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR   -  s     (   R   R   R   R   R   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyRœ   %  s   t   LiteralBlockTransformc           B   s   e  Z d  Z d Z d „  Z RS(   sE   Replace container nodes for literal_block by captioned_literal_block.i  c         C   sz   |  j  j j d k r d  SxZ |  j j t j ƒ D]C } | j d ƒ t k r/ t	 d | j
 | j Ž } | j | ƒ q/ q/ Wd  S(   NR   t   literal_blockR(   (   R“   R”   R`   R   R   R    t	   containerR-   R6   R   Rn   t
   attributesRS   (   R   R   t   newnode(    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR   ?  s    (   R   R   R   R   R   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR¤   ;  s   t   DocumentTargetTransformc           B   s   e  Z d  Z d Z d „  Z RS(   s5   Add :doc label to the first section of each document.i  c         C   si   |  j  j j d k r d  SxI |  j j t j ƒ D]2 } | j t j	 ƒ } | r/ | d j
 d ƒ q/ q/ Wd  S(   NR   RE   s   :doc(   R“   R”   R`   R   R   R   R>   t	   next_nodeR    Ry   RH   (   R   R   Ry   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR   N  s    (   R   R   R   R   R   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR©   J  s   t   IndexInSectionTitleTransformc           B   s   e  Z d  Z d Z d „  Z RS(   s  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
            ...
    i  c         C   s‰   x‚ |  j  j t j ƒ D]k } t | j t j ƒ r xM t | j t j	 ƒ ƒ D]0 \ } } | j
 | ƒ | j j | d | ƒ qJ Wq q Wd  S(   Ni   (   R   R   R    t   titleR   R1   Ry   Rm   R   R2   RT   R5   (   R   R   Rp   R2   (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR   u  s
    %(   R   R   R   R   R   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyR«   Y  s   N(   s   mailto:s   http:s   https:s   ftp:(!   R   t   docutilsR    t   sphinxR   t   sphinx.builders.latex.nodesR   R   R   R   R   t   sphinx.transformsR   R+   t   typingR   R	   R
   R   R   R/   R   R   R[   RN   Rc   Re   Rˆ   RŒ   Rœ   R¤   R©   R«   (    (    (    s?   lib/python2.7/site-packages/sphinx/builders/latex/transforms.pyt   <module>
   s$   (+
k²‚+