Mini Shell
3
�2[�� � @ 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�ZG dd� d�ZG dd� d�ZG dd� d�ZdS )z Implements generic chat support.z$Id$z
$Revision$z$Date$z%Copyright (c) 2010-2011 The Orca TeamZLGPL� N� )�cmdnames)�debug)� guilabels)� input_event)� keybindings)�messages)�
orca_state)�settings)�settings_managerc @ sD e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dS )�RingListc C s g | _ d| _|| _d| _d S )Nr )�__data__�__full__�__max__�__cur__)�selfZlength� r �/usr/lib/python3.6/chat.py�__init__4 s zRingList.__init__c C sz | j dkrJx,td| jd �D ]}| j|d | j|< q W || j| jd < n,| jj|� | jd7 _| j| jkrvd| _ d S )Nr r )r �ranger r
�appendr )r �x�ir r r r : s
zRingList.appendc C s | j S )N)r
)r r r r �getE s z RingList.getc C s* | j dkr&| j| j d = | j d8 _ d S )Nr r )r r
)r r r r �removeH s
zRingList.removec C s | j S )N)r )r r r r �sizeM s z
RingList.sizec C s | j S )N)r )r r r r �maxsizeP s zRingList.maxsizec C s dj | j�S )N� )�joinr
)r r r r �__str__S s zRingList.__str__N)
�__name__�
__module__� __qualname__r r r r r r r r r r r r 3 s r c @ s: e Zd ZdZd
dd�Zdd� Zdd� Zd d
� Zd d � ZdS )� Conversation� Nc C sR || _ || _|| _ttj�| _d}x$|| jj� k rF| jd� |d7 }q$W d| _ dS )a Creates a new instance of the Conversation class.
Arguments:
- name: the chatroom/conversation name
- accHistory: the accessible which holds the conversation history
- inputArea: the editable text object for this conversation.
r r r N)
�name�
accHistory� inputArear r# �MESSAGE_LIST_LENGTH�_messageHistoryr �
addMessage�
_typingStatus)r r% r& r' r r r r r b s
zConversation.__init__c C s | j j|� dS )z�Adds the current message to the message history.
Arguments:
- message: A string containing the message to add
N)r) r )r �messager r r r* � s zConversation.addMessagec C s | j j� }|| S )z�Returns the specified message from the message history.
Arguments:
- messageNumber: the index of the message to get.
)r) r )r �
messageNumberr r r r �
getNthMessage� s
zConversation.getNthMessagec C s | j S )z<Returns the typing status of the buddy in this conversation.)r+ )r r r r �getTypingStatus� s z Conversation.getTypingStatusc C s
|| _ dS )z�Sets the typing status of the buddy in this conversation.
Arguments:
- status: a string describing the current status.
N)r+ )r �statusr r r �setTypingStatus� s z Conversation.setTypingStatus)N) r r! r" r( r r* r. r/ r1 r r r r r# \ s
r# c @ sD e Zd Zdd� Zdd� Zdd� Zdd� Zd d
� Zd d � Zd
d� Z dS )�ConversationListc C sJ g | _ t|�| _t|�| _d}x&|| jj� k rD| jdd� |d7 }q W dS )z�Creates a new instance of the ConversationList class.
Arguments:
- messageListLength: the size of the message history to keep.
r r Nr )�
conversationsr r) � _roomHistoryr r* )r �messageListLengthr r r r r � s
zConversationList.__init__c C s@ |s
d}n| j |�s | j|� |j}| jj|� | jj|� dS )z�Adds the current message to the message history.
Arguments:
- message: A string containing the message to add
- conversation: The instance of the Conversation class with which
the message is associated
r N)�hasConversation�addConversationr% r) r r4 )r r, � conversationr% r r r r* � s
zConversationList.addMessagec C s$ | j j� }| jj� }|| || fS )z�Returns a list containing the specified message from the message
history and the name of the chatroom/conversation associated with
that message.
Arguments:
- messageNumber: the index of the message to get.
)r) r r4 )r r- r Zroomsr r r �getNthMessageAndName� s
z%ConversationList.getNthMessageAndNamec C s
|| j kS )z�Returns True if we know about this conversation.
Arguments:
- conversation: the conversation of interest
)r3 )r r8 r r r r6 � s z ConversationList.hasConversationc C s
t | j�S )z<Returns the number of conversations we currently know about.)�lenr3 )r r r r �getNConversations� s z"ConversationList.getNConversationsc C s | j j|� dS )z|Adds conversation to the list of conversations.
Arguments:
- conversation: the conversation to add
N)r3 r )r r8 r r r r7 � s z ConversationList.addConversationc C s$ y| j j|� W n
dS dS dS )z�Removes conversation from the list of conversations.
Arguments:
- conversation: the conversation to remove
Returns True if conversation was successfully removed.
FTN)r3 r )r r8 r r r �removeConversation� s
z#ConversationList.removeConversationN)
r r! r" r r* r9 r6 r; r7 r< r r r r r2 � s r2 c @ s� e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z d5dd�Z d6dd�Z
dd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd7d%d&�Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd/d0� Zd1d2� Zd3d4� ZdS )8�ChatzTThis class implements the chat functionality which is available to
scripts.
c C s� || _ || _ddddddddd g | _tj| _i | _| j� | j� | _ t
| j�| _ t | j �| _
d
| _d
| _d
| _d
| _d
| _d
| _d
S ) at Creates an instance of the Chat class.
Arguments:
- script: the script with which this instance is associated.
- buddyListAncestries: a list of lists of pyatspi roles beginning
with the the object serving as the actual buddy list (e.g.
ROLE_TREE_TABLE) and ending with the top level object (e.g.
ROLE_FRAME).
ZF1ZF2ZF3ZF4ZF5ZF6ZF7ZF8ZF9N)�_script�_buddyListAncestries� messageKeysr �ORCA_MODIFIER_MASK�messageKeyModifier�inputEventHandlers�setupInputEventHandlers�getKeyBindings� keyBindingsr: r5 r2 �_conversationList�focusedChannelRadioButton�allChannelsRadioButton�allMessagesRadioButton�buddyTypingCheckButton� chatRoomHistoriesCheckButton�speakNameCheckButton)r �scriptZbuddyListAncestriesr r r r s
z
Chat.__init__c C s\ t j| jtj�| jd< t j| jtj�| jd< t j| jtj �| jd< t j| j
tj �| jd< dS )z�Defines InputEventHandler fields for chat functions which
will be used by the script associated with this chat instance.�togglePrefixHandler�toggleBuddyTypingHandler� toggleMessageHistoriesHandler�
reviewMessageN) r ZInputEventHandler� togglePrefixr Z CHAT_TOGGLE_ROOM_NAME_PREFIXrC �toggleBuddyTypingZCHAT_TOGGLE_BUDDY_TYPING�toggleMessageHistoriesZ CHAT_TOGGLE_MESSAGE_HISTORIES�readPreviousMessageZCHAT_PREVIOUS_MESSAGE)r r r r rD K s z Chat.setupInputEventHandlersc C s� t j� }|jt jdt jt j| jd �� |jt jdt jt j| jd �� |jt jdt jt j| jd �� x.| jD ]$}|jt j|| jt j | jd �� qpW |S )z�Defines the chat-related key bindings which will be used by
the script associated with this chat instance.
Returns: an instance of keybindings.KeyBindings.
r rO rP rQ rR )
r Z KeyBindings�addZ
KeyBindingZdefaultModifierMaskZNO_MODIFIER_MASKrC r@ rB rA )r rF Z
messageKeyr r r rE e s6 zChat.getKeyBindingsc C sB ddl m} |j� }|jd� tj}tjd�}|jj |�| _
| j
j |� |j | j
dddd� tj
}tjd�}|jj |�| _| jj |� |j | jdddd� tj}tjd�}|jj |�| _| jj |� |j | jdddd� |j� }|j |dd dd� |jd
tj �}|jd � |j|� |jjd d dd�}|jdddd� |j|� |j� }|j|� tjd
�}tj}|jj d|�}|j |t j k� || _ |j | j dddd� tj }|jj d|�} | j |� | j |t j!k� | | _"|j | j"dddd� tj#| j$j%j& }|jj d|�}
|
j |� |
j |t j'k� |
| _(|j | j(dddd� |j)� |S )zpReturn a GtkGrid containing the application unique configuration
GUI items for the current application. r )�Gtk� �chatSpeakRoomNamer �chatAnnounceBuddyTyping�chatRoomHistories� � z <b>%s</b>Tg �?�chatMessageVerbosityN)*Z
gi.repositoryrX ZGridZset_border_widthr ZCHAT_SPEAK_ROOM_NAME�_settingsManager�
getSettingZ CheckButtonZnew_with_mnemonicrM Z
set_activeZattachZCHAT_ANNOUNCE_BUDDY_TYPINGrK Z CHAT_SEPARATE_MESSAGE_HISTORIESrL ZFrameZLabelZCHAT_SPEAK_MESSAGES_FROMZset_use_markupZset_label_widgetZ Alignment�newZ set_paddingrW ZCHAT_SPEAK_MESSAGES_ALLZ RadioButtonr
�CHAT_SPEAK_ALLrJ ZCHAT_SPEAK_MESSAGES_ACTIVEZ
join_group�CHAT_SPEAK_FOCUSED_CHANNELrH Z"CHAT_SPEAK_MESSAGES_ALL_IF_FOCUSEDr> �appr% �CHAT_SPEAK_ALL_IF_FOCUSEDrI Zshow_all) r rX ZgridZlabel�valueZ
messagesFrameZmessagesAlignmentZ messagesGridZrb1Zrb2Zrb3r r r �getAppPreferencesGUI� sb
zChat.getAppPreferencesGUIc C sJ | j j� rtj}n| jj� r$tj}ntj}|| jj� | jj� | j j� d�S )z7Returns a dictionary with the app-specific preferences.)r_ rZ r[ r\ )
rI Z
get_activer
rf rH rd rc rM rK rL )r � verbosityr r r �getPreferencesFromGUI� s
zChat.getPreferencesFromGUIc C s8 t j}tjd�}tjd| � |r(t j}| jj|� dS )z� Toggle whether we prefix chat room messages with the name of
the chat room.
Arguments:
- script: the script associated with this event
- inputEvent: if not None, the input event that caused this action.
rZ T)r ZCHAT_ROOM_NAME_PREFIX_ONr` ra �
setSettingZCHAT_ROOM_NAME_PREFIX_OFFr> �presentMessage)r rN �
inputEvent�lineZ
speakRoomNamer r r rS � s
zChat.togglePrefixc C s8 t j}tjd�}tjd| � |r(t j}| jj|� dS )z� Toggle whether we announce when our buddies are typing a message.
Arguments:
- script: the script associated with this event
- inputEvent: if not None, the input event that caused this action.
r[ T)r ZCHAT_BUDDY_TYPING_ONr` ra rk ZCHAT_BUDDY_TYPING_OFFr> rl )r rN rm rn ZannounceTypingr r r rT � s
zChat.toggleBuddyTypingc C s8 t j}tjd�}tjd| � |r(t j}| jj|� dS )z� Toggle whether we provide chat room specific message histories.
Arguments:
- script: the script associated with this event
- inputEvent: if not None, the input event that caused this action.
r\ T)r ZCHAT_SEPARATE_HISTORIES_ONr` ra rk ZCHAT_SEPARATE_HISTORIES_OFFr> rl )r rN rm rn Z
roomHistoriesr r r rU s
zChat.toggleMessageHistoriesNr c
C s� y| j j|j�}W n Y nX | j|d }d\}}tjd�rb| jtj�}|rr|j |�}|j
}n| j j |�\}}|r�|r�| j
||d� dS )a� Speak/braille a previous chat room message.
Arguments:
- script: the script associated with this event
- inputEvent: if not None, the input event that caused this action.
- index: The index of the message to read -- by default, the most
recent message. If we get an inputEvent, however, the value of
index is ignored and the index of the event_string with respect
to self.messageKeys is used instead.
r Nr\ T)NN)r@ �indexZ event_stringr5 r` ra �getConversationr Z locusOfFocusr. r% rG r9 � utterMessage)r rN rm ro r- r, � chatRoomNamer8 r r r rV s
zChat.readPreviousMessageTc C s� t j| jjd�}tjj| jjkr.|tjkr.dS | rB|tj krBdS d}|rdt j| jjd�rdt
j | }tj s|| jj
j||�}n| jj
j||�}t|j� �r�| jjj|d�}| jj||d� | jj|� dS )aj Speak/braille a chat room message.
Arguments:
- chatRoomName: name of the chat room this message came from
- message: the chat room message
- focused: whether or not the current chatroom has focus. Defaults
to True so that we can use this method to present chat history
as well as incoming messages.
r_ Nr rZ )�string)�voice)r` Z
getAppSettingr> re r Z activeScriptr% r
rf rd r ZCHAT_MESSAGE_FROM_ROOMZpresentChatRoomLast� utilitiesZ appendStringr: �strip�speechGeneratorrt � speakMessageZdisplayBrailleMessage)r rr r, �focusedri �textrt r r r rq < s"
zChat.utterMessagec C s |j S )ay Get the actual displayed message. This will almost always be the
unaltered any_data from an event of type object:text-changed:insert.
Arguments:
- event: the Event from which to take the text.
Returns the string which should be presented as the newly-inserted
text. (Things like chatroom name prefacing get handled elsewhere.)
)�any_data)r �eventr r r �getMessageFromEvent` s zChat.getMessageFromEventc C s: | s |j jd� s |j r dS | j|j�r0dS | j|j�r@dS | j|�r\| j||j� dS | j|j��r | j j
r|| j j � | j |j�r�| j
|j�}t||j�}n| j|j�}|j}| j|�jd�}|r�| j||� | j|j�}|r�d}|� r�| j|||� dS | j|��r6|j}| j jj|d�}| j j||d� dS dS )aS Gives the Chat class an opportunity to present the text from the
text inserted Event.
Arguments:
- event: the text inserted Event
Returns True if we handled this event here; otherwise False, which
tells the associated script that is not a chat event that requires
custom handling.
zobject:text-changed:insertFT�
r )rs )rt )�type�
startswithr{ �isGenericTextObject�source�
isInBuddyList�isTypingStatusChangedEvent�presentTypingStatusChange�
isChatRoomMsgr> ZflatReviewContextZtoggleFlatReviewMode�isNewConversation�getChatRoomNamer# rp r% r} rv �addMessageToHistory�
isFocusedChatrq �isAutoCompletedTextEventrw rt rx )r r| r% r8 r, ry rz rt r r r �presentInsertedTextm sD
zChat.presentInsertedTextc C sX t jd�rT| j|j�}|rT||j� krT| jjj|d�}| jj||d� |j |� dS dS )aC Presents a change in typing status for the current conversation
if the status has indeed changed and if the user wants to hear it.
Arguments:
- event: the accessible Event
- status: a string containing the status change
Returns True if we spoke the change; False otherwise
r[ )rs )rt TF)
r` ra rp r� r/ r> rw rt rx r1 )r r| r0 r8 rt r r r r� � s
z Chat.presentTypingStatusChangec C s |j |� | jj ||� dS )aQ Adds message to both the individual conversation's history
as well as to the complete history stored in our conversation
list.
Arguments:
- message: a string containing the message to be added
- conversation: the instance of the Conversation class to which
this message belongs
N)r* rG )r r, r8 r r r r� � s
zChat.addMessageToHistoryc C s( |j � }|jtj�r$|jtj�r$dS dS )z�Returns True if the given accessible seems to be something
unrelated to the custom handling we're attempting to do here.
Arguments:
- obj: the accessible object to examine.
TF)�getState�contains�pyatspi�STATE_EDITABLEZSTATE_SINGLE_LINE)r �obj�stater r r r� � s
zChat.isGenericTextObjectc C s, |r(x"| j D ]}| jjj||�r dS q W dS )ay Returns True if obj is the list of buddies in the buddy list
window. Note that this method relies upon a hierarchical check,
using a list of hierarchies provided by the script. Scripts
which have more reliable means of identifying the buddy list
can override this method.
Arguments:
- obj: the accessible being examined
TF)r? r> ru ZhasMatchingHierarchy)r r� �roleListr r r � isBuddyList� s
zChat.isBuddyListc C sT |r| j |�rdS x<| jD ]2}|d }| jjj||gtjg�}| j |�rdS qW dS )z�Returns True if obj is, or is inside of, the buddy list.
Arguments:
- obj: the accessible being examined
- includeList: whether or not the list itself should be
considered "in" the buddy list.
Tr F)r� r? r> ru �ancestorWithRoler� �
ROLE_FRAME)r r� Z includeListr� Z
buddyListRole� candidater r r r� � s
zChat.isInBuddyListc C s | j |�}| jj|� S )z�Returns True if the given accessible is the chat history
associated with a new conversation.
Arguments:
- obj: the accessible object to examine.
)rp rG r6 )r r� r8 r r r r� s
zChat.isNewConversationc C sr |sdS d}|j � tjtjgkr:|j� jtj�r:| j|�}x2| jj D ]&}|r\||j
krj|S qD||j krD|S qDW dS )z�Attempts to locate the conversation associated with obj.
Arguments:
- obj: the accessible of interest
Returns the conversation if found; None otherwise
Nr ) �getRoler� � ROLE_TEXTZ
ROLE_ENTRYr� r� r� r� rG r3 r% r& )r r� r% r8 r r r rp s
zChat.getConversationc C sL |rH|j � tjkrH|jj � tjkrH|j� }|jtj� rH|jtj�rHdS dS )z�Returns True if the given accessible is the text object for
associated with a chat room conversation.
Arguments:
- obj: the accessible object to examine.
TF) r� r� r� �parentZROLE_SCROLL_PANEr� r� r� ZSTATE_MULTI_LINE)r r� r� r r r r� C s zChat.isChatRoomMsgc C s^ |rB|j � jtj�rB| jjj|�}d||f }tjtj |d� |S d| }tjtj |d� dS )z�Returns True if we plan to treat this chat as focused for
the purpose of deciding whether or not a message should be
presented to the user.
Arguments:
- obj: the accessible object to examine.
z%INFO: %s's window is focused chat: %sTz*INFO: %s is not focused chat (not showing)F)
r� r� r� Z
STATE_SHOWINGr> ru Z topLevelObjectIsActiveAndCurrentr ZprintlnZ
LEVEL_INFO)r r� Zactive�msgr r r r� T s zChat.isFocusedChatc C s� | j jj|tjtjgtjg�}d}y2| j jj|�}|j� j � | j j
j� j � krR|}W n Y nX |s�| j jj|tjgtjg�}y2| j jj|�}|j� j � | j j
j� j � kr�|}W n Y nX |S )z�Attempts to find the name of the current chat room.
Arguments:
- obj: The accessible of interest
Returns a string containing what we think is the chat room name.
r ) r> ru r� r� Z
ROLE_PAGE_TABr� ZROLE_APPLICATIONZ
displayedText�lowerrv r% )r r� Zancestorr% rz r r r r� g s*
zChat.getChatRoomNamec C s0 | j jj� \}}|dkr,|jr,|jdkr,dS dS )z�Returns True if event is associated with text being autocompleted.
Arguments:
- event: the accessible event being examined
ZTab� TF)r> ru ZlastKeyAndModifiersr{ )r r| ZlastKeyZmodsr r r r� � s z Chat.isAutoCompletedTextEventc C s dS )z�Returns True if event is associated with a change in typing status.
Arguments:
- event: the accessible event being examined
Fr )r r| r r r r� � s z Chat.isTypingStatusChangedEvent)Nr )T)T) r r! r" �__doc__r rD rE rh rj rS rT rU rV rq r} r� r� r� r� r� r� r� rp r� r� r� r� r� r r r r r= s2 ,(C
$
G
%*
r= )r� Z__id__� __version__Z__date__Z
__copyright__Z __license__r� r r r r r r r r r
r Z
getManagerr` r r# r2 r= r r r r �<module> s( )Mq