/make/edam-mk

To get this branch, use:
bzr branch http://bzr.ed.am/make/edam-mk

« back to all changes in this revision

Viewing changes to edam.mk

  • Committer: edam
  • Date: 2011-03-16 16:03:15 UTC
  • Revision ID: edam@waxworlds.org-20110316160315-418eeb4u3lvhyxje
- added the debug goal

Show diffs side-by-side

added added

removed removed

Lines of Context:
edam.mk
1
1
#_______________________________________________________________________________
2
2
#
3
 
#                                       edam's general-purpose makefile v2.0
4
 
#_______________________________________________________________________________
5
 
#                                                                COMMON SETTINGS
6
 
 
7
 
#
8
 
# overridable options
9
 
# (better to specify in environment/command line)
10
 
#
11
 
#export DEBUGMODE       := 1
12
 
#export PROFILEMODE := 1
13
 
#export LINKSTATIC      := 1
14
 
 
15
 
#
16
 
# target binary/library
17
 
#
18
 
#MKSTATICLIB    := 1
19
 
#MKSHAREDLIB    := 1
20
 
TARGET          := tim
21
 
 
22
 
#
23
 
# all source files
24
 
#
25
 
SOURCES         := tim.cc
26
 
 
27
 
#
28
 
# libraries to link against
29
 
#
30
 
LIBRARIES       := 
31
 
 
32
 
#
33
 
# subdirectories to make first
34
 
#
35
 
SUBDIRS         := 
36
 
 
37
 
#
38
 
# additional build flags
39
 
#
40
 
CPPFLAGS        := 
41
 
CFLAGS          := 
42
 
CXXFLAGS        := 
43
 
ASFLAGS         := 
44
 
LDFLAGS         := 
45
 
LDPOSTFLAGS     := 
46
 
 
47
 
#_______________________________________________________________________________
48
 
#                                                                 OTHER SETTINGS
 
3
#                       edam's general-purpose makefile
 
4
#_______________________________________________________________________________
 
5
#                                                                    version 3.4
 
6
#
 
7
# Copyright (c) 2009 Tim Marston <edam@waxworlds.org>.
 
8
#
 
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:
 
15
#
 
16
# The above copyright notice and this permission notice shall be included in
 
17
# all copies or substantial portions of the Software.
 
18
#
 
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
 
25
# THE SOFTWARE.
 
26
#
 
27
#_______________________________________________________________________________
 
28
#
 
29
#
 
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.
 
34
#
 
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:
 
38
#
 
39
#       TARGET = my_program
 
40
#       SOURCES = main.cc foo.cc
 
41
#       LIBRARIES = bar
 
42
#       include ~/src/edam.mk
 
43
#
 
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:
 
49
#       export DEBUGMODE=1
 
50
# and overridding on the command line when necessary:
 
51
#       make DEBUGMODE=
 
52
#
 
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.
 
56
#
 
57
# Here is a list of all configuration parameters:
 
58
#
 
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.
 
66
#
 
67
# LINKSTATIC   Boolean. Set to build a target that staticly links against all
 
68
#              its libraries and doesn't use shared libraries.
 
69
#
 
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
 
72
#              binary executable.
 
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
 
75
#              binary executable.
 
76
# NOLIBPREFIX  Boolean. When building a static or shared library, do not ensure
 
77
#              that the target's name is prefixed with "lib".
 
78
#
 
79
# TARGET       The name of the target file.
 
80
#
 
81
# SOURCES      A list of all source files of whatever language. The language
 
82
#              type is determined by the file extension.
 
83
#
 
84
# LIBRARIES    A list of libraries to link against. Don't include the 'lib'
 
85
#              prefix.
 
86
#
 
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.
 
91
#
 
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.
 
96
#
 
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
 
104
#
 
105
# This general-purpose makefile also defines the following goals for use on the
 
106
# command line when you run make:
 
107
#
 
108
# all          This is the default if no goal is specified. It builds subdirs
 
109
#              and subprojects first and then the target.
 
110
#
 
111
# subdirs      Goes through the list of specified subdirectories, changing to
 
112
#              them, and runs make there.
 
113
#
 
114
# subprojs     Goes through the list of specified subprojects, running the
 
115
#              makefiles for each of them.
 
116
#
 
117
# target       Builds the target of your Makefile.
 
118
#
 
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.
 
121
#
 
122
# debug        The same as the run goal, except instead of running the target,
 
123
#              it is debugged with gdb.
 
124
#
 
125
# clean        Deletes temporary files.
 
126
#
 
127
# clean_all    Deletes temporary files and then goes through then project's
 
128
#              subdirectories doing the same.
 
129
#
 
130
# <subdir>     Builds the specified subdirectory from those that are listed for
 
131
#              the project.
 
132
#
 
133
# <subproj>    Builds the specified subproject from those listed for the
 
134
#              project.
 
135
#
 
136
# <file>       Builds the specified file, either an object file or the target,
 
137
#              from those that that would be built for the project.
 
138
#
 
139
# Please report any problems to Tim Marston <edam@waxworlds.org>
 
140
#
 
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.
 
144
#
 
145
#_______________________________________________________________________________
 
146
#
49
147
 
50
148
# set debug mode if profiling
51
149
ifdef PROFILEMODE
53
151
endif
54
152
 
55
153
# software
56
 
AS                      := nasm
57
154
CC                      := gcc
58
155
CXX                     := g++
 
156
GDC                     := gdc
 
157
AS                      := nasm
59
158
LD                      := g++
60
159
AR                      := ar
61
160
MAKE            := make
62
161
 
63
 
# build flags
64
 
CPPFLAGS        := $(if $(PROFILEMODE),-pg -D PROFILE) $(CPPFLAGS)
65
 
CPPFLAGS        := $(if $(DEBUGMODE),-g -D DEBUG,-O2) $(CPPFLAGS)
66
 
ASFLAGS         := -f elf $(if $(DEBUGMODE),-g -dDEBUG,-O2) $(ASFLAGS)
67
 
LDFLAGS         := $(if $(PROFILEMODE),-pg,$(if $(DEBUGMODE),,-s)) $(LDFLAGS)
68
 
LDFLAGS         := -Wall $(if $(LINKSTATIC),-static) $(LDFLAGS)
 
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)
 
171
 
 
172
# setup options for shared/static libs
 
173
CPPFLAGS        := $(if $(or $(MKSHAREDLIB),$(MKSTATICLIB)),-fPIC) $(CPPFLAGS)
 
174
LDFLAGS         := $(if $(LINKSTATIC),-static) $(LDFLAGS)
 
175
 
 
176
# add libraries for d
 
177
LIBRARIES       := $(LIBRARIES) $(if $(filter %.d, $(SOURCES)), gphobos pthread m)
 
178
 
 
179
# build flags for libraries
69
180
LDPOSTFLAGS := $(addprefix -l,$(LIBRARIES)) $(LDPOSTFLAGS)
70
181
 
71
 
#_______________________________________________________________________________
72
 
 
73
182
# object debug/profile suffix
74
183
BUILDSUFFIX     := $(if $(PROFILEMODE),_p,$(if $(DEBUGMODE),_d))
75
184
 
76
 
# files
 
185
# work out object and dependency files
77
186
OBJECTS         := $(addsuffix $(BUILDSUFFIX).o,$(basename $(SOURCES)))
78
 
DEPFILES        := $(addsuffix .d,$(basename $(SOURCES)))
 
187
DEPFILES        := $(addsuffix .dep,$(basename $(SOURCES)))
79
188
 
80
 
# fixup target
 
189
# fixup target name
81
190
ifdef TARGET
82
191
TARGET          := $(basename $(TARGET))$(BUILDSUFFIX)$(suffix $(TARGET))
83
192
TARGET          := $(patsubst %.so,%,$(patsubst %.a,%,$(TARGET)))
 
193
ifneq ($(strip $(MKSHAREDLIB) $(MKSTATICLIB)),)
84
194
TARGET          := $(TARGET)$(if $(MKSHAREDLIB),.so,$(if $(MKSTATICLIB),.a))
 
195
ifndef NOLIBPREFIX
 
196
TARGET          := lib$(patsubst lib%,%,$(TARGET))
 
197
endif
 
198
endif
85
199
endif
86
200
 
87
 
# Set up dependancy generation build flags and a commands to be executed after
88
 
# generating any dependancy file. The commands append the names of all the
89
 
# depended-on files in the dependancy file to the end of the dependancy file as
 
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
90
205
# empty rules with no prerequesits or commands. This causes make not to fail if
91
 
# one of these files becomes non-existant, but causes files dependant on these
92
 
# files to be rebuilt (and thus also have their dependancies regenerated).
 
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).
93
208
ifdef DEBUGMODE
94
209
ifndef PROFILEMODE
95
 
FIXUP_DEPENDANCY_FILES = \
 
210
FIXUP_DEPENDENCY_FILES = \
96
211
        sed 's/\#.*//;s/^[^:]*://;s/^[ \t]*//;s/ *\\$$//;/^$$/d;s/$$/:/' < \
97
 
                $(basename $<).d > .$$$$~; cat .$$$$~ >> $(basename $<).d; rm .$$$$~;
98
 
DEPFLAGS        = -MD -MF $(basename $<).d
 
212
        $(basename $<).dep > .$$$$~; cat .$$$$~ >> $(basename $<).dep; rm .$$$$~;
 
213
DEPFLAGS        = -MMD -MP -MF $(basename $<).dep
99
214
endif
100
215
endif
101
216
 
102
 
# include dependancies
 
217
# include dependencies
103
218
ifneq "$(MAKECMDGOALS)" "clean"
104
219
ifneq "$(MAKECMDGOALS)" "clean_all"
105
220
-include $(DEPFILES)
112
227
#_______________________________________________________________________________
113
228
#                                                                          RULES
114
229
 
115
 
.PHONY: all subdirs target clean clean_all run depend dep $(SUBDIRS)
 
230
.PHONY: all subdirs subprojs target clean clean_all run debug depend dep \
 
231
        $(SUBDIRS) $(SUBPROJS)
116
232
 
117
 
all: subdirs target
 
233
all: subdirs subprojs target
118
234
 
119
235
subdirs: $(SUBDIRS)
120
236
 
 
237
subprojs: $(SUBPROJS)
 
238
 
121
239
target: $(TARGET)
122
240
 
123
241
clean:
124
 
ifdef SUBDIRS
 
242
ifneq ($(or $(SUBDIRS),$(SUBPROJS)),)
125
243
ifneq "$(MAKECMDGOALS)" "clean_all"
126
 
        @echo "NOT RECURSING: use 'make clean_all' to clean subdirectories as well."
127
 
endif
128
 
endif
129
 
        rm -f $(OBJECTS) $(TARGET) core
 
244
        @echo "NOT RECURSING - use 'make clean_all' to clean subdirs and " \
 
245
                "subprojs as well"
 
246
endif
 
247
endif
 
248
        rm -f $(OBJECTS) $(TARGET) $(DEPFILES) core *~
130
249
 
131
 
clean_all: subdirs clean
 
250
clean_all: subdirs subprojs clean
132
251
 
133
252
ifndef MKSTATICLIB
134
253
ifndef MKSHAREDLIB
135
254
run: target
136
255
        ./$(TARGET)
137
 
endif
138
 
endif
139
 
 
140
 
$(SUBDIRS):
141
 
        @$(MAKE) -C $@ $(filter-out $(SUBDIRS),$(MAKECMDGOALS))
 
256
 
 
257
debug: target
 
258
        gdb ./$(TARGET)
 
259
endif
 
260
endif
 
261
 
 
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))
142
267
        @echo
143
268
 
144
269
$(TARGET): $(OBJECTS)
145
270
ifdef MKSTATICLIB
146
271
        $(AR) rcs $(TARGET) $(OBJECTS)
147
272
else
148
 
        $(LD) $(if $(MKSHAREDLIB),-shared) -o $(TARGET) $(LDFLAGS) $(OBJECTS) $(LDPOSTFLAGS) 
 
273
        $(LD) $(if $(MKSHAREDLIB),-shared) -o $(TARGET) $(LDFLAGS) $(OBJECTS) $(LDPOSTFLAGS)
149
274
endif
150
275
 
151
276
%.o %_d.o %_p.o: %.c
152
277
        $(CC) -c $(CPPFLAGS) $(DEPFLAGS) $(CFLAGS) -o $@ $<
153
 
        $(FIXUP_DEPENDANCY_FILES)
154
278
 
155
279
%.o %_d.o %_p.o: %.cc
156
280
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
157
 
        $(FIXUP_DEPENDANCY_FILES)
158
281
%.o %_d.o %_p.o: %.C
159
282
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
160
 
        $(FIXUP_DEPENDANCY_FILES)
161
283
%.o %_d.o %_p.o: %.cpp
162
284
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
163
 
        $(FIXUP_DEPENDANCY_FILES)
 
285
 
 
286
%.o %_d.o %_p.o: %.d
 
287
        $(GDC) -c $(CPPFLAGS) $(DFLAGS) -o $@ $<
164
288
 
165
289
%.o %_d.o %_p.o: %.s
166
290
        $(AS) $(ASFLAGS) -o $@ $<
 
291
ifdef DEBUGMODE
 
292
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
 
293
        $(FIXUP_DEPENDENCY_FILES)
 
294
endif
167
295
%.o %_d.o %_p.o: %.S
168
296
        $(AS) $(ASFLAGS) -o $@ $<
 
297
ifdef DEBUGMODE
 
298
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
 
299
        $(FIXUP_DEPENDENCY_FILES)
 
300
endif
169
301
%.o %_d.o %_p.o: %.asm
170
302
        $(AS) $(ASFLAGS) -o $@ $<
171
 
 
172
 
%.d: %.s
173
 
        $(AS) $(ASFLAGS) -M $< > $@
174
 
        $(FIXUP_DEPENDANCY_FILES)
175
 
%.d: %.S
176
 
        $(AS) $(ASFLAGS) -M $< > $@
177
 
        $(FIXUP_DEPENDANCY_FILES)
178
 
%.d: %.asm
179
 
        $(AS) $(ASFLAGS) -M $< > $@
180
 
        $(FIXUP_DEPENDANCY_FILES)
 
303
ifdef DEBUGMODE
 
304
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
 
305
        $(FIXUP_DEPENDENCY_FILES)
 
306
endif
181
307
 
182
308
#_______________________________________________________________________________
 
309