Lib.mak

   1
   2 ifndef Lib.mak.included
   3 Lib.mak.included := 1
   4
   5 # These variables should be provided by the includer Makefile:
   6 # P should be the project name, mostly used to handle include directories
   7 # T should be the path to the top-level directory.
   8 # C should be the path to the current directory.
   9
  10 # Load top-level directory local configuration
  11 sinclude $T/Config.mak
  12
  13 # Verbosity flag (empty show nice messages, 1 be verbose)
  14 # honour make -s flag
  15 override V := $(if $(findstring s,$(MAKEFLAGS)),1,$V)
  16
  17 # Flavor (variant), should be one of "dbg", "opt" or "cov"
  18 F ?= opt
  19
  20 # Use C++ linker by default
  21 LINKER := $(CXX)
  22
  23 # Use precompiled headers if non-empty
  24 GCH ?=
  25
  26
  27 # Directories
  28 ##############
  29
  30 # Use absolute paths to avoid problems with automatic dependencies when
  31 # building from subdirectories
  32 T := $(abspath $T)
  33
  34 # Name of the current directory, relative to $T
  35 R := $(subst $T,,$(patsubst $T/%,%,$(CURDIR)))
  36
  37 # Base directory where to put variants
  38 D ?= $T/build
  39
  40 # Generated files top directory
  41 G ?= $D/$F
  42
  43 # Objects (and other garbage like precompiled headers and dependency files)
  44 # directory
  45 O ?= $G/obj
  46
  47 # Binaries directory
  48 B ?= $G/bin
  49
  50 # Libraries directory
  51 L ?= $G/lib
  52
  53 # Includes directory
  54 I ?= $G/include
  55
  56 # Generated includes directory
  57 J ?= $G/geninc
  58
  59
  60 # Functions
  61 ############
  62
  63 # Find sources files and get the corresponding object names
  64 # The first argument should be the sources extension ("c" or "cpp" typically)
  65 # It expects the variable $T and $O to be defined as commented previously in
  66 # this file. $C should be defined to the path to the current directory relative
  67 # to the top-level.
  68 find_objects = $(patsubst $T/%.$1,$O/%.o,$(shell find $T/$C -name '*.$1'))
  69
  70 # Abbreviate a file name. Cut the leading part of a file if it match to the $T
  71 # directory, so it can be displayed as if it were a relative directory. Take
  72 # just one argument, the file name.
  73 abbr = $(addprefix $(shell echo $R | sed 's|/\?\([^/]\+\)/\?|../|g'),\
  74                 $(subst $T,.,$(patsubst $T/%,%,$1)))
  75
  76 # Execute a command printing a nice message if $V is empty
  77 # The first argument is mandatory and it's the command to execute. The second
  78 # and third arguments are optional and are the target name and command name to
  79 # pretty print.
  80 vexec = $(if $V,,\
  81                 echo '   $(notdir $(if $3,$(strip $3),$(firstword $1))) \
  82                                 $(call abbr,$(if $2,$(strip $2),$@))' ; )$1
  83
  84 # Same as vexec but it silence the echo command (prepending a @).
  85 exec = $(if $V,,@)$(call vexec,$1,$2,$3)
  86
  87 # Compile a source file to an object, generating pre-compiled headers and
  88 # dependencies. The pre-compiled headers are generated only if the system
  89 # includes change. This function is designed to be used as a command in a rule.
  90 # It takes one argument only, the type of file to compile (typically "c" or
  91 # "cpp"). What to compile and the output files are built using the automatic
  92 # variables from a rule.
  93 define compile
  94 $(if $(GCH),\
  95 @if test -f $O/$*.d; then \
  96         tmp=`mktemp`; \
  97         h=`awk -F: '!$$0 {f = 1} $$0 && f {print $$1}' $O/$*.d`; \
  98         grep -h '^#include <' $(call abbr,$<) $$h | sort -u > "$$tmp"; \
  99         if diff -q -w "$(call abbr,$O/$*.$1.h)" "$$tmp" > /dev/null 2>&1; \
 100         then \
 101                 rm "$$tmp"; \
 102         else \
 103                 mv "$$tmp" "$(call abbr,$O/$*.$1.h)"; \
 104                 $(call vexec,$(COMPILE.$1) -o "$O/$*.$1.h.gch" "$O/$*.$1.h",\
 105                                 $O/$*.$1.h.gch); \
 106         fi \
 107 else \
 108         touch "$(call abbr,$O/$*.$1.h)"; \
 109 fi \
 110 )
 111 $(call exec,$(COMPILE.$1) -o $@ -MMD -MP $(if $(GCH),-include $O/$*.$1.h) $<)
 112 endef
 113
 114 # Link object files to build an executable. The objects files are taken from
 115 # the prerequisite files ($O/%.o). If in the prerequisite files are shared
 116 # objects ($L/lib%.so), they are included as libraries to link to (-l%). This
 117 # function is designed to be used as a command in a rule. The ouput name is
 118 # taken from the rule automatic variables. If an argument is provided, it's
 119 # included in the link command line. The variable LINKER is used to link the
 120 # executable; for example, if you want to link a C++ executable, you should use
 121 # LINKER := $(CXX).
 122 link = $(call exec,$(LINKER) $(LDFLAGS) $(TARGET_ARCH) -o $@ $1 \
 123                 $(patsubst $L/lib%.so,-l%,$(filter %.so,$^)) \
 124                 $(foreach obj,$(filter %.o,$^),$(obj)))
 125
 126
 127 # Overrided flags
 128 ##################
 129
 130 # Warn about everything
 131 override CPPFLAGS += -Wall
 132
 133 # Use the includes directories to search for includes
 134 override CPPFLAGS += -I$I -I$J
 135
 136 # Be standard compilant
 137 override CFLAGS += -std=c99 -pedantic
 138 override CXXFLAGS += -std=c++98 -pedantic
 139
 140 # Use the generated library directory to for libraries
 141 override LDFLAGS += -L$L -Wall
 142
 143 # Make sure the generated libraries can be found
 144 export LD_LIBRARY_PATH := $L:$(LD_LIBRARY_PATH)
 145
 146
 147 # Variant flags
 148 ################
 149
 150 ifeq ($F,dbg)
 151 override CPPFLAGS += -ggdb -DDEBUG
 152 endif
 153
 154 ifeq ($F,opt)
 155 override CPPFLAGS += -O2 -DNDEBUG
 156 endif
 157
 158 ifeq ($F,cov)
 159 override CPPFLAGS += -ggdb -pg --coverage
 160 override LDFLAGS += -pg --coverage
 161 endif
 162
 163
 164 # Automatic rebuilding when flags or commands changes
 165 ######################################################
 166
 167 # Re-compile C files if one of this variables changes
 168 COMPILE.c.FLAGS := $(CC) ~ $(CPPFLAGS) ~ $(CFLAGS) ~ $(TARGET_ARCH)
 169
 170 # Re-compile C++ files if one of this variables changes
 171 COMPILE.cpp.FLAGS := $(CXX) ~ $(CPPFLAGS) ~ $(CXXFLAGS) ~ $(TARGET_ARCH)
 172
 173 # Re-link binaries and libraries if one of this variables changes
 174 LINK.o.FLAGS := $(LD) ~ $(LDFLAGS) ~ $(TARGET_ARCH)
 175
 176
 177 # Default rules
 178 ################
 179
 180 $O/%.o: $T/%.c $G/compile-c-flags
 181         $(call compile,c)
 182
 183 $O/%.o: $T/%.cpp $G/compile-cpp-flags
 184         $(call compile,cpp)
 185
 186 $B/%: $G/link-o-flags
 187         $(call link)
 188
 189 $L/%.so: override CFLAGS += -fPIC
 190 $L/%.so: override CXXFLAGS += -fPIC
 191 $L/%.so: $G/link-o-flags
 192         $(call link,-shared)
 193
 194 .PHONY: clean
 195 clean:
 196         $(call exec,$(RM) -r $D,$D)
 197
 198
 199 # Automatic dependency handling
 200 ################################
 201
 202 sinclude $(shell test -d $O && find $O -name '*.d')
 203
 204
 205 # Create build directory structure
 206 ###################################
 207
 208 # Create a file with flags used to trigger rebuilding when they change. The
 209 # first argument is the name of the file where to store the flags, the second
 210 # are the flags and the third argument is a text to be displayed if the flags
 211 # have changed.  This should be used as a rule action or something where
 212 # a shell script is expected.
 213 gen_rebuild_flags = if test x"$2" != x"`cat $1 2>/dev/null`"; then \
 214                 test -f $1 && echo "$3"; \
 215                 echo "$2" > $1 ; fi
 216
 217 # Create $O, $B, $L, $I and $J directories and replicate the directory
 218 # structure of the project into $O. Create one symlink "last" to the current
 219 # build directory and another to use as include directory.  It update the flags
 220 # files to detect flag and/or compiler changes to force a rebuild.
 221 #
 222 # NOTE: the second mkdir can yield no arguments if the project don't have any
 223 #       subdirectories, that's why the current directory "." is included, so it
 224 #       won't show an error message in case of no subdirectories.
 225 setup_build_dir__ := $(shell \
 226         mkdir -p $O $B $L $I $J; \
 227         mkdir -p . $(addprefix $O,$(patsubst $T%,%,\
 228                         $(shell find $T -type d -not -path '$D*'))); \
 229         $(call gen_rebuild_flags,$G/compile-c-flags, \
 230                         $(COMPILE.c.FLAGS),C compiler or flags;); \
 231         $(call gen_rebuild_flags,$G/compile-cpp-flags, \
 232                         $(COMPILE.cpp.FLAGS),C++ compiler or flags;); \
 233         $(call gen_rebuild_flags,$G/link-o-flags, \
 234                         $(LINK.o.FLAGS),linker or link flags;); \
 235         test -L $I/$P || ln -s $T $I/$P; \
 236         test -L $D/last || ln -s $F $D/last )
 237
 238 # Print any generated message (if verbose)
 239 $(if $V,,$(if $(setup_build_dir__), \
 240         $(info !! Something changed: $(setup_build_dir__) \
 241                         re-building affected files...)))
 242
 243 # Include the Build.mak for this directory
 244 include $T/Build.mak
 245
 246 # Phony rule to make all the targets (sub-makefiles can append targets to build
 247 # to the $(all) variable).
 248 .PHONY: all
 249 all: $(all)
 250
 251 endif