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