aboutsummaryrefslogtreecommitdiff
blob: d0ca6eab0788db159d133879a66282719d456f16 (plain)
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
# Copyright 1999-2007 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header

#
# Version: 0.08 (2008-02-23)
# Authors: Markus Dittrich <markusle@gentoo.org>
#
# The octave-forge eclass installs and manages the split
# octave-forge packages. In a nutshell, it does two things:
# 1) Compile (if necessary) and install individual octave-forge
#    packages
# 2) Add/Remove the octave-forge package and its description
#    from the database file in
#       /usr/share/octave/octave_packages
#    such that octave knows what octave-forge packages are
#    installed and what functionality they provide.
#
# The individual octave-forge packages should only need to inherit
# this eclass and possible have some additional dependencies and/or
# custom patches.
#

HOMEPAGE="http://octave.sourceforge.net"
SLOT="0"
LICENSE="GPL-2"

EXPORT_FUNCTIONS src_compile src_install pkg_postinst pkg_prerm

# unless requested otherwise we're happy with octave-3.0.0
NEED_OCTAVE=${NEED_OCTAVE:-3.0.0}

DEPEND="${DEPEND}
	>=sci-mathematics/octave-${NEED_OCTAVE}
	|| ( >=sys-apps/coreutils-6.10-r1 sys-apps/mktemp )"
RDEPEND="${RDEPEND}
	>=sci-mathematics/octave-${NEED_OCTAVE}"


#################################################################
# define global paths needed for the install
#################################################################
OCT_PKG=${P#octave-forge-}
OCT_PKG_NAME=${PN#octave-forge-}
OCT_INSTALL_ROOT=/usr/share/octave
OCT_INSTALL_PKG="${OCT_INSTALL_ROOT}/packages/${OCT_PKG}"
OCT_BINARY=$(type -p octave)
OCT_DATABASE="${OCT_INSTALL_ROOT}/octave_packages"
OCT_DESC="${OCT_INSTALL_PKG}/packinfo/DESCRIPTION"
S="${WORKDIR}/${OCT_PKG}"
OCT_DESC_SRC="${S}/DESCRIPTION"


################################################################
# generate the name of the architecture dependend install
# directory for binary files (*.mex, *.oct)
################################################################
octave_getarch() {
	local host_type="$(octave-config -p CANONICAL_HOST_TYPE)";
	eval $1="${host_type}-$(octave-config -p API_VERSION)";
}


#################################################################
# determine if autoload is requested
#################################################################
check_autoload() {
	local answer="$(fgrep -i 'autoload' "${OCT_DESC_SRC}"  | cut -d' ' -f2)"
	if [[  "${answer}" == "yes" \
		|| "${answer}" == "true" \
		|| "${answer}" == "0" \
		|| "${answer}" == "1" ]]; then
			eval $1="${answer}"
	fi
}

#################################################################
# extract package description from the DESCRIPTION file into
# an array so we can use it later to update the octave database
#################################################################
get_description()
{
	local count=0
	local tracker=0
	local line
	while read line
	do
		if [[ "${line}" == *:* ]]; then
			keys[${count}]=$(echo "${line}" | cut -f1 -d: | sed -e "s: $::g" | gawk '{ print tolower($1)}')
			values[${count}]=$(echo "${line}" | cut -f2 -d: | sed -e "s:^ ::g")
			if [[ ${keys[count]} == "depends" ]]; then
				tracker=${count}
			fi

			(( count++ ))
		fi
	done < "${OCT_DESC}"

	# further separate depend string
	local depend_value=${values[tracker]}
	depend_value=${depend_value/\(/}
	depend_value=${depend_value/\)/}
	pkg_name=$(echo ${depend_value} | cut -d' ' -f1)
	operator=$(echo ${depend_value} | cut -d' ' -f2)
	version=$(echo ${depend_value} | cut -d' ' -f3)
}


################################################################
# this function reads the DESCRIPTION file into a bash array,
# then uses the latter to generate a temporary octave file and
# finally calls octave on the temporary file to update the
# database
################################################################
add_pkg_to_database()
{
	# read properties from DESCRIPTION file
	declare -a keys
	declare -a values
	get_description

	# securely generate tmp file
	OCT_TMP=$(mktemp generate-database.XXXXXXXXXX) \
		|| die "Failed to generate temporary file."

	if [ -e "${OCT_DATABASE}" ]; then
		echo "global_packages = load (\"${OCT_DATABASE}\").global_packages;" >> "${OCT_TMP}"
	else
		echo "global_packages = {};" >> "${OCT_TMP}"
	fi

	echo "new_package = struct();" >> "${OCT_TMP}"

	# path to parent of directory holding mex/oct files
	local libexec_dir="${OCT_INSTALL_PKG}"
	echo "new_package.archprefix = \"${libexec_dir}\";" \
		>> "${OCT_TMP}"

	for ((count=0; count < ${#keys[*]}; count++)); do
		# the depend string needs a separate struct
		if [[ ${keys[count]} == "depends" ]]; then
			echo "temp = struct(\"operator\",\"${operator}\",\"package\",\"${pkg_name}\",\"version\",\"${version}\");" >> "${OCT_TMP}"
			echo "foo = {temp};" >> "${OCT_TMP}"
			echo "new_package.depends = foo;" >> "${OCT_TMP}"
		elif [[ ${keys[count]} == "name" ]]; then
			echo "new_package.${keys[count]} = lower(\"${values[count]}\");" >> "${OCT_TMP}"
		else
			echo "new_package.${keys[count]} = \"${values[count]}\";" >> "${OCT_TMP}"
		fi
	done

	cat >> "${OCT_TMP}" <<-EOF
		new_package.dir = "${OCT_INSTALL_PKG}";
		global_packages = { global_packages{:}, new_package};
		save("${OCT_DATABASE}","global_packages");
	EOF

	# let octave do the final setup of the database file
	echo
	ebegin "Adding package to global octave database."
	"${OCT_BINARY}" -q "${OCT_TMP}" >& /dev/null
	eend $?
	echo;

	# remove the temporary octave file
	rm -f "${OCT_TMP}" \
		|| die "Failed to remove temporary octave database code."
}


#################################################################
# this function removes an octave-forge package from the
# to global package database
#################################################################
delete_pkg_from_database()
{
	# read properties from DESCRIPTION file
	declare -a keys
	declare -a values
	get_description

	local remove_name
	for ((count=0; count < ${#keys[*]}; count++)); do
		if [[ ${keys[count]} == "name" ]]; then
			remove_name=${values[count]}
		fi
	done

	# securely generate tmp file
	OCT_TMP=$(mktemp /tmp/generate-database.XXXXXXXXXX) || \
		die "Failed to generate temporary file."

	# generate octave code to remove relevant entry from
	# global file
	cat >> "${OCT_TMP}" <<-EOF
		old_packages = load ("${OCT_DATABASE}").global_packages;
		global_packages = {};
		purge_name = lower("${remove_name}");
		for i=1:length(old_packages);
		if ( !strcmp(old_packages{i}.name,purge_name));
		global_packages = {global_packages{:}, old_packages{i}}; endif; endfor;
		save ("${OCT_DATABASE}","global_packages");
	EOF

	# let octave do the final setup of the database file
	echo
	ebegin "Removing from database"
	"${OCT_BINARY}" -q "${OCT_TMP}"  >& /dev/null
	eend $?

	# if the database file is empty we get rid of it completely
	# otherwise octave will be confused. To do so, we simply
	# check if there are any author fields left.
	fgrep 'author' "${OCT_DATABASE}"  >& /dev/null
	if [[ $? == 1 ]]; then
		ebegin "Purging empty database"
		rm -f "${OCT_DATABASE}"
		eend $?
	fi
	echo

	# remove the temporary octave file
	rm -f "${OCT_TMP}" \
		|| die "Failed to remove temporary octave database code."
}


#################################################################
# our custom src_compile tries to do the Right Thing for each
# of the individual octave-forge packages. Some require
# compilation via configure/make, make only, and some simply
# install several *.m files without any compilation at all.
#################################################################
octave-forge_src_compile() {
	cd "${S}"

	# check for configure/makefile since not all octave-forge
	# packages have one
	if [[ -e src/configure ]]; then
		pushd . && cd src/
		econf || die "configure failed in src"
		popd
	fi

	if [[ -e src/Makefile ]]; then
		pushd . && cd src/
		emake -j1 || die "make failed in src"
		popd
	fi

	# we need to check if there are any examples
	# to build as well
	if [[ -e examples/configure ]]; then
		pushd . && cd examples/
		econf || die "configure failed in examples"
		popd
	fi

	if [[ -e examples/Makefile ]]; then
		pushd . && cd examples/
		emake -j1 || die "make failed in examples"
		popd
	fi
}


####################################################################
# install *.m and *.oct/*.mex files if present into the locations
# where octave expects them.
####################################################################
octave-forge_src_install() {
	cd "${S}"

	# get arch string
	local octave_arch=""
	octave_getarch octave_arch

	# check if we have *.m, *.mex, and *.oct files in src
	m_files=$(find ./src -type f -name "*.m" -print0 2> /dev/null)
	oct_files=$(find ./src -type f -name "*.oct" -print0 2> /dev/null)
	mex_files=$(find ./src -type f -name "*.mex" -print0 2> /dev/null)

	# install *.m files
	insinto "${OCT_INSTALL_PKG}"
	if [[ -n "${m_files}" ]]; then
		doins src/*.m \
			|| die "failed to install m files"
	fi

	# install *.mex/*.oct files if present
	if [[ -n "${oct_files}" || -n "${mex_files}" ]]; then
		insinto "${OCT_INSTALL_PKG}/${octave_arch}"
		if [[ -n "${oct_files}" ]]; then
			doins src/*.oct \
				|| die "failed to install oct files"
		fi
		if [[ -n "${mex_files}" ]]; then
			doins src/*.mex \
				|| die "failed to install mex files"
		fi
	fi

	# include PKG_ADD and PKG_DEL
	# TODO: need to scan included *.m *.cc files for
	# additional PKG_ADD/PKG_DEL commands for appending
	if [[ -e "${S}/PKG_ADD" ]]; then
		insinto "${OCT_INSTALL_PKG}"
		doins "${S}/PKG_ADD" \
			|| die "failed to install PKG_ADD"
	fi
	if [[ -e "${S}/PKG_DEL" ]]; then
		insinto "${OCT_INSTALL_PKG}"
		doins "${S}/PKG_DEL" \
			|| die "failed to install PKG_ADD"
	fi

	# copy files in inst if they exits
	if [[ -d "${S}"/inst ]]; then
		insinto "${OCT_INSTALL_PKG}"
		doins inst/* \
			|| die "failed to install inst/"
	fi

	# check for on_uninstall.m and install if present
	local uninstall_file=$(find "${S}" -name 'on_uninstall.m')
	if [[ -n "${uninstall_file}" ]]; then
		doins "${uninstall_file}" \
			|| die "failed to install on_uninstall.m"
	fi

	# copy files in packinfo
	insinto "${OCT_INSTALL_PKG}"/packinfo
	doins COPYING DESCRIPTION \
		|| die "failed to install packinfo files"

	# copy Changelog if present
	if [[ -e "Changelog" ]]; then
		doins Changelog \
			|| die "failed to install Changelog"
	fi

	# mark package as autoload if requested
	local want_autoload=""
	check_autoload want_autoload
	if [[ -n "${want_autoload}" ]]; then
		touch "${T}"/.autoload && doins "${T}"/.autoload \
			|| die "failed to install autoload"
	fi

	# check for index file
	# TODO: need to generate index file in case it is missing
	local index_file=$(find "${S}" -name 'INDEX')
	if [ -n "${index_file}" ]; then
		doins "${index_file}" \
			|| die "failed to install INDEX"
	fi

	# check for doc directory and install content if present
	if [[ -d "${S}"/doc ]]; then
		insinto "${OCT_INSTALL_PKG}"/doc
		doins doc/* \
			|| die "failed to install docs"
	fi

	# check for bin directory and install content if present
	if [[ -d "${S}"/bin ]]; then
		insinto "${OCT_INSTALL_PKG}"/bin
		doins bin/* \
			|| die "failed to install bin"
	fi

	# check for examples to be installed
	if [[ -d "${S}"/examples ]]; then
		insinto "${OCT_INSTALL_PKG}"/examples
		doins examples/*.m examples/*.oct examples/README \
			|| die "failed to install example files"
	fi
}


##################################################################
# after installing add package to global octave database
##################################################################
octave-forge_pkg_postinst() {
	add_pkg_to_database
}


##################################################################
# after unmerging remove package from global octave database
##################################################################
octave-forge_pkg_prerm() {
	delete_pkg_from_database
}