forked from UniMath/UniMath
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
379 lines (350 loc) · 15.1 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
# -*- makefile-gmake -*-
UMAKEFILES += Makefile
ifneq "$(INCLUDE)" "no"
ifeq ($(shell test -f build/Makefile-configuration && echo yes),yes)
UMAKEFILES += build/Makefile-configuration
include build/Makefile-configuration
endif
endif
############################################
# The packages, listed in order by dependency:
PACKAGES += Foundations
PACKAGES += MoreFoundations
PACKAGES += Combinatorics
PACKAGES += Algebra
PACKAGES += NumberSystems
PACKAGES += PAdics
PACKAGES += CategoryTheory
PACKAGES += Ktheory
PACKAGES += Topology
PACKAGES += RealNumbers
PACKAGES += Tactics
PACKAGES += SubstitutionSystems
PACKAGES += Folds
PACKAGES += HomologicalAlgebra
############################################
# other user options; see also build/Makefile-configuration-template
BUILD_COQ ?= yes
BUILD_COQIDE ?= no
COQBIN ?=
############################################
.PHONY: all everything install lc lcp wc describe clean distclean build-coq doc build-coqide
all: check-first
all: check-for-change-to-Foundations
everything: TAGS all html install
check-first: enforce-prescribed-ordering check-travis
COQIDE_OPTION := no
ifeq "$(BUILD_COQ)" "yes"
COQBIN=sub/coq/bin/
all: build-coq
build-coq: sub/coq/bin/coqc
build/CoqMakefile.make: $(COQBIN)coq_makefile
ifeq "$(BUILD_COQIDE)" "yes"
all: build-coqide
build-coqide: sub/coq/bin/coqide
COQIDE_OPTION := opt
endif
endif
# override the definition in build/CoqMakefile.make, to eliminate the -utf8 option
COQDOC := coqdoc
COQDOCFLAGS := -interpolate --charset utf-8
COQDOC_OPTIONS := -toc $(COQDOCFLAGS) $(COQDOCLIBS) -utf8
PACKAGE_FILES := $(patsubst %, UniMath/%/.package/files, $(PACKAGES))
ifneq "$(INCLUDE)" "no"
include build/CoqMakefile.make
endif
ifeq ($(BUILD_COQ),yes)
# this comes after including build/CoqMakefile.make, to bet VFILES defined
$(VFILES:.v=.vo) : $(COQBIN)coqc
endif
OTHERFLAGS += $(MOREFLAGS)
OTHERFLAGS += -indices-matter -type-in-type -w '-notation-overridden,-local-declaration,+uniform-inheritance,-deprecated-option'
ifeq ($(VERBOSE),yes)
OTHERFLAGS += -verbose
endif
ENHANCEDDOCTARGET = enhanced-html
ENHANCEDDOCSOURCE = util/enhanced-doc
LATEXDIR = latex
COQDOCLATEXOPTIONS := -latex -utf8 --body-only
DEFINERS :=
DEFINERS := $(DEFINERS)Axiom\|
DEFINERS := $(DEFINERS)Class\|
DEFINERS := $(DEFINERS)CoFixpoint\|
DEFINERS := $(DEFINERS)CoInductive\|
DEFINERS := $(DEFINERS)Corollary\|
DEFINERS := $(DEFINERS)Definition\|
DEFINERS := $(DEFINERS)Example\|
DEFINERS := $(DEFINERS)Fact\|
DEFINERS := $(DEFINERS)Fixpoint\|
DEFINERS := $(DEFINERS)Function\|
DEFINERS := $(DEFINERS)Identity[[:space:]]+Coercion\|
DEFINERS := $(DEFINERS)Inductive\|
DEFINERS := $(DEFINERS)Instance\|
DEFINERS := $(DEFINERS)Lemma\|
DEFINERS := $(DEFINERS)Ltac\|
DEFINERS := $(DEFINERS)Module[[:space:]]+Import\|
DEFINERS := $(DEFINERS)Module\|
DEFINERS := $(DEFINERS)Notation\|
DEFINERS := $(DEFINERS)Proposition\|
DEFINERS := $(DEFINERS)Record\|
DEFINERS := $(DEFINERS)Remark\|
DEFINERS := $(DEFINERS)Scheme[[:space:]]+Equality[[:space:]]+for\|
DEFINERS := $(DEFINERS)Scheme[[:space:]]+Induction[[:space:]]+for\|
DEFINERS := $(DEFINERS)Scheme\|
DEFINERS := $(DEFINERS)Structure\|
DEFINERS := $(DEFINERS)Theorem
MODIFIERS :=
MODIFIERS := $(MODIFIERS)Canonical\|
MODIFIERS := $(MODIFIERS)Global\|
MODIFIERS := $(MODIFIERS)Local\|
MODIFIERS := $(MODIFIERS)Private\|
MODIFIERS := $(MODIFIERS)Program\|
COQDEFS := --language=none \
-r '/^[[:space:]]*\(\($(MODIFIERS)\)[[:space:]]+\)?\($(DEFINERS)\)[[:space:]]+\([[:alnum:]'\''_]+\)/\4/' \
-r "/^[[:space:]]*Notation.* \"'\([[:alnum:]'\''_]+\)'/\1/" \
-r '/^[[:space:]]*Tactic[[:space:]]+Notation.*[[:space:]]"\([[:alnum:]'\''_]+\)"[[:space:]]/\1/' \
-r '/^[[:space:]]*Delimit[[:space:]]+Scope[[:space:]]+[[:alnum:]'\''_]+[[:space:]]+with[[:space:]]+\([[:alnum:]'\''_]+\)[[:space:]]*\./\1/'
$(foreach P,$(PACKAGES),$(eval TAGS-$P: Makefile $(filter UniMath/$P/%,$(VFILES)); etags $(COQDEFS) -o $$@ $$^))
TAGS : Makefile $(PACKAGE_FILES) $(VFILES); etags $(COQDEFS) $(VFILES)
FILES_FILTER := grep -vE '^[[:space:]]*(\#.*)?$$'
$(foreach P,$(PACKAGES),$(eval $P: check-first $(shell <UniMath/$P/.package/files $(FILES_FILTER) |sed "s=^\(.*\)=UniMath/$P/\1o=" )))
install:all
coqwc:; coqwc $(VFILES)
lc:; wc -l $(VFILES)
lcp:; for i in $(PACKAGES) ; do echo ; echo ==== $$i ==== ; for f in $(VFILES) ; do echo "$$f" ; done | grep "UniMath/$$i" | xargs wc -l ; done
wc:; wc -w $(VFILES)
admitted:
grep --color=auto Admitted $(VFILES)
axiom:
grep --color=auto "Axiom " $(VFILES)
describe:; git describe --dirty --long --always --abbrev=40 --all
.coq_makefile_input: $(PACKAGE_FILES) $(UMAKEFILES)
@ echo making $@ ; ( \
echo '# -*- makefile-gmake -*-' ;\
echo ;\
echo '# DO NOT EDIT THIS FILE!' ;\
echo '# It is made by automatically (by code in Makefile)' ;\
echo ;\
echo '-Q UniMath UniMath' ;\
echo '-arg "$(OTHERFLAGS)"' ;\
echo ;\
for i in $(PACKAGES) ;\
do <UniMath/$$i/.package/files $(FILES_FILTER) |sed "s=^=UniMath/$$i/=" ;\
done ;\
echo ;\
echo '# Local ''Variables:' ;\
echo '# compile-command: "$(COQBIN)coq_makefile -f .coq_makefile_input -o CoqMakefile.make.tmp && mv CoqMakefile.make.tmp build/CoqMakefile.make"' ;\
echo '# End:' ;\
) >$@
# the '' above prevents emacs from mistaking the lines above as providing local variables when visiting this file
build/CoqMakefile.make: .coq_makefile_input
$(COQBIN)coq_makefile -f .coq_makefile_input -o .coq_makefile_output
mv .coq_makefile_output $@
# "clean::" occurs also in build/CoqMakefile.make, hence both colons
clean::
rm -f .coq_makefile_input .coq_makefile_output build/CoqMakefile.make COQC.log
find UniMath \( -name .\*.aux -o -name \*.glob -o -name \*.d -o -name \*.vo \) -delete
find UniMath -type d -empty -delete
clean::; rm -rf $(ENHANCEDDOCTARGET)
latex-clean clean::; cd $(LATEXDIR) ; rm -f *.pdf *.tex *.log *.aux *.out *.blg *.bbl
distclean:: clean
distclean:: ; - $(MAKE) -C sub/coq distclean
distclean:: ; rm -f build/Makefile-configuration
distclean:: ; - $(MAKE) -C sub/lablgtk arch-clean
# building coq:
export PATH:=$(shell pwd)/sub/coq/bin:$(PATH)
sub/coq/configure.ml:
git submodule update --init sub/coq
sub/coq/config/coq_config.ml: sub/coq/configure.ml
: making $@ because of $?
cd sub/coq && ./configure -coqide "$(COQIDE_OPTION)" -with-doc no -annotate -debug -local
# instead of "coqlight" below, we could use simply "theories/Init/Prelude.vo"
sub/coq/bin/coq_makefile sub/coq/bin/coqc: sub/coq/config/coq_config.ml
.PHONY: rebuild-coq
rebuild-coq sub/coq/bin/coq_makefile sub/coq/bin/coqc:
$(MAKE) -w -C sub/coq KEEP_ML4_PREPROCESSED=true VERBOSE=true READABLE_ML4=yes coqbinaries tools states
sub/coq/bin/coqide: sub/coq/config/coq_config.ml
$(MAKE) -w -C sub/coq KEEP_ML4_PREPROCESSED=true VERBOSE=true READABLE_ML4=yes coqide-files bin/coqide
configure-coq: sub/coq/config/coq_config.ml
git-describe:
git describe --dirty --long --always --abbrev=40
git submodule foreach git describe --dirty --long --always --abbrev=40 --tags
doc: $(GLOBFILES) $(VFILES)
mkdir -p $(ENHANCEDDOCTARGET)
cp $(ENHANCEDDOCSOURCE)/proofs-toggle.js $(ENHANCEDDOCTARGET)/proofs-toggle.js
$(COQDOC) -toc $(COQDOCFLAGS) -html $(COQDOCLIBS) -d $(ENHANCEDDOCTARGET) \
--with-header $(ENHANCEDDOCSOURCE)/header.html $(VFILES)
sed -i'.bk' -f $(ENHANCEDDOCSOURCE)/proofs-toggle.sed $(ENHANCEDDOCTARGET)/*html
# Jason Gross' coq-tools bug isolator:
# The isolated bug will appear in this file, in the UniMath directory:
ISOLATED_BUG_FILE := isolated_bug.v
# To use it, run something like this command in an interactive shell:
# make isolate-bug BUGGY_FILE=Foundations/Basics/PartB.v
sub/coq-tools/find-bug.py:
git submodule update --init sub/coq-tools
help-find-bug:
sub/coq-tools/find-bug.py --help
isolate-bug: sub/coq-tools/find-bug.py
cd UniMath && \
rm -f $(ISOLATED_BUG_FILE) && \
../sub/coq-tools/find-bug.py --coqbin ../sub/coq/bin -R . UniMath \
--arg " -indices-matter" \
--arg " -type-in-type" \
$(BUGGY_FILE) $(ISOLATED_BUG_FILE)
@ echo "==="
@ echo "=== the isolated bug has been deposited in the file UniMath/$(ISOLATED_BUG_FILE)"
@ echo "==="
world: all html doc latex-doc
latex-doc: $(LATEXDIR)/doc.pdf
$(LATEXDIR)/doc.pdf : $(LATEXDIR)/helper.tex $(LATEXDIR)/references.bib $(LATEXDIR)/latex-preamble.txt $(LATEXDIR)/helper.tex $(LATEXDIR)/latex-epilogue.txt
cd $(LATEXDIR) && cat latex-preamble.txt helper.tex latex-epilogue.txt > doc.tex
cd $(LATEXDIR) && latexmk -pdf -interaction=nonstopmode doc
$(LATEXDIR)/coqdoc.sty $(LATEXDIR)/helper.tex : $(VFILES:.v=.glob) $(VFILES)
$(COQDOC) -Q UniMath UniMath $(COQDOC_OPTIONS) $(COQDOCLATEXOPTIONS) $(VFILES) -o $@
.PHONY: enforce-max-line-length
enforce-max-line-length:
LC_ALL="en_US.UTF-8" gwc -L $(VFILES) | grep -vw total | awk '{ if ($$1 > 100) { printf "%6d %s\n", $$1, $$2 }}' | sort -r | grep .
show-long-lines:
LC_ALL="en_US.UTF-8" grep -nE '.{101}' $(VFILES)
# here we assume the shell is bash, which it usually is nowadays:
SHELL = bash
enforce-prescribed-ordering: .enforce-prescribed-ordering.okay
clean::; rm -f .enforce-prescribed-ordering.okay
ifdef VDFILE
# Coq >= 8.8
.enforce-prescribed-ordering.okay: Makefile $(VDFILE).d
: "--- enforce ordering prescribed by the files UniMath/*/.packages/files ---"
@set -e ; \
if declare -A seqnum 2>/dev/null ; \
then n=0 ; \
for i in $(VOFILES) ; \
do n=$$(( $$n + 1 )) ; \
seqnum[$$i]=$$n ; \
done ; \
for i in $(VFILES:.v=.vo); \
do grep $(VDFILE).d $$i ; \
done \
| sed -E -e 's/[^ ]*\.(glob|v\.beautified|v)([ :]|$$)/\2/g' -e 's/ *: */ /' \
| while read line ; \
do for i in $$line ; do echo $$i ; done \
| ( read target ; \
[ "$${seqnum[$$target]}" ] || (echo unknown target: $$target; false) >&2 ; \
while read prereq ; \
do [ "$${seqnum[$$prereq]}" ] || (echo "unknown prereq of $$target : $$prereq" ; false) >&2 ; \
echo "$$(($${seqnum[$$target]} > $${seqnum[$$prereq]})) error: *** $$target should not require $$prereq" ; \
done ) ; \
done | grep ^0 | sed 's/^0 //' | \
( haderror= ; \
while read line ; \
do if [ ! "$$haderror" ] ; then haderror=1 ; fi ; \
echo "$$line" ; \
done ; \
[ ! "$$haderror" ] ) ; \
else echo "make: *** skipping enforcement of linear ordering of packages, because 'bash' is too old" ; \
fi
touch $@
else
.enforce-prescribed-ordering.okay: Makefile $(VFILES:.v=.v.d)
: "--- enforce ordering prescribed by the files UniMath/*/.packages/files ---"
@set -e ; \
if declare -A seqnum 2>/dev/null ; \
then n=0 ; \
for i in $(VOFILES) ; \
do n=$$(( $$n + 1 )) ; \
seqnum[$$i]=$$n ; \
done ; \
for i in $(VFILES:.v=.v.d); \
do head -1 $$i ; \
done \
| sed -E -e 's/[^ ]*\.(glob|v\.beautified|v)([ :]|$$)/\2/g' -e 's/ *: */ /' \
| while read line ; \
do for i in $$line ; do echo $$i ; done \
| ( read target ; \
[ "$${seqnum[$$target]}" ] || (echo unknown target: $$target; false) >&2 ; \
while read prereq ; \
do [ "$${seqnum[$$prereq]}" ] || (echo "unknown prereq of $$target : $$prereq" ; false) >&2 ; \
echo "$$(($${seqnum[$$target]} > $${seqnum[$$prereq]})) error: *** $$target should not require $$prereq" ; \
done ) ; \
done | grep ^0 | sed 's/^0 //' | \
( haderror= ; \
while read line ; \
do if [ ! "$$haderror" ] ; then haderror=1 ; fi ; \
echo "$$line" ; \
done ; \
[ ! "$$haderror" ] ) ; \
else echo "make: *** skipping enforcement of linear ordering of packages, because 'bash' is too old" ; \
fi
touch $@
endif
# here we ensure that the travis script checks every package
check-travis:.check-travis.okay
clean::; rm -f .check-travis.okay
.check-travis.okay: Makefile .travis.yml
: --- check travis script ---
@set -e ; \
for p in $(PACKAGES) ; \
do grep -q "PACKAGES=.*$$p" .travis.yml || ( echo "package $$p not checked by .travis.yml" >&2 ; exit 1 ) ; \
done
touch "$@"
# here we ensure that every *.v file F in each package P is listed in the corresponding file UniMath/P/.package/files
# except for those listed in $GRANDFATHER_UNLISTED (currently none)
GRANDFATHER_UNLISTED =
enforce-listing-of-proof-files:
@ if declare -A islisted 2>/dev/null ; \
then for i in $(VFILES) $(GRANDFATHER_UNLISTED) ; \
do islisted[$$i]=yes ; \
done ; \
m=0 ; \
for P in $(PACKAGES) ; \
do find UniMath/$$P -name '*.v' | \
( \
n=0 ; \
while read F ; \
do if [ "$${islisted[$$F]}" != yes ] ; \
then echo "error: *** file $$F not listed in appropriate file UniMath/*/.package/files" >&2 ; \
n=$$(( $$n + 1 )) ; \
fi ; \
done ; exit $$n ) ; \
m=$$(( $$m + $$? )) ; \
done ; \
if [ $$m != 0 ] ; \
then echo "error: *** $$m unlisted proof files encountered" >&2 ; \
exit 1 ; \
fi ; \
else echo "make: *** skipping enforcement of listing of proof files, because 'bash' is too old" ; \
fi
# Here we check for changes to UniMath/Foundations, which normally does not change.
# One step of the travis job will fail, if a change is made, see .travis.yml
ifneq ($(FOUNDATIONS_CHANGE_ERROR),yes)
FOUNDATIONS_CHANGE_ERROR0 = -
endif
check-for-change-to-Foundations:
$(FOUNDATIONS_CHANGE_ERROR0) ! ( git diff --stat master -- UniMath/Foundations | grep . )
# Here we create a table of contents file, in markdown format, for browsing on github
# When the file UniMath/CONTENTS.md changes, the new version should be committed to github.
all: UniMath/CONTENTS.md
UniMath/CONTENTS.md: Makefile UniMath/*/.package/files
$(SHOW)'making $@'
$(HIDE) exec >$@ ; \
echo "# Contents of the UniMath library" ; \
echo "The packages and files are listed here in logical order: each file depends only on files ocurring earlier." ; \
for P in $(PACKAGES) ; \
do if [ -f UniMath/$$P/README.md ] ; \
then echo "## Package [$$P]($$P/README.md)" ; \
elif [ -f UniMath/$$P/README ] ; \
then echo "## Package [$$P]($$P/README)" ; \
else echo "## Package $$P" ; \
fi ; \
for F in `<UniMath/$$P/.package/files $(FILES_FILTER)` ; \
do echo " - [$$F]($$P/$$F)" ; \
done ; \
done
#################################
# targets best used with INCLUDE=no
git-clean:
git clean -Xdfq
git submodule foreach git clean -xdfq
git-deinit:
git submodule foreach git clean -xdfq
git submodule deinit -f sub/*
#################################