1#!/bin/sh
2
3#### make-package: create a Mac OS X package for use by the installer.
4#### The installer will place the Emacs OSX application in
5#### /Application/Emacs and the rest of emacs in the usual unix places
6#### under /usr/local or some other location if specified as the first
7#### argument. The disc image will be in the file EmacsInstaller.dmg.
8####
9#### Upon installation, this will leave two versions of emacs on the
10#### computer, 20.7 and 21.1.
11####
12#### Examples:
13#### ./make-package
14####     Will create an installer that will place the emacs support
15####     files inside /usr/local.
16#### ./make-package /usr
17####     Will create an installer that will place the emacs support
18####     files inside /usr.  This will replace the default version of
19####     emacs included with Mac OS X.
20
21# Copyright (C) 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
22#
23# This file is part of GNU Emacs.
24#
25# GNU Emacs is free software; you can redistribute it and/or modify
26# it under the terms of the GNU General Public License as published by
27# the Free Software Foundation; either version 2, or (at your option)
28# any later version.
29#
30# GNU Emacs is distributed in the hope that it will be useful,
31# but WITHOUT ANY WARRANTY; without even the implied warranty of
32# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
33# GNU General Public License for more details.
34#
35# You should have received a copy of the GNU General Public License
36# along with GNU Emacs; see the file COPYING.  If not, write to the
37# Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
38# Boston, MA 02110-1301, USA.
39#
40# Contributed by Steven Tamm (steventamm@mac.com).
41
42progname="$0"
43
44srcdir="`pwd`/.."
45builddir=${srcdir}
46
47## Default location to place it is /usr/local
48prefix=/usr/local
49appsdir=/Applications
50emapp=Emacs.app
51with_config=yes
52with_app=yes
53with_x=no
54comp_diskimage=no
55self_contained=no
56app_symlink=no
57full_dist=yes
58compressed_dist=no
59build_in_place=no
60keep_directory=no
61
62ac_prev=
63display_usage=false;
64config_options=;
65while test $# != 0
66do
67  if test -n "$ac_prev"; then
68     eval "$ac_prev=\$1"
69     ac_prev=
70     continue
71  fi
72  case $1 in
73    -help | --help | --hel | --he | -h)
74       display_usage=yes ;;
75    -p | -prefix | --p | --prefix)
76       ac_prev=prefix ;;
77    -p=* | -prefix=* | --p=* | --prefix=*)
78       prefix=`expr "x$1" : 'x[^=]*=\(.*\)'` ;;
79    --build-in-place | --build-in-place )
80       build_in_place=yes ;;
81    --build-dir | -build-dir | --builddir | -build-dir)
82       build_in_place=no
83       ac_prev=builddir;;
84    --build-dir=* | -build-dir=* | -builddir=* | --builddir=*)
85       build_in_place=no
86       builddir=`expr "x$1" : 'x[^=]*=\(.*\)'`;;
87    -no-configure | -no-conf | --no-configure | --no-conf | --without-config)
88       with_config=no ;;
89    -no-app | --no-app | -without-app | --without-app)
90       with_app=no ;;
91    -without-x | --without-x)
92       with_x=no ;;
93    -with-x | --with-x)
94       with_x=yes
95       with_app=no ;;
96    --without-full-dist | -without-full-dist | -no-full-dist | -no-full)
97       full_dist=no ;;
98    --compressed-dist)
99       compressed_dist=yes ;;
100    --self-contained | -self-contained | --with-self-contained-app | -sc)
101       self_contained=yes ;;
102    -app-symlink | --app-symlink | -symlink | --symlink | --asl)
103       app_symlink=yes ;;
104    --keep-dir)
105       keep_directory=yes ;;
106    -C,* | -c,*)
107       config_options="$config_options `expr "x$1" : 'x[^,]*,\(.*\)'`" ;;
108    -M,* | -m,*)
109       make_options="$make_options `expr "x$1" : 'x[^,]*,\(.*\)'`" ;;
110    *)
111       display_usage=yes ;;
112  esac
113  shift
114done
115
116if test "$with_x" = "no"; then
117   config_options="--without-x $config_options"
118fi
119
120if test "$display_usage" = "yes"; then
121  cat <<EOF
122\`make-package' generates a Mac OS X installer package from an Emacs
123distribution.  By default, this first runs ./configure on the emacs
124directory.  Then make install to create the emacs distribution.
125Then some mac-specific commands to generate the required information
126for the mac package.  The installer will, by default, create a
127Carbon application called Emacs in the ${appsdir} directory, with the
128shared emacs files in /usr/local
129
130Usage: $0 [OPTION]
131
132Options:
133  -h, --help              display this help and exit
134      --prefix=DIR        Set install location for the Mac OS X package
135                          of the emacs related file.  By default /usr/local
136      --no-conf           Do not run the configure script before running
137                          make install.
138      --without-app       Do not create the Emacs application bundle
139      --with-x            Setup the install to use X Windows for its
140                          windowed display, instead of carbon.  Implies
141                          --without-app.
142      --without-full-dist Do not include all the .el files in the distribution.
143                          This is discouraged except if disk space is critical.
144      --compressed-dist   Compress .el and info files in the distribution.
145      --app-symlink       Have the Emacs.app executable be a symlink
146                          to the install in [prefix]/bin/emacs and have
147                          the emacs executable link to emacs-${version}
148      --self-contained    Create an Emacs.app that is self-contained;
149                          prefix will be ignored and all files installed
150                          inside the application
151      --build-in-place    Build the application in the source directory
152                          instead of a temporary directory.
153      --build-dir=DIR     Build the application in the specified directory
154                          instead of a temporary directory.  Mutually exclusive
155                          with --build-in-place.
156  -C,option               Pass option to configure
157  -M,option               Pass option to make
158EOF
159  exit 0
160fi
161
162### Exit if a command fails.
163#set -e
164
165### Print out each line we read, for debugging's sake.
166#set -v
167
168LANGUAGE=C
169LC_ALL=C
170LC_MESSAGES=
171LANG=
172export LANGUAGE LC_ALL LC_MESSAGES LANG
173
174## Don't restrict access to any files.
175umask 0
176
177### Make sure we're running in the right place.
178if [ -f Emacs.pkg ]; then
179  echo "${progname}: Package Emacs.pkg already exists.
180Perhaps a previous invocation of \`${progname}' failed to clean up after
181itself.  Move or delete Emacs.pkg and try again." >&2
182  exit 1
183fi
184
185if test $with_app == "yes" && [ ! -f ${emapp}/Contents/PkgInfo ]; then
186  echo "${progname}: Can't find \`${emapp}/Contents/PkgInfo'" >&2
187  echo "${progname} must be run in the \`mac' directory of the Emacs" >&2
188  echo "distribution tree.  cd to that directory and try again." >&2
189  exit 1
190fi
191
192### Check whether file ../lisp/version.el exists.
193if [ ! -f ../lisp/version.el ]; then
194  echo "${progname}: Can't find \`../lisp/version.el'" >&2
195  exit 1
196fi
197
198### Find out which version of Emacs this is.
199shortversion=`grep 'defconst[	 ]*emacs-version' ../lisp/version.el \
200	 | sed -e 's/^.*"\([0-9][0-9]*\.[0-9][0-9]*\).*$/\1/'`
201version=`grep 'defconst[	 ]*emacs-version' ../lisp/version.el \
202	 | sed -e 's/^[^"]*"\([^"]*\)".*$/\1/'`
203if [ ! "${version}" ]; then
204  echo "${progname}: can't find current Emacs version in \`./lisp/version.el'" >&2
205  exit 1
206fi
207
208echo Version numbers are $version and $shortversion
209
210### Make sure we don't already have a directory  emacs-${version}.
211
212emacsname="emacs-${version}${new_extension}"
213
214if [ -d ${emacsname} ]
215then
216  echo Directory "${emacsname}" already exists >&2
217  exit 1
218fi
219
220### Make sure the subdirectory is available.
221tempparent="make-package.tmp.$$"
222if [ -d ${tempparent} ]; then
223  echo "${progname}: staging directory \`${tempparent}' already exists.
224Perhaps a previous invocation of \`${progname}' failed to clean up after
225itself.  Check that directories whose names are of the form
226\`make-dist.tmp.NNNNN' don't contain any important information, remove
227them, and try again." >&2
228  exit 1
229fi
230
231if [ -d /Volumes/Emacs ]; then
232  echo "${progname}: Already have an Emacs disc image mounted.  Please
233eject that disc image and try again." >&2
234  exit 1
235fi
236
237tempparentfull="`pwd`/${tempparent}"
238tempparentdist=${tempparentfull}/dist
239
240if test "$build_in_place" = "no"; then
241    case ${builddir} in
242      ${srcdir})
243        tempbuild="make-package.build.$$"
244	builddir="`pwd`/${tempbuild}"
245	removable_build_dir=${builddir}
246	mkdir -p ${builddir}
247	;;
248      [\\/]* | ?:[\\/]* ) #Absolutepath.
249        mkdir -p ${builddir}
250        ;;
251      *)
252	mkdir -p ${builddir}
253	builddir=`cd $builddir && pwd`
254	;;
255    esac
256fi
257# Location of install package
258packagedir=${builddir}/mac/Emacs.pkg
259
260echo Building in directory ${builddir}
261echo Installing into directory ${tempparentfull} >&2
262
263### This trap ensures that the staging directory will be cleaned up even
264### when the script is interrupted in mid-career.
265trap "echo 'Interrupted...cleaning up the staging directory'; rm -rf ${tempparent} ${removable_build_dir} ${packagedir}; exit 1" 1 2 15
266
267# Run configure in the new tempparent directory
268if test "$with_config" = "yes"; then
269    (cd ${builddir}; ${srcdir}/configure ${config_options} --prefix=${prefix})
270fi
271
272installprefix=${tempparentfull}${prefix}
273if test "$self_contained" = "yes"; then
274    # If selfcontained, the local directory is Resources directory
275    installprefix=$tempparentfull/$appsdir/$emapp/Contents/Resources
276fi
277
278
279make_options="prefix=${installprefix} $make_options"
280
281if test "$with_app" = "yes"; then
282    make_options="carbon_appdir=${tempparentfull}/Applications $make_options"
283fi
284
285## Make bootstrap if .elc files are missing from distribution
286if [ ! -f ${srcdir}/lisp/abbrev.elc ]; then
287   echo "Required .elc files missing; making bootstrap..."
288   if ! (cd ${builddir}; make bootstrap $make_options); then
289      echo "Make bootstrap failed...  Aborting make-package."
290      exit 2
291   fi
292fi
293
294if ! (cd ${builddir}; make install $make_options); then
295   echo "Make failed... Aborting make-package."
296   exit 1
297fi
298
299if test "$full_dist" == "no"; then
300    echo "Removing unneeded .el files"
301    sharedir=$installprefix/share/emacs/$version
302    find $sharedir/lisp $sharedir/leim -name "*.elc" -print | sed 's|\(.*\)\.elc$|/bin/rm -f \1.el|' | /bin/sh -s
303fi
304
305if test "$compressed_dist" == "yes" -a "$full_dist" == "yes"; then
306    echo "Compressing .el files"
307    sharedir=$installprefix/share/emacs/$version
308    find $sharedir/lisp $sharedir/leim -name "*.elc" -print | sed 's|\(.*\)\.elc$|/usr/bin/gzip -9 \1.el|' | /bin/sh -s
309    echo "Compressing info files"
310    find $installprefix/info -type f ! -name dir -print | sed 's|\(.*\)$|/usr/bin/gzip -9 \1|' | /bin/sh -s
311fi
312
313if test "$with_app" == "yes"; then
314  echo "Creating Emacs.app application"
315  tempappdir=${tempparentfull}${appsdir}
316  tempemapp=${tempappdir}/${emapp}/Contents/MacOS/Emacs
317  ## Delete any CVS files
318  find ${tempappdir} -name "CVS" -type d -exec rm -rf {} \;
319
320  ## Have application be a symlink to ${prefix}/bin/emacs
321  if test "$app_symlink" == "yes"; then
322    echo "Creating application symlink"
323    rm ${tempemapp}
324    ln -s ${prefix}/bin/${emacsname} ${tempemapp}
325  fi
326fi
327
328compver=`uname -p`-apple-darwin`uname -r`
329 
330if test "$self_contained" = "yes"; then
331    # Move shared files down to Resources directory
332    mv $installprefix/share/emacs/$version/* $installprefix
333    mv $installprefix/share/info $installprefix
334    mv $installprefix/share/man $installprefix
335    rm -rf $installprefix/share
336    # These directories might remain in Resources
337    mv $installprefix/bin $installprefix/../MacOS/bin
338    mv $installprefix/libexec/emacs/$version/$compver $installprefix/../MacOS/libexec
339    # Make the application binary a hard link
340    rm $installprefix/../MacOS/Emacs
341    ln $installprefix/../MacOS/bin/emacs $installprefix/../MacOS/Emacs
342fi
343
344
345# Remove unnecessary .el files
346#if test "$full_dist" = no; then
347#fi
348
349echo "Creating Package Info file"
350
351mkdir -p ${packagedir}
352mkdir ${packagedir}/Contents
353mkdir ${packagedir}/Contents/Resources
354mkdir ${packagedir}/Contents/Resources/English.lproj
355echo -n 'pmkrpkg1' > ${packagedir}/Contents/PkgInfo
356
357# Create ReadMe and License files
358cp ${srcdir}/COPYING ${packagedir}/Contents/Resources/License.txt
359cp ${srcdir}/mac/README ${packagedir}/Contents/Resources/ReadMe.txt
360
361infofile=${packagedir}/Contents/Resources/English.lproj/Emacs.info
362
363echo 'Title GNU Emacs' > ${infofile}
364echo "Version ${version}" >> ${infofile}
365echo "Description Install GNU Emacs ${version} as a command-line app and a Mac OS Application" >> ${infofile}
366echo 'DefaultLocation /' >> ${infofile}
367echo 'DeleteWarning' >> ${infofile}
368echo 'NeedsAuthorization YES' >> ${infofile}
369echo 'Required NO' >> ${infofile}
370echo 'Relocatable NO' >> ${infofile}
371echo 'RequiresReboot NO' >> ${infofile}
372echo 'UseUserMask NO' >> ${infofile}
373echo 'OverwritePermissions NO' >> ${infofile}
374echo 'InstallFat NO' >> ${infofile}
375
376### Set the install directory to install files as root...
377### Not sure if this is a good diea
378# echo "Setting owner to root"
379# chown -Rh 0 ${tempparentfull}
380
381echo "Creating pax file"
382(cd ${tempparentfull}; pax -w -f ${packagedir}/Contents/Resources/Emacs.pax .)
383echo "Compressing pax file"
384gzip ${packagedir}/Contents/Resources/Emacs.pax
385
386echo "Creating bom file"
387mkbom ${tempparentfull} ${packagedir}/Contents/Resources/Emacs.bom
388
389echo "Generating sizes file"
390sizesfile=${packagedir}/Contents/Resources/Emacs.sizes
391
392numFiles=`du -a ${tempparent} | wc -l`
393installedSize=`du -s ${tempparent} | cut -f1`
394compressedSize=`du -s ${packagedir} | cut -f1`
395
396echo "NumFiles ${numFiles}" > ${sizesfile}
397echo "InstalledSize ${installedSize}" >> ${sizesfile}
398echo "CompressedSize ${compressedSize}" >> ${sizesfile}
399cat ${sizesfile}
400
401echo "Creating Disc Image"
402## From hdiutil man page, a sector is 512k.  Allocate an extra 5% for
403## directories and partition tables.
404sectorsAlloced=`echo 2.1*${compressedSize}|bc`
405hdiutil create -ov ${builddir}/mac/EmacsRW -sectors ${sectorsAlloced}
406## Need to format the disc image before mounting
407mountLoc=`hdid -nomount ${builddir}/mac/EmacsRW.dmg | grep HFS | cut -f1`
408/sbin/newfs_hfs -v Emacs ${mountLoc}
409hdiutil eject ${mountLoc}
410echo "Copying Package to Disc Image"
411hdid ${builddir}/mac/EmacsRW.dmg
412
413if test "$keep_directory" = "no"; then
414    rm -rf ${tempparentfull}
415else
416    mv ${tempparentfull} ${emacsname}
417fi
418
419if [ ! -d /Volumes/Emacs ]; then
420  echo "Could not create disc image.  The Emacs installer package (Emacs.pkg)
421in this directory should be correct.  Please use the Disc Copy program to
422create a disc image." >&2
423  exit 0
424fi
425
426cp -R ${packagedir} /Volumes/Emacs
427
428## Converting Disk Image to read-only
429echo 'Converting Disc Image to read-only'
430hdiutil eject ${mountLoc}
431hdiutil resize ${builddir}/mac/EmacsRW.dmg -sectors min
432if test "$comp_diskimage" = "yes"; then
433    hdiutil convert ${builddir}/mac/EmacsRW.dmg -format UDZO -imagekey zlib-level=2 -o ${srcdir}/mac/EmacsInstaller.dmg
434else
435    hdiutil convert ${builddir}/mac/EmacsRW.dmg -format UDRO -o ${srcdir}/mac/EmacsInstaller.dmg
436fi
437rm ${builddir}/mac/EmacsRW.dmg
438
439echo "Cleaning up the staging directory"
440rm -rf ${builddir}/mac/Emacs.pkg ${removable_build_dir}
441
442# arch-tag: 1b631d0d-9fde-4f71-80c0-33e0e5815515
443### make-package ends here
444