g fdZdZdZdZdZdZddlmZddlmZdd lm Z dd lm Z dd lm Z dd lm Z dd lm Z ddlmZddlmZddlmZddlmZddlmZGddZGddZGddZGddZy)z Implements generic chat support.z$Id$z $Revision$z$Date$z%Copyright (c) 2010-2011 The Orca TeamLGPL)cmdnames)debug) focus_manager) guilabels) input_event) keybindings)messages)script_manager)settings)settings_manager)AXObject) AXUtilitiesc6eZdZdZdZdZdZdZdZdZ y) RingListc<g|_d|_||_d|_yN)__data____full____max____cur__)selflengths +/usr/lib/python3/dist-packages/orca/chat.py__init__zRingList.__init__3s    cx|jdk(rZtd|jdz D]!}|j|dz|j|<#||j|jdz <y|jj ||xjdz c_|j|j k(rd|_yy)Nrr)rrangerrappendr)rxis rr zRingList.append9s ==A At||a/0 8#'==Q#7 a  8./DMM$,,* + MM  # LLA L||t||+ ! ,rc|jSN)rrs rgetz RingList.getDs }}rc|jdkDr0|j|jdz =|xjdzc_yy)Nrr)rrr%s rremovezRingList.removeGs6 LL1  dllQ./ LLA L rc|jSr$)rr%s rsizez RingList.sizeL ||rc|jSr$)rr%s rmaxsizezRingList.maxsizeOr+rc8dj|jS)N)joinrr%s r__str__zRingList.__str__Rswwt}}%%rN) __name__ __module__ __qualname__rr r&r(r*r-r1rrrr2s% " &rrc0eZdZdZddZdZdZdZdZy) Conversation Nc||_||_||_ttj |_d}||j jkr4|jd|dz }||j jkr4d|_ y)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. rr/rN) name accHistory inputArearr7MESSAGE_LIST_LENGTH_messageHistoryr- addMessage _typingStatus)rr:r;r<r"s rrzConversation.__init__as $" ( (H(HI $&&..00 OOB  FA$&&..00 rc:|jj|y)zAdds the current message to the message history. Arguments: - message: A string containing the message to add N)r>r )rmessages rr?zConversation.addMessages ##G,rc@|jj}||S)zReturns the specified message from the message history. Arguments: - messageNumber: the index of the message to get. )r>r&)r messageNumberr s r getNthMessagezConversation.getNthMessages#''++- &&rc|jS)z- '" $rr7c6eZdZdZdZdZdZdZdZdZ y) ConversationListcg|_t||_t||_d}||jj kr6|j dd|dz }||jj kr5yy)zCreates a new instance of the ConversationList class. Arguments: - messageListLength: the size of the message history to keep. rr/Nr) conversationsrr> _roomHistoryr-r?)rmessageListLengthr"s rrzConversationList.__init__sz  ((9: %%67 $&&..00 OOB % FA$&&..00rc|sd}n.|j|s|j||j}|jj ||j j |y)zAdds 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)hasConversationaddConversationr:r>r rP)rrB conversationr:s rr?zConversationList.addMessages[D'' 5$$\2$$D ##G,   &rc~|jj}|jj}||||fS)zReturns 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&rP)rrDr roomss rgetNthMessageAndNamez%ConversationList.getNthMessageAndNamesA''++-!!%%' &m(<<  @ A   " "//,,''(BC  E F   " "//,,''(GH  J K** ?J OO&&++22++O< > ? ?rcddlm}|j}|jdtj }t jjd}|jj||_ |jj||j|jddddtj}t jjd}|jj||_|jj||j|jddddtj }t jjd}|jj||_|j"j||j|j"dddd|j%}|j|dd dd|j'd tj(d }|j+d |j-||j.j1d d dd}|j3dddd|j5||j}|j5|t jjd}tj6}|j8jd|}|j|t:j<k(||_|j|j>ddddtj@}|j8jd|} | jC|| j|t:jDk(| |_#|j|jFddddtjHtKjL|jNjPz}|j8jd|} | jC|| j|t:jRk(| |_*|j|jTdddd|jW|S)zpReturn a GtkGrid containing the application unique configuration GUI items for the current application. r)Gtk chatSpeakRoomNamerchatAnnounceBuddyTypingchatRoomHistorieszzTg?chatMessageVerbosityN), gi.repositoryrGridset_border_widthrCHAT_SPEAK_ROOM_NAMEr getManager getSetting CheckButtonnew_with_mnemonicr} set_activeattachCHAT_ANNOUNCE_BUDDY_TYPINGr{CHAT_SEPARATE_MESSAGE_HISTORIESr|FrameLabelCHAT_SPEAK_MESSAGES_FROMset_use_markupset_label_widget Alignmentnew set_paddingrCHAT_SPEAK_MESSAGES_ALL RadioButtonr CHAT_SPEAK_ALLrzCHAT_SPEAK_MESSAGES_ACTIVE join_groupCHAT_SPEAK_FOCUSED_CHANNELrx"CHAT_SPEAK_MESSAGES_ALL_IF_FOCUSEDrget_namernappCHAT_SPEAK_ALL_IF_FOCUSEDryshow_all) rrgridlabelvalue messagesFramemessagesAlignment messagesGridrb1rb2rb3s rgetAppPreferencesGUIzChat.getAppPreferencesGUIs &xxz b!.. ++-889LM$'OO$E$Ee$L! !!,,U3 D--q!Q:44 ++-889RS&)oo&G&G&N# ##..u5 D//Aq!<99 ++-889LM OO - -e 4 ) ))44U; D55q!QB  M1aA. C B BC4HI T"&&u-MM--c31=%%aB2+,xxz l+ ++-889OP11oo//e< u 7 778&)#D77Aq!D44oo//e< s u C CCD),&D::Aq!QG<<   dll.. /0oo//e< s u B BBC&)#D77Aq!D  rcl|jjrtj}n;|jjrtj }ntj }||jj|jj|jjdS)z7Returns a dictionary with the app-specific preferences.)rrrr) ry get_activer rrxrrr}r{r|)r verbositys rgetPreferencesFromGUIzChat.getPreferencesFromGUIs  & & 1 1 3 ::I  + + 6 6 8 ;;I //I%.!%!:!:!E!E!G'+'B'B'M'M'O!%!B!B!M!M!O   rctj}tjj d}tjj d| |rtj }|jj|y)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. rT) r CHAT_ROOM_NAME_PREFIX_ONr rr setSettingCHAT_ROOM_NAME_PREFIX_OFFrnpresentMessage)rr~ inputEventline speakRoomNames rrzChat.togglePrefixsi00(335@@ATU ##%001D-FWX 55D ##D)rctj}tjj d}tjj d| |rtj }|jj|y)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. rT) r CHAT_BUDDY_TYPING_ONr rrrCHAT_BUDDY_TYPING_OFFrnr)rr~rrannounceTypings rrzChat.toggleBuddyTypingsk,,)446AAB[\##%00 %>'9 ; 11D ##D)rctj}tjj d}tjj d| |rtj }|jj|y)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. rT) r CHAT_SEPARATE_HISTORIES_ONr rrrCHAT_SEPARATE_HISTORIES_OFFrnr)rr~rr roomHistoriess rrzChat.toggleMessageHistoriessi22(335@@ATU ##%001D-FWX 77D ##D)rNc |jj|j}|j|dzz }d\}}t j jdrQ|jtj j}|r<|j|}|j}n|jj|\}}|r|r|j||dyyy#t$rYwxYw)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)NNrTN)rpindex event_stringr`rQr rrgetConversationrget_locus_of_focusrEr:rwrX utterMessage)rr~rrrDrB chatRoomNamerUs rrzChat.readPreviousMessages $$**:+B+BCE..%!)< *  & & ( 3 34G H// 0H0H0J0]0]0_`L&44]C+00 &&;;MJ "G\ |   lGT :$7   s%C** C65C6ctjj|jjd}t jj }|j|jjk7r|tjk(ry|s|tjk(ryd}|rKtjj|jjdrtj|z}tjs'|jjj||}n&|jjj||}t!|j#rC|jj$j'|}|jj)|||jj+|y)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. rNr/rstringvoice)r r getAppSettingrnrr getActiveScriptr:r rrr CHAT_MESSAGE_FROM_ROOMpresentChatRoomLast utilities appendStringr\stripspeechGeneratorr speakMessagedisplayBrailleMessage)rrrBfocusedrr~textrs rrzChat.utterMessage9sO%//1?? LL  46 **,<<> ;;$,,++ +H>>> Y(*M*MM    & & ( 6 6t||7G7GI\ ]22\AD++<<))66tWED<<))66wED tzz| LL0066d6CE LL % %d% % 8 **40rc|jS)ayGet 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_datarevents rgetMessageFromEventzChat.getMessageFromEvent_s~~rc|r'|jjdr |jsy|j|jry|j |jry|j |r|j||jy|j|jr|j|jr2|j|j}t||j}n'|j|j}|j}|j|jd}|r|j!|||j#|j}|rd}|r|j%|||y|j'|rP|j}|j(j*j-|}|j(j/||yy)aSGives 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/rr)type startswithrisGenericTextObjectsource isInBuddyListisTypingStatusChangedEventpresentTypingStatusChange isChatRoomMsgisNewConversationgetChatRoomNamer7rr:rraddMessageToHistory isFocusedChatrisAutoCompletedTextEventrnrrr)rrr:rUrBrrrs rpresentInsertedTextzChat.presentInsertedTextls**''(DE..  # #ELL 1    -  , ,U 3  * *5%.. A    -%%ell3++ELL9+D%,,? #33ELLA #((..u5;;DAG((,? ((6G!!$9  * *5 1>>DLL0066d6CE LL % %d% % 8rcTtjjdr|j|j}|rh||j k7rU|j jj|}|j j|||j|yy)aCPresents 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 rrrTF) r rrrrrHrnrrrrK)rrrJrUrs rrzChat.presentTypingStatusChanges  & & ( 3 34M N// =L<+G+G+I!I 44::&:I ))&)>,,V4rc^|j||jj||y)aQAdds 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?rw)rrBrUs rrzChat.addMessageToHistorys( ( ))'<@rcZtj|xrtj|S)zReturns 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. )r is_editableis_single_linerobjs rrzChat.isGenericTextObjects%&&s+O 0J0J30OOrc||y|jD]*}|jjj||s*yy)ayReturns 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 FT)rornrhasMatchingHierarchy)rrroleLists r isBuddyListzChat.isBuddyListsC ;11 H||%%::3I rc|r|j|ry|jD]3}|dtj|fd}|j|s3yy)zReturns 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. Trc4tj|k(Sr$)rget_role)r!roles rz$Chat.isInBuddyList..sh>O>OPQ>RVZ>ZrF)rror find_ancestor)rr includeListr candidaters @rrzChat.isInBuddyLists_ 4++C011 HA;D ..s4Z[I *   rc\|j|}|jj| S)zReturns True if the given accessible is the chat history associated with a new conversation. Arguments: - obj: the accessible object to examine. )rrwrS)rrrUs rrzChat.isNewConversations.++C0 ))99,GGGrc6|syd}tj|stj|r&tj|r|j |}|j jD]+}|r||jk(s|cS||jk(s)|cSy)zAttempts to locate the conversation associated with obj. Arguments: - obj: the accessible of interest Returns the conversation if found; None otherwise Nr/) ris_textris_entryr rrwrOr:r;)rrr:rUs rrzChat.getConversations    $(9(9#(>&&s+'',D 22@@ $L<,,,'' ///## $rctj|rUtjtj|r-tj | xrtj |Sy)zReturns True if the given accessible is the text object for associated with a chat room conversation. Arguments: - obj: the accessible object to examine. F)rris_scroll_paner get_parentr  is_multi_liner s rrzChat.isChatRoomMsg8sS   s # (B(B8CVCVWZC[(\"..s33V 8Q8QRU8V Vrc&tj|rR|jjj |}d|d|g}t j t j|d|Sd|dg}t j t j|dy)zReturns 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. zINFO:z's window is focused chat:Tz!is not focused chat (not showing)F)r is_showingrnr topLevelObjectIsActiveAndCurrentr printTokens LEVEL_INFO)rractivetokenss rrzChat.isFocusedChatDs  ! !# &\\++LLSQFs$@&IF   e.. =M3 CD %**FD9rcd}tj||}d} |jjj |}|j j |jjj j k7r|}|stj|tj} |jjj |}|j j |jjj j k7r|}|S|S#t$rYwxYw#t$rY|SwxYw)zAttempts 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. cZtj|xstj|Sr$)r is_page_tabis_frame)r!s rpredz"Chat.getChatRoomName..predes#**1-H1E1Ea1H Hrr/) rrrnr displayedTextlowerrr:r`rr-)rrr.ancestorr:rs rrzChat.getChatRoomNameWs# I))#t4 <<))77ADzz|!!#t||'8'8'>'>'@'F'F'HH--c;3G3GHH ||--;;HE::<%%'4<<+<+<+B+B+D+J+J+LLD t !      s%A8D8>T3Ircy)zReturns True if event is associated with a change in typing status. Arguments: - event: the accessible event being examined Fr5rs rrzChat.isTypingStatusChangedEventsrr)T)r2r3r4__doc__rrtrurrrrrrrrrrrrrrrrrrrrrr5rrrcrcs()T4&PAF .$$";@$1L ?B* A(P(( H#J &'R rrcN)r9__id__ __version____date__ __copyright__ __license__r/rrrrrr r r r r ax_objectr ax_utilitiesrrr7rMrcr5rrrAsx('  7  %!&!&RE$E$ZiibC C r