]> git.llucax.com Git - personal/resume.git/blob - Makeit.mak
Add .gitignore
[personal/resume.git] / Makeit.mak
1 ifndef Makeit.mak.included
2 Makeit.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 # If $V is non-empty, colored output is used if $(COLOR) is non-empty too
18 COLOR ?= 1
19
20 # ANSI color used for the command if $(COLOR) is non-empty
21 # The color is composed with 2 numbers separated by ;
22 # The first is the style. 00 is normal, 01 is bold, 04 is underline, 05 blinks,
23 # 07 is reversed mode
24 # The second is the color: 30 dark gray/black, 31 red, 32 green, 33 yellow, 34
25 # blue, 35 magenta, 36 cyan and 37 white.
26 # If empty, no special color is used.
27 COLOR_CMD ?= 00;33
28
29 # ANSI color used for the argument if $(COLOR) is non-empty
30 # See COLOR_CMD comment for details.
31 COLOR_ARG ?=
32
33 # ANSI color used for the warnings if $(COLOR) is non-empty
34 # See COLOR_CMD comment for details.
35 COLOR_WARN ?= 00;36
36
37 # ANSI color used for commands output if $(COLOR) is non-empty
38 # See COLOR_CMD comment for details.
39 COLOR_OUT ?= 00;31
40
41 # Flavor (variant), should be one of "dbg", "opt" or "cov"
42 F ?= opt
43
44 # Use C++ linker by default
45 LINKER := $(CXX)
46
47 # Default mode used to install files
48 IMODE ?= 0644
49
50 # Default install flags
51 IFLAGS ?= -D
52
53 # Use pre-compiled headers if non-empty
54 GCH ?=
55
56 # If non-empty, use valgrind to run commands via the "valgrind" function
57 VALGRIND ?=
58
59 # Options to pass to valgrind; if the variable $(VALGRIND_SUPP) is non-empty
60 # it will be used as a suppressions file.
61 VALGRIND_CMD ?= valgrind --tool=memcheck --leak-check=yes --db-attach=no \
62                 --num-callers=24 --leak-resolution=high --track-fds=yes \
63                 --error-exitcode=1 \
64                 $(if $V,--log-file=$<.valgrind.log) \
65                 $(if $(VALGRIND_SUPP),--suppressions=$(VALGRIND_SUPP))
66
67 # Command to generate Sphinx based documentation
68 SPHINX ?= sphinx-build
69
70 # Format to build using Sphinx (html, pickle, htmlhelp, latex, changes or
71 # linkcheck; see sphinx-build docs for details)
72 SPHINX_FORMAT ?= html
73
74 # Paper size for Sphinx LaTeX output (a4, letter, etc.)
75 SPHINX_PAPERSIZE ?= a4
76
77 # Name of the build directory (to use when excluding some paths)
78 BUILD_DIR_NAME ?= build
79
80 # Directories to exclude from the build directory tree replication
81 BUILD_DIR_EXCLUDE ?= $(BUILD_DIR_NAME) .git .hg .bzr _darcs .svn CVS
82
83
84 # Directories
85 ##############
86
87 # Base directory where to install files (can be overridden, should be absolute)
88 prefix ?= /usr/local
89
90 # Path to a complete alternative environment, usually a jail, or an installed
91 # system mounted elsewhere than /.
92 DESTDIR ?=
93
94 # Use absolute paths to avoid problems with automatic dependencies when
95 # building from subdirectories
96 T := $(abspath $T)
97
98 # Name of the current directory, relative to $T
99 R := $(subst $T,,$(patsubst $T/%,%,$(CURDIR)))
100
101 # Base directory where to put variants (Variants Directory)
102 VD ?= $T/$(BUILD_DIR_NAME)
103
104 # Generated files top directory
105 G ?= $(VD)/$F
106
107 # Objects (and other garbage like pre-compiled headers and dependency files)
108 # directory
109 O ?= $G/obj
110
111 # Binaries directory
112 B ?= $G/bin
113
114 # Libraries directory
115 L ?= $G/lib
116
117 # Documentation directory
118 D ?= $(VD)/doc
119
120 # Installation directory
121 I := $(DESTDIR)$(prefix)
122
123 # Includes directory
124 INCLUDE_DIR ?= $G/include
125
126 # Directory of the current makefile (this might not be the same as $(CURDIR)
127 # This variable is "lazy" because $S changes all the time, so it should be
128 # evaluated in the context where $C is used, not here.
129 C = $T/$S
130
131
132 # Functions
133 ############
134
135 # Compare two strings, if they are the same, returns the string, if not,
136 # returns empty.
137 eq = $(if $(subst $1,,$2),,$1)
138
139 # Find sources files and get the corresponding object names.  The first
140 # argument should be the sources extension ("c" or "cpp" typically).  The
141 # second argument is where to search for the sources ($C if omitted).  The
142 # resulting files will always have the suffix "o" and the directory rewritten
143 # to match the directory structure (from $T) but in the $O directory.  For
144 # example, if $T is "/usr/src", $O is "/tmp/obj", $C is "/usr/src/curr" and it
145 # have 2 C sources: "/usr/src/curr/1.c" and "/usr/src/curr/dir/2.c", the call:
146 # $(call find_objects,c)
147 # Will yield "/tmp/obj/curr/1.o" and "/tmp/obj/curr/dir/2.o".
148 find_objects = $(patsubst $T/%.$1,$O/%.o,$(shell \
149                 find $(if $2,$2,$C) -name '*.$1'))
150
151 # Find files and get the their file names relative to another directory.  The
152 # first argument should be the files suffix (".h" or ".cpp" for example).  The
153 # second argument is a directory rewrite, the matched files will be rewriten to
154 # be in the directory specified in this argument (it defaults to the third
155 # argument if omitted).  The third argument is where to search for the files
156 # ($C if omitted).
157 find_files = $(patsubst $(if $3,$3,$C)/%$1,$(if $2,$2,$(if $3,$3,$C))/%$1, \
158                 $(shell find $(if $3,$3,$C) -name '*$1'))
159
160 # Abbreviate a file name. Cut the leading part of a file if it match to the $T
161 # directory, so it can be displayed as if it were a relative directory. Take
162 # just one argument, the file name.
163 abbr_helper = $(subst $T,.,$(patsubst $T/%,%,$1))
164 abbr = $(if $(call eq,$(call abbr_helper,$1),$1),$1,$(addprefix \
165                 $(shell echo $R | sed 's|/\?\([^/]\+\)/\?|../|g'),\
166                 $(call abbr_helper,$1)))
167
168 # Execute a command printing a nice message if $V is @.
169 # The first argument is mandatory and it's the command to execute. The second
170 # and third arguments are optional and are the target name and command name to
171 # pretty print.
172 vexec_pc = $(if $1,\033[$1m%s\033[00m,%s)
173 vexec_p = $(if $(COLOR), \
174         '   $(call vexec_pc,$(COLOR_CMD)) $(call vexec_pc,$(COLOR_ARG))\n$(if \
175                         $(COLOR_OUT),\033[$(COLOR_OUT)m)', \
176         '   %s %s\n')
177 vexec = $(if $V,printf $(vexec_p) \
178                 '$(call abbr,$(if $3,$(strip $3),$(firstword $1)))' \
179                 '$(call abbr,$(if $2,$(strip $2),$@))' ; )$1 \
180                 $(if $V,$(if $(COLOR),$(if $(COLOR_OUT), \
181                                 ; r=$$? ; printf '\033[00m' ; exit $$r)))
182
183 # Same as vexec but it silence the echo command (prepending a @ if $V).
184 exec = $V$(call vexec,$1,$2,$3)
185
186 # Compile a source file to an object, generating pre-compiled headers (if
187 # $(GCH) is non-empty) and dependencies. The pre-compiled headers are generated
188 # only if the system includes change. This function is designed to be used as
189 # a command in a rule.  The first argument is the type of file to compile
190 # (typically "c" or "cpp").  What to compile and the output files are built
191 # using the automatic variables from a rule.  The second argument is the base
192 # output directory (typically $O).  You can add non-propagated object-specific
193 # flags defining a variable with the name of the target followed with
194 # ".EXTRA_FLAGS".
195 #
196 # XXX: The pre-compiled headers generation is not very useful if you include
197 #      local files using #include <...>, because the system headers detection
198 #      is a little simplistic now, it just parse the source file and all its
199 #      dependencies searching for lines starting with "#include <" and
200 #      extracting the included files from them.
201 define compile
202 $(if $(GCH),\
203 $Vif test -f $2/$*.d; then \
204         tmp=`mktemp`; \
205         h=`awk -F: '!$$0 {f = 1} $$0 && f {print $$1}' $2/$*.d`; \
206         grep -h '^#include <' $< $$h | sort -u > "$$tmp"; \
207         if diff -q -w "$2/$*.$1.h" "$$tmp" > /dev/null 2>&1; \
208         then \
209                 rm "$$tmp"; \
210         else \
211                 mv "$$tmp" "$2/$*.$1.h"; \
212                 $(call vexec,$(COMPILE.$1) $($@.EXTRA_FLAGS) \
213                         -o "$2/$*.$1.h.gch" "$2/$*.$1.h",$2/$*.$1.h.gch); \
214         fi \
215 else \
216         touch "$2/$*.$1.h"; \
217 fi \
218 )
219 $(call exec,$(COMPILE.$1) $($@.EXTRA_FLAGS) -o $@ -MMD -MP \
220                 $(if $(GCH),-include $2/$*.$1.h) $<)
221 endef
222
223 # Link object files to build an executable. The objects files are taken from
224 # the prerequisite files ($O/%.o). If in the prerequisite files are shared
225 # objects ($L/lib%.so), they are included as libraries to link to (-l%). This
226 # function is designed to be used as a command in a rule. The output name is
227 # taken from the rule automatic variables. If an argument is provided, it's
228 # included in the link command line. The variable LINKER is used to link the
229 # executable; for example, if you want to link a C++ executable, you should use
230 # LINKER := $(CXX).  You can add non-propagated target-specific flags defining
231 # a variable with the name of the target followed with ".EXTRA_FLAGS".  You can
232 # specify a non-propagated object-specific linker defining a variable with the
233 # name of the target followed with ".LINKER".
234 link = $(call exec,$(if $($@.LINKER),$($@.LINKER),$(LINKER)) \
235                 $(LDFLAGS) $(TARGET_ARCH) $($@.EXTRA_FLAGS) -o $@ $1 \
236                 $(patsubst $L/lib%.so,-l%,$(filter %.so,$^)) \
237                 $(foreach obj,$(filter %.o,$^),$(obj)))
238
239 # Install a file. All arguments are optional.  The first argument is the file
240 # mode (defaults to 0644).  The second argument are extra flags to the install
241 # command (defaults to -D).  The third argument is the source file to install
242 # (defaults to $<) and the last one is the destination (defaults to $@).
243 install_file = $(call exec,install -m $(if $1,$1,0644) $(if $2,$2,-D) \
244                 $(if $3,$3,$<) $(if $4,$4,$@))
245
246 # Concatenate variables together.  The first argument is a list of variables
247 # names to concatenate.  The second argument is an optional prefix for the
248 # variables and the third is the string to use as separator (" ~" if omitted).
249 # For example:
250 # X_A := a
251 # X_B := b
252 # $(call varcat,A B,X_, --)
253 # Will produce something like "a -- b --"
254 varcat = $(foreach v,$1,$($2$v)$(if $3,$3, ~))
255
256 # Replace variables with specified values in a template file.  The first
257 # argument is a list of make variables names which will be replaced in the
258 # target file.  The strings @VARNAME@ in the template file will be replaced
259 # with the value of the make $(VARNAME) variable and the result will be stored
260 # in the target file.  The second (optional) argument is a prefix to add to the
261 # make variables names, so if the prefix is PREFIX_ and @VARNAME@ is found in
262 # the template file, it will be replaced by the value of the make variable
263 # $(PREFIX_VARNAME).  The third and fourth arguments are the source file and
264 # the destination file (both optional, $< and $@ are used if omitted). The
265 # fifth (optional) argument are options to pass to the substitute sed command
266 # (for example, use "g" if you want to do multiple substitutions per line).
267 replace = $(call exec,sed '$(foreach v,$1,s|@$v@|$($2$v)|$5;)' $(if $3,$3,$<) \
268                 > $(if $4,$4,$@))
269
270 # Create a symbolic link to the project under the $(INCLUDE_DIR). The first
271 # argument is the name of symbolic link to create.  The link is only created if
272 # it doesn't already exist.
273 symlink_include_dir = $(shell \
274                 test -L $(INCLUDE_DIR)/$1 \
275                         || ln -s $C $(INCLUDE_DIR)/$1 )
276
277 # Create a file with flags used to trigger rebuilding when they change. The
278 # first argument is the name of the file where to store the flags, the second
279 # are the flags and the third argument is a text to be displayed if the flags
280 # have changed (optional).  This should be used as a rule action or something
281 # where a shell script is expected.
282 gen_rebuild_flags = $(shell if test x"$2" != x"`cat $1 2>/dev/null`"; then \
283                 $(if $3,test -f $1 && echo "$(if $(COLOR),$(if $(COLOR_WARN),\
284                         \033[$(COLOR_WARN)m$3\033[00m,$3),$3);";) \
285                 echo "$2" > $1 ; fi)
286
287 # Include sub-directory's Build.mak.  The only argument is a list of
288 # subdirectories for which Build.mak should be included.  The $S directory is
289 # set properly before including each sub-directory's Build.mak and restored
290 # afterwards.
291 define build_subdir_code
292 _parent__$d__dir_ := $$S
293 S := $$(if $$(_parent__$d__dir_),$$(_parent__$d__dir_)/$d,$d)
294 include $$T/$$S/Build.mak
295 S := $$(_parent__$d__dir_)
296 endef
297 include_subdirs = $(foreach d,$1,$(eval $(build_subdir_code)))
298
299 # Run a command through valgrind if $(VALGRIND) is non-empty.  The first
300 # argument is the command to run.  If $(VALGRIND) is empty, the command is
301 # executed as passed to this function.  If valgrind is used, the
302 # $(VALGRIND_CMD) is prepended to the command to run.  See VALGRIND_CMD
303 # definition for extra options that can be passed as make variables.  The
304 # second argument is the name of the command to print when $V is non-empty (if
305 # omitted, the first word of the first argument is used).
306 valgrind = $(call exec,$(if $(VALGRIND),$(VALGRIND_CMD)) $1,\
307                 $(if $(VALGRIND),[$(firstword $(VALGRIND_CMD))], ),\
308                 $(if $2,$2,$(firstword $1)))
309
310
311 # Overridden flags
312 ##################
313
314 # Warn about everything
315 override CPPFLAGS += -Wall
316
317 # Use the includes directories to search for includes
318 override CPPFLAGS += -I$(INCLUDE_DIR)
319
320 # Let the program know where it will be installed
321 override CPPFLAGS += -DPREFIX=$(prefix)
322
323 # Be standard compliant
324 override CFLAGS += -std=c99 -pedantic
325 override CXXFLAGS += -std=c++98 -pedantic
326
327 # Use the generated library directory to for libraries
328 override LDFLAGS += -L$L -Wall
329
330 # Make sure the generated libraries can be found
331 export LD_LIBRARY_PATH := $L:$(LD_LIBRARY_PATH)
332
333
334 # Variant flags
335 ################
336
337 ifeq ($F,dbg)
338 override CPPFLAGS += -ggdb -DDEBUG
339 endif
340
341 ifeq ($F,opt)
342 override CPPFLAGS += -O2 -DNDEBUG
343 endif
344
345 ifeq ($F,cov)
346 override CPPFLAGS += -ggdb -pg --coverage
347 override LDFLAGS += -pg --coverage
348 endif
349
350
351 # Automatic dependency handling
352 ################################
353
354 # These files are created during compilation.
355 sinclude $(shell test -d $O && find $O -name '*.d')
356
357
358 # Default rules
359 ################
360
361 # Compile C objects
362 $O/%.o: $T/%.c $G/compile-c-flags
363         $(call compile,c,$O)
364
365 # Compile C++ objects
366 $O/%.o: $T/%.cpp $G/compile-cpp-flags
367         $(call compile,cpp,$O)
368
369 # Link binary programs
370 $B/%: $G/link-o-flags
371         $(call link)
372
373 # Link shared libraries
374 $L/%.so: override CFLAGS += -fPIC
375 $L/%.so: override CXXFLAGS += -fPIC
376 $L/%.so: $G/link-o-flags
377         $(call link,-shared)
378
379 # Create pkg-config files using a template
380 $L/%.pc:
381         $(call replace,$(PC_VARS),$*-PC-)
382
383 # Run doxygen to build the documentation.  It expects the first prerequisite to
384 # be the Doxyfile to use and the next prerequisites the input files.  You
385 # can override Doxyfile configuration variables by defining a DOXYGEN_VARS
386 # Make variable for this rule.  For example, defining:
387 # PROJECT_NAME := myproj
388 # DOXYGEN_VARS := PROJECT_NAME
389 # You can override Doxygen's PROJECT_NAME configuration option. Optionally, you
390 # can define DOXYGEN_VARS_PREFIX too, to avoid polluting your Makefile with
391 # Doxygen variables.  For example:
392 # DOXY.PROJECT_NAME := myproj
393 # DOXYGEN_VARS_PREFIX := DOXY.
394 # DOXYGEN_VARS := PROJECT_NAME
395 # This rule might be still a little restrictive, but you can always make your
396 # own if it doesn't fit your needs ;)
397 $D/%/doxygen-stamp:
398         $V mkdir -p $(@D)
399         $(call exec,(cat $<; \
400                 echo "FULL_PATH_NAMES=YES"; \
401                 $(if $(filter INPUT,$(DOXYGEN_VARS)),,\
402                         echo "INPUT=$(patsubst $(<D)/%,$(INCLUDE_DIR)/$*/%, \
403                                         $(wordlist 2,$(words $^),$^))";) \
404                 echo "OUTPUT_DIRECTORY=$(@D)"; \
405                 echo "STRIP_FROM_PATH=$(INCLUDE_DIR)"; \
406                 echo "STRIP_FROM_INC_PATH=$(INCLUDE_DIR)"; \
407                 echo "QUIET=$(if $V,YES,NO)"; \
408                 $(foreach v,$(DOXYGEN_VARS),\
409                                 echo '$v=$($(DOXYGEN_VARS_PREFIX)$v)';) \
410                 ) | doxygen -,$(@D),doxygen)
411         $V touch $@
412
413 # Run Sphinx to build the documentation.  It expects the variable SPHINX_DIR
414 # to be set to the directory where the Sphinx's conf.py and reST source files
415 # are.  This rule is a little restrictive, but you can always make your own if
416 # it doesn't fit your needs ;)
417 $D/%/sphinx-stamp: $G/sphinx-flags
418         $V mkdir -p $(@D)/$(SPHINX_FORMAT)
419         $(call exec,$(SPHINX) $(if $V,-q) -b $(SPHINX_FORMAT) \
420                 -d $(@D)/doctrees -D latex_paper_size=$(SPHINX_PAPERSIZE) \
421                 $(SPHINX_DIR) $(@D)/$(SPHINX_FORMAT),$(@D),$(SPHINX))
422         $V touch $@
423
424 # Install binary programs
425 $I/bin/%:
426         $(call install_file,0755)
427
428 # Install system binary programs
429 $I/sbin/%:
430         $(call install_file,0755)
431
432 # Install pkg-config specification files
433 $I/lib/pkgconfig/%:
434         $(call install_file)
435
436 # Install libraries
437 $I/lib/%:
438         $(call install_file)
439
440 .PHONY: clean
441 clean:
442         $(call exec,$(RM) -r $(VD),$(VD))
443
444 # Phony rule to uninstall all built targets (like "install", uses $(install)).
445 .PHONY: uninstall
446 uninstall:
447         $V$(foreach i,$(install),$(call vexec,$(RM) $i,$i);)
448
449 # These rules use the "Secondary Expansion" GNU Make feature, to allow
450 # sub-makes to add values to the special variables $(all), after this makefile
451 # was read.
452 .SECONDEXPANSION:
453
454 # Phony rule to make all the targets (sub-makefiles can append targets to build
455 # to the $(all) variable).
456 .PHONY: all
457 all: $$(all)
458
459 # Phony rule to install all built targets (sub-makefiles can append targets to
460 # build to the $(install) variable).
461 .PHONY: install
462 install: $$(install)
463
464 # Phony rule to build all documentation targets (sub-makefiles can append
465 # documentation to build to the $(doc) variable).
466 .PHONY: doc
467 doc: $$(doc)
468
469 # Phony rule to build and run all test (sub-makefiles can append targets to
470 # build and run tests to the $(test) variable).
471 .PHONY: test
472 test: $$(test)
473
474
475 # Create build directory structure
476 ###################################
477
478 # Create $O, $B, $L, $D and $(INCLUDE_DIR) directories and replicate the
479 # directory structure of the project into $O. Create one symbolic link "last"
480 # to the current build directory.
481 #
482 # NOTE: the second mkdir can yield no arguments if the project don't have any
483 #       subdirectories, that's why the current directory "." is included, so it
484 #       won't show an error message in case of no subdirectories.
485 setup_build_dir__ := $(shell \
486         mkdir -p $O $B $L $D $(INCLUDE_DIR) $(addprefix $O,$(patsubst $T%,%,\
487                 $(shell find $T -type d $(foreach d,$(BUILD_DIR_EXCLUDE), \
488                                 -not -path '*/$d' -not -path '*/$d/*')))); \
489         rm -f $(VD)/last && ln -s $F $(VD)/last )
490
491
492 # Automatic rebuilding when flags or commands changes
493 ######################################################
494
495 # Re-compile C files if one of this variables changes
496 COMPILE.c.FLAGS := $(call varcat,CC CPPFLAGS CFLAGS TARGET_ARCH prefix)
497
498 # Re-compile C++ files if one of this variables changes
499 COMPILE.cpp.FLAGS := $(call varcat,CXX CPPFLAGS CXXFLAGS TARGET_ARCH prefix)
500
501 # Re-link binaries and libraries if one of this variables changes
502 LINK.o.FLAGS := $(call varcat,LD LDFLAGS TARGET_ARCH)
503
504 # Re-build sphinx documentation if one of these variables changes
505 SPHINX.FLAGS := $(call varcat,SPHINX SPHINX_FORMAT SPHINX_PAPERSIZE)
506
507 # Create files containing the current flags to trigger a rebuild if they change
508 setup_flag_files__ := $(call gen_rebuild_flags,$G/compile-c-flags, \
509         $(COMPILE.c.FLAGS),C compiler)
510 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \
511         $G/compile-cpp-flags, $(COMPILE.cpp.FLAGS),C++ compiler)
512 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \
513         $G/link-o-flags, $(LINK.o.FLAGS),linker)
514 setup_flag_files__ := $(setup_flag_files__)$(call gen_rebuild_flags, \
515         $G/sphinx-flags, $(SPHINX.FLAGS),sphinx)
516
517 # Print any generated message (if verbose)
518 $(if $V,$(if $(setup_flag_files__), \
519         $(info !! Flags or commands changed:$(setup_flag_files__) re-building \
520                         affected files...)))
521
522 endif