Implement -d (debug) option.
[goals.git] / src / cmdline.ml
1 (* Goalfile command line
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
20 open Printf
21
22 open Utils
23
24 (* See also "let id" in [lexer.mll]. *)
25 let var_regexp =
26   Str.regexp "\\([a-zA-Z_][a-zA-Z0-9_]*\\)[ \t]*=[ \t]*\\(.*\\)"
27
28 let usage =
29   "\
30 goals: Build software.
31
32  goals [-f Goalfile] ['var=value' ...] ['target' ...]
33
34 For detailed help see goals(1).
35
36 Options:"
37
38 let print_version () =
39   printf "%s %s\n" Config.package_name Config.package_version;
40   exit 0
41
42 (* Get stdlib directory. *)
43 let datadir =
44   try Sys.getenv "GOALS_DATADIR" with Not_found -> Config.datadir
45 let stdlibdir = datadir // "stdlib"
46 let prelude_file = stdlibdir // "prelude.gl"
47 let () =
48   if not (is_directory stdlibdir) || not (Sys.file_exists prelude_file) then
49     failwithf "%s: cannot find the standard library directory, expected %s.  If the standard library directory is in a non-standard location then set GOALS_DATADIR.  If you can trying to run goals from the build directory then use ‘./run goals ...’"
50       Sys.executable_name stdlibdir
51
52 let input_file,
53     debug_flag, directory, includes, use_prelude, anon_vars, targets =
54   let args = ref [] in
55   let debug_flag = ref false in
56   let directory = ref "." in
57   let input_file = ref "Goalfile" in
58   let includes = ref [stdlibdir] in
59   let add_include dir = includes := dir :: !includes in
60   let use_prelude = ref true in
61
62   let argspec = [
63     "-C",          Arg.Set_string directory,
64                    "directory Change to directory before running";
65     "-d",          Arg.Set debug_flag,
66                    " Print debug information.";
67     "--directory", Arg.Set_string directory,
68                    "directory Change to directory before running";
69     "-f",          Arg.Set_string input_file,
70                    "filename Set name of Goalfile";
71     "--file",      Arg.Set_string input_file,
72                    "filename Set name of Goalfile";
73     "-I",          Arg.String add_include,
74                    "dir Add include directory";
75     "--include",   Arg.String add_include,
76                    "dir Add include directory";
77     "--no-prelude",Arg.Clear use_prelude,
78                    " Do not automatically use prelude.gl from stdlib";
79     "-v",          Arg.Unit print_version,
80                    " Print version and exit";
81     "--version",   Arg.Unit print_version,
82                    " Print version and exit";
83   ] in
84   let argspec = Arg.align argspec in
85   let anon_fun s = args := s :: !args in
86   Arg.parse argspec anon_fun usage;
87
88   let args = List.rev !args in
89   let debug_flag = !debug_flag in
90   let directory = !directory in
91   let input_file = absolute_path !input_file in
92   (* Don't reverse includes - we want newer -I options to take precedence. *)
93   let includes = List.map absolute_path !includes in
94   let use_prelude = !use_prelude in
95
96   (* Get the anon var assignments and targets. *)
97   let anon_vars, targets =
98     List.partition (
99       fun arg -> Str.string_match var_regexp arg 0
100     ) args in
101   let anon_vars =
102     List.map (
103       fun arg ->
104         ignore (Str.string_match var_regexp arg 0);
105         let name = Str.matched_group 1 arg in
106         let expr = Str.matched_group 2 arg in
107         (name, expr)
108     ) anon_vars in
109
110   input_file,
111   debug_flag, directory, includes, use_prelude, anon_vars, targets
112
113 (* Create the debug function. *)
114 let debug fs =
115   let display str = if debug_flag then prerr_endline str in
116   ksprintf display fs