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
|
#!/usr/bin/lua
-- Copyright 2007-2020 Mitchell mitchell.att.foicica.com. See LICENSE.
local constants, functions, properties, events = {}, {}, {}, {}
local const_patt = '^val ([%w_]+)=([-%dx%x]+)'
local event_patt = '^evt %a+ ([%w_]+)=(%d+)(%b())'
local msg_patt = '^(%a+) (%a+) (%w+)=(%d+)%((%a*)%s*([^,]*),%s*(%a*)%s*([^)]*)'
local types = {
[''] = 0, void = 0, int = 1, length = 2, index = 3, position = 3, line = 3,
colour = 4, bool = 5, keymod = 6, string = 7, stringresult = 8, cells = 9,
pointer = 1, textrange = 10, findtext = 11, formatrange = 12
}
local ignores = { -- constants to ignore
'^INDIC[012S]_', '^INVALID_POSITION', '^KEYWORDSET_MAX', '^SC_AC_',
'^SC_DOCUMENTOPTION_', '^SC_CACHE_', '^SC_CHARSET_', '^SC_EFF_',
'^SC_FONT_SIZE_MULTIPLIER', '^SC_INDIC', '^SC_LINE_END_TYPE_', '^SC_PHASES_',
'^SC_POPUP_', '^SC_PRINT_', '^SC_STATUS_', '^SC_TECHNOLOGY_', '^SC_TYPE_',
'^SC_WEIGHT_', '^SCE_', '^SCEN_', '^SCFIND_POSIX', '^SCI_', '^SCK_',
'^SCLEX_', '^UNDO_MAY_COALESCE'
}
local increments = { -- constants to increment by one
'^MARKER_MAX', '^MARKNUM_', '^MAX_MARGIN', '^STYLE_', '^INDICATOR_'
}
local changed_setter = {} -- holds properties changed to setter functions
local function to_en_us(name)
return name:gsub('([iIlL][oO])[uU]([rR])', '%1%2'):
gsub('ise$', 'ize'):gsub('([cC][eE][nN][tT])([rR])([eE])', '%1%3%2'):
gsub('CANCELLED', 'CANCELED')
end
local function to_lua_name(camel_case)
return to_en_us(camel_case:gsub('([a-z])([A-Z])', '%1_%2'):
gsub('([A-Z])([A-Z][a-z])', '%1_%2'):lower())
end
local function is_length(ptype, param)
return ptype == 'position' and param:find('^length')
end
local function is_index(ptype, param)
return ptype == 'int' and (param == 'style' or param == 'markerNumber' or
param == 'margin' or param == 'indicator' or param == 'selection')
end
for line in io.lines('../src/scintilla/include/Scintilla.iface') do
if line:find('^val ') then
local name, value = line:match(const_patt)
for i = 1, #ignores do if name:find(ignores[i]) then goto continue end end
name = to_en_us(name:gsub('^SC_', ''):gsub('^SC([^N]%u+)', '%1'))
if name == 'FIND_REGEXP' then
value = tostring(tonumber(value) + 2^23) -- add SCFIND_CXX11REGEX
value = value:gsub('%.0$', '') -- Lua 5.3+ may append this
else
for i = 1, #increments do
if name:find(increments[i]) then value = tonumber(value) + 1 end
end
end
constants[#constants + 1] = string.format('%s=%s', name, value)
elseif line:find('^evt ') then
local name, value, param_list = line:match(event_patt)
name = to_lua_name(name)
local event, has_modifiers = {string.format('%q', name)}, false
for param in param_list:gmatch('(%a+)[,)]') do
if param ~= 'void' and param ~= 'modifiers' then
event[#event + 1] = string.format('%q', to_lua_name(param))
elseif param == 'modifiers' then
has_modifiers = true
end
end
if name:find('^margin') then
event[2], event[3] = event[3], event[2] -- swap position, margin
end
if has_modifiers then event[#event + 1] = '"modifiers"' end -- prefer at end
events[#events + 1] = value
events[value] = table.concat(event, ',')
elseif line:find('^fun ') then
local _, rtype, name, id, wtype, param, ltype, param2 = line:match(msg_patt)
if rtype:find('^%u') then rtype = 'int' end
if wtype:find('^%u') then wtype = 'int' end
if ltype:find('^%u') then ltype = 'int' end
name = to_lua_name(name)
if name == 'convert_eo_ls' then name = 'convert_eols' end
if is_length(wtype, param) then
wtype = 'length'
elseif is_index(wtype, param) then
wtype = 'index'
end
if is_length(ltype, param2) then
ltype = 'length'
elseif is_index(ltype, param2) then
ltype = 'index'
elseif ltype == 'stringresult' then
rtype = 'void'
end
functions[#functions + 1] = name
functions[name] = {id, types[rtype], types[wtype], types[ltype]}
elseif line:find('^get ') or line:find('^set ') then
local kind, rtype, name, id, wtype, param, ltype, param2 =
line:match(msg_patt)
if rtype:find('^%u') then rtype = 'int' end
if wtype:find('^%u') then wtype = 'int' end
if ltype:find('^%u') then ltype = 'int' end
name = to_lua_name(name:gsub('[GS]et%f[%u]', ''))
if kind == 'get' and types[wtype] == types.int and
types[ltype] == types.int or wtype == 'bool' and ltype ~= '' or
changed_setter[name] then
-- Special case getter/setter; handle as function.
local fname = kind .. '_' .. name
functions[#functions + 1] = fname
functions[fname] = {id, types[rtype], types[wtype], types[ltype]}
changed_setter[name] = true
goto continue
end
if not properties[name] then
properties[#properties + 1] = name
properties[name] = {0, 0, 0, 0}
end
if is_index(wtype, param) then wtype = 'index' end
if is_index(ltype, param2) then ltype = 'index' end
local prop = properties[name]
if kind == 'get' then
prop[1] = id
prop[3] = types[ltype ~= 'stringresult' and rtype or ltype]
if wtype ~= '' then prop[4] = types[wtype] end
else
prop[2] = id
if prop[1] == 0 then
prop[3] = types[wtype ~= '' and ltype == '' and wtype or ltype]
end
prop[4] = types[ltype ~= '' and wtype or ltype]
end
elseif line:find('cat Provisional') then
break
end
::continue::
end
-- Manually adjust special-case messages that do not quite follow the rules.
functions['auto_c_show'][3] = types.int -- was interpreted as 'length'
functions['get_cur_line'][2] = types.position -- was interpreted as 'void'
-- Manually adjust messages whose param or return types would be interpreted as
-- 1-based numbers, but should not be, or vice-versa.
properties['length'][3] = types.int
properties['style_at'][3] = types.index
functions['marker_handle_from_line'][4] = types.index
functions['marker_number_from_line'][2] = types.index
functions['marker_number_from_line'][4] = types.index
functions['count_characters'][2] = types.int
functions['count_code_units'][2] = types.int
properties['line_count'][3] = types.int
functions['line_scroll'][3] = types.int
functions['line_scroll'][4] = types.int
properties['text_length'][3] = types.int
functions['replace_target'][2] = types.int
functions['replace_target_re'][2] = types.int
functions['wrap_count'][2] = types.int
properties['edge_column'][3] = types.int
functions['multi_edge_add_line'][3] = types.int
properties['multi_edge_column'][3] = types.int
properties['multi_edge_column'][4] = types.index
functions['line_length'][2] = types.int
properties['lines_on_screen'][3] = types.int
properties['auto_c_current'][3] = types.index
properties['indicator_current'][3] = types.index
properties['margin_style'][3] = types.index
properties['margin_style_offset'][3] = types.index
properties['annotation_style'][3] = types.index
properties['annotation_style_offset'][3] = types.index
properties['main_selection'][3] = types.index
functions['position_relative'][4] = types.int
-- Add mouse events from Scintilla curses manually.
constants[#constants + 1] = 'MOUSE_PRESS=1'
constants[#constants + 1] = 'MOUSE_DRAG=2'
constants[#constants + 1] = 'MOUSE_RELEASE=3'
table.sort(constants)
table.sort(functions)
table.sort(properties)
table.sort(events)
local f = io.open('../core/iface.lua', 'wb')
f:write([=[
-- Copyright 2007-2020 Mitchell mitchell.att.foicica.com. See LICENSE.
local M = {}
--[[ This comment is for LuaDoc.
---
-- Scintilla constants, functions, and properties.
-- Do not modify anything in this module. Doing so will have unpredictable
-- consequences.
module('_SCINTILLA')]]
]=])
f:write([[
---
-- Map of Scintilla constant names to their numeric values.
-- @class table
-- @name constants
-- @see _G.buffer
M.constants = {]])
f:write(table.concat(constants, ','))
f:write('}\n\n')
f:write([[
---
-- Map of Scintilla function names to tables containing their IDs, return types,
-- wParam types, and lParam types. Types are as follows:
--
-- + `0`: Void.
-- + `1`: Integer.
-- + `2`: Length of the given lParam string.
-- + `3`: Integer position.
-- + `4`: Color, in "0xBBGGRR" format.
-- + `5`: Boolean `true` or `false`.
-- + `6`: Bitmask of Scintilla key modifiers and a key value.
-- + `7`: String parameter.
-- + `8`: String return value.
-- @class table
-- @name functions
M.functions = {]])
for _, func in ipairs(functions) do
f:write(
string.format('%s={%d,%d,%d,%d},', func, table.unpack(functions[func])))
end
f:write('}\n\n')
f:write([[
---
-- Map of Scintilla property names to table values containing their "get"
-- function IDs, "set" function IDs, return types, and wParam types.
-- The wParam type will be non-zero if the property is indexable.
-- Types are the same as in the `functions` table.
-- @see functions
-- @class table
-- @name properties
M.properties = {]])
for _, property in ipairs(properties) do
f:write(string.format(
'%s={%d,%d,%d,%d},', property, table.unpack(properties[property])))
end
f:write('}\n\n')
f:write([[
---
-- Map of Scintilla event IDs to tables of event names and event parameters.
-- @class table
-- @name events
M.events = {]])
for _, event in ipairs(events) do
f:write(string.format('[%s]={%s},', event, events[event]))
end
f:write('}\n\n')
f:write([[
local marker_number, indic_number, list_type, image_type = 0, 0, 0, 0
---
-- Returns a unique marker number for use with `view.marker_define()`.
-- Use this function for custom markers in order to prevent clashes with
-- identifiers of other custom markers.
-- @usage local marknum = _SCINTILLA.next_marker_number()
-- @see view.marker_define
-- @name next_marker_number
function M.next_marker_number()
assert(marker_number < M.constants.MARKER_MAX, 'too many markers in use')
marker_number = marker_number + 1
return marker_number
end
---
-- Returns a unique indicator number for use with custom indicators.
-- Use this function for custom indicators in order to prevent clashes with
-- identifiers of other custom indicators.
-- @usage local indic_num = _SCINTILLA.next_indic_number()
-- @see view.indic_style
-- @name next_indic_number
function M.next_indic_number()
assert(indic_number < M.constants.INDICATOR_MAX, 'too many indicators in use')
indic_number = indic_number + 1
return indic_number
end
---
-- Returns a unique user list identier number for use with
-- `buffer.user_list_show()`.
-- Use this function for custom user lists in order to prevent clashes with
-- list identifiers of other custom user lists.
-- @usage local list_type = _SCINTILLA.next_user_list_type()
-- @see buffer.user_list_show
-- @name next_user_list_type
function M.next_user_list_type()
list_type = list_type + 1
return list_type
end
---
-- Returns a unique image type identier number for use with
-- `view.register_image()` and `view.register_rgba_image()`.
-- Use this function for custom image types in order to prevent clashes with
-- identifiers of other custom image types.
-- @usage local image_type = _SCINTILLA.next_image_type()
-- @see view.register_image
-- @see view.register_rgba_image
-- @name next_image_type
function M.next_image_type()
image_type = image_type + 1
return image_type
end
return M
]])
f:close()
|