src/ast.ml

   1 (* Goalfile Abstract Syntax Tree
   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 Lexing
  21 open Printf
  22
  23 open Utils
  24
  25 module Env = Map.Make (String)
  26
  27 type loc = position * position
  28 let noloc = dummy_pos, dummy_pos
  29
  30 let string_loc () loc =
  31   let pos = fst loc in
  32   sprintf "%s:%d:%d" pos.pos_fname pos.pos_lnum (pos.pos_cnum - pos.pos_bol)
  33 let print_loc fp loc =
  34   fprintf fp "%s" (string_loc () loc)
  35
  36 type env = expr Env.t
  37 and pattern =
  38   | PTactic of loc * id * substs list
  39   | PVar of loc * id
  40 and expr =
  41   | EGoal of loc * goal
  42   | ECall of loc * id * expr list
  43   | ETactic of loc * id * expr list
  44   | EVar of loc * id
  45   | EList of loc * expr list
  46   | ESubsts of loc * substs
  47   | EConstant of loc * constant
  48 and constant =
  49   | CString of string
  50 and goal = param_decl list * pattern list * expr list * code option
  51 and param_decl = id
  52 and id = string
  53 and code = substs
  54 and substs = subst list
  55 and subst =
  56   | SString of string
  57   | SVar of id
  58
  59 let getvar env loc name =
  60   try Env.find name env
  61   with Not_found ->
  62     failwithf "%a: variable ‘%s’ not found" string_loc loc name
  63
  64 let getgoal env loc name =
  65   let expr =
  66     try Env.find name env
  67     with Not_found ->
  68       failwithf "%a: goal ‘%s’ not found" string_loc loc name in
  69   let goal =
  70     match expr with
  71     | EGoal (loc, goal) -> goal
  72     | _ ->
  73        failwithf "%a: tried to call ‘%s’ which is not a goal"
  74          string_loc loc name in
  75   goal
  76
  77 let rec to_constant env = function
  78   | EConstant (loc, c) -> c
  79
  80   | EVar (loc, name) ->
  81      let expr = getvar env loc name in
  82      to_constant env expr
  83
  84   | ESubsts (loc, str) ->
  85      CString (substitute env loc str)
  86
  87   | EList (loc, _) ->
  88      failwithf "%a: list found where constant expression expected"
  89        string_loc loc
  90
  91   | ECall (loc, name, _) ->
  92      failwithf "%a: cannot use goal ‘%s’ in constant expression"
  93        string_loc loc name
  94
  95   | ETactic (loc, name, _) ->
  96      failwithf "%a: cannot use tactic ‘*%s’ in constant expression"
  97        string_loc loc name
  98
  99   | EGoal (loc, _) ->
 100      failwithf "%a: cannot use goal in constant expression"
 101        string_loc loc
 102
 103 and substitute env loc substs =
 104   let b = Buffer.create 13 in
 105   List.iter (
 106     function
 107     | SString s -> Buffer.add_string b s
 108     | SVar name ->
 109        let expr = getvar env loc name in
 110        match to_constant env expr with
 111        | CString s -> Buffer.add_string b s
 112   ) substs;
 113   Buffer.contents b
 114
 115 let rec to_shell_script env loc substs =
 116   let b = Buffer.create 13 in
 117   List.iter (
 118     function
 119     | SString s -> Buffer.add_string b s
 120     | SVar name ->
 121        let expr = getvar env loc name in
 122        let s = expr_to_shell_string env expr in
 123        Buffer.add_string b s
 124   ) substs;
 125   Buffer.contents b
 126
 127 and expr_to_shell_string env = function
 128   | EConstant (loc, CString s) -> Filename.quote s
 129
 130   | EVar (loc, name) ->
 131      let expr = getvar env loc name in
 132      expr_to_shell_string env expr
 133
 134   | ESubsts (loc, str) ->
 135      Filename.quote (substitute env loc str)
 136
 137   | EList (loc, exprs) ->
 138      let strs = List.map (expr_to_shell_string env) exprs in
 139      (* These are shell quoted so we can just concat them with space. *)
 140      String.concat " " strs
 141
 142   | ECall (loc, name, _) ->
 143      failwithf "%a: cannot use goal ‘%s’ in shell expansion"
 144        string_loc loc name
 145
 146   (* Tactics expand to the first parameter. *)
 147   | ETactic (loc, _, []) -> Filename.quote ""
 148   | ETactic (loc, _, (arg :: _)) -> expr_to_shell_string env arg
 149
 150   | EGoal (loc, _) ->
 151      failwithf "%a: cannot use goal in shell expansion"
 152        string_loc loc
 153
 154 module Substs = struct
 155   type t = {
 156       mutable elems : subst list; (* built in reverse order *)
 157       curr : Buffer.t;            (* current string *)
 158     }
 159
 160   let create () = { elems = []; curr = Buffer.create 13 }
 161
 162   let finalize t =
 163     if Buffer.length t.curr > 0 then
 164       t.elems <- SString (Buffer.contents t.curr) :: t.elems;
 165     Buffer.clear t.curr
 166
 167   let get t = finalize t; List.rev t.elems
 168
 169   let add_char { curr } = Buffer.add_char curr
 170   let add_string { curr} = Buffer.add_string curr
 171   let add_var t id = finalize t; t.elems <- SVar id :: t.elems
 172 end
 173
 174 let iter_with_commas
 175     : out_channel -> (out_channel -> 'a -> unit) -> 'a list -> unit =
 176   fun fp f xs ->
 177   let comma = ref false in
 178   List.iter (
 179     fun x ->
 180       if !comma then fprintf fp ", ";
 181       comma := true;
 182       f fp x
 183   ) xs
 184
 185 let rec string_env () env =
 186   let env = Env.bindings env in
 187   String.concat "" (List.map (string_def ()) env)
 188
 189 and print_env fp env = output_string fp (string_env () env)
 190
 191 and string_def () (name, expr) =
 192   match expr with
 193   | EGoal (loc, goal) -> string_goal () (Some name, goal) ^ "\n"
 194   | expr -> sprintf "let %s = %a\n" name string_expr expr;
 195
 196 and print_def fp name expr = output_string fp (string_def () (name, expr))
 197
 198 and string_goal () (name, (param_decls, patterns, exprs, code)) =
 199   sprintf "goal%s (%s) = %s : %s%s"
 200     (match name with None -> "" | Some name -> " " ^ name)
 201     (String.concat ", " (List.map (string_param_decl ()) param_decls))
 202     (String.concat ", " (List.map (string_pattern ()) patterns))
 203     (String.concat ", " (List.map (string_expr ()) exprs))
 204     (match code with None -> "" | Some code -> " = { ... }")
 205
 206 and string_param_decl () name = name
 207
 208 and string_pattern () = function
 209   | PTactic (loc, name, params) ->
 210      sprintf "*%s (%s)" name (String.concat ", "
 211                                 (List.map (string_substs ()) params));
 212   | PVar (loc, id) -> id
 213
 214 and print_pattern fp p = output_string fp (string_pattern () p)
 215
 216 and string_expr () = function
 217   | EGoal (loc, goal) -> string_goal () (None, goal)
 218   | ECall (loc, name, params) ->
 219      sprintf "%s (%s)"
 220        name (String.concat ", " (List.map (string_expr ()) params))
 221   | ETactic (loc, name, params) ->
 222      sprintf "*%s (%s)"
 223        name (String.concat ", " (List.map (string_expr ()) params))
 224   | EVar (loc, var) -> var
 225   | EList (loc, xs) ->
 226      sprintf "[%s]" (String.concat ", " (List.map (string_expr ()) xs))
 227   | ESubsts (loc, s) -> string_substs () s
 228   | EConstant (loc, c) -> string_constant () c
 229
 230 and print_expr fp expr = output_string fp (string_expr () expr)
 231
 232 and string_constant () = function
 233   | CString s -> sprintf "%S" s
 234
 235 and print_constant fp c = output_string fp (string_constant () c)
 236
 237 and print_id = output_string
 238
 239 and string_substs () ss =
 240   let ss =
 241     List.map (
 242       function
 243       | SString s -> sprintf "%S" s
 244       | SVar id -> id
 245     ) ss in
 246   (String.concat "+" ss)
 247
 248 and print_substs fp ss = output_string fp (string_substs () ss)
 249
 250 and print_code fp xs =
 251   List.iter (
 252     function
 253     | SString s -> fprintf fp "%s" s
 254     | SVar id -> fprintf fp "%%%s" id
 255   ) xs