5 Goalfile - introduction, tutorial, and reference for writing goal files
15 =head2 Standard Functions
17 =head3 basename (path)
21 basename ("dir/file.ext") ⇒ "file.ext"
23 Returns the filename part of the path.
29 dirname ("dir/file.ext") ⇒ "dir"
31 Returns the directory part of the path.
37 error ("this should not happen")
39 This prints the error message and causes goals to exit.
41 =head3 extension (filename)
45 extension ("dir/file.ext") ⇒ "ext"
47 Returns the filename extension.
53 head (["a", "b", "c"]) ⇒ "a"
55 Returns the head (first) element of the list.
57 =head3 join (list1, list2)
61 join (["a", "b"], ["c", "d"]) ⇒ ["a", "b", "c", "d"]
63 Concatenate C<list1> and C<list2>. It's not usually necessary to use
64 this function since goals automatically flattens lists within lists
65 into simple lists in many cases.
67 =head3 read (filename)
71 read ("filename") => "this is the content of filename"
73 Read the contents of C<filename> and return it as a single string.
74 If there is a trailing C<\n> in the file it is truncated.
76 =head3 readlines (filename)
80 readlines ("filename") => ["line1", "line2", "line3"]
82 Read the lines in C<filename> returning a list of strings.
84 =head3 realpath (filename)
88 realpath ("./tests") ⇒ "/home/user/tests"
90 Run the L<realpath(1)> command to return the resolved absolute path of
91 the C<filename> parameter.
97 sort (["c", "b", "b", "a"]) ⇒ ["a", "b", "c"]
99 This takes a list of strings and sorts it, removing duplicates.
101 =head3 subst (from, to, text)
105 subst ("aa", "AA", "aabbccaa") ⇒ "AAbbccAA"
106 subst ("a.*c", "b", "aaacac") ⇒ "bb"
108 This function works something like make’s C<subst> function, except
109 that C<from> is a regular expression, specifically a L<sed(1)>
110 extended regular expression.
116 tail (["a", "b", "c"]) ⇒ ["b", "c"]
118 Returns the tail (all except first) elements of the list.
120 =head3 wildcard (pattern)
124 wildcard ("*.c") ⇒ ["bar.c", "foo.c"]
126 The single parameter is a wildcard which is expanded into a list of
127 files using ordinary globbing rules.
129 =head3 wrap (wrapper, list)
133 wrap ("*file", ["bar.c", "foo.c"]) ⇒ [*file("bar.c"), *file("foo.c")]
135 Each element in C<list> is wrapped into a call to C<wrapper(element)>.
136 There are two common uses for this: either to add explicit tactics
137 (such as C<*file>) to a plain list of strings as in the example above;
138 or to turn a list of strings into a list of goal or function calls.
146 Richard W.M. Jones <rjones@redhat.com>
150 Copyright (C) 2020 Richard W.M. Jones
152 Copyright (C) 2020 Red Hat Inc.
154 This program is free software; you can redistribute it and/or modify
155 it under the terms of the GNU General Public License as published by
156 the Free Software Foundation; either version 2 of the License, or
157 (at your option) any later version.
159 This program is distributed in the hope that it will be useful,
160 but WITHOUT ANY WARRANTY; without even the implied warranty of
161 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
162 GNU General Public License for more details.
164 You should have received a copy of the GNU General Public License along
165 with this program; if not, write to the Free Software Foundation, Inc.,
166 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.