Mini Shell
3
�2[5Q � @ s� d Z dZdZdZdZdZddlZdd lmZ dd
lm Z dd lm
Z
dd lm Z dd
lm Z ddlm
Z
ddlmZ ddlmZ ddlmZ ej� ZG dd� d�Ze� gZG dd� de
j�ZdS )z:Utilities for obtaining braille presentations for objects.z$Id$z
$Revision$z$Date$z-Copyright (c) 2005-2009 Sun Microsystems Inc.ZLGPL� N� )�braille)�debug)� generator)�messages)�object_properties)�
orca_state)�settings)�settings_manager)�shortRoleNamesc @ s e Zd ZdZddd�ZdS )�SpacezxA dummy class to indicate we want to insert a space into an
utterance, but only if there is text prior to the space.� c C s
|| _ d S )N)� delimiter)�selfr � r �'/usr/lib/python3.6/braille_generator.py�__init__- s zSpace.__init__N)r
)�__name__�
__module__� __qualname__�__doc__r r r r r r * s r c s� e Zd ZdZejejejejfZ dd� Z
dd� Z dd� Z dd � Z
� fd
d �Zd d
� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zd d � Z� fd d �Z� fd d!�Zd"d#� Zd$d%� Zd&d'� Z d(d)� Z d/d+d,�Z d0d-d.�Z � Z S )1�BrailleGeneratora Takes accessible objects and produces a list of braille Regions
for those objects. See the generateBraille method, which is the
primary entry point. Subclasses can feel free to override/extend
the brailleGenerators instance field as they see fit.c C s t jj| |d� d S )Nr )r � Generatorr )r Zscriptr r r r = s zBrailleGenerator.__init__c C sN t jj| |� | j|d< tj|d< tj|d< tj|d< tj|d< | j |d< dS )zCOther things to make available from the formatting string.
�space� Component�Region�Text�Link�asStringN)
r r � _addGlobalsr r r r r r r )r Z globalsDictr r r r @ s
z BrailleGenerator._addGlobalsc K s$ t jd� r.t jd� r.tjtjd� g d gS |tjkrN|jdd � rNd|d< | j|f|�}y |d }W n d }Y nX x�|D ]�}y |j � }W n d }Y nX t
|t j t j
f�r�|j|kr�|}P q�t
|t j
�r�|tjkr�|jj|kr�|}P q�t
|t j �r�|tjkr�|jj|kr�|}P q�W ||gS )NZ
enableBrailleZenableBrailleMonitorz BRAILLE: generation disabledZ
formatTypeZfocusedr )�_settingsManager�
getSettingr ZprintlnZ
LEVEL_INFOr Z locusOfFocus�get�generate�getRole�
isinstancer r r Z
accessible�pyatspi�ROLE_COMBO_BOX�parentZROLE_TABLE_CELL)r �obj�args�resultZ
focusedRegionZregion�roler r r �generateBrailleK s@
z BrailleGenerator.generateBraillec K s� |j d�rtjd� rg S g }|j d|j� �}tjd�}tjtjtjtjg}|j rp|j j� tj
krp|j |j� � |t j
kr�|jtjtjg� |tjkr�| jjj|�}|j tj| � n4|t jkr�|j dd� r�||kr�|j | j|f|�� |S )a Returns the role name for the object in an array of strings, with
the exception that the pyatspi.ROLE_UNKNOWN role will yield an
empty array. Note that a 'role' attribute in args will
override the accessible role of the obj.
�isProgressBarUpdate�brailleProgressBarUpdatesr, �brailleVerbosityLevelZ
readingRowF)r" r r! r$ r& Z ROLE_UNKNOWN� ROLE_FILLERZ
ROLE_EXTENDEDZ ROLE_LINKr( �
ROLE_LIST_BOX�appendr �VERBOSITY_LEVEL_BRIEF�extendZ ROLE_ICONZ ROLE_CANVASZ ROLE_HEADING�_script� utilitiesZ headingLevelr ZROLE_HEADING_LEVEL_BRAILLEZVERBOSITY_LEVEL_VERBOSE�getLocalizedRoleName)r r) r* r+ r, �verbosityLevelZ doNotPresent�levelr r r �_generateRoleName s*
z"BrailleGenerator._generateRoleNamec sB t jd�tjkr2|jd|j� �}tj|�}|r2|S t� j|f|�S )z�Returns the localized name of the given Accessible object; the name
is suitable to be brailled.
Arguments:
- obj: an Accessible object
ZbrailleRolenameStyler, ) r r! r Z BRAILLE_ROLENAME_STYLE_SHORTr" r$ r �superr8 )r r) r* r, �rv)� __class__r r r8 � s
z%BrailleGenerator.getLocalizedRoleNamec K s< g }| j jj|�}x$|D ] }| j|f|�}|j|� qW |S )N)r6 r7 ZunrelatedLabels�
_generateNamer5 )r r) r* r+ Zlabels�label�namer r r �_generateUnrelatedLabels� s
z)BrailleGenerator._generateUnrelatedLabelsc K sJ t jd�}|tjkrg S g }| jjj|�\}}}|rF|jd| d � |S )z�Returns an array of strings (and possibly voice and audio
specifications) that represent the accelerator for the object,
or an empty array if no accelerator can be found.
r0 �(�))r r! r r4 r6 r7 ZmnemonicShortcutAcceleratorr3 )r r) r* r9 r+ ZmnemonicZshortcutZ acceleratorr r r �_generateAccelerator� s
z%BrailleGenerator._generateAcceleratorc K sD g }y| j jj|�}W n d}Y nX |dkr@|jtj|�� |S )z�Returns an array of strings that says how many alerts and dialogs
are associated with the application for this object. [[[WDW -
I wonder if this string should be moved to settings.py.]]]
r )r6 r7 Z unfocusedAlertAndDialogCountr3 r ZdialogCountBraille)r r) r* r+ ZalertAndDialogCountr r r � _generateAlertAndDialogCount� s
z-BrailleGenerator._generateAlertAndDialogCountc K s� g }t jd�s|S d|d< |jd|j� �}|tjk}|j}|rR|j� | jkrR|j}�x$|ob|j|k�rxg }y |j� }W n d}Y nX |r�|tjkr�|tj kr�|tj
kr�|tj kr�| j j
j|� r�||d< | j|f|�}|tjtjgk�r<| j j
j|�}|�r<t|��r<|j� �r<|�s8|j� |d< | j|f|�}nd}|�rX|�rX|jtjd�� |j|� |tjk�rpP |j}qVW |j� |S )aE Returns an array of strings (and possibly voice and audio
specifications) that represent the text of the ancestors for
the object. This is typically used to present the context for
an object (e.g., the names of the window, the panels, etc.,
that the object is contained in). If the 'priorObj' attribute
of the args dictionary is set, only the differences in
ancestry between the 'priorObj' and the current obj will be
computed. The 'priorObj' is typically set by Orca to be the
previous object with focus.
�enableBrailleContextF�includeContextr, Nr
)r r! r" r$ r& �ROLE_RADIO_BUTTONr( �SKIP_CONTEXT_ROLESr1 Z ROLE_SECTIONZROLE_SPLIT_PANEZROLE_DESKTOP_FRAMEr6 r7 Z isLayoutOnlyr# Z
ROLE_PANELZdisplayedLabel�len�isspacer3 r r r5 Z
ROLE_EMBEDDED�reverse) r r) r* r+ r, ZexcludeRadioButtonGroupr( Z parentResultr@ r r r �_generateAncestors� sJ
z#BrailleGenerator._generateAncestorsc K s� g }|j d|j� �}|tjtjgkr(|S dtj|�krF| jjj|�}n| jjj |�g}|o`|d sf|S x t
| j |�D ]}|j |� qtW |S )Nr, Z Selectionr )
r" r$ r& Z ROLE_LISTr2 ZlistInterfacesr6 r7 ZselectedChildrenZ focusedChild�mapr? r5 )r r) r* r+ r, �items�itemr r r �_generateFocusedItem3 s z%BrailleGenerator._generateFocusedItemc s� t jt jt jt jt jt jg� � fdd�}g }|jr�|jj� t j kr�t j
||�}x0|D ](}|j | j |dd�� |j
tjd�� qTW |S )Nc s | o| j � � kS )N)r$ )�x)� widgetRolesr r �<lambda>L s z>BrailleGenerator._generateListBoxItemWidgets.<locals>.<lambda>F)rH r
)r& ZROLE_CHECK_BOXr' ZROLE_PUSH_BUTTONrI Z ROLE_SLIDERZROLE_TOGGLE_BUTTONr( r$ r2 ZfindAllDescendantsr5 r# r3 r r )r r) r* ZisWidgetr+ ZwidgetsZwidgetr )rT r �_generateListBoxItemWidgetsE s
z,BrailleGenerator._generateListBoxItemWidgetsc K sR |j d� s | j|f|� r g S | j� \}}}||krN| j|�\}}d| gS g S )Nr. z%s)r" � _shouldPresentProgressBarUpdateZ _getMostRecentProgressBarUpdateZ getProgressBarNumberAndCount)r r) r* ZaccZ
updateTimeZ updateValueZnumber�countr r r �_generateProgressBarIndexV s
z*BrailleGenerator._generateProgressBarIndexc K s, |j d�r | j|f|� r g S | j|f|�S )Nr. )r" rW �_generatePercentage)r r) r* r r r �_generateProgressBarValueb s
z*BrailleGenerator._generateProgressBarValuec K s$ | j jj|�}|d k r d| gS g S )Nz%s%%)r6 r7 ZgetValueAsPercent)r r) r* Zpercentr r r rZ i s
z$BrailleGenerator._generatePercentagec s$ t jd�}|d kr t� j� S t|�S )NZprogressBarBrailleInterval)r r! r< � _getProgressBarUpdateInterval�int)r Zinterval)r> r r r\ p s
z.BrailleGenerator._getProgressBarUpdateIntervalc s t jd�sdS t� j|f|�S )Nr/ F)r r! r< rW )r r) r* )r> r r rW w s
z0BrailleGenerator._shouldPresentProgressBarUpdatec K s� g }y |j � }W n g }Y nX x:|D ]2}|j� tjkr(|jd�}|j| j|f|�� P q(W |s�| jd|�}|j| j|f|�� | j||� |S )z�If this scroll pane is labelled by a page tab, then return the page
tab information for the braille context instead. Thunderbird
folder properties is such a case. See bug #507922 for more
details.
r ZREAL_ROLE_SCROLL_PANE) �getRelationSet�getRelationTyper& ZRELATION_LABELLED_BY� getTargetr5 r# Z
_overrideRoleZ _restoreRole)r r) r* r+ Z relations�relationZ
labelledByZoldRoler r r � _generateAsPageTabOrScrollPane� s
z/BrailleGenerator._generateAsPageTabOrScrollPanec K sN g }d}x"|D ]}|r|j � tjkr|}qW |rJ|j� jtj�rJ|j|� |S )a� For a combo box, we check to see if the text is editable. If so,
then we want to show the text attributes (such as selection --
see bug 496846 for more details). This will return an array
containing a single object, which is the accessible for the
text object. Note that this is different from the rest of the
generators, which all return an array of strings. Yes, this
is a hack.
N)r$ r& Z ROLE_TEXTZgetState�containsZSTATE_EDITABLEr3 )r r) r* r+ ZtextObjZchildr r r �_generateComboBoxTextObj� s
z)BrailleGenerator._generateComboBoxTextObjc K s� |j d�rdS tjd�}|s |S y |j� }W n tk
rD d}Y nX |r�| jjj|�sh|j� t j
gkr�y|j |j t j
�\}}}W n
|S |dk}|r�x4|j� D ](}|j� t jkr�| jjj|jd�� }q�W |S )z]Returns True or False to indicate whether context should be
included or not.
r. FrG Nr )r" r r! Z queryText�NotImplementedErrorr6 r7 Z
isTextArear$ r& Z
ROLE_LABELZgetTextAtOffsetZ caretOffsetZTEXT_BOUNDARY_LINE_STARTr^ r_ ZRELATION_FLOWS_FROMr` ) r r) r* �include�textZ
lineStringZ startOffsetZ endOffsetra r r r �_generateIncludeContext� s0
z(BrailleGenerator._generateIncludeContextc K sF g }t jd�sB|jdd �s$| j|d< d|d< |j| jjjf |�� |S )NZdisableBrailleEOL�modeZeolZ
stringType)r r! r" �_moder3 r6 Z
formattingZ getString)r r) r* r+ r r r � _generateEol� s
z BrailleGenerator._generateEolr
c C s |dkr t S t|�gS d S )Nr
)�SPACEr )r r r r r r � s zBrailleGenerator.spacec C s� d}d }t |t�r|}n�|r�t |t�r�x"|rHt |d t�rH|dd � }q(W x"|rlt |d t�rl|dd� }qLW xF|D ]>}t |t�r�|r�||j7 }d }qt| j|�}| jjj|||�}qtW |S )N� r r ���rn ) r% �str�listr r r r6 r7 Z appendString)r Zcontentr ZcombinedZprior�elementr r r r � s"
zBrailleGenerator.asString)r
)r
)!r r r r r& Z ROLE_MENUZ
ROLE_MENU_BARZROLE_PAGE_TAB_LISTr' rJ r r r- r; r8 rB rE rF rN rR rV rY r[ rZ r\ rW rb rd rh rk r r �
__classcell__r r )r> r r 2 s6 4$ I *
r )r Z__id__� __version__Z__date__Z
__copyright__Z __license__r& rm r r r r r r r r
Zbraille_rolenamesr Z
getManagerr r rl r r r r r r �<module> s&