Comment default rules

[software/makeit.git] / Lib.mak

diff --git a/Lib.mak b/Lib.mak
index ce5449914729d8b53a51f7e9cc0a005a5cd4095a..a2ec0dfb52cf9f8f9b8609869f0715fc35cec4e1 100644 (file)
--- a/Lib.mak
+++ b/Lib.mak
@@ -1,11 +1,10 @@
-

 ifndef Lib.mak.included
 Lib.mak.included := 1
 
 # These variables should be provided by the includer Makefile:
 # P should be the project name, mostly used to handle include directories
 # T should be the path to the top-level directory.
 ifndef Lib.mak.included
 Lib.mak.included := 1
 
 # These variables should be provided by the includer Makefile:
 # P should be the project name, mostly used to handle include directories
 # T should be the path to the top-level directory.

-# C should be the path to the current directory.
+# S should be sub-directory where the current makefile is, relative to $T.

 
 # Verbosity flag (empty show nice messages, non-empty use make messages)
 # When used internal, $V expand to @ is nice messages should be printed, this
 
 # Verbosity flag (empty show nice messages, non-empty use make messages)
 # When used internal, $V expand to @ is nice messages should be printed, this


@@ -21,6 +20,12 @@ F ?= opt
 # Use C++ linker by default
 LINKER := $(CXX)
 
 # Use C++ linker by default
 LINKER := $(CXX)
 

+# Default mode used to install files
+IMODE ?= 0644
+
+# Degault install flags
+IFLAGS ?= -D
+

 # Use precompiled headers if non-empty
 GCH ?=
 
 # Use precompiled headers if non-empty
 GCH ?=
 


@@ -28,6 +33,13 @@ GCH ?=
 # Directories
 ##############
 
 # Directories
 ##############
 

+# Base directory where to install files (can be overrided, should be absolute)
+prefix ?= /usr/local
+
+# Path to a complete alternative environment, usually a jail, or an installed
+# system mounted elsewhere than /.
+DESTDIR ?=
+

 # Use absolute paths to avoid problems with automatic dependencies when
 # building from subdirectories
 T := $(abspath $T)
 # Use absolute paths to avoid problems with automatic dependencies when
 # building from subdirectories
 T := $(abspath $T)


@@ -51,28 +63,44 @@ B ?= $G/bin
 # Libraries directory
 L ?= $G/lib
 
 # Libraries directory
 L ?= $G/lib
 

+# Installation directory
+I := $(DESTDIR)$(prefix)
+

 # Includes directory
 # Includes directory

-I ?= $G/include
+INCLUDE_DIR ?= $G/include

 
 

-# Generated includes directory
-J ?= $G/geninc
+# Directory of the current makefile (this might not be the same as $(CURDIR)
+# This variable is "lazy" because $S changes all the time, so it should be
+# evaluated in the context where $C is used, not here.
+C = $T/$S

 
 
 # Functions
 ############
 
 
 
 # Functions
 ############
 

+# Compare two strings, if they are the same, returns the string, if not,
+# 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
 # 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. $C should be defined to the path to the current directory relative
-# to the top-level.
-find_objects = $(patsubst $T/%.$1,$O/%.o,$(shell find $T/$C -name '*.$1'))
+# 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'))

 
 # 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.
 
 # 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 = $(addprefix $(shell echo $R | sed 's|/\?\([^/]\+\)/\?|../|g'),\
-               $(subst $T,.,$(patsubst $T/%,%,$1)))
+abbr_helper = $(subst $T,.,$(patsubst $T/%,%,$1))
+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 @.
 # The first argument is mandatory and it's the command to execute. The second
 
 # Execute a command printing a nice message if $V is @.
 # The first argument is mandatory and it's the command to execute. The second


@@ -96,17 +124,17 @@ $(if $(GCH),\
 $Vif test -f $O/$*.d; then \
        tmp=`mktemp`; \
        h=`awk -F: '!$$0 {f = 1} $$0 && f {print $$1}' $O/$*.d`; \
 $Vif test -f $O/$*.d; then \
        tmp=`mktemp`; \
        h=`awk -F: '!$$0 {f = 1} $$0 && f {print $$1}' $O/$*.d`; \

-       grep -h '^#include <' $(call abbr,$<) $$h | sort -u > "$$tmp"; \
-       if diff -q -w "$(call abbr,$O/$*.$1.h)" "$$tmp" > /dev/null 2>&1; \
+       grep -h '^#include <' $< $$h | sort -u > "$$tmp"; \
+       if diff -q -w "$O/$*.$1.h" "$$tmp" > /dev/null 2>&1; \

        then \
                rm "$$tmp"; \
        else \
        then \
                rm "$$tmp"; \
        else \

-               mv "$$tmp" "$(call abbr,$O/$*.$1.h)"; \
+               mv "$$tmp" "$O/$*.$1.h"; \

                $(call vexec,$(COMPILE.$1) -o "$O/$*.$1.h.gch" "$O/$*.$1.h",\
                                $O/$*.$1.h.gch); \
        fi \
 else \
                $(call vexec,$(COMPILE.$1) -o "$O/$*.$1.h.gch" "$O/$*.$1.h",\
                                $O/$*.$1.h.gch); \
        fi \
 else \

-       touch "$(call abbr,$O/$*.$1.h)"; \
+       touch "$O/$*.$1.h"; \

 fi \
 )
 $(call exec,$(COMPILE.$1) -o $@ -MMD -MP $(if $(GCH),-include $O/$*.$1.h) $<)
 fi \
 )
 $(call exec,$(COMPILE.$1) -o $@ -MMD -MP $(if $(GCH),-include $O/$*.$1.h) $<)


@@ -124,6 +152,20 @@ link = $(call exec,$(LINKER) $(LDFLAGS) $(TARGET_ARCH) -o $@ $1 \
                $(patsubst $L/lib%.so,-l%,$(filter %.so,$^)) \
                $(foreach obj,$(filter %.o,$^),$(obj)))
 
                $(patsubst $L/lib%.so,-l%,$(filter %.so,$^)) \
                $(foreach obj,$(filter %.o,$^),$(obj)))
 

+# Install a file. All arguments are optional.  The first argument is the file
+# mode (defaults to 0644).  The second argument are extra flags to the install
+# command (defaults to -D).  The third argument is the source file to install
+# (defaults to $<) and the last one is the destination (defaults to $@).
+install_file = $(call exec,install -m $(if $1,$1,0644) $(if $2,$2,-D) \
+               $(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.
+symlink_include_dir = $(shell \
+               test -L $(INCLUDE_DIR)/$1 \
+                       || ln -s $C $(INCLUDE_DIR)/$1 )
+

 
 # Overrided flags
 ##################
 
 # Overrided flags
 ##################


@@ -132,7 +174,10 @@ link = $(call exec,$(LINKER) $(LDFLAGS) $(TARGET_ARCH) -o $@ $1 \
 override CPPFLAGS += -Wall
 
 # Use the includes directories to search for includes
 override CPPFLAGS += -Wall
 
 # Use the includes directories to search for includes

-override CPPFLAGS += -I$I -I$J
+override CPPFLAGS += -I$(INCLUDE_DIR)
+
+# Let the program know where it will be installed
+override CPPFLAGS += -DPREFIX=$(prefix)

 
 # Be standard compilant
 override CFLAGS += -std=c99 -pedantic
 
 # Be standard compilant
 override CFLAGS += -std=c99 -pedantic


@@ -162,50 +207,101 @@ override LDFLAGS += -pg --coverage
 endif
 
 
 endif
 
 

-# Automatic rebuilding when flags or commands changes
-######################################################
-
-# Re-compile C files if one of this variables changes
-COMPILE.c.FLAGS := $(CC) ~ $(CPPFLAGS) ~ $(CFLAGS) ~ $(TARGET_ARCH)
-
-# Re-compile C++ files if one of this variables changes
-COMPILE.cpp.FLAGS := $(CXX) ~ $(CPPFLAGS) ~ $(CXXFLAGS) ~ $(TARGET_ARCH)
+# Automatic dependency handling
+################################

 
 

-# Re-link binaries and libraries if one of this variables changes
-LINK.o.FLAGS := $(LD) ~ $(LDFLAGS) ~ $(TARGET_ARCH)
+# These files are created during compilation.
+sinclude $(shell test -d $O && find $O -name '*.d')

 
 
 # Default rules
 ################
 
 
 
 # Default rules
 ################
 

+# Compile C objects

 $O/%.o: $T/%.c $G/compile-c-flags
        $(call compile,c)
 
 $O/%.o: $T/%.c $G/compile-c-flags
        $(call compile,c)
 

+# Compile C++ objects

 $O/%.o: $T/%.cpp $G/compile-cpp-flags
        $(call compile,cpp)
 
 $O/%.o: $T/%.cpp $G/compile-cpp-flags
        $(call compile,cpp)
 

+# Link binary programs

 $B/%: $G/link-o-flags
        $(call link)
 
 $B/%: $G/link-o-flags
        $(call link)
 

+# Link shared libraries

 $L/%.so: override CFLAGS += -fPIC
 $L/%.so: override CXXFLAGS += -fPIC
 $L/%.so: $G/link-o-flags
        $(call link,-shared)
 
 $L/%.so: override CFLAGS += -fPIC
 $L/%.so: override CXXFLAGS += -fPIC
 $L/%.so: $G/link-o-flags
        $(call link,-shared)
 

+# Install binary programs
+$I/bin/%:
+       $(call install_file,0755)
+
+# Install system binary programs
+$I/sbin/%:
+       $(call install_file,0755)
+
+# Install libraries
+$I/lib/%:
+       $(call install_file)
+

 .PHONY: clean
 clean:
        $(call exec,$(RM) -r $D,$D)
 
 .PHONY: clean
 clean:
        $(call exec,$(RM) -r $D,$D)
 

+# Phony rule to uninstall all built targets (like "install", uses $(install)).
+.PHONY: uninstall
+uninstall:
+       $V$(foreach i,$(install),$(call vexec,$(RM) $i,$i);)

 
 

-# Automatic dependency handling
-################################
+# These rules use the "Secondary Expansion" GNU Make feature, to allow
+# sub-makes to add values to the special variables $(all), after this makefile
+# was read.
+.SECONDEXPANSION:
+  
+# Phony rule to make all the targets (sub-makefiles can append targets to build
+# to the $(all) variable).
+.PHONY: all
+all: $$(all)

 
 

-sinclude $(shell test -d $O && find $O -name '*.d')
+# Phony rule to install all built targets (sub-makefiles can append targets to
+# build to the $(install) variable).
+.PHONY: install
+install: $$(install)

 
 
 # Create build directory structure
 ###################################
 
 
 
 # Create build directory structure
 ###################################
 

+# Create $O, $B, $L and $(INCLUDE_DIR) directories and replicate the directory
+# structure of the project into $O. Create one symlink "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 \
+       mkdir -p $O $B $L $(INCLUDE_DIR); \
+       mkdir -p . $(addprefix $O,$(patsubst $T%,%,\
+                       $(shell find $T -type d -not -path '$D*'))); \
+       test -L $D/last || ln -s $F $D/last )
+
+
+# Automatic rebuilding when flags or commands changes
+######################################################
+
+# Re-compile C files if one of this variables changes
+COMPILE.c.FLAGS += $(CC) ~ $(CPPFLAGS) ~ $(CFLAGS) ~ $(TARGET_ARCH) ~ $(prefix)
+
+# Re-compile C++ files if one of this variables changes
+COMPILE.cpp.FLAGS += $(CXX) ~ $(CPPFLAGS) ~ $(CXXFLAGS) ~ $(TARGET_ARCH) \
+               ~ $(prefix)
+
+# Re-link binaries and libraries if one of this variables changes
+LINK.o.FLAGS += $(LD) ~ $(LDFLAGS) ~ $(TARGET_ARCH)
+

 # Create a file with flags used to trigger rebuilding when they change. The
 # first argument is the name of the file where to store the flags, the second
 # are the flags and the third argument is a text to be displayed if the flags
 # Create a file with flags used to trigger rebuilding when they change. The
 # first argument is the name of the file where to store the flags, the second
 # are the flags and the third argument is a text to be displayed if the flags


@@ -215,38 +311,18 @@ gen_rebuild_flags = if test x"$2" != x"`cat $1 2>/dev/null`"; then \
                test -f $1 && echo "$3"; \
                echo "$2" > $1 ; fi
 
                test -f $1 && echo "$3"; \
                echo "$2" > $1 ; fi
 

-# Create $O, $B, $L, $I and $J directories and replicate the directory
-# structure of the project into $O. Create one symlink "last" to the current
-# build directory and another to use as include directory.  It update the flags
-# files to detect flag and/or compiler changes to force a rebuild.
-#
-# 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 \
-       mkdir -p $O $B $L $I $J; \
-       mkdir -p . $(addprefix $O,$(patsubst $T%,%,\
-                       $(shell find $T -type d -not -path '$D*'))); \
+# Create files containing the current flags to trigger a rebuild if they change
+setup_flag_files__ := $(shell \

        $(call gen_rebuild_flags,$G/compile-c-flags, \
                        $(COMPILE.c.FLAGS),C compiler or flags;); \
        $(call gen_rebuild_flags,$G/compile-cpp-flags, \
                        $(COMPILE.cpp.FLAGS),C++ compiler or flags;); \
        $(call gen_rebuild_flags,$G/link-o-flags, \
        $(call gen_rebuild_flags,$G/compile-c-flags, \
                        $(COMPILE.c.FLAGS),C compiler or flags;); \
        $(call gen_rebuild_flags,$G/compile-cpp-flags, \
                        $(COMPILE.cpp.FLAGS),C++ compiler or flags;); \
        $(call gen_rebuild_flags,$G/link-o-flags, \

-                       $(LINK.o.FLAGS),linker or link flags;); \
-       test -L $I/$P || ln -s $T $I/$P; \
-       test -L $D/last || ln -s $F $D/last )
+                       $(LINK.o.FLAGS),linker or link flags;) )

 
 # Print any generated message (if verbose)
 
 # Print any generated message (if verbose)

-$(if $V,$(if $(setup_build_dir__), \
-       $(info !! Something changed: $(setup_build_dir__) \
+$(if $V,$(if $(setup_flag_files__), \
+       $(info !! Something changed: $(setup_flag_files__) \

                        re-building affected files...)))
 
                        re-building affected files...)))
 

-# Include the Build.mak for this directory
-include $T/Build.mak
-
-# Phony rule to make all the targets (sub-makefiles can append targets to build
-# to the $(all) variable).
-.PHONY: all
-all: $(all)
-

 endif
 endif