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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
|
-- Copyright 2007-2012 Mitchell mitchell.att.foicica.com. See LICENSE.
--[[ This comment is for LuaDoc.
---
-- Extends Lua's `io` package with Textadept functions for working with files.
--
-- ## Working with UTF-8
--
-- If your filesystem does not use UTF-8 encoded filenames (e.g. Windows),
-- conversions to and from that encoding are necessary since all of Textadept's
-- internal strings are UTF-8 encoded. When opening and saving files through
-- dialogs, these conversions are performed automatically, but if you need to do
-- them manually, use [`string.iconv()`][] along with [`_CHARSET`][], your
-- filesystem's detected encoding. An example is
--
-- <div style="clear: right;"><!-- Clear Table of Contents --></div>
--
-- events.connect(events.FILE_OPENED, function(utf8_filename)
-- local filename = utf8_filename:iconv(_CHARSET, 'UTF-8')
-- local f = io.open(filename, 'rb')
-- -- process file
-- f:close()
-- end)
--
-- [`string.iconv()`]: string.html#iconv
-- [`_CHARSET`]: _G.html#_CHARSET
-- @field _G.events.FILE_OPENED (string)
-- Called when a file is opened in a new buffer.
-- This is emitted by [`open_file()`](#open_file)
-- Arguments:
--
-- * `filename`: The filename encoded in UTF-8.
-- @field _G.events.FILE_BEFORE_SAVE (string)
-- Called right before a file is saved to disk.
-- This is emitted by [`buffer:save()`][]
-- Arguments:
--
-- * `filename`: The filename encoded in UTF-8.
--
-- [`buffer:save()`]: buffer.html#save
-- @field _G.events.FILE_AFTER_SAVE (string)
-- Called right after a file is saved to disk.
-- This is emitted by [`buffer:save()`][]
-- Arguments:
--
-- * `filename`: The filename encoded in UTF-8.
--
-- [`buffer:save()`]: buffer.html#save
-- @field _G.events.FILE_SAVED_AS (string)
-- Called when a file is saved under a different filename.
-- This is emitted by [`buffer:save_as()`][]
-- Arguments:
--
-- * `filename`: The filename encoded in UTF-8.
--
-- [`buffer:save_as()`]: buffer.html#save_as
module('io')]]
-- Events.
local events, events_connect = events, events.connect
events.FILE_OPENED = 'file_opened'
events.FILE_BEFORE_SAVE = 'file_before_save'
events.FILE_AFTER_SAVE = 'file_after_save'
events.FILE_SAVED_AS = 'file_saved_as'
---
-- List of recently opened files.
-- The most recent are towards the top.
-- @class table
-- @name recent_files
io.recent_files = {}
---
-- List of byte-order marks (BOMs) for identifying unicode file types.
-- @class table
-- @name boms
io.boms = {
['UTF-16BE'] = string.char(254, 255),
['UTF-16LE'] = string.char(255, 254),
['UTF-32BE'] = string.char(0, 0, 254, 255),
['UTF-32LE'] = string.char(255, 254, 0, 0)
}
-- Attempt to detect the encoding of the given text.
-- @param text Text to determine encoding from.
-- @return encoding string for `string.iconv()` (unless `'binary'`, indicating a
-- binary file), byte-order mark (BOM) string or `nil`. If encoding string is
-- `nil`, no encoding has been detected.
local function detect_encoding(text)
local b1, b2, b3, b4 = string.byte(text, 1, 4)
if b1 == 239 and b2 == 187 and b3 == 191 then
return 'UTF-8', string.char(239, 187, 191)
elseif b1 == 254 and b2 == 255 then
return 'UTF-16BE', io.boms['UTF-16BE']
elseif b1 == 255 and b2 == 254 then
return 'UTF-16LE', io.boms['UTF-16LE']
elseif b1 == 0 and b2 == 0 and b3 == 254 and b4 == 255 then
return 'UTF-32BE', io.boms['UTF-32BE']
elseif b1 == 255 and b2 == 254 and b3 == 0 and b4 == 0 then
return 'UTF-32LE', io.boms['UTF-32LE']
else
local chunk = #text > 65536 and text:sub(1, 65536) or text
if chunk:find('\0') then return 'binary' end -- binary file
end
return nil
end
---
-- List of encodings to try to decode files as.
-- You should add to this list if you get a "Conversion failed" error when
-- trying to open a file whose encoding is not recognized. Valid encodings are
-- [GNU iconv's encodings][].
--
-- [GNU iconv's encodings]: http://www.gnu.org/software/libiconv/
-- @class table
-- @name try_encodings
io.try_encodings = { 'UTF-8', 'ASCII', 'ISO-8859-1', 'MacRoman' }
---
-- Opens a list of files.
-- Emits a `FILE_OPENED` event.
-- @param utf8_filenames A `\n` separated list of UTF-8-encoded filenames to
-- open. If `nil`, the user is prompted with a fileselect dialog.
-- @usage io.open_file(utf8_encoded_filename)
-- @see _G.events
-- @name open_file
function io.open_file(utf8_filenames)
utf8_filenames = utf8_filenames or
gui.dialog('fileselect',
'--title', _L['Open'],
'--button1', _L['_Open'],
'--button2', _L['_Cancel'],
'--select-multiple',
'--with-directory',
(buffer.filename or ''):match('.+[/\\]') or '')
for utf8_filename in utf8_filenames:gmatch('[^\n]+') do
utf8_filename = utf8_filename:gsub('^file://', '')
if WIN32 then utf8_filename = utf8_filename:gsub('/', '\\') end
for i, buffer in ipairs(_BUFFERS) do
if utf8_filename == buffer.filename then view:goto_buffer(i) return end
end
local filename = utf8_filename:iconv(_CHARSET, 'UTF-8')
local f, err = io.open(filename, 'rb')
if not f then error(err) end
local text = f:read('*all')
f:close()
if not text then return end -- filename exists, but cannot read it
local buffer = new_buffer()
-- Tries to detect character encoding and convert text from it to UTF-8.
local encoding, encoding_bom = detect_encoding(text)
if encoding ~= 'binary' then
if encoding then
if encoding_bom then text = text:sub(#encoding_bom + 1, -1) end
text = text:iconv('UTF-8', encoding)
else
-- Try list of encodings.
for _, try_encoding in ipairs(io.try_encodings) do
local ok, conv = pcall(string.iconv, text, 'UTF-8', try_encoding)
if ok then encoding, text = try_encoding, conv break end
end
if not encoding then error(_L['Encoding conversion failed.']) end
end
else
encoding = nil
end
buffer.encoding, buffer.encoding_bom = encoding, encoding_bom
buffer.code_page = encoding and _SCINTILLA.constants.SC_CP_UTF8 or 0
-- Tries to set the buffer's EOL mode appropriately based on the file.
local s, e = text:find('\r\n?')
if s and e then
buffer.eol_mode = (s == e and _SCINTILLA.constants.SC_EOL_CR or
_SCINTILLA.constants.SC_EOL_CRLF)
else
buffer.eol_mode = _SCINTILLA.constants.SC_EOL_LF
end
buffer:add_text(text, #text)
buffer:goto_pos(0)
buffer:empty_undo_buffer()
buffer.modification_time = lfs.attributes(filename).modification
buffer.filename = utf8_filename
buffer:set_save_point()
events.emit(events.FILE_OPENED, utf8_filename)
-- Add file to recent files list, eliminating duplicates.
for i, file in ipairs(io.recent_files) do
if file == utf8_filename then table.remove(io.recent_files, i) break end
end
table.insert(io.recent_files, 1, utf8_filename)
lfs.chdir(utf8_filename:iconv(_CHARSET, 'UTF-8'):match('.+[/\\]') or '.')
end
end
-- LuaDoc is in core/.buffer.luadoc.
local function reload(buffer)
if not buffer then buffer = _G.buffer end
buffer:check_global()
if not buffer.filename then return end
local pos, first_visible_line = buffer.current_pos, buffer.first_visible_line
local filename = buffer.filename:iconv(_CHARSET, 'UTF-8')
local f, err = io.open(filename, 'rb')
if not f then error(err) end
local text = f:read('*all')
f:close()
local encoding, encoding_bom = buffer.encoding, buffer.encoding_bom
if encoding_bom then text = text:sub(#encoding_bom + 1, -1) end
if encoding then text = text:iconv('UTF-8', encoding) end
buffer:clear_all()
buffer:add_text(text, #text)
buffer:line_scroll(0, first_visible_line)
buffer:goto_pos(pos)
buffer:set_save_point()
buffer.modification_time = lfs.attributes(filename).modification
end
-- LuaDoc is in core/.buffer.luadoc.
local function set_encoding(buffer, encoding)
buffer:check_global()
if not buffer.encoding then
error(_L['Cannot change binary file encoding'])
end
local pos, first_visible_line = buffer.current_pos, buffer.first_visible_line
local text = buffer:get_text(buffer.length)
text = text:iconv(buffer.encoding, 'UTF-8')
text = text:iconv(encoding, buffer.encoding)
text = text:iconv('UTF-8', encoding)
buffer:clear_all()
buffer:add_text(text, #text)
buffer:line_scroll(0, first_visible_line)
buffer:goto_pos(pos)
buffer.encoding, buffer.encoding_bom = encoding, io.boms[encoding]
end
-- LuaDoc is in core/.buffer.luadoc.
local function save(buffer)
if not buffer then buffer = _G.buffer end
buffer:check_global()
if not buffer.filename then buffer:save_as() return end
events.emit(events.FILE_BEFORE_SAVE, buffer.filename)
local text = buffer:get_text(buffer.length)
if buffer.encoding then
text = (buffer.encoding_bom or '')..text:iconv(buffer.encoding, 'UTF-8')
end
local filename = buffer.filename:iconv(_CHARSET, 'UTF-8')
local f, err = io.open(filename, 'wb')
if not f then error(err) end
f:write(text)
f:close()
buffer:set_save_point()
buffer.modification_time = lfs.attributes(filename).modification
if buffer._type then buffer._type = nil end
events.emit(events.FILE_AFTER_SAVE, buffer.filename)
end
-- LuaDoc is in core/.buffer.luadoc.
local function save_as(buffer, utf8_filename)
if not buffer and not utf8_filename then buffer = _G.buffer end
buffer:check_global()
if not utf8_filename then
utf8_filename = gui.dialog('filesave',
'--title', _L['Save'],
'--button1', _L['_Save'],
'--button2', _L['_Cancel'],
'--with-directory',
(buffer.filename or ''):match('.+[/\\]') or '',
'--with-file',
(buffer.filename or ''):match('[^/\\]+$') or '',
'--no-newline')
end
if #utf8_filename > 0 then
buffer.filename = utf8_filename
buffer:save()
events.emit(events.FILE_SAVED_AS, utf8_filename)
lfs.chdir(utf8_filename:iconv(_CHARSET, 'UTF-8'):match('.+[/\\]'))
end
end
---
-- Saves all dirty buffers to their respective files.
-- @usage io.save_all()
-- @see buffer.save
-- @name save_all
function io.save_all()
local current_buffer = _BUFFERS[buffer]
for i, buffer in ipairs(_BUFFERS) do
view:goto_buffer(i)
if buffer.filename and buffer.dirty then buffer:save() end
end
view:goto_buffer(current_buffer)
end
-- LuaDoc is in core/.buffer.luadoc.
local function close(buffer)
if not buffer then buffer = _G.buffer end
buffer:check_global()
local filename = buffer.filename or buffer._type or _L['Untitled']
if buffer.dirty and gui.dialog('msgbox',
'--title', _L['Close without saving?'],
'--text', _L['There are unsaved changes in'],
'--informative-text', filename,
'--button1', _L['_Cancel'],
'--button2', _L['Close _without saving'],
'--no-newline') ~= '2' then
return nil -- returning false can cause unwanted key command propagation
end
buffer:delete()
return true
end
---
-- Closes all open buffers.
-- If any buffer is dirty, the user is prompted to continue. No buffers are
-- saved automatically. They must be saved manually.
-- @usage io.close_all()
-- @return `true` if user did not cancel.
-- @see buffer.close
-- @name close_all
function io.close_all()
while #_BUFFERS > 1 do
view:goto_buffer(#_BUFFERS)
if not buffer:close() then return false end
end
return buffer:close() -- the last one
end
-- Prompts the user to reload the current file if it has been modified outside
-- of Textadept.
local function update_modified_file()
if not buffer.filename then return end
local buffer = buffer
local utf8_filename = buffer.filename
local filename = utf8_filename:iconv(_CHARSET, 'UTF-8')
local attributes = lfs.attributes(filename)
if not attributes or not buffer.modification_time then return end
if buffer.modification_time < attributes.modification then
buffer.modification_time = attributes.modification
if gui.dialog('yesno-msgbox',
'--title', _L['Reload?'],
'--text', _L['Reload modified file?'],
'--informative-text',
('"%s"\n%s'):format(utf8_filename,
_L['has been modified. Reload it?']),
'--button1', _L['_Yes'],
'--button2', _L['_No'],
'--no-cancel',
'--no-newline') == '1' then
buffer:reload()
end
end
end
events_connect(events.BUFFER_AFTER_SWITCH, update_modified_file)
events_connect(events.VIEW_AFTER_SWITCH, update_modified_file)
-- Set additional buffer functions.
events_connect(events.BUFFER_NEW, function()
local buffer = buffer
buffer.reload = reload
buffer.save, buffer.save_as = save, save_as
buffer.close = close
buffer.encoding, buffer.set_encoding = 'UTF-8', set_encoding
end)
-- Close initial "Untitled" buffer.
events_connect(events.FILE_OPENED, function(utf8_filename)
local b = _BUFFERS[1]
if #_BUFFERS == 2 and not (b.filename or b._type or b.dirty) then
view:goto_buffer(1)
buffer:close()
end
end)
---
-- Prompts the user to open a recently opened file.
-- @see recent_files
-- @name open_recent_file
function io.open_recent_file()
local i = gui.filteredlist(_L['Open'], _L['File'], io.recent_files, true,
NCURSES and { '--width', gui.size[1] - 2 } or '')
if i then io.open_file(io.recent_files[i + 1]) end
end
|