Commit | Line | Data |
---|---|---|
4ddf6f1a JB |
1 | # Sample Makefile to build simple project. |
2 | # | |
3 | # This Makefile expect all source files (.c) to be at the same level, in the | |
4 | # $(SRC_PATH) directory. | |
5 | # | |
6 | # This Makefile expect all embedded library source files (.c) to be at the same level, in the | |
7 | # $(LIBRARY_PATH) directory. | |
8 | # | |
9 | # It will automatically generate dependencies, compile all files, and produce a | |
10 | # binary using the provided name linked against the library if necessary. | |
11 | # | |
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. | |
17 | # | |
18 | # Automatic dependencies code from: | |
19 | # http://make.mad-scientist.net/papers/advanced-auto-dependency-generation/#tldr | |
20 | BINARY_NAME:=othello | |
21 | SRC_PATH:=src | |
22 | # will add -lothello automagically linking flags | |
23 | LIBRARY_NAME:=libothello | |
24 | LIBRARY_PATH:=lib | |
25 | LDLIBS:=-lncurses -ltinfo | |
26 | BUILD_TYPE:=debug | |
27 | #BUILD_TYPE:=release | |
28 | ||
29 | # ==================================== | |
30 | # DO NOT CHANGE STUFF BEYOND THIS LINE | |
31 | # ==================================== | |
32 | ||
33 | CC=gcc | |
34 | LD=gcc | |
35 | AR=ar | |
36 | ||
37 | WARN_FLAGS = -Wall -Wextra | |
38 | STD_FLAG = -std=c11 | |
39 | UNAME := $(shell uname -o) | |
40 | ||
41 | ifeq ($(BUILD_TYPE),debug) | |
42 | BUILDDIR := .build/debug | |
43 | DEBUG_FLAG = -g | |
44 | STRIP_FLAG = | |
45 | OPTI_FLAG = -O0 | |
46 | LTO_SUPPORT = yes | |
47 | GOLD_SUPPORT = yes | |
48 | else | |
49 | BUILDDIR := .build/release | |
50 | DEBUG_FLAG = | |
51 | STRIP_FLAG = -s | |
52 | OPTI_FLAG = -O3 | |
53 | LTO_SUPPORT = yes | |
54 | GOLD_SUPPORT = yes | |
55 | endif | |
56 | ||
57 | BINARY_SUFFIX := | |
58 | DLIB_PREFIX := | |
59 | SDLIB_PREFIX := | |
60 | DLIB_SUFFIX := .so | |
61 | SLIB_SUFFIX := .a | |
62 | ||
63 | OBJDIR := $(BUILDDIR)/objs | |
64 | $(shell mkdir -p $(OBJDIR)) | |
65 | ||
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))) | |
70 | ||
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 | |
75 | ||
76 | ifeq ($(UNAME),Cygwin) | |
77 | CYGWIN_DLIBRARY_NAME := $(subst lib,cyg,$(LIBRARY_NAME)) | |
78 | GOLD_SUPPORT = no | |
79 | # Cygwin ncurses do not contain tinfo | |
80 | LDLIBS := $(filter-out -ltinfo,$(LDLIBS)) | |
81 | BINARY_SUFFIX := .exe | |
82 | DLIB_SUFFIX := .dll | |
83 | # do not archive external libraries | |
84 | CYGWIN_LDLIBS_NOARCHIVE := $(LDLIBS) | |
85 | CYGWIN_LIBLDFLAGS := -Wl,--out-implib=$(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a \ | |
86 | -Wl,--export-all-symbols \ | |
87 | -Wl,--enable-auto-import | |
88 | endif | |
89 | ||
90 | ifeq ($(LTO_SUPPORT),yes) | |
91 | CFLAGS_LTO = -flto -ffat-lto-objects | |
92 | LDFLAGS_LTO = -fuse-linker-plugin -flto | |
93 | endif | |
94 | ||
95 | ifeq ($(GOLD_SUPPORT),yes) | |
96 | LDFLAGS_GOLD = -fuse-ld=gold | |
97 | endif | |
98 | ||
99 | # Putting header files in the source directory is not the purpose of this INCLUDES_PATH variable | |
100 | INCLUDES_PATH := $(INCLUDES_PATH) -I$(LIBRARY_PATH) | |
101 | CFLAGS := $(CFLAGS) $(CFLAGS_LTO) $(WARN_FLAGS) $(STD_FLAG) $(OPTI_FLAG) $(DEBUG_FLAG) $(INCLUDES_PATH) | |
102 | LIBCFLAGS := -fPIC $(CFLAGS) | |
103 | LDFLAGS := $(LDFLAGS) $(LDFLAGS_LTO) $(LDFLAGS_GOLD) $(STRIP_FLAG) | |
104 | LIBLDFLAGS := -shared $(LDFLAGS) | |
105 | STATICLIBLDFLAGS := -static $(LDFLAGS) | |
106 | LDLIBS := $(LDLIBS) -L$(LIBRARY_PATH) -l$(BINARY_NAME) | |
107 | ||
108 | all: $(BINARY_NAME)$(BINARY_SUFFIX) $(BINARY_NAME).dynamic$(BINARY_SUFFIX) $(BINARY_NAME).static$(BINARY_SUFFIX) | |
109 | ||
110 | $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX): $(LIBOBJS) | |
111 | @echo "[AR StO] $@" | |
112 | @$(AR) rcs $@ $^ | |
113 | ||
114 | ifeq ($(UNAME),Cygwin) | |
115 | $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a: $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX) | |
116 | $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS) | |
117 | @echo "[LD DLL] $@" | |
118 | @$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $(CYGWIN_LIBLDFLAGS) -Wl,--whole-archive $^ -Wl,--no-whole-archive $(CYGWIN_LDLIBS_NOARCHIVE) -o $@ | |
119 | else | |
120 | $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX): $(LIBOBJS) | |
121 | @echo "[LD ShO] $@" | |
122 | @$(LD) $(LIBCFLAGS) $(LIBLDFLAGS) $^ -o $@ | |
123 | endif | |
124 | ||
125 | #$(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBOBJS) | |
126 | # @echo "[LD ] $@" | |
127 | # @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@ | |
128 | ||
129 | $(BINARY_NAME)$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX) | |
130 | @echo "[LD ] $@" | |
131 | @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@ | |
132 | ||
133 | $(BINARY_NAME).static$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX) | |
134 | @echo "[LD ] $@" | |
135 | @$(LD) $(CFLAGS) $(STATICLIBLDFLAGS) $^ $(LDLIBS) -o $@ | |
136 | ||
137 | ifeq ($(UNAME),Cygwin) | |
138 | $(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a | |
139 | else | |
140 | $(BINARY_NAME).dynamic$(BINARY_SUFFIX): $(OBJS) $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX) | |
141 | endif | |
142 | @echo "[LD ] $@" | |
143 | @$(LD) $(CFLAGS) $(LDFLAGS) $^ $(LDLIBS) -o $@ | |
144 | ||
145 | $(OBJDIR)/%.o: $(SRC_PATH)/%.c $(DEPDIR)/%.d | |
146 | @echo "[C ] $(notdir $*)" | |
147 | @$(CC) $(DEPFLAGS) $(CFLAGS) -c $< -o $@ | |
148 | @$(POSTCOMPILE) | |
149 | ||
150 | include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(SRCS)))) | |
151 | ||
152 | $(OBJDIR)/%.o: $(LIBRARY_PATH)/%.c $(DEPDIR)/%.d | |
153 | @echo "[C ] $(notdir $*)" | |
154 | @$(CC) $(DEPFLAGS) $(LIBCFLAGS) -c $< -o $@ | |
155 | @$(POSTCOMPILE) | |
156 | ||
157 | include $(wildcard $(patsubst %,$(DEPDIR)/%.d,$(basename $(LIBSRCS)))) | |
158 | ||
159 | $(DEPDIR)/%.d: ; | |
160 | ||
161 | .PRECIOUS: $(DEPDIR)/%.d | |
162 | ||
163 | #FIXME: add an install target | |
164 | ||
165 | clean: | |
166 | @echo "[CLN]" | |
167 | -@rm -r $(BUILDDIR) | |
168 | -@rm $(BINARY_NAME)$(BINARY_SUFFIX) | |
169 | -@rm $(BINARY_NAME).static$(BINARY_SUFFIX) | |
170 | -@rm $(BINARY_NAME).dynamic$(BINARY_SUFFIX) | |
171 | -@rm $(LIBRARY_PATH)/$(SLIB_PREFIX)$(LIBRARY_NAME)$(SLIB_SUFFIX) | |
172 | ifeq ($(UNAME),Cygwin) | |
173 | -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(CYGWIN_DLIBRARY_NAME)$(DLIB_SUFFIX) | |
174 | -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX).a | |
175 | else | |
176 | -@rm $(LIBRARY_PATH)/$(DLIB_PREFIX)$(LIBRARY_NAME)$(DLIB_SUFFIX) | |
177 | endif | |
178 | ||
179 | disassemble: $(BINARY_NAME)$(BINARY_SUFFIX) | |
180 | objdump -d $< | less | |
181 | ||
182 | symbols: $(BINARY_NAME)$(BINARY_SUFFIX) | |
183 | objdump -t $< | sort | less |