mk/paths.mk

   1 #################################################################################
   2 #
   3 #                           paths.mk
   4 #
   5 #       This file defines Make variables for standard directories
   6 #       and file lists
   7 #
   8 #################################################################################
   9
  10
  11 #-----------------------------------------------------------------
  12 #
  13 # Installation setup
  14 #
  15
  16 #-----------------------------------------------------------------------------
  17 # install configuration
  18 #
  19 # The install standard target is guided by the following four variables
  20 #
  21 #  INSTALL_PROGS    (installed in $(bindir))
  22 #  INSTALL_LIBS     (installed in $(libdir))
  23 #  INSTALL_LIBEXECS (installed in $(libexecdir))
  24 #  INSTALL_DATAS    (installed in $(datadir))
  25 #
  26 # see target.mk for more information.
  27 #
  28
  29 #
  30 # Setting user/group ownership for the installed entities
  31 #
  32 # this stuff about "who" does the installing doesn't have make vars
  33 # as it is not intended to be run-time changeable.
  34 #
  35 ifneq "$(OWNER)" ""
  36 INSTALL_OWNER   = -o $(OWNER)
  37 else
  38 INSTALL_OWNER   =
  39 endif
  40
  41 ifneq "$(GROUP)" ""
  42 INSTALL_GROUP   = -g $(GROUP)
  43 else
  44 INSTALL_GROUP   =
  45 endif
  46
  47 SRC_INSTALL_OPTS += $(INSTALL_OWNER) $(INSTALL_GROUP)
  48
  49 #
  50 # Invocations of `install' for the four different classes
  51 # of targets:
  52 #
  53
  54 INSTALL_PROGRAM = $(INSTALL) -m 755
  55 INSTALL_SCRIPT  = $(INSTALL) -m 755
  56 INSTALL_SHLIB   = $(INSTALL) -m 755
  57 INSTALL_DATA    = $(INSTALL) -m 644
  58 INSTALL_DIR     = $(FPTOOLS_TOP)/glafp-utils/mkdirhier/mkdirhier
  59
  60 #
  61 # The install variables does not have any defaults,
  62 # what files to install have to be specified in the Makefiles.
  63 #
  64 #INSTALL_PROGS += $(HS_PROG) $(C_PROG)
  65 #INSTALL_LIBS  += $(LIBRARY)
  66 #INSTALL_DATAS += $(HS_IFACES)
  67
  68 #################################################################################
  69 #
  70 #               Standard variable names
  71 #
  72 #################################################################################
  73
  74 #
  75 # The fptools mk setup defines a set of standard names which are used by the standard
  76 # targets provided by mk. One example of this is the use of standard names
  77 # for specifying what files to compile, their intermediate/object code, and
  78 # the name of the final executable. Based on the settings of these variables, the
  79 # standard targets will generate/expand rules that automatically compile and
  80 # link your program.
  81 #
  82 # The general rules:
  83 #
  84 #   SRCS - sources, might be prefixed to indicate what type of source
  85 #          they are.
  86 #   OBJS - object files (possibly prefixed).
  87 #
  88 #   PROG - name of final executable
  89
  90 # We attempt to automatically devine the list of sources $(SRCS) to
  91 # compile by looking in the current directory.  This is complicated by
  92 # the fact that a .hsc file gives rise to a .hs file (which needs to
  93 # be automatically included in $(SRCS)), but the .hs file might
  94 # already be present in the current directory and we don't want to
  95 # compile it twice.
  96
  97 # So we figure out the sources in three stages: first figure out
  98 # what's in the current directory (this is $(PRE_SRCS)).  Then figure
  99 # out all the "derived" sources (eg. A.hsc generates A.hs and
 100 # A_hsc.c), and finally put all these together and remove duplicates
 101 # (GNU make's handy sort function does the duplicate removing).
 102 #
 103 # BOOT_SRCS: list of machine generated Haskell modules.
 104 # HS_SRCS:   list of Haskell modules you want to compile.
 105 #             (also use by depend rule).
 106 # HS_OBJS:   list of corresponding object files
 107 # HS_PROG:   program that is ultimately linked.
 108 # HS_IFACES: list of interface files generated
 109 #             (caveat: assuming no funny use of -hisuf and that
 110 #               file name and module name match)
 111
 112 # NB. use := rather than = here, otherwise the wildcard will get re-computed
 113 # every time PRE_SRCS is expanded (this happens a lot).
 114 ALL_SRCS    = $(wildcard $(patsubst ./%, %,  \
 115                    $(patsubst %,%/*.hs,   . $(ALL_DIRS)) \
 116                    $(patsubst %,%/*.lhs,  . $(ALL_DIRS)) \
 117                    $(patsubst %,%/*.y,    . $(ALL_DIRS)) \
 118                    $(patsubst %,%/*.ly,   . $(ALL_DIRS)) \
 119                    $(patsubst %,%/*.c,    . $(ALL_DIRS)) \
 120                    $(patsubst %,%/*.hc,   . $(ALL_DIRS)) \
 121                    $(patsubst %,%/*.S,    . $(ALL_DIRS)) \
 122                    $(patsubst %,%/*.prl,  . $(ALL_DIRS)) \
 123                    $(patsubst %,%/*.lprl, . $(ALL_DIRS)) \
 124                    $(patsubst %,%/*.lit,  . $(ALL_DIRS)) \
 125                    $(patsubst %,%/*.verb, . $(ALL_DIRS)) \
 126                    $(patsubst %,%/*.hsc,  . $(ALL_DIRS)) \
 127                ))
 128
 129 # ALL_SRCS is computed once and for all into PRE_SRCS at the top of target.mk.
 130
 131 PRE_HS_SRCS  = $(filter %.hs,  $(PRE_SRCS))
 132 PRE_LHS_SRCS = $(filter %.lhs, $(PRE_SRCS))
 133
 134 HSC_SRCS     = $(filter %.hsc, $(PRE_SRCS))
 135 HAPPY_SRCS   = $(filter %.y,   $(PRE_SRCS)) $(filter %.ly, $(PRE_SRCS))
 136
 137 DERIVED_SRCS = $(patsubst %.hsc, %.hs, $(HSC_SRCS)) \
 138                $(patsubst %.hsc, %_hsc.c, $(HSC_SRCS)) \
 139                $(patsubst %.hsc, %_hsc.h, $(HSC_SRCS)) \
 140                $(patsubst %.hsc, %.hc, $(HSC_SRCS)) \
 141                $(patsubst %.y,   %.hs, $(HAPPY_SRCS)) \
 142                $(patsubst %.ly,  %.hs, $(HAPPY_SRCS)) \
 143                $(patsubst %.hs,  %.hc, $(PRE_HS_SRCS)) \
 144                $(patsubst %.lhs, %.hc, $(PRE_LHS_SRCS))
 145
 146 # EXCLUDED_SRCS can be set in the Makefile, otherwise it defaults to empty.
 147 EXCLUDED_HSC_SRCS     = $(filter %.hsc, $(EXCLUDED_SRCS))
 148 EXCLUDED_HAPPY_SRCS   = $(filter %.y,   $(EXCLUDED_SRCS)) $(filter %.ly, $(EXCLUDED_SRCS))
 149 EXCLUDED_HS_SRCS      = $(filter %.hs,  $(EXCLUDED_SRCS))
 150 EXCLUDED_LHS_SRCS     = $(filter %.lhs, $(EXCLUDED_SRCS))
 151 EXCLUDED_DERIVED_SRCS = $(patsubst %.hsc, %.hs, $(EXCLUDED_HSC_SRCS)) \
 152                         $(patsubst %.hsc, %_hsc.h, $(EXCLUDED_HSC_SRCS)) \
 153                         $(patsubst %.hsc, %_hsc.c, $(EXCLUDED_HSC_SRCS)) \
 154                         $(patsubst %.hsc, %.hc, $(EXCLUDED_HSC_SRCS)) \
 155                         $(patsubst %.y,   %.hs, $(EXCLUDED_HAPPY_SRCS)) \
 156                         $(patsubst %.ly,  %.hs, $(EXCLUDED_HAPPY_SRCS)) \
 157                         $(patsubst %.hs,  %.hc, $(EXCLUDED_HS_SRCS)) \
 158                         $(patsubst %.lhs, %.hc, $(EXCLUDED_LHS_SRCS))
 159 # Exclude _hsc.c files; they get built as part of the cbits library,
 160 # not part of the main library
 161
 162 CLOSED_EXCLUDED_SRCS  = $(sort $(EXCLUDED_SRCS) $(EXCLUDED_DERIVED_SRCS))
 163
 164 SRCS        = $(filter-out $(CLOSED_EXCLUDED_SRCS), \
 165                 $(sort $(PRE_SRCS) $(DERIVED_SRCS)))
 166
 167 HS_SRCS     = $(filter %.lhs %.hs, $(sort $(SRCS) $(BOOT_SRCS)))
 168 HS_OBJS     = $(addsuffix .$(way_)o,$(basename $(HS_SRCS)))
 169 HS_IFACES   = $(addsuffix .$(way_)hi,$(basename $(HS_SRCS)))
 170
 171 HSC_C_OBJS  = $(addsuffix _hsc.$(way_)o,$(basename $(filter %.hsc,$(SRCS))))
 172
 173 C_SRCS      = $(filter %.c,$(SRCS))
 174 C_OBJS      = $(addsuffix .$(way_)o,$(basename $(C_SRCS)))
 175
 176 # SCRIPT_SRCS:  list of raw script files (in literate form)
 177 # SCRIPT_OBJS:  de-litted scripts
 178 SCRIPT_SRCS=$(filter %.lprl,$(SRCS))
 179 SCRIPT_OBJS=$(addsuffix .prl,$(basename $(SCRIPT_SRCS)))
 180
 181 OBJS=$(HS_OBJS) $(C_OBJS) $(SCRIPT_OBJS)
 182
 183 #
 184 # Note that as long as you use the standard variables for setting
 185 # which C & Haskell programs you want to work on, you don't have
 186 # to set any of the clean variables - the default should do the Right
 187 # Thing.
 188 #
 189
 190 #------------------------------------------------------------------
 191 #
 192 # make depend defaults
 193 #
 194 # The default set of files for the dependency generators to work on
 195 # is just their source equivalents.
 196 #
 197
 198 ifneq "$(BootingFromHc)" "YES"
 199 MKDEPENDHS_SRCS=$(HS_SRCS)
 200 else
 201 MKDEPENDHS_SRCS=
 202 endif
 203
 204 MKDEPENDC_SRCS=$(C_SRCS)
 205
 206 #------------------------------------------------------------------
 207 #
 208 # make TAGS defaults
 209 #
 210 # The default set of files for the dependency generators to work on
 211 # is just their source equivalents.
 212 #
 213 TAGS_HS_SRCS=$(HS_SRCS)
 214 TAGS_C_SRCS=$(C_SRCS)
 215
 216 #------------------------------------------------------------------
 217 # Clean file make-variables.
 218 #
 219 # The following three variables are used to control
 220 # what gets removed when doing `make clean'
 221 #
 222 # MOSTLYCLEAN_FILES   object code etc., but not stuff
 223 #                     that is slow to recompile and/or stable
 224 #
 225 # CLEAN_FILES  all files that are created by running make.
 226 #
 227 # MAINTAINER_CLEAN_FILES also clean out machine-generated files
 228 #                        that may require extra tools to create.
 229 #
 230 #
 231 MOSTLY_CLEAN_FILES += $(HS_OBJS) $(C_OBJS) $(HSC_C_OBJS)
 232 CLEAN_FILES        += $(HS_PROG) $(C_PROG) $(SCRIPT_PROG) $(SCRIPT_LINK) \
 233                       $(PROG) $(LIBRARY) $(HS_IFACES) a.out \
 234                       $(CLEAN_DERIVED_SRCS)
 235
 236 # Don't clean the .hc files if we're bootstrapping
 237 ifeq "$(BootingFromHc)" "YES"
 238 CLEAN_DERIVED_SRCS = $(filter-out %.hc, $(DERIVED_SRCS))
 239 else
 240 CLEAN_DERIVED_SRCS = $(DERIVED_SRCS)
 241 endif
 242
 243 DIST_CLEAN_FILES += .depend
 244 MAINTAINER_CLEAN_FILES += $(BOOT_SRCS)
 245
 246 #
 247 # `Standard' set of files to clean out.
 248 #
 249 MOSTLY_CLEAN_FILES += \
 250  *.CKP *.ln *.BAK *.bak .*.bak *.o core a.out errs ,* *.a .emacs_*  \
 251  tags TAGS *.ind *.ilg *.idx *.idx-prev *.aux *.aux-prev *.dvi *.log \
 252  *.toc *.lot *.lof *.blg *.cb *_stub.c *_stub.h *.raw_s *.a.list
 253
 254 #------------------------------------------------------------------
 255 #
 256 # Distribution setup
 257 #
 258 # Following variables are used for creating source and binary distributions:
 259 #
 260 #  SRC_DIST_NAME && BIN_DIST_NAME  -- the package names
 261 #
 262 #  SRC_DIST_FILES = list of extra files to include from a build tree into a source
 263 #                   distribution
 264 #
 265 #  SRC_DIST_DIR  = what the current directory in the source/build tree
 266 #                  maps to in the source distrib. tree being created.
 267 #
 268 SRC_DIST_NAME=$(ProjectNameShort)-$(ProjectVersion)
 269
 270 #
 271 # Binary distributions proceeds as follows:
 272 #
 273 # Fromthe top of a build tree, you do `make binary-dist'. The
 274 # canned rule for this  (in target.mk) will then do a binary
 275 # install to a temporary directory before packaging it all up.
 276 # The following variables guide the binary-dist:
 277 #
 278 #  BIN_DIST_TMPDIR= the absolute path to where the temporary directory
 279 #                   structure of a binary distribution should be created.
 280 #                   [Default: toplevel from which you issue `make binary-dist']
 281 #  BIN_DIST_NAME=   what to call the thing.
 282 #
 283 #  BIN_DIST_DIRS=   at the toplevel, list of directories to descend into when
 284 #                   building the distribution tree.
 285 #
 286 #  An extra directory variable that is set during bin-dists is $(bindist_top), giving
 287 #  the abs. path to the root of the binary installation tree. (useful when punting
 288 #  stuff like README and ANNOUNCE into a distrib, for instance)
 289 #
 290 #  The layout of a binary distribution is described in the
 291 #  installation documentation.
 292 #
 293
 294
 295 # Directory in which DLLs are dumped so as not to get picked up by running
 296 # programs (e.g. ghc or hsc) that run in the build tree
 297
 298 DLL_PEN = $(FPTOOLS_TOP)/dll
 299