Mini Shell
3
�2[�N � @ s
d Z dZdZdZdZdZddlZdd lmZ dd
lm Z dd lm
Z
dd lm Z dd
lm Z ddlm
Z
ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ e
j� Zej� Zej� ZG dd� d�Z dS )a$ Each script maintains a set of key bindings, braille bindings, and
AT-SPI event listeners. The key bindings are an instance of
KeyBindings. The braille bindings are also a dictionary where the
keys are BrlTTY command integers and the values are instances of
InputEventHandler. The listeners field is a dictionary where the keys
are AT-SPI event names and the values are function pointers.
Instances of scripts are intended to be created solely by the
script manager.
This Script class is not intended to be instantiated directly.
Instead, it is expected that subclasses of the Script class will be
created in their own module. The module defining the Script subclass
is also required to have a 'getScript(app)' method that returns an
instance of the Script subclass. See default.py for an example.z$Id$z
$Revision$z$Date$z-Copyright (c) 2005-2009 Sun Microsystems Inc.ZLGPL� N� )�braille_generator)�debug)�
event_manager)�
formatting)�label_inference)� keybindings)�
orca_state)�script_manager)�script_utilities)�settings)�settings_manager)�sound_generator)�speech_generator)�structural_navigation)� bookmarks)�tutorialgeneratorc @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� Zd0d1� Zd2d3� Z d4d5� Z d6d7� Z d8d9� Z d:d;� Z d<d=� Z!d>d?� Z"d@dA� Z#dBdC� Z$dDdE� Z%dFdG� Z&dHdI� Z'dJdK� Z(dLS )M�Scriptz:The specific focus tracking scripts for applications.
c C s\ || _ |rNy| j j| _W qT ttfk
rJ d}tjtj|d� d| _Y qTX nd| _| jd| j d 7 _| j� | _ d| _
| j � | _ | j
� | _| j� | _| j� | _| j� | _| j� | _| j� | _i | _i | _| j� | j � | _ | j � | _ | j � | _!| j"� | _#| j$� | _%| j&� | _'i | _(i | _)| j*� | _+| j,� | _-d| _.d| _/d| j }tjtj|d� dS ) z�Creates a script for the given application, if necessary.
This method should not be called by anyone except the
script manager.
Arguments:
- app: the Python Accessible application to create a script for
z*ERROR: Could not get name of script app %sT�defaultz (module=�)FzSCRIPT: %s initializedN)0�app�name� LookupError� RuntimeErrorr �println�
LEVEL_INFO�
__module__� getListeners� listeners�presentIfInactive� getUtilitiesZ utilities�getLabelInferenceZlabelInference�getStructuralNavigation�structuralNavigation�getCaretNavigationZcaretNavigation� getBookmarksr �getLiveRegionManagerZliveRegionManager�getChatZchatZinputEventHandlersZpointOfReference�setupInputEventHandlers�getKeyBindings� keyBindings�getBrailleBindings�brailleBindings�
getFormattingr �getBrailleGeneratorZbrailleGenerator�getSoundGeneratorZsoundGenerator�getSpeechGeneratorZspeechGenerator�generatorCache�
eventCache�
getSpellCheckZ
spellcheck�getTutorialGeneratorZtutorialGeneratorZfindCommandRun�_lastCommandWasStructNav)�selfr �msg� r8 � /usr/lib/python3.6/script.py�__init__E sH
zScript.__init__c C s i S )z�Sets up the AT-SPI event listeners for this script.
Returns a dictionary where the keys are AT-SPI event names
and the values are script methods.
r8 )r6 r8 r8 r9 r ~ s zScript.getListenersc C s dS )zlDefines InputEventHandler fields for this script that can be
called by the key and braille bindings.Nr8 )r6 r8 r8 r9 r( � s z Script.setupInputEventHandlersc C s t j� S )zkDefines the key bindings for this script.
Returns an instance of keybindings.KeyBindings.
)r � KeyBindings)r6 r8 r8 r9 r) � s zScript.getKeyBindingsc C s t j� S )z9Returns the toolkit-specific keybindings for this script.)r r; )r6 r8 r8 r9 �getToolkitKeyBindings� s z Script.getToolkitKeyBindingsc C s t j� S )z=Returns the application-specific keybindings for this script.)r r; )r6 r8 r8 r9 �getAppKeyBindings� s zScript.getAppKeyBindingsc C s i S )z�Defines the braille bindings for this script.
Returns a dictionary where the keys are BrlTTY commands and the
values are InputEventHandler instances.
r8 )r6 r8 r8 r9 r+ � s zScript.getBrailleBindingsc C s
t j| �S )z/Returns the formatting strings for this script.)r Z
Formatting)r6 r8 r8 r9 r- � s zScript.getFormattingc C s
t j| �S )z7Returns the braille generator for this script.
)r ZBrailleGenerator)r6 r8 r8 r9 r. � s zScript.getBrailleGeneratorc C s
t j| �S )z,Returns the sound generator for this script.)r ZSoundGenerator)r6 r8 r8 r9 r/ � s zScript.getSoundGeneratorc C s
t j| �S )z6Returns the speech generator for this script.
)r ZSpeechGenerator)r6 r8 r8 r9 r0 � s zScript.getSpeechGeneratorc C s
t j| �S )z8Returns the tutorial generator for this script.
)r ZTutorialGenerator)r6 r8 r8 r9 r4 � s zScript.getTutorialGeneratorc C s dS )z2Returns the 'chat' class for this script.
Nr8 )r6 r8 r8 r9 r' � s zScript.getChatc C s dS )z/Returns the spellcheck support for this script.Nr8 )r6 r8 r8 r9 r3 � s zScript.getSpellCheckc C s dS )z5Returns the caret navigation support for this script.Nr8 )r6 r8 r8 r9 r$ � s zScript.getCaretNavigationc C s
t j| �S )z.Returns the utilites for this script.
)r Z Utilities)r6 r8 r8 r9 r � s zScript.getUtilitiesc C s
t j| �S )z:Returns the label inference functionality for this script.)r ZLabelInference)r6 r8 r8 r9 r! � s zScript.getLabelInferencec C s g S )zaReturns a list of the structural navigation object types
enabled in this script.
r8 )r6 r8 r8 r9 �#getEnabledStructuralNavigationTypes� s z*Script.getEnabledStructuralNavigationTypesc C s | j � }tjd�}tj| ||�S )z:Returns the 'structural navigation' class for this script.ZstructuralNavigationEnabled)r> �_settingsManagerZ
getSettingr ZStructuralNavigation)r6 �types�enabler8 r8 r9 r" � s
z Script.getStructuralNavigationc C s dS )z0Returns the live region support for this script.Nr8 )r6 r8 r8 r9 r& � s zScript.getLiveRegionManagerc C s | j jS )a5 Returns True if we should use structural navigation. Most
scripts will have no need to override this. Gecko does however
because within an HTML document there are times when we do want
to use it and times when we don't even though it is enabled,
e.g. in a form field.
)r# Zenabled)r6 r8 r8 r9 � useStructuralNavigationModel� s z#Script.useStructuralNavigationModelc C s. y| j S tk
r( t j| �| _ | j S X dS )z7Returns the "bookmarks" class for this script.
N)r �AttributeErrorZ Bookmarks)r6 r8 r8 r9 r% � s
zScript.getBookmarksc C s dS )zxReturn a GtkGrid containing the application unique configuration
GUI items for the current application.
Nr8 )r6 r8 r8 r9 �getAppPreferencesGUI� s zScript.getAppPreferencesGUIc C s i S )z7Returns a dictionary with the app-specific preferences.r8 )r6 r8 r8 r9 �getPreferencesFromGUI� s z Script.getPreferencesFromGUIc C s t j| � dS )z�Tells the event manager to start listening for all the event types
of interest to the script.
Arguments:
- script: the script.
N)�
_eventManagerZregisterScriptListeners)r6 r8 r8 r9 �registerEventListeners� s z Script.registerEventListenersc C s t j| � dS )z�Tells the event manager to stop listening for all the event types
of interest to the script.
Arguments:
- script: the script.
N)rF ZderegisterScriptListeners)r6 r8 r8 r9 �deregisterEventListeners s z Script.deregisterEventListenersc C s� y|j j� }W n2 ttfk
r@ d|j }tjtj|d� dS X tj| kpP| j }|t
j krr| rrt j
t jkrrd}|szdS | j|�r�dS i | _x,| jj� D ] }|jj|�r�| j| |� q�W dS )a{ Processes all AT-SPI object events of interest to this
script. The interest in events is specified via the
'listeners' field that was defined during the construction of
this script.
Note that this script may be passed events it doesn't care
about, so it needs to react accordingly.
Arguments:
- event: the Event
z$ERROR: Exception getting role for %sTN)�sourceZgetRoler r r r r r Z activeScriptr �pyatspiZROLE_PROGRESS_BARr ZprogressBarVerbosityZPROGRESS_BAR_ALL�skipObjectEventr1 r �keys�type�
startswith)r6 �eventZroler7 Z processEvent�keyr8 r8 r9 �processObjectEvent s(
zScript.processObjectEventc C s@ | j j|jddg�\}}| s&||kr*dS dg}ddg}ddd d
g}d}|j|ks\|j|krr|j|jkrrd }d }n�|j|kr�|j|jkr�|j|jkr�|j|jkr�d }d
}n\|jjd�r�|j|jkr�d }d}n:|jjd�o�|j|jko�|j|jko�|j|jk�rd }d}|�r<dt|�jdd� } d|| f }
t j
t j |
d � |S )a Gives us, and scripts, the ability to decide an event isn't
worth taking the time to process under the current circumstances.
Arguments:
- event: the Event
Returns True if we shouldn't bother processing this object event.
Nr Fz object:state-changed:focusedzobject:text-changed:insertzobject:text-changed:deletezobject:text-caret-movedz object:text-selection-changedzobject:selection-changedz object:active-descendant-changedTz5more recent event of the same type in the same objectz8more recent event of the same type in a different object�systemz+more recent system event in the same objectzobject:state-changedz+appears to be duplicate state-changed eventz
%s� � � z*SCRIPT: Skipping object event due to %s
%sz ) r2 �getrM rI Zdetail1�endswithrN �str�replacer r r ) r6 rO Z cachedEventZ eventTimeZfocusZtypingZarrowing�skip�reasonZ eventDetailsr7 r8 r8 r9 rK P s>
zScript.skipObjectEventc
C sJ y ddl m} |j|j�|_W n& d|j }tjtj|d� Y nX dS )a� Checks the data on the keyboard event.
Some toolkits don't fill all the key event fields, and/or fills
them out with unexpected data. This method tries to fill in the
missing fields and validate/standardize the data we've been given.
While any script can override this method, it is expected that
this will only be done at the toolkit script level.
Arguments:
- keyboardEvent: an instance of input_event.KeyboardEvent
r )�Gdkz/ERROR: Exception getting keyval_name for id: %dTN)Z
gi.repositoryr\ Z keyval_name�idr r r )r6 �
keyboardEventr\ r7 r8 r8 r9 �checkKeyboardEventData~ s
z Script.checkKeyboardEventDatac C s� d}t j}| j|kr || j }nd|kr0|d }d}d| _|rv|j|�}|rn|j| jjkrn| j� }|rvd| _n|dk }|s�| j j|�}|r�|j| jjkr�| j� }|r�d| _n|dk }|S )z�Called when a key is pressed on the keyboard.
Arguments:
- keyboardEvent: an instance of input_event.KeyboardEvent
Returns True if the event is of interest.
Nr FT)
r ZkeyBindingsMapr r5 ZgetInputHandlerZfunctionr# Z functionsrB r* )r6 r^ �
user_bindings�user_bindings_map�consumes�handlerr8 r8 r9 �consumesKeyboardEvent� s2
z Script.consumesKeyboardEventc C s\ d}t j}| j|kr || j }nd|kr0|d }|jd }d}|rJ||k}|sX|| jk}|S )z�Called when a key is pressed on the braille display.
Arguments:
- brailleEvent: an instance of input_event.KeyboardEvent
Returns True if the event is of interest.
Nr �commandF)r �brailleBindingsMapr rO r, )r6 � brailleEventr` ra re rb r8 r8 r9 �consumesBrailleEvent� s
zScript.consumesBrailleEventc C s� | |_ d}d}|jd }tj}| j|kr4|| j }nd|krD|d }|rd||krd|| }|j| |�}| r�|| jkr�| j| }|j| |�}|S )a� Called whenever a key is pressed on the Braille display.
This method will primarily use the brailleBindings field of
this script instance see if this script has an interest in the
event.
NOTE: there is latent, but unsupported, logic for allowing
the user's user-settings.py file to extend and/or override
the brailleBindings for a script.
Arguments:
- brailleEvent: an instance of input_event.BrailleEvent
FNre r )ZscriptrO r rf r ZprocessInputEventr, )r6 rg �consumedr` re ra rc r8 r8 r9 �processBrailleEvent� s
zScript.processBrailleEventc C s dS )a= Called when the visual object with focus changes.
The primary purpose of this method is to present locus of focus
information to the user.
NOTE: scripts should not call this method directly. Instead,
a script should call orca.setLocusOfFocus, which will eventually
result in this method being called.
Arguments:
- event: if not None, the Event that caused the change
- oldLocusOfFocus: Accessible that is the old locus of focus
- newLocusOfFocus: Accessible that is the new locus of focus
Nr8 )r6 rO ZoldLocusOfFocusZnewLocusOfFocusr8 r8 r9 �locusOfFocusChanged s zScript.locusOfFocusChangedc C s dS )a� Returns True if the given event is one that should cause this
script to become the active script. This is only a hint to
the focus tracking manager and it is not guaranteed this
request will be honored. Note that by the time the focus
tracking manager calls this method, it thinks the script
should become active. This is an opportunity for the script
to say it shouldn't.
Tr8 )r6 rO r8 r8 r9 �isActivatableEvent s zScript.isActivatableEventc C s dS )z%Called when this script is activated.Nr8 )r6 r8 r8 r9 �activate s zScript.activatec C s dS )z'Called when this script is deactivated.Nr8 )r6 r8 r8 r9 �
deactivate s zScript.deactivatec C s i S )Nr8 )r6 r8 r8 r9 �getTransferableAttributes$ s z Script.getTransferableAttributesN))�__name__r � __qualname__�__doc__r: r r( r) r< r= r+ r- r. r/ r0 r4 r' r3 r$ r r! r> r" r& rB r% rD rE rG rH rQ rK r_ rd rh rj rk rl rm rn ro r8 r8 r8 r9 r A sL 9
5.&1 r ) rr Z__id__� __version__Z__date__Z
__copyright__Z __license__rJ � r r r r r r r r
r r r
r r r r r Z
getManagerrF Z_scriptManagerr? r r8 r8 r8 r9 �<module>" s4