Make call to include_subdirs easier to read

[software/makeit.git] / Makeit.mak

diff --git a/Makeit.mak b/Makeit.mak
index a4b6dfbfb5f8dd1bcf4005902055b03b652fb653..8964fe2dce5921fab107c232e15a96432a2d9ea2 100644 (file)
--- a/Makeit.mak
+++ b/Makeit.mak
@@ -30,8 +30,16 @@ COLOR_CMD ?= 00;33
 # See COLOR_CMD comment for details.
 COLOR_ARG ?=
 
 # See COLOR_CMD comment for details.
 COLOR_ARG ?=
 

-# Flavor (variant), should be one of "dbg", "opt" or "cov"
-F ?= opt
+# ANSI color used for the warnings if $(COLOR) is non-empty
+# See COLOR_CMD comment for details.
+COLOR_WARN ?= 00;36
+
+# ANSI color used for commands output if $(COLOR) is non-empty
+# See COLOR_CMD comment for details.
+COLOR_OUT ?= 00;31
+
+# Flavor (variant), can be defined by the user in Config.mak
+F ?= default

 
 # Use C++ linker by default
 LINKER := $(CXX)
 
 # Use C++ linker by default
 LINKER := $(CXX)


@@ -66,6 +74,12 @@ SPHINX_FORMAT ?= html
 # Paper size for Sphinx LaTeX output (a4, letter, etc.)
 SPHINX_PAPERSIZE ?= a4
 
 # Paper size for Sphinx LaTeX output (a4, letter, etc.)
 SPHINX_PAPERSIZE ?= a4
 

+# Name of the build directory (to use when excluding some paths)
+BUILD_DIR_NAME ?= build
+
+# Directories to exclude from the build directory tree replication
+BUILD_DIR_EXCLUDE ?= $(BUILD_DIR_NAME) .git .hg .bzr _darcs .svn CVS
+

 
 # Directories
 ##############
 
 # Directories
 ##############


@@ -85,7 +99,7 @@ T := $(abspath $T)
 R := $(subst $T,,$(patsubst $T/%,%,$(CURDIR)))
 
 # Base directory where to put variants (Variants Directory)
 R := $(subst $T,,$(patsubst $T/%,%,$(CURDIR)))
 
 # Base directory where to put variants (Variants Directory)

-VD ?= $T/build
+VD ?= $T/$(BUILD_DIR_NAME)

 
 # Generated files top directory
 G ?= $(VD)/$F
 
 # Generated files top directory
 G ?= $(VD)/$F


@@ -157,23 +171,33 @@ abbr = $(if $(call eq,$(call abbr_helper,$1),$1),$1,$(addprefix \
 # pretty print.
 vexec_pc = $(if $1,\033[$1m%s\033[00m,%s)
 vexec_p = $(if $(COLOR), \
 # pretty print.
 vexec_pc = $(if $1,\033[$1m%s\033[00m,%s)
 vexec_p = $(if $(COLOR), \

-       '   $(call vexec_pc,$(COLOR_CMD)) $(call vexec_pc,$(COLOR_ARG))\n', \
+       '   $(call vexec_pc,$(COLOR_CMD)) $(call vexec_pc,$(COLOR_ARG))\n$(if \
+                       $(COLOR_OUT),\033[$(COLOR_OUT)m)', \

        '   %s %s\n')
 vexec = $(if $V,printf $(vexec_p) \
                '$(call abbr,$(if $3,$(strip $3),$(firstword $1)))' \
        '   %s %s\n')
 vexec = $(if $V,printf $(vexec_p) \
                '$(call abbr,$(if $3,$(strip $3),$(firstword $1)))' \

-               '$(call abbr,$(if $2,$(strip $2),$@))' ; )$1
+               '$(call abbr,$(if $2,$(strip $2),$@))' ; )$1 \
+               $(if $V,$(if $(COLOR),$(if $(COLOR_OUT), \
+                               ; r=$$? ; printf '\033[00m' ; exit $$r)))

 
 # Same as vexec but it silence the echo command (prepending a @ if $V).
 exec = $V$(call vexec,$1,$2,$3)
 
 
 # Same as vexec but it silence the echo command (prepending a @ if $V).
 exec = $V$(call vexec,$1,$2,$3)
 

-# Compile a source file to an object, generating pre-compiled headers and
-# dependencies. The pre-compiled headers are generated only if the system
-# includes change. This function is designed to be used as a command in a rule.
-# The first argument is the type of file to compile (typically "c" or "cpp").
-# What to compile and the output files are built using the automatic variables
-# from a rule.  The second argument is the base output directory (typically
-# $O).  You can add non-propagated object-specific flags defining a variable
-# with the name of the target followed with ".EXTRA_FLAGS".
+# Compile a source file to an object, generating pre-compiled headers (if
+# $(GCH) is non-empty) and dependencies. The pre-compiled headers are generated
+# only if the system includes change. This function is designed to be used as
+# a command in a rule.  The first argument is the type of file to compile
+# (typically "c" or "cpp").  What to compile and the output files are built
+# using the automatic variables from a rule.  The second argument is the base
+# output directory (typically $O).  You can add non-propagated object-specific
+# flags defining a variable with the name of the target followed with
+# ".EXTRA_FLAGS".
+#
+# XXX: The pre-compiled headers generation is not very useful if you include
+#      local files using #include <...>, because the system headers detection
+#      is a little simplistic now, it just parse the source file and all its
+#      dependencies searching for lines starting with "#include <" and
+#      extracting the included files from them.

 define compile
 $(if $(GCH),\
 $Vif test -f $2/$*.d; then \
 define compile
 $(if $(GCH),\
 $Vif test -f $2/$*.d; then \


@@ -256,7 +280,8 @@ symlink_include_dir = $(shell \
 # have changed (optional).  This should be used as a rule action or something
 # where a shell script is expected.
 gen_rebuild_flags = $(shell if test x"$2" != x"`cat $1 2>/dev/null`"; then \
 # have changed (optional).  This should be used as a rule action or something
 # where a shell script is expected.
 gen_rebuild_flags = $(shell if test x"$2" != x"`cat $1 2>/dev/null`"; then \

-               $(if $3,test -f $1 && echo "$3";) \
+               $(if $3,test -f $1 && echo "$(if $(COLOR),$(if $(COLOR_WARN),\
+                       \033[$(COLOR_WARN)m$3\033[00m,$3),$3);";) \

                echo "$2" > $1 ; fi)
 
 # Include sub-directory's Build.mak.  The only argument is a list of
                echo "$2" > $1 ; fi)
 
 # Include sub-directory's Build.mak.  The only argument is a list of


@@ -286,43 +311,19 @@ valgrind = $(call exec,$(if $(VALGRIND),$(VALGRIND_CMD)) $1,\
 # Overridden flags
 ##################
 
 # Overridden flags
 ##################
 

-# Warn about everything
-override CPPFLAGS += -Wall
-

 # Use the includes directories to search for includes
 override CPPFLAGS += -I$(INCLUDE_DIR)
 
 # Let the program know where it will be installed
 override CPPFLAGS += -DPREFIX=$(prefix)
 
 # Use the includes directories to search for includes
 override CPPFLAGS += -I$(INCLUDE_DIR)
 
 # Let the program know where it will be installed
 override CPPFLAGS += -DPREFIX=$(prefix)
 

-# Be standard compliant
-override CFLAGS += -std=c99 -pedantic
-override CXXFLAGS += -std=c++98 -pedantic
-

 # Use the generated library directory to for libraries
 # Use the generated library directory to for libraries

-override LDFLAGS += -L$L -Wall
+override LDFLAGS += -L$L

 
 # Make sure the generated libraries can be found
 export LD_LIBRARY_PATH := $L:$(LD_LIBRARY_PATH)
 
 
 
 # Make sure the generated libraries can be found
 export LD_LIBRARY_PATH := $L:$(LD_LIBRARY_PATH)
 
 

-# Variant flags
-################
-
-ifeq ($F,dbg)
-override CPPFLAGS += -ggdb -DDEBUG
-endif
-
-ifeq ($F,opt)
-override CPPFLAGS += -O2 -DNDEBUG
-endif
-
-ifeq ($F,cov)
-override CPPFLAGS += -ggdb -pg --coverage
-override LDFLAGS += -pg --coverage
-endif
-
-

 # Automatic dependency handling
 ################################
 
 # Automatic dependency handling
 ################################
 


@@ -356,20 +357,33 @@ $L/%.pc:
        $(call replace,$(PC_VARS),$*-PC-)
 
 # Run doxygen to build the documentation.  It expects the first prerequisite to
        $(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 ;)
+# be the Doxyfile to use and the next prerequisites the input files.  You
+# can override Doxyfile configuration variables by defining a DOXYGEN_VARS
+# Make variable for this rule.  For example, defining:
+# PROJECT_NAME := myproj
+# DOXYGEN_VARS := PROJECT_NAME
+# You can override Doxygen's PROJECT_NAME configuration option. Optionally, you
+# can define DOXYGEN_VARS_PREFIX too, to avoid polluting your Makefile with
+# Doxygen variables.  For example:
+# DOXY.PROJECT_NAME := myproj
+# DOXYGEN_VARS_PREFIX := DOXY.
+# DOXYGEN_VARS := PROJECT_NAME
+# This rule might be still 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"; \
 $D/%/doxygen-stamp:
        $V mkdir -p $(@D)
        $(call exec,(cat $<; \
                echo "FULL_PATH_NAMES=YES"; \

-               echo "INPUT=$(patsubst $(<D)/%,$(INCLUDE_DIR)/$*/%, \
-                               $(wordlist 2,$(words $^),$^))"; \
+               $(if $(filter INPUT,$(DOXYGEN_VARS)),,\
+                       echo "INPUT=$(patsubst $(<D)/%,$(INCLUDE_DIR)/$*/%, \
+                                       $(wordlist 2,$(words $^),$^))";) \

                echo "OUTPUT_DIRECTORY=$(@D)"; \
                echo "OUTPUT_DIRECTORY=$(@D)"; \

-               echo "INCLUDE_PATH=$(INCLUDE_DIR)"; \

                echo "STRIP_FROM_PATH=$(INCLUDE_DIR)"; \
                echo "STRIP_FROM_INC_PATH=$(INCLUDE_DIR)"; \
                echo "STRIP_FROM_PATH=$(INCLUDE_DIR)"; \
                echo "STRIP_FROM_INC_PATH=$(INCLUDE_DIR)"; \

-               echo "QUIET=$(if $V,YES,NO)") | doxygen -,$(@D),doxygen)
+               echo "QUIET=$(if $V,YES,NO)"; \
+               $(foreach v,$(DOXYGEN_VARS),\
+                               echo '$v=$($(DOXYGEN_VARS_PREFIX)$v)';) \
+               ) | doxygen -,$(@D),doxygen)

        $V touch $@
 
 # Run Sphinx to build the documentation.  It expects the variable SPHINX_DIR
        $V touch $@
 
 # Run Sphinx to build the documentation.  It expects the variable SPHINX_DIR


@@ -440,15 +454,12 @@ test: $$(test)
 # Create $O, $B, $L, $D and $(INCLUDE_DIR) directories and replicate the
 # directory structure of the project into $O. Create one symbolic link "last"
 # to the current build directory.
 # Create $O, $B, $L, $D and $(INCLUDE_DIR) directories and replicate the
 # directory structure of the project into $O. Create one symbolic link "last"
 # to the current build directory.

-#
-# NOTE: the second mkdir can yield no arguments if the project don't have any
-#       subdirectories, that's why the current directory "." is included, so it
-#       won't show an error message in case of no subdirectories.

 setup_build_dir__ := $(shell \
 setup_build_dir__ := $(shell \

-       mkdir -p $O $B $L $D $(INCLUDE_DIR); \
-       mkdir -p . $(addprefix $O,$(patsubst $T%,%,\
-                       $(shell find $T -type d -not -path '$(VD)*'))); \
-       test -L $(VD)/last || ln -s $F $(VD)/last )
+       mkdir -p $O $B $L $D $(INCLUDE_DIR) $(addprefix $O,$(patsubst $T%,%,\
+               $(shell find $T -type d $(foreach d,$(BUILD_DIR_EXCLUDE), \
+                       -not -path '$T/$d' -not -path '$T/$d/*' \
+                       -not -path '$T/*/$d' -not -path '$T/*/$d/*')))); \
+       rm -f $(VD)/last && ln -s $F $(VD)/last )

 
 
 # Automatic rebuilding when flags or commands changes
 
 
 # Automatic rebuilding when flags or commands changes


@@ -468,17 +479,17 @@ SPHINX.FLAGS := $(call varcat,SPHINX SPHINX_FORMAT SPHINX_PAPERSIZE)
 
 # Create files containing the current flags to trigger a rebuild if they change
 setup_flag_files__ := $(call gen_rebuild_flags,$G/compile-c-flags, \
 
 # Create files containing the current flags to trigger a rebuild if they change
 setup_flag_files__ := $(call gen_rebuild_flags,$G/compile-c-flags, \

-       $(COMPILE.c.FLAGS),C compiler or flags; )
+       $(COMPILE.c.FLAGS),C compiler)

 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \
 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \

-       $G/compile-cpp-flags, $(COMPILE.cpp.FLAGS),C++ compiler or flags; )
+       $G/compile-cpp-flags, $(COMPILE.cpp.FLAGS),C++ compiler)

 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \
 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \

-       $G/link-o-flags, $(LINK.o.FLAGS),linker or link flags; )
+       $G/link-o-flags, $(LINK.o.FLAGS),linker)

 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \
 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \

-       $G/sphinx-flags, $(SPHINX.FLAGS),sphinx command or flags; )
+       $G/sphinx-flags, $(SPHINX.FLAGS),sphinx)

 
 # Print any generated message (if verbose)
 $(if $V,$(if $(setup_flag_files__), \
 
 # Print any generated message (if verbose)
 $(if $V,$(if $(setup_flag_files__), \

-       $(info !! Something changed: $(setup_flag_files__)re-building \
+       $(info !! Flags or commands changed:$(setup_flag_files__) re-building \

                        affected files...)))
 
 endif
                        affected files...)))
 
 endif