summaryrefslogtreecommitdiff
path: root/eclass/latex-package.eclass
blob: 3d2c09754775154a028406411eac8d63f254dc3f (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
# Copyright 1999-2020 Gentoo Authors
# Distributed under the terms of the GNU General Public License v2

# @ECLASS: latex-package.eclass
# @MAINTAINER:
# TeX team <tex@gentoo.org>
# @AUTHOR:
# Matthew Turk <satai@gentoo.org>
# Martin Ehmsen <ehmsen@gentoo.org>
# @SUPPORTED_EAPIS: 7
# @BLURB: An eclass for easy installation of LaTeX packages
# @DESCRIPTION:
# This eClass is designed to be easy to use and implement.  The vast majority of
# LaTeX packages will only need to define SRC_URI (and sometimes S) for a
# successful installation.  If fonts need to be installed, then the variable
# SUPPLIER must also be defined.
#
# However, those packages that contain subdirectories must process each
# subdirectory individually.  For example, a package that contains directories
# DIR1 and DIR2 must call latex-package_src_compile() and
# latex-package_src_install() in each directory, as shown here:
#
# src_compile() {
#    cd ${S}
#    cd DIR1
#    latex-package_src_compile
#    cd ..
#    cd DIR2
#    latex-package_src_compile
# }
#
# src_install() {
#    cd ${S}
#    cd DIR1
#    latex-package_src_install
#    cd ..
#    cd DIR2
#    latex-package_src_install
# }
#
# The eClass automatically takes care of rehashing TeX's cache (ls-lR) after
# installation and after removal, as well as creating final documentation from
# TeX files that come with the source.  Note that we break TeX layout standards
# by placing documentation in /usr/share/doc/${PN}
#
# For examples of basic installations, check out dev-tex/aastex and
# dev-tex/leaflet .
#
# NOTE: The CTAN "directory grab" function creates files with different MD5
# signatures EVERY TIME.  For this reason, if you are grabbing from the CTAN,
# you must either grab each file individually, or find a place to mirror an
# archive of them.  (iBiblio)

if [[ -z ${_LATEX_PACKAGE_ECLASS} ]]; then
_LATEX_PACKAGE_ECLASS=1

RDEPEND="virtual/latex-base"
DEPEND="${RDEPEND}
	>=sys-apps/texinfo-4.2-r5"

case ${EAPI:-0} in
	[0-6])
		die "Unsupported EAPI=${EAPI:-0} (too old) for ${ECLASS}" ;;
	7)	;;
	*)	die "Unsupported EAPI=${EAPI} (unknown) for ${ECLASS}" ;;
esac

HOMEPAGE="http://www.tug.org/"
TEXMF="/usr/share/texmf-site"

# @ECLASS-VARIABLE: SUPPLIER
# @DESCRIPTION:
# This refers to the font supplier; it should be overridden (see eclass
# DESCRIPTION above)
SUPPLIER="misc"

# @ECLASS-VARIABLE: LATEX_DOC_ARGUMENTS
# @DESCRIPTION:
# When compiling documentation (.tex/.dtx), this variable will be passed
# to pdflatex as additional argument (e.g. -shell-escape). This variable
# must be set after inherit, as it gets automatically cleared otherwise.
LATEX_DOC_ARGUMENTS=""

# @FUNCTION: latex-package_src_doinstall
# @USAGE: [ module ]
# @DESCRIPTION:
# [module] can be one or more of: sh, sty, cls, fd, clo, def, cfg, dvi, ps, pdf,
# tex, dtx, tfm, vf, afm, pfb, ttf, bst, styles, doc, fonts, bin, or all.
# If [module] is not given, all is assumed.
# It installs the files found in the current directory to the standard locations
# for a TeX installation
latex-package_src_doinstall() {
	debug-print function $FUNCNAME $*

	# Avoid generating font cache outside of the sandbox
	export VARTEXFONTS="${T}/fonts"

	# This actually follows the directions for a "single-user" system
	# at http://www.ctan.org/installationadvice/ modified for gentoo.
	[[ -z ${1} ]] && latex-package_src_install all

	while [[ ${1} ]]; do
		case ${1} in
			"sh")
				while IFS= read -r -d '' i; do
					dobin ${i}
				done < <(find -maxdepth 1 -type f -name "*.${1}" -print0)
				;;

			"sty" | "cls" | "fd" | "clo" | "def" | "cfg")
				while IFS= read -r -d '' i; do
					insinto ${TEXMF}/tex/latex/${PN}
					doins ${i}
				done < <(find -maxdepth 1 -type f -name "*.${1}" -print0)
				;;

			"dvi" | "ps" | "pdf")
				while IFS= read -r -d '' i; do
					insinto /usr/share/doc/${PF}
					doins ${i}
					dosym /usr/share/doc/${PF}/$(basename ${i}) ${TEXMF}/doc/latex/${PN}/${i}
					docompress -x /usr/share/doc/${PF}/$(basename ${i})
				done < <(find -maxdepth 1 -type f -name "*.${1}" -print0)
				;;

			"tex" | "dtx")
				if ! in_iuse doc || use doc ; then
					while IFS= read -r -d '' i; do
						[[ -n ${LATEX_PACKAGE_SKIP} ]] &&
						has ${i##*/} ${LATEX_PACKAGE_SKIP} &&
						continue

						einfo "Making documentation: ${i}"
						# some macros need compiler called twice, do it here.
						set -- pdflatex ${LATEX_DOC_ARGUMENTS} --halt-on-error --interaction=nonstopmode ${i}
						if "${@}"; then
							"${@}"
						else
							einfo "pdflatex failed, trying texi2dvi"
							texi2dvi -q -c --language=latex ${i} || die
						fi
					done < <(find -maxdepth 1 -type f -name "*.${1}" -print0)
				fi
				;;

			"tfm" | "vf" | "afm")
				while IFS= read -r -d '' i; do
					insinto ${TEXMF}/fonts/${1}/${SUPPLIER}/${PN}
					doins ${i}
				done < <(find -maxdepth 1 -type f -name "*.${1}" -print0)
				;;

			"pfb")
				while IFS= read -r -d '' i; do
					insinto ${TEXMF}/fonts/type1/${SUPPLIER}/${PN}
					doins ${i}
				done < <(find -maxdepth 1 -type f -name "*.pfb" -print0)
				;;
			"ttf")
				while IFS= read -r -d '' i; do
					insinto ${TEXMF}/fonts/truetype/${SUPPLIER}/${PN}
					doins ${i}
				done < <(find -maxdepth 1 -type f -name "*.ttf" -print0)
				;;
			"bst")
				while IFS= read -r -d '' i; do
					insinto ${TEXMF}/bibtex/bst/${PN}
					doins ${i}
				done < <(find -maxdepth 1 -type f -name "*.bst" -print0)
				;;

			"styles")
				latex-package_src_doinstall sty cls fd clo def cfg bst
				;;

			"doc")
				latex-package_src_doinstall tex dtx dvi ps pdf
				;;

			"fonts")
				latex-package_src_doinstall tfm vf afm pfb ttf
				;;

			"bin")
				latex-package_src_doinstall sh
				;;

			"all")
				latex-package_src_doinstall styles fonts bin doc
				;;
		esac
	shift
	done
}

# @FUNCTION: latex-package_src_compile
# @DESCRIPTION:
# Calls latex for each *.ins in the current directory in order to generate the
# relevant files that will be installed
latex-package_src_compile() {
	debug-print function $FUNCNAME $*
	while IFS= read -r -d '' i; do
		einfo "Extracting from ${i}"
		latex --halt-on-error --interaction=nonstopmode ${i} || die
	done < <(find -maxdepth 1 -type f -name "*.ins" -print0)
}

# @FUNCTION: latex-package_src_install
# @DESCRIPTION:
# Installs the package
latex-package_src_install() {
	debug-print function $FUNCNAME $*
	latex-package_src_doinstall all
	einstalldocs
}

# @FUNCTION: latex-package_pkg_postinst
# @DESCRIPTION:
# Calls latex-package_rehash to ensure the TeX installation is consistent with
# the kpathsea database
latex-package_pkg_postinst() {
	debug-print function $FUNCNAME $*
	latex-package_rehash
}

# @FUNCTION: latex-package_pkg_postrm
# @DESCRIPTION:
# Calls latex-package_rehash to ensure the TeX installation is consistent with
# the kpathsea database
latex-package_pkg_postrm() {
	debug-print function $FUNCNAME $*
	latex-package_rehash
}

# @FUNCTION: latex-package_rehash
# @DESCRIPTION:
# Rehashes the kpathsea database, according to the current TeX installation
latex-package_rehash() {
	debug-print function $FUNCNAME $*
	texmf-update
}

EXPORT_FUNCTIONS src_compile src_install pkg_postinst pkg_postrm

fi