Tizen 2.0 Release
[external/tolua++.git] / README-5.1
1 Compiling for lua 5.1
2 ---------------------
3
4 Starting from version 1.0.8pre1, tolua++ can be compiled with both lua 5.0 and
5 5.1. Both versions will output the same code, and the C API (tolua++.h) is the
6 same.
7
8 The build system is not yet ready to detect/decide when to compile for 5.1,
9 the easiest way right now is to add a file called 'custom.py' on the root of
10 the package, with the following:
11
12 ## BEGIN custom.py
13
14 CCFLAGS = ['-I/usr/local/include/lua5.1', '-O2', '-ansi']
15 LIBPATH = ['/usr/local/lib']
16 LIBS = ['lua5.1', 'dl', 'm']
17 tolua_bin = 'tolua++5.1'
18 tolua_lib = 'tolua++5.1'
19 TOLUAPP = 'tolua++5.1'
20
21 ## END custom.py
22
23 This will build the binary as 'tolua++5.1' and the library as 'libtolua++5.1.a'
24 (taken from tolua_bin and tolua_lib), and take the lua headers and libraries
25 from /usr/local/include/lua5.1 and /usr/local/lib. It will also link with
26 '-llua5.1'. Modify the parameters acording to your system.
27
28 Compatibility
29 -------------
30
31 There are a couple of things to keep in mind when running code inside tolua
32 using the -L option:
33
34 * `...' and arg: you can still use 'arg' on 5.1, this is done automatically by
35 adding the 'arg' declaration to functions on files loaded with dofile.
36
37 For example, the line:
38
39 function foo( ... )
40
41 becomes
42
43 function foo( ... ) local arg = {n=select('#', ...), ...};
44
45 This lets you use the same code on both versions without having to make any
46 modifications.
47
48 * keep in mind that there are slight differences on the way string.gsub works,
49 and the original version of the function is always kept, so it will behave
50 diffently depending on which version of lua you're using.