Simplify the debugging functions

[Project_algorithmic_C.git] / Makefile

# Sample Makefile to build simple project.
#
# This Makefile expect all source files (.c) to be at the same level, in the
# $(SRC_PATH) directory.
#
# This Makefile expect all embedded library source files (.c) to be at the same level, in the
# $(LIBRARY_PATH) directory.
#
# It will automatically generate dependencies, compile all files, and produce a
# binary using the provided name linked against the library if necessary.
#
# Set BINARY_NAME to the name of the binary file to build.
# Set LIBRARY_NAME to the name of the library file to build.
# The default path for the library code and object is lib.
# By default the linker will look for $(BINARY_NAME) library name.
# Set BUILD_TYPE to either debug or release.
#
# Automatic dependencies code from:
# http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/#tldr
BINARY_NAME:=othello
SRC_PATH:=src
LIBRARY_NAME:=lib$(BINARY_NAME)
LIBRARY_PATH:=lib
LDLIBS:=-l$(BINARY_NAME) -lncurses -ltinfo
#BUILD_TYPE:=debug
BUILD_TYPE:=release

# ====================================
# DO NOT CHANGE STUFF BEYOND THIS LINE
# ====================================

CC=gcc
LD=gcc
AR=ar

WARN_FLAGS = -Wall -Wextra
STD_FLAG = -std=c11
UNAME := $(shell uname -s)

ifeq ($(BUILD_TYPE),debug)
BUILDDIR := .build/debug
DEBUG_FLAG = -g
DEBUG = 1
STRIP_FLAG =
OPTI_FLAG = -O0
LTO_SUPPORT = yes
GOLD_SUPPORT = yes
else
BUILDDIR := .build/release
DEBUG_FLAG =
DEBUG = 0
STRIP_FLAG = -s
OPTI_FLAG = -O3
LTO_SUPPORT = yes
GOLD_SUPPORT = yes
endif

BINARY_SUFFIX :=
DLIB_PREFIX :=
SDLIB_PREFIX :=
SHLIBLDFLAG := -shared
DLIB_SUFFIX := .so
SLIB_SUFFIX := .a

OBJDIR := $(BUILDDIR)/objs
$(shell mkdir -p $(OBJDIR))

SRCS=$(wildcard $(SRC_PATH)/*.c)
LIBSRCS=$(wildcard $(LIBRARY_PATH)/*.c)
OBJS=$(patsubst %.c,$(OBJDIR)/%.o,$(notdir $(SRCS)))
LIBOBJS=$(patsubst %.c,$(OBJDIR)/%.o,$(notdir $(LIBSRCS)))

DEPDIR := $(BUILDDIR)/deps
$(shell mkdir -p $(DEPDIR))
DEPFLAGS = -MT $@ -MMD -MP -MF $(DEPDIR)/$(notdir $*).Td
POSTCOMPILE = mv -f $(DEPDIR)/$(notdir $*).Td $(DEPDIR)/$(notdir $*).d

ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
CYGWIN_DLIBRARY_NAME := $(subst lib,cyg,$(LIBRARY_NAME))
GOLD_SUPPORT = no
# Cygwin ncurses do not contain tinfo
LDLIBS := $(filter-out -ltinfo,$(LDLIBS))
BINARY_SUFFIX := .exe
DLIB_SUFFIX := .dll
# do not archive external libraries
CYGWIN_LDLIBS_NOARCHIVE := $(filter-out -l$(BINARY_NAME),$(LDLIBS))
CYGWIN_LIBLDFLAGS := -Wl,--out-implib=$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a \
    -Wl,--export-all-symbols \
    -Wl,--enable-auto-import
endif

ifeq ($(UNAME),Darwin)
SHLIBLDFLAG=-dynamiclib
LDLIBS := $(filter-out -ltinfo,$(LDLIBS))
DLIB_SUFFIX=.dylib
LTO_SUPPORT=no
GOLD_SUPPORT=no
endif

ifeq ($(LTO_SUPPORT),yes)
CFLAGS_LTO = -flto -ffat-lto-objects
LDFLAGS_LTO = -fuse-linker-plugin -flto
endif

ifeq ($(GOLD_SUPPORT),yes)
LDFLAGS_GOLD = -fuse-ld=gold
endif

# Putting header files in the source directory is not the purpose of this INCLUDES_PATH variable
INCLUDES_PATH := $(INCLUDES_PATH) -I$(LIBRARY_PATH)
CFLAGS := -DDEBUG=$(DEBUG) $(CFLAGS) $(CFLAGS_LTO) $(WARN_FLAGS) $(STD_FLAG) $(OPTI_FLAG) $(DEBUG_FLAG) $(INCLUDES_PATH)
LIBCFLAGS := -fPIC $(CFLAGS)
LDFLAGS := $(LDFLAGS) $(LDFLAGS_LTO) $(LDFLAGS_GOLD) $(STRIP_FLAG)
LIBLDFLAGS := $(SHLIBLDFLAG) $(LDFLAGS)
STATICLIBLDFLAGS := -static $(LDFLAGS)
LDLIBS := $(LDLIBS) -L$(LIBRARY_PATH)

# Mac OS X do not support static linking
ifeq ($(UNAME),Darwin)
all: $(BINARY_NAME)$(BINARY_SUFFIX) $(BINARY_NAME).dynamic$(BINARY_SUFFIX)
else
all: $(BINARY_NAME)$(BINARY_SUFFIX) $(BINARY_NAME).dynamic$(BINARY_SUFFIX) $(BINARY_NAME).static$(BINARY_SUFFIX)
endif

$(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX): $(LIBOBJS)
	@echo "[AR StO] $@"
	@$(AR) rcs $@ $^

ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a: $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX)
$(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS)
	@echo "[LD DLL] $@"
	@$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $(CYGWIN_LIBLDFLAGS) -Wl,--whole-archive $^ -Wl,--no-whole-archive $(CYGWIN_LDLIBS_NOARCHIVE) -o $@
else
$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS)
	@echo "[LD ShO] $@"
	@$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $^ $(LDLIBS) -o $@
endif

#$(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBOBJS)
#	@echo "[LD ] $@"
#	@$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@

$(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
	@echo "[LD ] $@"
	@$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@

$(BINARY_NAME).static$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
	@echo "[LD ] $@"
	@$(LD) $(CFLAGS) $(STATICLIBLDFLAGS) $^ $(LDLIBS) -o $@

ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
$(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a
else
$(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)
endif
	@echo "[LD ] $@"
	@$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@

$(OBJDIR)/%.o: $(SRC_PATH)/%.c $(DEPDIR)/%.d
	@echo "[C  ] $(notdir $*)"
	@$(CC) $(DEPFLAGS) $(CFLAGS) -c $< -o $@
	@$(POSTCOMPILE)

include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(SRCS))))

$(OBJDIR)/%.o: $(LIBRARY_PATH)/%.c $(DEPDIR)/%.d
	@echo "[C  ] $(notdir $*)"
	@$(CC) $(DEPFLAGS) $(LIBCFLAGS) -c $< -o $@
	@$(POSTCOMPILE)

include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(LIBSRCS))))

$(DEPDIR)/%.d: ;

.PRECIOUS: $(DEPDIR)/%.d

#FIXME: add an install target

clean:
	@echo "[CLN]"
	-@rm -r $(BUILDDIR)
	-@rm $(BINARY_NAME)$(BINARY_SUFFIX)
ifneq ($(UNAME),Darwin)
	-@rm $(BINARY_NAME).static$(BINARY_SUFFIX)
endif
	-@rm $(BINARY_NAME).dynamic$(BINARY_SUFFIX)
	-@rm $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
	-@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX)
	-@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a
else
	-@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)
endif

run: $(BINARY_NAME)
	./$(BINARY_NAME)

disassemble: $(BINARY_NAME)$(BINARY_SUFFIX)
	objdump -d $< | less

symbols: $(BINARY_NAME)$(BINARY_SUFFIX)
	objdump -t $< | sort | less