Makefile 6.89 KB
Newer Older
1
# This is the main Makefile that is shipped as part of the source package.
2

3
# Keep in mind that the hierarchy that is shipped is not identical to the
4
5
6
7
8
# hierarchy within the git repository. Some sub-directories are not shipped.
# The documentation (manual.pdf, menhir.1) is pre-built and stored at the root.

# This Makefile can also be used directly in the repository. In that case,
# the documentation and demos are not installed.
9
10
11
12
13
14
15
16
17
18

# The hierarchy that is shipped includes:
#   demos
#   menhir.1
#   manual.pdf
#   src
#   Makefile (this one)

# ----------------------------------------------------------------------------

fpottier's avatar
fpottier committed
19
20
21
22
23
24
25
26
27
28
29
30
# The following variables must/can be configured.

ifndef PREFIX
  $(error Please define PREFIX)
endif

ifndef TARGET
  TARGET := native
endif

# ----------------------------------------------------------------------------

POTTIER Francois's avatar
Typo.    
POTTIER Francois committed
31
# By default, we attempt to use ocamlfind (if present in the PATH), but it
32
33
# is possible to prevent that externally by setting USE_OCAMLFIND to false.

34
35
36
37
38
# USE_OCAMLFIND is used only at build time (i.e., by "make all"). At
# (un)installation time, instead, we query menhir using --suggest-ocamlfind.
# This should protect us against people who pass USE_OCAMLFIND at build time
# and forget to pass it at (un)installation time.

39
40
41
42
ifndef USE_OCAMLFIND
  USE_OCAMLFIND = ocamlfind ocamlc -v >/dev/null 2>&1
endif

43
44
# ----------------------------------------------------------------------------
# Installation paths.
45
46
# These may be overridden from outside; e.g., our opam package description
# provides its own values of docdir, libdir, and mandir.
47

48
49
50
51
bindir          := $(PREFIX)/bin
docdir		:= $(PREFIX)/share/doc/menhir
libdir	        := $(PREFIX)/share/menhir
mandir          := $(PREFIX)/share/man/man1
52
53
54
55
MANS            := menhir.1
DOCS            := manual.pdf demos
MLYLIB          := src/standard.mly

56
57
58
59
# ----------------------------------------------------------------------------

# A few settings differ on Windows versus Unix.

60
61
62
# If the compiler is MSVC, then the name of the executable file ends in .exe,
# and object file names end in .obj instead of .o.

63
ifneq (,$(shell ocamlc -config | grep -E "ccomp_type: msvc"))
64
65
  MENHIREXE    := menhir.exe
  OBJ          := obj
fpottier's avatar
fpottier committed
66
67
# LIBSUFFIX    := lib
else
68
69
  MENHIREXE    := menhir
  OBJ          := o
fpottier's avatar
fpottier committed
70
71
# LIBSUFFIX    := a
endif
72

73
74
# The path $(installation_libdir), which is recorded in src/installation.ml (see
# below), must sometimes be translated using cygpath.
75
76
77
78
79
80
81
82
83
84

# This one is tricky. To summarize, if I understood correctly, we can assume
# that Cygwin always exists when Menhir is compiled and installed (because
# executing a Makefile, like this one, requires Cygwin), but we cannot assume
# that Menhir will be executed under Cygwin. If the OCaml compiler is
# configured to produce a Cygwin executable, then, yes, Cygwin is there at
# execution time, so path translation is not necessary (and should not be
# performed). On the other hand, if the OCaml compiler is configured to
# produce a native Windows executable, then Cygwin is not there at execution
# time and path translation is required. In summary, path translation must be
POTTIER Francois's avatar
Typo.    
POTTIER Francois committed
85
# performed if "os_type" is "Win32" or "Win64", and must not be performed if
86
87
# "os_type" is "Cygwin" or "Unix".

88
ifneq (,$(shell ocamlc -config | grep -E "os_type: (Win32|Win64)"))
89
90
91
installation_libdir := $(shell cygpath -m $(libdir))
else
installation_libdir := $(libdir)
92
endif
93

94
95
96
97
98
99
100
# -------------------------------------------------------------------------

# The names of the modules in MenhirLib are obtained by reading the
# non-comment lines in menhirLib.mlpack.

MENHIRLIB_MODULES := $(shell grep -ve "^[ \t\n\r]*\#" src/menhirLib.mlpack)

101
102
# ----------------------------------------------------------------------------

103
# The directory where things are built.
104

105
106
BUILDDIR := src/_stage2

107
108
109
# ----------------------------------------------------------------------------

# Compilation.
110
111
112
113

.PHONY: all install uninstall

all:
114
115
# Installation time settings are recorded within src/installation.ml.
# This file is recreated every time so as to avoid becoming stale.
116
	@ rm -f src/installation.ml
117
	@ echo "let libdir = \"$(installation_libdir)\"" > src/installation.ml
118
	@ if $(USE_OCAMLFIND) ; then \
119
120
121
122
	  echo "let ocamlfind = true" >> src/installation.ml ; \
	else \
	  echo "let ocamlfind = false" >> src/installation.ml ; \
	fi
123
# Compile the library modules and the Menhir executable.
124
125
126
127
128
129
	@ $(MAKE) -C src library bootstrap
# The source file menhirLib.ml is created by concatenating all of the source
# files that make up MenhirLib. This file is not needed to compile Menhir or
# MenhirLib. It is installed at the same time as MenhirLib and is copied by
# Menhir when the user requests a self-contained parser (one that is not
# dependent on MenhirLib).
130
131
	@ echo "Creating menhirLib.ml"
	@ rm -f $(BUILDDIR)/menhirLib.ml
132
	@ for m in $(MENHIRLIB_MODULES) ; do \
133
134
135
	  echo "module $$m = struct" >> $(BUILDDIR)/menhirLib.ml ; \
	  cat src/$$m.ml >> $(BUILDDIR)/menhirLib.ml ; \
	  echo "end" >> $(BUILDDIR)/menhirLib.ml ; \
136
137
138
139
140
	done
# The source file menhirLib.mli is created in the same way. If a module
# does not have an .mli file, then we assume that its .ml file contains
# type (and module type) definitions only, so we copy it instead of the
# (non-existent) .mli file.
141
142
	@ echo "Creating menhirLib.mli"
	@ rm -f $(BUILDDIR)/menhirLib.mli
143
	@ for m in $(MENHIRLIB_MODULES) ; do \
144
	  echo "module $$m : sig" >> $(BUILDDIR)/menhirLib.mli ; \
145
	  if [ -f src/$$m.mli ] ; then \
146
	    cat src/$$m.mli >> $(BUILDDIR)/menhirLib.mli ; \
147
	  else \
148
	    cat src/$$m.ml >> $(BUILDDIR)/menhirLib.mli ; \
149
	  fi ; \
150
	  echo "end" >> $(BUILDDIR)/menhirLib.mli ; \
151
152
153
154
155
156
157
158
159
160
	done

# -------------------------------------------------------------------------

# The files that should be installed as part of menhirLib.

MENHIRLIB       := menhirLib.mli menhirLib.ml menhirLib.cmi menhirLib.cmo
ifneq ($(TARGET),byte)
MENHIRLIB       := $(MENHIRLIB) menhirLib.cmx menhirLib.$(OBJ)
endif
161
162
163
164

# ----------------------------------------------------------------------------
# Installation.

165
install:
166
# Install the executable.
167
	mkdir -p $(bindir)
168
	install $(BUILDDIR)/menhir.$(TARGET) $(bindir)/$(MENHIREXE)
169
170
# Install the library.
	mkdir -p $(libdir)
171
	install -m 644 $(MLYLIB) $(libdir)
172
	@if `$(BUILDDIR)/menhir.$(TARGET) --suggest-ocamlfind | tr -d '\r'` ; then \
173
	  echo 'Installing MenhirLib via ocamlfind.' ; \
fpottier's avatar
fpottier committed
174
	  ocamlfind install menhirLib src/META $(patsubst %,$(BUILDDIR)/%,$(MENHIRLIB)) ; \
175
	else \
176
	  echo 'Installing MenhirLib manually.' ; \
fpottier's avatar
fpottier committed
177
	  install -m 644 $(patsubst %,$(BUILDDIR)/%,$(MENHIRLIB)) $(libdir) ; \
178
	fi
179
180
# Install the documentation, if it has been built.
	if [ -f manual.pdf ] ; then \
181
182
	  mkdir -p $(docdir) $(mandir) && \
	  cp -r $(DOCS) $(docdir) && \
183
184
	  cp -r $(MANS) $(mandir) ; \
	fi
185
186

uninstall:
187
	@if `$(bindir)/$(MENHIREXE) --suggest-ocamlfind` ; then \
188
	  echo 'Un-installing MenhirLib via ocamlfind.' ; \
189
190
	  ocamlfind remove menhirLib ; \
	fi
191
192
	rm -rf $(bindir)/$(MENHIREXE)
	rm -rf $(libdir)
193
194
	rm -rf $(docdir)
	rm -rf $(mandir)/$(MANS)