1
1
#_______________________________________________________________________________
3
# edam's general-purpose makefile
4
#_______________________________________________________________________________
7
# Copyright (c) 2009 Tim Marston <edam@waxworlds.org>.
9
# Permission is hereby granted, free of charge, to any person obtaining a copy
10
# of this software and associated documentation files (the "Software"), to deal
11
# in the Software without restriction, including without limitation the rights
12
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
# copies of the Software, and to permit persons to whom the Software is
14
# furnished to do so, subject to the following conditions:
16
# The above copyright notice and this permission notice shall be included in
17
# all copies or substantial portions of the Software.
19
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27
#_______________________________________________________________________________
30
# This is a general-purpose makefile for use with GNU make. It can be downloaded
31
# from http://www.waxworlds.org/edam/software/general-purpose-makefile where you
32
# can also find more information and documentation on it's use. The following
33
# text can only really be considered a reference to it's use.
35
# To use this makefile, put a file named "Makefile" in your project directory.
36
# Add all your project's settings to your Makefile and then include this file
37
# from it. For example, your Makefile might look something like this:
40
# SOURCES = main.cc foo.cc
42
# include ~/src/edam.mk
44
# A complete list of all the settings you can use in your Makefile follows. It
45
# should be noted, though, that some settings are better defined in the shell's
46
# environment and/or specified on the make command line than hard-coded straight
47
# in to the Makefile. For example, the "DEBUGMODE" is an ideal candidate for
48
# exporting from your shell:
50
# and overridding on the command line when necessary:
53
# It should also be noted that boolean parameters should either be undefined (or
54
# defined as an empty string) for "off", and defined as "1" for "on"; as in the
55
# above example with setting DEBUGMODE.
57
# Here is a list of all configuration parameters:
59
# DEBUGMODE Boolean. Build a debugable version of the target suitable for
60
# debugging with gdb. It's probably better to set this from the
61
# command line or the shell's environment than to hard-code it.
62
# PROFILEMODE Boolean. When set, DEBUGMODE is also implied. Build a profiling
63
# version of the target, for use with gprof. It's probably better
64
# to set this from the command line or the shell's environment
65
# than to hard-code it.
67
# LINKSTATIC Boolean. Set to build a target that staticly links against all
68
# its libraries and doesn't use shared libraries.
70
# MKSTATICLIB Boolean. Target type: Set to build a static library target. If
71
# neither this nor MKSHAREDLIB are set, the target defaults to a
73
# MKSHAREDLIB Boolean. Target type: Set to build a shared library target. If
74
# neither this nor MKSTATICLIB are set, the target defaults to a
76
# NOLIBPREFIX Boolean. When building a static or shared library, do not ensure
77
# that the target's name is prefixed with "lib".
79
# TARGET The name of the target file.
81
# SOURCES A list of all source files of whatever language. The language
82
# type is determined by the file extension.
84
# LIBRARIES A list of libraries to link against. Don't include the 'lib'
87
# SUBDIRS A list of subdirectories to build before attempting to build the
88
# target. These subdirectories are also included in a clean_all.
89
# Note that if the file 'emake.mk' exists in a subdirectory, it
90
# will be used explicitly, rather than any default makefile.
92
# SUBPROJS A list of the names of other makefiles to run before attempting
93
# to build the target. This allows you to build multiple targets.
94
# Note that ".mk" is appended to the subproject names. These
95
# subprojects are also included in a clean_all.
97
# CPPFLAGS Flags to give to the C and C++ compilers
98
# CFLAGS Flags to give to the C compiler
99
# CXXFLAGS Flags to give to the C++ compiler
100
# DFLAGS Flags to give to the D compiler
101
# ASFLAGS Flags to give to the assembler
102
# LDFLAGS Flags to give to the linker before librarys
103
# LDPOSTFLAGS Flags to give to the linker after libraries
105
# This general-purpose makefile also defines the following goals for use on the
106
# command line when you run make:
108
# all This is the default if no goal is specified. It builds subdirs
109
# and subprojects first and then the target.
111
# subdirs Goes through the list of specified subdirectories, changing to
112
# them, and runs make there.
114
# subprojs Goes through the list of specified subprojects, running the
115
# makefiles for each of them.
117
# target Builds the target of your Makefile.
119
# run Builds the target of your Makefile and, if successful, runs it.
120
# This is not available if you're building a library of some kind.
122
# debug The same as the run goal, except instead of running the target,
123
# it is debugged with gdb.
125
# clean Deletes temporary files.
127
# clean_all Deletes temporary files and then goes through then project's
128
# subdirectories doing the same.
130
# <subdir> Builds the specified subdirectory from those that are listed for
133
# <subproj> Builds the specified subproject from those listed for the
136
# <file> Builds the specified file, either an object file or the target,
137
# from those that that would be built for the project.
139
# Please report any problems to Tim Marston <edam@waxworlds.org>
141
# Known shortcommings:
142
# - Using C is probably broken because g++ is currently used for linking. We
143
# should be using ld and specifying the crt libs as required by the sources.
145
#_______________________________________________________________________________
3
# edam's general-purpose makefile v2.2
4
#_______________________________________________________________________________
9
# (better to specify in environment/command line)
11
#export DEBUGMODE := 1
12
#export PROFILEMODE := 1
13
#export LINKSTATIC := 1
16
# target binary/library
28
# libraries to link against
33
# subdirectories to make first
38
# additional build flags
47
#_______________________________________________________________________________
148
50
# set debug mode if profiling
162
# debug/profile build flags
163
CPPFLAGS := $(if $(PROFILEMODE),-pg -D PROFILE) $(if $(DEBUGMODE),\
164
-g3 -D DEBUG -Wall -Wextra,-D NDEBUG -O2) $(CPPFLAGS)
165
CXXFLAGS := $(if $(DEBUGMODE),-Woverloaded-virtual -Wreorder \
166
-Wctor-dtor-privacy) $(CXXFLAGS)
167
DFLAGS := $(if $(DEBUGMODE),,-frelease)
168
ASFLAGS := -f elf $(if $(DEBUGMODE),-g -dDEBUG,-dNDEBUG -O2) $(ASFLAGS)
169
LDFLAGS := $(if $(PROFILEMODE),-pg) \
170
$(if $(or $(PROFILEMODE), $(DEBUGMODE)),,-Wl,-S) $(LDFLAGS)
172
# setup options for shared/static libs
173
CPPFLAGS := $(if $(or $(MKSHAREDLIB),$(MKSTATICLIB)),-fPIC) $(CPPFLAGS)
64
CPPFLAGS := $(if $(PROFILEMODE),-pg -D PROFILE) $(CPPFLAGS)
65
CPPFLAGS := $(if $(DEBUGMODE),-g -D DEBUG -Wall,-O2) $(CPPFLAGS)
66
CPPFLAGS := $(if $(MKSHAREDLIB),-fPIC) $(CPPFLAGS)
67
ASFLAGS := -f elf $(if $(DEBUGMODE),-g -dDEBUG,-O2) $(ASFLAGS)
68
LDFLAGS := $(if $(PROFILEMODE),-pg) $(LDFLAGS)
69
LDFLAGS := $(if $(or $(PROFILEMODE),$(DEBUGMODE)),,-Wl,-S) $(LDFLAGS)
174
70
LDFLAGS := $(if $(LINKSTATIC),-static) $(LDFLAGS)
176
# add libraries for d
177
LIBRARIES := $(LIBRARIES) $(if $(filter %.d, $(SOURCES)), gphobos2 rt)
179
# build flags for libraries
180
71
LDPOSTFLAGS := $(addprefix -l,$(LIBRARIES)) $(LDPOSTFLAGS)
73
#_______________________________________________________________________________
182
76
# object debug/profile suffix
183
77
BUILDSUFFIX := $(if $(PROFILEMODE),_p,$(if $(DEBUGMODE),_d))
185
# work out object and dependency files
186
80
OBJECTS := $(addsuffix $(BUILDSUFFIX).o,$(basename $(SOURCES)))
187
81
DEPFILES := $(addsuffix .dep,$(basename $(SOURCES)))
191
TARGET := $(basename $(TARGET))$(BUILDSUFFIX)$(suffix $(TARGET))
192
TARGET := $(patsubst %.so,%,$(patsubst %.a,%,$(TARGET)))
85
TARGET := $(basename $(TARGET))$(BUILDSUFFIX)$(suffix $(TARGET))
86
TARGET := $(patsubst %.so,%,$(patsubst %.a,%,$(TARGET)))
193
87
ifneq ($(strip $(MKSHAREDLIB) $(MKSTATICLIB)),)
194
TARGET := $(TARGET)$(if $(MKSHAREDLIB),.so,$(if $(MKSTATICLIB),.a))
196
TARGET := lib$(patsubst lib%,%,$(TARGET))
88
TARGET := $(TARGET)$(if $(MKSHAREDLIB),.so,$(if $(MKSTATICLIB),.a))
89
TARGET := lib$(patsubst lib%,%,$(TARGET))
201
# Set up dependency generation build flags and, for those languages where the
202
# the compiler/assembler doesn't support dependency generation, commands to be
203
# executed after generating any dependency file. The commands append the names
204
# of all the depended-on files in the dependency file to the end of the file as
93
# Set up dependancy generation build flags and a commands to be executed after
94
# generating any dependancy file. The commands append the names of all the
95
# depended-on files in the dependancy file to the end of the dependancy file as
205
96
# empty rules with no prerequesits or commands. This causes make not to fail if
206
# one of these files becomes non-existant, but causes files dependent on these
207
# files to be rebuilt (and thus also have their dependencies regenerated).
97
# one of these files becomes non-existant, but causes files dependant on these
98
# files to be rebuilt (and thus also have their dependancies regenerated).
209
100
ifndef PROFILEMODE
210
FIXUP_DEPENDENCY_FILES = \
101
FIXUP_DEPENDANCY_FILES = \
211
102
sed 's/\#.*//;s/^[^:]*://;s/^[ \t]*//;s/ *\\$$//;/^$$/d;s/$$/:/' < \
212
103
$(basename $<).dep > .$$$$~; cat .$$$$~ >> $(basename $<).dep; rm .$$$$~;
213
DEPFLAGS = -MMD -MP -MF $(basename $<).dep
104
DEPFLAGS = -MD -MF $(basename $<).dep
217
# include dependencies
108
# include dependancies
218
109
ifneq "$(MAKECMDGOALS)" "clean"
219
110
ifneq "$(MAKECMDGOALS)" "clean_all"
220
111
-include $(DEPFILES)
227
118
#_______________________________________________________________________________
230
.PHONY: all subdirs subprojs target clean clean_all run debug depend dep \
231
$(SUBDIRS) $(SUBPROJS)
121
.PHONY: all subdirs target clean clean_all run depend dep $(SUBDIRS)
233
all: subdirs subprojs target
235
125
subdirs: $(SUBDIRS)
237
subprojs: $(SUBPROJS)
239
127
target: $(TARGET)
242
ifneq ($(or $(SUBDIRS),$(SUBPROJS)),)
243
131
ifneq "$(MAKECMDGOALS)" "clean_all"
244
@echo "NOT RECURSING - use 'make clean_all' to clean subdirs and " \
248
rm -f $(OBJECTS) $(TARGET) $(DEPFILES) core *~
132
@echo "NOT RECURSING: use 'make clean_all' to clean subdirectories as well."
135
rm -f $(OBJECTS) $(TARGET) core
250
clean_all: subdirs subprojs clean
137
clean_all: subdirs clean
252
139
ifndef MKSTATICLIB
253
140
ifndef MKSHAREDLIB
262
$(SUBDIRS) $(SUBPROJS):
263
@if [ "$@" = "$(firstword $(SUBDIRS) $(SUBPROJS))" ]; then echo; fi
264
@$(MAKE) $(if $(filter $@,$(SUBPROJS)), -f $@.mk, \
265
-C $@ $(if $(wildcard $@/emake.mk),-f emake.mk,)) \
266
$(filter-out $(SUBDIRS) $(SUBPROJS) subdirs subprojs,$(MAKECMDGOALS))
147
@if [ "$@" = "$(firstword $(SUBDIRS))" ]; then echo; fi
148
@$(MAKE) -C $@ $(filter-out $(SUBDIRS),$(MAKECMDGOALS))
269
151
$(TARGET): $(OBJECTS)
270
152
ifdef MKSTATICLIB
271
153
$(AR) rcs $(TARGET) $(OBJECTS)
273
$(LD) $(if $(MKSHAREDLIB),-shared) -o $(TARGET) $(LDFLAGS) $(OBJECTS) $(LDPOSTFLAGS)
155
$(LD) $(if $(MKSHAREDLIB),-shared) -o $(TARGET) $(LDFLAGS) $(OBJECTS) $(LDPOSTFLAGS)
276
158
%.o %_d.o %_p.o: %.c
277
159
$(CC) -c $(CPPFLAGS) $(DEPFLAGS) $(CFLAGS) -o $@ $<
160
$(FIXUP_DEPENDANCY_FILES)
279
162
%.o %_d.o %_p.o: %.cc
280
163
$(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
164
$(FIXUP_DEPENDANCY_FILES)
281
165
%.o %_d.o %_p.o: %.C
282
166
$(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
167
$(FIXUP_DEPENDANCY_FILES)
283
168
%.o %_d.o %_p.o: %.cpp
284
169
$(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
287
$(GDC) -c $(CPPFLAGS) $(DFLAGS) -o $@ $<
170
$(FIXUP_DEPENDANCY_FILES)
289
172
%.o %_d.o %_p.o: %.s
290
173
$(AS) $(ASFLAGS) -o $@ $<
292
$(AS) $(ASFLAGS) -M $< > $(basename $<).dep
293
$(FIXUP_DEPENDENCY_FILES)
295
174
%.o %_d.o %_p.o: %.S
296
175
$(AS) $(ASFLAGS) -o $@ $<
298
$(AS) $(ASFLAGS) -M $< > $(basename $<).dep
299
$(FIXUP_DEPENDENCY_FILES)
301
176
%.o %_d.o %_p.o: %.asm
302
177
$(AS) $(ASFLAGS) -o $@ $<
304
$(AS) $(ASFLAGS) -M $< > $(basename $<).dep
305
$(FIXUP_DEPENDENCY_FILES)
180
$(AS) $(ASFLAGS) -M $< > $@
181
$(FIXUP_DEPENDANCY_FILES)
183
$(AS) $(ASFLAGS) -M $< > $@
184
$(FIXUP_DEPENDANCY_FILES)
186
$(AS) $(ASFLAGS) -M $< > $@
187
$(FIXUP_DEPENDANCY_FILES)
308
189
#_______________________________________________________________________________