1 # Sample Makefile to build simple project.
3 # This Makefile expect all source files (.c) to be at the same level, in the
4 # $(SRC_PATH) directory.
6 # This Makefile expect all embedded library source files (.c) to be at the same level, in the
7 # $(LIBRARY_PATH) directory.
9 # It will automatically generate dependencies, compile all files, and produce a
10 # binary using the provided name linked against the library if necessary.
12 # Set BINARY_NAME to the name of the binary file to build.
13 # Set LIBRARY_NAME to the name of the library file to build.
14 # The default path for the library code and object is lib.
15 # By default the linker will look for $(BINARY_NAME) library name.
16 # Set BUILD_TYPE to either debug or release.
18 # Automatic dependencies code from:
19 # http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/#tldr
22 LIBRARY_NAME:=lib$(BINARY_NAME)
24 LDLIBS:=-l$(BINARY_NAME) -lncurses -ltinfo
28 # ====================================
29 # DO NOT CHANGE STUFF BEYOND THIS LINE
30 # ====================================
36 WARN_FLAGS = -Wall -Wextra
38 UNAME := $(shell uname -s)
40 ifeq ($(BUILD_TYPE),debug)
41 BUILDDIR := .build/debug
48 BUILDDIR := .build/release
59 SHLIBLDFLAG := -shared
63 OBJDIR := $(BUILDDIR)/objs
64 $(shell mkdir -p $(OBJDIR))
66 SRCS=$(wildcard $(SRC_PATH)/*.c)
67 LIBSRCS=$(wildcard $(LIBRARY_PATH)/*.c)
68 OBJS=$(patsubst %.c,$(OBJDIR)/%.o,$(notdir $(SRCS)))
69 LIBOBJS=$(patsubst %.c,$(OBJDIR)/%.o,$(notdir $(LIBSRCS)))
71 DEPDIR := $(BUILDDIR)/deps
72 $(shell mkdir -p $(DEPDIR))
73 DEPFLAGS = -MT $@ -MMD -MP -MF $(DEPDIR)/$(notdir $*).Td
74 POSTCOMPILE = mv -f $(DEPDIR)/$(notdir $*).Td $(DEPDIR)/$(notdir $*).d
76 ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
77 CYGWIN_DLIBRARY_NAME := $(subst lib,cyg,$(LIBRARY_NAME))
79 # Cygwin ncurses do not contain tinfo
80 LDLIBS := $(filter-out -ltinfo,$(LDLIBS))
83 # do not archive external libraries
84 CYGWIN_LDLIBS_NOARCHIVE := $(filter-out -l$(BINARY_NAME),$(LDLIBS))
85 CYGWIN_LIBLDFLAGS := -Wl,--out-implib=$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)$(SLIB_SUFFIX) \
86 -Wl,--export-all-symbols \
87 -Wl,--enable-auto-import
90 ifeq ($(UNAME),Darwin)
91 SHLIBLDFLAG=-dynamiclib
92 LDLIBS := $(filter-out -ltinfo,$(LDLIBS))
98 ifeq ($(LTO_SUPPORT),yes)
99 CFLAGS_LTO = -flto -ffat-lto-objects
100 LDFLAGS_LTO = -fuse-linker-plugin -flto
103 ifeq ($(GOLD_SUPPORT),yes)
104 LDFLAGS_GOLD = -fuse-ld=gold
107 # Putting header files in the source directory is not the purpose of this INCLUDES_PATH variable
108 INCLUDES_PATH := $(INCLUDES_PATH) -I$(LIBRARY_PATH)
109 CFLAGS := $(CFLAGS) $(CFLAGS_LTO) $(WARN_FLAGS) $(STD_FLAG) $(OPTI_FLAG) $(DEBUG_FLAG) $(INCLUDES_PATH)
110 LIBCFLAGS := -fPIC $(CFLAGS)
111 LDFLAGS := $(LDFLAGS) $(LDFLAGS_LTO) $(LDFLAGS_GOLD) $(STRIP_FLAG)
112 LIBLDFLAGS := $(SHLIBLDFLAG) $(LDFLAGS)
113 STATICLIBLDFLAGS := -static $(LDFLAGS)
114 LDLIBS := $(LDLIBS) -L$(LIBRARY_PATH)
116 # Mac OS X do not support static linking
117 ifeq ($(UNAME),Darwin)
118 all: $(BINARY_NAME)$(BINARY_SUFFIX) $(BINARY_NAME).dynamic$(BINARY_SUFFIX)
120 all: $(BINARY_NAME)$(BINARY_SUFFIX) $(BINARY_NAME).dynamic$(BINARY_SUFFIX) $(BINARY_NAME).static$(BINARY_SUFFIX)
123 $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX): $(LIBOBJS)
127 ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
128 $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)$(SLIB_SUFFIX): $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX)
129 $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS)
131 @$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $(CYGWIN_LIBLDFLAGS) -Wl,--whole-archive $^ -Wl,--no-whole-archive $(CYGWIN_LDLIBS_NOARCHIVE) -o $@
133 $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS)
135 @$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $^ $(LDLIBS) -o $@
138 #$(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBOBJS)
140 # @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
142 $(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
144 @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
146 $(BINARY_NAME).static$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
148 @$(LD) $(CFLAGS) $(STATICLIBLDFLAGS) $^ $(LDLIBS) -o $@
150 ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
151 $(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)$(SLIB_SUFFIX)
153 $(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)
156 @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@
158 $(OBJDIR)/%.o: $(SRC_PATH)/%.c $(DEPDIR)/%.d
159 @echo "[C ] $(notdir $*)"
160 @$(CC) $(DEPFLAGS) $(CFLAGS) -c $< -o $@
163 include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(SRCS))))
165 $(OBJDIR)/%.o: $(LIBRARY_PATH)/%.c $(DEPDIR)/%.d
166 @echo "[C ] $(notdir $*)"
167 @$(CC) $(DEPFLAGS) $(LIBCFLAGS) -c $< -o $@
170 include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(LIBSRCS))))
174 .PRECIOUS: $(DEPDIR)/%.d
176 #FIXME: add an install target
181 -@rm $(BINARY_NAME)$(BINARY_SUFFIX)
182 ifneq ($(UNAME),Darwin)
183 -@rm $(BINARY_NAME).static$(BINARY_SUFFIX)
185 -@rm $(BINARY_NAME).dynamic$(BINARY_SUFFIX)
186 -@rm $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX)
187 ifeq ($(findstring CYGWIN_NT,$(UNAME)),CYGWIN_NT)
188 -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX)
189 -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)$(SLIB_SUFFIX)
191 -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX)
194 disassemble: $(BINARY_NAME)$(BINARY_SUFFIX)
197 symbols: $(BINARY_NAME)$(BINARY_SUFFIX)
198 objdump -t $< | sort | less