U
    \ShI                     @  s  d Z ddlmZ ddlmZmZmZ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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"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/m0Z0m1Z1 ddl2m3Z3 e'4e5Z6G dd deee7e7f  Z8G dd de8Z9G dd de9Z:G dd de-Z;G dd de%Z<G d d! d!eZ=d"d#d$d%d&Z>d'S )(zThe JavaScript domain.    )annotations)AnyIteratorTuplecast)nodes)ElementNode)
directives)addnodes)desc_signaturepending_xref)Sphinx)Builder)ObjectDescription)DomainObjType)_pseudo_parse_arglist)BuildEnvironment)___)XRefRole)logging)FieldGroupedField
TypedField)SphinxDirective)make_idmake_refnodenested_parse_with_titles)
OptionSpecc                   @  s   e Zd ZU dZdZdZejejejejdZde	d< dddd	Z
d
dddddZdddddZdd
dddddZd
dd
dddZddddZddddZdd
ddd Zd!S )"JSObjectz-
    Description of a JavaScript object.
    F)noindexnoindexentrynocontentsentrysingle-line-parameter-listr    option_spec
list[Node]returnc                 C  s   g S N selfr+   r+   L/root/rtd-docs/venv/lib/python3.8/site-packages/sphinx/domains/javascript.pyget_display_prefix1   s    zJSObject.get_display_prefixstrr   tuple[str, str])sigsignoder)   c              
   C  s  |  }d|krJ|dd dkrJ|dd\}}|  }|dd   }n|}d}| jjdd}| jjd}|}z6z|dd\}	}W n tk
r   |}d	}	Y nX W 5 |}|r|	rd||	g}n|dkr|	r|	}X |}
|rd||g}
||d
< ||d< |
|d< | jjj	p"| jjj
p"d}d| jkoLt||  koHdkn  }|  }|rn|tjd| 7 }d}|r~|}n
|r|}|rtd	d	}|dD ]&}|t||7 }|tdd7 }q||7 }|td	d	t||7 }| jr|s
|t 7 }nt||| |
|fS )zBreaks 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)   	js:object	js:module. moduleobjectfullnamer   r%   )r;   r;   )stripsplitenvref_contextgetjoinrsplit
ValueErrorconfig(javascript_maximum_signature_line_lengthZmaximum_signature_line_lengthoptionslenr/   r   Zdesc_annotationZdesc_addnameZdesc_sig_nameZdesc_sig_punctuationZ	desc_namehas_argumentsZdesc_parameterlistr   )r-   r2   r3   memberZarglistprefixmod_namenamemember_nameZmember_prefixr>   max_lenZmulti_line_parameter_listZdisplay_prefixZactual_prefixZaddNamepr+   r+   r.   handle_signature5   sl    zJSObject.handle_signatureztuple[str, ...])sig_noder)   c                 C  sD   d|krdS | d}|d }|r2|f|dS t|dS d S )Nr>   r+   r<   r:   )rC   r@   tuple)r-   rT   modnamer>   r+   r+   r.   _object_hierarchy_parts{   s    
z JSObject._object_hierarchy_partsNone)name_objr2   r3   r)   c           	      C  s   | j jd}|r|d nd|d  }t| j | jjd|}|d | | jj| tt	| j 
d}|j|| j||d d| jkr| ||}|r| jd	 d
||dd f d S )Nr9   r:   r;   r   idsjslocationr#   entriessingle)rA   rB   rC   r   statedocumentappendnote_explicit_targetr   JavaScriptDomain
get_domainnote_objectobjtyperI   get_index_textZ	indexnode)	r-   rY   r2   r3   rN   r>   node_iddomain	indextextr+   r+   r.   add_target_and_index   s    
zJSObject.add_target_and_index)
objectnamerY   r)   c                 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;   )rg   r   )r-   rm   rY   rO   objr+   r+   r.   rh      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 hierarchy 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:   r8   
js:objects)namespopr?   allow_nestingrA   rB   
setdefaultrb   )r-   rM   obj_nameZobj_name_prefixobjectsr+   r+   r.   before_content   s    zJSObject.before_contentc                 C  s\   | j jdg }| jr8z|  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`.
        rs   r   r5   Nr8   )rA   rB   rw   rv   ru   
IndexErrorrJ   )r-   ry   r+   r+   r.   after_content   s    
zJSObject.after_contentc                 C  s   | dsdS | jjj}|j d}|jr8|dkr8d}nd}|d ^ }}|jdkrd| d|| S |jdkrv|| S |jd	krd
||| g S dS )NZ
_toc_partsr;   rg   >   methodrn   ()rj   r>   Zhideallr:   )rC   rA   apprG   parentZadd_function_parenthesesZtoc_object_entries_show_parentsrD   )r-   rT   rG   rg   ZparensparentsrO   r+   r+   r.   _toc_entry_name   s    




zJSObject._toc_entry_nameN)__name__
__module____qualname____doc__rK   rv   r
   flagr&   __annotations__r/   rS   rW   rl   rh   rz   r|   r   r+   r+   r+   r.   r!      s    
F$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	arguments	Arguments)argumentargZ	parameterparamfunc)Z	paramtypetype)labelrt   ZtyperolenameZ	typenameserrorsZThrows)Zthrows)r   Zrolenamert   Zcan_collapseZreturnvalueZReturnsF)Zreturnsr)   )r   has_argrt   Z
returntypezReturn type)ZrtypeN)
r   r   r   r   rK   r   r   r   r   Zdoc_field_typesr+   r+   r+   r.   r      s$   
 r   c                   @  s"   e Zd ZdZdZddddZdS )JSConstructorz,Like a callable but with a different prefix.Tr'   r(   c                 C  s   t ddt  gS )Nro   )r   Zdesc_sig_keywordZdesc_sig_spacer,   r+   r+   r.   r/     s    
z JSConstructor.get_display_prefixN)r   r   r   r   rv   r/   r+   r+   r+   r.   r     s   r   c                   @  sF   e Zd ZU dZdZdZdZdZej	ej	dZ
ded< d	d
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
    Tr7   r   F)r"   r$   r    r&   r'   r(   c           
      C  s
  | j d  }|| jjd< d| jk}t }| jj|_t	| j| j
|| j g }|stt| jd}t| j| jjd|}||| |j|d|| jj| jfd tjdd|gdd	}| jj| || td
| }tjd||dd fgd}	||	 ||j |S )Nr   r9   r"   r[   r<   r\   r;   T)rZ   Zismodz%s (module)r_   )r^   )r   r?   rA   rB   rI   r   sectionr`   ra   r   contentZcontent_offsetr   rd   re   r   note_modulerf   docnamelinenotargetrc   rb   r   r   indexextendchildren)
r-   rN   r"   Zcontent_noderetrj   ri   r   rk   inoder+   r+   r.   run'  s,    




zJSModule.runN)r   r   r   r   Zhas_contentZrequired_argumentsZoptional_argumentsZfinal_argument_whitespacer
   r   r&   r   r   r+   r+   r+   r.   r     s   
r   c                   @  s$   e Zd ZdddddddddZd	S )

JSXRefRoler   r   boolr0   r1   )rA   refnodehas_explicit_titletitler   r)   c                 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 )
Nr8   r9   r:   ~r   r7   r5   Trefspecific)rB   rC   lstriprfind)r-   rA   r   r   r   r   dotr+   r+   r.   process_linkG  s    


zJSXRefRole.process_linkN)r   r   r   r   r+   r+   r+   r.   r   F  s   r   c                	   @  s  e Zd ZU 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ed< eddddZdGddddddddZed dd!d"Zdddd#d$d%Zddd&d'd(Zd)d*dd+d,d-ZdHd/dddd0d1d2d3d4d5Zd/dd6ddd7d8d9d:d;d<Zd/dd6dd7d8d=d>d?d@ZdAddBdCZd8d0dDdEdFZdS )Ird   zJavaScript language domain.r[   
JavaScriptrn   r   r}   methro   rp   rq   attrr<   mod)rn   r}   ro   rp   rq   r<   T)Z
fix_parens)r   r   ro   rp   r   r   )ry   modulesz%dict[str, dict[str, tuple[str, str]]]initial_datazdict[str, tuple[str, str, str]]r(   c                 C  s   | j di S )Nry   rp   rw   r,   r+   r+   r.   ry   |  s    zJavaScriptDomain.objectsNr0   r   rX   )r>   rg   ri   r]   r)   c                 C  sJ   || j kr2| j | d }tjtd|||||d | jj||f| j |< d S )Nr   z.duplicate %s description of %s, other %s in %sr\   )ry   loggerwarningr   rA   r   )r-   r>   rg   ri   r]   r   r+   r+   r.   rf     s    

    zJavaScriptDomain.note_objectzdict[str, tuple[str, str]]c                 C  s   | j di S )Nr   r   r,   r+   r+   r.   r     s    zJavaScriptDomain.modules)rV   ri   r)   c                 C  s   | j j|f| j|< d S r*   )rA   r   r   )r-   rV   ri   r+   r+   r.   r     s    zJavaScriptDomain.note_module)r   r)   c                 C  s^   t | j D ]\}\}}}||kr| j|= qt | j D ]\}\}}||kr<| j|= q<d S r*   )listry   itemsr   )r-   r   r>   pkg_docnameZ_node_idZ_lrV   r+   r+   r.   	clear_doc  s    
zJavaScriptDomain.clear_docz	list[str]dict[str, Any])docnames	otherdatar)   c           	      C  sh   |d   D ]&\}\}}}||kr|||f| j|< q|d   D ]"\}\}}||kr@||f| j|< q@d S )Nry   r   )r   ry   r   )	r-   r   r   r>   fnri   rg   rN   r   r+   r+   r.   merge_domaindata  s    z!JavaScriptDomain.merge_domaindatar   r   z
str | Noneintz.tuple[str | None, tuple[str, str, str] | None])rA   rN   rM   rO   typsearchorderr)   c                 C  s   |dd  dkr|d d }g }|r>|r>| d|||g |rV| d||g |rn| d||g | | |dkr|  d }d }	|D ]}
|
| jkr|
}| j|
 }	q||	fS )Nr~   r:   r   )rb   rD   reversery   )r-   rA   rN   rM   rO   r   r   ZsearchesZnewnameZobject_Zsearch_namer+   r+   r.   find_obj  s&    	

zJavaScriptDomain.find_objr   r   r   zElement | None)rA   fromdocnamebuilderr   r   nodecontnoder)   c                 C  s`   | d}| d}	|dr"dnd}
| |||	|||
\}}|sFd S t|||d |d ||S )Nr9   r8   r   r7   r   )rC   hasattrr   r   )r-   rA   r   r   r   r   r   r   rN   rM   r   rO   rr   r+   r+   r.   resolve_xref  s    

zJavaScriptDomain.resolve_xrefzlist[tuple[str, Element]])rA   r   r   r   r   r   r)   c                 C  sb   | d}| d}| ||||d d\}	}
|
s4g S d| |
d  t|||
d |
d ||	fgS )Nr9   r8   r7   zjs:   r   )rC   r   Zrole_for_objtyper   )r-   rA   r   r   r   r   r   rN   rM   rO   rr   r+   r+   r.   resolve_any_xref  s    

z!JavaScriptDomain.resolve_any_xrefz-Iterator[tuple[str, str, str, str, str, int]]c                 c  s4   t | j D ] \}\}}}|||||dfV  qd S )Nr7   )r   ry   r   )r-   Zrefnamer   ri   r   r+   r+   r.   get_objects  s    zJavaScriptDomain.get_objects)r   r)   c                 C  sD   | d}| d}| d}|d kr*d S dtd |||gS d S )Nr9   r8   Z	reftargetr:   )rC   rD   filter)r-   r   rV   rM   r   r+   r+   r.   get_full_qualified_name  s    


z(JavaScriptDomain.get_full_qualified_name)N)r   )r   r   r   r   rO   r   r   r   Zobject_typesr   r   r!   r   r
   r   Zrolesr   r   propertyry   rf   r   r   r   r   r   r   r   r   r   r+   r+   r+   r.   rd   Z  sT   
			  !rd   r   r   )r   r)   c                 C  s.   |  t | jdd dtd hd dddddS )NrH   rA   )typesbuiltin   T)versionZenv_versionZparallel_read_safeZparallel_write_safe)Z
add_domainrd   Zadd_config_valuer   )r   r+   r+   r.   setup  s    
   r   N)?r   
__future__r   typingr   r   r   r   Zdocutilsr   Zdocutils.nodesr   r	   Zdocutils.parsers.rstr
   Zsphinxr   Zsphinx.addnodesr   r   Zsphinx.applicationr   Zsphinx.buildersr   Zsphinx.directivesr   Zsphinx.domainsr   r   Zsphinx.domains.pythonr   Zsphinx.environmentr   Zsphinx.localer   r   Zsphinx.rolesr   Zsphinx.utilr   Zsphinx.util.docfieldsr   r   r   Zsphinx.util.docutilsr   Zsphinx.util.nodesr   r   r   Zsphinx.util.typingr    	getLoggerr   r   r0   r!   r   r   r   r   rd   r   r+   r+   r+   r.   <module>   s<   
 R
; 