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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
# -*- coding: utf-8 -*-
# Copyright (c) 2005 Lateef Alabi-Oki
#
# This file is part of Scribes.
#
# Scribes is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# Scribes 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 General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Scribes; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
# USA
"""
This module documents functions that implement line operations in
gtk.TextBuffer.
@author: Lateef Alabi-Oki
@organization: The Scribes Project
@copyright: Copyright (c) 2005 Lateef Alabi-Oki
@license: GNU GPLv2 or Later
@contact: mystilleef@gmail.com
"""
def get_line_bounds(textbuffer):
"""
Get the beginning and end position of a line in a gtk.TextBuffer.
@param textbuffer: The textbuffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
@return: The beginning and end position of a line.
@rtype: A Tuple object containing a pair of gtk.TextIter.
"""
from cursor import get_cursor_line
cursor_line = get_cursor_line(textbuffer)
begin_position = textbuffer.get_iter_at_line(cursor_line)
end_position = begin_position.copy()
end_position.forward_to_line_end()
return begin_position, end_position
def get_text_on_line(textbuffer, line):
"""
Get the text on a line in the editor's buffer.
@param line: A line in the text editor's buffer.
@type line: An Integer object.
@param text: The text on a line in the buffer.
@type text: A String object.
"""
begin_position = textbuffer.get_iter_at_line(line)
if begin_position.ends_line(): return ""
end_position = begin_position.copy()
end_position.forward_to_line_end()
text = textbuffer.get_text(begin_position, end_position)
return text
def select_line(textbuffer):
"""
Select the current line in a gtk.TextBuffer.
The current line is the line the cursor is on.
@param textbuffer: The textbuffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
@return: Return True if the operation is successful.
@rtype: A Boolean object.
"""
begin_position, end_position = get_line_bounds(textbuffer)
if begin_position.get_char() in ["\n", "\x00"]: return False
textbuffer.select_range(begin_position, end_position)
return True
def delete_line(textbuffer):
"""
Delete a the cursor line in a gtk.TextBuffer.
@param textbuffer: The text buffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
"""
begin_position, end_position = get_line_bounds(textbuffer)
if begin_position.get_char() in ["\n"] and end_position.get_char() in ["\n"]:
# Delete empty line.
delete_empty_line(textbuffer)
return
if begin_position.get_char() in ["\n"] and end_position.get_char() in ["\x00"]:
# Delete empty second to last line.
delete_empty_line(textbuffer)
return
if begin_position.get_char() in ["\x00"] and end_position.get_char() in ["\x00"]:
# Delete empty last line.
delete_empty_last_line(textbuffer)
return
if begin_position.get_char() and end_position.get_char() in ["\x00"]:
# Delete last line with text on it.
delete_last_line(textbuffer)
return
# Delete normal lines.
end_position.forward_char()
textbuffer.begin_user_action()
textbuffer.delete(begin_position, end_position)
textbuffer.end_user_action()
return
def delete_empty_line(textbuffer):
"""
Delete an empty cursor line.
@param textbuffer: The text buffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
"""
from cursor import get_cursor_line
cursor_line = get_cursor_line(textbuffer)
begin_position = textbuffer.get_iter_at_line(cursor_line)
end_position = begin_position.copy()
end_position.forward_char()
textbuffer.begin_user_action()
textbuffer.delete(begin_position, end_position)
textbuffer.end_user_action()
return
def delete_empty_last_line(textbuffer):
"""
Delete an empty last cursor line.
@param textbuffer: The text buffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
"""
begin_position, end_position = get_line_bounds(textbuffer)
result = begin_position.backward_line()
if result:
if begin_position.get_char() in ["\n"]:
end_position = begin_position.copy()
end_position.forward_char()
else:
end_position = begin_position.copy()
end_position.forward_to_line_end()
end_position.forward_char()
begin_position.forward_to_line_end()
textbuffer.begin_user_action()
textbuffer.delete(begin_position, end_position)
textbuffer.end_user_action()
return result
def delete_last_line(textbuffer):
"""
Delete the last cursor line if it contains text.
@param textbuffer: The text buffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
"""
begin_position, end_position = get_line_bounds(textbuffer)
end_position.forward_char()
textbuffer.begin_user_action()
textbuffer.delete(begin_position, end_position)
delete_empty_last_line(textbuffer)
textbuffer.end_user_action()
return
def join_line(textbuffer):
"""
Join next line in the buffer to the current one.
@param textbuffer: The text buffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
@return: Return True if the operation is successful.
@rtype: A Boolean object.
"""
try:
mark = None
begin_position, end_position = get_line_bounds(textbuffer)
from gtk import TEXT_SEARCH_VISIBLE_ONLY
begin_match, end_match = begin_position.forward_search("\n", TEXT_SEARCH_VISIBLE_ONLY)
mark = textbuffer.create_mark(None, begin_match, True)
textbuffer.begin_user_action()
textbuffer.delete(begin_match, end_match)
begin_position = textbuffer.get_iter_at_mark(mark)
end_position = begin_position.copy()
if begin_position.backward_char():
while begin_position.get_char() in [" ", "\t"]:
begin_position.backward_char()
begin_position.forward_char()
while end_position.get_char() in [" ", "\t"]:
end_position.forward_char()
textbuffer.delete(begin_position, end_position)
begin_position = textbuffer.get_iter_at_mark(mark)
textbuffer.insert(begin_position, " ")
if mark.get_deleted() is False:
textbuffer.delete_mark(mark)
textbuffer.end_user_action()
except TypeError:
if mark is None: return False
if mark.get_deleted() is False: textbuffer.delete_mark(mark)
return False
return True
def free_line_above(textbuffer):
"""
Shift the text on current line to the next one.
@param textbuffer: The text buffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
@return: Return the line freed.
@rtype: A Integer object.
"""
string = None
spaces = get_beginning_spaces(textbuffer)
if spaces: string = "".join(spaces)
begin_position, end_position = get_line_bounds(textbuffer)
textbuffer.begin_user_action()
textbuffer.insert(begin_position, "\n")
begin_position, end_position = get_line_bounds(textbuffer)
begin_position.backward_line()
textbuffer.place_cursor(begin_position)
if string: textbuffer.insert(begin_position, string)
textbuffer.end_user_action()
from cursor import get_cursor_line
return get_cursor_line(textbuffer)
def free_line_below(textbuffer):
"""
Free the line below the current one.
@param textbuffer: The text buffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
@return: Return the line freed.
@rtype: A Integer object.
"""
string = None
spaces = get_beginning_spaces(textbuffer)
if spaces: string = "".join(spaces)
begin_position, end_position = get_line_bounds(textbuffer)
textbuffer.begin_user_action()
if begin_position.get_char() in ["\n", "\x00"]:
begin_position.forward_char()
textbuffer.insert(begin_position, "\n")
else:
end_position.forward_char()
textbuffer.insert(end_position, "\n")
begin_position, end_position = get_line_bounds(textbuffer)
begin_position.forward_line()
textbuffer.place_cursor(begin_position)
if string: textbuffer.insert(begin_position, string)
textbuffer.end_user_action()
from cursor import get_cursor_line
return get_cursor_line(textbuffer)
def get_beginning_spaces(textbuffer):
"""
Get the spaces at the beginning of the current line.
Spaces constitute either space or tab characters.
@param textbuffer: The text buffer to operate on.
@type textbuffer: A gtk.TextBuffer object.
@return: Return a list of spaces at the beginning of a line.
@rtype: A List object.
"""
begin_position, end_position = get_line_bounds(textbuffer)
if begin_position.get_char() in ["\n", "\x00"]: return None
spaces = []
transition_position = begin_position.copy()
while transition_position.get_char() in [" ", "\t"]:
spaces.append(transition_position.get_char())
transition_position.forward_char()
return spaces
def delete_cursor_to_line_end(textbuffer):
begin_position, end_position = get_line_bounds(textbuffer)
if begin_position.get_char() in ["\n", "\x00"]: return False
from cursor import get_cursor_iterator
cursor_position = get_cursor_iterator(textbuffer)
if cursor_position.get_char() in ["\n", "\x00"]: return False
textbuffer.begin_user_action()
textbuffer.delete(cursor_position, end_position)
textbuffer.end_user_action()
return True
def delete_cursor_to_line_begin(textbuffer):
begin_position, end_position = get_line_bounds(textbuffer)
if begin_position.get_char() in ["\n", "\x00"]: return False
from cursor import get_cursor_iterator
cursor_position = get_cursor_iterator(textbuffer)
if cursor_position.equal(begin_position): return False
textbuffer.begin_user_action()
textbuffer.delete(begin_position, cursor_position)
textbuffer.end_user_action()
return True
|