|
Server : Apache System : Linux iad1-shared-b8-43 6.6.49-grsec-jammy+ #10 SMP Thu Sep 12 23:23:08 UTC 2024 x86_64 User : dh_edsupp ( 6597262) PHP Version : 8.2.26 Disable Function : NONE Directory : /lib/python3/dist-packages/sphinx/domains/__pycache__/ |
Upload File : |
o
�$�a�F � @ 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(�4e5�Z6G dd� deee7e7f �Z8G dd� de8�Z9G dd� de9�Z:G dd � d e.�Z;G d d � d e&�Z<G d d � d e �Z=d!ed"ee7ef fd#d$�Z>d%S )&z�
sphinx.domains.javascript
~~~~~~~~~~~~~~~~~~~~~~~~~
The JavaScript domain.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� )�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 dZdZdZejejd�Ze e
d< de e fdd�Z
ded edeeef fd
d �Zd eeef ded edd
fdd�Zded eeef defdd�Zddd�Zddd�Zdedefdd�Zd
S )�JSObjectz-
Description of a JavaScript object.
F)�noindex� noindexentry� option_spec�returnc C s g S �N� ��selfr( r( �;/usr/lib/python3/dist-packages/sphinx/domains/javascript.py�get_display_prefix5 s zJSObject.get_display_prefix�sig�signodec
C s� |� � }d|v r%|dd� dkr%|�dd�\}}|� � }|dd� � � }n|}d}| jj�dd�}| jj�d�}|}z0z
|�dd�\}} W n
tyR |} d }Y nw W | }|rb|rbd�||g�}n |du rj|rj|}n| }|ry|ryd�||g�}w |du r�|r�|}w |}
|r�d�||g�}
||d
< ||d < |
|d < | �� } | r�|t j
d d g| �R � 7 }d} |r�|} n|r�|} | r�t � d d �}
| �d�D ]}|
t � ||�7 }
|
t �
dd�7 }
q�||
7 }|t �d d t � ||��7 }| jr�|s�|t �� 7 }|
|fS 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�)� � js:object� js:module�.� �module�object�fullname)�strip�split�env� ref_context�get�rsplit�
ValueError�joinr, r
�desc_annotation� desc_addname�
desc_sig_name�desc_sig_punctuation� desc_name�
has_arguments�desc_parameterlistr )r* r- r. �member�arglist�prefix�mod_name�name�
member_prefix� member_namer9 �display_prefix�
actual_prefix�addName�pr( r( r+ �handle_signature9 sp �� �� �
�zJSObject.handle_signature�name_objNc
C s� | j j�d�}|r
|d nd|d }t| j | jjd|�}|d �|� | �|�}|| jjjvr=||d vr=|d �|� | jj� |� t
t | j � d��}|j
|| j||d� d| jvrs| �||�} | ru| jd �d
| |dd f� d S d S d S ) Nr4 r5 r6 r �ids�js��locationr$ �entries�single)r< r= r> r �state�document�append� make_old_idrV �note_explicit_targetr �JavaScriptDomain�
get_domain� note_object�objtype�options�get_index_text� indexnode)
r* rU r- r. rL r9 �node_id� old_node_id�domain� indextextr( r( r+ �add_target_and_indexw s
�z JSObject.add_target_and_index�
objectnamec C s| |\}}| j dkr|std�| S td�||f S | j dkr$td�| S | j dkr/td�| S | j dkr<td �||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)r6 )rd r )r* rm rU rM �objr( r( r+ rf � s
zJSObject.get_index_textc C sp d}| j r| j �� \}}|r|�d�nd}| jr|}|r4|| jjd< | jr6| jj�dg �}|�|� dS dS 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
Nr5 r3 �
js:objects)�names�popr: �
allow_nestingr< r= �
setdefaultr^ )r* rK �obj_name�obj_name_prefix�objectsr( r( r+ �before_content� s �zJSObject.before_contentc C sZ | j j�dg �}| jrz|�� W n ty Y nw t|�dkr%|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`.
rs r r0 Nr3 )r< r= rw rv ru �
IndexError�len)r* rz r( r( r+ �
after_content� s
��zJSObject.after_contentr9 c C s |� dd�S )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.
�$�_S_)�replace)r* r9 r( r( r+ r_ � s zJSObject.make_old_id)r& N)�__name__�
__module__� __qualname__�__doc__rG rv r �flagr% r! �__annotations__r r r, �strr r rT rl rf r{ r~ r_ r( r( r( r+ r" $ s$
� >�
�
$r" c @ sd e Zd ZdZdZeded�dddd�ed ed
�dd dd �ed
ed�ddd�eded�ddd�gZ dS )�
JSCallablez<Description of a JavaScript function, method or constructor.T� arguments� Arguments)�argument�arg� parameter�param�func)� paramtype�type)�labelrt � typerolename� typenames�errors�Throws)�throws)r� �rolenamert � can_collapse� returnvalue�ReturnsF)�returnsr& )r� �has_argrt �
returntypez Return type)�rtypeN)
r� r� r� r� rG r r r r �doc_field_typesr( r( r( r+ r� � s$
� � � ��r� c @ s& e Zd ZdZdZdee fdd�ZdS )�
JSConstructorz,Like a callable but with a different prefix.Tr& c C s t �dd�t �� gS )Nro )r
�desc_sig_keyword�desc_sig_spacer) r( r( r+ r, � s
�z JSConstructor.get_display_prefixN)r� r� r� r� rv r r r, r( r( r( r+ r� � s r� c @ sX e Zd ZU dZdZdZdZdZdej iZ
e e d< de
e fdd �Zd
edefd 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
Fr2 r r# r% r& c
C s
| j d �� }|| jjd< d| jv }g }|s�tt| j�d��}t| j| j j
d|�}|� ||� |j |d|| jj
| jfd� tjdd|gdd �}| �|�}|| j j
jvr`||d
vr`|d
�|� | j j
�|� |�|� td �| }tjd ||dd fgd
�} |�| � |S )Nr r4 r# rW r7 rX r6 T)rV �ismodrV z %s (module)r[ )rZ )r� r: r< r= re r ra rb r r\ r] � note_modulerc �docname�linenor �targetr_ rV r^ r` r r
�index)
r* rL r# �retrj rh r� ri rk �inoder( r( r+ �run s*
�
z JSModule.run�modnamec 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+ r_ 1 s zJSModule.make_old_idN)r� r� r� r� � has_content�required_arguments�optional_arguments�final_argument_whitespacer r� r% r! r� r r r� r� r_ r( r( r( r+ r� � s
� r� c @ s6 e Zd Zdedededededeeef f dd�Zd S )
�
JSXRefRoler< �refnode�has_explicit_title�titler� r& c C s� |j �d�|d< |j �d�|d< |s;|�d�}|�d�}|dd� dkr;|dd � }|�d�}|dkr;||d d � }|dd� dkrM|dd � }d|d < ||fS )
Nr3 r4 r5 �~r r2 r0 T� refspecific)r= r> �lstrip�rfind)r* r< r� r� r� r� �dotr( r( r+ � process_link; s
zJSXRefRole.process_linkN) r� r� r� r r
�boolr� r r� r( r( r( r+ r� : s
���
�r� c @ sH e Zd ZU dZdZdZeed�d�eed�d�eed�d�eed �d �eed
�d �eed �d
�d�Ze e e
e e e d�Z
edd�edd�edd�e� e� e� d�Zi i d�Zeeeeeeef f f ed< edeeeeeef f fdd��Z d@dededededdf
d d �Zedeeeeef f fd d ��Zd ededdfd!d"�Zd#eddfd$d%�Zd&e e d'eddfd(d)�Z *dAd+e d,ed-ed.ed/ed0e deeeeeef f fd1d2�Z d+e d3ed4e!d/ed5ed6e"d7e#de$e# fd8d9�Z%d+e d3ed4e!d5ed6e"d7e#de eee#f fd:d;�Z&de'eeeeeee f fd<d=�Z(d6e#defd>d?�Z)dS )Bra zJavaScript language domain.rW �
JavaScriptrn r� �method�methro rp rq �attrr7 �mod)rn r� ro rp rq r7 T)�
fix_parens)r� r� ro rp r� r� )rz �modules� initial_datar& c C � | j �di �S )Nrz �rp rw r) r( r( r+ rz p � zJavaScriptDomain.objectsNr9 rd rh rY c C sJ || j v r| j | d }tjtd�|||||d� | jj||f| j |< d S )Nr z.duplicate %s description of %s, other %s in %srX )rz �logger�warningr r< r� )r* r9 rd rh rY r� r( r( r+ rc t s
�z JavaScriptDomain.note_objectc C r� )Nr� r� r) r( r( r+ r� | r� zJavaScriptDomain.modulesr� c C s | j j|f| j|< d S r' )r< r� r� )r* r� rh r( r( r+ r� � s z JavaScriptDomain.note_moduler� c C s^ t | j�� �D ]\}\}}}||kr| j|= qt | j�� �D ]\}\}}||kr,| j|= q d S r' )�listrz �itemsr� )r* r� r9 � pkg_docnamerh �_lr� r( r( r+ � clear_doc� s ���zJavaScriptDomain.clear_doc�docnames� otherdatac C sh |d � � D ]\}\}}}||v r|||f| j|< q|d � � D ]\}\}}||v r1||f| j|< q d S )Nrz r� )r� rz r� ) r* r� r� r9 �fnrh rd rL r� r( r( r+ �merge_domaindata� s ���z!JavaScriptDomain.merge_domaindatar r< rL rK rM �typ� searchorderc
C s� |dd � dkr|d d� }g }|r |r |� d�|||g�� |r+|� d�||g�� |r7|� d�||g�� |� |� |dkrD|�� d }|D ] } | | jv rQ| }qH|| j�|�fS )N���z()r5 r )r^ rA �reverserz r> )
r* r< rL rK rM r� r� �searches�newname� search_namer( r( r+ �find_obj� s$
�zJavaScriptDomain.find_obj� fromdocname�builderr� �node�contnodec
C s` |� d�}|� d�} |�d�rdnd}
| �||| |||
�\} } | s#d S t||| d | d || �S )Nr4 r3 r� r2 r )r> �hasattrr� r )
r* r< r� r� r� r� r� r� rL rK r� rM rr r( r( r+ � resolve_xref� s
z JavaScriptDomain.resolve_xrefc C sb |� d�}|� d�}| �||||d d�\} }
|
sg S d| �|
d � t|||
d |
d || �fgS )Nr4 r3 r2 zjs:� r )r> r� �role_for_objtyper ) r* r< r� r� r� r� r� rL rK rM rr r( r( r+ �resolve_any_xref� s
�z!JavaScriptDomain.resolve_any_xrefc c s6 � t | j�� �D ]\}\}}}|||||dfV qd S )Nr2 )r� rz r� )r* �refnamer� rh r� r( r( r+ � get_objects� s � �z JavaScriptDomain.get_objectsc C s@ |� d�}|� d�}|� d�}|d u rd S d�td |||g��S )Nr4 r3 � reftargetr5 )r> rA �filter)r* r� r� rK r� r( r( r+ �get_full_qualified_name� s
z(JavaScriptDomain.get_full_qualified_namer' )r )*r� r� r� r� rM r� r r � object_typesr� r� r" r� r r� �rolesr� r r� r r� �propertyrz r rc r� r� r� r r� r �intr� r r r
r r� r� r r� r� r( r( r( r+ ra N s�
� � � &�"��
�
���
�����
� ���
�" ra �appr& c C s | � t� ddddd�S )N�builtinr� T)�version� env_version�parallel_read_safe�parallel_write_safe)�
add_domainra )r� r( r( r+ �setup� s
�r� N)?r� �typingr r r r r r r �docutilsr �docutils.nodesr
r �docutils.parsers.rstr �sphinxr
�sphinx.addnodesr r �sphinx.applicationr �sphinx.buildersr �sphinx.directivesr �sphinx.domainsr r �sphinx.domains.pythonr �sphinx.environmentr �
sphinx.localer r � sphinx.rolesr � sphinx.utilr �sphinx.util.docfieldsr r r �sphinx.util.docutilsr �sphinx.util.nodesr r �sphinx.util.typingr! � getLoggerr� r� r� r" r� r� r� r� ra r� r( r( r( r+ �<module> s< $
9
B