gentoo-x86/eclass/latex-package.eclass

# Copyright 1999-2011 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/latex-package.eclass,v 1.38 2009/01/11 21:46:39 ulm Exp $

# @ECLASS: latex-package.eclass
# @MAINTAINER:
# TeX team <tex@gentoo.org>
# @AUTHOR:
# Matthew Turk <satai@gentoo.org>
# Martin Ehmsen <ehmsen@gentoo.org>
# @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)
#
# It inherits base.

inherit base

RDEPEND="virtual/latex-base"
DEPEND="${RDEPEND}
        >=sys-apps/texinfo-4.2-r5"
HOMEPAGE="http://www.tug.org/"
SRC_URI="ftp://tug.ctan.org/macros/latex/"
S=${WORKDIR}/${P}
TEXMF="/usr/share/texmf"

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

# @FUNCTION: latex-package_has_tetex3
# @RETURN: true if at least one of (>=tetex-3 or >=ptex-3.1.8 or >=texlive-core-2007) is installed, else false
# @DESCRIPTION:
# It is often used to know if the current TeX installation supports gentoo's
# texmf-update or if the package has to do it the old way
latex-package_has_tetex_3() {
        if has_version '>=app-text/tetex-3' || has_version '>=app-text/ptex-3.1.8' || has_version '>=app-text/texlive-core-2007' ; then
                true
        else
                false
        fi
}

# @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 $*
        # 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")
                                for i in `find . -maxdepth 1 -type f -name "*.${1}"`
                                do
                                        dobin $i || die "dobin $i failed"
                                done
                                ;;
                        "sty" | "cls" | "fd" | "clo" | "def" | "cfg")
                                for i in `find . -maxdepth 1 -type f -name "*.${1}"`
                                do
                                        insinto ${TEXMF}/tex/latex/${PN}
                                        doins $i || die "doins $i failed"
                                done
                                ;;
                        "dvi" | "ps" | "pdf")
                                for i in `find . -maxdepth 1 -type f -name "*.${1}"`
                                do
                                        insinto /usr/share/doc/${PF}
                                        doins $i || die "doins $i failed"
                                        dosym /usr/share/doc/${PF}/$(basename ${i}) ${TEXMF}/doc/latex/${PN}/${i}
                                        #dodoc -u $i
                                done
                                ;;
                        "tex" | "dtx")
                                for i in `find . -maxdepth 1 -type f -name "*.${1}"`
                                do
                                        einfo "Making documentation: $i"
                                        texi2dvi -q -c --language=latex $i &> /dev/null
                                        done
                                ;;
                        "tfm" | "vf" | "afm")
                                for i in `find . -maxdepth 1 -type f -name "*.${1}"`
                                do
                                        insinto ${TEXMF}/fonts/${1}/${SUPPLIER}/${PN}
                                        doins $i || die "doins $i failed"
                                done
                                ;;
                        "pfb")
                                for i in `find . -maxdepth 1 -type f -name "*.pfb"`
                                do
                                        insinto ${TEXMF}/fonts/type1/${SUPPLIER}/${PN}
                                        doins $i || die "doins $i failed"
                                done
                                ;;
                        "ttf")
                                for i in `find . -maxdepth 1 -type f -name "*.ttf"`
                                do
                                        insinto ${TEXMF}/fonts/truetype/${SUPPLIER}/${PN}
                                        doins $i || die "doins $i failed"
                                done
                                ;;
                        "bst")
                                for i in `find . -maxdepth 1 -type f -name "*.bst"`
                                do
                                        insinto ${TEXMF}/bibtex/bst/${PN}
                                        doins $i || die "doins $i failed"
                                done
                                ;;
                        "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 $*
        for i in `find \`pwd\` -maxdepth 1 -type f -name "*.ins"`
        do
                einfo "Extracting from $i"
                latex --interaction=batchmode $i &> /dev/null
        done
}

# @FUNCTION: latex-package_src_install
# @DESCRIPTION:
# Installs the package
latex-package_src_install() {
        debug-print function $FUNCNAME $*
        latex-package_src_doinstall all
        if [ -n "${DOCS}" ] ; then
                dodoc ${DOCS}
        fi
}

# @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 $*
        if latex-package_has_tetex_3 ; then
                texmf-update
        else
                texconfig rehash
        fi
}

EXPORT_FUNCTIONS src_compile src_install pkg_postinst pkg_postrm
1	vapier	1.39	# Copyright 1999-2011 Gentoo Foundation
2	vapier	1.10	# Distributed under the terms of the GNU General Public License v2
3	vapier	1.39	# $Header: /var/cvsroot/gentoo-x86/eclass/latex-package.eclass,v 1.38 2009/01/11 21:46:39 ulm Exp $
4	aballier	1.32
5			# @ECLASS: latex-package.eclass
6			# @MAINTAINER:
7	aballier	1.33	# TeX team <tex@gentoo.org>
8	vapier	1.39	# @AUTHOR:
9			# Matthew Turk <satai@gentoo.org>
10	ehmsen	1.28	# Martin Ehmsen <ehmsen@gentoo.org>
11	aballier	1.32	# @BLURB: An eclass for easy installation of LaTeX packages
12			# @DESCRIPTION:
13	satai	1.5	# This eClass is designed to be easy to use and implement. The vast majority of
14			# LaTeX packages will only need to define SRC_URI (and sometimes S) for a
15			# successful installation. If fonts need to be installed, then the variable
16			# SUPPLIER must also be defined.
17			#
18			# However, those packages that contain subdirectories must process each
19			# subdirectory individually. For example, a package that contains directories
20			# DIR1 and DIR2 must call latex-package_src_compile() and
21			# latex-package_src_install() in each directory, as shown here:
22			#
23			# src_compile() {
24			# cd ${S}
25			# cd DIR1
26			# latex-package_src_compile
27			# cd ..
28			# cd DIR2
29			# latex-package_src_compile
30			# }
31			#
32			# src_install() {
33			# cd ${S}
34			# cd DIR1
35			# latex-package_src_install
36			# cd ..
37			# cd DIR2
38			# latex-package_src_install
39			# }
40			#
41			# The eClass automatically takes care of rehashing TeX's cache (ls-lR) after
42			# installation and after removal, as well as creating final documentation from
43	swegener	1.25	# TeX files that come with the source. Note that we break TeX layout standards
44	satai	1.5	# by placing documentation in /usr/share/doc/${PN}
45			#
46	satai	1.14	# For examples of basic installations, check out dev-tex/aastex and
47			# dev-tex/leaflet .
48	satai	1.5	#
49			# NOTE: The CTAN "directory grab" function creates files with different MD5
50			# signatures EVERY TIME. For this reason, if you are grabbing from the CTAN,
51			# you must either grab each file individually, or find a place to mirror an
52			# archive of them. (iBiblio)
53	aballier	1.32	#
54			# It inherits base.
55	blocke	1.1
56			inherit base
57
58	aballier	1.37	RDEPEND="virtual/latex-base"
59			DEPEND="${RDEPEND}
60	usata	1.17	>=sys-apps/texinfo-4.2-r5"
61	blocke	1.1	HOMEPAGE="http://www.tug.org/"
62			SRC_URI="ftp://tug.ctan.org/macros/latex/"
63			S=${WORKDIR}/${P}
64			TEXMF="/usr/share/texmf"
65
66	aballier	1.32	# @ECLASS-VARIABLE: SUPPLIER
67			# @DESCRIPTION:
68			# This refers to the font supplier; it should be overridden (see eclass
69			# DESCRIPTION above)
70	ulm	1.38	SUPPLIER="misc"
71	aballier	1.32
72			# @FUNCTION: latex-package_has_tetex3
73			# @RETURN: true if at least one of (>=tetex-3 or >=ptex-3.1.8 or >=texlive-core-2007) is installed, else false
74			# @DESCRIPTION:
75			# It is often used to know if the current TeX installation supports gentoo's
76			# texmf-update or if the package has to do it the old way
77	usata	1.23	latex-package_has_tetex_3() {
78	aballier	1.31	if has_version '>=app-text/tetex-3' \|\| has_version '>=app-text/ptex-3.1.8' \|\| has_version '>=app-text/texlive-core-2007' ; then
79	usata	1.23	true
80			else
81			false
82			fi
83			}
84
85	aballier	1.32	# @FUNCTION: latex-package_src_doinstall
86			# @USAGE: [ module ]
87			# @DESCRIPTION:
88			# [module] can be one or more of: sh, sty, cls, fd, clo, def, cfg, dvi, ps, pdf,
89			# tex, dtx, tfm, vf, afm, pfb, ttf, bst, styles, doc, fonts, bin, or all.
90			# If [module] is not given, all is assumed.
91			# It installs the files found in the current directory to the standard locations
92			# for a TeX installation
93	blocke	1.1	latex-package_src_doinstall() {
94	usata	1.19	debug-print function $FUNCNAME $*
95			# This actually follows the directions for a "single-user" system
96			# at http://www.ctan.org/installationadvice/ modified for gentoo.
97			[ -z "$1" ] && latex-package_src_install all
98
99			while [ "$1" ]; do
100			case $1 in
101			"sh")
102			for i in `find . -maxdepth 1 -type f -name "*.${1}"`
103			do
104	usata	1.21	dobin $i \|\| die "dobin $i failed"
105	usata	1.19	done
106			;;
107	usata	1.20	"sty" \| "cls" \| "fd" \| "clo" \| "def" \| "cfg")
108	usata	1.19	for i in `find . -maxdepth 1 -type f -name "*.${1}"`
109			do
110			insinto ${TEXMF}/tex/latex/${PN}
111	usata	1.21	doins $i \|\| die "doins $i failed"
112	usata	1.19	done
113			;;
114			"dvi" \| "ps" \| "pdf")
115			for i in `find . -maxdepth 1 -type f -name "*.${1}"`
116			do
117	aballier	1.35	insinto /usr/share/doc/${PF}
118	tove	1.34	doins $i \|\| die "doins $i failed"
119	aballier	1.36	dosym /usr/share/doc/${PF}/$(basename ${i}) ${TEXMF}/doc/latex/${PN}/${i}
120	usata	1.19	#dodoc -u $i
121			done
122			;;
123			"tex" \| "dtx")
124			for i in `find . -maxdepth 1 -type f -name "*.${1}"`
125			do
126			einfo "Making documentation: $i"
127			texi2dvi -q -c --language=latex $i &> /dev/null
128			done
129			;;
130	leonardop	1.26	"tfm" \| "vf" \| "afm")
131	usata	1.19	for i in `find . -maxdepth 1 -type f -name "*.${1}"`
132			do
133			insinto ${TEXMF}/fonts/${1}/${SUPPLIER}/${PN}
134	usata	1.21	doins $i \|\| die "doins $i failed"
135	usata	1.19	done
136			;;
137	leonardop	1.26	"pfb")
138			for i in `find . -maxdepth 1 -type f -name "*.pfb"`
139			do
140			insinto ${TEXMF}/fonts/type1/${SUPPLIER}/${PN}
141			doins $i \|\| die "doins $i failed"
142			done
143			;;
144	usata	1.19	"ttf")
145			for i in `find . -maxdepth 1 -type f -name "*.ttf"`
146			do
147			insinto ${TEXMF}/fonts/truetype/${SUPPLIER}/${PN}
148	usata	1.21	doins $i \|\| die "doins $i failed"
149	usata	1.19	done
150			;;
151			"bst")
152			for i in `find . -maxdepth 1 -type f -name "*.bst"`
153			do
154			insinto ${TEXMF}/bibtex/bst/${PN}
155	usata	1.21	doins $i \|\| die "doins $i failed"
156	usata	1.19	done
157			;;
158			"styles")
159	usata	1.20	latex-package_src_doinstall sty cls fd clo def cfg bst
160	usata	1.19	;;
161			"doc")
162			latex-package_src_doinstall tex dtx dvi ps pdf
163			;;
164			"fonts")
165	usata	1.22	latex-package_src_doinstall tfm vf afm pfb ttf
166	usata	1.19	;;
167			"bin")
168			latex-package_src_doinstall sh
169			;;
170			"all")
171	usata	1.20	latex-package_src_doinstall styles fonts bin doc
172	usata	1.19	;;
173			esac
174			shift
175			done
176	blocke	1.1	}
177
178	aballier	1.32	# @FUNCTION: latex-package_src_compile
179			# @DESCRIPTION:
180			# Calls latex for each *.ins in the current directory in order to generate the
181			# relevant files that will be installed
182	blocke	1.1	latex-package_src_compile() {
183	usata	1.19	debug-print function $FUNCNAME $*
184			for i in `find \`pwd\` -maxdepth 1 -type f -name "*.ins"`
185			do
186			einfo "Extracting from $i"
187			latex --interaction=batchmode $i &> /dev/null
188			done
189	blocke	1.1	}
190
191	aballier	1.32	# @FUNCTION: latex-package_src_install
192			# @DESCRIPTION:
193			# Installs the package
194	blocke	1.1	latex-package_src_install() {
195	usata	1.19	debug-print function $FUNCNAME $*
196			latex-package_src_doinstall all
197	usata	1.21	if [ -n "${DOCS}" ] ; then
198			dodoc ${DOCS}
199			fi
200	blocke	1.1	}
201
202	ulm	1.38	# @FUNCTION: latex-package_pkg_postinst
203	aballier	1.32	# @DESCRIPTION:
204			# Calls latex-package_rehash to ensure the TeX installation is consistent with
205			# the kpathsea database
206	blocke	1.1	latex-package_pkg_postinst() {
207	usata	1.19	debug-print function $FUNCNAME $*
208			latex-package_rehash
209	blocke	1.1	}
210
211	aballier	1.32	# @FUNCTION: latex-package_pkg_postrm
212			# @DESCRIPTION:
213			# Calls latex-package_rehash to ensure the TeX installation is consistent with
214			# the kpathsea database
215	blocke	1.1	latex-package_pkg_postrm() {
216	usata	1.19	debug-print function $FUNCNAME $*
217			latex-package_rehash
218	blocke	1.1	}
219
220	aballier	1.32	# @FUNCTION: latex-package_rehash
221			# @DESCRIPTION:
222			# Rehashes the kpathsea database, according to the current TeX installation
223	blocke	1.1	latex-package_rehash() {
224	usata	1.19	debug-print function $FUNCNAME $*
225	usata	1.23	if latex-package_has_tetex_3 ; then
226			texmf-update
227			else
228			texconfig rehash
229			fi
230	blocke	1.1	}
231
232	nattfodd	1.27	EXPORT_FUNCTIONS src_compile src_install pkg_postinst pkg_postrm