-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathobjc.lua
2437 lines (2081 loc) · 71.5 KB
/
objc.lua
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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
--Objecive-C runtime and bridgesupport binding.
--Written by Cosmin Apreutesei. Public domain.
--Ideas and code from TLC by Fjölnir Ásgeirsson (c) 2012, MIT license.
--Tested with with LuaJIT 2.0.3, 32bit and 64bit on OSX 10.9 and 10.7.
local ffi = require'ffi'
local cast = ffi.cast
local OSX = ffi.os == 'OSX'
local x64 = ffi.abi'64bit'
if OSX then
ffi.load('libobjc.A.dylib', true)
end
if x64 then
ffi.cdef[[
typedef double CGFloat;
typedef long NSInteger;
typedef unsigned long NSUInteger;
]]
else
ffi.cdef[[
typedef float CGFloat;
typedef int NSInteger;
typedef unsigned int NSUInteger;
]]
end
ffi.cdef[[
typedef signed char BOOL;
typedef struct objc_class *Class;
typedef struct objc_object *id;
typedef struct objc_selector *SEL;
typedef struct objc_method *Method;
typedef id (*IMP) (id, SEL, ...);
typedef struct Protocol Protocol;
typedef struct objc_property *objc_property_t;
typedef struct objc_ivar *Ivar;
struct objc_class { Class isa; };
struct objc_object { Class isa; };
struct objc_method_description {
SEL name;
char *types;
};
//stdlib
int access(const char *path, int amode); // used to check if a file exists
void free (void*); // used for freeing returned dyn. allocated objects
//selectors
SEL sel_registerName(const char *str);
const char* sel_getName(SEL aSelector);
//classes
Class objc_getClass(const char *name);
const char *class_getName(Class cls);
Class class_getSuperclass(Class cls);
Class objc_allocateClassPair(Class superclass, const char *name, size_t extraBytes);
void objc_registerClassPair(Class cls);
void objc_disposeClassPair(Class cls);
BOOL class_isMetaClass(Class cls);
//instances
Class object_getClass(void* object); // use this instead of obj.isa because of tagged pointers
//methods
Method class_getInstanceMethod(Class aClass, SEL aSelector);
SEL method_getName(Method method);
const char *method_getTypeEncoding(Method method);
IMP method_getImplementation(Method method);
BOOL class_respondsToSelector(Class cls, SEL sel);
IMP class_replaceMethod(Class cls, SEL name, IMP imp, const char *types);
void method_exchangeImplementations(Method m1, Method m2);
//protocols
Protocol *objc_getProtocol(const char *name);
const char *protocol_getName(Protocol *p);
struct objc_method_description protocol_getMethodDescription(Protocol *p,
SEL aSel, BOOL isRequiredMethod, BOOL isInstanceMethod);
BOOL class_conformsToProtocol(Class cls, Protocol *protocol);
BOOL class_addProtocol(Class cls, Protocol *protocol);
//properties
objc_property_t class_getProperty(Class cls, const char *name);
objc_property_t protocol_getProperty(Protocol *proto, const char *name,
BOOL isRequiredProperty, BOOL isInstanceProperty);
const char *property_getName(objc_property_t property);
const char *property_getAttributes(objc_property_t property);
//ivars
Ivar class_getInstanceVariable(Class cls, const char* name);
const char *ivar_getName(Ivar ivar);
const char *ivar_getTypeEncoding(Ivar ivar);
ptrdiff_t ivar_getOffset(Ivar ivar);
//inspection
Class *objc_copyClassList(unsigned int *outCount);
Protocol **objc_copyProtocolList(unsigned int *outCount);
Method *class_copyMethodList(Class cls, unsigned int *outCount);
struct objc_method_description *protocol_copyMethodDescriptionList(Protocol *p,
BOOL isRequiredMethod, BOOL isInstanceMethod, unsigned int *outCount);
objc_property_t *class_copyPropertyList(Class cls, unsigned int *outCount);
objc_property_t *protocol_copyPropertyList(Protocol *proto, unsigned int *outCount);
Protocol **class_copyProtocolList(Class cls, unsigned int *outCount);
Protocol **protocol_copyProtocolList(Protocol *proto, unsigned int *outCount);
Ivar * class_copyIvarList(Class cls, unsigned int *outCount);
]]
local C = ffi.C --C namespace
local P = setmetatable({}, {__index = _G}) --private namespace
local objc = {} --public namespace
setfenv(1, P) --globals go in P, which is published as objc.debug
--helpers ----------------------------------------------------------------------------------------------------------------
local _ = string.format
local id_ct = ffi.typeof'id'
local function ptr(p) --convert NULL pointer to nil for easier handling (say 'not ptr' instead of 'ptr == nil')
if p == nil then return nil end
return p
end
local intptr_ct = ffi.typeof'intptr_t'
local function nptr(p) --convert pointer to Lua number for using as table key
if p == nil then return nil end
local np = cast(intptr_ct, p)
local n = tonumber(np)
if x64 and cast(intptr_ct, n) ~= np then --hi address: fall back to slower tostring()
n = tostring(np)
end
return n
end
local function own(p) --own a malloc()'ed pointer
return p ~= nil and ffi.gc(p, C.free) or nil
end
local function csymbol_(name) return C[name] end
local function csymbol(name)
local ok, sym = pcall(csymbol_, name)
if not ok then return end
return sym
end
local function memoize(func, cache) --special memoize that works with pointer arguments too
cache = cache or {}
return function(input)
local key = input
if type(key) == 'cdata' then
key = nptr(key)
end
if key == nil then return end
local ret = rawget(cache, key)
if ret == nil then
ret = func(input)
if ret == nil then return end
rawset(cache, key, ret)
end
return ret
end
end
local function memoize2(func, cache1) --memoize a two-arg. function (:
local memoized = memoize(function(arg1)
return memoize(function(arg2) --each unique arg1 gets 2 closures + 1 table of overhead
return func(arg1, arg2)
end)
end, cache1)
return function(arg1, arg2)
return memoized(arg1)(arg2)
end
end
local function canread(path) --check that a file is readable without having to open it
return C.access(path, 2^2) == 0
end
local function citer(a) --return an iterator for a null-terminated C array
local i = -1
return function()
if a == nil then return end
i = i + 1
if a[i] == nil then return end
return a[i]
end
end
--debugging --------------------------------------------------------------------------------------------------------------
errors = true --log non-fatal errors to stderr
errcount = {} --error counts per topic
logtopics = {} --topics to log (none by default)
local function writelog(topic, fmt, ...)
io.stderr:write(_('[objc] %-16s %s\n', topic, _(fmt, ...)))
end
local function log(topic, ...)
if logtopics[topic] then
writelog(topic, ...)
end
end
local function err(topic, ...)
errcount[topic] = (errcount[topic] or 0) + 1
if errors then
writelog(topic, ...)
end
end
local function check(ok, fmt, ...) --assert with formatted strings
if ok then return ok end
error(_(fmt or 'assertion failed!', ...), 3)
end
--ffi declarations -------------------------------------------------------------------------------------------------------
checkredef = false --check incompatible redefinition attempts (makes parsing slower)
printcdecl = false --print C declarations to stdout (then you can grab them and make static ffi headers)
cnames = {global = {0}, struct = {0}} --C namespaces; ns[1] holds the count
local function defined(name, namespace) --check if a name is already defined in a C namespace
return not checkredef and cnames[namespace][name]
end
local function redefined(name, namespace, new_cdecl) --check cdecl redefinitions and report on incompatible ones
local old_cdecl = cnames[namespace][name]
if not old_cdecl then return end
if not checkredef then return end
if old_cdecl == new_cdecl then return true end --already defined but same def.
err('redefinition', '%s\nold:\n\t%s\nnew:\n\t%s', name, old_cdecl, new_cdecl)
return true
end
local function declare(name, namespace, cdecl) --define a C type, const or function via ffi.cdef
if redefined(name, namespace, cdecl) then return end
local ok, cdeferr = pcall(ffi.cdef, cdecl)
if ok then
cnames[namespace][1] = cnames[namespace][1] + 1
if printcdecl then
print(cdecl .. ';')
end
else
if cdeferr == 'table overflow' then --fatal error from luajit: no more space for ctypes
error'too many ctypes'
end
err('cdef', '%s\n\t%s', cdeferr, cdecl)
end
cnames[namespace][name] = checkredef and cdecl or true --only store the cdecl if needed
return ok
end
--type encodings: parsing and conversion to C types ----------------------------------------------------------------------
-- stype: a value type encoding, eg. 'B', '^[8i]', '{CGPoint="x"d"y"d}'; converts to a ctype.
-- mtype: a method type encoding, eg. 'v12@0:4c8' or just 'v@:c'; converts to a ftype.
-- ftype: a function/method type encoding in table form, eg. {retval='v', '@', ':', 'c'}. converts to a ctype.
-- ctype: a C type encoding for a stype, eg. 'B' -> 'BOOL', or for a ftype, eg. 'v:#c' -> 'void (*) (SEL, Class, char)'.
-- ct: a ffi C type object for a ctype string, eg. ffi.typeof('void (*) (id, SEL)') -> ct.
--ftype spec:
-- variadic = true|nil --vararg function
-- isblock = true|nil --block or function (only for function pointers)
-- [argindex] = stype --arg stype (argindex is 1,2,... or 'retval')
-- fp = {[argindex] = ftype} --ftypes for function-pointer type args
local function optname(name) --format an optional name: if not nil, return it with a space in front
return name and ' '..name or ''
end
local stype_ctype --fw. decl.
local function array_ctype(s, name, ...) --('[Ntype]', 'name') -> ctype('type', 'name[N]')
local n,s = s:match'^%[(%d+)(.-)%]$'
--protect pointers to arrays by enclosing the name, because `[]` has precedence over `*` in C declarations.
--so for instance '^[8]' results in 'int (*)[8]` instead of `int *[8]`.
if name and name:sub(1,1) == '*' then
name = _('(%s)', name)
end
name = _('%s[%d]', name or '', n)
return stype_ctype(s, name, ...)
end
--note: `tag` means the struct tag in the C struct namespace; `name` means the typedef name in the C global namespace.
--for named structs only 'struct `tag`' is returned; for anonymous structs the full 'struct {fields...}' is returned.
--before returning, named structs are recursively cdef'ed (unless deftype ~= 'cdef' which skips this step).
local function struct_ctype(s, name, deftype, indent) --('{CGPoint="x"d"y"d}', 'NSPoint') -> 'struct CGPoint NSPoint'
--break the struct/union def. in its constituent parts: keyword, tag, fields
local kw, tag, fields = s:match'^(.)([^=]*)=?(.*).$' -- '{tag=fields}'
kw = kw == '{' and 'struct' or 'union'
if tag == '?' or tag == '' then tag = nil end -- ? or empty means anonymous struct
if fields == '' then fields = nil end -- empty definition means opaque struct
if not fields and not tag then --rare case: '{?}' coming from '^{?}'
return 'void'..optname(name)
end
if not fields or deftype ~= 'cdef' then --opaque named struct, or asked by caller not to be cdef'ed
if not tag then
err('parse', 'anonymous struct not valid here: %s', s)
return 'void'..optname(name)
end
return _('%s %s%s', kw, tag, optname(name))
end
if not tag or not defined(tag, 'struct') then --anonymous or not alreay defined: parse it
--parse the fields which come as '"name1"type1"name2"type2...'
local t = {}
local function addfield(name, s)
if name == '' then name = nil end --empty field name means unnamed struct (different from anonymous)
table.insert(t, stype_ctype(s, name, 'cdef', true)) --eg. 'struct _NSPoint origin'
return '' --remove the match
end
local s = fields
local n
while s ~= '' do
s,n = s:gsub('^"([^"]*)"([%^]*%b{})', addfield) --try "field"{...}
if n == 0 then s,n = s:gsub('^"([^"]*)"([%^]*%b())', addfield) end --try "field"(...)
if n == 0 then s,n = s:gsub('^"([^"]+)"([%^]*%b[])', addfield) end --try "field"[...]
if n == 0 then s,n = s:gsub('^"([^"]+)"(@)%?', addfield) end --try "field"@? (block type)
if n == 0 then s,n = s:gsub('^"([^"]+)"(@"[A-Z][^"]+")', addfield) end --try "field"@"Class"
if n == 0 then s,n = s:gsub('^"([^"]*)"([^"]+)', addfield) end --try "field"...
assert(n > 0, s)
end
local ctype = _('%s%s {\n\t%s;\n}', kw, optname(tag), table.concat(t, ';\n\t'))
--anonymous struct: return the full definition
if not tag then
if indent then --this is the only multiline output that can be indented
ctype = ctype:gsub('\n', '\n\t')
end
return _('%s%s', ctype, optname(name))
end
--named struct: cdef it.
--note: duplicate struct cdefs are rejected by luajit 2.0 with an error. we guard against that.
declare(tag, 'struct', ctype)
end
return _('%s %s%s', kw, tag, optname(name))
end
local function bitfield_ctype(s, name, deftype) --('bN', 'name') -> 'unsigned name: N'; N must be <= 32
local n = s:match'^b(%d+)$'
return _('unsigned %s: %d', name or '_', n)
end
local function pointer_ctype(s, name, ...) --('^type', 'name') -> ctype('type', '*name')
return stype_ctype(s:sub(2), '*'..(name or ''), ...)
end
local function char_ptr_ctype(s, ...) --('*', 'name') -> 'char *name'
return pointer_ctype('^c', ...)
end
local function primitive_ctype(ctype)
return function(s, name)
return ctype .. optname(name)
end
end
local function const_ctype(s, ...)
return 'const ' .. stype_ctype(s:sub(2), ...)
end
local ctype_decoders = {
['c'] = primitive_ctype'char', --also for `BOOL` (boolean-ness is specified through method type annotations)
['i'] = primitive_ctype'int',
['s'] = primitive_ctype'short',
['l'] = primitive_ctype'long', --treated as a 32-bit quantity on 64-bit programs
['q'] = primitive_ctype'long long',
['C'] = primitive_ctype'unsigned char',
['I'] = primitive_ctype'unsigned int',
['S'] = primitive_ctype'unsigned short',
['L'] = primitive_ctype'unsigned long',
['Q'] = primitive_ctype'unsigned long long',
['f'] = primitive_ctype'float',
['d'] = primitive_ctype'double',
['D'] = primitive_ctype'long double',
['B'] = primitive_ctype'BOOL', --does not appear in the runtime, but in bridgesupport
['v'] = primitive_ctype'void',
['?'] = primitive_ctype'void', --unknown type; used for function pointers among other things
['@'] = primitive_ctype'id', --@ or @? or @"ClassName"
['#'] = primitive_ctype'Class',
[':'] = primitive_ctype'SEL',
['['] = array_ctype, -- [Ntype] ; N = number of elements
['{'] = struct_ctype, -- {name=fields} ; struct
['('] = struct_ctype, -- (name=fields) ; union
['b'] = bitfield_ctype, -- bN ; N = number of bits
['^'] = pointer_ctype, -- ^type ; pointer
['*'] = char_ptr_ctype, -- * ; char* pointer
['r'] = const_ctype,
}
--convert a value type encoding (stype) to its C type, or, if name given, its C declaration.
--3rd arg = 'cdef' means that named structs contain field names and thus can and should be cdef'ed before returning.
function stype_ctype(s, name, ...)
local decoder = assert(ctype_decoders[s:sub(1,1)], s)
return decoder(s, name, ...)
end
--decode a method type encoding (mtype), and return its table representation (ftype).
--note: other type annotations like `variadic` and `isblock` come from bridgesupport attributes.
local function mtype_ftype(mtype) --eg. 'v12@0:4c8' (retval offset arg1 offset arg2 offset ...)
local ftype = {}
local retval
local function addarg(annotations, s)
if annotations:find'r' then
s = 'r' .. s
end
if not retval then
retval = s
else
table.insert(ftype, s)
end
return '' --remove the match
end
local s,n = mtype
while s ~= '' do
s,n = s:gsub('^([rnNoORV]*)([%^]*%b{})%d*', addarg) --try {...}offset
if n == 0 then s,n = s:gsub('^([rnNoORV]*)([%^]*%b())%d*', addarg) end --try (...)offset
if n == 0 then s,n = s:gsub('^([rnNoORV]*)([%^]*%b[])%d*', addarg) end --try [...]offset
if n == 0 then s,n = s:gsub('^([rnNoORV]*)(@%?)%d*', addarg) end --try @? (block type)
if n == 0 then s,n = s:gsub('^([rnNoORV]*)(@"[A-Z][^"]+")%d*', addarg) end --try @"Class"offset
if n == 0 then s,n = s:gsub('^([rnNoORV]*)([%^]*[cislqCISLQfdDBv%?@#%:%*])%d*', addarg) end --try <primitive>offset
assert(n > 0, mtype)
end
if retval ~= 'v' then
ftype.retval = retval
end
return ftype
end
--check if a ftype cannot be fully used with ffi callbacks, so we need to employ workarounds.
local function ftype_needs_wrapping(ftype)
--ffi callbacks don't work with vararg methods.
if ftype.variadic then
return true
end
--ffi callbacks don't work with pass-by-value structs.
for i = 1, #ftype do
if ftype[i]:find'^[%{%(]' then
return true
end
end
--they also can't return structs directly.
if ftype.retval and ftype.retval:find'^[%{%(]' then
return true
end
end
--format a table representation of a method or function (ftype) to its C type or, if name given, its C declaration.
--3rd arg = true means the type will be used for a ffi callback, which incurs some limitations.
local function ftype_ctype(ftype, name, for_callback)
local retval = ftype.retval
local lastarg = #ftype
if for_callback then
--ffi callbacks don't work with pass-by-value structs, so we're going to stop at the first one.
for i = 1, #ftype do
if ftype[i]:find'^[%{%(]' then
lastarg = i - 1
end
end
--they also can't return structs directly.
if retval and retval:find'^[%{%(]' then
retval = nil
end
end
local t = {}
for i = 1, lastarg do
t[i] = stype_ctype(ftype[i])
end
local args = table.concat(t, ', ')
local retval = retval and stype_ctype(retval) or 'void'
local vararg = not for_callback and ftype.variadic and (#t > 0 and ', ...' or '...') or ''
if name then
return _('%s %s (%s%s)', retval, name, args, vararg)
else
return _('%s (*) (%s%s)', retval, args, vararg)
end
end
local function ftype_mtype(ftype) --convert ftype to method type encoding
return (ftype.retval or 'v') .. table.concat(ftype)
end
local static_mtype_ftype = memoize(function(mtype) --ftype cache for non-anotated method types
return mtype_ftype(mtype)
end)
--cache anonymous function objects by their signature because we can only make 64K anonymous ct objects
--in luajit2 and there are a lot of duplicate method and function-pointer signatures (named functions are separate).
local ctype_ct = memoize(function(ctype)
local ok,ct = pcall(ffi.typeof, ctype)
check(ok, 'ctype error for "%s": %s', ctype, ct)
return ct
end)
local function ftype_ct(ftype, name, for_callback)
local cachekey = 'cb_ct' or 'ct'
local ct = ftype[cachekey] or ctype_ct(ftype_ctype(ftype, name, for_callback))
ftype[cachekey] = ct --cache it, useful for static ftypes
return ct
end
--bridgesupport file parsing ---------------------------------------------------------------------------------------------
lazyfuncs = true --cdef functions on the first call rather than at the time of parsing the xml (see below)
loaddeps = false --load dependencies specified in the bridgesupport file (usually too many to be useful)
--rename tables to prevent name clashes
rename = {string = {}, enum = {}, typedef = {}, const = {}, ['function'] = {}} --rename table to solve name clashing
rename.typedef.mach_timebase_info = 'mach_timebase_info_t'
rename.const.TkFont = 'const_TkFont'
local function global(name, kind) --return the "fixed" name for a given global name
return rename[kind][name] or name
end
--xml tag handlers
local tag = {} --{tag = start_tag_handler}
function tag.depends_on(attrs)
if not loaddeps then return end
local ok, loaderr = pcall(load_framework, attrs.path)
if not ok then
err('load', '%s', loaderr)
end
end
local typekey = x64 and 'type64' or 'type'
local valkey = x64 and 'value64' or 'value'
function tag.string_constant(attrs)
--note: some of these are NSStrings but we load them all as Lua strings.
rawset(objc, global(attrs.name, 'string'), attrs.value)
end
function tag.enum(attrs)
if attrs.ignore == 'true' then return end
local s = attrs[valkey] or attrs.value
if not s then return end --value not available on this platform
rawset(objc, global(attrs.name, 'enum'), tonumber(s))
end
local function cdef_node(attrs, typedecl, deftype)
local name = global(attrs.name, typedecl)
--note: duplicate typedef and const defs are ignored by luajit 2.0 and don't overflow its ctype table,
--but this is an implementation detail that we shouldn't rely on, so we guard against redefinitions.
if defined(name, 'global') then return end
local s = attrs[typekey] or attrs.type
if not s then return end --type not available on this platform
local ctype = stype_ctype(s, name, deftype)
declare(name, 'global', _('%s %s', typedecl, ctype))
end
function tag.constant(attrs)
cdef_node(attrs, 'const')
end
function tag.struct(attrs)
cdef_node(attrs, 'typedef', attrs.opaque ~= 'true' and 'cdef' or nil)
end
function tag.cftype(attrs)
cdef_node(attrs, 'typedef', 'cdef')
end
function tag.opaque(attrs)
cdef_node(attrs, 'typedef')
end
--arg or retval tag with function_pointer attribute
local function fp_arg(argtag, attrs, getwhile)
if attrs.function_pointer ~= 'true' then
return
end
local argtype = attrs[typekey] or attrs.type
local fp = {isblock = argtype == '@?' or nil}
if fp.isblock then fp[1] = '^v' end --adjust type: arg#1 is a pointer to the block object
for tag, attrs in getwhile(argtag) do
if tag == 'arg' or tag == 'retval' then
if fp then
local argtype = attrs[typekey] or attrs.type
if not argtype then --type not available on this platform: skip the entire argtag
fp = nil
else
local argindex = tag == 'retval' and 'retval' or #fp + 1
if not (argindex == 'retval' and argtype == 'v') then
fp[argindex] = argtype
end
end
end
local fp1 = fp_arg(tag, attrs, getwhile) --fpargs can have fpargs too
if fp and fp1 then
local argindex = tag == 'retval' and 'retval' or #fp + 1
fp.fp = fp.fp or {}
fp.fp[argindex] = fp1
end
for _ in getwhile(tag) do end --eat it because it might be the same as argtag
end
end
return fp
end
--function tag
local function_caller --fw. decl.
local function add_function(name, ftype, lazy) --cdef and call-wrap a global C function
if lazy == nil then lazy = lazyfuncs end
local function addfunc()
declare(name, 'global', ftype_ctype(ftype, name))
local cfunc = csymbol(name)
if not cfunc then
err('symbol', 'missing C function: %s', name)
return
end
local caller = function_caller(ftype, cfunc)
rawset(objc, name, caller) --overshadow the C function with the caller
return caller
end
if lazy then
--delay cdef'ing the function until the first call, to avoid polluting the C namespace with unused declarations.
--this is because in luajit2 can only hold as many as 64k ctypes total.
rawset(objc, name, function(...)
local func = addfunc()
if not func then return end
return func(...)
end)
else
addfunc()
end
end
tag['function'] = function(attrs, getwhile)
local name = global(attrs.name, 'function') --get the "fixed" name
--note: duplicate function defs are ignored by luajit 2.0 but they do overflow its ctype table,
--so it's necessary that we guard against redefinitions.
if defined(name, 'global') then return end
local ftype = {variadic = attrs.variadic == 'true' or nil}
for tag, attrs in getwhile'function' do
if ftype and (tag == 'arg' or tag == 'retval') then
local argtype = attrs[typekey] or attrs.type
if not argtype then --type not available on this platform: skip the entire function
ftype = nil
else
local argindex = tag == 'retval' and 'retval' or #ftype + 1
if not (argindex == 'retval' and argtype == 'v') then
ftype[argindex] = argtype
end
local fp = fp_arg(tag, attrs, getwhile)
if fp then
ftype.fp = ftype.fp or {}
ftype.fp[argindex] = fp
end
end
end
end
if ftype then
add_function(name, ftype)
end
end
--informal_protocol tag
local add_informal_protocol --fw. decl.
local add_informal_protocol_method --fw. decl.
function tag.informal_protocol(attrs, getwhile)
local proto = add_informal_protocol(attrs.name)
for tag, attrs in getwhile'informal_protocol' do
if proto and tag == 'method' then
local mtype = attrs[typekey] or attrs.type
if mtype then
add_informal_protocol_method(proto, attrs.selector, attrs.class_method ~= 'true', mtype)
end
end
end
end
--class tag
--method type annotations: {[is_instance] = {classname = {methodname = partial-ftype}}.
--only boolean retvals and function pointer args are recorded.
local mta = {[true] = {}, [false] = {}}
function tag.class(attrs, getwhile)
local inst_methods = {}
local class_methods = {}
local classname = attrs.name
for tag, attrs in getwhile'class' do
if tag == 'method' then
local meth = {}
local inst = attrs.class_method ~= 'true'
meth.variadic = attrs.variadic == 'true' or nil
local methodname = attrs.selector
for tag, attrs in getwhile'method' do
if meth and (tag == 'arg' or tag == 'retval') then
local argtype = attrs[typekey] or attrs.type
--attrs.index is the arg. index starting from 0 after the first two arguments (obj, sel).
local argindex = tag == 'retval' and 'retval' or attrs.index + 1 + 2
if tag == 'retval' and argtype == 'B' then
meth.retval = 'B'
end
local fp = fp_arg(tag, attrs, getwhile)
if fp then
meth.fp = meth.fp or {}
meth.fp[argindex] = fp
end
end
end
if meth and next(meth) then
if inst then
inst_methods[methodname] = meth
else
class_methods[methodname] = meth
end
end
end
end
if next(inst_methods) then
mta[true][classname] = inst_methods
end
if next(class_methods) then
mta[false][classname] = class_methods
end
end
local function get_raw_mta(classname, selname, inst)
local cls = mta[inst][classname]
return cls and cls[selname]
end
--function_alias tag
function tag.function_alias(attrs) --these tags always come after the 'function' tags
local name = attrs.name
local original = attrs.original
--delay getting a cdef to the original function until the first call to the alias
rawset(objc, name, function(...)
local origfunc = objc[original]
rawset(objc, name, origfunc) --replace this wrapper with the original function
return origfunc(...)
end)
end
--xml tag processor that dispatches the processing of tags inside <signatures> tag to a table of tag handlers.
--the tag handler gets the tag attributes and a conditional iterator to get any subtags.
local function process_tags(gettag)
local function nextwhile(endtag)
local start, tag, attrs = gettag()
if not start then
if tag == endtag then return end
return nextwhile(endtag)
end
return tag, attrs
end
local function getwhile(endtag) --iterate tags until `endtag` ends, returning (tag, attrs) for each tag
return nextwhile, endtag
end
for tagname, attrs in getwhile'signatures' do
if tag[tagname] then
tag[tagname](attrs, getwhile)
end
end
end
--fast, push-style xml parser that works with the simple cocoa generated xml files.
local function readfile(name)
local f = assert(io.open(name, 'rb'))
local s = f:read'*a'
f:close()
return s
end
local function parse_xml(path, write)
local s = readfile(path)
for endtag, tag, attrs, tagends in s:gmatch'<(/?)([%a_][%w_]*)([^/>]*)(/?)>' do
if endtag == '/' then
write(false, tag)
else
local t = {}
for name, val in attrs:gmatch'([%a_][%w_]*)=["\']([^"\']*)["\']' do
if val:find('"', 1, true) then --gsub alone is way slower
val = val:gsub('"', '"') --the only escaping found in all xml files tested
end
t[name] = val
end
write(true, tag, t)
if tagends == '/' then
write(false, tag)
end
end
end
end
--xml processor driver. runs a user-supplied tag processor function in a coroutine.
--the processor receives a gettags() function to pull tags with, as its first argument.
usexpat = false --choice of xml parser: expat or the lua-based parser above.
local function process_xml(path, processor, ...)
local send = coroutine.wrap(processor)
send(coroutine.yield, ...) --start the parser by passing it the gettag() function and other user args.
if usexpat then
local expat = require'expat'
expat.parse({path = path}, {
start_tag = function(name, attrs)
send(true, name, attrs)
end,
end_tag = function(name)
send(false, name)
end,
})
else
parse_xml(path, send)
end
end
function load_bridgesupport(path)
process_xml(path, process_tags)
end
--loading frameworks -----------------------------------------------------------------------------------------------------
loadtypes = true --load bridgesupport files
local searchpaths = {
'/System/Library/Frameworks',
'/Library/Frameworks',
'~/Library/Frameworks',
}
function find_framework(name) --given a framework name or its full path, return its full path and its name
if name:find'^/' then
-- try 'path/foo.framework'
local path = name
local name = path:match'([^/]+)%.framework$'
if not name then
-- try 'path/foo.framework/foo'
name = path:match'([^/]+)$'
path = name and path:sub(1, -#name-2)
end
if name and canread(path) then
return path, name
end
else
local subname = name:gsub('%.framework', '%$') --escape the '.framework' suffix
subname = subname:gsub('%.', '.framework/Versions/Current/Frameworks/') --expand 'Framework.Subframework' syntax
subname = subname:gsub('%$', '.framework') --unescape it
name = name:match'([^%./]+)$' --strip relative path from name
for i,path in pairs(searchpaths) do
path = _('%s/%s.framework', path, subname)
if canread(path) then
return path, name
end
end
end
end
loaded = {} --{framework_name = true}
loaded_bs = {} --{framework_name = true}
function load_framework(namepath, option) --load a framework given its name or full path
if not OSX then
error('platform not OSX', 2)
end
local basepath, name = find_framework(namepath)
check(basepath, 'framework not found %s', namepath)
if not loaded[basepath] then
--load the framework binary which contains classes, functions and protocols
local path = _('%s/%s', basepath, name)
if canread(path) then
ffi.load(path, true)
end
--load the bridgesupport dylib which contains callable versions of inline functions (NSMakePoint, etc.)
local path = _('%s/Resources/BridgeSupport/%s.dylib', basepath, name)
if canread(path) then
ffi.load(path, true)
end
log('load', '%s', basepath)
loaded[basepath] = true
end
if loadtypes and option ~= 'notypes' and not loaded_bs[basepath] then
loaded_bs[basepath] = true --set it before loading the file to prevent recursion from depends_on tag
--load the bridgesupport xml file which contains typedefs and constants which we can't get from the runtime.
local path = _('%s/Resources/BridgeSupport/%s.bridgesupport', basepath, name)
if canread(path) then
load_bridgesupport(path)
end
end
end
--objective-c runtime ----------------------------------------------------------------------------------------------------
--selectors
local selector_object = memoize(function(name) --cache to prevent string creation on each method call (worth it?)
--replace '_' with ':' except at the beginning
name = name:match('^_*') .. name:gsub('^_*', ''):gsub('_', ':')
return ptr(C.sel_registerName(name))
end)
local function selector(name)
if type(name) ~= 'string' then return name end
return selector_object(name)
end
local function selector_name(sel)
return ffi.string(C.sel_getName(sel))
end
ffi.metatype('struct objc_selector', {
__tostring = selector_name,
__index = {
name = selector_name,
},
})
--formal protocols
local function formal_protocols()
return citer(own(C.objc_copyProtocolList(nil)))
end
local function formal_protocol(name)
return ptr(C.objc_getProtocol(name))
end
local function formal_protocol_name(proto)
return ffi.string(C.protocol_getName(proto))
end
local function formal_protocol_protocols(proto) --protocols of superprotocols not included
return citer(own(C.protocol_copyProtocolList(proto, nil)))
end
local function formal_protocol_properties(proto) --inherited properties not included
return citer(own(C.protocol_copyPropertyList(proto, nil)))
end
local function formal_protocol_property(proto, name, required, readonly) --looks in superprotocols too
return ptr(C.protocol_getProperty(proto, name, required, readonly))
end
local function formal_protocol_methods(proto, inst, required) --inherited methods not included
local desc = own(C.protocol_copyMethodDescriptionList(proto, required, inst, nil))
local i = -1
return function()
i = i + 1