buildlib/defaults.mak

   1 # -*- make -*-
   2
   3 # This file configures the default environment for the make system
   4 # The way it works is fairly simple, each module is defined in it's
   5 # own *.mak file. It expects a set of variables to be set to values
   6 # for it to operate as expected. When included the module generates
   7 # the requested rules based on the contents of its control variables.
   8
   9 # This works out very well and allows a good degree of flexability.
  10 # To accomidate some of the features we introduce the concept of
  11 # local variables. To do this we use the 'Computed Names' feature of
  12 # gmake. Each module declares a LOCAL scope and access it with,
  13 #   $($(LOCAL)-VAR)
  14 # This works very well but it is important to rembember that within
  15 # a rule the LOCAL var is unavailble, it will have to be constructed
  16 # from the information in the rule invokation. For stock rules like
  17 # clean this is simple, we use a local clean rule called clean/$(LOCAL)
  18 # and then within the rule $(@F) gets back $(LOCAL)! Other rules will
  19 # have to use some other mechanism (filter perhaps?) The reason such
  20 # lengths are used is so that each directory can contain several 'instances'
  21 # of any given module. I notice that the very latest gmake has the concept
  22 # of local variables for rules. It is possible this feature in conjunction
  23 # with the generated names will provide a very powerfull solution indeed!
  24
  25 # A build directory is used by default, all generated items get put into
  26 # there. However unlike automake this is not done with a VPATH build
  27 # (vpath builds break the distinction between #include "" and #include <>)
  28 # but by explicly setting the BUILD variable. Make is invoked from
  29 # within the source itself which is much more compatible with compilation
  30 # environments.
  31 ifndef NOISY
  32 .SILENT:
  33 endif
  34
  35 # Search for the build directory
  36 ifdef BUILD
  37 BUILD_POSSIBLE := $(BUILD) $(BASE)/$(BUILD)
  38 else
  39 BUILD_POSSIBLE := $(BASE) $(BASE)/build-$(shell uname -m) $(BASE)/build
  40 endif
  41
  42 BUILDX:= $(foreach i,$(BUILD_POSSIBLE),$(wildcard $(i)/environment.mak*))
  43
  44 ifeq ($(words $(BUILDX)),0)
  45
  46 # Check for a busted wildcard function. We use this function in several
  47 # places, it must work.
  48 ifeq ($(words $(wildcard *)),0)
  49 error-all/environment.mak:
  50         echo You have a broken version of GNU Make - upgrade.
  51         error-out-and-die
  52 else
  53 error-all/environment.mak:
  54         echo Can't find the build directory in $(BUILD_POSSIBLE) -- use BUILD=
  55         error-out-and-die
  56 endif
  57
  58 # Force include below to come to the error target
  59 BUILDX := error-all
  60 else
  61 BUILDX:= $(patsubst %/,%,$(firstword $(dir $(BUILDX))))
  62 endif
  63
  64 override BUILD := $(BUILDX)
  65
  66 # Base definitions
  67 INCLUDE := $(BUILD)/include
  68 BIN := $(BUILD)/bin
  69 LIB := $(BIN)
  70 OBJ := $(BUILD)/obj/$(SUBDIR)
  71 DEP := $(OBJ)
  72 DOC := $(BUILD)/docs
  73
  74 # Module types
  75 LIBRARY_H = $(BASE)/buildlib/library.mak
  76 DEBIANDOC_H = $(BASE)/buildlib/debiandoc.mak
  77 MANPAGE_H = $(BASE)/buildlib/manpage.mak
  78 PROGRAM_H = $(BASE)/buildlib/program.mak
  79 COPY_H = $(BASE)/buildlib/copy.mak
  80 YODL_MANPAGE_H = $(BASE)/buildlib/yodl_manpage.mak
  81
  82 ifdef STATICLIBS
  83 LIBRARY_H += $(BASE)/buildlib/staticlibrary.mak
  84 endif
  85
  86 ifdef ONLYSTATICLIBS
  87 LIBRARY_H = $(BASE)/buildlib/staticlibrary.mak
  88 endif
  89
  90 # Source location control
  91 # SUBDIRS specifies sub components of the module that
  92 # may be located in subdrictories of the source dir.
  93 # This should be declared before including this file
  94 SUBDIRS+=
  95
  96 # Header file control.
  97 # TARGETDIRS indicitates all of the locations that public headers
  98 # will be published to.
  99 # This should be declared before including this file
 100 HEADER_TARGETDIRS+=
 101
 102 # Options
 103 include $(BUILD)/environment.mak
 104 CPPFLAGS+= -I$(INCLUDE)
 105 LDFLAGS+= -L$(LIB)
 106
 107 # Phony rules. Other things hook these by appending to the dependency
 108 # list
 109 .PHONY: headers library clean veryclean all binary program doc
 110 .PHONY: maintainer-clean dist-clean distclean pristine sanity
 111 all: binary doc
 112 binary: library program
 113 maintainer-clean dist-clean distclean pristine sanity: veryclean
 114 headers library clean veryclean program:
 115
 116 veryclean:
 117         echo Very Clean done for $(SUBDIR)
 118 clean:
 119         echo Clean done for $(SUBDIR)
 120
 121 # Header file control. We want all published interface headers to go
 122 # into the build directory from thier source dirs. We setup some
 123 # search paths here
 124 vpath %.h $(SUBDIRS)
 125 $(INCLUDE)/%.h $(addprefix $(INCLUDE)/,$(addsuffix /%.h,$(HEADER_TARGETDIRS))) : %.h
 126         cp $< $@
 127
 128 # Dependency generation. We want to generate a .d file using gnu cpp.
 129 # For GNU systems the compiler can spit out a .d file while it is compiling,
 130 # this is specified with the INLINEDEPFLAG. Other systems might have a
 131 # makedep program that can be called after compiling, that's illistrated
 132 # by the DEPFLAG case.
 133 # Compile rules are expected to call this macro after calling the compiler
 134 ifdef INLINEDEPFLAG
 135  define DoDep
 136         sed -e "1s/.*:/$(subst /,\\/,$@):/" $(basename $(@F)).d > $(DEP)/$(@F).d
 137         -rm -f $(basename $(@F)).d
 138  endef
 139 else
 140  ifdef DEPFLAG
 141   define DoDep
 142         $(CXX) $(DEPFLAG) $(CPPFLAGS) -o $@ $<
 143         sed -e "1s/.*:/$(subst /,\\/,$@):/" $(basename $(@F)).d > $(DEP)/$(@F).d
 144         -rm -f $(basename $(@F)).d
 145   endef
 146  else
 147   define DoDep
 148   endef
 149  endif
 150 endif
 151
 152 # Automatic -j support
 153 ifeq ($(NUM_PROCS),1)
 154   PARALLEL_RUN=no
 155 endif
 156
 157 ifndef PARALLEL_RUN
 158  PARALLEL_RUN=yes
 159  .EXPORT: PARALLEL_RUN
 160  # handle recursion
 161  ifneq ($(NUM_PROCS),)
 162   MAKEFLAGS += -j $(NUM_PROCS)
 163  endif
 164 endif