/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 Makefile

  • Committer: edam
  • Date: 2009-03-05 13:47:12 UTC
  • Revision ID: edam@waxworlds.org-20090305134712-grzh787t06ojomf8
Tags: 2.0
- smartened up comments
- added PROFILEMODE
- renamed STATICLIBS to LINKSTATIC
- renamed lib target switched to MKSHAREDLIB and MKSTATICLIB
- added setting of software variables
- added debug & profile suffixes
- added dependency file generation system
- added rules to build various source types and added dependency generation

Show diffs side-by-side

added added

removed removed

Makefile
1
1
#_______________________________________________________________________________
2
2
#
3
 
#                       edam's general-purpose makefile
4
 
#_______________________________________________________________________________
5
 
#                                                                    version 3.5
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
 
#
 
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
147
49
 
148
50
# set debug mode if profiling
149
51
ifdef PROFILEMODE
151
53
endif
152
54
 
153
55
# software
 
56
AS                      := nasm
154
57
CC                      := gcc
155
58
CXX                     := g++
156
 
GDC                     := gdc
157
 
AS                      := nasm
158
59
LD                      := g++
159
60
AR                      := ar
160
61
MAKE            := make
161
62
 
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)), gphobos2 rt)
178
 
 
179
 
# build flags for libraries
 
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)
180
69
LDPOSTFLAGS := $(addprefix -l,$(LIBRARIES)) $(LDPOSTFLAGS)
181
70
 
 
71
#_______________________________________________________________________________
 
72
 
182
73
# object debug/profile suffix
183
74
BUILDSUFFIX     := $(if $(PROFILEMODE),_p,$(if $(DEBUGMODE),_d))
184
75
 
185
 
# work out object and dependency files
 
76
# files
186
77
OBJECTS         := $(addsuffix $(BUILDSUFFIX).o,$(basename $(SOURCES)))
187
 
DEPFILES        := $(addsuffix .dep,$(basename $(SOURCES)))
 
78
DEPFILES        := $(addsuffix .d,$(basename $(SOURCES)))
188
79
 
189
 
# fixup target name
 
80
# fixup target
190
81
ifdef TARGET
191
82
TARGET          := $(basename $(TARGET))$(BUILDSUFFIX)$(suffix $(TARGET))
192
83
TARGET          := $(patsubst %.so,%,$(patsubst %.a,%,$(TARGET)))
193
 
ifneq ($(strip $(MKSHAREDLIB) $(MKSTATICLIB)),)
194
84
TARGET          := $(TARGET)$(if $(MKSHAREDLIB),.so,$(if $(MKSTATICLIB),.a))
195
 
ifndef NOLIBPREFIX
196
 
TARGET          := lib$(patsubst lib%,%,$(TARGET))
197
 
endif
198
 
endif
199
85
endif
200
86
 
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
 
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
205
90
# 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).
 
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).
208
93
ifdef DEBUGMODE
209
94
ifndef PROFILEMODE
210
 
FIXUP_DEPENDENCY_FILES = \
 
95
FIXUP_DEPENDANCY_FILES = \
211
96
        sed 's/\#.*//;s/^[^:]*://;s/^[ \t]*//;s/ *\\$$//;/^$$/d;s/$$/:/' < \
212
 
        $(basename $<).dep > .$$$$~; cat .$$$$~ >> $(basename $<).dep; rm .$$$$~;
213
 
DEPFLAGS        = -MMD -MP -MF $(basename $<).dep
 
97
                $(basename $<).d > .$$$$~; cat .$$$$~ >> $(basename $<).d; rm .$$$$~;
 
98
DEPFLAGS        = -MD -MF $(basename $<).d
214
99
endif
215
100
endif
216
101
 
217
 
# include dependencies
 
102
# include dependancies
218
103
ifneq "$(MAKECMDGOALS)" "clean"
219
104
ifneq "$(MAKECMDGOALS)" "clean_all"
220
105
-include $(DEPFILES)
227
112
#_______________________________________________________________________________
228
113
#                                                                          RULES
229
114
 
230
 
.PHONY: all subdirs subprojs target clean clean_all run debug depend dep \
231
 
        $(SUBDIRS) $(SUBPROJS)
 
115
.PHONY: all subdirs target clean clean_all run depend dep $(SUBDIRS)
232
116
 
233
 
all: subdirs subprojs target
 
117
all: subdirs target
234
118
 
235
119
subdirs: $(SUBDIRS)
236
120
 
237
 
subprojs: $(SUBPROJS)
238
 
 
239
121
target: $(TARGET)
240
122
 
241
123
clean:
242
 
ifneq ($(or $(SUBDIRS),$(SUBPROJS)),)
 
124
ifdef SUBDIRS
243
125
ifneq "$(MAKECMDGOALS)" "clean_all"
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 *~
 
126
        @echo "NOT RECURSING: use 'make clean_all' to clean subdirectories as well."
 
127
endif
 
128
endif
 
129
        rm -f $(OBJECTS) $(TARGET) core
249
130
 
250
 
clean_all: subdirs subprojs clean
 
131
clean_all: subdirs clean
251
132
 
252
133
ifndef MKSTATICLIB
253
134
ifndef MKSHAREDLIB
254
135
run: target
255
136
        ./$(TARGET)
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))
 
137
endif
 
138
endif
 
139
 
 
140
$(SUBDIRS):
 
141
        @$(MAKE) -C $@ $(filter-out $(SUBDIRS),$(MAKECMDGOALS))
267
142
        @echo
268
143
 
269
144
$(TARGET): $(OBJECTS)
270
145
ifdef MKSTATICLIB
271
146
        $(AR) rcs $(TARGET) $(OBJECTS)
272
147
else
273
 
        $(LD) $(if $(MKSHAREDLIB),-shared) -o $(TARGET) $(LDFLAGS) $(OBJECTS) $(LDPOSTFLAGS)
 
148
        $(LD) $(if $(MKSHAREDLIB),-shared) -o $(TARGET) $(LDFLAGS) $(OBJECTS) $(LDPOSTFLAGS) 
274
149
endif
275
150
 
276
151
%.o %_d.o %_p.o: %.c
277
152
        $(CC) -c $(CPPFLAGS) $(DEPFLAGS) $(CFLAGS) -o $@ $<
 
153
        $(FIXUP_DEPENDANCY_FILES)
278
154
 
279
155
%.o %_d.o %_p.o: %.cc
280
156
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
 
157
        $(FIXUP_DEPENDANCY_FILES)
281
158
%.o %_d.o %_p.o: %.C
282
159
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
 
160
        $(FIXUP_DEPENDANCY_FILES)
283
161
%.o %_d.o %_p.o: %.cpp
284
162
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
285
 
 
286
 
%.o %_d.o %_p.o: %.d
287
 
        $(GDC) -c $(CPPFLAGS) $(DFLAGS) -o $@ $<
 
163
        $(FIXUP_DEPENDANCY_FILES)
288
164
 
289
165
%.o %_d.o %_p.o: %.s
290
166
        $(AS) $(ASFLAGS) -o $@ $<
291
 
ifdef DEBUGMODE
292
 
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
293
 
        $(FIXUP_DEPENDENCY_FILES)
294
 
endif
295
167
%.o %_d.o %_p.o: %.S
296
168
        $(AS) $(ASFLAGS) -o $@ $<
297
 
ifdef DEBUGMODE
298
 
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
299
 
        $(FIXUP_DEPENDENCY_FILES)
300
 
endif
301
169
%.o %_d.o %_p.o: %.asm
302
170
        $(AS) $(ASFLAGS) -o $@ $<
303
 
ifdef DEBUGMODE
304
 
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
305
 
        $(FIXUP_DEPENDENCY_FILES)
306
 
endif
 
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)
307
181
 
308
182
#_______________________________________________________________________________
309