X-Git-Url: https://git.llucax.com/software/makeit.git/blobdiff_plain/2825d7cb9f58a30d0280ff3bea5dfe4c6faa6ddf..6f045d91850bab9b78c3283f1b2e230fd18751b4:/Lib.mak diff --git a/Lib.mak b/Lib.mak index 6a6c9f9..6893b46 100644 --- a/Lib.mak +++ b/Lib.mak @@ -1,7 +1,7 @@ ifndef Lib.mak.included Lib.mak.included := 1 -# These variables should be provided by the includer Makefile: +# These variables should be provided by the Makefile that include us: # P should be the project name, mostly used to handle include directories # T should be the path to the top-level directory. # S should be sub-directory where the current makefile is, relative to $T. @@ -23,17 +23,28 @@ LINKER := $(CXX) # Default mode used to install files IMODE ?= 0644 -# Degault install flags +# Default install flags IFLAGS ?= -D -# Use precompiled headers if non-empty +# Use pre-compiled headers if non-empty GCH ?= +# If non-empty, use valgrind to run commands via the "valgrind" function +VALGRIND ?= + +# Options to pass to valgrind; if the variable $(VALGRIND_SUPP) is non-empty +# it will be used as a suppressions file. +VALGRIND_CMD ?= valgrind --tool=memcheck --leak-check=yes --db-attach=no \ + --num-callers=24 --leak-resolution=high --track-fds=yes \ + --error-exitcode=1 \ + $(if $V,--log-file=$<.valgrind.log) \ + $(if $(VALGRIND_SUPP),--suppressions=$(VALGRIND_SUPP)) + # Directories ############## -# Base directory where to install files (can be overrided, should be absolute) +# Base directory where to install files (can be overridden, should be absolute) prefix ?= /usr/local # Path to a complete alternative environment, usually a jail, or an installed @@ -47,13 +58,13 @@ T := $(abspath $T) # Name of the current directory, relative to $T R := $(subst $T,,$(patsubst $T/%,%,$(CURDIR))) -# Base directory where to put variants -D ?= $T/build +# Base directory where to put variants (Variants Directory) +VD ?= $T/build # Generated files top directory -G ?= $D/$F +G ?= $(VD)/$F -# Objects (and other garbage like precompiled headers and dependency files) +# Objects (and other garbage like pre-compiled headers and dependency files) # directory O ?= $G/obj @@ -63,6 +74,9 @@ B ?= $G/bin # Libraries directory L ?= $G/lib +# Documentation directory +D ?= $(VD)/doc + # Installation directory I := $(DESTDIR)$(prefix) @@ -82,24 +96,33 @@ C = $T/$S # returns empty. eq = $(if $(subst $1,,$2),,$1) -# Find sources files and get the corresponding object names -# The first argument should be the sources extension ("c" or "cpp" typically) -# It expects the variable $T and $O to be defined as commented previously in -# this file. -find_objects = $(patsubst $T/%.$1,$O/%.o,$(shell find $C -name '*.$1')) - -# Find sources files and get the corresponding object names -# The first argument should be the sources extension ("c" or "cpp" typically) -# It expects the variable $T and $O to be defined as commented previously in -# this file. -find_headers = $(patsubst $C/%.$1,$2/%.$1,$(shell find $C -name '*.$1')) +# Find sources files and get the corresponding object names. The first +# argument should be the sources extension ("c" or "cpp" typically). The +# second argument is where to search for the sources ($C if omitted). The +# resulting files will always have the suffix "o" and the directory rewritten +# to match the directory structure (from $T) but in the $O directory. For +# example, if $T is "/usr/src", $O is "/tmp/obj", $C is "/usr/src/curr" and it +# have 2 C sources: "/usr/src/curr/1.c" and "/usr/src/curr/dir/2.c", the call: +# $(call find_objects,c) +# Will yield "/tmp/obj/curr/1.o" and "/tmp/obj/curr/dir/2.o". +find_objects = $(patsubst $T/%.$1,$O/%.o,$(shell \ + find $(if $2,$2,$C) -name '*.$1')) + +# Find files and get the their file names relative to another directory. The +# first argument should be the files suffix (".h" or ".cpp" for example). The +# second argument is a directory rewrite, the matched files will be rewriten to +# be in the directory specified in this argument (it defaults to the third +# argument if omitted). The third argument is where to search for the files +# ($C if omitted). +find_files = $(patsubst $(if $3,$3,$C)/%$1,$(if $2,$2,$(if $3,$3,$C))/%$1, \ + $(shell find $(if $3,$3,$C) -name '*$1')) # Abbreviate a file name. Cut the leading part of a file if it match to the $T # directory, so it can be displayed as if it were a relative directory. Take # just one argument, the file name. abbr_helper = $(subst $T,.,$(patsubst $T/%,%,$1)) -abbr = $(if $(call eq,$(call abbr_helper,$1),$1),$1, \ - $(addprefix $(shell echo $R | sed 's|/\?\([^/]\+\)/\?|../|g'),\ +abbr = $(if $(call eq,$(call abbr_helper,$1),$1),$1,$(addprefix \ + $(shell echo $R | sed 's|/\?\([^/]\+\)/\?|../|g'),\ $(call abbr_helper,$1))) # Execute a command printing a nice message if $V is @. @@ -107,7 +130,7 @@ abbr = $(if $(call eq,$(call abbr_helper,$1),$1),$1, \ # and third arguments are optional and are the target name and command name to # pretty print. vexec = $(if $V,\ - echo ' $(notdir $(if $3,$(strip $3),$(firstword $1))) \ + echo ' $(call abbr,$(if $3,$(strip $3),$(firstword $1))) \ $(call abbr,$(if $2,$(strip $2),$@))' ; )$1 # Same as vexec but it silence the echo command (prepending a @ if $V). @@ -143,7 +166,7 @@ endef # Link object files to build an executable. The objects files are taken from # the prerequisite files ($O/%.o). If in the prerequisite files are shared # objects ($L/lib%.so), they are included as libraries to link to (-l%). This -# function is designed to be used as a command in a rule. The ouput name is +# function is designed to be used as a command in a rule. The output name is # taken from the rule automatic variables. If an argument is provided, it's # included in the link command line. The variable LINKER is used to link the # executable; for example, if you want to link a C++ executable, you should use @@ -184,8 +207,8 @@ replace = $(call exec,sed '$(foreach v,$1,s|@$v@|$($2$v)|$5;)' $(if $3,$3,$<) \ > $(if $4,$4,$@)) # Create a symbolic link to the project under the $(INCLUDE_DIR). The first -# argument is the name of symlink to create. The link is only created if it -# doesn't already exist. +# argument is the name of symbolic link to create. The link is only created if +# it doesn't already exist. symlink_include_dir = $(shell \ test -L $(INCLUDE_DIR)/$1 \ || ln -s $C $(INCLUDE_DIR)/$1 ) @@ -199,8 +222,29 @@ gen_rebuild_flags = $(shell if test x"$2" != x"`cat $1 2>/dev/null`"; then \ $(if $3,test -f $1 && echo "$3";) \ echo "$2" > $1 ; fi) +# Include sub-directory's Build.mak. The only argument is a list of +# subdirectories for which Build.mak should be included. The $S directory is +# set properly before including each sub-directory's Build.mak and restored +# afterwards. +define build_subdir_code +_parent__$d__dir_ := $$S +S := $$(if $$(_parent__$d__dir_),$$(_parent__$d__dir_)/$d,$d) +include $$T/$$S/Build.mak +S := $$(_parent__$d__dir_) +endef +include_subdirs = $(foreach d,$1,$(eval $(build_subdir_code))) + +# Run a command through valgrind if $(VALGRIND) is non-empty. The first and +# only argument is the command to. If $(VALGRIND) is empty, the command is +# executed as passed to this function. If valgrind is used, the +# $(VALGRIND_CMD) is prepended to the command to run. See VALGRIND_CMD +# definition for extra options that can be passed as make variables. +valgrind = $(call exec,$(if $(VALGRIND),$(VALGRIND_CMD)) $1,\ + $(if $(VALGRIND),[$(firstword $(VALGRIND_CMD))], ),\ + $(firstword $1)) -# Overrided flags + +# Overridden flags ################## # Warn about everything @@ -212,7 +256,7 @@ override CPPFLAGS += -I$(INCLUDE_DIR) # Let the program know where it will be installed override CPPFLAGS += -DPREFIX=$(prefix) -# Be standard compilant +# Be standard compliant override CFLAGS += -std=c99 -pedantic override CXXFLAGS += -std=c++98 -pedantic @@ -272,6 +316,23 @@ $L/%.so: $G/link-o-flags $L/%.pc: $(call replace,$(PC_VARS),$*-PC-) +# Run doxygen to build the documentation. It expects the first prerequisite to +# be the Doxyfile to use and the next prerequisites the input files. This rule +# is a little restrictive, but you can always make your own if it doesn't fit +# your needs ;) +$D/%/doxygen-stamp: + $V mkdir -p $(@D) + $(call exec,(cat $<; \ + echo "FULL_PATH_NAMES=YES"; \ + echo "INPUT=$(patsubst $(