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
  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
  85 CC            := @CC@
  86 CXX           := @CXX@
  87 CFLAGS        += @CFLAGS@ -DPREFIX=\"$(prefix)\"
  88 CPPFLAGS      += @CPPFLAGS@
  89 CXXFLAGS      += @CXXFLAGS@ -DPREFIX=\"$(prefix)\"
  90 COMPILE       := $(CXX) -fPIC -MMD -MP $(CPPFLAGS) $(CFLAGS) $(CXXFLAGS) \
  91                  $(sprojs_include)
  92 COMPILE_C     := $(CC) -fPIC -MMD -MP $(CPPFLAGS) $(CFLAGS) \
  93                  $(sprojs_include)
  94 # Linker
  95 #  - LDFLAGS : Flags for the linker (eg. -L)
  96 #  - LIBS    : Library flags (eg. -l)
  97
  98 comma := ,
  99 LD            := $(CXX)
 100 LDFLAGS       := @LDFLAGS@
 101 LIBS          := @LIBS@
 102 LINK          := $(LD) -L. $(LDFLAGS) -Wl,-rpath,$(install_libs_dir) $(patsubst -L%,-Wl$(comma)-rpath$(comma)%,$(filter -L%,$(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 $$($(2)_gen_hdrs)
 192         $(COMPILE) -c $$<
 193 $$($(2)_c_objs) : %.o : %.c $$($(2)_gen_hdrs)
 194         $(COMPILE_C) -c $$<
 195
 196 $(2)_junk += $$($(2)_objs) $$($(2)_c_objs) $$($(2)_deps) $$($(2)_c_deps) $$($(2)_gen_hdrs)
 197
 198 # Reverse the dependency list so that a given subproject only depends on
 199 # subprojects listed to its right. This is the correct order for linking
 200 # the list of subproject libraries.
 201
 202 $(2)_reverse_deps   := $$(call reverse_list,$$($(2)_subproject_deps))
 203
 204 # Build a library for this subproject
 205
 206 $(2)_lib_libs       := $$($(2)_reverse_deps)
 207 $(2)_lib_libnames   := $$(patsubst %, lib%.so, $$($(2)_lib_libs))
 208 $(2)_lib_libarg     := $$(patsubst %, -l%, $$($(2)_lib_libs))
 209
 210 lib$(1).so : $$($(2)_objs) $$($(2)_c_objs) $$($(2)_lib_libnames)
 211         $(LINK) -shared -o $$@ $(if $(filter Darwin,$(shell uname -s)),-install_name $(install_libs_dir)/$$@) $$^ $$($(2)_lib_libarg) $(LIBS)
 212
 213 $(2)_junk += lib$(1).so
 214
 215 # Build unit tests
 216
 217 $(2)_test_objs      := $$(patsubst %.cc, %.o, $$($(2)_test_srcs))
 218 $(2)_test_deps      := $$(patsubst %.o, %.d, $$($(2)_test_objs))
 219 $(2)_test_exes      := $$(patsubst %.t.cc, %-utst, $$($(2)_test_srcs))
 220 $(2)_test_outs      := $$(patsubst %, %.out, $$($(2)_test_exes))
 221 $(2)_test_libs      := $(1) $$($(2)_reverse_deps) utst
 222 $(2)_test_libnames  := $$(patsubst %, lib%.so, $$($(2)_test_libs))
 223 $(2)_test_libarg    := $$(patsubst %, -l%, $$($(2)_test_libs))
 224
 225 $$($(2)_test_objs) : %.o : %.cc
 226         $(COMPILE) -c $$<
 227
 228 $$($(2)_test_exes) : %-utst : %.t.o $$($(2)_test_libnames)
 229         $(LINK) -o $$@ $$< $$($(2)_test_libarg) $(LIBS)
 230
 231 $(2)_deps += $$($(2)_test_deps)
 232 $(2)_junk += \
 233         $$($(2)_test_objs) $$($(2)_test_deps) \
 234   $$($(2)_test_exes) *.junk-dat
 235
 236 # Run unit tests
 237
 238 $$($(2)_test_outs) : %.out : %
 239         $(RUN) $(RUNFLAGS) ./$$< default | tee $$@
 240
 241 $(2)_junk += $$($(2)_test_outs)
 242
 243 # Build programs
 244
 245 $(2)_prog_objs      := $$(patsubst %.cc, %.o, $$($(2)_prog_srcs))
 246 $(2)_prog_deps      := $$(patsubst %.o, %.d, $$($(2)_prog_objs))
 247 $(2)_prog_exes      := $$(patsubst %.cc, %, $$($(2)_prog_srcs))
 248 $(2)_prog_libs      := $(1) $$($(2)_reverse_deps)
 249 $(2)_prog_libnames  := $$(patsubst %, lib%.so, $$($(2)_prog_libs))
 250 $(2)_prog_libarg    := $$(patsubst %, -l%, $$($(2)_prog_libs))
 251
 252 $$($(2)_prog_objs) : %.o : %.cc
 253         $(COMPILE) -c $$<
 254
 255 $$($(2)_prog_exes) : % : %.o $$($(2)_prog_libnames)
 256         $(LINK) -o $$@ $$< $$($(2)_prog_libarg) $(LIBS)
 257
 258 $(2)_deps += $$($(2)_prog_deps)
 259 $(2)_junk += $$($(2)_prog_objs) $$($(2)_prog_deps) $$($(2)_prog_exes)
 260
 261 # Build programs which will be installed
 262
 263 $(2)_install_prog_objs := $$(patsubst %.cc, %.o, $$($(2)_install_prog_srcs))
 264 $(2)_install_prog_deps := $$(patsubst %.o, %.d, $$($(2)_install_prog_objs))
 265 $(2)_install_prog_exes := $$(patsubst %.cc, %, $$($(2)_install_prog_srcs))
 266
 267 $$($(2)_install_prog_objs) : %.o : %.cc $$($(2)_gen_hdrs)
 268         $(COMPILE) -c $$<
 269
 270 $$($(2)_install_prog_exes) : % : %.o $$($(2)_prog_libnames)
 271         $(LINK) -o $$@ $$< $$($(2)_prog_libarg) $(LIBS)
 272
 273 $(2)_deps += $$($(2)_install_prog_deps)
 274 $(2)_junk += \
 275   $$($(2)_install_prog_objs) $$($(2)_install_prog_deps) \
 276   $$($(2)_install_prog_exes)
 277
 278 # Subproject specific targets
 279
 280 all-$(1) : lib$(1).so $$($(2)_install_prog_exes)
 281
 282 check-$(1) : $$($(2)_test_outs)
 283         echo; grep -h -e'Unit Tests' -e'FAILED' -e'Segementation' $$^; echo
 284
 285 clean-$(1) :
 286         rm -rf $$($(2)_junk)
 287
 288 .PHONY : all-$(1) check-$(1) clean-$(1)
 289
 290 # Update running variables
 291
 292 libs += lib$(1).so
 293 objs += $$($(2)_objs)
 294 srcs += $$(addprefix $(src_dir)/$(1)/, $$($(2)_srcs))
 295 hdrs += $$(addprefix $(src_dir)/$(1)/, $$($(2)_hdrs)) $$($(2)_gen_hdrs)
 296 junk += $$($(2)_junk)
 297 deps += $$($(2)_deps)
 298
 299 test_outs += $$($(2)_test_outs)
 300
 301 install_hdrs += $$(addprefix $(src_dir)/$(1)/, $$($(2)_hdrs)) $$($(2)_gen_hdrs)
 302 install_libs += lib$(1).so
 303 install_exes += $$($(2)_install_prog_exes)
 304
 305 endef
 306
 307 # Iterate over the subprojects and call the template for each one
 308
 309 $(foreach sproj,$(sprojs_enabled), \
 310   $(eval $(call subproject_template,$(sproj),$(subst -,_,$(sproj)))))
 311
 312 #-------------------------------------------------------------------------
 313 # Autodependency files
 314 #-------------------------------------------------------------------------
 315
 316 -include $(deps)
 317
 318 deps : $(deps)
 319 .PHONY : deps
 320
 321 #-------------------------------------------------------------------------
 322 # Check
 323 #-------------------------------------------------------------------------
 324
 325 check : $(test_outs)
 326         echo; grep -h -e'Unit Tests' -e'FAILED' -e'Segementation' $^; echo
 327
 328 .PHONY : check
 329
 330 #-------------------------------------------------------------------------
 331 # Installation
 332 #-------------------------------------------------------------------------
 333
 334 install-hdrs : $(install_hdrs)
 335         $(MKINSTALLDIRS) $(install_hdrs_dir)
 336         for file in $^; \
 337   do \
 338     $(INSTALL_HDR) $$file $(install_hdrs_dir); \
 339   done
 340
 341 install-libs : $(install_libs)
 342         $(MKINSTALLDIRS) $(install_libs_dir)
 343         for file in $^; \
 344   do \
 345     $(INSTALL_LIB) $$file $(install_libs_dir); \
 346   done
 347
 348 install-exes : $(install_exes)
 349         $(MKINSTALLDIRS) $(install_exes_dir)
 350         for file in $^; \
 351   do \
 352     $(INSTALL_EXE) $$file $(install_exes_dir); \
 353   done
 354
 355 install : install-hdrs install-libs install-exes
 356 ifeq ($(enable_stow),yes)
 357         $(MKINSTALLDIRS) $(stow_pkg_dir)
 358         cd $(stow_pkg_dir) && \
 359     $(STOW) --delete $(project_name)-* && \
 360     $(STOW) $(project_name)-$(project_ver)
 361 endif
 362
 363 .PHONY : install install-hdrs install-libs install-exes
 364
 365 #-------------------------------------------------------------------------
 366 # Regenerate configure information
 367 #-------------------------------------------------------------------------
 368
 369 configure_prereq = \
 370   $(src_dir)/configure.ac \
 371   $(src_dir)/aclocal.m4 \
 372   $(join $(addprefix $(src_dir)/, $(sprojs_enabled)), \
 373          $(patsubst  %, /%.ac, $(sprojs_enabled)))
 374
 375 $(src_dir)/configure : $(configure_prereq)
 376         cd $(src_dir) && autoconf && autoheader
 377
 378 config.status : $(src_dir)/configure
 379         ./config.status --recheck
 380
 381 sprojs_mk_in = \
 382   $(join $(addprefix $(src_dir)/, $(sprojs_enabled)), \
 383          $(patsubst  %, /%.mk.in, $(sprojs_enabled)))
 384
 385 Makefile : $(src_dir)/Makefile.in $(sprojs_mk_in) config.status
 386         ./config.status
 387
 388 dist_junk += config.status config.h Makefile config.log
 389
 390 #-------------------------------------------------------------------------
 391 # Distribution
 392 #-------------------------------------------------------------------------
 393 # The distribution tarball is named project-ver.tar.gz and it includes
 394 # both enabled and disabled subprojects.
 395
 396 dist_files = \
 397   $(sprojs) \
 398   README \
 399   style-guide.txt \
 400   mcppbs-uguide.txt \
 401   scripts \
 402   configure.ac \
 403   aclocal.m4 \
 404   configure \
 405   config.h.in \
 406   Makefile.in \
 407
 408 dist_dir := $(project_name)-$(project_ver)
 409 dist_tgz := $(project_name)-$(project_ver).tar.gz
 410
 411 # Notice that when we make the distribution we rewrite the configure.ac
 412 # script with the current version and we rerun autoconf in the new
 413 # source directory so that the distribution will have the proper version
 414 # information. We also rewrite the "Version : " line in the README.
 415
 416 dist :
 417         rm -rf $(dist_dir)
 418         mkdir $(dist_dir)
 419         tar -C $(src_dir) -cf - $(dist_files) | tar -C $(dist_dir) -xpf -
 420         sed -i.bak 's/^\(# Version :\).*/\1 $(project_ver)/' $(dist_dir)/README
 421         sed -i.bak 's/\( proj_version,\).*/\1 [$(project_ver)])/' $(dist_dir)/configure.ac
 422         cd $(dist_dir) && \
 423     autoconf && autoheader && \
 424     rm -rf autom4te.cache configure.ac.bak README.bak
 425         tar -czvf $(dist_tgz) $(dist_dir)
 426         rm -rf $(dist_dir)
 427
 428 # You can use the distcheck target to try untarring the distribution and
 429 # then running configure, make, make check, and make distclean. A
 430 # "directory is not empty" error means distclean is not removing
 431 # everything.
 432
 433 distcheck : dist
 434         rm -rf $(dist_dir)
 435         tar -xzvf $(dist_tgz)
 436         mkdir -p $(dist_dir)/build
 437         cd $(dist_dir)/build; ../configure; make; make check; make distclean
 438         rm -rf $(dist_dir)
 439
 440 junk += $(project_name)-*.tar.gz
 441
 442 .PHONY : dist distcheck
 443
 444 #-------------------------------------------------------------------------
 445 # Default
 446 #-------------------------------------------------------------------------
 447
 448 all : $(install_hdrs) $(install_libs) $(install_exes)
 449 .PHONY : all
 450
 451 #-------------------------------------------------------------------------
 452 # Makefile debugging
 453 #-------------------------------------------------------------------------
 454 # This handy rule will display the contents of any make variable by
 455 # using the target debug-<varname>. So for example, make debug-junk will
 456 # display the contents of the junk variable.
 457
 458 debug-% :
 459         @echo $* = $($*)
 460
 461 #-------------------------------------------------------------------------
 462 # Clean up junk
 463 #-------------------------------------------------------------------------
 464
 465 clean :
 466         rm -rf *~ \#* $(junk)
 467
 468 distclean :
 469         rm -rf *~ \#* $(junk) $(dist_junk)
 470
 471 .PHONY : clean distclean