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