Makefile

   1 ## Almost Universal Makefile
   2 ## Author: Przemysław Pawełczyk
   3
   4 BINS := \
   5  metastore
   6
   7 LIBS := \
   8
   9 ### Directories
  10 PROJ_DIR := $(dir $(lastword $(MAKEFILE_LIST)))
  11 SRCS_DIR = $(PROJ_DIR)src/
  12 INCS_DIR = $(PROJ_DIR)include/
  13 CFGS_DIR = $(PROJ_DIR)etc/
  14 SHRS_DIR = $(PROJ_DIR)share/
  15 OBJS_DIR = $(PROJ_DIR)obj/
  16 BINS_DIR = $(PROJ_DIR)bin/
  17 LIBS_DIR = $(PROJ_DIR)lib/
  18 DOCS_DIR = $(PROJ_DIR)
  19 MANS_DIR = $(PROJ_DIR)
  20
  21 ###
  22 METASTORE_VER  := $(shell "$(PROJ_DIR)"/version.sh)
  23 UNAME_S        := $(shell uname -s)
  24
  25 ###
  26
  27 DOCS := \
  28  AUTHORS \
  29  FILEFORMAT \
  30  LICENSE.GPLv2 \
  31  NEWS \
  32  README \
  33  metastore.txt \
  34  examples \
  35
  36 metastore_COMP := CC
  37
  38 metastore_SRCS := \
  39  metaentry.c \
  40  metastore.c \
  41  utils.c \
  42
  43 metastore_DLIBS := \
  44
  45 metastore_MANS := \
  46  man1/metastore.1 \
  47
  48 ifeq ($(findstring BSD,$(UNAME_S)),)
  49 ifneq (DragonFly,$(UNAME_S))
  50 ifneq (Darwin,$(UNAME_S))
  51 metastore_DLIBS += -lbsd
  52 endif
  53 endif
  54 endif
  55
  56 PVER := $(PROJ_DIR)Makefile.ver
  57
  58 SDEP := Makefile.dep
  59
  60 -include $(PVER)
  61
  62 # when building from project tree, then always use the same output layout
  63 # otherwise use current working directory
  64 ifneq (,$(findstring ^$(realpath $(PROJ_DIR)),^$(realpath ./)))
  65         SDEP := $(PROJ_DIR)$(SDEP)
  66 else
  67         OBJS_DIR := ./obj/
  68         BINS_DIR := ./bin/
  69         LIBS_DIR := ./lib/
  70 endif
  71
  72
  73 # library name prefix
  74 LIB_PRE := lib
  75 # Dynamic Shared Object extension
  76 DSO_EXT := .so
  77 # Statically-Linked Library extension
  78 SLL_EXT := .a
  79
  80
  81 ### Default target
  82 all:   libs bins
  83
  84 bins:  $(BINS)
  85 libs:  $(LIBS)
  86
  87 ### Flags
  88 MUSTHAVE_FLAGS    := \
  89  -DMETASTORE_VER="\"$(METASTORE_VER)\"" \
  90  -D_FILE_OFFSET_BITS=64 \
  91  -Wall -Wextra -pedantic \
  92  -g \
  93
  94 MUSTHAVE_CFLAGS   := -std=c99
  95 MUSTHAVE_CXXFLAGS := -std=c++11
  96 OPTIONAL_FLAGS    := -O2
  97
  98 ### Install paths
  99 PREFIX := /usr/local
 100 EXECPREFIX := $(PREFIX)
 101 BINDIR := $(EXECPREFIX)/bin
 102 LIBDIR := $(EXECPREFIX)/lib
 103 INCLUDEDIR := $(PREFIX)/include
 104 SYSCONFDIR := $(PREFIX)/etc
 105 DATAROOTDIR := $(PREFIX)/share
 106 DATADIR := $(DATAROOTDIR)
 107 DOCDIR := ${DATAROOTDIR}/doc/metastore
 108 MANDIR := ${DATAROOTDIR}/man
 109
 110 ### Phony targets
 111 .PHONY: \
 112  all bins libs \
 113  strip strip-bins strips-libs \
 114  install install-bins install-libs install-includes \
 115  install-configs install-docs install-mans install-shares \
 116  uninstall uninstall-bins uninstall-libs uninstall-includes \
 117  clean distclean \
 118  dep \
 119  printvars \
 120
 121 ### Debug
 122 printvars:
 123         @$(foreach V, $(sort $(.VARIABLES)), \
 124            $(if $(filter-out environment% default automatic, $(origin $V)), \
 125                 $(warning $V = $(value $V)) \
 126                 $(if $(findstring ^$(value $V)%,^$($V)%),,$(warning $V == $($V))) \
 127            ) \
 128         )
 129
 130 ### Install tools
 131 INSTALL := install
 132 INSTALL_EXEC := $(INSTALL) -m 0755
 133 COPY_NODEREF := cp -P
 134
 135 ### Build tools
 136 DEFCC  := gcc
 137 DEFCXX := g++
 138 ifeq ($(origin CC),default)
 139 CC  := $(DEFCC)
 140 endif
 141 ifeq ($(origin CXX),default)
 142 CXX := $(DEFCXX)
 143 endif
 144 ifneq ($(origin CC),environment)
 145 CC  := $(CROSS_COMPILE)$(CC)
 146 endif
 147 ifneq ($(origin CXX),environment)
 148 CXX := $(CROSS_COMPILE)$(CXX)
 149 endif
 150 ifneq ($(origin CCLD),environment)
 151 CCLD  := $(CC)
 152 endif
 153 ifneq ($(origin CXXLD),environment)
 154 CXXLD := $(CXX)
 155 endif
 156 ifneq ($(origin STRIP),environment)
 157 STRIP := $(CROSS_COMPILE)strip
 158 endif
 159 CC_PARAMS  = $(CFLAGS) $(CPPFLAGS) $(TARGET_ARCH)
 160 CXX_PARAMS = $(CXXFLAGS) $(CPPFLAGS) $(TARGET_ARCH)
 161
 162 ### Final flags
 163 ifneq ($(origin CFLAGS),environment)
 164 CFLAGS   = $(OPTIONAL_FLAGS)
 165 endif
 166 ifneq ($(origin CXXFLAGS),environment)
 167 CXXFLAGS = $(OPTIONAL_FLAGS)
 168 endif
 169 override CFLAGS   += $(MUSTHAVE_FLAGS) $(MUSTHAVE_CFLAGS) \
 170                      $(if $(INCS_DIR),-I$(INCS_DIR),) -I$(SRCS_DIR)
 171 override CXXFLAGS += $(MUSTHAVE_FLAGS) $(MUSTHAVE_CXXFLAGS) \
 172                          $(if $(INCS_DIR),-I$(INCS_DIR),) -I$(SRCS_DIR)
 173
 174 vpath %.h   $(SRCS_DIR) $(INCS_DIR)
 175 vpath %.c   $(SRCS_DIR)
 176 vpath %.cpp $(SRCS_DIR)
 177
 178 ### Support for hiding command-line
 179 V ?= 0
 180 HIDE_0 := @
 181 HIDE_1 :=
 182 HIDE := $(HIDE_$(V))
 183
 184
 185 ### Rules for directories
 186
 187 $(sort $(OBJS_DIR) $(BINS_DIR) $(LIBS_DIR)):
 188         @mkdir -p $@
 189
 190 ### Templated rules
 191
 192 define BIN_template
 193
 194 $(1)_OBJS := $$(addsuffix .o,$$(basename $$($(1)_SRCS)))
 195
 196 $$(BINS_DIR)$(1): \
 197  $$(addsuffix $$(DSO_EXT),$$(addprefix $$(LIBS_DIR)$$(LIB_PRE),$$($(1)_DEPS))) \
 198  $$(addsuffix $$(SLL_EXT),$$(addprefix $$(LIBS_DIR)$$(LIB_PRE),$$($(1)_DEPS))) \
 199  $$(addprefix $$(OBJS_DIR),$$($(1)_OBJS)) $$(SDEP) | $$(BINS_DIR)
 200 ifeq ($$($(1)_COMP),CC)
 201         @echo "        CCLD    $$@"
 202 else
 203         @echo "        CXXLD   $$@"
 204 endif
 205         $$(HIDE)$$($$($(1)_COMP)LD) $$(LDFLAGS) $$(TARGET_ARCH) \
 206           -o $$@ $$(filter %.o,$$^) \
 207           -Wl,-Bstatic $$($(1)_SLIBS) -Wl,-Bdynamic $$($(1)_DLIBS)
 208
 209 $(1): $$(BINS_DIR)$(1)
 210 .PHONY: $(1)
 211
 212 SRCS += $$($(1)_SRCS)
 213 OBJS += $$($(1)_OBJS)
 214
 215 CFGS += $$($(1)_CFGS)
 216 MANS += $$($(1)_MANS)
 217 SHRS += $$($(1)_SHRS)
 218
 219 endef
 220
 221 define LIB_template
 222
 223 $(1)_OBJS := $$(addsuffix .o,$$(basename $$($(1)_SRCS)))
 224
 225 $(1)_SOLINK := $$(LIB_PRE)$(1)$$(DSO_EXT)
 226 $(1)_SONAME := $$(LIB_PRE)$(1)$$(DSO_EXT).$$($(1)_MAJV)
 227 $(1)_SOFILE := $$(LIB_PRE)$(1)$$(DSO_EXT).$$($(1)_MAJV)$$($(1)_MINV)
 228 $(1)_ARFILE := $$(LIB_PRE)$(1)$$(SLL_EXT)
 229
 230 $$(LIBS_DIR)$$($(1)_SOLINK): $$(LIBS_DIR)$$($(1)_SONAME)
 231         @echo "        LN      $$@ -> $$($(1)_SONAME)"
 232         $$(HIDE)(cd "$(LIBS_DIR)" && ln -sf $$($(1)_SONAME) $$($(1)_SOLINK))
 233
 234 ifneq ($$($(1)_SONAME),$$($(1)_SOFILE))
 235 $$(LIBS_DIR)$$($(1)_SONAME): $$(LIBS_DIR)$$($(1)_SOFILE)
 236         @echo "        LN      $$@ -> $$($(1)_SOFILE)"
 237         $$(HIDE)(cd "$$(LIBS_DIR)" && ln -sf $$($(1)_SOFILE) $$($(1)_SONAME))
 238 endif
 239
 240 $$(LIBS_DIR)$$($(1)_SOFILE): \
 241  $$(addsuffix $$(DSO_EXT),$$(addprefix $$(LIBS_DIR)$$(LIB_PRE),$$($(1)_DEPS))) \
 242  $$(addsuffix $$(SLL_EXT),$$(addprefix $$(LIBS_DIR)$$(LIB_PRE),$$($(1)_DEPS))) \
 243  $$(addprefix $$(OBJS_DIR),$$($(1)_OBJS)) $$(SDEP) | $$(LIBS_DIR)
 244 ifeq ($$($(1)_COMP),CC)
 245         @echo "        CCLD    $$@"
 246 else
 247         @echo "        CXXLD   $$@"
 248 endif
 249         $$(HIDE)$$($$($(1)_COMP)LD) $$(LDFLAGS) $$(TARGET_ARCH) \
 250           -shared -Wl,-soname,$$($(1)_SONAME) \
 251           -o $$@ $$(filter %.o,$$^) \
 252           -Wl,-Bstatic $$($(1)_SLIBS) -Wl,-Bdynamic $$($(1)_DLIBS)
 253
 254 $$(LIBS_DIR)$$($(1)_ARFILE): \
 255  $$(addprefix $$(OBJS_DIR),$$($(1)_OBJS)) $$(SDEP) | $$(LIBS_DIR)
 256         @echo "        AR      $$@"
 257         $$(HIDE)$$(AR) r $$@ $$(filter %.o,$$^)
 258
 259 $(1): \
 260  $$(LIBS_DIR)$$($(1)_SOFILE) \
 261  $$(LIBS_DIR)$$($(1)_SOLINK) \
 262  $$(LIBS_DIR)$$($(1)_ARFILE)
 263 .PHONY: $(1)
 264
 265 SRCS += $$($(1)_SRCS)
 266 OBJS += $$($(1)_OBJS)
 267
 268 INCS += $$($(1)_INCS)
 269 CFGS += $$($(1)_CFGS)
 270 MANS += $$($(1)_MANS)
 271 SHRS += $$($(1)_SHRS)
 272
 273 LIBS_FILES += $$($(1)_SOFILE) $$($(1)_ARFILE)
 274 LIBS_ALL_FILES += $$($(1)_SOLINK) $$($(1)_SONAME) $$($(1)_SOFILE) \
 275                   $$($(1)_ARFILE)
 276
 277 endef
 278
 279 $(foreach BIN,$(BINS),$(eval $(call BIN_template,$(BIN))))
 280
 281 $(foreach LIB,$(LIBS),$(eval $(call LIB_template,$(LIB))))
 282
 283
 284 ### Rules for normal targets
 285
 286 $(OBJS_DIR)%.o: %.c
 287         @echo "        CC      $@"
 288         $(HIDE)mkdir -p $(dir $@)
 289         $(HIDE)$(CC) $(CC_PARAMS) -c -o $@ $<
 290
 291 $(OBJS_DIR)%.o: %.cpp
 292         @echo "        CXX     $@"
 293         $(HIDE)mkdir -p $(dir $@)
 294         $(HIDE)$(CXX) $(CXX_PARAMS) -c -o $@ $<
 295
 296 $(SDEP): SRCS_PATH := $(SRCS_DIR)
 297 $(SDEP): SRCS_DIR := ./
 298 $(SDEP): PROJ_DIR := ../
 299 $(SDEP): $(SRCS) $(PROJ_DIR)Makefile
 300         @echo "        DEPS";
 301         $(HIDE)echo "# This file is automatically (re)generated by make." >$(SDEP)
 302         $(HIDE)echo >>$(SDEP)
 303         $(HIDE)(cd "$(SRCS_PATH)" && for FILE in $(SRCS); do \
 304                 if [ "$${FILE##*.}" = "c" ]; then \
 305                         $(CC) $(CFLAGS) -MT "\$$(OBJS_DIR)$${FILE%.*}.o" -MM "$$FILE"; \
 306                 else \
 307                         $(CXX) $(CXXFLAGS) -MT "\$$(OBJS_DIR)$${FILE%.*}.o" -MM "$$FILE"; \
 308                 fi \
 309         done) >>$(SDEP)
 310
 311 $(DOCS_DIR)%.txt: $(MANS_DIR)/man1/%.1
 312         @echo "        GROFF   $@"
 313         $(HIDE)groff -mandoc -Kutf8 -Tutf8 $^ | col -bx >$@
 314
 315
 316 ### Rules for phony targets
 317
 318 clean:
 319         @echo "        CLEAN"
 320         $(HIDE)$(RM) $(addprefix $(BINS_DIR),$(BINS)) \
 321                      $(addprefix $(LIBS_DIR),$(LIBS_ALL_FILES)) \
 322                      $(addprefix $(OBJS_DIR),$(OBJS)) \
 323                      $(SDEP)
 324
 325 distclean: clean
 326         $(HIDE)(find \
 327                 $(OBJS_DIR) \
 328                 $(LIBS_DIR) \
 329                 $(BINS_DIR) \
 330                 -type d -exec rmdir --parents {} \; \
 331                 2>/dev/null ; exit 0)
 332
 333 dep: $(SDEP)
 334
 335 strip: strip-bins strip-libs
 336
 337 strip-bins: $(addprefix $(BINS_DIR),$(BINS))
 338 ifneq ($(strip $(BINS)),)
 339         @echo "        STRIP   $^"
 340         $(HIDE)$(STRIP) $^
 341 endif
 342
 343 strip-libs: $(addprefix $(LIBS_DIR),$(LIBS_FILES))
 344 ifneq ($(strip $(LIBS)),)
 345         @echo "        STRIP   $^"
 346         $(HIDE)$(STRIP) $^
 347 endif
 348
 349 install: install-bins install-libs install-includes \
 350          install-configs install-docs install-mans install-shares \
 351
 352 install-bins: $(addprefix $(BINS_DIR),$(BINS))
 353 ifneq ($(strip $(BINS)),)
 354         @echo "        INSTALL $^"
 355         $(HIDE)$(INSTALL) -d $(DESTDIR)$(BINDIR)
 356         $(HIDE)$(INSTALL_EXEC) \
 357                 $(addprefix $(BINS_DIR),$(BINS)) \
 358                 $(DESTDIR)$(BINDIR)/
 359 endif
 360
 361 install-libs: $(addprefix $(LIBS_DIR),$(LIBS_ALL_FILES))
 362 ifneq ($(strip $(LIBS)),)
 363         @echo "        INSTALL $^"
 364         $(HIDE)$(INSTALL) -d $(DESTDIR)$(LIBDIR)
 365         $(HIDE)$(COPY_NODEREF) \
 366                 $(addprefix $(LIBS_DIR),$(LIBS_ALL_FILES)) \
 367                 $(DESTDIR)$(LIBDIR)/
 368 endif
 369
 370 install-includes: $(addprefix $(INCS_DIR),$(INCS))
 371 ifneq ($(strip $(INCS)),)
 372         @echo "        INSTALL $^"
 373         $(HIDE)$(INSTALL) -d $(DESTDIR)$(INCLUDEDIR)
 374         $(HIDE)( cd $(INCS_DIR) && $(COPY_NODEREF) --parents \
 375                 $(INCS) \
 376                 $(DESTDIR)$(INCLUDEDIR)/ \
 377         )
 378 endif
 379
 380 install-configs: $(addprefix $(CFGS_DIR),$(CFGS))
 381 ifneq ($(strip $(CFGS)),)
 382         @echo "        INSTALL $^"
 383         $(HIDE)$(INSTALL) -d $(DESTDIR)$(SYSCONFDIR)
 384         $(HIDE)( cd $(CFGS_DIR) && $(COPY_NODEREF) --parents \
 385                 $(CFGS) \
 386                 $(DESTDIR)$(SYSCONFDIR)/ \
 387         )
 388 endif
 389
 390 install-docs: $(addprefix $(DOCS_DIR),$(DOCS))
 391 ifneq ($(strip $(DOCS)),)
 392         @echo "        INSTALL $^"
 393         $(HIDE)$(INSTALL) -d $(DESTDIR)$(DOCDIR)
 394         $(HIDE)( cd $(DOCS_DIR) && $(COPY_NODEREF) --parents -r \
 395                 $(DOCS) \
 396                 $(DESTDIR)$(DOCDIR)/ \
 397         )
 398 endif
 399
 400 install-mans: $(addprefix $(MANS_DIR),$(MANS))
 401 ifneq ($(strip $(MANS)),)
 402         @echo "        INSTALL $^"
 403         $(HIDE)$(INSTALL) -d $(DESTDIR)$(MANDIR)
 404         $(HIDE)( cd $(MANS_DIR) && $(COPY_NODEREF) --parents \
 405                 $(MANS) \
 406                 $(DESTDIR)$(MANDIR)/ \
 407         )
 408 endif
 409
 410 install-shares: $(addprefix $(SHRS_DIR),$(SHRS))
 411 ifneq ($(strip $(SHRS)),)
 412         @echo "        INSTALL $^"
 413         $(HIDE)$(INSTALL) -d $(DESTDIR)$(DATADIR)
 414         $(HIDE)( cd $(SHRS_DIR) && $(COPY_NODEREF) --parents \
 415                 $(SHRS) \
 416                 $(DESTDIR)$(DATADIR)/ \
 417         )
 418 endif
 419
 420 uninstall: uninstall-bins uninstall-libs uninstall-includes \
 421            uninstall-docs uninstall-mans uninstall-shares \
 422
 423 uninstall-bins:
 424 ifneq ($(strip $(BINS)),)
 425         @echo "        UNINST  $(addprefix $(DESTDIR)$(BINDIR)/,$(BINS))"
 426         $(HIDE)$(RM) $(addprefix $(DESTDIR)$(BINDIR)/,$(BINS))
 427 endif
 428
 429 uninstall-libs:
 430 ifneq ($(strip $(LIBS)),)
 431         @echo "        UNINST  $(addprefix $(DESTDIR)$(LIBDIR)/,$(LIBS_ALL_FILES))"
 432         $(HIDE)$(RM) $(addprefix $(DESTDIR)$(LIBDIR)/,$(LIBS_ALL_FILES))
 433 endif
 434
 435 uninstall-includes:
 436 ifneq ($(strip $(INCS)),)
 437         @echo "        UNINST  $(addprefix $(DESTDIR)$(INCLUDEDIR)/,$(INCS))"
 438         $(HIDE)$(RM) $(addprefix $(DESTDIR)$(INCLUDEDIR)/,$(INCS))
 439 endif
 440
 441 uninstall-docs:
 442 ifneq ($(strip $(DOCS)),)
 443         @echo "        UNINST  $(addprefix $(DESTDIR)$(DOCDIR)/,$(DOCS))"
 444         $(HIDE)$(RM) -r $(addprefix $(DESTDIR)$(DOCDIR)/,$(DOCS))
 445 endif
 446
 447 uninstall-mans:
 448 ifneq ($(strip $(MANS)),)
 449         @echo "        UNINST  $(addprefix $(DESTDIR)$(MANDIR)/,$(MANS))"
 450         $(HIDE)$(RM) $(addprefix $(DESTDIR)$(MANDIR)/,$(MANS))
 451 endif
 452
 453 uninstall-shares:
 454 ifneq ($(strip $(SHRS)),)
 455         @echo "        UNINST  $(addprefix $(DESTDIR)$(DATADIR)/,$(SHRS))"
 456         $(HIDE)$(RM) $(addprefix $(DESTDIR)$(DATADIR)/,$(SHRS))
 457 endif
 458
 459
 460 ### Dependencies
 461 ifneq ($(MAKECMDGOALS),distclean)
 462 ifneq ($(MAKECMDGOALS),clean)
 463 -include $(SDEP)
 464 endif
 465 endif