mk/package.mk

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