generator-macros/pa_wrap.ml

   1 (* wrappi
   2  * Copyright (C) 2011 Red Hat Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  *)
  18
  19 (* For general information about camlp4, see:
  20  * http://brion.inria.fr/gallium/index.php/Camlp4
  21  *
  22  * For information about quotations, see:
  23  * http://brion.inria.fr/gallium/index.php/Quotation
  24  *)
  25
  26 open Camlp4.PreCast
  27 open Syntax
  28 open Ast
  29
  30 open Wrappi_types
  31
  32 (* Convert a plain list into a list AST. *)
  33 let rec expr_of_list _loc = function
  34   | [] -> <:expr< [] >>
  35   | h::t -> let t = expr_of_list _loc t in <:expr< $h$ :: $t$ >>
  36
  37 (* Convert an optional type into an option AST. *)
  38 let expr_of_option _loc = function
  39   | None -> <:expr< None >>
  40   | Some x -> <:expr< Some $x$ >>
  41
  42 (* Convert a _loc to an AST. *)
  43 let expr_of_loc _loc loc =
  44   let file_name,
  45     start_line, start_bol, start_off,
  46     stop_line, stop_bol, stop_off,
  47     ghost = Loc.to_tuple loc in
  48   <:expr< Camlp4.PreCast.Loc.of_tuple
  49     ($str:file_name$,
  50      $`int:start_line$, $`int:start_bol$, $`int:start_off$,
  51      $`int:stop_line$, $`int:stop_bol$, $`int:stop_off$,
  52      $`bool:ghost$) >>
  53
  54 let add_entry_point _loc name parameters rtype code =
  55   let loc = expr_of_loc _loc _loc in
  56
  57   let parameters = List.map (
  58     fun (name, t) -> <:expr< ($str:name$, $t$, None) >>
  59   ) parameters in
  60   let parameters = expr_of_list _loc parameters in
  61
  62   let code = expr_of_option _loc code in
  63
  64   <:str_item<
  65     let ep = { Wrappi_types.ep_loc = $loc$;
  66                ep_name = $str:name$;
  67                ep_ftype = ($rtype$, $parameters$, []);
  68                ep_code = $code$ } in
  69     Wrappi_accumulator.add_entry_point ep
  70   >>
  71
  72 let add_typedef _loc name t =
  73   let loc = expr_of_loc _loc _loc in
  74
  75   <:str_item<
  76     let td = { Wrappi_types.td_loc = $loc$;
  77                td_name = $str:name$;
  78                td_type = $t$ } in
  79     Wrappi_accumulator.add_typedef td
  80   >>
  81
  82 let () =
  83   (* Quotation expander for C code. *)
  84   let c_quotation_expander _loc _ code =
  85     (* XXX Expand %- or $- expressions in code. *)
  86     (* XXX Escape >> in code. *)
  87     ExStr (_loc, code)
  88   in
  89   Quotation.add "c" Quotation.DynAst.expr_tag c_quotation_expander;
  90
  91   (* Default quotation expander (<< .. >>) should be C code ("c"). *)
  92   Quotation.default := "c"
  93
  94 ;;
  95
  96 (* Extend the regular OCaml grammar. *)
  97 EXTEND Gram
  98   GLOBAL: str_item;
  99
 100   (* A parameter or return type. *)
 101   ptype: [
 102     [ "buffer" -> <:expr< Wrappi_types.TBuffer >> ]
 103   | [ "file" -> <:expr< Wrappi_types.TFile >> ]
 104   | [ "hash"; "("; t = ptype; ")" -> <:expr< Wrappi_types.THash $t$ >> ]
 105   | [ "int" -> <:expr< Wrappi_types.TInt >> ]
 106   | [ "int32" -> <:expr< Wrappi_types.TInt32 >> ]
 107   | [ "int64" -> <:expr< Wrappi_types.TInt64 >> ]
 108   | [ "list"; "("; t = ptype; ")" -> <:expr< Wrappi_types.TList $t$ >> ]
 109   | [ "nullable"; "("; t = ptype; ")" -> <:expr< Wrappi_types.TNullable $t$ >> ]
 110   | [ "string" -> <:expr< Wrappi_types.TString >> ]
 111   | [ "struct"; name = LIDENT -> <:expr< Wrappi_types.TStruct $str:name$ >> ]
 112   | [ "uint32" -> <:expr< Wrappi_types.TUInt32 >> ]
 113   | [ "uint64" -> <:expr< Wrappi_types.TUInt64 >> ]
 114   | [ name = LIDENT -> <:expr< Wrappi_types.TTypedef $str:name$ >> ]
 115   ];
 116
 117   (* A return type. *)
 118   rtype: [
 119     [ "err" -> <:expr< Wrappi_types.RErr >> ]
 120   | [ t = ptype -> <:expr< Wrappi_types.Return $t$ >> ]
 121   ];
 122
 123   (* A single function parameter.  XXX Preconditions. *)
 124   parameter: [[ t = ptype; name = LIDENT -> (name, t) ]];
 125
 126   str_item: LEVEL "top" [
 127     [ "entry_point";
 128       rtype = rtype; name = LIDENT;
 129       "("; parameters = LIST0 parameter SEP ","; ")";
 130       code = OPT [ code = expr -> code ] ->
 131       add_entry_point _loc name parameters rtype code
 132     ]
 133   | [ "typedef"; t = ptype; name = LIDENT ->
 134       add_typedef _loc name t
 135     ]
 136   ];
 137
 138 END