B
    öÀ„\>?  ã               @   s   d Z ddlmZ ddlmZ ddlmZ ddlmZ ddl	m
Z
mZ ddlmZ ddlmZ dd	lmZ dd
lmZmZmZ ddlmZ ddlm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G dd„ de
ƒZdd„ Z dS )zË
    sphinx.domains.javascript
    ~~~~~~~~~~~~~~~~~~~~~~~~~

    The JavaScript domain.

    :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
é    )Únodes)Ú
directives)Úaddnodes)ÚObjectDescription)ÚDomainÚObjType)Ú_pseudo_parse_arglist)Ú_)ÚXRefRole)ÚFieldÚGroupedFieldÚ
TypedField)ÚSphinxDirective)Úmake_refnodec               @   sD   e Zd ZdZdZdZdZdd„ Zdd„ Zdd	„ Z	d
d„ Z
dd„ ZdS )ÚJSObjectz-
    Description of a JavaScript object.
    FNc          
   C   s   |  ¡ }d|krJ|dd… dkrJ| dd¡\}}|  ¡ }|dd…   ¡ }n|}d}| jj dd¡}| jj d¡}|}z6y| dd¡\}}	W n tk
r¦   |}	d	}Y nX W d|	}|rÈ|rÈd ||g¡}n|dkrØ|rØ|}X |}
|rðd ||g¡}
||d
< ||d< |
|d< | jr$|t	 
| j| j¡7 }|rD|t	 |d |d ¡7 }n|rb|t	 |d |d ¡7 }|t	 ||¡7 }| jr˜|sŽ|t	 ¡ 7 }n
t||ƒ |
|fS )zÑBreaks down construct signatures

        Parses out prefix and argument list from construct definition. The
        namespace and class will be determined by the nesting of domain
        directives.
        ú(éÿÿÿÿNú)é   z	js:objectz	js:moduleÚ.Ú ÚmoduleÚobjectÚfullname)ÚstripÚsplitÚenvÚref_contextÚgetÚrsplitÚ
ValueErrorÚjoinÚdisplay_prefixr   Zdesc_annotationZdesc_addnameZ	desc_nameÚhas_argumentsZdesc_parameterlistr   )ÚselfÚsigÚsignodeÚmemberZarglistÚprefixÚmod_nameÚnameZmember_prefixÚmember_namer   © r,   ú8lib/python3.7/site-packages/sphinx/domains/javascript.pyÚhandle_signature1   sN    


zJSObject.handle_signaturec             C   s  | j j d¡}|r|d pd|d  }|| jjjkrÌ|d  |¡ |d  | dd¡¡ | j |d	< | jj 	|¡ | j j
d
 d }||krº| jjjd| d | j  || d ¡ | jd | j j| jf||< |  ||¡}|rþ| jd  d|| dd¡dd f¡ d S )Nz	js:moduler   r   r   ÚnamesÚidsú$Ú_S_ÚfirstÚjsÚobjectsz$duplicate object description of %s, zother instance in )ÚlineÚentriesÚsingle)r   r   r   ÚstateÚdocumentr0   ÚappendÚreplacer/   Únote_explicit_targetÚ
domaindataZstate_machineZreporterZwarningZdoc2pathÚlinenoÚdocnameÚobjtypeÚget_index_textZ	indexnode)r$   Úname_objr%   r&   r)   r   r5   Ú	indextextr,   r,   r-   Úadd_target_and_indexg   s&    


zJSObject.add_target_and_indexc             C   s|   |\}}| j dkr2|s"tdƒ| S tdƒ||f S | j dkrHtdƒ| S | j dkr^tdƒ| S | j dkrxtd	ƒ||f S d
S )NÚfunctionz%s() (built-in function)z%s() (%s method)Úclassz%s() (class)Údataz %s (global variable or constant)Ú	attributez%s (%s attribute)r   )rA   r	   )r$   Z
objectnamerC   r*   Úobjr,   r,   r-   rB      s    



zJSObject.get_index_textc             C   sh   d}| j r4| j  ¡ \}}|r&| d¡nd}| jr4|}|rd|| jjd< | jrd| jj dg ¡}| |¡ dS )a  Handle object nesting before content

        :py:class:`JSObject` represents JavaScript language constructs. For
        constructs that are nestable, this method will build up a stack of the
        nesting heirarchy so that it can be later de-nested correctly, in
        :py:meth:`after_content`.

        For constructs that aren't nestable, the stack is bypassed, and instead
        only the most recent object is tracked. This object prefix name will be
        removed with :py:meth:`after_content`.

        The following keys are used in ``self.env.ref_context``:

            js:objects
                Stores the object prefix history. With each nested element, we
                add the object prefix to this list. When we exit that object's
                nesting level, :py:meth:`after_content` is triggered and the
                prefix is removed from the end of the list.

            js:object
                Current object prefix. This should generally reflect the last
                element in the prefix history
        Nr   z	js:objectz
js:objects)r/   Úpopr   Úallow_nestingr   r   Ú
setdefaultr;   )r$   r(   Zobj_nameZobj_name_prefixr5   r,   r,   r-   Úbefore_contentŽ   s    zJSObject.before_contentc             C   s\   | j j dg ¡}| jr8y| ¡  W n tk
r6   Y nX t|ƒdkrL|d nd| j jd< dS )a^  Handle object de-nesting after content

        If this class is a nestable object, removing the last nested class prefix
        ends further nesting in the object.

        If this class is not a nestable object, the list of classes should not
        be altered as we didn't affect the nesting levels in
        :py:meth:`before_content`.
        z
js:objectsr   r   Nz	js:object)r   r   rM   rL   rK   Ú
IndexErrorÚlen)r$   r5   r,   r,   r-   Úafter_content³   s    zJSObject.after_content)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r#   r"   rL   r.   rE   rB   rN   rQ   r,   r,   r,   r-   r   "   s   6%r   c            	   @   sd   e Zd ZdZdZededƒdddded	ed
ƒddddededƒdddededƒdddgZ	dS )Ú
JSCallablez<Description of a JavaScript function, method or constructor.TÚ	argumentsZ	Arguments)ZargumentÚargZ	parameterZparamÚfunc)Z	paramtypeÚtype)Úlabelr/   ZtyperolenameZ	typenamesÚerrorsZThrowsÚerr)Zthrows)r[   Zrolenamer/   Zcan_collapseZreturnvalueZReturnsF)ZreturnsÚreturn)r[   Zhas_argr/   Z
returntypezReturn type)ZrtypeN)
rR   rS   rT   rU   r#   r   r	   r   r   Zdoc_field_typesr,   r,   r,   r-   rV   È   s   
rV   c               @   s   e Zd ZdZdZdZdS )ÚJSConstructorz,Like a callable but with a different prefix.zclass TN)rR   rS   rT   rU   r"   rL   r,   r,   r,   r-   r_   Ú   s   r_   c               @   s2   e Zd ZdZdZdZdZdZdej	iZ
dd„ ZdS )	ÚJSModulea÷  
    Directive to mark description of a new JavaScript module.

    This directive specifies the module name that will be used by objects that
    follow this directive.

    Options
    -------

    noindex
        If the ``noindex`` option is specified, no linkable elements will be
        created, and the module won't be added to the global module index. This
        is useful for splitting up the module definition across multiple
        sections or files.

    :param mod_name: Module name
    Fr   r   Únoindexc             C   sÆ   | j d  ¡ }|| jjd< d| jk}g }|sÂ| jj| jjd d |< | jjdf| jjd d |< tjddd	| gd
d}| j	j
 |¡ | |¡ tdƒ| }tjd|d	| dd fgd}| |¡ |S )Nr   z	js:modulera   r4   Úmodulesr   r5   r   zmodule-T)r0   Zismodz%s (module)r8   )r7   )rW   r   r   r   Zoptionsr@   r>   r   Útargetr9   r:   r=   r;   r	   r   Úindex)r$   r)   ra   ZretZ
targetnoderD   Úinoder,   r,   r-   Úrunû   s     


zJSModule.runN)rR   rS   rT   rU   Zhas_contentZrequired_argumentsZoptional_argumentsZfinal_argument_whitespacer   ÚflagZoption_specrf   r,   r,   r,   r-   r`   à   s   
r`   c               @   s   e Zd Zdd„ ZdS )Ú
JSXRefRolec             C   s¢   |j  d¡|d< |j  d¡|d< |sv| d¡}| d¡}|dd… dkrv|dd … }| d¡}|dkrv||d d … }|dd… dkrš|dd … }d|d	< ||fS )
Nz	js:objectz	js:moduler   ú~r   r   r   TÚrefspecific)r   r   ÚlstripÚrfind)r$   r   ZrefnodeZhas_explicit_titleÚtitlerc   Údotr,   r,   r-   Úprocess_link  s    


zJSXRefRole.process_linkN)rR   rS   rT   ro   r,   r,   r,   r-   rh     s   rh   c               @   sæ   e Zd ZdZdZdZeedƒdƒeedƒdƒeedƒdƒeed	ƒd	ƒeed
ƒdƒeedƒdƒdœZe	e	e
eeedœZeddeddeddeƒ eƒ eƒ dœZi i dœZdd„ Zdd„ Zd#dd„Zdd„ Zdd„ Zdd„ Zd d!„ Zd"S )$ÚJavaScriptDomainzJavaScript language domain.r4   Z
JavaScriptrF   rY   ÚmethodÚmethrG   rH   rI   Úattrr   Úmod)rF   rq   rG   rH   rI   r   T)Z
fix_parens)rY   rr   rG   rH   rs   rt   )r5   rb   c             C   sp   x6t | jd  ¡ ƒD ] \}\}}||kr| jd |= qW x2t | jd  ¡ ƒD ]\}}||krL| jd |= qLW d S )Nr5   rb   )ÚlistrH   Úitems)r$   r@   r   Úpkg_docnameZ_lr)   r,   r,   r-   Ú	clear_docG  s     zJavaScriptDomain.clear_docc             C   sl   x6|d   ¡ D ]&\}\}}||kr||f| jd |< qW x.|d   ¡ D ]\}}||krF|| jd |< qFW d S )Nr5   rb   )rv   rH   )r$   ZdocnamesZ	otherdatar   ÚfnrA   r)   rw   r,   r,   r-   Úmerge_domaindataP  s    z!JavaScriptDomain.merge_domaindatar   c             C   s¾   |dd … dkr|d d… }| j d }g }|rH|rH| d |||g¡¡ |r`| d ||g¡¡ |rx| d ||g¡¡ | |¡ |dkr’| ¡  d }	x|D ]}
|
|krœ|
}	qœW |	| |	¡fS )Néþÿÿÿz()r5   r   r   )rH   r;   r!   Úreverser   )r$   r   r)   r(   r*   ÚtypÚsearchorderr5   ZsearchesZnewnameZsearch_namer,   r,   r-   Úfind_objZ  s$    


zJavaScriptDomain.find_objc             C   sd   |  d¡}|  d¡}	| d¡r"dp$d}
|  |||	|||
¡\}}|sFd S t|||d | dd¡||ƒS )Nz	js:modulez	js:objectrj   r   r   r1   r2   )r   Úhasattrr   r   r<   )r$   r   ÚfromdocnameÚbuilderr}   rc   ÚnodeÚcontnoder)   r(   r~   r*   rJ   r,   r,   r-   Úresolve_xrefs  s    

zJavaScriptDomain.resolve_xrefc          	   C   sf   |  d¡}|  d¡}|  ||||d d¡\}	}
|
s4g S d|  |
d ¡ t|||
d |	 dd¡||	ƒfgS )Nz	js:modulez	js:objectr   zjs:r   r1   r2   )r   r   Zrole_for_objtyper   r<   )r$   r   r   r‚   rc   rƒ   r„   r)   r(   r*   rJ   r,   r,   r-   Úresolve_any_xref  s    

z!JavaScriptDomain.resolve_any_xrefc          	   c   sB   x<t | jd  ¡ ƒD ]&\}\}}||||| dd¡dfV  qW d S )Nr5   r1   r2   r   )ru   rH   rv   r<   )r$   Zrefnamer@   rZ   r,   r,   r-   Úget_objects‹  s     zJavaScriptDomain.get_objectsc             C   sD   |  d¡}|  d¡}|  d¡}|d kr*d S d td |||gƒ¡S d S )Nz	js:modulez	js:objectZ	reftargetr   )r   r!   Úfilter)r$   rƒ   Úmodnamer(   rc   r,   r,   r-   Úget_full_qualified_name‘  s    


z(JavaScriptDomain.get_full_qualified_nameN)r   )rR   rS   rT   rU   r*   r[   r   r	   Zobject_typesrV   r_   r   r`   r   rh   ZrolesZinitial_datarx   rz   r   r…   r†   r‡   rŠ   r,   r,   r,   r-   rp   %  s<   
	

rp   c             C   s   |   t¡ dddddœS )NZbuiltinr   T)ÚversionZenv_versionZparallel_read_safeZparallel_write_safe)Z
add_domainrp   )Zappr,   r,   r-   Úsetupœ  s
    
rŒ   N)!rU   Zdocutilsr   Zdocutils.parsers.rstr   Zsphinxr   Zsphinx.directivesr   Zsphinx.domainsr   r   Zsphinx.domains.pythonr   Zsphinx.localer	   Zsphinx.rolesr
   Zsphinx.util.docfieldsr   r   r   Zsphinx.util.docutilsr   Zsphinx.util.nodesr   r   rV   r_   r`   rh   rp   rŒ   r,   r,   r,   r-   Ú<module>
   s&    '1w