2 ** $Id: luaconf.h,v 1.259 2016/12/22 13:08:50 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_SEP is the character that separates templates in a path.
163 ** LUA_PATH_MARK is the string that marks the substitution points in a
165 ** LUA_EXEC_DIR in a Windows path is replaced by the executable's
168 #define LUA_PATH_SEP ";"
169 #define LUA_PATH_MARK "?"
170 #define LUA_EXEC_DIR "!"
174 @@ LUA_PATH_DEFAULT is the default path that Lua uses to look for
176 @@ LUA_CPATH_DEFAULT is the default path that Lua uses to look for
178 ** CHANGE them if your machine has a non-conventional directory
179 ** hierarchy or if you want to install your libraries in
180 ** non-conventional directories.
182 #define LUA_VDIR LUA_VERSION_MAJOR "." LUA_VERSION_MINOR
183 #if defined(_WIN32) /* { */
185 ** In Windows, any exclamation mark ('!') in the path is replaced by the
186 ** path of the directory of the executable file of the current process.
188 #define LUA_LDIR "!\\lua\\"
189 #define LUA_CDIR "!\\"
190 #define LUA_SHRDIR "!\\..\\share\\lua\\" LUA_VDIR "\\"
191 #define LUA_PATH_DEFAULT \
192 LUA_LDIR"?.lua;" LUA_LDIR"?\\init.lua;" \
193 LUA_CDIR"?.lua;" LUA_CDIR"?\\init.lua;" \
194 LUA_SHRDIR"?.lua;" LUA_SHRDIR"?\\init.lua;" \
195 ".\\?.lua;" ".\\?\\init.lua"
196 #define LUA_CPATH_DEFAULT \
198 LUA_CDIR"..\\lib\\lua\\" LUA_VDIR "\\?.dll;" \
199 LUA_CDIR"loadall.dll;" ".\\?.dll"
203 #define LUA_ROOT "/usr/local/"
204 #define LUA_LDIR LUA_ROOT "share/lua/" LUA_VDIR "/"
205 #define LUA_CDIR LUA_ROOT "lib/lua/" LUA_VDIR "/"
206 #define LUA_PATH_DEFAULT \
207 LUA_LDIR"?.lua;" LUA_LDIR"?/init.lua;" \
208 LUA_CDIR"?.lua;" LUA_CDIR"?/init.lua;" \
209 "./?.lua;" "./?/init.lua"
210 #define LUA_CPATH_DEFAULT \
211 LUA_CDIR"?.so;" LUA_CDIR"loadall.so;" "./?.so"
216 @@ LUA_DIRSEP is the directory separator (for submodules).
217 ** CHANGE it if your machine does not use "/" as the directory separator
218 ** and is not Windows. (On Windows Lua automatically uses "\".)
221 #define LUA_DIRSEP "\\"
223 #define LUA_DIRSEP "/"
226 /* }================================================================== */
230 ** {==================================================================
231 ** Marks for exported symbols in the C code
232 ** ===================================================================
236 @@ LUA_API is a mark for all core API functions.
237 @@ LUALIB_API is a mark for all auxiliary library functions.
238 @@ LUAMOD_API is a mark for all standard library opening functions.
239 ** CHANGE them if you need to define those functions in some special way.
240 ** For instance, if you want to create one Windows DLL with the core and
241 ** the libraries, you may want to use the following definition (define
242 ** LUA_BUILD_AS_DLL to get it).
244 #if defined(LUA_BUILD_AS_DLL) /* { */
246 #if defined(LUA_CORE) || defined(LUA_LIB) /* { */
247 #define LUA_API __declspec(dllexport)
249 #define LUA_API __declspec(dllimport)
254 #define LUA_API extern
259 /* more often than not the libs go together with the core */
260 #define LUALIB_API LUA_API
261 #define LUAMOD_API LUALIB_API
265 @@ LUAI_FUNC is a mark for all extern functions that are not to be
266 ** exported to outside modules.
267 @@ LUAI_DDEF and LUAI_DDEC are marks for all extern (const) variables
268 ** that are not to be exported to outside modules (LUAI_DDEF for
269 ** definitions and LUAI_DDEC for declarations).
270 ** CHANGE them if you need to mark them in some special way. Elf/gcc
271 ** (versions 3.2 and later) mark them as "hidden" to optimize access
272 ** when Lua is compiled as a shared library. Not all elf targets support
273 ** this attribute. Unfortunately, gcc does not offer a way to check
274 ** whether the target offers that support, and those without support
275 ** give a warning about it. To avoid these warnings, change to the
276 ** default definition.
278 #if defined(__GNUC__) && ((__GNUC__*100 + __GNUC_MINOR__) >= 302) && \
279 defined(__ELF__) /* { */
280 #define LUAI_FUNC __attribute__((visibility("hidden"))) extern
282 #define LUAI_FUNC extern
285 #define LUAI_DDEC LUAI_FUNC
286 #define LUAI_DDEF /* empty */
288 /* }================================================================== */
292 ** {==================================================================
293 ** Compatibility with previous versions
294 ** ===================================================================
298 @@ LUA_COMPAT_5_2 controls other macros for compatibility with Lua 5.2.
299 @@ LUA_COMPAT_5_1 controls other macros for compatibility with Lua 5.1.
300 ** You can define it to get all options, or change specific options
301 ** to fit your specific needs.
303 #if defined(LUA_COMPAT_5_2) /* { */
306 @@ LUA_COMPAT_MATHLIB controls the presence of several deprecated
307 ** functions in the mathematical library.
309 #define LUA_COMPAT_MATHLIB
312 @@ LUA_COMPAT_BITLIB controls the presence of library 'bit32'.
314 #define LUA_COMPAT_BITLIB
317 @@ LUA_COMPAT_IPAIRS controls the effectiveness of the __ipairs metamethod.
319 #define LUA_COMPAT_IPAIRS
322 @@ LUA_COMPAT_APIINTCASTS controls the presence of macros for
323 ** manipulating other integer types (lua_pushunsigned, lua_tounsigned,
324 ** luaL_checkint, luaL_checklong, etc.)
326 #define LUA_COMPAT_APIINTCASTS
331 #if defined(LUA_COMPAT_5_1) /* { */
333 /* Incompatibilities from 5.2 -> 5.3 */
334 #define LUA_COMPAT_MATHLIB
335 #define LUA_COMPAT_APIINTCASTS
338 @@ LUA_COMPAT_UNPACK controls the presence of global 'unpack'.
339 ** You can replace it with 'table.unpack'.
341 #define LUA_COMPAT_UNPACK
344 @@ LUA_COMPAT_LOADERS controls the presence of table 'package.loaders'.
345 ** You can replace it with 'package.searchers'.
347 #define LUA_COMPAT_LOADERS
350 @@ macro 'lua_cpcall' emulates deprecated function lua_cpcall.
351 ** You can call your C function directly (with light C functions).
353 #define lua_cpcall(L,f,u) \
354 (lua_pushcfunction(L, (f)), \
355 lua_pushlightuserdata(L,(u)), \
360 @@ LUA_COMPAT_LOG10 defines the function 'log10' in the math library.
361 ** You can rewrite 'log10(x)' as 'log(x, 10)'.
363 #define LUA_COMPAT_LOG10
366 @@ LUA_COMPAT_LOADSTRING defines the function 'loadstring' in the base
367 ** library. You can rewrite 'loadstring(s)' as 'load(s)'.
369 #define LUA_COMPAT_LOADSTRING
372 @@ LUA_COMPAT_MAXN defines the function 'maxn' in the table library.
374 #define LUA_COMPAT_MAXN
377 @@ The following macros supply trivial compatibility for some
378 ** changes in the API. The macros themselves document how to
379 ** change your code to avoid using them.
381 #define lua_strlen(L,i) lua_rawlen(L, (i))
383 #define lua_objlen(L,i) lua_rawlen(L, (i))
385 #define lua_equal(L,idx1,idx2) lua_compare(L,(idx1),(idx2),LUA_OPEQ)
386 #define lua_lessthan(L,idx1,idx2) lua_compare(L,(idx1),(idx2),LUA_OPLT)
389 @@ LUA_COMPAT_MODULE controls compatibility with previous
390 ** module functions 'module' (Lua) and 'luaL_register' (C).
392 #define LUA_COMPAT_MODULE
398 @@ LUA_COMPAT_FLOATSTRING makes Lua format integral floats without a
399 @@ a float mark ('.0').
400 ** This macro is not on by default even in compatibility mode,
401 ** because this is not really an incompatibility.
403 /* #define LUA_COMPAT_FLOATSTRING */
405 /* }================================================================== */
410 ** {==================================================================
411 ** Configuration for Numbers.
412 ** Change these definitions if no predefined LUA_FLOAT_* / LUA_INT_*
413 ** satisfy your needs.
414 ** ===================================================================
418 @@ LUA_NUMBER is the floating-point type used by Lua.
419 @@ LUAI_UACNUMBER is the result of a 'default argument promotion'
420 @@ over a floating number.
421 @@ l_mathlim(x) corrects limit name 'x' to the proper float type
422 ** by prefixing it with one of FLT/DBL/LDBL.
423 @@ LUA_NUMBER_FRMLEN is the length modifier for writing floats.
424 @@ LUA_NUMBER_FMT is the format for writing floats.
425 @@ lua_number2str converts a float to a string.
426 @@ l_mathop allows the addition of an 'l' or 'f' to all math operations.
427 @@ l_floor takes the floor of a float.
428 @@ lua_str2number converts a decimal numeric string to a number.
432 /* The following definitions are good for most cases here */
434 #define l_floor(x) (l_mathop(floor)(x))
436 #define lua_number2str(s,sz,n) \
437 l_sprintf((s), sz, LUA_NUMBER_FMT, (LUAI_UACNUMBER)(n))
440 @@ lua_numbertointeger converts a float number to an integer, or
441 ** returns 0 if float is not within the range of a lua_Integer.
442 ** (The range comparisons are tricky because of rounding. The tests
443 ** here assume a two-complement representation, where MININTEGER always
444 ** has an exact representation as a float; MAXINTEGER may not have one,
445 ** and therefore its conversion to float may have an ill-defined value.)
447 #define lua_numbertointeger(n,p) \
448 ((n) >= (LUA_NUMBER)(LUA_MININTEGER) && \
449 (n) < -(LUA_NUMBER)(LUA_MININTEGER) && \
450 (*(p) = (LUA_INTEGER)(n), 1))
453 /* now the variable definitions */
455 #if LUA_FLOAT_TYPE == LUA_FLOAT_FLOAT /* { single float */
457 #define LUA_NUMBER float
459 #define l_mathlim(n) (FLT_##n)
461 #define LUAI_UACNUMBER double
463 #define LUA_NUMBER_FRMLEN ""
464 #define LUA_NUMBER_FMT "%.7g"
466 #define l_mathop(op) op##f
468 #define lua_str2number(s,p) strtof((s), (p))
471 #elif LUA_FLOAT_TYPE == LUA_FLOAT_LONGDOUBLE /* }{ long double */
473 #define LUA_NUMBER long double
475 #define l_mathlim(n) (LDBL_##n)
477 #define LUAI_UACNUMBER long double
479 #define LUA_NUMBER_FRMLEN "L"
480 #define LUA_NUMBER_FMT "%.19Lg"
482 #define l_mathop(op) op##l
484 #define lua_str2number(s,p) strtold((s), (p))
486 #elif LUA_FLOAT_TYPE == LUA_FLOAT_DOUBLE /* }{ double */
488 #define LUA_NUMBER double
490 #define l_mathlim(n) (DBL_##n)
492 #define LUAI_UACNUMBER double
494 #define LUA_NUMBER_FRMLEN ""
495 #define LUA_NUMBER_FMT "%.14g"
497 #define l_mathop(op) op
499 #define lua_str2number(s,p) strtod((s), (p))
503 #error "numeric float type not defined"
510 @@ LUA_INTEGER is the integer type used by Lua.
512 @@ LUA_UNSIGNED is the unsigned version of LUA_INTEGER.
514 @@ LUAI_UACINT is the result of a 'default argument promotion'
515 @@ over a lUA_INTEGER.
516 @@ LUA_INTEGER_FRMLEN is the length modifier for reading/writing integers.
517 @@ LUA_INTEGER_FMT is the format for writing integers.
518 @@ LUA_MAXINTEGER is the maximum value for a LUA_INTEGER.
519 @@ LUA_MININTEGER is the minimum value for a LUA_INTEGER.
520 @@ lua_integer2str converts an integer to a string.
524 /* The following definitions are good for most cases here */
526 #define LUA_INTEGER_FMT "%" LUA_INTEGER_FRMLEN "d"
528 #define LUAI_UACINT LUA_INTEGER
530 #define lua_integer2str(s,sz,n) \
531 l_sprintf((s), sz, LUA_INTEGER_FMT, (LUAI_UACINT)(n))
534 ** use LUAI_UACINT here to avoid problems with promotions (which
535 ** can turn a comparison between unsigneds into a signed comparison)
537 #define LUA_UNSIGNED unsigned LUAI_UACINT
540 /* now the variable definitions */
542 #if LUA_INT_TYPE == LUA_INT_INT /* { int */
544 #define LUA_INTEGER int
545 #define LUA_INTEGER_FRMLEN ""
547 #define LUA_MAXINTEGER INT_MAX
548 #define LUA_MININTEGER INT_MIN
550 #elif LUA_INT_TYPE == LUA_INT_LONG /* }{ long */
552 #define LUA_INTEGER long
553 #define LUA_INTEGER_FRMLEN "l"
555 #define LUA_MAXINTEGER LONG_MAX
556 #define LUA_MININTEGER LONG_MIN
558 #elif LUA_INT_TYPE == LUA_INT_LONGLONG /* }{ long long */
560 /* use presence of macro LLONG_MAX as proxy for C99 compliance */
561 #if defined(LLONG_MAX) /* { */
562 /* use ISO C99 stuff */
564 #define LUA_INTEGER long long
565 #define LUA_INTEGER_FRMLEN "ll"
567 #define LUA_MAXINTEGER LLONG_MAX
568 #define LUA_MININTEGER LLONG_MIN
570 #elif defined(LUA_USE_WINDOWS) /* }{ */
571 /* in Windows, can use specific Windows types */
573 #define LUA_INTEGER __int64
574 #define LUA_INTEGER_FRMLEN "I64"
576 #define LUA_MAXINTEGER _I64_MAX
577 #define LUA_MININTEGER _I64_MIN
581 #error "Compiler does not support 'long long'. Use option '-DLUA_32BITS' \
582 or '-DLUA_C89_NUMBERS' (see file 'luaconf.h' for details)"
588 #error "numeric integer type not defined"
592 /* }================================================================== */
596 ** {==================================================================
597 ** Dependencies with C99 and other C details
598 ** ===================================================================
602 @@ l_sprintf is equivalent to 'snprintf' or 'sprintf' in C89.
603 ** (All uses in Lua have only one format item.)
605 #if !defined(LUA_USE_C89)
606 #define l_sprintf(s,sz,f,i) snprintf(s,sz,f,i)
608 #define l_sprintf(s,sz,f,i) ((void)(sz), sprintf(s,f,i))
613 @@ lua_strx2number converts an hexadecimal numeric string to a number.
614 ** In C99, 'strtod' does that conversion. Otherwise, you can
615 ** leave 'lua_strx2number' undefined and Lua will provide its own
618 #if !defined(LUA_USE_C89)
619 #define lua_strx2number(s,p) lua_str2number(s,p)
624 @@ lua_number2strx converts a float to an hexadecimal numeric string.
625 ** In C99, 'sprintf' (with format specifiers '%a'/'%A') does that.
626 ** Otherwise, you can leave 'lua_number2strx' undefined and Lua will
627 ** provide its own implementation.
629 #if !defined(LUA_USE_C89)
630 #define lua_number2strx(L,b,sz,f,n) \
631 ((void)L, l_sprintf(b,sz,f,(LUAI_UACNUMBER)(n)))
636 ** 'strtof' and 'opf' variants for math functions are not valid in
637 ** C89. Otherwise, the macro 'HUGE_VALF' is a good proxy for testing the
638 ** availability of these variants. ('math.h' is already included in
639 ** all files that use these macros.)
641 #if defined(LUA_USE_C89) || (defined(HUGE_VAL) && !defined(HUGE_VALF))
642 #undef l_mathop /* variants not available */
643 #undef lua_str2number
644 #define l_mathop(op) (lua_Number)op /* no variant */
645 #define lua_str2number(s,p) ((lua_Number)strtod((s), (p)))
650 @@ LUA_KCONTEXT is the type of the context ('ctx') for continuation
651 ** functions. It must be a numerical type; Lua will use 'intptr_t' if
652 ** available, otherwise it will use 'ptrdiff_t' (the nearest thing to
653 ** 'intptr_t' in C89)
655 #define LUA_KCONTEXT ptrdiff_t
657 #if !defined(LUA_USE_C89) && defined(__STDC_VERSION__) && \
658 __STDC_VERSION__ >= 199901L
660 #if defined(INTPTR_MAX) /* even in C99 this type is optional */
662 #define LUA_KCONTEXT intptr_t
668 @@ lua_getlocaledecpoint gets the locale "radix character" (decimal point).
669 ** Change that if you do not want to use C locales. (Code using this
670 ** macro must include header 'locale.h'.)
672 #if !defined(lua_getlocaledecpoint)
673 #define lua_getlocaledecpoint() (localeconv()->decimal_point[0])
676 /* }================================================================== */
680 ** {==================================================================
681 ** Language Variations
682 ** =====================================================================
686 @@ LUA_NOCVTN2S/LUA_NOCVTS2N control how Lua performs some
687 ** coercions. Define LUA_NOCVTN2S to turn off automatic coercion from
688 ** numbers to strings. Define LUA_NOCVTS2N to turn off automatic
689 ** coercion from strings to numbers.
691 /* #define LUA_NOCVTN2S */
692 /* #define LUA_NOCVTS2N */
696 @@ LUA_USE_APICHECK turns on several consistency checks on the C API.
697 ** Define it as a help when debugging C code.
699 #if defined(LUA_USE_APICHECK)
701 #define luai_apicheck(l,e) assert(e)
704 /* }================================================================== */
708 ** {==================================================================
709 ** Macros that affect the API and must be stable (that is, must be the
710 ** same when you compile Lua and when you compile code that links to
711 ** Lua). You probably do not want/need to change them.
712 ** =====================================================================
716 @@ LUAI_MAXSTACK limits the size of the Lua stack.
717 ** CHANGE it if you need a different limit. This limit is arbitrary;
718 ** its only purpose is to stop Lua from consuming unlimited stack
719 ** space (and to reserve some numbers for pseudo-indices).
721 #if LUAI_BITSINT >= 32
722 #define LUAI_MAXSTACK 1000000
724 #define LUAI_MAXSTACK 15000
729 @@ LUA_EXTRASPACE defines the size of a raw memory area associated with
730 ** a Lua state with very fast access.
731 ** CHANGE it if you need a different size.
733 #define LUA_EXTRASPACE (sizeof(void *))
737 @@ LUA_IDSIZE gives the maximum size for the description of the source
738 @@ of a function in debug information.
739 ** CHANGE it if you want a different size.
741 #define LUA_IDSIZE 60
745 @@ LUAL_BUFFERSIZE is the buffer size used by the lauxlib buffer system.
746 ** CHANGE it if it uses too much C-stack space. (For long double,
747 ** 'string.format("%.99f", -1e4932)' needs 5034 bytes, so a
748 ** smaller buffer would force a memory allocation for each call to
751 #if LUA_FLOAT_TYPE == LUA_FLOAT_LONGDOUBLE
752 #define LUAL_BUFFERSIZE 8192
754 #define LUAL_BUFFERSIZE ((int)(0x80 * sizeof(void*) * sizeof(lua_Integer)))
757 /* }================================================================== */
761 @@ LUA_QL describes how error messages quote program elements.
762 ** Lua does not use these macros anymore; they are here for
763 ** compatibility only.
765 #define LUA_QL(x) "'" x "'"
766 #define LUA_QS LUA_QL("%s")
771 /* =================================================================== */
774 ** Local configuration. You can use this space to add your redefinitions
775 ** without modifying the main part of the file.