docs: Remove separate goals-reference manual.
[goals.git] / stdlib / prelude.gl
1 # Goals stdlib prelude.
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 # This file is included first and automatically in all Goalfiles
20 # (unless you use --no-prelude).  It contains standard functions and
21 # tactics.
22
23 # The only tactic that ‘make’ has.
24 tactic *file (filename) = @{
25     # Rebuild if the target file doesn't exist at all.
26     test -f %filename || exit 99
27
28     # Otherwise rebuild if it is older than any dependency.
29     for f in %<; do
30         test %filename -ot "$f" && exit 99 ||:
31     done
32 }
33
34 # This is a simpler tactic than the above since it will
35 # rebuild if the file is missing, but not if it is older.
36 tactic *exists (filename) = @{
37     test -f %filename || exit 99
38 }
39
40 #----------------------------------------------------------------------
41 # Basic functions.
42
43 # Wrap list of strings in a call or tactic.
44 pure function wrap (wrapper, xs) = @{
45     echo '['
46     for x in %xs; do
47         echo %wrapper "( "
48         quoted_string "$x"
49         echo " ),"
50     done
51     echo ']'
52 }
53
54 #----------------------------------------------------------------------
55 # Text functions.
56
57 # Sort + uniq a list.
58 pure function sort (xs) returning strings = @{
59     for f in %xs; do echo "$f"; done | sort -u
60 }
61
62 #----------------------------------------------------------------------
63 # File functions.
64
65 # Expand a wildcard into a list of filenames.
66 #
67 # This function is probably not "pure" since it depends on the
68 # current working directory and also files may be created in
69 # the directory while goals is running which would affect the
70 # result.
71 function wildcard (wc) returning strings = @{
72     shopt -s nullglob
73     # Note that the substitution is quoted by goals, so to expand
74     # it we must assign it to a variable and then use it unquoted.
75     wc=%wc
76     for f in $wc; do echo "$f"; done
77 }