gentoo-x86/eclass/perl-module.eclass

# Copyright 1999-2004 Gentoo Foundation
# Distributed under the terms of the GNU General Public License v2
# $Header: /var/cvsroot/gentoo-x86/eclass/perl-module.eclass,v 1.88 2006/04/03 16:50:25 mcummings Exp $
#
# Author: Seemant Kulleen <seemant@gentoo.org>
# Maintained by the Perl herd <perl@gentoo.org>
#
# The perl-module eclass is designed to allow easier installation of perl
# modules, and their incorporation into the Gentoo Linux system.


EXPORT_FUNCTIONS pkg_setup pkg_preinst pkg_postinst pkg_prerm pkg_postrm src_compile src_install src_test

# 2005.04.28 mcummings
# Mounting problems with src_test functions has forced me to make the
# compilation of perl modules honor the FEATURES maketest flag rather than what
# is generally necessary. I've left a block to make sure we still need to set
# the SRC_TEST="do" flag on the suspicion that otherwise we will face 10 times
# as many bug reports as we have lately.

# 2004.05.10 rac
# block on makemaker versions earlier than that in the 5.8.2 core. in
# actuality, this should be handled in the perl ebuild, so every perl
# ebuild should block versions of MakeMaker older than the one it
# carries. in the meantime, since we have dumped support for MakeMaker
# <6.11 and the associated broken DESTDIR handling, block here to save
# people from sandbox trouble.
#
# 2004.05.25 rac
# for the same reasons, make the perl dep >=5.8.2 to get everybody
# with 5.8.0 and its 6.03 makemaker up to a version that can
# understand DESTDIR
#
# 2004.10.01 mcummings
# noticed a discrepancy in how we were sed fixing references to ${D}
#
# 2005.03.14 mcummings
# Updated eclass to include a specific function for dealing with perlocal.pods -
# this should avoid the conflicts we've been running into with the introduction
# of file collision features by giving us a single exportable function to deal
# with the pods. Modifications to the eclass provided by Yaakov S
# <yselkowitz@hotmail.com> in bug 83622
#
# <later the same day>
# The long awaited (by me) fix for automagically detecting and dealing
# with module-build dependancies. I've chosen not to make it a default dep since
# this adds overhead to people that might not otherwise need it, and instead
# modified the eclass to detect the existence of a Build.PL and behave
# accordingly. This will fix issues with g-cpan builds that needs module-build
# support, as well as get rid of the (annoying) style=builder vars. I know of
# only one module that needed to be hacked for this, Class-MethodMaker-2.05, but
# that module has a bad Build.PL to begin with. Ebuilds should continue to
# DEPEND on module-build<-version> as needed, but there should be no need for
# the style directive any more (especially since it isn't in the eclass
# anymore). Enjoy!
#
# 2005.07.18 mcummings
# Fix for proper handling of $mydoc - thanks to stkn for noticing we were
# bombing out there
#
# 2005.07.19 mcummings
# Providing an override var for the use of Module::Build. While it is being
# incorporated in more and more modules, not module authors have working
# Build.PL's in place. The override is to allow for a fallback to the "classic"
# Makfile.PL - example is Class::MethodMaker, which provides a Build.PL that is
# severely broken.
#
# 2006.02.11 mcummings
# Per a conversation with solar, adding a change to the dep/rdep lines for
# minimal. Should fix bug 68367 and bug 83622, as well as other embedded builds
# that use perl components without providing perl


IUSE="minimal"
DEPEND=">=dev-lang/perl-5.8.2 !<perl-core/ExtUtils-MakeMaker-6.17"
RDEPEND="!minimal? ( ${DEPEND} )"
SRC_PREP="no"
SRC_TEST="skip"
USE_BUILDER="yes"

PERL_VERSION=""
SITE_ARCH=""
SITE_LIB=""
VENDOR_LIB=""
VENDOR_ARCH=""
ARCH_LIB=""
POD_DIR=""
BUILDER_VER=""

perl-module_src_prep() {

        perlinfo

        export PERL_MM_USE_DEFAULT=1


        SRC_PREP="yes"
        if [ -f Makefile.PL ] && [ ! ${PN} == "module-build" ]; then
                einfo "Using ExtUtils::MakeMaker"
                #perl Makefile.PL ${myconf} \
                perl Makefile.PL ${myconf} INSTALLMAN3DIR='none'\
                PREFIX=/usr INSTALLDIRS=vendor DESTDIR=${D}
        fi
        if [ -f Build.PL ] ; then
                einfo "Using Module::Build"
                perl Build.PL --installdirs=vendor --destdir=${D} --libdoc=
        fi
        if [ ! -f Build.PL ] && [ ! -f Makefile.PL ]; then
                einfo "No Make or Build file detected..."
                return
        fi
}

perl-module_src_compile() {

        perlinfo
        [ "${SRC_PREP}" != "yes" ] && perl-module_src_prep
        if [ -f Makefile ]; then
                make ${mymake} || die "compilation failed"
        elif [ -f Build ]; then
                perl Build build
        fi

}

perl-module_src_test() {
        if [ "${SRC_TEST}" == "do" ]; then
                perlinfo
                if [ -f Makefile ]; then
                        make test || die "test failed"
                elif [ -f Build ]; then
                        perl Build  test || die "test failed"
                fi
        fi
}

perl-module_src_install() {

        perlinfo

        test -z ${mytargets} && mytargets="install"

        if [ -f Makefile ]; then
                make ${myinst} ${mytargets} || die
        elif [ -f Build ]; then
                perl ${S}/Build install
        fi

        fixlocalpod

        for FILE in `find ${D} -type f |grep -v '.so'`; do
                STAT=`file $FILE| grep -i " text"`
                if [ "${STAT}x" != "x" ]; then
                        sed -i -e "s:${D}:/:g" ${FILE}
                fi
        done

        for doc in Change* MANIFEST* README* ${mydoc}; do
                [ -s "$doc" ] && dodoc $doc
        done
}


perl-module_pkg_setup() {

        perlinfo
}


perl-module_pkg_preinst() {

        perlinfo
}

perl-module_pkg_postinst() {

        einfo "Man pages are not installed for most modules now."
        einfo "Please use perldoc instead."
        updatepod
}

perl-module_pkg_prerm() {

        updatepod
}

perl-module_pkg_postrm() {

        updatepod
}

perlinfo() {

        local version
        eval `perl '-V:version'`
        PERL_VERSION=${version}

        local installsitearch
        eval `perl '-V:installsitearch'`
        SITE_ARCH=${installsitearch}

        local installsitelib
        eval `perl '-V:installsitelib'`
        SITE_LIB=${installsitelib}

        local installarchlib
        eval `perl '-V:installarchlib'`
        ARCH_LIB=${installarchlib}

        local installvendorlib
        eval `perl '-V:installvendorlib'`
        VENDOR_LIB=${installvendorlib}

        local installvendorarch
        eval `perl '-V:installvendorarch'`
        VENDOR_ARCH=${installvendorarch}

        if [ "${USE_BUILDER}" == "yes" ]; then
           if [ ! -f ${S}/Makefile.PL ] || [ ${PN} == "module-build" ]; then
                if [ -f ${S}/Build.PL ]; then
                        if [ ${PN} == "module-build" ]; then
                                BUILDER_VER="1" # A bootstrapping if you will
                        else
                                BUILDER_VER=`perl -MModule::Build -e 'print "$Module::Build::VERSION;"' `
                        fi
                fi
           fi
        fi

        if [ -f /usr/bin/perl ]
        then
                POD_DIR="/usr/share/perl/gentoo-pods/${version}"
        fi
}

fixlocalpod() {
        perlinfo
        dodir ${POD_DIR}

        if [ -f ${D}${ARCH_LIB}/perllocal.pod ];
        then
                touch ${D}/${POD_DIR}/${P}.pod
                sed -e "s:${D}::g" \
                        ${D}${ARCH_LIB}/perllocal.pod >> ${D}/${POD_DIR}/${P}.pod
                touch ${D}/${POD_DIR}/${P}.pod.arch
                cat ${D}/${POD_DIR}/${P}.pod >>${D}/${POD_DIR}/${P}.pod.arch
                rm -f ${D}/${ARCH_LIB}/perllocal.pod
        fi

        if [ -f ${D}${SITE_LIB}/perllocal.pod ];
        then
                touch ${D}/${POD_DIR}/${P}.pod
                sed -e "s:${D}::g" \
                        ${D}${SITE_LIB}/perllocal.pod >> ${D}/${POD_DIR}/${P}.pod
                touch ${D}/${POD_DIR}/${P}.pod.site
                cat ${D}/${POD_DIR}/${P}.pod >>${D}/${POD_DIR}/${P}.pod.site
                rm -f ${D}/${SITE_LIB}/perllocal.pod
        fi

        if [ -f ${D}${VENDOR_LIB}/perllocal.pod ];
        then
                touch ${D}/${POD_DIR}/${P}.pod
                sed -e "s:${D}::g" \
                        ${D}${VENDOR_LIB}/perllocal.pod >> ${D}/${POD_DIR}/${P}.pod
                touch ${D}/${POD_DIR}/${P}.pod.vendor
                cat ${D}/${POD_DIR}/${P}.pod >>${D}/${POD_DIR}/${P}.pod.vendor
                rm -f ${D}/${VENDOR_LIB}/perllocal.pod
        fi
}

updatepod() {
        perlinfo

        if [ -d "${POD_DIR}" ]
        then
                for FILE in `find ${POD_DIR} -type f -name "*.pod.arch"`; do
                   cat ${FILE} >> ${ARCH_LIB}/perllocal.pod
                   rm -f ${FILE}
                done
                for FILE in `find ${POD_DIR} -type f -name "*.pod.site"`; do
                   cat ${FILE} >> ${SITE_LIB}/perllocal.pod
                   rm -f ${FILE}
                done
                for FILE in `find ${POD_DIR} -type f -name "*.pod.vendor"`; do
                   cat ${FILE} >> ${VENDOR_LIB}/perllocal.pod
                   rm -f ${FILE}
                done
        fi
}
1	vapier	1.63	# Copyright 1999-2004 Gentoo Foundation
2	vapier	1.30	# Distributed under the terms of the GNU General Public License v2
3	mcummings	1.89	# $Header: /var/cvsroot/gentoo-x86/eclass/perl-module.eclass,v 1.88 2006/04/03 16:50:25 mcummings Exp $
4	vapier	1.33	#
5	seemant	1.1	# Author: Seemant Kulleen <seemant@gentoo.org>
6	mcummings	1.57	# Maintained by the Perl herd <perl@gentoo.org>
7	vapier	1.33	#
8	seemant	1.1	# The perl-module eclass is designed to allow easier installation of perl
9			# modules, and their incorporation into the Gentoo Linux system.
10	seemant	1.3
11	danarmak	1.13
12	chriswhite	1.84	EXPORT_FUNCTIONS pkg_setup pkg_preinst pkg_postinst pkg_prerm pkg_postrm src_compile src_install src_test
13	seemant	1.1
14	mcummings	1.68	# 2005.04.28 mcummings
15			# Mounting problems with src_test functions has forced me to make the
16			# compilation of perl modules honor the FEATURES maketest flag rather than what
17			# is generally necessary. I've left a block to make sure we still need to set
18			# the SRC_TEST="do" flag on the suspicion that otherwise we will face 10 times
19			# as many bug reports as we have lately.
20
21	rac	1.61	# 2004.05.10 rac
22			# block on makemaker versions earlier than that in the 5.8.2 core. in
23			# actuality, this should be handled in the perl ebuild, so every perl
24			# ebuild should block versions of MakeMaker older than the one it
25			# carries. in the meantime, since we have dumped support for MakeMaker
26			# <6.11 and the associated broken DESTDIR handling, block here to save
27			# people from sandbox trouble.
28	rac	1.62	#
29			# 2004.05.25 rac
30			# for the same reasons, make the perl dep >=5.8.2 to get everybody
31			# with 5.8.0 and its 6.03 makemaker up to a version that can
32			# understand DESTDIR
33	mcummings	1.65	#
34			# 2004.10.01 mcummings
35			# noticed a discrepancy in how we were sed fixing references to ${D}
36	mcummings	1.66	#
37			# 2005.03.14 mcummings
38			# Updated eclass to include a specific function for dealing with perlocal.pods -
39			# this should avoid the conflicts we've been running into with the introduction
40			# of file collision features by giving us a single exportable function to deal
41			# with the pods. Modifications to the eclass provided by Yaakov S
42			# <yselkowitz@hotmail.com> in bug 83622
43	swegener	1.76	#
44	mcummings	1.67	# <later the same day>
45			# The long awaited (by me) fix for automagically detecting and dealing
46			# with module-build dependancies. I've chosen not to make it a default dep since
47			# this adds overhead to people that might not otherwise need it, and instead
48			# modified the eclass to detect the existence of a Build.PL and behave
49			# accordingly. This will fix issues with g-cpan builds that needs module-build
50			# support, as well as get rid of the (annoying) style=builder vars. I know of
51			# only one module that needed to be hacked for this, Class-MethodMaker-2.05, but
52			# that module has a bad Build.PL to begin with. Ebuilds should continue to
53			# DEPEND on module-build<-version> as needed, but there should be no need for
54			# the style directive any more (especially since it isn't in the eclass
55			# anymore). Enjoy!
56	mcummings	1.78	#
57			# 2005.07.18 mcummings
58			# Fix for proper handling of $mydoc - thanks to stkn for noticing we were
59			# bombing out there
60			#
61			# 2005.07.19 mcummings
62			# Providing an override var for the use of Module::Build. While it is being
63			# incorporated in more and more modules, not module authors have working
64			# Build.PL's in place. The override is to allow for a fallback to the "classic"
65			# Makfile.PL - example is Class::MethodMaker, which provides a Build.PL that is
66			# severely broken.
67	mcummings	1.82	#
68			# 2006.02.11 mcummings
69			# Per a conversation with solar, adding a change to the dep/rdep lines for
70			# minimal. Should fix bug 68367 and bug 83622, as well as other embedded builds
71			# that use perl components without providing perl
72	mcummings	1.67
73	mcummings	1.66
74	mcummings	1.82	IUSE="minimal"
75	mcummings	1.71	DEPEND=">=dev-lang/perl-5.8.2 !<perl-core/ExtUtils-MakeMaker-6.17"
76	mcummings	1.82	RDEPEND="!minimal? ( ${DEPEND} )"
77	azarah	1.11	SRC_PREP="no"
78	rac	1.55	SRC_TEST="skip"
79	mcummings	1.78	USE_BUILDER="yes"
80	azarah	1.11
81	mcummings	1.57	PERL_VERSION=""
82			SITE_ARCH=""
83	seemant	1.35	SITE_LIB=""
84	mcummings	1.65	VENDOR_LIB=""
85			VENDOR_ARCH=""
86	seemant	1.35	ARCH_LIB=""
87			POD_DIR=""
88	mcummings	1.67	BUILDER_VER=""
89	seemant	1.35
90	aliz	1.15	perl-module_src_prep() {
91	rac	1.60
92			perlinfo
93
94	rac	1.64	export PERL_MM_USE_DEFAULT=1
95
96	mcummings	1.67
97	azarah	1.11	SRC_PREP="yes"
98	mcummings	1.88	if [ -f Makefile.PL ] && [ ! ${PN} == "module-build" ]; then
99	mcummings	1.85	einfo "Using ExtUtils::MakeMaker"
100			#perl Makefile.PL ${myconf} \
101			perl Makefile.PL ${myconf} INSTALLMAN3DIR='none'\
102			PREFIX=/usr INSTALLDIRS=vendor DESTDIR=${D}
103	mcummings	1.88	fi
104	mcummings	1.89	if [ -f Build.PL ] ; then
105	mcummings	1.78	einfo "Using Module::Build"
106	mcummings	1.89	perl Build.PL --installdirs=vendor --destdir=${D} --libdoc=
107	mcummings	1.88	fi
108			if [ ! -f Build.PL ] && [ ! -f Makefile.PL ]; then
109			einfo "No Make or Build file detected..."
110	mcummings	1.85	return
111	mcummings	1.43	fi
112	azarah	1.11	}
113
114	aliz	1.15	perl-module_src_compile() {
115	seemant	1.6
116	mcummings	1.67	perlinfo
117	aliz	1.15	[ "${SRC_PREP}" != "yes" ] && perl-module_src_prep
118	mcummings	1.88	if [ -f Makefile ]; then
119	mcummings	1.43	make ${mymake} \|\| die "compilation failed"
120	mcummings	1.88	elif [ -f Build ]; then
121			perl Build build
122	mcummings	1.43	fi
123
124	seemant	1.8	}
125
126	aliz	1.15	perl-module_src_test() {
127	mcummings	1.68	if [ "${SRC_TEST}" == "do" ]; then
128			perlinfo
129	mcummings	1.88	if [ -f Makefile ]; then
130	mcummings	1.68	make test \|\| die "test failed"
131	mcummings	1.88	elif [ -f Build ]; then
132			perl Build test \|\| die "test failed"
133	mcummings	1.68	fi
134	mcummings	1.43	fi
135	seemant	1.1	}
136
137	aliz	1.15	perl-module_src_install() {
138	swegener	1.76
139	seemant	1.35	perlinfo
140	swegener	1.76
141	seemant	1.9	test -z ${mytargets} && mytargets="install"
142	swegener	1.76
143	mcummings	1.88	if [ -f Makefile ]; then
144	mcummings	1.67	make ${myinst} ${mytargets} \|\| die
145	mcummings	1.88	elif [ -f Build ]; then
146	mcummings	1.43	perl ${S}/Build install
147			fi
148	mcummings	1.20
149	mcummings	1.66	fixlocalpod
150	mcummings	1.65
151			for FILE in `find ${D} -type f \|grep -v '.so'`; do
152			STAT=`file $FILE\| grep -i " text"`
153			if [ "${STAT}x" != "x" ]; then
154			sed -i -e "s:${D}:/:g" ${FILE}
155			fi
156	mcummings	1.38	done
157	seemant	1.1
158	mcummings	1.77	for doc in Change* MANIFEST* README* ${mydoc}; do
159	lanius	1.53	[ -s "$doc" ] && dodoc $doc
160			done
161	seemant	1.35	}
162
163
164			perl-module_pkg_setup() {
165
166			perlinfo
167			}
168
169
170			perl-module_pkg_preinst() {
171	swegener	1.76
172	seemant	1.35	perlinfo
173			}
174
175			perl-module_pkg_postinst() {
176
177	mcummings	1.85	einfo "Man pages are not installed for most modules now."
178	mcummings	1.87	einfo "Please use perldoc instead."
179	seemant	1.35	updatepod
180			}
181
182			perl-module_pkg_prerm() {
183	swegener	1.76
184	seemant	1.35	updatepod
185			}
186
187			perl-module_pkg_postrm() {
188
189			updatepod
190			}
191
192			perlinfo() {
193
194	mcummings	1.79	local version
195	mcummings	1.58	eval `perl '-V:version'`
196			PERL_VERSION=${version}
197	swegener	1.76
198	mcummings	1.79	local installsitearch
199	mcummings	1.58	eval `perl '-V:installsitearch'`
200			SITE_ARCH=${installsitearch}
201	swegener	1.76
202	mcummings	1.79	local installsitelib
203			eval `perl '-V:installsitelib'`
204			SITE_LIB=${installsitelib}
205	swegener	1.76
206	mcummings	1.79	local installarchlib
207	mcummings	1.58	eval `perl '-V:installarchlib'`
208			ARCH_LIB=${installarchlib}
209	swegener	1.76
210	mcummings	1.79	local installvendorlib
211	mcummings	1.65	eval `perl '-V:installvendorlib'`
212			VENDOR_LIB=${installvendorlib}
213
214	mcummings	1.79	local installvendorarch
215	mcummings	1.65	eval `perl '-V:installvendorarch'`
216			VENDOR_ARCH=${installvendorarch}
217	swegener	1.76
218	mcummings	1.78	if [ "${USE_BUILDER}" == "yes" ]; then
219	mcummings	1.88	if [ ! -f ${S}/Makefile.PL ] \|\| [ ${PN} == "module-build" ]; then
220	mcummings	1.78	if [ -f ${S}/Build.PL ]; then
221			if [ ${PN} == "module-build" ]; then
222			BUILDER_VER="1" # A bootstrapping if you will
223			else
224			BUILDER_VER=`perl -MModule::Build -e 'print "$Module::Build::VERSION;"' `
225			fi
226	mcummings	1.67	fi
227	mcummings	1.85	fi
228	mcummings	1.67	fi
229
230	mcummings	1.65	if [ -f /usr/bin/perl ]
231	swegener	1.76	then
232	mcummings	1.65	POD_DIR="/usr/share/perl/gentoo-pods/${version}"
233			fi
234	seemant	1.35	}
235
236	mcummings	1.66	fixlocalpod() {
237			perlinfo
238			dodir ${POD_DIR}
239
240			if [ -f ${D}${ARCH_LIB}/perllocal.pod ];
241			then
242			touch ${D}/${POD_DIR}/${P}.pod
243			sed -e "s:${D}::g" \
244			${D}${ARCH_LIB}/perllocal.pod >> ${D}/${POD_DIR}/${P}.pod
245			touch ${D}/${POD_DIR}/${P}.pod.arch
246			cat ${D}/${POD_DIR}/${P}.pod >>${D}/${POD_DIR}/${P}.pod.arch
247			rm -f ${D}/${ARCH_LIB}/perllocal.pod
248			fi
249	swegener	1.76
250	mcummings	1.66	if [ -f ${D}${SITE_LIB}/perllocal.pod ];
251	swegener	1.76	then
252	mcummings	1.66	touch ${D}/${POD_DIR}/${P}.pod
253			sed -e "s:${D}::g" \
254			${D}${SITE_LIB}/perllocal.pod >> ${D}/${POD_DIR}/${P}.pod
255			touch ${D}/${POD_DIR}/${P}.pod.site
256			cat ${D}/${POD_DIR}/${P}.pod >>${D}/${POD_DIR}/${P}.pod.site
257			rm -f ${D}/${SITE_LIB}/perllocal.pod
258			fi
259
260			if [ -f ${D}${VENDOR_LIB}/perllocal.pod ];
261	swegener	1.76	then
262	mcummings	1.66	touch ${D}/${POD_DIR}/${P}.pod
263			sed -e "s:${D}::g" \
264			${D}${VENDOR_LIB}/perllocal.pod >> ${D}/${POD_DIR}/${P}.pod
265			touch ${D}/${POD_DIR}/${P}.pod.vendor
266			cat ${D}/${POD_DIR}/${P}.pod >>${D}/${POD_DIR}/${P}.pod.vendor
267			rm -f ${D}/${VENDOR_LIB}/perllocal.pod
268			fi
269			}
270
271	seemant	1.35	updatepod() {
272			perlinfo
273
274			if [ -d "${POD_DIR}" ]
275			then
276			for FILE in `find ${POD_DIR} -type f -name "*.pod.arch"`; do
277			cat ${FILE} >> ${ARCH_LIB}/perllocal.pod
278			rm -f ${FILE}
279			done
280			for FILE in `find ${POD_DIR} -type f -name "*.pod.site"`; do
281			cat ${FILE} >> ${SITE_LIB}/perllocal.pod
282			rm -f ${FILE}
283			done
284	mcummings	1.65	for FILE in `find ${POD_DIR} -type f -name "*.pod.vendor"`; do
285			cat ${FILE} >> ${VENDOR_LIB}/perllocal.pod
286			rm -f ${FILE}
287			done
288	seemant	1.35	fi
289	seemant	1.1	}