Comment default rules

[software/makeit.git] / Lib.mak

diff --git a/Lib.mak b/Lib.mak
index 539a597cfdefa5dafd2959ef3a08bdfae12d8d48..a2ec0dfb52cf9f8f9b8609869f0715fc35cec4e1 100644 (file)
--- a/Lib.mak
+++ b/Lib.mak
@@ -4,7 +4,7 @@ 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.
 # 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


@@ -20,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 ?=
 


@@ -27,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)


@@ -50,10 +63,17 @@ B ?= $G/bin
 # Libraries directory
 L ?= $G/lib
 
 # Libraries directory
 L ?= $G/lib
 

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

 
 # Includes directory
 INCLUDE_DIR ?= $G/include
 
 
 # Includes directory
 INCLUDE_DIR ?= $G/include
 

+# 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
 ############


@@ -65,9 +85,14 @@ 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
 
 # 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


@@ -127,12 +152,19 @@ 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 \
 # 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 $T/$C $(INCLUDE_DIR)/$1 )
+                       || ln -s $C $(INCLUDE_DIR)/$1 )

 
 
 # Overrided flags
 
 
 # Overrided flags


@@ -144,6 +176,9 @@ override CPPFLAGS += -Wall
 # Use the includes directories to search for includes
 override CPPFLAGS += -I$(INCLUDE_DIR)
 
 # 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 compilant
 override CFLAGS += -std=c99 -pedantic
 override CXXFLAGS += -std=c++98 -pedantic
 # Be standard compilant
 override CFLAGS += -std=c99 -pedantic
 override CXXFLAGS += -std=c++98 -pedantic


@@ -182,24 +217,45 @@ 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);)
+

 # 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.
 # 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.


@@ -210,11 +266,15 @@ clean:
 .PHONY: all
 all: $$(all)
 
 .PHONY: all
 all: $$(all)
 

+# 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.
 # 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.


@@ -233,10 +293,11 @@ setup_build_dir__ := $(shell \
 ######################################################
 
 # Re-compile C files if one of this variables changes
 ######################################################
 
 # Re-compile C files if one of this variables changes

-COMPILE.c.FLAGS += $(CC) ~ $(CPPFLAGS) ~ $(CFLAGS) ~ $(TARGET_ARCH)
+COMPILE.c.FLAGS += $(CC) ~ $(CPPFLAGS) ~ $(CFLAGS) ~ $(TARGET_ARCH) ~ $(prefix)

 
 # Re-compile C++ files if one of this variables changes
 
 # Re-compile C++ files if one of this variables changes

-COMPILE.cpp.FLAGS += $(CXX) ~ $(CPPFLAGS) ~ $(CXXFLAGS) ~ $(TARGET_ARCH)
+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)
 
 # Re-link binaries and libraries if one of this variables changes
 LINK.o.FLAGS += $(LD) ~ $(LDFLAGS) ~ $(TARGET_ARCH)