3
T'ícðE ã @ s® d Z ddlmZmZmZmZmZmZmZ ddl m
Z
ddl m Z m
Z
ddlmZ ddlmZ ddlmZmZ ddlmZ dd lmZ dd
lmZ dd lm Z m Z dd l m Z dd
l m!Z! ddl"m#Z#m$Z$ ddl%m&Z& ddl'm(Z( ddl)m*Z*m+Z+m,Z, ddl-m.Z. ddl/m0Z0m1Z1 ddl2m3Z3 e(j4e5Z6G dd deee7e7f Z8G dd de8Z9G dd de9Z:G dd d e.Z;G d d d e&Z<G d d d e Z=eee7ef d!d"d#Z>d$S )%zThe JavaScript domain.é )ÚAnyÚDictÚIteratorÚListÚOptionalÚ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)Ú
OptionSpecc @ sº e Zd ZU dZdZdZejejdZe e
e dddZ e
eee
e
f ddd Zee
e
f e
ed
d d d
Ze
ee
e
f e
dddZd
dddZd
dddZe
e
dddZd
S )ÚJSObjectz-
Description of a JavaScript object.
F)ÚnoindexÚ noindexentry)Úreturnc C s g S )N© )Úselfr& r& ú;/tmp/pip-build-gk9425m9/sphinx/sphinx/domains/javascript.pyÚget_display_prefix- s zJSObject.get_display_prefix)ÚsigÚsignoder% c C sÚ |j }d|krJ|d d
dkrJ|jdd\}}|j }|dd
j }n|}d}| jjjdd}| jjjd}|}z6y|jdd\}} W n tk
r¦ |} d}Y nX W d| }|rÈ|rÈdj||g}n|dkrØ|rØ|}X |}
|rðdj||g}
||d < ||d
< |
|d < | j } | r(|t j
d| 7 }d} |r8|} n
|rB|} | rt j dd}
x4| jdD ]&}|
t j ||7 }
|
t j
dd7 }
q`W ||
7 }|t jddt j ||7 }| jrÒ|sÈ|t j 7 }n
t|| |
|fS )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éÿÿÿÿr4 )r0 r0 )ÚstripÚsplitÚenvÚ ref_contextÚgetÚrsplitÚ
ValueErrorÚjoinr) r
Zdesc_annotationZ desc_addnameZ
desc_sig_nameZdesc_sig_punctuationZ desc_nameÚ
has_argumentsZdesc_parameterlistr )r' r* r+ ÚmemberZarglistÚprefixÚmod_nameÚnameZ
member_prefixÚ member_namer3 Zdisplay_prefixZ
actual_prefixZaddNameÚpr& r& r( Úhandle_signature1 s\
zJSObject.handle_signatureN)Úname_objr* r+ r% c
C sæ | j jjd}|r|d nd|d }t| j | jjd|}|d j| | j|}|| jjjkrz||d krz|d j| | jjj | t
t | j j d}|j
|| j||d d| jkrâ| j||} | râ| jd jd
| |dd f d S ) Nz js:moduler/ r0 r ÚidsÚjs)Úlocationr$ ÚentriesÚsingle)r7 r8 r9 r ÚstateÚdocumentÚappendÚ make_old_idrF Únote_explicit_targetr ÚJavaScriptDomainÚ
get_domainÚ note_objectÚobjtypeÚoptionsÚget_index_textZ indexnode)
r' rE r* r+ r@ r3 Únode_idÚ old_node_idÚdomainÚ indextextr& r& r( Úadd_target_and_indexo s
z JSObject.add_target_and_index)Ú
objectnamerE r% c C s| |\}}| j dkr2|s"td| S td||f S | j dkrHtd| S | j dkr^td| S | j dkrxtd ||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)r0 )rS r )r' r[ rE rA Úobjr& r& r( rU s
zJSObject.get_index_textc C sh d}| j r4| j j \}}|r&|jdnd}| jr4|}|rd|| jjd< | jrd| jjjdg }|j| dS )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/ z js:objectz
js:objects)ÚnamesÚpopr5 Ú
allow_nestingr7 r8 Ú
setdefaultrM )r' r? Zobj_nameZobj_name_prefixÚobjectsr& r& r( Úbefore_content s zJSObject.before_contentc C s\ | j jjdg }| jr8y |j W n tk
r6 Y nX t|dkrL|d nd| j jd< dS )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:objectr4 )r7 r8 rd rc rb Ú
IndexErrorÚlen)r' re r& r& r( Ú
after_content¸ s
zJSObject.after_content)r3 r% c C s |j ddS )z«Generate old styled node_id for JS objects.
.. note:: Old Styled node_id was used until Sphinx-3.0.
This will be removed in Sphinx-5.0.
ú$Z_S_)Úreplace)r' r3 r& r& r( rN Ë s zJSObject.make_old_id)Ú__name__Ú
__module__Ú __qualname__Ú__doc__r= rc r ÚflagÚ option_specr! r r r) Ústrr r rD rZ rU rf ri rN r& r& r& r( r" s
> $r" c @ sd e Zd ZdZdZededdd d d ed
edd d ddededdd dededdd dgZ dS ) Ú
JSCallablez<Description of a JavaScript function, method or constructor.TÚ argumentsÚ ArgumentsÚargumentÚargÚ parameterÚparamÚfuncÚ paramtypeÚtype)Úlabelra Z typerolenameZ typenamesÚerrorsZThrowsÚthrows)r} Zrolenamera Z can_collapseZ returnvalueZReturnsFÚreturnsr% )r} Úhas_argra Z
returntypez Return typeÚrtypeN)rv rw rx ry )r{ r| )r )r r% )r )
rl rm rn ro r= r r r r Zdoc_field_typesr& r& r& r( rs Ô s
rs c @ s& e Zd ZdZdZee dddZdS )Ú
JSConstructorz,Like a callable but with a different prefix.T)r% c C s t jddt j gS )Nr] )r
Zdesc_sig_keywordZdesc_sig_space)r' r& r& r( r) ë s
z JSConstructor.get_display_prefixN)rl rm rn ro rc r r r) r& r& r& r( r æ s r c @ sR e Zd ZU dZdZdZdZdZdej iZ
e
e e
dddZeed d
d Zd 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 r# )r% c
C s | j d j }|| jjd< d| jk}g }|stt| jjd}t| j| j j
d|}|j || |j |d|| jj
| jfd tjdd|gdd }| j|}|| j j
jkrÂ||d
krÂ|d
j| | j j
j| |j| td | }tjd ||dd fgd
} |j| |S )Nr z js:moduler# rG r1 )rH r0 T)rF ZismodrF z %s (module)rJ )rI )rt r5 r7 r8 rT r rP rQ r rK rL Ú note_modulerR ÚdocnameÚlinenor ÚtargetrN rF rM rO r r
Úindex)
r' r@ r# ÚretrX rV r rW rY Úinoder& r& r( Úrun s(
z JSModule.run)Úmodnamer% c C s d| S )z«Generate old styled node_id for JS modules.
.. note:: Old Styled node_id was used until Sphinx-3.0.
This will be removed in Sphinx-5.0.
zmodule-r& )r' r r& r& r( rN ) s zJSModule.make_old_idN)rl rm rn ro Z has_contentZrequired_argumentsZoptional_argumentsZfinal_argument_whitespacer rp rq r! r r r rr rN r& r& r& r( r ð s
r c @ s, e Zd Zeeeeeeeef dddZdS )Ú
JSXRefRole)r7 ÚrefnodeÚhas_explicit_titleÚtitler r% c C s¢ |j jd|d< |j jd|d< |sv|jd}|jd}|dd
dkrv|dd
}|jd}|d krv||d d
}|dd
dkr|dd
}d|d< ||fS )
Nz js:objectz js:moduler/ ú~r r- TÚ refspecificr4 )r8 r9 ÚlstripÚrfind)r' r7 r r r r Údotr& r& r( Ú process_link3 s
zJSXRefRole.process_linkN) rl rm rn r r
Úboolrr r r r& r& r& r( r 2 s r c
@ s e Zd ZU dZdZdZeeddeeddeeddeed d eed
d eed d
dZe e e
e e e dZ
eddeddedde e e dZi i dZeeeeeeef f f eeeeeeef f dddZd4eeeeddddZeeeeeef f dddZeedd d d Zedd d d!Zee edd"d#d$Z d5e eeeee eeeeeef f d&d'd(Z e ee eee!e"e#e" d)d*d+Z$e ee ee!e"eeee"f d,d-d.Z%e&eeeeeee f dd/d0Z'e"ed1d2d3Z(dS )6rP zJavaScript language domain.rG Z
JavaScriptr\ rz ÚmethodÚmethr] r^ r_ Úattrr1 Úmod)r\ r r] r^ r_ r1 T)Z
fix_parens)rz r r] r^ r r )re Úmodules)r% c C s | j jdi S )Nre )r^ rd )r' r& r& r( re h s zJavaScriptDomain.objectsN)r3 rS rV rH r% c C sJ || j kr2| j | d }tjtd|||||d | jj||f| j |< d S )Nr z.duplicate %s description of %s, other %s in %s)rH )re ÚloggerÚwarningr r7 r )r' r3 rS rV rH r r& r& r( rR l s
z JavaScriptDomain.note_objectc C s | j jdi S )Nr )r^ rd )r' r& r& r( r t s zJavaScriptDomain.modules)r rV r% c C s | j j|f| j|< d S )N)r7 r r )r' r rV r& r& r( r
x s z JavaScriptDomain.note_module)r r% c C sf x0t | jj D ] \}\}}}||kr| j|= qW x.t | jj D ] \}\}}||krB| j|= qBW d S )N)Úlistre Úitemsr )r' r r3 Ú pkg_docnameZ_node_idZ_lr r& r& r( Ú clear_doc{ s zJavaScriptDomain.clear_doc)ÚdocnamesÚ otherdatar% c C sp x6|d j D ]&\}\}}}||kr|||f| j|< qW x2|d j D ]"\}\}}||krF||f| j|< qFW d S )Nre r )r¡ re r ) r' r¤ r¥ r3 ÚfnrV rS r@ r¢ r& r& r( Úmerge_domaindata s z!JavaScriptDomain.merge_domaindatar )r7 r@ r? rA ÚtypÚ searchorderr% c
C s¸ |dd
dkr |d d
}g }|r>|r>|j dj|||g |rV|j dj||g |rn|j dj||g |j | |dkr|j d }x|D ]} | | jkr| }qW || jj|fS )Né z()r/ r éþÿÿÿr« )rM r< Úreversere r9 )
r' r7 r@ r? rA r¨ r© ZsearchesZnewnameÚ search_namer& r& r( Úfind_obj s"
zJavaScriptDomain.find_obj)r7 Ú fromdocnameÚbuilderr¨ r ÚnodeÚcontnoder% c
C s` |j d}|j d} |jdr"dnd}
| j||| |||
\} } | sFd S t||| d | d || S )Nz js:modulez js:objectr r- r )r9 Úhasattrr® r )
r' r7 r¯ r° r¨ r r± r² r@ r? r© rA r` r& r& r( Ú resolve_xref¤ s
z JavaScriptDomain.resolve_xref)r7 r¯ r° r r± r² r% c C sb |j d}|j d}| j||||d d\} }
|
s4g S d| j|
d t|||
d |
d || fgS )Nz js:modulez js:objectr- zjs:rª r )r9 r® Zrole_for_objtyper ) r' r7 r¯ r° r r± r² r@ r? rA r` r& r& r( Úresolve_any_xref¯ s
z!JavaScriptDomain.resolve_any_xrefc c s8 x2t | jj D ] \}\}}}|||||dfV qW d S )Nr- )r re r¡ )r' Zrefnamer rV r¨ r& r& r( Ú get_objectsº s z JavaScriptDomain.get_objects)r± r% c C sD |j d}|j d}|j d}|d kr*d S djtd |||gS d S )Nz js:modulez js:objectZ reftargetr/ )r9 r< Úfilter)r' r± r r? r r& r& r( Úget_full_qualified_name¾ s
z(JavaScriptDomain.get_full_qualified_name)N)r ))rl rm rn ro rA r} r r Z object_typesrs r r" r r r ZrolesZ initial_datar rr r Úpropertyre r rR r r
r£ r r§ r Úintr® r r r
r r´ rµ r r¶ r¸ r& r& r& r( rP F sP
$"
. "rP )Úappr% c C s | j t dddddS )NÚbuiltinrª T)ÚversionZ env_versionZparallel_read_safeZparallel_write_safe)Z
add_domainrP )r» r& r& r( ÚsetupÈ s
r¾ N)?ro Útypingr r r r r r r Zdocutilsr Zdocutils.nodesr
r Zdocutils.parsers.rstr Zsphinxr
Zsphinx.addnodesr r Zsphinx.applicationr Zsphinx.buildersr Zsphinx.directivesr Zsphinx.domainsr r Zsphinx.domains.pythonr Zsphinx.environmentr Z
sphinx.localer r Z sphinx.rolesr Z sphinx.utilr Zsphinx.util.docfieldsr r r Zsphinx.util.docutilsr Zsphinx.util.nodesr r Zsphinx.util.typingr! Ú getLoggerrl r rr r" rs r r r rP r¾ r& r& r& r( Ú<module> s: $
9
B