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 function error (msg) = @{
  44     echo %msg >&2
  45     exit 1
  46 }
  47
  48 # Wrap list of strings in a call or tactic.
  49 pure function wrap (wrapper, xs) = @{
  50     echo '['
  51     for x in %xs; do
  52         echo %wrapper "( "
  53         quoted_string "$x"
  54         echo " ),"
  55     done
  56     echo ']'
  57 }
  58
  59 #----------------------------------------------------------------------
  60 # Text functions.
  61
  62 # Head of a list.
  63 pure function head (xs) returning string = @{
  64     for f in %xs; do
  65         echo "$f"
  66         exit 0
  67     done
  68 }
  69
  70 # Join two lists.
  71 pure function join (xs, ys) returning strings = @{
  72     for f in %xs %ys; do echo "$f"; done
  73 }
  74
  75 # Sort + uniq a list.
  76 pure function sort (xs) returning strings = @{
  77     for f in %xs; do echo "$f"; done | sort -u
  78 }
  79
  80 # Substitute.
  81 pure function subst (from, to, text) returning string = @{
  82     # We need to replace any / characters in ‘to’ with escaped ones.
  83     to="$( echo -n %to | sed 's,/,\\/,g' )"
  84     echo %text | sed -E s/%from/$to/g
  85 }
  86
  87 # Tail of a list.
  88 pure function tail (xs) returning strings = @{
  89     drop=1
  90     for f in %xs; do
  91         if [ -z "$drop" ]; then echo "$f"; fi
  92         drop=
  93     done
  94 }
  95
  96 #----------------------------------------------------------------------
  97 # File functions.
  98
  99 # Base name.
 100 pure function basename (name) returning string = @{
 101     basename %name
 102 }
 103
 104 # Directory name.
 105 pure function dirname (name) returning string = @{
 106     dirname %name
 107 }
 108
 109 # File extension.
 110 pure function extension (name) returning string = @{
 111     name=%name
 112     echo "${name##*.}"
 113 }
 114
 115 # Read a file.
 116 function read (filename) returning string = @{
 117     cat %filename
 118 }
 119
 120 # Read a file as a list of lines.
 121 function readlines (filename) returning strings = @{
 122     cat %filename
 123 }
 124
 125 # Real path.
 126 function realpath (filename) returning string = @{
 127     realpath -- %filename
 128 }
 129
 130 # Expand a wildcard into a list of filenames.
 131 #
 132 # This function is probably not "pure" since it depends on the
 133 # current working directory and also files may be created in
 134 # the directory while goals is running which would affect the
 135 # result.
 136 function wildcard (wc) returning strings = @{
 137     shopt -s nullglob
 138     # Note that the substitution is quoted by goals, so to expand
 139     # it we must assign it to a variable and then use it unquoted.
 140     wc=%wc
 141     for f in $wc; do echo "$f"; done
 142 }