eclass/latex-package.eclass

   1 # Copyright 1999-2015 Gentoo Foundation
   2 # Distributed under the terms of the GNU General Public License v2
   3 # $Id$
   4
   5 # @ECLASS: latex-package.eclass
   6 # @MAINTAINER:
   7 # TeX team <tex@gentoo.org>
   8 # @AUTHOR:
   9 # Matthew Turk <satai@gentoo.org>
  10 # Martin Ehmsen <ehmsen@gentoo.org>
  11 # @BLURB: An eclass for easy installation of LaTeX packages
  12 # @DESCRIPTION:
  13 # 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 # TeX files that come with the source.  Note that we break TeX layout standards
  44 # by placing documentation in /usr/share/doc/${PN}
  45 #
  46 # For examples of basic installations, check out dev-tex/aastex and
  47 # dev-tex/leaflet .
  48 #
  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 #
  54 # It inherits base.
  55
  56 inherit base
  57
  58 RDEPEND="virtual/latex-base"
  59 DEPEND="${RDEPEND}
  60         >=sys-apps/texinfo-4.2-r5"
  61 HOMEPAGE="http://www.tug.org/"
  62 SRC_URI="ftp://tug.ctan.org/macros/latex/"
  63 S=${WORKDIR}/${P}
  64 TEXMF="/usr/share/texmf-site"
  65
  66 # @ECLASS-VARIABLE: SUPPLIER
  67 # @DESCRIPTION:
  68 # This refers to the font supplier; it should be overridden (see eclass
  69 # DESCRIPTION above)
  70 SUPPLIER="misc"
  71
  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 latex-package_has_tetex_3() {
  78         if has_version '>=app-text/tetex-3' || has_version '>=app-text/ptex-3.1.8' || has_version '>=app-text/texlive-core-2007' ; then
  79                 true
  80         else
  81                 false
  82         fi
  83 }
  84
  85 # @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 latex-package_src_doinstall() {
  94         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                                         dobin $i || die "dobin $i failed"
 105                                 done
 106                                 ;;
 107                         "sty" | "cls" | "fd" | "clo" | "def" | "cfg")
 108                                 for i in `find . -maxdepth 1 -type f -name "*.${1}"`
 109                                 do
 110                                         insinto ${TEXMF}/tex/latex/${PN}
 111                                         doins $i || die "doins $i failed"
 112                                 done
 113                                 ;;
 114                         "dvi" | "ps" | "pdf")
 115                                 for i in `find . -maxdepth 1 -type f -name "*.${1}"`
 116                                 do
 117                                         insinto /usr/share/doc/${PF}
 118                                         doins $i || die "doins $i failed"
 119                                         dosym /usr/share/doc/${PF}/$(basename ${i}) ${TEXMF}/doc/latex/${PN}/${i}
 120                                         case "${EAPI:-0}" in
 121                                                 0|1|2|3) ;;
 122                                                 *)
 123                                                         # prevent compression of symlink target
 124                                                         docompress -x /usr/share/doc/${PF}/$(basename ${i})
 125                                                         ;;
 126                                         esac
 127                                 done
 128                                 ;;
 129                         "tex" | "dtx")
 130                                 for i in `find . -maxdepth 1 -type f -name "*.${1}"`
 131                                 do
 132                                         einfo "Making documentation: $i"
 133                                         texi2dvi -q -c --language=latex $i &> /dev/null
 134                                         done
 135                                 ;;
 136                         "tfm" | "vf" | "afm")
 137                                 for i in `find . -maxdepth 1 -type f -name "*.${1}"`
 138                                 do
 139                                         insinto ${TEXMF}/fonts/${1}/${SUPPLIER}/${PN}
 140                                         doins $i || die "doins $i failed"
 141                                 done
 142                                 ;;
 143                         "pfb")
 144                                 for i in `find . -maxdepth 1 -type f -name "*.pfb"`
 145                                 do
 146                                         insinto ${TEXMF}/fonts/type1/${SUPPLIER}/${PN}
 147                                         doins $i || die "doins $i failed"
 148                                 done
 149                                 ;;
 150                         "ttf")
 151                                 for i in `find . -maxdepth 1 -type f -name "*.ttf"`
 152                                 do
 153                                         insinto ${TEXMF}/fonts/truetype/${SUPPLIER}/${PN}
 154                                         doins $i || die "doins $i failed"
 155                                 done
 156                                 ;;
 157                         "bst")
 158                                 for i in `find . -maxdepth 1 -type f -name "*.bst"`
 159                                 do
 160                                         insinto ${TEXMF}/bibtex/bst/${PN}
 161                                         doins $i || die "doins $i failed"
 162                                 done
 163                                 ;;
 164                         "styles")
 165                                 latex-package_src_doinstall sty cls fd clo def cfg bst
 166                                 ;;
 167                         "doc")
 168                                 latex-package_src_doinstall tex dtx dvi ps pdf
 169                                 ;;
 170                         "fonts")
 171                                 latex-package_src_doinstall tfm vf afm pfb ttf
 172                                 ;;
 173                         "bin")
 174                                 latex-package_src_doinstall sh
 175                                 ;;
 176                         "all")
 177                                 latex-package_src_doinstall styles fonts bin doc
 178                                 ;;
 179                 esac
 180         shift
 181         done
 182 }
 183
 184 # @FUNCTION: latex-package_src_compile
 185 # @DESCRIPTION:
 186 # Calls latex for each *.ins in the current directory in order to generate the
 187 # relevant files that will be installed
 188 latex-package_src_compile() {
 189         debug-print function $FUNCNAME $*
 190         for i in `find \`pwd\` -maxdepth 1 -type f -name "*.ins"`
 191         do
 192                 einfo "Extracting from $i"
 193                 latex --interaction=batchmode $i &> /dev/null
 194         done
 195 }
 196
 197 # @FUNCTION: latex-package_src_install
 198 # @DESCRIPTION:
 199 # Installs the package
 200 latex-package_src_install() {
 201         debug-print function $FUNCNAME $*
 202         latex-package_src_doinstall all
 203         if [ -n "${DOCS}" ] ; then
 204                 dodoc ${DOCS}
 205         fi
 206 }
 207
 208 # @FUNCTION: latex-package_pkg_postinst
 209 # @DESCRIPTION:
 210 # Calls latex-package_rehash to ensure the TeX installation is consistent with
 211 # the kpathsea database
 212 latex-package_pkg_postinst() {
 213         debug-print function $FUNCNAME $*
 214         latex-package_rehash
 215 }
 216
 217 # @FUNCTION: latex-package_pkg_postrm
 218 # @DESCRIPTION:
 219 # Calls latex-package_rehash to ensure the TeX installation is consistent with
 220 # the kpathsea database
 221 latex-package_pkg_postrm() {
 222         debug-print function $FUNCNAME $*
 223         latex-package_rehash
 224 }
 225
 226 # @FUNCTION: latex-package_rehash
 227 # @DESCRIPTION:
 228 # Rehashes the kpathsea database, according to the current TeX installation
 229 latex-package_rehash() {
 230         debug-print function $FUNCNAME $*
 231         if latex-package_has_tetex_3 ; then
 232                 texmf-update
 233         else
 234                 texconfig rehash
 235         fi
 236 }
 237
 238 EXPORT_FUNCTIONS src_compile src_install pkg_postinst pkg_postrm