docs/Goalfile.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 Goalfile - introduction, tutorial, and reference for writing goal files
   6
   7 =head1 SUMMARY
   8
   9 =head1 INTRODUCTION
  10
  11 =head1 TUTORIAL
  12
  13 =head1 REFERENCE
  14
  15 =head2 Standard Functions
  16
  17 =head3 basename (path)
  18
  19 For example:
  20
  21  basename ("dir/file.ext") ⇒ "file.ext"
  22
  23 Returns the filename part of the path.
  24
  25 =head3 dirname (path)
  26
  27 For example:
  28
  29  dirname ("dir/file.ext") ⇒ "dir"
  30
  31 Returns the directory part of the path.
  32
  33 =head3 extension (filename)
  34
  35 For example:
  36
  37  extension ("dir/file.ext") ⇒ "ext"
  38
  39 Returns the filename extension.
  40
  41 =head3 head (list)
  42
  43 For example:
  44
  45  head (["a", "b", "c"]) ⇒ "a"
  46
  47 Returns the head (first) element of the list.
  48
  49 =head3 join (list1, list2)
  50
  51 For example:
  52
  53  join (["a", "b"], ["c", "d"]) ⇒ ["a", "b", "c", "d"]
  54
  55 Concatenate C<list1> and C<list2>.  It's not usually necessary to use
  56 this function since goals automatically flattens lists within lists
  57 into simple lists in many cases.
  58
  59 =head3 read (filename)
  60
  61 For example:
  62
  63  read ("filename") => "this is the content of filename"
  64
  65 Read the contents of C<filename> and return it as a single string.
  66 If there is a trailing C<\n> in the file it is truncated.
  67
  68 =head3 readlines (filename)
  69
  70 For example:
  71
  72  readlines ("filename") => ["line1", "line2", "line3"]
  73
  74 Read the lines in C<filename> returning a list of strings.
  75
  76 =head3 realpath (filename)
  77
  78 For example:
  79
  80  realpath ("./tests") ⇒ "/home/user/tests"
  81
  82 Run the L<realpath(1)> command to return the resolved absolute path of
  83 the C<filename> parameter.
  84
  85 =head3 sort (list)
  86
  87 For example:
  88
  89  sort (["c", "b", "b", "a"]) ⇒ ["a", "b", "c"]
  90
  91 This takes a list of strings and sorts it, removing duplicates.
  92
  93 =head3 subst (from, to, text)
  94
  95 For example:
  96
  97  subst ("aa", "AA", "aabbccaa") ⇒ "AAbbccAA"
  98  subst ("a.*c", "b", "aaacac") ⇒ "bb"
  99
 100 This function works something like make’s C<subst> function, except
 101 that C<from> is a regular expression, specifically a L<sed(1)>
 102 extended regular expression.
 103
 104 =head3 tail (list)
 105
 106 For example:
 107
 108  tail (["a", "b", "c"]) ⇒ ["b", "c"]
 109
 110 Returns the tail (all except first) elements of the list.
 111
 112 =head3 wildcard (pattern)
 113
 114 For example:
 115
 116  wildcard ("*.c") ⇒ ["bar.c", "foo.c"]
 117
 118 The single parameter is a wildcard which is expanded into a list of
 119 files using ordinary globbing rules.
 120
 121 =head3 wrap (wrapper, list)
 122
 123 For example:
 124
 125  wrap ("*file", ["bar.c", "foo.c"]) ⇒ [*file("bar.c"), *file("foo.c")]
 126
 127 Each element in C<list> is wrapped into a call to C<wrapper(element)>.
 128 There are two common uses for this: either to add explicit tactics
 129 (such as C<*file>) to a plain list of strings as in the example above;
 130 or to turn a list of strings into a list of goal or function calls.
 131
 132 =head1 SEE ALSO
 133
 134 L<goals(1)>.
 135
 136 =head1 AUTHORS
 137
 138 Richard W.M. Jones <rjones@redhat.com>
 139
 140 =head1 COPYRIGHT
 141
 142 Copyright (C) 2020 Richard W.M. Jones
 143
 144 Copyright (C) 2020 Red Hat Inc.
 145
 146 This program is free software; you can redistribute it and/or modify
 147 it under the terms of the GNU General Public License as published by
 148 the Free Software Foundation; either version 2 of the License, or
 149 (at your option) any later version.
 150
 151 This program is distributed in the hope that it will be useful,
 152 but WITHOUT ANY WARRANTY; without even the implied warranty of
 153 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 154 GNU General Public License for more details.
 155
 156 You should have received a copy of the GNU General Public License along
 157 with this program; if not, write to the Free Software Foundation, Inc.,
 158 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.