forked from gentoo/gentoo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
lua-utils.eclass
538 lines (473 loc) · 14.5 KB
/
lua-utils.eclass
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
# Copyright 1999-2024 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2
# @ECLASS: lua-utils.eclass
# @MAINTAINER:
# William Hubbs <[email protected]>
# @AUTHOR:
# Marek Szuba <[email protected]>
# Based on python-utils-r1.eclass by Michał Górny <[email protected]> et al.
# @SUPPORTED_EAPIS: 7 8
# @BLURB: Utility functions for packages with Lua parts
# @DESCRIPTION:
# A utility eclass providing functions to query Lua implementations,
# install Lua modules and scripts.
#
# This eclass neither sets any metadata variables nor exports any phase
# functions. It can be inherited safely.
case ${EAPI} in
7|8) ;;
*) die "${ECLASS}: EAPI ${EAPI:-0} not supported" ;;
esac
if [[ -z ${_LUA_UTILS_ECLASS} ]]; then
_LUA_UTILS_ECLASS=1
inherit toolchain-funcs
# @ECLASS_VARIABLE: _LUA_ALL_IMPLS
# @INTERNAL
# @DESCRIPTION:
# All supported Lua implementations, most preferred last
_LUA_ALL_IMPLS=(
luajit
lua5-1
lua5-3
lua5-4
)
readonly _LUA_ALL_IMPLS
# @ECLASS_VARIABLE: _LUA_HISTORICAL_IMPLS
# @INTERNAL
# @DESCRIPTION:
# All historical Lua implementations that are no longer supported.
_LUA_HISTORICAL_IMPLS=(
lua5-2
)
readonly _LUA_HISTORICAL_IMPLS
# @FUNCTION: _lua_set_impls
# @INTERNAL
# @DESCRIPTION:
# Check LUA_COMPAT for well-formedness and validity, then set
# two global variables:
#
# - _LUA_SUPPORTED_IMPLS containing valid implementations supported
# by the ebuild (LUA_COMPAT minus dead implementations),
#
# - and _LUA_UNSUPPORTED_IMPLS containing valid implementations that
# are not supported by the ebuild.
#
# Implementations in both variables are ordered using the pre-defined
# eclass implementation ordering.
#
# This function must only be called once.
_lua_set_impls() {
local i
if ! declare -p LUA_COMPAT &>/dev/null; then
die 'LUA_COMPAT not declared.'
fi
if [[ $(declare -p LUA_COMPAT) != "declare -a"* ]]; then
die 'LUA_COMPAT must be an array.'
fi
local supp=() unsupp=()
for i in "${_LUA_ALL_IMPLS[@]}"; do
if has "${i}" "${LUA_COMPAT[@]}"; then
supp+=( "${i}" )
else
unsupp+=( "${i}" )
fi
done
if [[ ! ${supp[@]} ]]; then
die "No supported implementation in LUA_COMPAT."
fi
if [[ ${_LUA_SUPPORTED_IMPLS[@]} ]]; then
# set once already, verify integrity
if [[ ${_LUA_SUPPORTED_IMPLS[@]} != ${supp[@]} ]]; then
eerror "Supported impls (LUA_COMPAT) changed between inherits!"
eerror "Before: ${_LUA_SUPPORTED_IMPLS[*]}"
eerror "Now : ${supp[*]}"
die "_LUA_SUPPORTED_IMPLS integrity check failed"
fi
if [[ ${_LUA_UNSUPPORTED_IMPLS[@]} != ${unsupp[@]} ]]; then
eerror "Unsupported impls changed between inherits!"
eerror "Before: ${_LUA_UNSUPPORTED_IMPLS[*]}"
eerror "Now : ${unsupp[*]}"
die "_LUA_UNSUPPORTED_IMPLS integrity check failed"
fi
else
_LUA_SUPPORTED_IMPLS=( "${supp[@]}" )
_LUA_UNSUPPORTED_IMPLS=( "${unsupp[@]}" )
readonly _LUA_SUPPORTED_IMPLS _LUA_UNSUPPORTED_IMPLS
fi
}
# @FUNCTION: _lua_wrapper_setup
# @USAGE: [<path> [<impl>]]
# @INTERNAL
# @DESCRIPTION:
# Create proper Lua executables and pkg-config wrappers
# (if available) in the directory named by <path>. Set up PATH
# and PKG_CONFIG_PATH appropriately. <path> defaults to ${T}/${ELUA}.
#
# The wrappers will be created for implementation named by <impl>,
# or for one named by ${ELUA} if no <impl> passed.
#
# If the named directory contains a lua symlink already, it will
# be assumed to contain proper wrappers already and only environment
# setup will be done. If wrapper update is requested, the directory
# shall be removed first.
_lua_wrapper_setup() {
debug-print-function ${FUNCNAME} "${@}"
local workdir=${1:-${T}/${ELUA}}
local impl=${2:-${ELUA}}
[[ ${workdir} ]] || die "${FUNCNAME}: no workdir specified."
[[ ${impl} ]] || die "${FUNCNAME}: no impl nor ELUA specified."
if [[ ! -x ${workdir}/bin/lua ]]; then
mkdir -p "${workdir}"/{bin,pkgconfig} || die
# Clean up, in case we were supposed to do a cheap update
rm -f "${workdir}"/bin/lua{,c} || die
rm -f "${workdir}"/pkgconfig/lua.pc || die
local ELUA LUA
_lua_export "${impl}" ELUA LUA
# Lua interpreter
ln -s "${LUA}" "${workdir}"/bin/lua || die
# Lua compiler, or a stub for it in case of luajit
if [[ ${ELUA} == luajit ]]; then
# Just in case
ln -s "${BROOT}"/bin/true "${workdir}"/bin/luac || die
else
ln -s "${BROOT}"/usr/bin/${ELUA/a/ac} "${workdir}"/bin/luac || die
fi
# pkg-config
ln -s "${ESYSROOT}"/usr/$(get_libdir)/pkgconfig/${ELUA}.pc \
"${workdir}"/pkgconfig/lua.pc || die
fi
# Now, set the environment.
# But note that ${workdir} may be shared with something else,
# and thus already on top of PATH.
if [[ ${PATH##:*} != ${workdir}/bin ]]; then
PATH=${workdir}/bin${PATH:+:${PATH}}
fi
if [[ ${PKG_CONFIG_PATH##:*} != ${workdir}/pkgconfig ]]; then
PKG_CONFIG_PATH=${workdir}/pkgconfig${PKG_CONFIG_PATH:+:${PKG_CONFIG_PATH}}
fi
export PATH PKG_CONFIG_PATH
}
# @ECLASS_VARIABLE: ELUA
# @DEFAULT_UNSET
# @DESCRIPTION:
# The executable name of the current Lua interpreter. This variable is set
# automatically in functions called by lua_foreach_impl().
#
# Example value:
# @CODE
# lua5.1
# @CODE
# @ECLASS_VARIABLE: LUA
# @DEFAULT_UNSET
# @DESCRIPTION:
# The absolute path to the current Lua interpreter. This variable is set
# automatically in functions called by lua_foreach_impl().
#
# Example value:
# @CODE
# /usr/bin/lua5.1
# @CODE
# @FUNCTION: _lua_get_library_file
# @USAGE: <impl>
# @INTERNAL
# @DESCRIPTION:
# Get the core part (i.e. without the extension) of the library name,
# with path, of the given Lua implementation.
# Used internally by _lua_export().
_lua_get_library_file() {
local impl="${1}"
local libdir libname
case ${impl} in
luajit)
libname=lib$($(tc-getPKG_CONFIG) --variable libname ${impl}) || die
;;
lua*)
libname=lib${impl}
;;
*)
die "Invalid implementation: ${impl}"
;;
esac
libdir=$($(tc-getPKG_CONFIG) --variable libdir ${impl}) || die
libdir="${libdir#${ESYSROOT#${SYSROOT}}}"
debug-print "${FUNCNAME}: libdir = ${libdir}, libname = ${libname}"
echo "${libdir}/${libname}"
}
# @FUNCTION: _lua_export
# @USAGE: [<impl>] <variables>...
# @INTERNAL
# @DESCRIPTION:
# Set and export the Lua implementation-relevant variables passed
# as parameters.
#
# The optional first parameter may specify the requested Lua
# implementation (either as LUA_TARGETS value, e.g. lua5-4,
# or an ELUA one, e.g. lua5.4). If no implementation passed,
# the current one will be obtained from ${ELUA}.
_lua_export() {
debug-print-function ${FUNCNAME} "${@}"
local impl var
case "${1}" in
luajit)
impl=${1}
shift
;;
lua*)
impl=${1/-/.}
shift
;;
*)
impl=${ELUA}
if [[ -z ${impl} ]]; then
die "_lua_export called without a Lua implementation and ELUA is unset"
fi
;;
esac
debug-print "${FUNCNAME}: implementation: ${impl}"
for var; do
case "${var}" in
ELUA)
export ELUA=${impl}
debug-print "${FUNCNAME}: ELUA = ${ELUA}"
;;
LUA)
export LUA="${BROOT}"/usr/bin/${impl}
debug-print "${FUNCNAME}: LUA = ${LUA}"
;;
LUA_CFLAGS)
local val
val=$($(tc-getPKG_CONFIG) --cflags ${impl}) || die
export LUA_CFLAGS=${val}
debug-print "${FUNCNAME}: LUA_CFLAGS = ${LUA_CFLAGS}"
;;
LUA_CMOD_DIR)
local val
val=$($(tc-getPKG_CONFIG) --variable INSTALL_CMOD ${impl}) || die
val="${val#${ESYSROOT#${SYSROOT}}}"
export LUA_CMOD_DIR=${val}
debug-print "${FUNCNAME}: LUA_CMOD_DIR = ${LUA_CMOD_DIR}"
;;
LUA_INCLUDE_DIR)
local val
val=$($(tc-getPKG_CONFIG) --variable includedir ${impl}) || die
val="${val#${ESYSROOT#${SYSROOT}}}"
export LUA_INCLUDE_DIR=${val}
debug-print "${FUNCNAME}: LUA_INCLUDE_DIR = ${LUA_INCLUDE_DIR}"
;;
LUA_LIBS)
local val
val=$($(tc-getPKG_CONFIG) --libs ${impl}) || die
export LUA_LIBS=${val}
debug-print "${FUNCNAME}: LUA_LIBS = ${LUA_LIBS}"
;;
LUA_LMOD_DIR)
local val
val=$($(tc-getPKG_CONFIG) --variable INSTALL_LMOD ${impl}) || die
val="${val#${ESYSROOT#${SYSROOT}}}"
export LUA_LMOD_DIR=${val}
debug-print "${FUNCNAME}: LUA_LMOD_DIR = ${LUA_LMOD_DIR}"
;;
LUA_PKG_DEP)
local d
case ${impl} in
luajit)
LUA_PKG_DEP="dev-lang/luajit:="
;;
lua*)
LUA_PKG_DEP="dev-lang/lua:${impl#lua}"
;;
*)
die "Invalid implementation: ${impl}"
;;
esac
# use-dep
if [[ ${LUA_REQ_USE} ]]; then
LUA_PKG_DEP+=[${LUA_REQ_USE}]
fi
export LUA_PKG_DEP
debug-print "${FUNCNAME}: LUA_PKG_DEP = ${LUA_PKG_DEP}"
;;
LUA_SHARED_LIB)
local val=$(_lua_get_library_file ${impl})
export LUA_SHARED_LIB="${val}".so
debug-print "${FUNCNAME}: LUA_SHARED_LIB = ${LUA_SHARED_LIB}"
;;
LUA_VERSION)
local val
val=$($(tc-getPKG_CONFIG) --modversion ${impl}) || die
export LUA_VERSION=${val}
debug-print "${FUNCNAME}: LUA_VERSION = ${LUA_VERSION}"
;;
*)
die "_lua_export: unknown variable ${var}"
;;
esac
done
}
# @FUNCTION: lua_enable_tests
# @USAGE: <test-runner> <test-directory>
# @DESCRIPTION:
# Set up IUSE, RESTRICT, BDEPEND and src_test() for running tests
# with the specified test runner. Also copies the current value
# of RDEPEND to test?-BDEPEND. The test-runner argument must be one of:
#
# - busted: dev-lua/busted
#
# Additionally, a second argument can be passed after <test-runner>,
# so <test-runner> will use that directory to search for tests.
# If not passed, a default directory of <test-runner> will be used.
#
# - busted: spec
#
# This function is meant as a helper for common use cases, and it only
# takes care of basic setup. You still need to list additional test
# dependencies manually. If you have uncommon use case, you should
# not use it and instead enable tests manually.
#
# This function must be called in global scope, after RDEPEND has been
# declared. Take care not to overwrite the variables set by it.
lua_enable_tests() {
debug-print-function ${FUNCNAME} "${@}"
[[ ${#} -ge 1 ]] || die "${FUNCNAME} takes at least one argument: test-runner (test-directory)"
local test_directory
local test_pkg
case ${1} in
busted)
test_directory="${2:-spec}"
test_pkg="dev-lua/busted"
if [[ ! ${_LUA_SINGLE_ECLASS} ]]; then
eval "lua_src_test() {
busted --lua=\"\${ELUA}\" --output=\"plainTerminal\" \"${test_directory}\" || die \"Tests fail with \${ELUA}\"
}"
src_test() {
lua_foreach_impl lua_src_test
}
else
eval "src_test() {
busted --lua=\"\${ELUA}\" --output=\"plainTerminal\" \"${test_directory}\" || die \"Tests fail with \${ELUA}\"
}"
fi
;;
*)
die "${FUNCNAME}: unsupported argument: ${1}"
esac
local test_deps=${RDEPEND}
if [[ -n ${test_pkg} ]]; then
if [[ ! ${_LUA_SINGLE_ECLASS} ]]; then
test_deps+=" ${test_pkg}[${LUA_USEDEP}]"
else
test_deps+=" $(lua_gen_cond_dep "
${test_pkg}[\${LUA_USEDEP}]
")"
fi
fi
if [[ -n ${test_deps} ]]; then
IUSE+=" test"
RESTRICT+=" !test? ( test )"
BDEPEND+=" test? ( ${test_deps} )"
fi
# we need to ensure successful return in case we're called last,
# otherwise Portage may wrongly assume sourcing failed
return 0
}
# @FUNCTION: lua_get_CFLAGS
# @USAGE: [<impl>]
# @DESCRIPTION:
# Obtain and print the compiler flags for building against Lua,
# for the given implementation. If no implementation is provided,
# ${ELUA} will be used.
#
# Please note that this function requires Lua and pkg-config installed,
# and therefore proper build-time dependencies need be added to the ebuild.
lua_get_CFLAGS() {
debug-print-function ${FUNCNAME} "${@}"
_lua_export "${@}" LUA_CFLAGS
echo "${LUA_CFLAGS}"
}
# @FUNCTION: lua_get_cmod_dir
# @USAGE: [<impl>]
# @DESCRIPTION:
# Obtain and print the name of the directory into which compiled Lua
# modules are installed, for the given implementation. If no implementation
# is provided, ${ELUA} will be used.
#
# Please note that this function requires Lua and pkg-config installed,
# and therefore proper build-time dependencies need be added to the ebuild.
lua_get_cmod_dir() {
debug-print-function ${FUNCNAME} "${@}"
_lua_export "${@}" LUA_CMOD_DIR
echo "${LUA_CMOD_DIR}"
}
# @FUNCTION: lua_get_include_dir
# @USAGE: [<impl>]
# @DESCRIPTION:
# Obtain and print the name of the directory containing header files
# of the given Lua implementation. If no implementation is provided,
# ${ELUA} will be used.
#
# Please note that this function requires Lua and pkg-config installed,
# and therefore proper build-time dependencies need be added to the ebuild.
lua_get_include_dir() {
debug-print-function ${FUNCNAME} "${@}"
_lua_export "${@}" LUA_INCLUDE_DIR
echo "${LUA_INCLUDE_DIR}"
}
# @FUNCTION: lua_get_LIBS
# @USAGE: [<impl>]
# @DESCRIPTION:
# Obtain and print the compiler flags for linking against Lua,
# for the given implementation. If no implementation is provided,
# ${ELUA} will be used.
#
# Please note that this function requires Lua and pkg-config installed,
# and therefore proper build-time dependencies need be added to the ebuild.
lua_get_LIBS() {
debug-print-function ${FUNCNAME} "${@}"
_lua_export "${@}" LUA_LIBS
echo "${LUA_LIBS}"
}
# @FUNCTION: lua_get_lmod_dir
# @USAGE: [<impl>]
# @DESCRIPTION:
# Obtain and print the name of the directory into which native-Lua
# modules are installed, for the given implementation. If no implementation
# is provided, ${ELUA} will be used.
#
# Please note that this function requires Lua and pkg-config installed,
# and therefore proper build-time dependencies need be added to the ebuild.
lua_get_lmod_dir() {
debug-print-function ${FUNCNAME} "${@}"
_lua_export "${@}" LUA_LMOD_DIR
echo "${LUA_LMOD_DIR}"
}
# @FUNCTION: lua_get_shared_lib
# @USAGE: [<impl>]
# @DESCRIPTION:
# Obtain and print the expected name, with path, of the main shared library
# of the given Lua implementation. If no implementation is provided,
# ${ELUA} will be used.
#
# Note that it is up to the ebuild maintainer to ensure Lua actually
# provides a shared library.
#
# Please note that this function requires Lua and pkg-config installed,
# and therefore proper build-time dependencies need be added to the ebuild.
lua_get_shared_lib() {
debug-print-function ${FUNCNAME} "${@}"
_lua_export "${@}" LUA_SHARED_LIB
echo "${LUA_SHARED_LIB}"
}
# @FUNCTION: lua_get_version
# @USAGE: [<impl>]
# @DESCRIPTION:
# Obtain and print the full version number of the given Lua implementation.
# If no implementation is provided, ${ELUA} will be used.
#
# Please note that this function requires Lua and pkg-config installed,
# and therefore proper build-time dependencies need be added to the ebuild.
lua_get_version() {
debug-print-function ${FUNCNAME} "${@}"
_lua_export "${@}" LUA_VERSION
echo "${LUA_VERSION}"
}
fi