Lib.mak

   1 ifndef Lib.mak.included
   2 Lib.mak.included := 1
   3
   4 # These variables should be provided by the Makefile that include us:
   5 # P should be the project name, mostly used to handle include directories
   6 # T should be the path to the top-level directory.
   7 # S should be sub-directory where the current makefile is, relative to $T.
   8
   9 # Verbosity flag (empty show nice messages, non-empty use make messages)
  10 # When used internal, $V expand to @ is nice messages should be printed, this
  11 # way it's easy to add $V in front of commands that should be silenced when
  12 # displaying the nice messages.
  13 override V := $(if $V,,@)
  14 # honour make -s flag
  15 override V := $(if $(findstring s,$(MAKEFLAGS)),,$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 # Default mode used to install files
  24 IMODE ?= 0644
  25
  26 # Default install flags
  27 IFLAGS ?= -D
  28
  29 # Use pre-compiled headers if non-empty
  30 GCH ?=
  31
  32
  33 # Directories
  34 ##############
  35
  36 # Base directory where to install files (can be overridden, should be absolute)
  37 prefix ?= /usr/local
  38
  39 # Path to a complete alternative environment, usually a jail, or an installed
  40 # system mounted elsewhere than /.
  41 DESTDIR ?=
  42
  43 # Use absolute paths to avoid problems with automatic dependencies when
  44 # building from subdirectories
  45 T := $(abspath $T)
  46
  47 # Name of the current directory, relative to $T
  48 R := $(subst $T,,$(patsubst $T/%,%,$(CURDIR)))
  49
  50 # Base directory where to put variants (Variants Directory)
  51 VD ?= $T/build
  52
  53 # Generated files top directory
  54 G ?= $(VD)/$F
  55
  56 # Objects (and other garbage like pre-compiled headers and dependency files)
  57 # directory
  58 O ?= $G/obj
  59
  60 # Binaries directory
  61 B ?= $G/bin
  62
  63 # Libraries directory
  64 L ?= $G/lib
  65
  66 # Documentation directory
  67 D ?= $(VD)/doc
  68
  69 # Installation directory
  70 I := $(DESTDIR)$(prefix)
  71
  72 # Includes directory
  73 INCLUDE_DIR ?= $G/include
  74
  75 # Directory of the current makefile (this might not be the same as $(CURDIR)
  76 # This variable is "lazy" because $S changes all the time, so it should be
  77 # evaluated in the context where $C is used, not here.
  78 C = $T/$S
  79
  80
  81 # Functions
  82 ############
  83
  84 # Compare two strings, if they are the same, returns the string, if not,
  85 # returns empty.
  86 eq = $(if $(subst $1,,$2),,$1)
  87
  88 # Find sources files and get the corresponding object names.  The first
  89 # argument should be the sources extension ("c" or "cpp" typically).  The
  90 # second argument is where to search for the sources ($C if omitted).  The
  91 # resulting files will always have the suffix "o" and the directory rewritten
  92 # to match the directory structure (from $T) but in the $O directory.  For
  93 # example, if $T is "/usr/src", $O is "/tmp/obj", $C is "/usr/src/curr" and it
  94 # have 2 C sources: "/usr/src/curr/1.c" and "/usr/src/curr/dir/2.c", the call:
  95 # $(call find_objects,c)
  96 # Will yield "/tmp/obj/curr/1.o" and "/tmp/obj/curr/dir/2.o".
  97 find_objects = $(patsubst $T/%.$1,$O/%.o,$(shell \
  98                 find $(if $2,$2,$C) -name '*.$1'))
  99
 100 # Find files and get the their file names relative to another directory.  The
 101 # first argument should be the files suffix (".h" or ".cpp" for example).  The
 102 # second argument is a directory rewrite, the matched files will be rewriten to
 103 # be in the directory specified in this argument (it defaults to the third
 104 # argument if omitted).  The third argument is where to search for the files
 105 # ($C if omitted).
 106 find_files = $(patsubst $(if $3,$3,$C)/%$1,$(if $2,$2,$(if $3,$3,$C))/%$1, \
 107                 $(shell find $(if $3,$3,$C) -name '*$1'))
 108
 109 # Abbreviate a file name. Cut the leading part of a file if it match to the $T
 110 # directory, so it can be displayed as if it were a relative directory. Take
 111 # just one argument, the file name.
 112 abbr_helper = $(subst $T,.,$(patsubst $T/%,%,$1))
 113 abbr = $(if $(call eq,$(call abbr_helper,$1),$1),$1, \
 114         $(addprefix $(shell echo $R | sed 's|/\?\([^/]\+\)/\?|../|g'),\
 115                 $(call abbr_helper,$1)))
 116
 117 # Execute a command printing a nice message if $V is @.
 118 # The first argument is mandatory and it's the command to execute. The second
 119 # and third arguments are optional and are the target name and command name to
 120 # pretty print.
 121 vexec = $(if $V,\
 122                 echo '   $(notdir $(if $3,$(strip $3),$(firstword $1))) \
 123                                 $(call abbr,$(if $2,$(strip $2),$@))' ; )$1
 124
 125 # Same as vexec but it silence the echo command (prepending a @ if $V).
 126 exec = $V$(call vexec,$1,$2,$3)
 127
 128 # Compile a source file to an object, generating pre-compiled headers and
 129 # dependencies. The pre-compiled headers are generated only if the system
 130 # includes change. This function is designed to be used as a command in a rule.
 131 # It takes one argument only, the type of file to compile (typically "c" or
 132 # "cpp"). What to compile and the output files are built using the automatic
 133 # variables from a rule.
 134 define compile
 135 $(if $(GCH),\
 136 $Vif test -f $O/$*.d; then \
 137         tmp=`mktemp`; \
 138         h=`awk -F: '!$$0 {f = 1} $$0 && f {print $$1}' $O/$*.d`; \
 139         grep -h '^#include <' $< $$h | sort -u > "$$tmp"; \
 140         if diff -q -w "$O/$*.$1.h" "$$tmp" > /dev/null 2>&1; \
 141         then \
 142                 rm "$$tmp"; \
 143         else \
 144                 mv "$$tmp" "$O/$*.$1.h"; \
 145                 $(call vexec,$(COMPILE.$1) -o "$O/$*.$1.h.gch" "$O/$*.$1.h",\
 146                                 $O/$*.$1.h.gch); \
 147         fi \
 148 else \
 149         touch "$O/$*.$1.h"; \
 150 fi \
 151 )
 152 $(call exec,$(COMPILE.$1) -o $@ -MMD -MP $(if $(GCH),-include $O/$*.$1.h) $<)
 153 endef
 154
 155 # Link object files to build an executable. The objects files are taken from
 156 # the prerequisite files ($O/%.o). If in the prerequisite files are shared
 157 # objects ($L/lib%.so), they are included as libraries to link to (-l%). This
 158 # function is designed to be used as a command in a rule. The output name is
 159 # taken from the rule automatic variables. If an argument is provided, it's
 160 # included in the link command line. The variable LINKER is used to link the
 161 # executable; for example, if you want to link a C++ executable, you should use
 162 # LINKER := $(CXX).
 163 link = $(call exec,$(LINKER) $(LDFLAGS) $(TARGET_ARCH) -o $@ $1 \
 164                 $(patsubst $L/lib%.so,-l%,$(filter %.so,$^)) \
 165                 $(foreach obj,$(filter %.o,$^),$(obj)))
 166
 167 # Install a file. All arguments are optional.  The first argument is the file
 168 # mode (defaults to 0644).  The second argument are extra flags to the install
 169 # command (defaults to -D).  The third argument is the source file to install
 170 # (defaults to $<) and the last one is the destination (defaults to $@).
 171 install_file = $(call exec,install -m $(if $1,$1,0644) $(if $2,$2,-D) \
 172                 $(if $3,$3,$<) $(if $4,$4,$@))
 173
 174 # Concatenate variables together.  The first argument is a list of variables
 175 # names to concatenate.  The second argument is an optional prefix for the
 176 # variables and the third is the string to use as separator (" ~" if omitted).
 177 # For example:
 178 # X_A := a
 179 # X_B := b
 180 # $(call varcat,A B,X_, --)
 181 # Will produce something like "a -- b --"
 182 varcat = $(foreach v,$1,$($2$v)$(if $3,$3, ~))
 183
 184 # Replace variables with specified values in a template file.  The first
 185 # argument is a list of make variables names which will be replaced in the
 186 # target file.  The strings @VARNAME@ in the template file will be replaced
 187 # with the value of the make $(VARNAME) variable and the result will be stored
 188 # in the target file.  The second (optional) argument is a prefix to add to the
 189 # make variables names, so if the prefix is PREFIX_ and @VARNAME@ is found in
 190 # the template file, it will be replaced by the value of the make variable
 191 # $(PREFIX_VARNAME).  The third and fourth arguments are the source file and
 192 # the destination file (both optional, $< and $@ are used if omitted). The
 193 # fifth (optional) argument are options to pass to the substitute sed command
 194 # (for example, use "g" if you want to do multiple substitutions per line).
 195 replace = $(call exec,sed '$(foreach v,$1,s|@$v@|$($2$v)|$5;)' $(if $3,$3,$<) \
 196                 > $(if $4,$4,$@))
 197
 198 # Create a symbolic link to the project under the $(INCLUDE_DIR). The first
 199 # argument is the name of symbolic link to create.  The link is only created if
 200 # it doesn't already exist.
 201 symlink_include_dir = $(shell \
 202                 test -L $(INCLUDE_DIR)/$1 \
 203                         || ln -s $C $(INCLUDE_DIR)/$1 )
 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 (optional).  This should be used as a rule action or something
 209 # where a shell script is expected.
 210 gen_rebuild_flags = $(shell if test x"$2" != x"`cat $1 2>/dev/null`"; then \
 211                 $(if $3,test -f $1 && echo "$3";) \
 212                 echo "$2" > $1 ; fi)
 213
 214
 215 # Overridden flags
 216 ##################
 217
 218 # Warn about everything
 219 override CPPFLAGS += -Wall
 220
 221 # Use the includes directories to search for includes
 222 override CPPFLAGS += -I$(INCLUDE_DIR)
 223
 224 # Let the program know where it will be installed
 225 override CPPFLAGS += -DPREFIX=$(prefix)
 226
 227 # Be standard compliant
 228 override CFLAGS += -std=c99 -pedantic
 229 override CXXFLAGS += -std=c++98 -pedantic
 230
 231 # Use the generated library directory to for libraries
 232 override LDFLAGS += -L$L -Wall
 233
 234 # Make sure the generated libraries can be found
 235 export LD_LIBRARY_PATH := $L:$(LD_LIBRARY_PATH)
 236
 237
 238 # Variant flags
 239 ################
 240
 241 ifeq ($F,dbg)
 242 override CPPFLAGS += -ggdb -DDEBUG
 243 endif
 244
 245 ifeq ($F,opt)
 246 override CPPFLAGS += -O2 -DNDEBUG
 247 endif
 248
 249 ifeq ($F,cov)
 250 override CPPFLAGS += -ggdb -pg --coverage
 251 override LDFLAGS += -pg --coverage
 252 endif
 253
 254
 255 # Automatic dependency handling
 256 ################################
 257
 258 # These files are created during compilation.
 259 sinclude $(shell test -d $O && find $O -name '*.d')
 260
 261
 262 # Default rules
 263 ################
 264
 265 # Compile C objects
 266 $O/%.o: $T/%.c $G/compile-c-flags
 267         $(call compile,c)
 268
 269 # Compile C++ objects
 270 $O/%.o: $T/%.cpp $G/compile-cpp-flags
 271         $(call compile,cpp)
 272
 273 # Link binary programs
 274 $B/%: $G/link-o-flags
 275         $(call link)
 276
 277 # Link shared libraries
 278 $L/%.so: override CFLAGS += -fPIC
 279 $L/%.so: override CXXFLAGS += -fPIC
 280 $L/%.so: $G/link-o-flags
 281         $(call link,-shared)
 282
 283 # Create pkg-config files using a template
 284 $L/%.pc:
 285         $(call replace,$(PC_VARS),$*-PC-)
 286
 287 # Run doxygen to build the documentation.  It expects the first prerequisite to
 288 # be the Doxyfile to use and the next prerequisites the input files.  This rule
 289 # is a little restrictive, but you can always make your own if it doesn't fit
 290 # your needs ;)
 291 $D/%/doxygen-stamp:
 292         $V mkdir -p $(@D)
 293         $(call exec,(cat $<; \
 294                 echo "FULL_PATH_NAMES=YES"; \
 295                 echo "INPUT=$(patsubst $(<D)/%,$(INCLUDE_DIR)/$*/%, \
 296                                 $(wordlist 2,$(words $^),$^))"; \
 297                 echo "OUTPUT_DIRECTORY=$(@D)"; \
 298                 echo "INCLUDE_PATH=$(INCLUDE_DIR)"; \
 299                 echo "STRIP_FROM_PATH=$(INCLUDE_DIR)"; \
 300                 echo "STRIP_FROM_INC_PATH=$(INCLUDE_DIR)"; \
 301                 echo "QUIET=$(if $V,YES,NO)") | doxygen -,$(@D),doxygen)
 302         $V touch $@
 303
 304 # Install binary programs
 305 $I/bin/%:
 306         $(call install_file,0755)
 307
 308 # Install system binary programs
 309 $I/sbin/%:
 310         $(call install_file,0755)
 311
 312 # Install pkg-config specification files
 313 $I/lib/pkgconfig/%:
 314         $(call install_file)
 315
 316 # Install libraries
 317 $I/lib/%:
 318         $(call install_file)
 319
 320 .PHONY: clean
 321 clean:
 322         $(call exec,$(RM) -r $(VD),$(VD))
 323
 324 # Phony rule to uninstall all built targets (like "install", uses $(install)).
 325 .PHONY: uninstall
 326 uninstall:
 327         $V$(foreach i,$(install),$(call vexec,$(RM) $i,$i);)
 328
 329 # These rules use the "Secondary Expansion" GNU Make feature, to allow
 330 # sub-makes to add values to the special variables $(all), after this makefile
 331 # was read.
 332 .SECONDEXPANSION:
 333
 334 # Phony rule to make all the targets (sub-makefiles can append targets to build
 335 # to the $(all) variable).
 336 .PHONY: all
 337 all: $$(all)
 338
 339 # Phony rule to install all built targets (sub-makefiles can append targets to
 340 # build to the $(install) variable).
 341 .PHONY: install
 342 install: $$(install)
 343
 344 # Phony rule to build all documentation targets (sub-makefiles can append
 345 # documentation to build to the $(doc) variable).
 346 .PHONY: doc
 347 doc: $$(doc)
 348
 349
 350 # Create build directory structure
 351 ###################################
 352
 353 # Create $O, $B, $L, $D and $(INCLUDE_DIR) directories and replicate the
 354 # directory structure of the project into $O. Create one symbolic link "last"
 355 # to the current build directory.
 356 #
 357 # NOTE: the second mkdir can yield no arguments if the project don't have any
 358 #       subdirectories, that's why the current directory "." is included, so it
 359 #       won't show an error message in case of no subdirectories.
 360 setup_build_dir__ := $(shell \
 361         mkdir -p $O $B $L $D $(INCLUDE_DIR); \
 362         mkdir -p . $(addprefix $O,$(patsubst $T%,%,\
 363                         $(shell find $T -type d -not -path '$(VD)*'))); \
 364         test -L $(VD)/last || ln -s $F $(VD)/last )
 365
 366
 367 # Automatic rebuilding when flags or commands changes
 368 ######################################################
 369
 370 # Re-compile C files if one of this variables changes
 371 COMPILE.c.FLAGS := $(call varcat,CC CPPFLAGS CFLAGS TARGET_ARCH prefix)
 372
 373 # Re-compile C++ files if one of this variables changes
 374 COMPILE.cpp.FLAGS := $(call varcat,CXX CPPFLAGS CXXFLAGS TARGET_ARCH prefix)
 375
 376 # Re-link binaries and libraries if one of this variables changes
 377 LINK.o.FLAGS := $(call varcat,LD LDFLAGS TARGET_ARCH)
 378
 379 # Create files containing the current flags to trigger a rebuild if they change
 380 setup_flag_files__ := $(call gen_rebuild_flags,$G/compile-c-flags, \
 381         $(COMPILE.c.FLAGS),C compiler or flags; )
 382 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \
 383         $G/compile-cpp-flags, $(COMPILE.cpp.FLAGS),C++ compiler or flags; )
 384 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \
 385         $G/link-o-flags, $(LINK.o.FLAGS),linker or link flags; )
 386
 387 # Print any generated message (if verbose)
 388 $(if $V,$(if $(setup_flag_files__), \
 389         $(info !! Something changed: $(setup_flag_files__)re-building \
 390                         affected files...)))
 391
 392 endif