2 ** $Id: luaconf.h,v 1.255 2016/05/01 20:06:09 roberto Exp $
3 ** Configuration file for Lua
4 ** See Copyright Notice in lua.h
16 ** ===================================================================
17 ** Search for "@@" to find all configurable definitions.
18 ** ===================================================================
23 ** {====================================================================
24 ** System Configuration: macros to adapt (if needed) Lua to some
25 ** particular platform, for instance compiling it with 32-bit numbers or
26 ** restricting it to C89.
27 ** =====================================================================
31 @@ LUA_32BITS enables Lua with 32-bit integers and 32-bit floats. You
32 ** can also define LUA_32BITS in the make file, but changing here you
33 ** ensure that all software connected to Lua will be compiled with the
34 ** same configuration.
36 /* #define LUA_32BITS */
40 @@ LUA_USE_C89 controls the use of non-ISO-C89 features.
41 ** Define it if you want Lua to avoid the use of a few C99 features
42 ** or Windows-specific features on Windows.
44 /* #define LUA_USE_C89 */
48 ** By default, Lua on Windows use (some) specific Windows features
50 #if !defined(LUA_USE_C89) && defined(_WIN32) && !defined(_WIN32_WCE)
51 #define LUA_USE_WINDOWS /* enable goodies for regular Windows */
55 #if defined(LUA_USE_WINDOWS)
56 #define LUA_DL_DLL /* enable support for DLL */
57 #define LUA_USE_C89 /* broadly, Windows is C89 */
61 #if defined(LUA_USE_LINUX)
63 #define LUA_USE_DLOPEN /* needs an extra library: -ldl */
64 #define LUA_USE_READLINE /* needs some extra libraries */
68 #if defined(LUA_USE_MACOSX)
70 #define LUA_USE_DLOPEN /* MacOS does not need -ldl */
71 #define LUA_USE_READLINE /* needs an extra library: -lreadline */
76 @@ LUA_C89_NUMBERS ensures that Lua uses the largest types available for
77 ** C89 ('long' and 'double'); Windows always has '__int64', so it does
78 ** not need to use this case.
80 #if defined(LUA_USE_C89) && !defined(LUA_USE_WINDOWS)
81 #define LUA_C89_NUMBERS
87 @@ LUAI_BITSINT defines the (minimum) number of bits in an 'int'.
89 /* avoid undefined shifts */
90 #if ((INT_MAX >> 15) >> 15) >= 1
91 #define LUAI_BITSINT 32
93 /* 'int' always must have at least 16 bits */
94 #define LUAI_BITSINT 16
99 @@ LUA_INT_TYPE defines the type for Lua integers.
100 @@ LUA_FLOAT_TYPE defines the type for Lua floats.
101 ** Lua should work fine with any mix of these options (if supported
102 ** by your C compiler). The usual configurations are 64-bit integers
103 ** and 'double' (the default), 32-bit integers and 'float' (for
104 ** restricted platforms), and 'long'/'double' (for C compilers not
105 ** compliant with C99, which may not have support for 'long long').
108 /* predefined options for LUA_INT_TYPE */
109 #define LUA_INT_INT 1
110 #define LUA_INT_LONG 2
111 #define LUA_INT_LONGLONG 3
113 /* predefined options for LUA_FLOAT_TYPE */
114 #define LUA_FLOAT_FLOAT 1
115 #define LUA_FLOAT_DOUBLE 2
116 #define LUA_FLOAT_LONGDOUBLE 3
118 #if defined(LUA_32BITS) /* { */
120 ** 32-bit integers and 'float'
122 #if LUAI_BITSINT >= 32 /* use 'int' if big enough */
123 #define LUA_INT_TYPE LUA_INT_INT
124 #else /* otherwise use 'long' */
125 #define LUA_INT_TYPE LUA_INT_LONG
127 #define LUA_FLOAT_TYPE LUA_FLOAT_FLOAT
129 #elif defined(LUA_C89_NUMBERS) /* }{ */
131 ** largest types available for C89 ('long' and 'double')
133 #define LUA_INT_TYPE LUA_INT_LONG
134 #define LUA_FLOAT_TYPE LUA_FLOAT_DOUBLE
140 ** default configuration for 64-bit Lua ('long long' and 'double')
142 #if !defined(LUA_INT_TYPE)
143 #define LUA_INT_TYPE LUA_INT_LONGLONG
146 #if !defined(LUA_FLOAT_TYPE)
147 #define LUA_FLOAT_TYPE LUA_FLOAT_DOUBLE
150 /* }================================================================== */
156 ** {==================================================================
157 ** Configuration for Paths.
158 ** ===================================================================
162 @@ LUA_PATH_DEFAULT is the default path that Lua uses to look for
164 @@ LUA_CPATH_DEFAULT is the default path that Lua uses to look for
166 ** CHANGE them if your machine has a non-conventional directory
167 ** hierarchy or if you want to install your libraries in
168 ** non-conventional directories.
170 #define LUA_VDIR LUA_VERSION_MAJOR "." LUA_VERSION_MINOR
171 #if defined(_WIN32) /* { */
173 ** In Windows, any exclamation mark ('!') in the path is replaced by the
174 ** path of the directory of the executable file of the current process.
176 #define LUA_LDIR "!\\lua\\"
177 #define LUA_CDIR "!\\"
178 #define LUA_SHRDIR "!\\..\\share\\lua\\" LUA_VDIR "\\"
179 #define LUA_PATH_DEFAULT \
180 LUA_LDIR"?.lua;" LUA_LDIR"?\\init.lua;" \
181 LUA_CDIR"?.lua;" LUA_CDIR"?\\init.lua;" \
182 LUA_SHRDIR"?.lua;" LUA_SHRDIR"?\\init.lua;" \
183 ".\\?.lua;" ".\\?\\init.lua"
184 #define LUA_CPATH_DEFAULT \
186 LUA_CDIR"..\\lib\\lua\\" LUA_VDIR "\\?.dll;" \
187 LUA_CDIR"loadall.dll;" ".\\?.dll"
191 #define LUA_ROOT "/usr/local/"
192 #define LUA_LDIR LUA_ROOT "share/lua/" LUA_VDIR "/"
193 #define LUA_CDIR LUA_ROOT "lib/lua/" LUA_VDIR "/"
194 #define LUA_PATH_DEFAULT \
195 LUA_LDIR"?.lua;" LUA_LDIR"?/init.lua;" \
196 LUA_CDIR"?.lua;" LUA_CDIR"?/init.lua;" \
197 "./?.lua;" "./?/init.lua"
198 #define LUA_CPATH_DEFAULT \
199 LUA_CDIR"?.so;" LUA_CDIR"loadall.so;" "./?.so"
204 @@ LUA_DIRSEP is the directory separator (for submodules).
205 ** CHANGE it if your machine does not use "/" as the directory separator
206 ** and is not Windows. (On Windows Lua automatically uses "\".)
209 #define LUA_DIRSEP "\\"
211 #define LUA_DIRSEP "/"
214 /* }================================================================== */
218 ** {==================================================================
219 ** Marks for exported symbols in the C code
220 ** ===================================================================
224 @@ LUA_API is a mark for all core API functions.
225 @@ LUALIB_API is a mark for all auxiliary library functions.
226 @@ LUAMOD_API is a mark for all standard library opening functions.
227 ** CHANGE them if you need to define those functions in some special way.
228 ** For instance, if you want to create one Windows DLL with the core and
229 ** the libraries, you may want to use the following definition (define
230 ** LUA_BUILD_AS_DLL to get it).
232 #if defined(LUA_BUILD_AS_DLL) /* { */
234 #if defined(LUA_CORE) || defined(LUA_LIB) /* { */
235 #define LUA_API __declspec(dllexport)
237 #define LUA_API __declspec(dllimport)
242 #define LUA_API extern
247 /* more often than not the libs go together with the core */
248 #define LUALIB_API LUA_API
249 #define LUAMOD_API LUALIB_API
253 @@ LUAI_FUNC is a mark for all extern functions that are not to be
254 ** exported to outside modules.
255 @@ LUAI_DDEF and LUAI_DDEC are marks for all extern (const) variables
256 ** that are not to be exported to outside modules (LUAI_DDEF for
257 ** definitions and LUAI_DDEC for declarations).
258 ** CHANGE them if you need to mark them in some special way. Elf/gcc
259 ** (versions 3.2 and later) mark them as "hidden" to optimize access
260 ** when Lua is compiled as a shared library. Not all elf targets support
261 ** this attribute. Unfortunately, gcc does not offer a way to check
262 ** whether the target offers that support, and those without support
263 ** give a warning about it. To avoid these warnings, change to the
264 ** default definition.
266 #if defined(__GNUC__) && ((__GNUC__*100 + __GNUC_MINOR__) >= 302) && \
267 defined(__ELF__) /* { */
268 #define LUAI_FUNC __attribute__((visibility("hidden"))) extern
270 #define LUAI_FUNC extern
273 #define LUAI_DDEC LUAI_FUNC
274 #define LUAI_DDEF /* empty */
276 /* }================================================================== */
280 ** {==================================================================
281 ** Compatibility with previous versions
282 ** ===================================================================
286 @@ LUA_COMPAT_5_2 controls other macros for compatibility with Lua 5.2.
287 @@ LUA_COMPAT_5_1 controls other macros for compatibility with Lua 5.1.
288 ** You can define it to get all options, or change specific options
289 ** to fit your specific needs.
291 #if defined(LUA_COMPAT_5_2) /* { */
294 @@ LUA_COMPAT_MATHLIB controls the presence of several deprecated
295 ** functions in the mathematical library.
297 #define LUA_COMPAT_MATHLIB
300 @@ LUA_COMPAT_BITLIB controls the presence of library 'bit32'.
302 #define LUA_COMPAT_BITLIB
305 @@ LUA_COMPAT_IPAIRS controls the effectiveness of the __ipairs metamethod.
307 #define LUA_COMPAT_IPAIRS
310 @@ LUA_COMPAT_APIINTCASTS controls the presence of macros for
311 ** manipulating other integer types (lua_pushunsigned, lua_tounsigned,
312 ** luaL_checkint, luaL_checklong, etc.)
314 #define LUA_COMPAT_APIINTCASTS
319 #if defined(LUA_COMPAT_5_1) /* { */
321 /* Incompatibilities from 5.2 -> 5.3 */
322 #define LUA_COMPAT_MATHLIB
323 #define LUA_COMPAT_APIINTCASTS
326 @@ LUA_COMPAT_UNPACK controls the presence of global 'unpack'.
327 ** You can replace it with 'table.unpack'.
329 #define LUA_COMPAT_UNPACK
332 @@ LUA_COMPAT_LOADERS controls the presence of table 'package.loaders'.
333 ** You can replace it with 'package.searchers'.
335 #define LUA_COMPAT_LOADERS
338 @@ macro 'lua_cpcall' emulates deprecated function lua_cpcall.
339 ** You can call your C function directly (with light C functions).
341 #define lua_cpcall(L,f,u) \
342 (lua_pushcfunction(L, (f)), \
343 lua_pushlightuserdata(L,(u)), \
348 @@ LUA_COMPAT_LOG10 defines the function 'log10' in the math library.
349 ** You can rewrite 'log10(x)' as 'log(x, 10)'.
351 #define LUA_COMPAT_LOG10
354 @@ LUA_COMPAT_LOADSTRING defines the function 'loadstring' in the base
355 ** library. You can rewrite 'loadstring(s)' as 'load(s)'.
357 #define LUA_COMPAT_LOADSTRING
360 @@ LUA_COMPAT_MAXN defines the function 'maxn' in the table library.
362 #define LUA_COMPAT_MAXN
365 @@ The following macros supply trivial compatibility for some
366 ** changes in the API. The macros themselves document how to
367 ** change your code to avoid using them.
369 #define lua_strlen(L,i) lua_rawlen(L, (i))
371 #define lua_objlen(L,i) lua_rawlen(L, (i))
373 #define lua_equal(L,idx1,idx2) lua_compare(L,(idx1),(idx2),LUA_OPEQ)
374 #define lua_lessthan(L,idx1,idx2) lua_compare(L,(idx1),(idx2),LUA_OPLT)
377 @@ LUA_COMPAT_MODULE controls compatibility with previous
378 ** module functions 'module' (Lua) and 'luaL_register' (C).
380 #define LUA_COMPAT_MODULE
386 @@ LUA_COMPAT_FLOATSTRING makes Lua format integral floats without a
387 @@ a float mark ('.0').
388 ** This macro is not on by default even in compatibility mode,
389 ** because this is not really an incompatibility.
391 /* #define LUA_COMPAT_FLOATSTRING */
393 /* }================================================================== */
398 ** {==================================================================
399 ** Configuration for Numbers.
400 ** Change these definitions if no predefined LUA_FLOAT_* / LUA_INT_*
401 ** satisfy your needs.
402 ** ===================================================================
406 @@ LUA_NUMBER is the floating-point type used by Lua.
407 @@ LUAI_UACNUMBER is the result of an 'usual argument conversion'
408 @@ over a floating number.
409 @@ l_mathlim(x) corrects limit name 'x' to the proper float type
410 ** by prefixing it with one of FLT/DBL/LDBL.
411 @@ LUA_NUMBER_FRMLEN is the length modifier for writing floats.
412 @@ LUA_NUMBER_FMT is the format for writing floats.
413 @@ lua_number2str converts a float to a string.
414 @@ l_mathop allows the addition of an 'l' or 'f' to all math operations.
415 @@ l_floor takes the floor of a float.
416 @@ lua_str2number converts a decimal numeric string to a number.
420 /* The following definitions are good for most cases here */
422 #define l_floor(x) (l_mathop(floor)(x))
424 #define lua_number2str(s,sz,n) l_sprintf((s), sz, LUA_NUMBER_FMT, (n))
427 @@ lua_numbertointeger converts a float number to an integer, or
428 ** returns 0 if float is not within the range of a lua_Integer.
429 ** (The range comparisons are tricky because of rounding. The tests
430 ** here assume a two-complement representation, where MININTEGER always
431 ** has an exact representation as a float; MAXINTEGER may not have one,
432 ** and therefore its conversion to float may have an ill-defined value.)
434 #define lua_numbertointeger(n,p) \
435 ((n) >= (LUA_NUMBER)(LUA_MININTEGER) && \
436 (n) < -(LUA_NUMBER)(LUA_MININTEGER) && \
437 (*(p) = (LUA_INTEGER)(n), 1))
440 /* now the variable definitions */
442 #if LUA_FLOAT_TYPE == LUA_FLOAT_FLOAT /* { single float */
444 #define LUA_NUMBER float
446 #define l_mathlim(n) (FLT_##n)
448 #define LUAI_UACNUMBER double
450 #define LUA_NUMBER_FRMLEN ""
451 #define LUA_NUMBER_FMT "%.7g"
453 #define l_mathop(op) op##f
455 #define lua_str2number(s,p) strtof((s), (p))
458 #elif LUA_FLOAT_TYPE == LUA_FLOAT_LONGDOUBLE /* }{ long double */
460 #define LUA_NUMBER long double
462 #define l_mathlim(n) (LDBL_##n)
464 #define LUAI_UACNUMBER long double
466 #define LUA_NUMBER_FRMLEN "L"
467 #define LUA_NUMBER_FMT "%.19Lg"
469 #define l_mathop(op) op##l
471 #define lua_str2number(s,p) strtold((s), (p))
473 #elif LUA_FLOAT_TYPE == LUA_FLOAT_DOUBLE /* }{ double */
475 #define LUA_NUMBER double
477 #define l_mathlim(n) (DBL_##n)
479 #define LUAI_UACNUMBER double
481 #define LUA_NUMBER_FRMLEN ""
482 #define LUA_NUMBER_FMT "%.14g"
484 #define l_mathop(op) op
486 #define lua_str2number(s,p) strtod((s), (p))
490 #error "numeric float type not defined"
497 @@ LUA_INTEGER is the integer type used by Lua.
499 @@ LUA_UNSIGNED is the unsigned version of LUA_INTEGER.
501 @@ LUAI_UACINT is the result of an 'usual argument conversion'
502 @@ over a lUA_INTEGER.
503 @@ LUA_INTEGER_FRMLEN is the length modifier for reading/writing integers.
504 @@ LUA_INTEGER_FMT is the format for writing integers.
505 @@ LUA_MAXINTEGER is the maximum value for a LUA_INTEGER.
506 @@ LUA_MININTEGER is the minimum value for a LUA_INTEGER.
507 @@ lua_integer2str converts an integer to a string.
511 /* The following definitions are good for most cases here */
513 #define LUA_INTEGER_FMT "%" LUA_INTEGER_FRMLEN "d"
514 #define lua_integer2str(s,sz,n) l_sprintf((s), sz, LUA_INTEGER_FMT, (n))
516 #define LUAI_UACINT LUA_INTEGER
519 ** use LUAI_UACINT here to avoid problems with promotions (which
520 ** can turn a comparison between unsigneds into a signed comparison)
522 #define LUA_UNSIGNED unsigned LUAI_UACINT
525 /* now the variable definitions */
527 #if LUA_INT_TYPE == LUA_INT_INT /* { int */
529 #define LUA_INTEGER int
530 #define LUA_INTEGER_FRMLEN ""
532 #define LUA_MAXINTEGER INT_MAX
533 #define LUA_MININTEGER INT_MIN
535 #elif LUA_INT_TYPE == LUA_INT_LONG /* }{ long */
537 #define LUA_INTEGER long
538 #define LUA_INTEGER_FRMLEN "l"
540 #define LUA_MAXINTEGER LONG_MAX
541 #define LUA_MININTEGER LONG_MIN
543 #elif LUA_INT_TYPE == LUA_INT_LONGLONG /* }{ long long */
545 /* use presence of macro LLONG_MAX as proxy for C99 compliance */
546 #if defined(LLONG_MAX) /* { */
547 /* use ISO C99 stuff */
549 #define LUA_INTEGER long long
550 #define LUA_INTEGER_FRMLEN "ll"
552 #define LUA_MAXINTEGER LLONG_MAX
553 #define LUA_MININTEGER LLONG_MIN
555 #elif defined(LUA_USE_WINDOWS) /* }{ */
556 /* in Windows, can use specific Windows types */
558 #define LUA_INTEGER __int64
559 #define LUA_INTEGER_FRMLEN "I64"
561 #define LUA_MAXINTEGER _I64_MAX
562 #define LUA_MININTEGER _I64_MIN
566 #error "Compiler does not support 'long long'. Use option '-DLUA_32BITS' \
567 or '-DLUA_C89_NUMBERS' (see file 'luaconf.h' for details)"
573 #error "numeric integer type not defined"
577 /* }================================================================== */
581 ** {==================================================================
582 ** Dependencies with C99 and other C details
583 ** ===================================================================
587 @@ l_sprintf is equivalent to 'snprintf' or 'sprintf' in C89.
588 ** (All uses in Lua have only one format item.)
590 #if !defined(LUA_USE_C89)
591 #define l_sprintf(s,sz,f,i) snprintf(s,sz,f,i)
593 #define l_sprintf(s,sz,f,i) ((void)(sz), sprintf(s,f,i))
598 @@ lua_strx2number converts an hexadecimal numeric string to a number.
599 ** In C99, 'strtod' does that conversion. Otherwise, you can
600 ** leave 'lua_strx2number' undefined and Lua will provide its own
603 #if !defined(LUA_USE_C89)
604 #define lua_strx2number(s,p) lua_str2number(s,p)
609 @@ lua_number2strx converts a float to an hexadecimal numeric string.
610 ** In C99, 'sprintf' (with format specifiers '%a'/'%A') does that.
611 ** Otherwise, you can leave 'lua_number2strx' undefined and Lua will
612 ** provide its own implementation.
614 #if !defined(LUA_USE_C89)
615 #define lua_number2strx(L,b,sz,f,n) ((void)L, l_sprintf(b,sz,f,n))
620 ** 'strtof' and 'opf' variants for math functions are not valid in
621 ** C89. Otherwise, the macro 'HUGE_VALF' is a good proxy for testing the
622 ** availability of these variants. ('math.h' is already included in
623 ** all files that use these macros.)
625 #if defined(LUA_USE_C89) || (defined(HUGE_VAL) && !defined(HUGE_VALF))
626 #undef l_mathop /* variants not available */
627 #undef lua_str2number
628 #define l_mathop(op) (lua_Number)op /* no variant */
629 #define lua_str2number(s,p) ((lua_Number)strtod((s), (p)))
634 @@ LUA_KCONTEXT is the type of the context ('ctx') for continuation
635 ** functions. It must be a numerical type; Lua will use 'intptr_t' if
636 ** available, otherwise it will use 'ptrdiff_t' (the nearest thing to
637 ** 'intptr_t' in C89)
639 #define LUA_KCONTEXT ptrdiff_t
641 #if !defined(LUA_USE_C89) && defined(__STDC_VERSION__) && \
642 __STDC_VERSION__ >= 199901L
644 #if defined(INTPTR_MAX) /* even in C99 this type is optional */
646 #define LUA_KCONTEXT intptr_t
652 @@ lua_getlocaledecpoint gets the locale "radix character" (decimal point).
653 ** Change that if you do not want to use C locales. (Code using this
654 ** macro must include header 'locale.h'.)
656 #if !defined(lua_getlocaledecpoint)
657 #define lua_getlocaledecpoint() (localeconv()->decimal_point[0])
660 /* }================================================================== */
664 ** {==================================================================
665 ** Language Variations
666 ** =====================================================================
670 @@ LUA_NOCVTN2S/LUA_NOCVTS2N control how Lua performs some
671 ** coercions. Define LUA_NOCVTN2S to turn off automatic coercion from
672 ** numbers to strings. Define LUA_NOCVTS2N to turn off automatic
673 ** coercion from strings to numbers.
675 /* #define LUA_NOCVTN2S */
676 /* #define LUA_NOCVTS2N */
680 @@ LUA_USE_APICHECK turns on several consistency checks on the C API.
681 ** Define it as a help when debugging C code.
683 #if defined(LUA_USE_APICHECK)
685 #define luai_apicheck(l,e) assert(e)
688 /* }================================================================== */
692 ** {==================================================================
693 ** Macros that affect the API and must be stable (that is, must be the
694 ** same when you compile Lua and when you compile code that links to
695 ** Lua). You probably do not want/need to change them.
696 ** =====================================================================
700 @@ LUAI_MAXSTACK limits the size of the Lua stack.
701 ** CHANGE it if you need a different limit. This limit is arbitrary;
702 ** its only purpose is to stop Lua from consuming unlimited stack
703 ** space (and to reserve some numbers for pseudo-indices).
705 #if LUAI_BITSINT >= 32
706 #define LUAI_MAXSTACK 1000000
708 #define LUAI_MAXSTACK 15000
713 @@ LUA_EXTRASPACE defines the size of a raw memory area associated with
714 ** a Lua state with very fast access.
715 ** CHANGE it if you need a different size.
717 #define LUA_EXTRASPACE (sizeof(void *))
721 @@ LUA_IDSIZE gives the maximum size for the description of the source
722 @@ of a function in debug information.
723 ** CHANGE it if you want a different size.
725 #define LUA_IDSIZE 60
729 @@ LUAL_BUFFERSIZE is the buffer size used by the lauxlib buffer system.
730 ** CHANGE it if it uses too much C-stack space. (For long double,
731 ** 'string.format("%.99f", 1e4932)' needs ~5030 bytes, so a
732 ** smaller buffer would force a memory allocation for each call to
735 #if defined(LUA_FLOAT_LONGDOUBLE)
736 #define LUAL_BUFFERSIZE 8192
738 #define LUAL_BUFFERSIZE ((int)(0x80 * sizeof(void*) * sizeof(lua_Integer)))
741 /* }================================================================== */
745 @@ LUA_QL describes how error messages quote program elements.
746 ** Lua does not use these macros anymore; they are here for
747 ** compatibility only.
749 #define LUA_QL(x) "'" x "'"
750 #define LUA_QS LUA_QL("%s")
755 /* =================================================================== */
758 ** Local configuration. You can use this space to add your redefinitions
759 ** without modifying the main part of the file.