Split implementation into dependency analysis and traversal.
[goals.git] / Goalfile.in
1 # Goalfile
2 # Copyright (C) 2019 Richard W.M. Jones
3 # Copyright (C) 2019 Red Hat Inc.
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License along
16 # with this program; if not, write to the Free Software Foundation, Inc.,
17 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18
19 include "ocaml.gl"
20
21 let subdirs = [ "m4", "src", "stdlib", "docs", "man", "tests" ]
22
23 goal all = : "Goalfile", tool, documentation;
24
25 "Goalfile": "Goalfile.in", "config.status" {
26     ./config.status %@
27 }
28 "src/config.ml" : "src/config.ml.in", "config.status" {
29     ./config.status %@
30 }
31
32 goal clean = {
33     for d in %subdirs; do
34         pushd $d
35         rm -f *~
36         rm -f *.cmi *.cmo *.cmx *.o
37         popd
38     done
39     rm -f src/parser.ml src/parser.mli src/lexer.ml src/parser.conflicts
40     rm -f man/*.1 man/*.5
41
42     # We don't delete src/goals because it is required to do builds.
43     # If you want to really delete it, use the maintainer-clean rule.
44 }
45
46 goal maintainer-clean = : clean {
47     rm -f src/goals
48 }
49
50 #----------------------------------------------------------------------
51 # Build the goals tool itself.
52
53 let MENHIR = "@MENHIR@"
54 let OCAMLDEP = "@OCAMLDEP@"
55 let OCAMLFIND = "@OCAMLFIND@"
56 let OCAMLLEX = "@OCAMLLEX@"
57 # XXX
58 let OCAMLFLAGS = [ "-g", "-safe-string", "-warn-error", "CDEFLMPSUVYZX+52-3" ]
59 let OCAMLPACKAGES = [ "-package", "str,unix,threads", "-I", "src", "-thread" ]
60 #let OCAMLFLAGS = "@OCAMLFLAGS@"
61 #let OCAMLPACKAGES = "@OCAMLPACKAGES@"
62
63 let objects = [
64     # These must be in dependency order.
65     "src/config.cmx",
66     "src/utils.cmx",
67     "src/cmdline.cmx",
68     "src/jobs.cmx",
69     "src/ast.cmx",
70     "src/parser.cmx",
71     "src/lexer.cmx",
72     "src/parse.cmx",
73     "src/eval.cmx",
74     "src/deps.cmx",
75     "src/run.cmx",
76     "src/main.cmx"
77 ]
78
79 goal tool = : ocaml_link ("src/goals", objects) ;
80
81 # Parser.
82 "src/parser.mli", "src/parser.ml" : "src/parser.mly" {
83     %MENHIR --explain %<
84     # Hack required to break circular dependencies.
85     echo 'val lexer_read : (Lexing.lexbuf -> token) option ref' >> src/parser.mli
86     echo 'val eval_substitute : (Ast.env -> Ast.loc -> Ast.substs -> string) option ref' >> src/parser.mli
87 }
88
89 "src/lexer.ml" : "src/lexer.mll" {
90     %OCAMLLEX %<
91 }
92
93 # XXX Goalfile itself depends on this and we should probably have a
94 # way to reevaluate it.
95 # XXX Atomic output.
96 goal depend =
97 "src/.depend" : wildcard ("src/*.ml"), wildcard ("src/*.mli") {
98     rm -f %@ %@-t
99     # Like many existing tools, ocamldep produces make-compatible
100     # output which doesn't work directly in goals.
101     %OCAMLDEP -all -one-line -I src %< |
102         sed 's|[./[:alnum:]]\+|"&"|g' |
103         sed 's|" "|", "|g' |
104         sed 's|.*|& ;|' > %@-t
105     mv %@-t %@
106 }
107
108 -include "src/.depend";
109
110 #----------------------------------------------------------------------
111 # Documentation.
112
113 let POD2MAN = "@POD2MAN@"
114
115 goal documentation = : pod2man ("goals", "1"),
116                        pod2man ("Goalfile", "5"),
117                        pod2man ("goals-reference", "5")
118
119 goal pod2man (page, section) =
120 "man/%page.%section" : "docs/%page.pod" {
121     rm -f %@ %@-t
122     mkdir -p man
123     %POD2MAN \
124         -u \
125         -c "goals" \
126         --release "@PACKAGE_NAME@-@PACKAGE_VERSION@" \
127         --section %section %< > %@-t
128     mv %@-t %@
129 }