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 flexibility.
  10 # To accommodate 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 remember that within
  15 # a rule the LOCAL var is unavailable, it will have to be constructed
  16 # from the information in the rule invocation. 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 powerful 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 explicitly 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 not 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 PO := $(BUILD)/po
  74 LOCALE := $(BUILD)/locale
  75 PO_DOMAINS := $(BUILD)/po/domains
  76
  77 # Module types
  78 LIBRARY_H = $(BASE)/buildlib/library.mak
  79 DOCBOOK_H = $(BASE)/buildlib/docbook.mak
  80 MANPAGE_H = $(BASE)/buildlib/manpage.mak
  81 PROGRAM_H = $(BASE)/buildlib/program.mak
  82 PYTHON_H = $(BASE)/buildlib/python.mak
  83 COPY_H = $(BASE)/buildlib/copy.mak
  84 PO4A_MANPAGE_H = $(BASE)/buildlib/po4a_manpage.mak
  85 FAIL_H = $(BASE)/buildlib/fail.mak
  86 PODOMAIN_H = $(BASE)/buildlib/podomain.mak
  87
  88 include $(BUILD)/environment.mak
  89
  90 ifdef STATICLIBS
  91 LIBRARY_H += $(BASE)/buildlib/staticlibrary.mak
  92 endif
  93
  94 ifdef ONLYSTATICLIBS
  95 LIBRARY_H = $(BASE)/buildlib/staticlibrary.mak
  96 endif
  97
  98 # Source location control
  99 # SUBDIRS specifies sub components of the module that
 100 # may be located in subdirectories of the source dir.
 101 # This should be declared before including this file
 102 SUBDIRS+=
 103
 104 # Header file control.
 105 # TARGETDIRS indicates all of the locations that public headers
 106 # will be published to.
 107 # This should be declared before including this file
 108 HEADER_TARGETDIRS+=
 109
 110 # Options
 111 CPPFLAGS+= -I$(INCLUDE)
 112 LDFLAGS+= -L$(LIB)
 113
 114 # Directors to create
 115 MKDIRS := $(BIN)
 116
 117 # Phony rules. Other things hook these by appending to the dependency
 118 # list
 119 .PHONY: headers library clean veryclean all binary program doc dirs
 120 .PHONY: maintainer-clean dist-clean distclean pristine sanity
 121 all: dirs binary doc
 122 binary: library program
 123 maintainer-clean dist-clean distclean pristine sanity: veryclean
 124 startup headers library clean veryclean program test update-po manpages docbook:
 125
 126 veryclean:
 127         echo Very Clean done for $(SUBDIR)
 128 clean:
 129         echo Clean done for $(SUBDIR)
 130 dirs:
 131         mkdir -p $(patsubst %/,%,$(sort $(MKDIRS)))
 132
 133 # Header file control. We want all published interface headers to go
 134 # into the build directory from their source dirs. We setup some
 135 # search paths here
 136 vpath %.h $(SUBDIRS)
 137 $(INCLUDE)/%.h $(addprefix $(INCLUDE)/,$(addsuffix /%.h,$(HEADER_TARGETDIRS))) : %.h
 138         cp $< $@
 139
 140 # Dependency generation. We want to generate a .d file using gnu cpp.
 141 # For GNU systems the compiler can spit out a .d file while it is compiling,
 142 # this is specified with the INLINEDEPFLAG. Other systems might have a
 143 # makedep program that can be called after compiling, that's illustrated
 144 # by the DEPFLAG case.
 145 # Compile rules are expected to call this macro after calling the compiler
 146 ifdef GCC3DEP
 147 DFILE = $(DEP)/$(basename $(@F)).d
 148 else
 149 DFILE = $(basename $(@F)).d
 150 endif
 151 ifdef INLINEDEPFLAG
 152  define DoDep
 153         sed -e "1s/.*:/$(subst /,\\/,$@):/" $(DFILE) > $(DEP)/$(@F).d
 154         #sed -e "1s/.*:/$(subst /,\\/,$@):/" $(DEP)/$(basename $(@F)).d > $(DEP)/$(@F).d
 155         -rm -f $(basename $(@F)).d
 156  endef
 157 else
 158  ifdef DEPFLAG
 159   define DoDep
 160         $(CXX) $(DEPFLAG) $(CPPFLAGS) -o $@ $<
 161         sed -e "1s/.*:/$(subst /,\\/,$@):/" $(basename $(@F)).d > $(DEP)/$(@F).d
 162         -rm -f $(basename $(@F)).d
 163   endef
 164  else
 165   define DoDep
 166   endef
 167  endif
 168 endif
 169
 170 # Automatic -j support
 171 ifeq ($(NUM_PROCS),1)
 172   PARALLEL_RUN=no
 173 endif
 174
 175 ifndef PARALLEL_RUN
 176  PARALLEL_RUN=yes
 177  export PARALLEL_RUN
 178  # handle recursion
 179  ifneq ($(NUM_PROCS),)
 180   MAKEFLAGS += -j $(NUM_PROCS)
 181  endif
 182 endif
 183
 184 # This makes sorting predictable
 185 export LC_COLLATE=C.UTF-8