/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: 2009-03-05 14:01:29 UTC
  • Revision ID: edam@waxworlds.org-20090305140129-ykjca5rvvfggzwjt
Tags: 3.0
- renamed to edam.mk; makefile should now be included rather than duplicated and modified
- added documentation comments and a disclaimer
- removed settings that should now be specified in a separaet Makefile before including edam.mk

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.0
 
6
# Copyright (c) 2008 Tim Marston <edam@waxworlds.org>.
 
7
#
 
8
# Permission is hereby granted, free of charge, to any person obtaining a copy
 
9
# of this software and associated documentation files (the "Software"), to deal
 
10
# in the Software without restriction, including without limitation the rights
 
11
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 
12
# copies of the Software, and to permit persons to whom the Software is
 
13
# furnished to do so, subject to the following conditions:
 
14
#
 
15
# The above copyright notice and this permission notice shall be included in
 
16
# all copies or substantial portions of the Software.
 
17
#
 
18
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
19
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
20
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 
21
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 
22
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 
23
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 
24
# THE SOFTWARE.
 
25
#_______________________________________________________________________________
 
26
#
 
27
#
 
28
# This is a general-purpose makefile for use with GNU make. It can be downloaded
 
29
# from http://www.waxworlds.org/edam/software/general-purpose-makefile where you
 
30
# might also find more information/documentation on it's use. The following text
 
31
# can only really be considered a reference to it's use.
 
32
#
 
33
# To use this makefile, put a file named "Makefile" in your project directory.
 
34
# Add all your project's settings to your Makefile and then include this file
 
35
# from it. For example, your Makefile might look something like this:
 
36
#
 
37
#       TARGET = my_program
 
38
#       SOURCES = main.cc foo.cc
 
39
#       LIBRARIES = bar
 
40
#       include ~/src/edam.mk
 
41
#
 
42
# A complete list of all the settings you can use in your Makefile follows. It
 
43
# should be noted, though, that some settings are better defined in the shell's
 
44
# environment and/or specified on the make command line than hard-coded straight
 
45
# in to the Makefile. For example, the "DEBUGMODE" is an ideal candidate for
 
46
# exporting from your shell:
 
47
#       export DEBUGMODE=1
 
48
# and overridding on the command line when necessary:
 
49
#       make DEBUGMODE=
 
50
#
 
51
# It should also be noted that boolean parameters should either be undefined (or
 
52
# defined as an empty string) for "off", and defined as "1" for "on"; as in the
 
53
# above example with setting DEBUGMODE.
 
54
#
 
55
# Here is a list of all configuration parameters:
 
56
#
 
57
# DEBUGMODE    Boolean. Build a debugable version of the target suitable for
 
58
#              debugging with gdb. It's probably better to set this from the
 
59
#              command line or the shell's environment than to hard-code it.
 
60
# PROFILEMODE  Boolean. When set, DEBUGMODE is also implied. Build a profiling
 
61
#              version of the target, for use with gprof. It's probably better
 
62
#              to set this from the command line or the shell's environment
 
63
#              than to hard-code it.
 
64
#
 
65
# LINKSTATIC   Boolean. Set to build a target that staticly links against all
 
66
#              its libraries and doesn't use shared libraries.
 
67
#
 
68
# MKSTATICLIB  Boolean. Target type: Set to build a static library target. If
 
69
#              neither this nor MKSHAREDLIB are set, the target defaults to a
 
70
#              binary executable.
 
71
# MKSHAREDLIB  Boolean. Target type: Set to build a shared library target. If
 
72
#              neither this nor MKSTATICLIB are set, the target defaults to a
 
73
#              binary executable.
 
74
#
 
75
# TARGET       The name of the target file.
 
76
#
 
77
# SOURCES      A list of all source files of whatever language. The language
 
78
#              type is determined by the file extension.
 
79
#
 
80
# LIBRARIES    A list of libraries to link against. Don't include the 'lib'
 
81
#              prefix.
 
82
#
 
83
# SUBDIRS      A list of subdirectories to build before attempting to build the
 
84
#              target. These subdirectories are also included in a clean_all.
 
85
#
 
86
# CPPFLAGS     Flags to give to the C and C++ compilers
 
87
# CFLAGS       Flags to give to the C compiler
 
88
# CXXFLAGS     Flags to give to the C++ compiler
 
89
# DFLAGS       Flags to give to the D compiler
 
90
# ASFLAGS      Flags to give to the assembler
 
91
# LDFLAGS      Flags to give to the linker before librarys
 
92
# LDPOSTFLAGS  Flags to give to the linker after libraries
 
93
#
 
94
# This general-purpose makefile also defines the following goals for use on the
 
95
# command line when you run make:
 
96
#
 
97
# all          This is the default if no goal is specified. It builds subdirs
 
98
#              first and then the target.
 
99
#
 
100
# subdirs      Changes to the subdirectories specified for the project and runs
 
101
#              make in them.
 
102
#
 
103
# target       Builds the target of your Makefile.
 
104
#
 
105
# run          Builds the target of your Makefile and, if successful, runs it.
 
106
#              This is not available if you're building a library of some kind.
 
107
#
 
108
# clean        Deletes temporary files.
 
109
#
 
110
# clean_all    Deletes temporary files and then goes through then project's
 
111
#              subdirectories doing the same.
 
112
#
 
113
# <subdir>     Builds the specified subdirectory from those that are listed for
 
114
#              the project.
 
115
#
 
116
# <file>       Builds the specified file, either an object file or the target,
 
117
#              from those that that would be built for the project.
 
118
#
 
119
# Please report any problems to Tim Marston <edam@waxworlds.org>
 
120
#
 
121
# Known shortcommings:
 
122
# - Using C is probably broken because g++ is currently used for linking. We
 
123
#   should switch to ld and specify the correct crt as required by source files.
 
124
# - Currently can only specify one target. If we could specify several targets
 
125
#   though, we'd need separate sources, libraries and build params for each!
 
126
#
 
127
#_______________________________________________________________________________
 
128
#
49
129
 
50
130
# set debug mode if profiling
51
131
ifdef PROFILEMODE
53
133
endif
54
134
 
55
135
# software
56
 
AS                      := nasm
57
136
CC                      := gcc
58
137
CXX                     := g++
 
138
GDC                     := gdc
 
139
AS                      := nasm
59
140
LD                      := g++
60
141
AR                      := ar
61
142
MAKE            := make
62
143
 
63
 
# build flags
 
144
# debug/profile build flags
64
145
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)
 
146
CPPFLAGS        := $(if $(DEBUGMODE),-g -D DEBUG -Wall,-D NDEBUG -O2) $(CPPFLAGS)
 
147
DFLAGS          := $(if $(DEBUGMODE),,-frelease)
 
148
ASFLAGS         := -f elf $(if $(DEBUGMODE),-g -dDEBUG,-dNDEBUG -O2) $(ASFLAGS)
 
149
LDFLAGS         := $(if $(PROFILEMODE),-pg) $(LDFLAGS)
 
150
LDFLAGS         := $(if $(or $(PROFILEMODE), $(DEBUGMODE)),,-Wl,-S) $(LDFLAGS)
 
151
 
 
152
# setup options for shared/static libs
 
153
CPPFLAGS        := $(if $(MKSHAREDLIB),-fPIC) $(CPPFLAGS)
 
154
LDFLAGS         := $(if $(LINKSTATIC),-static) $(LDFLAGS)
 
155
 
 
156
# add libraries for d
 
157
LIBRARIES       := $(LIBRARIES) $(if $(filter %.d, $(SOURCES)), gphobos pthread m)
 
158
 
 
159
# build flags for libraries
69
160
LDPOSTFLAGS := $(addprefix -l,$(LIBRARIES)) $(LDPOSTFLAGS)
70
161
 
71
162
#_______________________________________________________________________________
 
163
#
72
164
 
73
165
# object debug/profile suffix
74
166
BUILDSUFFIX     := $(if $(PROFILEMODE),_p,$(if $(DEBUGMODE),_d))
75
167
 
76
 
# files
 
168
# work out object and dependency files
77
169
OBJECTS         := $(addsuffix $(BUILDSUFFIX).o,$(basename $(SOURCES)))
78
 
DEPFILES        := $(addsuffix .d,$(basename $(SOURCES)))
 
170
DEPFILES        := $(addsuffix .dep,$(basename $(SOURCES)))
79
171
 
80
 
# fixup target
 
172
# fixup target name
81
173
ifdef TARGET
82
174
TARGET          := $(basename $(TARGET))$(BUILDSUFFIX)$(suffix $(TARGET))
83
175
TARGET          := $(patsubst %.so,%,$(patsubst %.a,%,$(TARGET)))
 
176
ifneq ($(strip $(MKSHAREDLIB) $(MKSTATICLIB)),)
84
177
TARGET          := $(TARGET)$(if $(MKSHAREDLIB),.so,$(if $(MKSTATICLIB),.a))
 
178
TARGET          := lib$(patsubst lib%,%,$(TARGET))
 
179
endif
85
180
endif
86
181
 
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
 
182
# Set up dependency generation build flags and, for those languages where the
 
183
# the compiler/assembler doesn't support dependency generation, commands to be
 
184
# executed after generating any dependency file. The commands append the names
 
185
# of all the depended-on files in the dependency file to the end of the file as
90
186
# 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).
 
187
# one of these files becomes non-existant, but causes files dependent on these
 
188
# files to be rebuilt (and thus also have their dependencies regenerated).
93
189
ifdef DEBUGMODE
94
190
ifndef PROFILEMODE
95
 
FIXUP_DEPENDANCY_FILES = \
 
191
FIXUP_DEPENDENCY_FILES = \
96
192
        sed 's/\#.*//;s/^[^:]*://;s/^[ \t]*//;s/ *\\$$//;/^$$/d;s/$$/:/' < \
97
 
                $(basename $<).d > .$$$$~; cat .$$$$~ >> $(basename $<).d; rm .$$$$~;
98
 
DEPFLAGS        = -MD -MF $(basename $<).d
 
193
        $(basename $<).dep > .$$$$~; cat .$$$$~ >> $(basename $<).dep; rm .$$$$~;
 
194
DEPFLAGS        = -MMD -MP -MF $(basename $<).dep
99
195
endif
100
196
endif
101
197
 
102
 
# include dependancies
 
198
# include dependencies
103
199
ifneq "$(MAKECMDGOALS)" "clean"
104
200
ifneq "$(MAKECMDGOALS)" "clean_all"
105
201
-include $(DEPFILES)
126
222
        @echo "NOT RECURSING: use 'make clean_all' to clean subdirectories as well."
127
223
endif
128
224
endif
129
 
        rm -f $(OBJECTS) $(TARGET) core
 
225
        rm -f $(OBJECTS) $(TARGET) *.dep core
130
226
 
131
227
clean_all: subdirs clean
132
228
 
138
234
endif
139
235
 
140
236
$(SUBDIRS):
 
237
        @if [ "$@" = "$(firstword $(SUBDIRS))" ]; then echo; fi
141
238
        @$(MAKE) -C $@ $(filter-out $(SUBDIRS),$(MAKECMDGOALS))
142
239
        @echo
143
240
 
150
247
 
151
248
%.o %_d.o %_p.o: %.c
152
249
        $(CC) -c $(CPPFLAGS) $(DEPFLAGS) $(CFLAGS) -o $@ $<
153
 
        $(FIXUP_DEPENDANCY_FILES)
154
250
 
155
251
%.o %_d.o %_p.o: %.cc
156
252
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
157
 
        $(FIXUP_DEPENDANCY_FILES)
158
253
%.o %_d.o %_p.o: %.C
159
254
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
160
 
        $(FIXUP_DEPENDANCY_FILES)
161
255
%.o %_d.o %_p.o: %.cpp
162
256
        $(CXX) -c $(CPPFLAGS) $(DEPFLAGS) $(CXXFLAGS) -o $@ $<
163
 
        $(FIXUP_DEPENDANCY_FILES)
 
257
 
 
258
%.o %_d.o %_p.o: %.d
 
259
        $(GDC) -c $(CPPFLAGS) $(DFLAGS) -o $@ $<
164
260
 
165
261
%.o %_d.o %_p.o: %.s
166
262
        $(AS) $(ASFLAGS) -o $@ $<
 
263
ifdef DEBUGMODE
 
264
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
 
265
        $(FIXUP_DEPENDENCY_FILES)
 
266
endif
167
267
%.o %_d.o %_p.o: %.S
168
268
        $(AS) $(ASFLAGS) -o $@ $<
 
269
ifdef DEBUGMODE
 
270
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
 
271
        $(FIXUP_DEPENDENCY_FILES)
 
272
endif
169
273
%.o %_d.o %_p.o: %.asm
170
274
        $(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)
 
275
ifdef DEBUGMODE
 
276
        $(AS) $(ASFLAGS) -M $< > $(basename $<).dep
 
277
        $(FIXUP_DEPENDENCY_FILES)
 
278
endif
181
279
 
182
280
#_______________________________________________________________________________
 
281