Makefile.in

   1 #=========================================================================
   2 # Toplevel Makefile for the Modular C++ Build System
   3 #=========================================================================
   4 # Please read the documenation in 'mcppbs-doc.txt' for more details on
   5 # how the Modular C++ Build System works. For most projects, a developer
   6 # will not need to make any changes to this makefile. The key targets
   7 # are as follows:
   8 #
   9 #  - default   : build all libraries and programs
  10 #  - check     : build and run all unit tests
  11 #  - install   : install headers, project library, and some programs
  12 #  - clean     : remove all generated content (except autoconf files)
  13 #  - dist      : make a source tarball
  14 #  - distcheck : make a source tarball, untar it, check it, clean it
  15 #  - distclean : remove everything
  16 #
  17
  18 #-------------------------------------------------------------------------
  19 # Basic setup
  20 #-------------------------------------------------------------------------
  21
  22 # Remove all default implicit rules since they can cause subtle bugs
  23 # and they just make things run slower
  24 .SUFFIXES:
  25 % : %,v
  26 % : RCS/%,v
  27 % : RCS/%
  28 % : s.%
  29 % : SCCS/s.%
  30
  31 # Default is to build the prereqs of the all target (defined at bottom)
  32 default : all
  33 .PHONY : default
  34
  35 project_name := @PACKAGE_TARNAME@
  36 src_dir      := @srcdir@
  37 scripts_dir  := $(src_dir)/scripts
  38
  39 # If the version information is not in the configure script, then we
  40 # assume that we are in a working directory. We use the vcs-version.sh
  41 # script in the scripts directory to generate an appropriate version
  42 # string. Currently the way things are setup we have to run this script
  43 # everytime we run make so the script needs to be as fast as possible.
  44
  45 ifeq (@PACKAGE_VERSION@,?)
  46   project_ver:=$(shell $(scripts_dir)/vcs-version.sh $(src_dir))
  47 else
  48   project_ver:=@PACKAGE_VERSION@
  49 endif
  50
  51 # Installation directories
  52
  53 prefix       := @prefix@
  54 enable_stow  := @enable_stow@
  55
  56 ifeq ($(enable_stow),yes)
  57   stow_pkg_dir := $(prefix)/pkgs
  58   DESTDIR ?= $(stow_pkg_dir)/$(project_name)-$(project_ver)
  59 else
  60   DESTDIR ?= $(prefix)
  61 endif
  62
  63 install_hdrs_dir := $(DESTDIR)/include/$(project_name)
  64 install_libs_dir := $(DESTDIR)/lib/$(project_name)
  65 install_exes_dir := $(DESTDIR)/bin
  66
  67 #-------------------------------------------------------------------------
  68 # List of subprojects
  69 #-------------------------------------------------------------------------
  70
  71 sprojs         := @subprojects@
  72 sprojs_enabled := @subprojects_enabled@
  73
  74 sprojs_include := -I. $(addprefix -I$(src_dir)/, $(sprojs_enabled))
  75 VPATH := $(addprefix $(src_dir)/, $(sprojs_enabled))
  76
  77 #-------------------------------------------------------------------------
  78 # Programs and flags
  79 #-------------------------------------------------------------------------
  80
  81 # C++ compiler
  82 #  - CPPFLAGS : flags for the preprocessor (eg. -I,-D)
  83 #  - CXXFLAGS : flags for C++ compiler (eg. -Wall,-g,-O3)
  84 #  - INCDIRS : extra include directories (eg. -I/foo/bar)
  85
  86 CC            := @CC@
  87 CXX           := @CXX@
  88 CPPFLAGS      := @CPPFLAGS@
  89 CXXFLAGS      := @CXXFLAGS@
  90 INCDIRS       := @INCDIRS@
  91 COMPILE       := $(CXX) -MMD -MP $(CPPFLAGS) $(CXXFLAGS) $(INCDIRS) \
  92                  $(sprojs_include)
  93 COMPILE_C     := $(CC)  -MMD -MP $(CPPFLAGS) $(CXXFLAGS) $(INCDIRS) \
  94                  $(sprojs_include)
  95 # Linker
  96 #  - LDFLAGS : Flags for the linker (eg. -L)
  97 #  - LIBS    : Library flags (eg. -l)
  98
  99 LD            := $(CXX)
 100 LDFLAGS       := @LDFLAGS@
 101 LIBS          := @LIBS@
 102 LINK          := $(LD) $(LDFLAGS)
 103
 104 # Library creation
 105
 106 AR            := @AR@
 107 RANLIB        := @RANLIB@
 108
 109 # Host simulator
 110
 111 RUN           := @RUN@
 112 RUNFLAGS      := @RUNFLAGS@
 113
 114 # Installation
 115
 116 MKINSTALLDIRS := $(scripts_dir)/mk-install-dirs.sh
 117 INSTALL       := @INSTALL@
 118 INSTALL_HDR   := $(INSTALL) -m 444
 119 INSTALL_LIB   := $(INSTALL) -m 644
 120 INSTALL_EXE   := $(INSTALL) -m 555
 121 STOW          := @stow@
 122
 123 #-------------------------------------------------------------------------
 124 # Include subproject makefile fragments
 125 #-------------------------------------------------------------------------
 126
 127 sprojs_mk = $(addsuffix .mk, $(sprojs_enabled))
 128
 129 -include $(sprojs_mk)
 130
 131 dist_junk += $(sprojs_mk)
 132
 133 #-------------------------------------------------------------------------
 134 # Reverse list helper function
 135 #-------------------------------------------------------------------------
 136 # This function is used by the subproject template to reverse the list
 137 # of dependencies. It uses recursion to perform the reversal.
 138 #
 139 # Arguments:
 140 #  $(1)   : space separated input list
 141 #  retval : input list in reverse order
 142 #
 143
 144 reverse_list = $(call reverse_list_h,$(1),)
 145 define reverse_list_h
 146   $(if $(strip $(1)),                        \
 147     $(call reverse_list_h,                   \
 148            $(wordlist 2,$(words $(1)),$(1)), \
 149            $(firstword $(1)) $(2)),          \
 150     $(2))
 151 endef
 152
 153 #-------------------------------------------------------------------------
 154 # Template for per subproject rules
 155 #-------------------------------------------------------------------------
 156 # The template is instantiated for each of the subprojects. It relies on
 157 # subprojects defining a certain set of make variables which are all
 158 # prefixed with the subproject name. Since subproject names can have
 159 # dashes in them (and the make variables are assumed to only use
 160 # underscores) the template takes two arguments - one with the regular
 161 # subproject name and one with dashes replaced with underscores.
 162 #
 163 # Arguments:
 164 #  $(1) : real subproject name (ie with dashes)
 165 #  $(2) : normalized subproject name (ie dashes replaced with underscores)
 166 #
 167
 168 define subproject_template
 169
 170 # In some (rare) cases, a subproject might not have any actual object
 171 # files. It might only include header files or program sources. To keep
 172 # things consistent we still want a library for this subproject, so in
 173 # this spectial case we create a dummy source file and thus the build
 174 # system will create a library for this subproject with just the
 175 # corresponding dummy object file.
 176
 177 ifeq ($$(strip $$($(2)_srcs) $$($(2)_c_srcs)),)
 178 $(2)_srcs += _$(1).cc
 179 $(2)_junk += _$(1).cc
 180 endif
 181
 182 _$(1).cc :
 183         echo "int _$(2)( int arg ) { return arg; }" > $$@
 184
 185 # Build the object files for this subproject
 186
 187 $(2)_objs := $$(patsubst %.cc, %.o, $$($(2)_srcs))
 188 $(2)_c_objs := $$(patsubst %.c, %.o, $$($(2)_c_srcs))
 189 $(2)_deps := $$(patsubst %.o, %.d, $$($(2)_objs))
 190 $(2)_c_deps := $$(patsubst %.o, %.d, $$($(2)_c_objs))
 191 $$($(2)_objs) : %.o : %.cc
 192         $(COMPILE) -c $$<
 193 $$($(2)_c_objs) : %.o : %.c
 194         $(COMPILE_C) -c $$<
 195
 196 $(2)_junk += $$($(2)_objs) $$($(2)_c_objs) $$($(2)_deps) $$($(2)_c_deps)
 197
 198 # Build a library for this subproject
 199
 200 lib$(1).a : $$($(2)_objs) $$($(2)_c_objs)
 201         $(AR) rcv $$@ $$^
 202         $(RANLIB) $$@
 203
 204 $(2)_junk += lib$(1).a
 205
 206 # Reverse the dependency list so that a given subproject only depends on
 207 # subprojects listed to its right. This is the correct order for linking
 208 # the list of subproject libraries.
 209
 210 $(2)_reverse_deps   := $$(call reverse_list,$$($(2)_subproject_deps))
 211
 212 # Build unit tests
 213
 214 $(2)_test_objs      := $$(patsubst %.cc, %.o, $$($(2)_test_srcs))
 215 $(2)_test_deps      := $$(patsubst %.o, %.d, $$($(2)_test_objs))
 216 $(2)_test_exes      := $$(patsubst %.t.cc, %-utst, $$($(2)_test_srcs))
 217 $(2)_test_outs      := $$(patsubst %, %.out, $$($(2)_test_exes))
 218 $(2)_test_libs      := $(1) $$($(2)_reverse_deps) utst
 219 $(2)_test_libnames  := $$(patsubst %, lib%.a, $$($(2)_test_libs))
 220 $(2)_test_libarg    := -L. $$(patsubst %, -l%, $$($(2)_test_libs))
 221
 222 $$($(2)_test_objs) : %.o : %.cc
 223         $(COMPILE) -c $$<
 224
 225 $$($(2)_test_exes) : %-utst : %.t.o $$($(2)_test_libnames)
 226         $(LINK) -o $$@ $$< $$($(2)_test_libarg) $(LIBS)
 227
 228 $(2)_deps += $$($(2)_test_deps)
 229 $(2)_junk += \
 230         $$($(2)_test_objs) $$($(2)_test_deps) \
 231   $$($(2)_test_exes) *.junk-dat
 232
 233 # Run unit tests
 234
 235 $$($(2)_test_outs) : %.out : %
 236         $(RUN) $(RUNFLAGS) ./$$< default | tee $$@
 237
 238 $(2)_junk += $$($(2)_test_outs)
 239
 240 # Build programs
 241
 242 $(2)_prog_objs      := $$(patsubst %.cc, %.o, $$($(2)_prog_srcs))
 243 $(2)_prog_deps      := $$(patsubst %.o, %.d, $$($(2)_prog_objs))
 244 $(2)_prog_exes      := $$(patsubst %.cc, %, $$($(2)_prog_srcs))
 245 $(2)_prog_libs      := $(1) $$($(2)_reverse_deps)
 246 $(2)_prog_libnames  := $$(patsubst %, lib%.a, $$($(2)_prog_libs))
 247 $(2)_prog_libarg    := -L. $$(patsubst %, -l%, $$($(2)_prog_libs))
 248
 249 $$($(2)_prog_objs) : %.o : %.cc
 250         $(COMPILE) -c $$<
 251
 252 $$($(2)_prog_exes) : % : %.o $$($(2)_prog_libnames)
 253         $(LINK) -o $$@ $$< $$($(2)_prog_libarg) $(LIBS)
 254
 255 $(2)_deps += $$($(2)_prog_deps)
 256 $(2)_junk += $$($(2)_prog_objs) $$($(2)_prog_deps) $$($(2)_prog_exes)
 257
 258 # Build programs which will be installed
 259
 260 $(2)_install_prog_objs := $$(patsubst %.cc, %.o, $$($(2)_install_prog_srcs))
 261 $(2)_install_prog_deps := $$(patsubst %.o, %.d, $$($(2)_install_prog_objs))
 262 $(2)_install_prog_exes := $$(patsubst %.cc, %, $$($(2)_install_prog_srcs))
 263
 264 $$($(2)_install_prog_objs) : %.o : %.cc
 265         $(COMPILE) -c $$<
 266
 267 $$($(2)_install_prog_exes) : % : %.o $$($(2)_prog_libnames)
 268         $(LINK) -o $$@ $$< $$($(2)_prog_libarg) $(LIBS)
 269
 270 $(2)_deps += $$($(2)_install_prog_deps)
 271 $(2)_junk += \
 272   $$($(2)_install_prog_objs) $$($(2)_install_prog_deps) \
 273   $$($(2)_install_prog_exes)
 274
 275 # Subproject specific targets
 276
 277 all-$(1) : lib$(1).a $$($(2)_install_prog_exes)
 278
 279 check-$(1) : $$($(2)_test_outs)
 280         echo; grep -h -e'Unit Tests' -e'FAILED' -e'Segementation' $$^; echo
 281
 282 clean-$(1) :
 283         rm -rf $$($(2)_junk)
 284
 285 .PHONY : all-$(1) check-$(1) clean-$(1)
 286
 287 # Update running variables
 288
 289 libs += lib$(1).a
 290 objs += $$($(2)_objs)
 291 srcs += $$(addprefix $(src_dir)/$(1)/, $$($(2)_srcs))
 292 hdrs += $$(addprefix $(src_dir)/$(1)/, $$($(2)_hdrs))
 293 junk += $$($(2)_junk)
 294 deps += $$($(2)_deps)
 295
 296 test_outs += $$($(2)_test_outs)
 297
 298 install_hdrs += $$(addprefix $(src_dir)/$(1)/, $$($(2)_hdrs))
 299 install_libs += lib$(1).a
 300 install_exes += $$($(2)_install_prog_exes)
 301
 302 endef
 303
 304 # Iterate over the subprojects and call the template for each one
 305
 306 $(foreach sproj,$(sprojs_enabled), \
 307   $(eval $(call subproject_template,$(sproj),$(subst -,_,$(sproj)))))
 308
 309 #-------------------------------------------------------------------------
 310 # Autodependency files
 311 #-------------------------------------------------------------------------
 312
 313 -include $(deps)
 314
 315 deps : $(deps)
 316 .PHONY : deps
 317
 318 #-------------------------------------------------------------------------
 319 # Check
 320 #-------------------------------------------------------------------------
 321
 322 check : $(test_outs)
 323         echo; grep -h -e'Unit Tests' -e'FAILED' -e'Segementation' $^; echo
 324
 325 .PHONY : check
 326
 327 #-------------------------------------------------------------------------
 328 # Installation
 329 #-------------------------------------------------------------------------
 330
 331 install-hdrs : $(install_hdrs)
 332         $(MKINSTALLDIRS) $(install_hdrs_dir)
 333         for file in $(install_hdrs); \
 334   do \
 335     $(INSTALL_HDR) $$file $(install_hdrs_dir); \
 336   done
 337
 338 install-libs : $(install_libs)
 339         $(MKINSTALLDIRS) $(install_libs_dir)
 340         for file in $(install_libs); \
 341   do \
 342     $(INSTALL_LIB) $$file $(install_libs_dir); \
 343   done
 344
 345 install-exes : $(install_exes)
 346         $(MKINSTALLDIRS) $(install_exes_dir)
 347         for file in $(install_exes); \
 348   do \
 349     $(INSTALL_EXE) $$file $(install_exes_dir); \
 350   done
 351
 352 install : install-hdrs install-libs install-exes
 353 ifeq ($(enable_stow),yes)
 354         $(MKINSTALLDIRS) $(stow_pkg_dir)
 355         cd $(stow_pkg_dir) && \
 356     $(STOW) --delete $(project_name)-* && \
 357     $(STOW) $(project_name)-$(project_ver)
 358 endif
 359
 360 .PHONY : install install-hdrs install-libs install-exes
 361
 362 #-------------------------------------------------------------------------
 363 # Regenerate configure information
 364 #-------------------------------------------------------------------------
 365
 366 configure_prereq = \
 367   $(src_dir)/configure.ac \
 368   $(src_dir)/aclocal.m4 \
 369   $(join $(addprefix $(src_dir)/, $(sprojs_enabled)), \
 370          $(patsubst  %, /%.ac, $(sprojs_enabled)))
 371
 372 $(src_dir)/configure : $(configure_prereq)
 373         cd $(src_dir) && autoconf && autoheader
 374
 375 config.status : $(src_dir)/configure
 376         ./config.status --recheck
 377
 378 sprojs_mk_in = \
 379   $(join $(addprefix $(src_dir)/, $(sprojs_enabled)), \
 380          $(patsubst  %, /%.mk.in, $(sprojs_enabled)))
 381
 382 Makefile : $(src_dir)/Makefile.in $(sprojs_mk_in) config.status
 383         ./config.status
 384
 385 dist_junk += config.status config.h Makefile config.log
 386
 387 #-------------------------------------------------------------------------
 388 # Distribution
 389 #-------------------------------------------------------------------------
 390 # The distribution tarball is named project-ver.tar.gz and it includes
 391 # both enabled and disabled subprojects.
 392
 393 dist_files = \
 394   $(sprojs) \
 395   README \
 396   style-guide.txt \
 397   mcppbs-uguide.txt \
 398   scripts \
 399   configure.ac \
 400   aclocal.m4 \
 401   configure \
 402   config.h.in \
 403   Makefile.in \
 404
 405 dist_dir := $(project_name)-$(project_ver)
 406 dist_tgz := $(project_name)-$(project_ver).tar.gz
 407
 408 # Notice that when we make the distribution we rewrite the configure.ac
 409 # script with the current version and we rerun autoconf in the new
 410 # source directory so that the distribution will have the proper version
 411 # information. We also rewrite the "Version : " line in the README.
 412
 413 dist :
 414         rm -rf $(dist_dir)
 415         mkdir $(dist_dir)
 416         tar -C $(src_dir) -cf - $(dist_files) | tar -C $(dist_dir) -xpf -
 417         sed -i.bak 's/^\(# Version :\).*/\1 $(project_ver)/' $(dist_dir)/README
 418         sed -i.bak 's/\( proj_version,\).*/\1 [$(project_ver)])/' $(dist_dir)/configure.ac
 419         cd $(dist_dir) && \
 420     autoconf && autoheader && \
 421     rm -rf autom4te.cache configure.ac.bak README.bak
 422         tar -czvf $(dist_tgz) $(dist_dir)
 423         rm -rf $(dist_dir)
 424
 425 # You can use the distcheck target to try untarring the distribution and
 426 # then running configure, make, make check, and make distclean. A
 427 # "directory is not empty" error means distclean is not removing
 428 # everything.
 429
 430 distcheck : dist
 431         rm -rf $(dist_dir)
 432         tar -xzvf $(dist_tgz)
 433         mkdir -p $(dist_dir)/build
 434         cd $(dist_dir)/build; ../configure; make; make check; make distclean
 435         rm -rf $(dist_dir)
 436
 437 junk += $(project_name)-*.tar.gz
 438
 439 .PHONY : dist distcheck
 440
 441 #-------------------------------------------------------------------------
 442 # Default
 443 #-------------------------------------------------------------------------
 444
 445 all : $(install_hdrs) $(install_libs) $(install_exes)
 446 .PHONY : all
 447
 448 #-------------------------------------------------------------------------
 449 # Makefile debugging
 450 #-------------------------------------------------------------------------
 451 # This handy rule will display the contents of any make variable by
 452 # using the target debug-<varname>. So for example, make debug-junk will
 453 # display the contents of the junk variable.
 454
 455 debug-% :
 456         @echo $* = $($*)
 457
 458 #-------------------------------------------------------------------------
 459 # Clean up junk
 460 #-------------------------------------------------------------------------
 461
 462 clean :
 463         rm -rf *~ \#* $(junk)
 464
 465 distclean :
 466         rm -rf *~ \#* $(junk) $(dist_junk)
 467
 468 .PHONY : clean distclean