mk/package.mk

   1 # -----------------------------------------------------------------------------
   2 # $Id: package.mk,v 1.52 2005/03/29 14:06:02 simonmar Exp $
   3
   4 ifneq "$(PACKAGE)" ""
   5
   6 ifeq "$(STANDALONE_PACKAGE)" ""
   7 ifeq "$(ProjectNameShort)" "ghc"
   8 STANDALONE_PACKAGE = NO
   9 else
  10 STANDALONE_PACKAGE = YES
  11 endif
  12 endif
  13
  14 # -----------------------------------------------------------------------------
  15 # Directory layouts, installation etc.
  16
  17 # Here Windows & Unix differ.  On Windows, the value of $(prefix) is known
  18 # to the compiler, and spliced into package.conf in place of $topdir at
  19 # runtime.
  20 #
  21 # On Unix, we only use absolute paths in package.conf, except that when
  22 # building a binary distribution we use $libdir and $datadir in package.conf
  23 # which are then replaced by the correct values at install time.
  24 #
  25
  26 ifeq "$(Windows)" "YES"
  27
  28 PKG_LIBDIR  = $$topdir
  29 PKG_DATADIR = $$topdir
  30
  31 else
  32
  33 ifeq "$(BIN_DIST)" ""
  34 PKG_LIBDIR  = $(libdir)
  35 PKG_DATADIR = $(datadir)
  36 else
  37 PKG_LIBDIR  = $$libdir
  38 PKG_DATADIR = $$datadir
  39 endif
  40
  41 endif # Unix
  42
  43 IMPORT_DIR_INSTALLED = $(PKG_LIBDIR)/imports
  44 IMPORT_DIR_INPLACE   = $(FPTOOLS_TOP_ABS)/libraries/$(PACKAGE)
  45
  46 INCLUDE_DIR_INSTALLED = $(PKG_LIBDIR)/include
  47 INCLUDE_DIR_INPLACE   = $(FPTOOLS_TOP_ABS)/libraries/$(PACKAGE)/include
  48
  49 LIB_DIR_INSTALLED    = $(PKG_LIBDIR)
  50 LIB_DIR_INPLACE      = $(FPTOOLS_TOP_ABS)/libraries/$(PACKAGE)
  51
  52 DATA_DIR_INSTALLED   = $(PKG_DATADIR)
  53 DATA_DIR_INPLACE     = $(FPTOOLS_TOP_ABS)/libraries/$(PACKAGE)
  54
  55 HTML_DIR_INPLACE     = $(FPTOOLS_TOP_ABS)/libraries/$(PACKAGE)/html
  56 HTML_DIR_INSTALLED   = $(PKG_DATADIR)/html/libraries/$(PACKAGE)
  57
  58 HADDOCK_IFACE_INPLACE   = $(HTML_DIR_INPLACE)/$(PACKAGE).haddock
  59 HADDOCK_IFACE_INSTALLED = $(HTML_DIR_INSTALLED)/$(PACKAGE).haddock
  60
  61 # -----------------------------------------------------------------------------
  62 # Build the package configuration file and tell the compiler about it.
  63
  64 # We want to build two versions of the package configuration: one for use
  65 # in the
  66
  67 ifeq "$(way)" ""
  68
  69 ifeq "$(STANDALONE_PACKAGE)" "NO"
  70 PACKAGE_CPP_OPTS += -I$(GHC_INCLUDE_DIR) -Iinclude
  71 else
  72 PACKAGE_CPP_OPTS += -Iinclude
  73 endif
  74
  75 PACKAGE_CPP_OPTS += -DPACKAGE=${PACKAGE}
  76 PACKAGE_CPP_OPTS += -DVERSION=${VERSION}
  77
  78 PACKAGE_CPP_OPTS += -DPKG_LIBDIR='"$(PKG_LIBDIR)"'
  79 PACKAGE_CPP_OPTS += -DPKG_DATADIR='"$(PKG_DATADIR)"'
  80
  81 package.conf.inplace   : package.conf.in
  82         $(CPP) $(RAWCPP_FLAGS) -P \
  83                 -DIMPORT_DIR='"$(IMPORT_DIR_INPLACE)"' \
  84                 -DLIB_DIR='"$(LIB_DIR_INPLACE)"' \
  85                 -DINCLUDE_DIR='"$(INCLUDE_DIR_INPLACE)"' \
  86                 -DDATA_DIR='"$(DATA_DIR_INPLACE)"' \
  87                 -DHTML_DIR='"$(HTML_DIR_INPLACE)"' \
  88                 -DHADDOCK_IFACE='"$(HADDOCK_IFACE_INPLACE)"' \
  89                 -DFPTOOLS_TOP_ABS=\"${FPTOOLS_TOP_ABS}\" \
  90                 -x c $(PACKAGE_CPP_OPTS) $< | \
  91         grep -v '^#pragma GCC' | \
  92         sed -e 's/""//g' -e 's/:[       ]*,/: /g' >$@
  93
  94 package.conf.installed : package.conf.in
  95         $(CPP) $(RAWCPP_FLAGS) -P -DINSTALLING \
  96                 -DIMPORT_DIR='"$(IMPORT_DIR_INSTALLED)"' \
  97                 -DLIB_DIR='"$(LIB_DIR_INSTALLED)"' \
  98                 -DINCLUDE_DIR='"$(INCLUDE_DIR_INSTALLED)"' \
  99                 -DDATA_DIR='"$(DATA_DIR_INSTALLED)"' \
 100                 -DHTML_DIR='"$(HTML_DIR_INSTALLED)"' \
 101                 -DHADDOCK_IFACE='"$(HADDOCK_IFACE_INSTALLED)"' \
 102                  -x c $(PACKAGE_CPP_OPTS) $< | \
 103         grep -v '^#pragma GCC' | \
 104         sed -e 's/""//g' -e 's/:[       ]*,/: /g' >$@
 105
 106 # we could be more accurate here and add a dependency on
 107 # ghc/driver/package.conf, but that doesn't work too well because of
 108 # make's limited accuracy with modification times: when doing 'make
 109 # boot' in multiple packages, make won't detect that the package
 110 # configuration needs updating if it was updated already in the last
 111 # second.
 112 #
 113 # The stamp file goes in $(GHC_DRIVER_DIR), so that if someone happens
 114 # to 'make clean' in ghc without cleaning in libraries too, the packages
 115 # will be correctly re-installed.
 116 #
 117 ifeq "$(STANDALONE_PACKAGE)" "NO"
 118
 119 STAMP_PKG_CONF = $(GHC_DRIVER_DIR)/stamp-pkg-conf-$(PACKAGE)
 120 CLEAN_FILES += $(STAMP_PKG_CONF)
 121
 122 ifneq "$(BootingFromHc)" "YES"
 123 boot all :: $(STAMP_PKG_CONF)
 124 endif
 125
 126 $(STAMP_PKG_CONF) : package.conf.inplace package.conf.installed
 127         $(GHC_PKG_INPLACE) --force --update-package <package.conf.inplace
 128         $(GHC_PKG_INPLACE)  -f $(GHC_DRIVER_DIR)/package.conf --force --update-package <package.conf.installed
 129         @touch $(STAMP_PKG_CONF)
 130
 131 CLEAN_FILES += package.conf.installed package.conf.inplace
 132
 133 else # $(STANDALONE_PACKAGE) == "YES"
 134
 135 PACKAGE_CPP_OPTS += -DPACKAGE_DEPS='$(subst " ","$(comma) ",$(patsubst %,"%",$(PACKAGE_DEPS)))'
 136 PACKAGE_CPP_OPTS += -DLIBRARY=\"HS$(PACKAGE)\"
 137 PACKAGE_CPP_OPTS += -DLIBDIR=\"$(libdir)\"
 138
 139 # Let the package configuration file refer to $(libdir) as
 140 # ${pkglibdir}.  Note we can't use ${libdir} because ghc-pkg already
 141 # redefines it to point to GHC's libdir (bug or feature?).
 142 #
 143 install :: package.conf.installed
 144         $(GHC_PKG) --force --update-package <package.conf.installed
 145
 146 # Invoke this rule by hand in order to use the package in-place
 147 install-inplace-pkg : package.conf.inplace
 148         $(GHC_PKG) --force --update-package <package.conf.inplace
 149
 150 endif # $(STANDALONE_PACKAGE)
 151
 152 endif # $(way) == ""
 153
 154 # -----------------------------------------------------------------------------
 155 # Building the static library libHS<pkg>.a
 156
 157 SRC_HSC2HS_OPTS += -I.
 158
 159 ifeq "$(STANDALONE_PACKAGE)" "NO"
 160 HC = $(GHC_INPLACE)
 161 IGNORE_PACKAGE_FLAG = -ignore-package
 162 else
 163 # Only use -ignore-package if supported by HC; i.e., ghc-6.3 and later.
 164 # (Don't like the use of slow $(shell ..) in Makefiles, but can't see a way around it here.)
 165 ifeq "$(strip $(GHC))" ""
 166 IGNORE_PACKAGE_FLAG = -ignore-package
 167 else
 168 # Making the assumption here that standalone packages will be using mk/config.mk:GHC
 169 IGNORE_PACKAGE_FLAG = $(shell if (test $(GhcCanonVersion) -ge 603); then echo "-ignore-package"; else echo "-package-name"; fi)
 170 endif
 171 endif # STANDALONE_PACKAGE
 172
 173 ifeq "$(NON_HS_PACKAGE)" ""
 174 SRC_HC_OPTS     += $(IGNORE_PACKAGE_FLAG) $(PACKAGE)
 175 SRC_HC_OPTS     += $(GhcLibHcOpts)
 176 SRC_HC_OPTS     += $(patsubst %, -package %, $(PACKAGE_DEPS))
 177 endif
 178
 179 #       -fgenerics switches on generation of support code for
 180 #               derivable type classes.  This is now off by default,
 181 #               but we switch it on for the libraries so that we generate
 182 #               the code in case someone importing wants it.
 183 ifeq "$(NON_HS_PACKAGE)" ""
 184 SRC_HC_OPTS     += -fgenerics
 185 endif
 186
 187 LIBRARY         = libHS$(PACKAGE)$(_way).a
 188
 189 ifeq "$(WAYS)" ""
 190 WAYS = $(GhcLibWays)
 191 endif
 192
 193 all :: $(LIBRARY)
 194
 195 # POSSIBLE alternative version using --make:
 196 #
 197 # lib : $(HS_SRCS)
 198 #       $(GHC_INPLACE) $(HC_OPTS) --make $(HS_SRCS)
 199 #
 200 # $(LIBNAME) : lib
 201 #       $(RM) $@
 202 #       $(AR) $(AR_OPTS) $@ $(HS_OBJS)
 203 #       $(RANLIB) $@
 204 #
 205 # %.o : %.hs
 206 #       $(GHC_INPLACE) $(HC_OPTS) --make $<
 207 # %.o : %.lhs
 208 #       $(GHC_INPLACE) $(HC_OPTS) --make $<
 209
 210 # -----------------------------------------------------------------------------
 211 # Installation; need to install .hi files as well as libraries
 212
 213 ifeq "$(DLLized)" "YES"
 214 INSTALL_PROGS += $(DLL_NAME)
 215 INSTALL_LIBS += $(patsubst %.a,%_imp.a, $(LIBRARY))
 216 endif
 217
 218 # The interface files are put inside the $(libdir), since they
 219 # might (potentially) be platform specific..
 220
 221 ifeq "$(HIERARCHICAL_LIB)" "YES"
 222 ifacedir = $(libdir)/imports
 223 else
 224 ifacedir = $(libdir)/hslibs-imports/$(PACKAGE)
 225 endif
 226
 227 # If the lib consists of a hierachy of modules, we must retain the directory
 228 # structure when we install the interfaces.
 229 ifeq "$(HIERARCHICAL_LIB)" "YES"
 230 INSTALL_IFACES_WITH_DIRS += $(HS_IFACES)
 231 ifneq "$(ALL_DIRS)" ""
 232 install ::
 233         @for i in $(ALL_DIRS); do \
 234                 $(INSTALL_DIR) $(ifacedir)/$$i; \
 235         done
 236 endif
 237 else
 238 INSTALL_IFACES += $(HS_IFACES)
 239 endif
 240
 241 # -----------------------------------------------------------------------------
 242 # Dependencies
 243
 244 ifeq "$(STANDALONE_PACKAGE)" "NO"
 245 MKDEPENDHS = $(GHC_INPLACE)
 246 endif
 247
 248 SRC_MKDEPENDC_OPTS += $(addprefix -I,$(ALL_DIRS))
 249
 250 ifeq "$(STANDALONE_PACKAGE)" "NO"
 251 SRC_MKDEPENDC_OPTS += -I$(GHC_INCLUDE_DIR)
 252 endif
 253
 254 endif # $(PACKAGE) != ""
 255
 256 #--------------------------------------------------------------
 257 # Installation
 258
 259 ifneq "$(NO_INSTALL_LIBRARY)" "YES"
 260 INSTALL_LIBS  += $(LIBRARY) $(GHCI_LIBRARY)
 261 endif
 262
 263 #--------------------------------------------------------------
 264 # Building dynamically-linkable libraries for GHCi
 265 #
 266 # Build $(GHCI_LIBRARY) whenever we build $(LIBRARY)
 267 #
 268 # Why?  GHCi can only link .o files (at the moment), not .a files
 269 # so we have to build libFoo.o as well as libFoo.a
 270 #
 271 # Furthermore, GHCi currently never loads
 272 # profiling libraries (or other non-std ways)
 273
 274 ifneq "$(LIBRARY)" ""
 275
 276 ifeq "$(way)" ""
 277 ifeq "$(GhcWithInterpreter)" "YES"
 278
 279 GHCI_LIBRARY = $(patsubst lib%.a,%.o,$(LIBRARY))
 280
 281 ifneq "$(NO_INSTALL_LIBRARY)" "YES"
 282 INSTALL_LIBS += $(GHCI_LIBRARY)
 283 endif
 284
 285 CLEAN_FILES  += $(GHCI_LIBRARY)
 286
 287 all :: $(GHCI_LIBRARY)
 288
 289 ifneq "$(DONT_WANT_STD_GHCI_LIB_RULE)" "YES"
 290 # If you don't want to build GHCI_LIBRARY the 'standard' way,
 291 # set DONT_WANT_STD_GHCI_LIB_RULE to YES. The Prelude and
 292 # hslibs/Win32 uses this 'feature', which will go away soon
 293 # when we can use a "fixed" ld.
 294 #
 295 $(GHCI_LIBRARY) : $(LIBOBJS)
 296         $(LD) -r $(LD_X) -o $@ $(STUBOBJS) $(LIBOBJS)
 297
 298 endif # DONT_WANT_STD_GHCI_LIB_RULE
 299 endif # GhcWithInterpreter
 300 endif # way
 301
 302 ifeq "$(GhcBuildDylibs)" "YES"
 303
 304     # Build dynamic libraries.
 305     # Currently, this is a hack. Anyone, PLEASE clean it up.
 306
 307     # For now, we pretend that there are two operating systems in the world;
 308     # Darwin, and Everything Else. Furthermore, we pretend that Everything Else
 309     # behaves like Linux.
 310
 311 ifeq "$(darwin_TARGET_OS)" "1"
 312     # Darwin: Shared libraries end in .dylib
 313 DYLD_LIBRARY = $(patsubst %.a,%_dyn.dylib,$(LIBRARY))
 314
 315     # About the options used for Darwin:
 316     # -dynamiclib
 317     #   Apple's way of saying -shared
 318     # -flat_namespace -undefined suppress:
 319     #   Without these options, we'd have to specify the correct dependencies
 320     #   for each of the dylibs. Twolevel namespaces are in general a good thing
 321     #   (they make things more robust), so we should fix this sooner or later.
 322     # -install_name
 323     #   Causes the dynamic linker to ignore the DYLD_LIBRARY_PATH when loading
 324     #   this lib and instead look for it at its absolute path.
 325     #   When installing the .dylibs (see target.mk), we'll change that path to
 326     #   point to the place they are installed.
 327     #   Note: I'm not yet sure about this, but I think it will be convenient for
 328     #         users not to have to set up DYLD_LIBRARY_PATH to point to the GHC
 329     #         library dir. -- Wolfgang
 330
 331 $(DYLD_LIBRARY) : $(LIBOBJS) $(STUBOBJS)
 332         $(CC) -dynamiclib -o $@ $(STUBOBJS) $(LIBOBJS) -flat_namespace -undefined suppress -install_name `pwd`/$@
 333 else
 334 DYLD_LIBRARY = $(patsubst %.a,%_dyn.so,$(LIBRARY))
 335
 336 $(DYLD_LIBRARY) : $(LIBOBJS) $(STUBOBJS)
 337         $(CC) -shared -o $@ $(STUBOBJS) $(LIBOBJS)
 338 endif
 339
 340 ifneq "$(NO_INSTALL_LIBRARY)" "YES"
 341 INSTALL_LIBS += $(DYLD_LIBRARY)
 342 endif
 343
 344 CLEAN_FILES += $(DYLD_LIBRARY)
 345
 346 all :: $(DYLD_LIBRARY)
 347
 348 endif # $(GhcBuildDylibs) == "YES"
 349
 350 endif # $(LIBRARY) /= ""
 351
 352 # -----------------------------------------------------------------------------
 353 # Doc building with Haddock
 354
 355 ifneq "$(PACKAGE)" ""
 356 ifneq "$(NO_HADDOCK_DOCS)" "YES"
 357
 358 HS_PPS = $(addsuffix .raw-hs, $(basename $(filter-out $(EXCLUDED_HADDOCK_SRCS), $(HS_SRCS))))
 359
 360 HTML_DIR = html
 361 HTML_DOC = $(HTML_DIR)/haddock.css $(HTML_DIR)/haddock.js
 362
 363 ifneq "$(HS_PPS)" ""
 364
 365 CLEAN_FILES += $(HS_PPS) $(addsuffix .tmp, $(HS_SRCS))
 366
 367 ifeq "$(HADDOCK)" ""
 368 html ::
 369         @echo Haddock must be installed in order to build HTML library documentation.
 370         @echo Please install Haddock and re-configure.
 371         @exit 1
 372 endif
 373
 374 html :: $(HTML_DOC)
 375
 376 extraclean ::
 377         $(RM) -rf $(HTML_DIR)
 378
 379 $(HTML_DOC) : $(HS_PPS)
 380         @$(INSTALL_DIR) $(HTML_DIR)
 381         $(HADDOCK) $(HADDOCK_OPTS) -h -o $(HTML_DIR) $(HS_PPS) \
 382                 --package=$(PACKAGE) \
 383                 --dump-interface=$(PACKAGE).haddock \
 384                 --use-index=../doc-index.html --use-contents=../index.html \
 385                 $(foreach pkg, $(PACKAGE_DEPS), \
 386                    --read-interface=../$(pkg),../$(pkg)/$(pkg).haddock)
 387
 388 CLEAN_FILES += $(PACKAGE).haddock
 389
 390 %.raw-hs : %.lhs
 391         $(HC) $(HC_OPTS) -D__HADDOCK__ -E -optP-P $< -o $@
 392
 393 %.raw-hs : %.hs
 394         $(HC) $(HC_OPTS) -D__HADDOCK__ -E -optP-P $< -o $@
 395
 396 HTML_INSTALL_DIR = $(datadir)/html/libraries/$(PACKAGE)
 397 #  NOT the same as HTML_DIR_INSTALLED when BIN_DIST is on
 398
 399 install-docs :: $(HTML_DOC)
 400         @$(INSTALL_DIR) $(HTML_INSTALL_DIR)
 401         @for i in $(HTML_DIR)/*; do \
 402            echo $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(HTML_INSTALL_DIR); \
 403            $(INSTALL_DATA) $(INSTALL_OPTS) $$i $(HTML_INSTALL_DIR); \
 404         done
 405         $(INSTALL_DATA) $(INSTALL_OPTS) $(PACKAGE).haddock $(HTML_INSTALL_DIR)
 406
 407 endif # HS_PPS
 408 endif # NO_HADDOCK_DOCS
 409 endif # $(PACKAGE) /= ""
 410
 411 # -----------------------------------------------------------------------------
 412