File: texteditor.py

package info (click to toggle)
sugar-pippy-activity 70+20160925~dfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 1,492 kB
  • ctags: 1,126
  • sloc: python: 8,015; makefile: 27
file content (204 lines) | stat: -rw-r--r-- 7,870 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# Copyright (C) 2015, Batchu Venkat Vishal
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the
# Free Software Foundation, Inc., 59 Temple Place - Suite 330,
# Boston, MA 02111-1307, USA.

import logging
import time

from gi.repository import Gtk

try:
    from sugar3.presence.wrapper import CollabWrapper
    logging.error('USING SUGAR COLLAB WRAPPER')
except ImportError:
    from collabwrapper import CollabWrapper

'''
The collabtexteditor moudle provides a text editor widget 
which can be included in any activity and then multiple 
users can collaborate and edit together in the editor.
'''


class CollabTextEditor(Gtk.TextView):
    '''
    A CollabTextEditor widget is a adjustable text editor which
    can be placed on an activity screen.

    The `changed` signal is usually emitted when the text in the
    editor is changed by a user.
    The `message` signal is usually emitted when another user makes
    changes in the text editor, so they are reflected in your editor.

    The widget can be embedded in a window which can be displayed.
    Example usage:
        editorinstance = CollabTextEditor(self)
        scrolled_window.add(editorinstance)
        scrolled_window.show()

    '''

    def __init__(self, activity, editor_id, collab):
        Gtk.TextView.__init__(self)
        self.set_editable(True)
        self.set_cursor_visible(True)
        self.set_wrap_mode(Gtk.WrapMode.WORD)
        self.textbuffer = self.get_buffer()
        self._collaberizer = TextBufferCollaberizer(
            self.textbuffer, editor_id, collab)
        self.textbuffer.set_text("")
        self.show()

class TextBufferCollaberizer(object):

    def __init__(self, textbuffer, editor_id, collab):
        self._id = editor_id
        self._buffer = textbuffer
        self._callbacks_status = True
        self.has_initialized = False

        self._collab = collab
        self._collab.connect('message', self.__message_cb)
        self._collab.connect('joined', self.__joined_cb)

        self._buffer.connect('insert-text', self.__text_buffer_inserted_cb)
        self._buffer.connect('delete-range', self.__text_buffer_deleted_cb)
        self._buffer.set_text('')

        if not self._collab.props.leader:
            # We must be joining an activity and just made the buffer
            self._collab.post(dict(
                action='init_request',
                res_id=self._id
            ))

    '''
    The message callback is called whenever another user edits
    something in the text editor and the changes are reflected
    in the editor or when a new buddy joins and we send them the
    latest version of the text buffer.

    Args:
        buddy : another user who sent the message
        message : updates send over from other users
    '''

    def __message_cb(self, collab, buddy, message):
        action = message.get('action')
        if str(message.get('res_id')) != self._id:
            return

        if action == 'init_response' or action == 'sync_editors':
            self.has_initialized = True
            self._callbacks_status = False
            self._buffer.set_text(message.get('current_content'))
            self._callbacks_status = True
        if action == 'entry_inserted':
            start_iter=self._buffer.get_iter_at_line_offset(message.get('start_iter_line'),
                    message.get('start_iter_offset'))
            self._callbacks_status = False
            self._buffer.insert(start_iter, message.get('new_text'))
            self._callbacks_status = True
        if action == 'entry_deleted':
            start_iter=self._buffer.get_iter_at_line_offset(message.get('start_iter_line'),
                    message.get('start_iter_offset'))
            end_iter=self._buffer.get_iter_at_line_offset(message.get('end_iter_line'),
                    message.get('end_iter_offset'))
            self._callbacks_status = False
            self._buffer.delete(start_iter, end_iter)
            self._callbacks_status = True
        if action == 'init_request':
            text = self._buffer.get_text(
                self._buffer.get_start_iter(),
                self._buffer.get_end_iter(),
                True)
            self._collab.post(dict(
                action='init_response',
                res_id=self._id,
                current_content=text
            ))
    
    def __joined_cb(self, sender):
        if self._collab._leader:
            return
        self._collab.post(dict(
            action='init_request',
            res_id=self._id
        ))

    '''
    This will send a message to all your buddies to set their editors to 
    sync with the text specified as an argument.

    Args:
        text : Text to be set in all the editors
    '''
    def __set_text_synced(self, text):
        if self._callbacks_status == False:
            return
        if self.has_initialized == False:
            self.has_initialized = True
        self._callbacks_status = False
        self._buffer.set_text(text)
        self._callbacks_status = True
        self._collab.post(dict(action='sync_editors', res_id=self._id,
            current_content=text))

    '''
    The text buffer inserted callback is called whenever text is 
    inserted in the editor, so that other users get updated with 
    these changes.

    Args:
        textbuffer (:class:`Gtk.TextBuffer`): text storage widget
        start (:class:`Gtk.Iterator`): a pointer to the start position
    '''

    def __text_buffer_inserted_cb(self, textbuffer, start, text, length):
        if self._callbacks_status == False:
            return
        if self.has_initialized == False:
            self.has_initialized = True
        logging.debug('Text inserted is %s' % (text))
        logging.debug('Text has been updated, %s' % (textbuffer.get_text(
            textbuffer.get_start_iter(), textbuffer.get_end_iter(), True)))
        self._collab.post(dict(action='entry_inserted',
                               res_id=self._id, start_iter_offset=start.get_line_offset(), 
                               start_iter_line=start.get_line(), new_text=text))

    '''
    The text buffer deleted callback is called whenever any text is 
    removed in the editor, so that other users get updated with 
    these changes.

    Args:
        textbuffer (:class:`Gtk.TextBuffer`): text storage widget
        start (:class:`Gtk.Iterator`): a pointer to the start position
        end (:class:`Gtk.Iterator`): a pointer to the end position
    '''

    def __text_buffer_deleted_cb(self, textbuffer, start, end):
        if self._callbacks_status == False:
            return
        if self.has_initialized == False:
            self.has_initialized = True
        logging.debug('Text deleted is %s' %
                      (textbuffer.get_text(start, end, True)))
        logging.debug('Text has been updated, %s' % (textbuffer.get_text(
            textbuffer.get_start_iter(), textbuffer.get_end_iter(), True)))
        self._collab.post(dict(action='entry_deleted',
                               res_id=self._id, start_iter_offset=start.get_line_offset(), 
                               start_iter_line=start.get_line(),end_iter_offset=end.get_line_offset(), 
                               end_iter_line=end.get_line()))