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
  40 endif
  41
  42 BUILDX:= $(foreach i,$(BUILD_POSSIBLE),$(wildcard $(i)/environment.mak*))
  43 BUILDX:= $(patsubst %/,%,$(firstword $(dir $(BUILDX))))
  44
  45 ifeq ($(words $(BUILDX)),0)
  46 error-all:
  47         echo Can't find the build directory in $(BUILD_POSSIBLE) -- use BUILD=
  48 endif
  49
  50 override BUILD := $(BUILDX)
  51
  52 # Base definitions
  53 INCLUDE := $(BUILD)/include
  54 BIN := $(BUILD)/bin
  55 LIB := $(BIN)
  56 OBJ := $(BUILD)/obj/$(SUBDIR)
  57 DEP := $(OBJ)
  58 DOC := $(BUILD)/docs
  59
  60 # Module types
  61 LIBRARY_H = $(BASE)/buildlib/library.mak
  62 DEBIANDOC_H = $(BASE)/buildlib/debiandoc.mak
  63 MANPAGE_H = $(BASE)/buildlib/manpage.mak
  64 PROGRAM_H = $(BASE)/buildlib/program.mak
  65 COPY_H = $(BASE)/buildlib/copy.mak
  66 YODL_MANPAGE_H = $(BASE)/buildlib/yodl_manpage.mak
  67
  68 ifdef STATICLIBS
  69 LIBRARY_H += $(BASE)/buildlib/staticlibrary.mak
  70 endif
  71
  72 ifdef ONLYSTATICLIBS
  73 LIBRARY_H = $(BASE)/buildlib/staticlibrary.mak
  74 endif
  75
  76 # Source location control
  77 # SUBDIRS specifies sub components of the module that
  78 # may be located in subdrictories of the source dir.
  79 # This should be declared before including this file
  80 SUBDIRS+=
  81
  82 # Header file control.
  83 # TARGETDIRS indicitates all of the locations that public headers
  84 # will be published to.
  85 # This should be declared before including this file
  86 HEADER_TARGETDIRS+=
  87
  88 # Options
  89 include $(BUILD)/environment.mak
  90 CPPFLAGS+= -I$(INCLUDE)
  91 LDFLAGS+= -L$(LIB)
  92
  93 # Phony rules. Other things hook these by appending to the dependency
  94 # list
  95 .PHONY: headers library clean veryclean all binary program doc
  96 .PHONY: maintainer-clean dist-clean distclean pristine sanity
  97 all: binary doc
  98 binary: library program
  99 maintainer-clean dist-clean distclean pristine sanity: veryclean
 100 headers library clean veryclean program:
 101
 102 veryclean:
 103         echo Very Clean done for $(SUBDIR)
 104 clean:
 105         echo Clean done for $(SUBDIR)
 106
 107 # Header file control. We want all published interface headers to go
 108 # into the build directory from thier source dirs. We setup some
 109 # search paths here
 110 vpath %.h $(SUBDIRS)
 111 $(INCLUDE)/%.h $(addprefix $(INCLUDE)/,$(addsuffix /%.h,$(HEADER_TARGETDIRS))) : %.h
 112         cp $< $@
 113
 114 # Dependency generation. We want to generate a .d file using gnu cpp.
 115 # For GNU systems the compiler can spit out a .d file while it is compiling,
 116 # this is specified with the INLINEDEPFLAG. Other systems might have a
 117 # makedep program that can be called after compiling, that's illistrated
 118 # by the DEPFLAG case.
 119 # Compile rules are expected to call this macro after calling the compiler
 120 ifdef INLINEDEPFLAG
 121  define DoDep
 122         sed -e "1s/.*:/$(subst /,\\/,$@):/" $(basename $(@F)).d > $(DEP)/$(@F).d
 123         -rm -f $(basename $(@F)).d
 124  endef
 125 else
 126  ifdef DEPFLAG
 127   define DoDep
 128         $(CXX) $(DEPFLAG) $(CPPFLAGS) -o $@ $<
 129         sed -e "1s/.*:/$(subst /,\\/,$@):/" $(basename $(@F)).d > $(DEP)/$(@F).d
 130         -rm -f $(basename $(@F)).d
 131   endef
 132  else
 133   define DoDep
 134   endef
 135  endif
 136 endif